Merge pull request #566 from pedro-mendonca/dev

Include tests in WPCS lint

phpcs.xml.dist

@@ -9,7 +9,6 @@
 	<exclude-pattern>*/lib/*</exclude-pattern>
 	<exclude-pattern>*/node_modules/*</exclude-pattern>
 	<exclude-pattern>*/vendor/*</exclude-pattern>
-	<exclude-pattern>*/tests/*</exclude-pattern>
 
 	<!-- Only scan PHP files. -->
 	<arg name="extensions" value="php"/>

tests/phpstan/bootstrap.php

@@ -5,7 +5,6 @@
  * @package Translation_Stats
  */
 
-
 // Set Translation Stats plugin version.
 if ( ! defined( 'TRANSLATION_STATS_VERSION' ) ) {
 	define( 'TRANSLATION_STATS_VERSION', '1.2.5' );

tests/phpunit/bootstrap.php

@@ -5,34 +5,34 @@
  * @package Translation_Stats
  */
 
-$_tests_dir = getenv( 'WP_TESTS_DIR' );
+$translation_stats_tests_dir = getenv( 'WP_TESTS_DIR' );
 
-if ( ! $_tests_dir ) {
-	$_tests_dir = rtrim( sys_get_temp_dir(), '/\\' ) . '/wordpress-tests-lib';
+if ( ! $translation_stats_tests_dir ) {
+	$translation_stats_tests_dir = rtrim( sys_get_temp_dir(), '/\\' ) . '/wordpress-tests-lib';
 }
 
 // Forward custom PHPUnit Polyfills configuration to PHPUnit bootstrap file.
-$_phpunit_polyfills_path = getenv( 'WP_TESTS_PHPUNIT_POLYFILLS_PATH' );
-if ( false !== $_phpunit_polyfills_path ) {
-	define( 'WP_TESTS_PHPUNIT_POLYFILLS_PATH', $_phpunit_polyfills_path );
+$translation_stats_phpunit_polyfills_path = getenv( 'WP_TESTS_PHPUNIT_POLYFILLS_PATH' );
+if ( false !== $translation_stats_phpunit_polyfills_path ) {
+	define( 'WP_TESTS_PHPUNIT_POLYFILLS_PATH', $translation_stats_phpunit_polyfills_path ); // phpcs:ignore
 }
 
-if ( ! file_exists( "{$_tests_dir}/includes/functions.php" ) ) {
-	echo "Could not find {$_tests_dir}/includes/functions.php, have you run bin/install-wp-tests.sh ?" . PHP_EOL; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
+if ( ! file_exists( "{$translation_stats_tests_dir}/includes/functions.php" ) ) {
+	echo "Could not find {$translation_stats_tests_dir}/includes/functions.php, have you run bin/install-wp-tests.sh ?" . PHP_EOL; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
 	exit( 1 );
 }
 
 // Give access to tests_add_filter() function.
-require_once "{$_tests_dir}/includes/functions.php";
+require_once "{$translation_stats_tests_dir}/includes/functions.php";
 
 /**
  * Manually load the plugin being tested.
  */
-function _manually_load_plugin() {
+function translation_stats_manually_load_plugin() {
 	require dirname( dirname( __DIR__ ) ) . '/translation-stats.php';
 }
 
-tests_add_filter( 'muplugins_loaded', '_manually_load_plugin' );
+tests_add_filter( 'muplugins_loaded', 'translation_stats_manually_load_plugin' );
 
 // Start up the WP testing environment.
-require "{$_tests_dir}/includes/bootstrap.php";
+require "{$translation_stats_tests_dir}/includes/bootstrap.php";

tests/phpunit/includes/test-admin-notice.php

@@ -5,7 +5,7 @@
  * @package Translation_Stats
  */
 
-Use Translation_Stats\Admin_Notice;
+use Translation_Stats\Admin_Notice;
 
 
 /**
@@ -69,6 +69,9 @@ public function provide_test_sanitize_type() {
 	 * Test type sanitization.
 	 *
 	 * @dataProvider provide_test_sanitize_type
+	 *
+	 * @param string $type              The type of the admin notice.
+	 * @param string $expected_result   The expected result for the test.
 	 */
 	public function test_sanitize_type( $type, $expected_result ) {
 
@@ -79,7 +82,6 @@ public function test_sanitize_type( $type, $expected_result ) {
 		$admin_notice = new Admin_Notice( $args );
 
 		$this->assertSame( $admin_notice->type, $expected_result );
-
 	}
 
 	/**
@@ -291,6 +293,17 @@ public function provide_test_notice_html() {
 	 * Test wrap sanitization.
 	 *
 	 * @dataProvider provide_test_notice_html
+	 *
+	 * @param string $type                 The type of the admin notice.
+	 * @param bool   $notice_alt           Wether to set as notice-alt.
+	 * @param bool   $inline               Wether to set as inline.
+	 * @param bool   $dismissible          Wether to set as dismissible.
+	 * @param array  $additional_classes   The type of the admin notice.
+	 * @param bool   $update_icon          Wether to use the update-icon.
+	 * @param string $message              The message of the admin notice.
+	 * @param string $wrap                 The HTML to wrap the admin notice message.
+	 * @param string $extra_html           The extra HTML markup to add to the end of the admin message.
+	 * @param string $expected_result      The expected result for the test.
 	 */
 	public function test_notice_html( $type, $notice_alt, $inline, $dismissible, $additional_classes, $update_icon, $message, $wrap, $extra_html, $expected_result ) {
 
@@ -312,7 +325,6 @@ public function test_notice_html( $type, $notice_alt, $inline, $dismissible, $ad
 		$markup = $admin_notice->notice_html();
 
 		$this->assertSame( $markup, $expected_result );
-
 	}
 
 	/**
@@ -367,6 +379,9 @@ public function provide_test_sanitize_wrap() {
 	 * Test wrap sanitization.
 	 *
 	 * @dataProvider provide_test_sanitize_wrap
+	 *
+	 * @param string $wrap              The HTML to wrap the admin notice message.
+	 * @param string $expected_result   The expected result for the test.
 	 */
 	public function test_sanitize_wrap( $wrap, $expected_result ) {
 
@@ -377,7 +392,6 @@ public function test_sanitize_wrap( $wrap, $expected_result ) {
 		$admin_notice = new Admin_Notice( $args );
 
 		$this->assertSame( $admin_notice->wrap, $expected_result );
-
 	}
 
 	/**
@@ -394,6 +408,5 @@ public function test_render() {
 		$admin_notice = new Admin_Notice( $args );
 
 		$admin_notice->render();
-
 	}
 }

tests/phpunit/includes/test-locale.php

@@ -5,8 +5,8 @@
  * @package Translation_Stats
  */
 
-Use Translation_Stats\Locale;
-Use Translation_Stats\GP_Locale;
+use Translation_Stats\Locale;
+use Translation_Stats\GP_Locale;
 
 
 /**
@@ -20,29 +20,28 @@ class Test_Locale extends WP_UnitTestCase {
 	public function test_construct() {
 
 		$pt = new GP_Locale();
-		$pt->english_name = 'Portuguese (Portugal)';
-		$pt->native_name = 'Português';
+
+		$pt->english_name        = 'Portuguese (Portugal)';
+		$pt->native_name         = 'Português';
 		$pt->lang_code_iso_639_1 = 'pt';
-		$pt->country_code = 'pt';
-		$pt->wp_locale = 'pt_PT';
-		$pt->slug = 'pt';
-		$pt->google_code = 'pt-PT';
-		$pt->facebook_locale = 'pt_PT';
+		$pt->country_code        = 'pt';
+		$pt->wp_locale           = 'pt_PT';
+		$pt->slug                = 'pt';
+		$pt->google_code         = 'pt-PT';
+		$pt->facebook_locale     = 'pt_PT';
 
 		$locale = new Locale( $pt );
 
 		$this->assertNull( $locale->translations );
 
 		$this->assertSame(
- 			$locale->locale_slug,
- 			'pt/default'
- 		);
+			$locale->locale_slug,
+			'pt/default'
+		);
 
 		$this->assertSame(
- 			$locale->wporg_subdomain,
- 			'pt'
- 		);
-
+			$locale->wporg_subdomain,
+			'pt'
+		);
 	}
-
 }

tests/phpunit/includes/test-locales.php

@@ -5,8 +5,8 @@
  * @package Translation_Stats
  */
 
-Use Translation_Stats\Locales;
-Use Translation_Stats\GP_Locales;
+use Translation_Stats\Locales;
+use Translation_Stats\GP_Locales;
 
 
 /**
@@ -22,10 +22,8 @@ public function test_instance() {
 		$this->assertFalse( isset( $GLOBALS['translation_stats_locales'] ) );
 
 		// Get wordpress.org Locales.
-		$locales = Locales::locales();
+		Locales::locales();
 
 		$this->assertTrue( isset( $GLOBALS['translation_stats_locales'] ) );
-
 	}
-
 }

tests/phpunit/includes/test-translations-api.php

@@ -5,7 +5,7 @@
  * @package Translation_Stats
  */
 
-Use Translation_Stats\Translations_API;
+use Translation_Stats\Translations_API;
 
 
 /**
@@ -37,7 +37,6 @@ public function test_get_plugin_slug() {
 		$plugin_slug = Translations_API::get_plugin_slug( 'translation-stats' );
 
 		$this->assertSame( $plugin_slug, 'translation-stats' );
-
 	}
 
 
@@ -61,7 +60,6 @@ public function test_translations_api_get_plugin() {
 		$response_code = wp_remote_retrieve_response_code( $response );
 
 		$this->assertSame( $response_code, 404 );
-
 	}
 
 
@@ -99,7 +97,6 @@ public function test_plugin_subprojects() {
 			$plugin_subprojects,
 			$expected
 		);
-
 	}
 
 
@@ -180,6 +177,10 @@ public function provide_test_translate_url() {
 	 * Test the translate site URL.
 	 *
 	 * @dataProvider provide_test_translate_url
+	 *
+	 * @param string $project           The project.
+	 * @param bool   $api               Wether to get an API URL.
+	 * @param string $expected_result   The expected result for the test.
 	 */
 	public function test_translate_url( $project, $api, $expected_result ) {
 
@@ -189,7 +190,5 @@ public function test_translate_url( $project, $api, $expected_result ) {
 			$translate_url,
 			$expected_result
 		);
-
 	}
-
 }

tests/phpunit/includes/test-translations-stats.php

@@ -5,7 +5,7 @@
  * @package Translation_Stats
  */
 
-Use Translation_Stats\Translation_Stats;
+use Translation_Stats\Translation_Stats;
 
 
 /**
@@ -23,7 +23,7 @@ public function test_plugin_action_links() {
 			'deactivate' => '<a href="#" id="deactivate-akismet" aria-label="Deactivate Akismet">Deactivate</a>',
 		);
 
-		$translation_stats = new Translation_Stats;
+		$translation_stats = new Translation_Stats();
 
 		$plugin_action_links = $translation_stats->plugin_action_links( $links );
 
@@ -34,7 +34,6 @@ public function test_plugin_action_links() {
 				'deactivate' => '<a href="#" id="deactivate-akismet" aria-label="Deactivate Akismet">Deactivate</a>',
 			)
 		);
-
 	}
 
 
@@ -43,7 +42,7 @@ public function test_plugin_action_links() {
 	 */
 	public function test_allowed_pages() {
 
-		$translation_stats = new Translation_Stats;
+		$translation_stats = new Translation_Stats();
 
 		// Allowed pages.
 		$this->assertTrue( $translation_stats->allowed_pages( 'plugins.php' ) );
@@ -57,7 +56,5 @@ public function test_allowed_pages() {
 		$this->assertFalse( $translation_stats->allowed_pages( null ) );
 		$this->assertFalse( $translation_stats->allowed_pages( true ) );
 		$this->assertFalse( $translation_stats->allowed_pages( false ) );
-
 	}
-
 }