bump stable tag to 1.6.1

fix output for user agent filter on settings page
prepare release 1.6.1
2021-05-28 11:55:21 +02:00 · 2021-05-28 11:49:31 +02:00 · 2021-05-28 11:43:37 +02:00 · 2021-05-28 11:11:30 +02:00 · 2021-05-25 12:35:57 +02:00 · 2021-05-24 19:54:50 +02:00
19 changed files with 406 additions and 628 deletions
--- a/.distignore
+++ b/.distignore
@ -0,0 +1,15 @@
+/.git
+/.github
+/assets
+/test
+/.distignore
+/.gitattributes
+/.gitignore
+/.travis.yml
+/composer.json
+/composer.lock
+/CONTRIBUTING.md
+/package.json
+/package-lock.json
+/phpcs.xml
+/phpunit.xml
--- a/.gitattributes
+++ b/.gitattributes
@ -1,5 +1,7 @@
+/.github export-ignore
 /assets export-ignore
 /test export-ignore
+.distignore export-ignore
 .gitattributes export-ignore
 .gitignore export-ignore
 .travis.yml export-ignore
@ -9,4 +11,3 @@ CONTRIBUTING.md export-ignore
 package.json export-ignore
 phpcs.xml export-ignore
 phpunit.xml export-ignore
-RoboFile.php export-ignore
--- a/.github/workflows/test.yml
+++ b/.github/workflows/test.yml
@ -0,0 +1,54 @@
+name: CI
+on: [ push, pull_request ]
+jobs:
+  unit-test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        php: [ '5.6', '7.3', '7.4', '8.0' ]
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php }}
+          tools: composer
+      - name: Install
+        run: composer install --no-interaction
+      - name: Unit tests
+        run: |
+          composer test
+          sed -i "s#<file name=\"${GITHUB_WORKSPACE}#<file name=\"/github/workspace#g" tests-clover.xml
+      - name: Analyze with SonarCloud
+        if: matrix.php == '8.0' && github.event_name != 'pull_request'
+        uses: sonarsource/sonarcloud-github-action@master
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
+        with:
+          args: >
+            -Dsonar.organization=stklcode-github
+            -Dsonar.projectKey=stklcode:statify-blacklist
+            -Dsonar.sources=inc,views,statify-blacklist.php
+            -Dsonar.tests=test
+            -Dsonar.php.tests.reportPath=tests-junit.xml
+            -Dsonar.php.coverage.reportPaths=tests-clover.xml
+            -Dsonar.coverage.exclusions=test/**/*.php
+
+  quality:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: '8.0'
+          tools: composer
+      - name: Install
+        run: composer install --no-interaction
+      - name: Code style checks for PHP
+        run: composer test-cs
--- a/.github/workflows/wordpress-plugin-asset-update.yml
+++ b/.github/workflows/wordpress-plugin-asset-update.yml
@ -0,0 +1,20 @@
+name: Plugin asset/readme update
+on:
+  push:
+    branches:
+      - stable
+jobs:
+  master:
+    name: Push to stable
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Clean README.md
+        run: tail -n +6 README.md > README.md.tmp && mv README.md.tmp README.md
+      - name: WordPress.org plugin asset/readme update
+        uses: 10up/action-wordpress-plugin-asset-update@stable
+        env:
+          ASSETS_DIR: assets
+          README_NAME: README.md
+          SVN_PASSWORD: ${{ secrets.WP_SVN_PASSWORD }}
+          SVN_USERNAME: ${{ secrets.WP_SVN_USERNAME }}
--- a/.github/workflows/wordpress-plugin-deploy.yml
+++ b/.github/workflows/wordpress-plugin-deploy.yml
@ -0,0 +1,20 @@
+name: Deploy to WordPress.org
+on:
+  push:
+    tags:
+      - "v*"
+      - "!v*-*"
+jobs:
+  tag:
+    name: New tag
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Clean README.md
+        run: tail -n +6 README.md > README.md.tmp && mv README.md.tmp README.md
+      - name: WordPress Plugin Deploy
+        uses: 10up/action-wordpress-plugin-deploy@stable
+        env:
+          ASSETS_DIR: assets
+          SVN_PASSWORD: ${{ secrets.WP_SVN_PASSWORD }}
+          SVN_USERNAME: ${{ secrets.WP_SVN_USERNAME }}
--- a/.travis.yml
+++ b/.travis.yml
@ -1,13 +0,0 @@
-language: php
-php:
-  - '5.6'
-  - '7.3'
-  - '7.4'
-  - '8.0'
-before_script:
-  - composer install
-script:
-  - composer test-all
-notifications:
-  slack:
-    secure: "ScXTSMO65veI1jA6TBHGDUtvDqEMkqJykaNf7vLLbb7YIxPIHHNBiX/wcjOHVFfQXZCV3qxQrflB7Lbm9qVUsAv861jTO9x/ZkECl5QhRoc0DIznejwZoypx0HJ9tBZFYT6qNUkViXRKZ/ILAiBLU9Yw52WACtQB9hu3FNFZwmKsjipvV8Sne1qEyTkLYLaMphsbC5mtXYdKMHvdt39jsYsk91UWGeYbXQ37LkMbsaG/8YHXF724d5JO7BRGoThw6p5knKAO5fk29V7GfNqg2h+hnGyNIUOcmxujgMDMFLyFCGMZpPoBa+3jyWWgq4PgpQt0F5VZtJFGoXCGcoMQm5IbVfqkSKJ4jYhqiSIrqSebLmzoPHepWX3yn8tpfOiBWjC6K9w9esp6vcZf26rnAJcjcGkA01rMrHRwR+UEMCLvj7q0DR0qzi/AFeED6gtpODzUf93Rp42Tz1iGvWIbgeCtkCWjfPO6XLuNiqGVPEVaT5BDKqlqbijdKxxp7yh1fdt8s0fInWdIsgoWTbU9DC1W4ZiqtQW7oYO+QtFZMaD6kZWpSqJUwB3kW5JL3odAUEm8bLbRWBvK5ZjGdaGqSbOs6f9gAKcf86iQQhwzCJSOgFlLlKFv9smicjPC+BGOxgx32pgseHNPWn6tmEo/ihmmr/NbbqoOusUKX9gQbA4="
--- a/README.md
+++ b/README.md
@ -1,14 +1,14 @@
-[![Build Status](https://travis-ci.com/stklcode/statify-blacklist.svg?branch=master)](https://travis-ci.com/stklcode/statify-blacklist)
-[![Quality Gate](https://sonarcloud.io/api/project_badges/measure?project=de.stklcode.web.wordpress.plugins%3Astatify-blacklist&metric=alert_status)](https://sonarcloud.io/dashboard?id=de.stklcode.web.wordpress.plugins%3Astatify-blacklist)
+[![Build Status](https://github.com/stklcode/statify-blacklist/actions/workflows/test.yml/badge.svg?branch=stable)](https://github.com/stklcode/statify-blacklist/actions/workflows/test.yml?query=branch%3Astable)
+[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=stklcode%3Astatify-blacklist&metric=alert_status)](https://sonarcloud.io/dashboard?id=stklcode%3Astatify-blacklist)
 [![Packagist Version](https://img.shields.io/packagist/v/stklcode/statify-blacklist.svg)](https://packagist.org/packages/stklcode/statify-blacklist)
-[![License](https://img.shields.io/badge/license-GPL%20v2-blue.svg)](https://github.com/stklcode/statify-blacklist/blob/master/LICENSE.md)
+[![License](https://img.shields.io/badge/license-GPL%20v2-blue.svg)](https://github.com/stklcode/statify-blacklist/blob/stable/LICENSE.md)

 # Statify Filter #
 * Contributors:      Stefan Kalscheuer
 * Requires at least: 4.7
-* Tested up to:      5.6
+* Tested up to:      5.7
 * Requires PHP:      5.5
-* Stable tag:        1.6.0
+* Stable tag:        1.6.1
 * License:           GPLv2 or later
 * License URI:       https://www.gnu.org/licenses/gpl-2.0.html

@ -93,6 +93,9 @@ Same for IPv6 prefixes like _2001:db8:a0b:12f0::/64_.

 ## Upgrade Notice ##

+### 1.6.1 ###
+This is a bugfix release that corrects storage and evaluation of the user agent filter list.
+
 ### 1.6.0 ###
 The plugin has been renamed from _Statify Blacklist_ to _Statify Filter_.
 This does not imply any changes in functionality, rather than using a better wording.
@ -103,6 +106,9 @@ This version should be compatible with latest WordPress 5.6.

 ## Changelog ##

+### 1.6.1 / 28.05.2021 ###
+* Fix storage of user agent filter list (#28, props @BananaSquishee)
+
 ### 1.6.0 / 09.12.2020 ###

 Plugin renamed to _Statify Filter_.
--- a/RoboFile.php
+++ b/RoboFile.php
@ -1,396 +0,0 @@
-<?php
-/**
- * Statify Filter Robo build script.
- *
- * This file contains the Robo tasks for building a distributable plugin package.
- * Should not be included in final package.
- *
- * @author    Stefan Kalscheuer <stefan@stklcode.de>
- *
- * @package   Statify_Blacklist
- * @version   1.0.0
- */
-
-use Robo\Exception\TaskException;
-use Robo\Tasks;
-
-/**
- * Class RoboFile
- */
-class RoboFile extends Tasks {
-	const PROJECT_NAME = 'statify-blacklist';
-	const SVN_URL      = 'https://plugins.svn.wordpress.org/statify-blacklist';
-
-	const OPT_TARGET    = 'target';
-	const OPT_SKIPTEST  = 'skipTests';
-	const OPT_SKIPSTYLE = 'skipStyle';
-
-	/**
-	 * Version tag (read from composer.json).
-	 *
-	 * @var string
-	 */
-	private $version;
-
-	/**
-	 * Target directory path.
-	 *
-	 * @var string
-	 */
-	private $target_dir;
-
-	/**
-	 * Final package name.
-	 *
-	 * @var string
-	 */
-	private $final_name;
-
-	/**
-	 * RoboFile constructor
-	 *
-	 * @param array $opts Options.
-	 *
-	 * @return void
-	 */
-	public function __construct( $opts = [ self::OPT_TARGET => 'dist' ] ) {
-		// Read composer configuration and extract version number..
-		$composer = json_decode( file_get_contents( __DIR__ . '/composer.json' ) );
-		// Extract parameter from options.
-		$this->version    = $composer->version;
-		$this->target_dir = $opts[ self::OPT_TARGET ];
-		$this->final_name = self::PROJECT_NAME . '.' . $this->version;
-	}
-
-	/**
-	 * Clean up target directory
-	 *
-	 * @param array $opts Options.
-	 *
-	 * @return void
-	 */
-	public function clean( $opts = [ self::OPT_TARGET => 'dist' ] ) {
-		$this->say( 'Cleaning target directory...' );
-		if ( is_dir( $this->target_dir . '/' . $this->final_name ) ) {
-			$this->_deleteDir( [ $this->target_dir . '/' . $this->final_name ] );
-		}
-		if ( is_file( $this->target_dir . '/' . $this->final_name . '.zip' ) ) {
-			$this->_remove( $this->target_dir . '/' . $this->final_name . '.zip' );
-		}
-	}
-
-	/**
-	 * Run PHPUnit tests
-	 *
-	 * @return void
-	 */
-	public function test() {
-		$this->say( 'Executing PHPUnit tests...' );
-		$this->taskPhpUnit()->configFile( __DIR__ . '/phpunit.xml' )->run();
-	}
-
-	/**
-	 * Run code style tests
-	 *
-	 * @return void
-	 */
-	public function testCS() {
-		$this->say( 'Executing PHPCS tests...' );
-		$this->_exec( __DIR__ . '/vendor/bin/phpcs --standard=phpcs.xml -s' );
-	}
-
-	/**
-	 * Build a distributable bundle.
-	 *
-	 * @param array $opts Options.
-	 *
-	 * @return void
-	 */
-	public function build(
-		$opts = [
-			self::OPT_TARGET    => 'dist',
-			self::OPT_SKIPTEST  => false,
-			self::OPT_SKIPSTYLE => false,
-		]
-	) {
-		$this->clean( $opts );
-		if ( isset( $opts[ self::OPT_SKIPTEST ] ) && true === $opts[ self::OPT_SKIPTEST ] ) {
-			$this->say( 'Tests skipped' );
-		} else {
-			$this->test();
-		}
-		if ( isset( $opts[ self::OPT_SKIPSTYLE ] ) && true === $opts[ self::OPT_SKIPSTYLE ] ) {
-			$this->say( 'Style checks skipped' );
-		} else {
-			$this->testCS();
-		}
-		$this->bundle();
-	}
-
-	/**
-	 * Bundle global resources.
-	 *
-	 * @return void
-	 */
-	private function bundle() {
-		$this->say( 'Bundling resources...' );
-		$this->taskCopyDir(
-			[
-				'inc'   => $this->target_dir . '/' . $this->final_name . '/inc',
-				'views' => $this->target_dir . '/' . $this->final_name . '/views',
-			]
-		)->run();
-		$this->_copy( 'statify-blacklist.php', $this->target_dir . '/' . $this->final_name . '/statify-blacklist.php' );
-		$this->_copy( 'LICENSE.md', $this->target_dir . '/' . $this->final_name . '/LICENSE.md' );
-		$this->_copy( 'README.md', $this->target_dir . '/' . $this->final_name . '/README.md' );
-
-		// Remove content before title (e.g. badges) from README file.
-		$this->taskReplaceInFile( $this->target_dir . '/' . $this->final_name . '/README.md' )
-			->regex( '/^[^\\#]*/' )
-			->to( '' )
-			->run();
-	}
-
-	/**
-	 * Create ZIP package from distribution bundle.
-	 *
-	 * @param array $opts Options.
-	 *
-	 * @return void
-	 */
-	public function package(
-		$opts = [
-			self::OPT_TARGET    => 'dist',
-			self::OPT_SKIPTEST  => false,
-			self::OPT_SKIPSTYLE => false,
-		]
-	) {
-		$this->build( $opts );
-		$this->say( 'Packaging...' );
-		$this->taskPack( $this->target_dir . '/' . $this->final_name . '.zip' )
-			->addDir( '', $this->target_dir . '/' . $this->final_name )
-			->run();
-	}
-
-	/**
-	 * Deploy development version (trunk).
-	 *
-	 * @param array $opts Options.
-	 *
-	 * @return void
-	 * @throws TaskException On errors.
-	 */
-	public function deployTrunk(
-		$opts = [
-			self::OPT_TARGET    => 'dist',
-			self::OPT_SKIPTEST  => false,
-			self::OPT_SKIPSTYLE => false,
-		]
-	) {
-		// First execute build job.
-		$this->build( $opts );
-
-		// Prepare VCS, either checkout or update local copy.
-		$this->prepareVCS();
-
-		$this->say( 'Preparing deployment directory...' );
-		$this->updateVCStrunk();
-
-		// Update remote repository.
-		$this->say( 'Deploying...' );
-		$this->commitVCS(
-			'--force trunk/*',
-			'Updated ' . self::PROJECT_NAME . ' trunk'
-		);
-	}
-
-	/**
-	 * Deploy current version tag.
-	 *
-	 * @param array $opts Options.
-	 *
-	 * @return void
-	 * @throws TaskException On errors.
-	 */
-	public function deployTag(
-		$opts = [
-			self::OPT_TARGET    => 'dist',
-			self::OPT_SKIPTEST  => false,
-			self::OPT_SKIPSTYLE => false,
-		]
-	) {
-		// First execute build job.
-		$this->build( $opts );
-
-		// Prepare VCS, either checkout or update local copy.
-		$this->prepareVCS();
-
-		$this->say( 'Preparing deployment directory...' );
-		$this->updateVCStag();
-
-		// Update remote repository.
-		$this->say( 'Deploying...' );
-		$this->commitVCS(
-			'tags/' . $this->version,
-			'Updated ' . self::PROJECT_NAME . ' v' . $this->version
-		);
-	}
-
-	/**
-	 * Deploy current version tag.
-	 *
-	 * @param array $opts Options.
-	 *
-	 * @return void
-	 * @throws TaskException On errors.
-	 */
-	public function deployReadme(
-		$opts = [
-			self::OPT_TARGET    => 'dist',
-			self::OPT_SKIPTEST  => false,
-			self::OPT_SKIPSTYLE => false,
-		]
-	) {
-		// First execute build job.
-		$this->build( $opts );
-
-		// Prepare VCS, either checkout or update local copy.
-		$this->prepareVCS();
-
-		$this->updateVCSreadme();
-
-		// Update remote repository.
-		$this->say( 'Deploying...' );
-		$this->commitVCS(
-			'--force trunk/README.md',
-			'Updated ' . self::PROJECT_NAME . ' ReadMe'
-		);
-	}
-
-	/**
-	 * Deploy current version tag and trunk.
-	 *
-	 * @param array $opts Options.
-	 *
-	 * @return void
-	 * @throws TaskException On errors.
-	 */
-	public function deployAll(
-		$opts = [
-			self::OPT_TARGET    => 'dist',
-			self::OPT_SKIPTEST  => false,
-			self::OPT_SKIPSTYLE => false,
-		]
-	) {
-		// First execute build job.
-		$this->build( $opts );
-
-		// Prepare VCS, either checkout or update local copy.
-		$this->prepareVCS();
-
-		$this->say( 'Preparing deployment directory...' );
-		$this->updateVCStrunk();
-		$this->updateVCStag();
-
-		// Update remote repository.
-		$this->say( 'Deploying...' );
-		$this->commitVCS(
-			[
-				'--force trunk/*',
-				'--force tags/' . $this->version,
-			],
-			'Updated ' . self::PROJECT_NAME . ' v' . $this->version
-		);
-	}
-
-	/**
-	 * Prepare VCS direcory.
-	 *
-	 * Checkout or update local copy of SVN repository.
-	 *
-	 * @return void
-	 * @throws TaskException On errors.
-	 */
-	private function prepareVCS() {
-		if ( is_dir( $this->target_dir . '/svn' ) ) {
-			$this->taskSvnStack()
-				->stopOnFail()
-				->dir( $this->target_dir . '/svn/statify-blacklist' )
-				->update()
-				->run();
-		} else {
-			$this->_mkdir( $this->target_dir . '/svn' );
-			$this->taskSvnStack()
-				->dir( $this->target_dir . '/svn' )
-				->checkout( self::SVN_URL )
-				->run();
-		}
-	}
-
-	/**
-	 * Commit VCS changes
-	 *
-	 * @param string|array $to_add Files to add.
-	 * @param string       $msg    Commit message.
-	 *
-	 * @return void
-	 * @throws TaskException On errors.
-	 */
-	private function commitVCS( $to_add, $msg ) {
-		$task = $this->taskSvnStack()
-					->stopOnFail()
-					->dir( $this->target_dir . '/svn/statify-blacklist' );
-
-		if ( is_array( $to_add ) ) {
-			foreach ( $to_add as $ta ) {
-				$task = $task->add( $ta );
-			}
-		} else {
-			$task = $task->add( $to_add );
-		}
-
-		$task->commit( $msg )->run();
-	}
-
-	/**
-	 * Update SVN readme file.
-	 *
-	 * @return void
-	 */
-	private function updateVCSreadme() {
-		$trunk_dir = $this->target_dir . '/svn/statify-blacklist/trunk';
-		$this->_copy( $this->target_dir . '/' . $this->final_name . '/README.md', $trunk_dir . '/README.md' );
-	}
-
-	/**
-	 * Update SVN development version (trunk).
-	 *
-	 * @return void
-	 */
-	private function updateVCStrunk() {
-		// Clean trunk directory.
-		$trunk_dir = $this->target_dir . '/svn/statify-blacklist/trunk';
-		$this->taskCleanDir( $trunk_dir )->run();
-
-		// Copy built bundle to trunk.
-		$this->taskCopyDir( [ $this->target_dir . '/' . $this->final_name => $trunk_dir ] )->run();
-	}
-
-	/**
-	 * Update current SVN version tag.
-	 *
-	 * @return void
-	 */
-	private function updateVCStag() {
-		// Clean tag directory if it exists.
-		$tag_dir = $this->target_dir . '/svn/statify-blacklist/tags/' . $this->version;
-		if ( is_dir( $tag_dir ) ) {
-			$this->taskCleanDir( $this->target_dir . '/svn/statify-blacklist/tags/' . $this->version )->run();
-		} else {
-			$this->_mkdir( $tag_dir );
-		}
-
-		// Copy built bundle to trunk.
-		$this->taskCopyDir( [ $this->target_dir . '/' . $this->final_name => $tag_dir ] )->run();
-	}
-}
--- a/composer.json
+++ b/composer.json
@ -1,6 +1,6 @@
 {
  "name": "stklcode/statify-blacklist",
-  "version": "1.6.0",
+  "version": "1.6.1",
  "description": "A filter extension for the famous Statify WordPress plugin",
  "keywords": [
    "wordpress",
@ -19,28 +19,18 @@
  "type": "wordpress-plugin",
  "require": {
    "php": ">=5.5",
-    "composer/installers": "~1.9"
+    "composer/installers": "~1.11"
  },
  "require-dev": {
    "dealerdirect/phpcodesniffer-composer-installer": "^0.7",
-    "consolidation/robo": "^1.4",
    "phpunit/phpunit": "*",
    "phpunit/php-code-coverage": "*",
    "slowprog/composer-copy-file": "~0.3",
-    "squizlabs/php_codesniffer": "^3.5",
+    "squizlabs/php_codesniffer": "^3.6",
    "phpcompatibility/phpcompatibility-wp": "^2.1",
    "wp-coding-standards/wpcs": "^2.3"
  },
  "scripts": {
-    "build": [
-      "robo build"
-    ],
-    "package": [
-      "robo package"
-    ],
-    "deploy": [
-      "robo deploy:all"
-    ],
    "test-all": [
      "@test",
      "@test-cs"
--- a/inc/class-statifyblacklist-system.php
+++ b/inc/class-statifyblacklist-system.php
@ -178,6 +178,30 @@ class StatifyBlacklist_System extends StatifyBlacklist {
 			self::update_options();
 		}

+		// Version older than 1.6.
+		if ( self::$options['version'] < 1.6 ) {
+			$options = self::$options;
+			if ( ! isset( $options['ua'] ) ) {
+				$options['ua'] = array(
+					'active'    => 0,
+					'regexp'    => 0,
+					'blacklist' => array(),
+				);
+			} elseif ( ! isset( $options['ua']['blacklist'] ) ) {
+				$options['ua']['blacklist'] = array();
+			} elseif ( isset( $options['ua'] ) ) {
+				// User agent strings got stored incorrectly in 1.6.0 - luckily the version was not updated, either.
+				$options['ua']['blacklist'] = array_flip( $options['ua']['blacklist'] );
+			}
+			$options['version'] = 1.6;
+			if ( self::$multisite ) {
+				update_site_option( 'statify-blacklist', $options );
+			} else {
+				update_option( 'statify-blacklist', $options );
+			}
+			self::update_options();
+		}
+
 		// Version older than current major release.
 		if ( self::VERSION_MAIN > self::$options['version'] ) {
 			// Merge default options with current config, assuming only additive changes.
--- a/inc/class-statifyblacklist.php
+++ b/inc/class-statifyblacklist.php
@ -24,7 +24,7 @@ class StatifyBlacklist {
 	 * @since 1.4.0
 	 * @var int VERSION_MAIN
 	 */
-	const VERSION_MAIN = 1.4;
+	const VERSION_MAIN = 1.6;

 	/**
 	 * Operation mode "normal".
--- a/package.json
+++ b/package.json
@ -1,6 +1,6 @@
 {
  "name": "statify-blacklist",
-  "version": "1.6.0",
+  "version": "1.6.1",
  "description": "A filter extension for the famous Statify WordPress plugin",
  "author": "Stefan Kalscheuer",
  "license": "GPL-2.0+"
--- a/phpunit.xml
+++ b/phpunit.xml
@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="utf-8" ?>
-<phpunit bootstrap="./vendor/autoload.php">
+<phpunit bootstrap="test/bootstrap.php">
 	<testsuites>
 		<testsuite name="Statify Blacklist TestSuite">
 			<directory suffix="_Test.php">./test/</directory>
--- a/statify-blacklist.php
+++ b/statify-blacklist.php
@ -10,7 +10,7 @@
 * Plugin Name: Statify Filter
 * Plugin URI:  https://wordpress.org/plugins/statify-blacklist/
 * Description: Extension for the Statify plugin to add customizable filters. (formerly "Statify Blacklist)
- * Version:     1.6.0
+ * Version:     1.6.1
 * Author:      Stefan Kalscheuer (@stklcode)
 * Author URI:  https://www.stklcode.de
 * Text Domain: statify-blacklist
--- a/test/StatifyBlacklist_Admin_Test.php
+++ b/test/StatifyBlacklist_Admin_Test.php
@ -0,0 +1,64 @@
+<?php
+/**
+ * Statify Filter: Unit Test
+ *
+ * This is a PHPunit test class for the plugin's functionality
+ *
+ * @package Statify_Blacklist
+ */
+
+/**
+ * Class StatifyBlacklist_Admin_Test.
+ *
+ * PHPUnit test class for StatifyBlacklist_Admin.
+ */
+class StatifyBlacklist_Admin_Test extends PHPUnit\Framework\TestCase {
+
+
+	/**
+	 * Test sanitization of IP addresses.
+	 *
+	 * @return void
+	 */
+	public function test_sanitize_ips() {
+		// IPv4 tests.
+		$valid   = array( '192.0.2.123', '192.0.2.123/32', '192.0.2.0/24', '192.0.2.128/25' );
+		$invalid = array( '12.34.56.789', '192.0.2.123/33', '192.0.2.123/-1' );
+		$result  = invoke_static( StatifyBlacklist_Admin::class, 'sanitize_ips', array( array_merge( $valid, $invalid ) ) );
+		$this->assertNotFalse( $result );
+
+		/*
+		 * Unfortunately this is necessary as long as we run PHP 5 tests, because "assertInternalType" is deprecated
+		 * as of PHPUnit 8, but "assertIsArray" has been introduces in PHPUnit 7.5 which requires PHP >= 7.1.
+		 */
+		if ( method_exists( $this, 'assertIsArray' ) ) {
+			$this->assertIsArray( $result );
+		} else {
+			$this->assertInternalType( 'array', $result );
+		}
+		$this->assertEquals( $valid, $result );
+
+		// IPv6 tests.
+		$valid   = array(
+			'2001:db8:a0b:12f0::',
+			'2001:db8:a0b:12f0::1',
+			'2001:db8:a0b:12f0::1/128',
+			'2001:db8:a0b:12f0::/64',
+		);
+		$invalid = array(
+			'2001:db8:a0b:12f0::x',
+			'2001:db8:a0b:12f0:::',
+			'2001:fffff:a0b:12f0::1',
+			'2001:db8:a0b:12f0::/129',
+			'1:2:3:4:5:6:7:8:9',
+		);
+		$result  = invoke_static( StatifyBlacklist_Admin::class, 'sanitize_ips', array( array_merge( $valid, $invalid ) ) );
+		$this->assertNotFalse( $result );
+		if ( method_exists( $this, 'assertIsArray' ) ) {
+			$this->assertIsArray( $result );
+		} else {
+			$this->assertInternalType( 'array', $result );
+		}
+		$this->assertEquals( $valid, $result );
+	}
+}
--- a/test/StatifyBlacklist_System_Test.php
+++ b/test/StatifyBlacklist_System_Test.php
@ -0,0 +1,92 @@
+<?php
+/**
+ * Statify Filter: Unit Test
+ *
+ * This is a PHPunit test class for the plugin's functionality
+ *
+ * @package Statify_Blacklist
+ */
+
+/**
+ * Class StatifyBlacklist_System_Test.
+ *
+ * PHPUnit test class for StatifyBlacklist_System.
+ */
+class StatifyBlacklist_System_Test extends PHPUnit\Framework\TestCase {
+
+	/**
+	 * Test the upgrade methodology for configuration options.
+	 *
+	 * @return void
+	 */
+	public function test_upgrade() {
+		// Create configuration of version 1.3.
+		$options13 = array(
+			'active_referer' => 1,
+			'cron_referer'   => 0,
+			'referer'        => array(
+				'example.net' => 0,
+				'example.com' => 1,
+			),
+			'referer_regexp' => 0,
+			'version'        => 1.3,
+		);
+
+		// Set options in mock.
+		update_option( 'statify-blacklist', $options13 );
+
+		// Execute upgrade.
+		StatifyBlacklist_System::upgrade();
+
+		// Retrieve updated options.
+		$options_updated = get_option( 'statify-blacklist' );
+
+		// Verify size against default options (no junk left).
+		$this->assertEquals( 5, count( $options_updated ) );
+		$this->assertEquals( 4, count( $options_updated['referer'] ) );
+		$this->assertEquals( 4, count( $options_updated['target'] ) );
+		$this->assertEquals( 2, count( $options_updated['ip'] ) );
+		$this->assertEquals( 3, count( $options_updated['ua'] ) );
+		$this->assertEquals( 1.6, $options_updated['version'] );
+
+		// Verify that original attributes are unchanged.
+		$this->assertEquals( $options13['active_referer'], $options_updated['referer']['active'] );
+		$this->assertEquals( $options13['cron_referer'], $options_updated['referer']['cron'] );
+		$this->assertEquals( $options13['referer'], $options_updated['referer']['blacklist'] );
+		$this->assertEquals( $options13['referer_regexp'], $options_updated['referer']['regexp'] );
+
+		// Verify that new attributes are present in config and filled with default values (disabled, empty).
+		$this->assertEquals( 0, $options_updated['target']['active'] );
+		$this->assertEquals( 0, $options_updated['target']['cron'] );
+		$this->assertEquals( 0, $options_updated['target']['regexp'] );
+		$this->assertEquals( array(), $options_updated['target']['blacklist'] );
+		$this->assertEquals( 0, $options_updated['ip']['active'] );
+		$this->assertEquals( array(), $options_updated['ip']['blacklist'] );
+		$this->assertEquals( 0, $options_updated['ua']['active'] );
+		$this->assertEquals( 0, $options_updated['ua']['regexp'] );
+		$this->assertEquals( array(), $options_updated['ua']['blacklist'] );
+
+		// Verify that version number has changed to current release.
+		$this->assertEquals( StatifyBlacklist::VERSION_MAIN, $options_updated['version'] );
+
+		// Test upgrade of incorrectly stored user agent list in 1.6.
+		$options_updated['version']         = 1.4;
+		$options_updated['ua']['blacklist'] = array( 'user agent 1', 'user agent 2' );
+		update_option( 'statify-blacklist', $options_updated );
+
+		// Execute upgrade.
+		StatifyBlacklist_System::upgrade();
+
+		// Retrieve updated options.
+		$options_updated = get_option( 'statify-blacklist' );
+		$this->assertEquals(
+			array(
+				'user agent 1' => 0,
+				'user agent 2' => 1,
+			),
+			$options_updated['ua']['blacklist']
+		);
+		$this->assertEquals( 1.6, $options_updated['version'] );
+		$this->assertEquals( StatifyBlacklist::VERSION_MAIN, $options_updated['version'] );
+	}
+}
--- a/test/StatifyBlacklist_Test.php
+++ b/test/StatifyBlacklist_Test.php
@ -4,34 +4,10 @@
 *
 * This is a PHPunit test class for the plugin's functionality
 *
- * @package    Statify_Blacklist
- * @subpackage Admin
- * @since      1.3.0
+ * @package Statify_Blacklist
+ * @since   1.3.0
 */

-/**
- * Simulating the ABSPATH constant.
- *
- * @since 1.3.0
- * @var bool ABSPATH
- */
-const ABSPATH = false;
-
-/**
- * The StatifyBlacklist base class.
- */
-require_once __DIR__ . '/../inc/class-statifyblacklist.php';
-
-/**
- * The StatifyBlacklist system class.
- */
-require_once __DIR__ . '/../inc/class-statifyblacklist-system.php';
-
-/**
- * The StatifyBlacklist admin class.
- */
-require_once __DIR__ . '/../inc/class-statifyblacklist-admin.php';
-
 /**
 * Class StatifyBlacklistTest.
 *
@ -228,57 +204,6 @@ class StatifyBlacklist_Test extends PHPUnit\Framework\TestCase {
 		$this->assertTrue( StatifyBlacklist::apply_blacklist_filter() );
 	}

-	/**
-	 * Test the upgrade methodology for configuration options.
-	 *
-	 * @return void
-	 */
-	public function test_upgrade() {
-		// Create configuration of version 1.3.
-		$options13 = array(
-			'active_referer' => 1,
-			'cron_referer'   => 0,
-			'referer'        => array(
-				'example.net' => 0,
-				'example.com' => 1,
-			),
-			'referer_regexp' => 0,
-			'version'        => 1.3,
-		);
-
-		// Set options in mock.
-		update_option( 'statify-blacklist', $options13 );
-
-		// Execute upgrade.
-		StatifyBlacklist_System::upgrade();
-
-		// Retrieve updated options.
-		$options_updated = get_option( 'statify-blacklist' );
-
-		// Verify size against default options (no junk left).
-		$this->assertEquals( 4, count( $options_updated ) );
-		$this->assertEquals( 4, count( $options_updated['referer'] ) );
-		$this->assertEquals( 4, count( $options_updated['target'] ) );
-		$this->assertEquals( 2, count( $options_updated['ip'] ) );
-
-		// Verify that original attributes are unchanged.
-		$this->assertEquals( $options13['active_referer'], $options_updated['referer']['active'] );
-		$this->assertEquals( $options13['cron_referer'], $options_updated['referer']['cron'] );
-		$this->assertEquals( $options13['referer'], $options_updated['referer']['blacklist'] );
-		$this->assertEquals( $options13['referer_regexp'], $options_updated['referer']['regexp'] );
-
-		// Verify that new attributes are present in config and filled with default values (disabled, empty).
-		$this->assertEquals( 0, $options_updated['target']['active'] );
-		$this->assertEquals( 0, $options_updated['target']['cron'] );
-		$this->assertEquals( 0, $options_updated['target']['regexp'] );
-		$this->assertEquals( array(), $options_updated['target']['blacklist'] );
-		$this->assertEquals( 0, $options_updated['ip']['active'] );
-		$this->assertEquals( array(), $options_updated['ip']['blacklist'] );
-
-		// Verify that version number has changed to current release.
-		$this->assertEquals( StatifyBlacklist::VERSION_MAIN, $options_updated['version'] );
-	}
-
 	/**
 	 * Test CIDR address matching for IP filter (#7).
 	 *
@ -367,53 +292,6 @@ class StatifyBlacklist_Test extends PHPUnit\Framework\TestCase {
 		);
 	}

-	/**
-	 * Test sanitization of IP addresses.
-	 *
-	 * @return void
-	 */
-	public function test_sanitize_ips() {
-		// IPv4 tests.
-		$valid   = array( '192.0.2.123', '192.0.2.123/32', '192.0.2.0/24', '192.0.2.128/25' );
-		$invalid = array( '12.34.56.789', '192.0.2.123/33', '192.0.2.123/-1' );
-		$result  = invoke_static( StatifyBlacklist_Admin::class, 'sanitize_ips', array( array_merge( $valid, $invalid ) ) );
-		$this->assertNotFalse( $result );
-
-		/*
-		 * Unfortunately this is necessary as long as we run PHP 5 tests, because "assertInternalType" is deprecated
-		 * as of PHPUnit 8, but "assertIsArray" has been introduces in PHPUnit 7.5 which requires PHP >= 7.1.
-		 */
-		if ( method_exists( $this, 'assertIsArray' ) ) {
-			$this->assertIsArray( $result );
-		} else {
-			$this->assertInternalType( 'array', $result );
-		}
-		$this->assertEquals( $valid, $result );
-
-		// IPv6 tests.
-		$valid   = array(
-			'2001:db8:a0b:12f0::',
-			'2001:db8:a0b:12f0::1',
-			'2001:db8:a0b:12f0::1/128',
-			'2001:db8:a0b:12f0::/64',
-		);
-		$invalid = array(
-			'2001:db8:a0b:12f0::x',
-			'2001:db8:a0b:12f0:::',
-			'2001:fffff:a0b:12f0::1',
-			'2001:db8:a0b:12f0::/129',
-			'1:2:3:4:5:6:7:8:9',
-		);
-		$result  = invoke_static( StatifyBlacklist_Admin::class, 'sanitize_ips', array( array_merge( $valid, $invalid ) ) );
-		$this->assertNotFalse( $result );
-		if ( method_exists( $this, 'assertIsArray' ) ) {
-			$this->assertIsArray( $result );
-		} else {
-			$this->assertInternalType( 'array', $result );
-		}
-		$this->assertEquals( $valid, $result );
-	}
-
 	/**
 	 * Test IP filter (#7).
 	 *
@ -619,11 +497,11 @@ class StatifyBlacklist_Test extends PHPUnit\Framework\TestCase {
 		$this->assertNull( StatifyBlacklist::apply_blacklist_filter() );
 		// Keyword matching.
 		StatifyBlacklist::$options['ua']['blacklist'] = array( 'TestBot' => 0 );
-		StatifyBlacklist::$options['ua']['regexp'] = StatifyBlacklist::MODE_KEYWORD;
+		StatifyBlacklist::$options['ua']['regexp']    = StatifyBlacklist::MODE_KEYWORD;
 		$this->assertTrue( StatifyBlacklist::apply_blacklist_filter() );
 		// RegEx.
 		StatifyBlacklist::$options['ua']['blacklist'] = array( 'T[a-z]+B[a-z]+' => 0 );
-		StatifyBlacklist::$options['ua']['regexp'] = StatifyBlacklist::MODE_REGEX;
+		StatifyBlacklist::$options['ua']['regexp']    = StatifyBlacklist::MODE_REGEX;
 		$this->assertTrue( StatifyBlacklist::apply_blacklist_filter() );
 		StatifyBlacklist::$options['ua']['blacklist'] = array( 't[a-z]+' => 0 );
 		$this->assertNull( StatifyBlacklist::apply_blacklist_filter() );
@ -721,69 +599,3 @@ class StatifyBlacklist_Test extends PHPUnit\Framework\TestCase {

 	}
 }
-
-
-/** @ignore */
-function invoke_static( $class, $method_name, $parameters = array() ) {
-	$reflection = new \ReflectionClass( $class );
-	$method     = $reflection->getMethod( $method_name );
-	$method->setAccessible( true );
-
-	return $method->invokeArgs( null, $parameters );
-}
-
-
-// Some mocked WP functions.
-$mock_options   = array();
-$mock_multisite = false;
-
-/** @ignore */
-function is_multisite() {
-	global $mock_multisite;
-
-	return $mock_multisite;
-}
-
-/** @ignore */
-function wp_parse_args( $args, $defaults = '' ) {
-	if ( is_object( $args ) ) {
-		$r = get_object_vars( $args );
-	} elseif ( is_array( $args ) ) {
-		$r =& $args;
-	} else {
-		parse_str( $args, $r );
-	}
-
-	if ( is_array( $defaults ) ) {
-		return array_merge( $defaults, $r );
-	}
-
-	return $r;
-}
-
-/** @ignore */
-function get_option( $option, $default = false ) {
-	global $mock_options;
-
-	return isset( $mock_options[ $option ] ) ? $mock_options[ $option ] : $default;
-}
-
-/** @ignore */
-function update_option( $option, $value, $autoload = null ) {
-	global $mock_options;
-	$mock_options[ $option ] = $value;
-}
-
-/** @ignore */
-function wp_get_raw_referer() {
-	return isset( $_SERVER['HTTP_REFERER'] ) ? $_SERVER['HTTP_REFERER'] : '';
-}
-
-function wp_parse_url( $value ) {
-	return parse_url( $value );
-}
-
-/** @ignore */
-function wp_unslash( $value ) {
-	return is_string( $value ) ? stripslashes( $value ) : $value;
-}
--- a/test/bootstrap.php
+++ b/test/bootstrap.php
@ -0,0 +1,89 @@
+<?php
+/**
+ * PHPUnit bootstrap file
+ *
+ * @package Statify_Blacklist
+ */
+
+/**
+ * Simulating the ABSPATH constant.
+ *
+ * @var boolean ABSPATH
+ */
+const ABSPATH = false;
+
+/*
+ * Include class files.
+ */
+require_once __DIR__ . '/../inc/class-statifyblacklist.php';
+require_once __DIR__ . '/../inc/class-statifyblacklist-admin.php';
+require_once __DIR__ . '/../inc/class-statifyblacklist-system.php';
+
+// Include Composer autoloader.
+require_once __DIR__ . '/../vendor/autoload.php';
+
+
+
+/** @ignore */
+function invoke_static( $class, $method_name, $parameters = array() ) {
+	$reflection = new \ReflectionClass( $class );
+	$method     = $reflection->getMethod( $method_name );
+	$method->setAccessible( true );
+
+	return $method->invokeArgs( null, $parameters );
+}
+
+// Some mocked WP functions.
+$mock_options   = array();
+$mock_multisite = false;
+
+/** @ignore */
+function is_multisite() {
+	global $mock_multisite;
+
+	return $mock_multisite;
+}
+
+/** @ignore */
+function wp_parse_args( $args, $defaults = '' ) {
+	if ( is_object( $args ) ) {
+		$r = get_object_vars( $args );
+	} elseif ( is_array( $args ) ) {
+		$r =& $args;
+	} else {
+		parse_str( $args, $r );
+	}
+
+	if ( is_array( $defaults ) ) {
+		return array_merge( $defaults, $r );
+	}
+
+	return $r;
+}
+
+/** @ignore */
+function get_option( $option, $default = false ) {
+	global $mock_options;
+
+	return isset( $mock_options[ $option ] ) ? $mock_options[ $option ] : $default;
+}
+
+/** @ignore */
+function update_option( $option, $value, $autoload = null ) {
+	global $mock_options;
+	$mock_options[ $option ] = $value;
+}
+
+/** @ignore */
+function wp_get_raw_referer() {
+	return isset( $_SERVER['HTTP_REFERER'] ) ? $_SERVER['HTTP_REFERER'] : '';
+}
+
+function wp_parse_url( $value ) {
+	return parse_url( $value );
+}
+
+/** @ignore */
+function wp_unslash( $value ) {
+	return is_string( $value ) ? stripslashes( $value ) : $value;
+}
--- a/views/settings-page.php
+++ b/views/settings-page.php
@ -88,7 +88,7 @@ if ( ! empty( $_POST['statifyblacklist'] ) ) {
 			);
 		}

-		// TODO: Extract user agent array.
+		// Extract user agent array.
 		if ( isset( $_POST['statifyblacklist']['ua']['blacklist'] ) ) {
 			$ua_string = sanitize_textarea_field( wp_unslash( $_POST['statifyblacklist']['ua']['blacklist'] ) );
 		}
@ -139,7 +139,7 @@ if ( ! empty( $_POST['statifyblacklist'] ) ) {
 						? (int) $_POST['statifyblacklist']['ua']['active'] : 0,
 					'regexp'    => isset( $_POST['statifyblacklist']['ua']['regexp'] )
 						? (int) $_POST['statifyblacklist']['ua']['regexp'] : 0,
-					'blacklist' => $ua,
+					'blacklist' => array_flip( $ua ),
 				),
 				'version' => StatifyBlacklist::VERSION_MAIN,
 			)
@ -457,9 +457,9 @@ if ( ! empty( $_POST['statifyblacklist'] ) ) {
 				<td>
 					<textarea cols="40" rows="5" name="statifyblacklist[ua][blacklist]" id="statify-blacklist_ua"><?php
 					if ( empty( $statifyblacklist_update_result['ua'] ) ) {
-						print esc_html( implode( "\r\n", StatifyBlacklist::$options['ua']['blacklist'] ) );
+						print esc_html( implode( "\r\n", array_keys( StatifyBlacklist::$options['ua']['blacklist'] ) ) );
 					} else {
-						print esc_html( implode( "\r\n", $statifyblacklist_update_result['ua']['sanitized'] ) );
+						print esc_html( implode( "\r\n", array_keys( $statifyblacklist_update_result['ua']['sanitized'] ) ) );
 					}
 					?></textarea>
Author	SHA1	Message	Date
Stefan Kalscheuer	2bf0bcb0fd	bump stable tag to 1.6.1	2021-05-28 11:55:21 +02:00
Stefan Kalscheuer	eb49dbc7db	fix output for user agent filter on settings page	2021-05-28 11:49:31 +02:00
Stefan Kalscheuer	be173c6428	prepare release 1.6.1	2021-05-28 11:43:37 +02:00
BananaSquishee	6ffa650254	fix storage of user agent filter list (#28 ) The user agent filer list is not flipped with the actual values as keys like the lists for referrer and target. Hence the numeric keys are compared against the actual user agent. We now flip the values in the upgrade hook.	2021-05-28 11:11:30 +02:00
Stefan Kalscheuer	6fdaa8bd5a	split unit test into separate test classes	2021-05-25 12:35:57 +02:00
Stefan Kalscheuer	e64122a5c6	skip sonar analysis for pull requests	2021-05-24 19:54:50 +02:00
Stefan Kalscheuer	5981971ddb	enable CI for pull requests	2021-05-24 19:18:54 +02:00
Stefan Kalscheuer	eee20e4d05	remove RoboFile The build process is trivial and does not require an additional task runner and deployments are done by the GH action, so we can remove the Robo dependency and clean up the build environment.	2021-05-22 19:30:04 +02:00
Stefan Kalscheuer	0a3102ee38	use GitHub actions for CI and automate Sonarcloud analysis	2021-05-17 20:47:21 +02:00
Stefan Kalscheuer	5f3fd8b554	minor dev-dependency updates	2021-05-16 10:11:12 +02:00
Stefan Kalscheuer	2f4428c0e4	use "stable" branch instead of "master"	2021-05-16 10:11:12 +02:00
Stefan Kalscheuer	e794758d77	declare compatibility with WordPress 5.7	2021-03-14 11:16:40 +01:00
Stefan Kalscheuer	91b612425b	introduce GitHub actions for automated plugin/asset deployment	2021-03-14 11:16:17 +01:00