PHStan for tests & lint fixes

wearerequired · May 16, 2024 · 1830a06 · 1830a06
1 parent 23f659e
commit 1830a06
Show file tree

Hide file tree

Showing 49 changed files with 742 additions and 425 deletions.
diff --git a/composer.json b/composer.json
@@ -41,16 +41,18 @@
     "wearerequired/traduttore-registry": "^2.0"
   },
   "require-dev": {
-    "dealerdirect/phpcodesniffer-composer-installer": "^v1.0.0",
-    "php-stubs/wp-cli-stubs": "^v2.10",
+    "dealerdirect/phpcodesniffer-composer-installer": "^1.0.0",
+    "php-stubs/wordpress-tests-stubs": "^6.5",
+    "php-stubs/wp-cli-stubs": "^2.10",
     "phpstan/extension-installer": "^1.3",
     "phpstan/phpstan-deprecation-rules": "^1.2",
+    "phpstan/phpstan-phpunit": "^1.4",
     "swissspidy/phpstan-no-private": "^0.2.0",
     "szepeviktor/phpstan-wordpress": "^1.3",
     "wearerequired/coding-standards": "^6.0",
     "wp-cli/extension-command": "^2.0",
     "wp-cli/rewrite-command": "^2.0",
-    "wp-cli/wp-cli-tests": "^v4.2.9",
+    "wp-cli/wp-cli-tests": "^4.2.9",
     "wpackagist-plugin/glotpress": "^4.0.0",
     "yoast/phpunit-polyfills": "^1.1"
   },
@@ -75,8 +77,8 @@
   },
   "config": {
     "allow-plugins": {
-      "dealerdirect/phpcodesniffer-composer-installer": true,
       "composer/installers": true,
+      "dealerdirect/phpcodesniffer-composer-installer": true,
       "phpstan/extension-installer": true
     },
     "process-timeout": 7200,

diff --git a/inc/CLI/InfoCommand.php b/inc/CLI/InfoCommand.php
@@ -149,7 +149,7 @@ protected function get_svn_binary_path(): ?string {
 	 * @return null|string Binary path on success, null otherwise.
 	 */
 	protected function get_wp_binary_path(): ?string {
-		if ( \defined( 'TRADUTTORE_WP_BIN' ) && TRADUTTORE_WP_BIN ) {
+		if ( \defined( 'TRADUTTORE_WP_BIN' ) && \is_string( TRADUTTORE_WP_BIN ) ) {
 			return TRADUTTORE_WP_BIN;
 		}
 

diff --git a/inc/CLI/ProjectCommand.php b/inc/CLI/ProjectCommand.php
@@ -88,8 +88,8 @@ public function info( array $args, array $assoc_args ): void {
 		$repository_visibility = $project->get_repository_visibility() ?? '(unknown)';
 		$repository_ssh_url    = $repository ? $repository->get_ssh_url() : '(unknown)';
 		$repository_https_url  = $repository ? $repository->get_https_url() : '(unknown)';
-		$repository_instance   = $repository ? \get_class( $repository ) : '(unknown)';
-		$loader_instance       = $loader ? \get_class( $loader ) : '(unknown)';
+		$repository_instance   = $repository ? $repository::class : '(unknown)';
+		$loader_instance       = $loader ? $loader::class : '(unknown)';
 
 		if ( get_flag_value( $assoc_args, 'format' ) === 'json' ) {
 			$info = [

diff --git a/inc/Configuration.php b/inc/Configuration.php
@@ -22,16 +22,16 @@ class Configuration {
 	 *
 	 * @var string Repository path.
 	 */
-	protected $path;
+	protected string $path;
 
 	/**
 	 * Repository configuration.
 	 *
 	 * @since 3.0.0
 	 *
-	 * @phpstan-var ProjectConfig
-	 *
 	 * @var array Repository configuration.
+	 *
+	 * @phpstan-var ProjectConfig
 	 */
 	protected $config = [];
 
@@ -64,9 +64,9 @@ public function get_path(): string {
 	 *
 	 * @since 3.0.0
 	 *
-	 * @phpstan-return ProjectConfig
-	 *
 	 * @return array<string,string|string[]> Repository configuration.
+	 *
+	 * @phpstan-return ProjectConfig
 	 */
 	public function get_config(): array {
 		return $this->config;
@@ -77,14 +77,14 @@ public function get_config(): array {
 	 *
 	 * @since 3.0.0
 	 *
+	 * @param string $key Config key.
+	 * @return string|string[]|null Config value.
+	 *
 	 * @phpstan-template T of key-of<ProjectConfig>
 	 * @phpstan-param T $key
 	 * @phpstan-return ProjectConfig[T] | null
-	 *
-	 * @param string $key Config key.
-	 * @return string|string[]|null Config value.
 	 */
-	public function get_config_value( string $key ) {
+	public function get_config_value( string $key ): string|array|null {
 		if ( isset( $this->config[ $key ] ) ) {
 			return $this->config[ $key ];
 		}
@@ -97,9 +97,9 @@ public function get_config_value( string $key ) {
 	 *
 	 * @since 3.0.0
 	 *
-	 * @phpstan-return ProjectConfig
-	 *
 	 * @return array<string,string|string[]> Configuration data if found.
+	 *
+	 * @phpstan-return ProjectConfig
 	 */
 	protected function load_config(): array {
 		$config_file   = trailingslashit( $this->path ) . 'traduttore.json';

diff --git a/inc/Export.php b/inc/Export.php
@@ -10,7 +10,6 @@
 use GP;
 use GP_Locales;
 use GP_Translation_Set;
-use InvalidArgumentException;
 
 /**
  * Export strings to translation files in PO, MO, and JSON format.
@@ -25,7 +24,7 @@ class Export {
 	 *
 	 * @var \GP_Translation_Set
 	 */
-	protected $translation_set;
+	protected GP_Translation_Set $translation_set;
 
 	/**
 	 * The current locale.
@@ -43,7 +42,7 @@ class Export {
 	 *
 	 * @var \Required\Traduttore\Project
 	 */
-	protected $project;
+	protected Project $project;
 
 	/**
 	 * List of generated files.
@@ -52,7 +51,7 @@ class Export {
 	 *
 	 * @var string[]
 	 */
-	protected $files;
+	protected array $files;
 
 	/**
 	 * Export constructor.
@@ -63,12 +62,13 @@ public function __construct( GP_Translation_Set $translation_set ) {
 		$this->translation_set = $translation_set;
 		$this->locale          = GP_Locales::by_slug( $translation_set->locale );
 
+		/**
+		 * GlotPress project.
+		 *
+		 * @var \GP_Project $gp_project
+		 */
 		$gp_project = GP::$project->get( $translation_set->project_id );
 
-		if ( ! $gp_project ) {
-			throw new InvalidArgumentException( __( 'Project not found', 'traduttore' ) );
-		}
-
 		$this->project = new Project( $gp_project );
 	}
 

diff --git a/inc/Loader/Base.php b/inc/Loader/Base.php
@@ -21,7 +21,7 @@ abstract class Base implements Loader {
 	 *
 	 * @var \Required\Traduttore\Repository Repository object.
 	 */
-	protected $repository;
+	protected Repository $repository;
 
 	/**
 	 * Class constructor.

diff --git a/inc/Plugin.php b/inc/Plugin.php
@@ -189,7 +189,7 @@ static function ( $events ) {
 					'description' => __( 'When a new translation ZIP file is built', 'traduttore' ),
 					'message'     => function ( $zip_path, $zip_url, GP_Translation_Set $translation_set ) {
 						/** @var \GP_Locale $locale */
-						$locale  = GP_Locales::by_slug( $translation_set->locale );
+						$locale = GP_Locales::by_slug( $translation_set->locale );
 
 						$gp_project = GP::$project->get( $translation_set->project_id );
 
@@ -397,10 +397,10 @@ public function filter_restricted_site_access_is_restricted( bool $is_restricted
 	 *
 	 * @since 3.0.0
 	 *
-	 * @phpstan-param \WP_REST_Request<array{}> $request
-	 *
 	 * @param \WP_REST_Request $request Request object.
 	 * @return bool True if permission is granted, false otherwise.
+	 *
+	 * @phpstan-param \WP_REST_Request<array{}> $request
 	 */
 	public function incoming_webhook_permission_callback( WP_REST_Request $request ): bool {
 		$result  = false;
@@ -429,12 +429,12 @@ public function incoming_webhook_permission_callback( WP_REST_Request $request )
 	 *
 	 * @since 3.0.0
 	 *
-	 * @phpstan-param \WP_REST_Request<array{}> $request
-	 *
 	 * @param \WP_REST_Request $request Request object.
 	 * @return \WP_Error|\WP_REST_Response REST response on success, error object on failure.
+	 *
+	 * @phpstan-param \WP_REST_Request<array{}> $request
 	 */
-	public function incoming_webhook_callback( WP_REST_Request $request ) {
+	public function incoming_webhook_callback( WP_REST_Request $request ): \WP_Error|\WP_REST_Response {
 		$result  = new \WP_Error( '400', 'Bad request' );
 		$handler = ( new WebhookHandlerFactory() )->get_handler( $request );
 

diff --git a/inc/Project.php b/inc/Project.php
@@ -101,7 +101,7 @@ class Project {
 	 *
 	 * @var \GP_Project Project information.
 	 */
-	protected $project;
+	protected GP_Project $project;
 
 	/**
 	 * Project constructor.

diff --git a/inc/ProjectLocator.php b/inc/ProjectLocator.php
@@ -23,16 +23,16 @@ class ProjectLocator {
 	 *
 	 * @var \Required\Traduttore\Project|null Project instance.
 	 */
-	protected $project;
+	protected ?Project $project;
 
 	/**
 	 * ProjectLocator constructor.
 	 *
 	 * @since 2.0.0
 	 *
-	 * @param int|string|Project|GP_Project $project Possible GlotPress project ID or path or source code repository path.
+	 * @param int|string|false|null|\Required\Traduttore\Project|\GP_Project $project Possible GlotPress project ID or path or source code repository path.
 	 */
-	public function __construct( $project ) {
+	public function __construct( int|string|false|\Required\Traduttore\Project|\GP_Project|null $project ) {
 		$this->project = $this->find_project( $project );
 	}
 
@@ -52,10 +52,10 @@ public function get_project(): ?Project {
 	 *
 	 * @since 2.0.0
 	 *
-	 * @param int|string|Project|GP_Project $project Possible GlotPress project ID or path or source code repository path.
+	 * @param int|string|false|null|\Required\Traduttore\Project|\GP_Project $project Possible GlotPress project ID or path or source code repository path.
 	 * @return \Required\Traduttore\Project Project instance.
 	 */
-	protected function find_project( $project ): ?Project {
+	protected function find_project( int|string|false|\Required\Traduttore\Project|\GP_Project|null $project ): ?Project {
 		if ( ! $project ) {
 			return null;
 		}

diff --git a/inc/Repository/Base.php b/inc/Repository/Base.php
@@ -23,7 +23,7 @@ abstract class Base implements Repository {
 	 *
 	 * @var \Required\Traduttore\Project Project information.
 	 */
-	protected $project;
+	protected Project $project;
 
 	/**
 	 * Loader constructor.
@@ -106,7 +106,7 @@ public function get_name(): string {
 			}
 
 			if ( $url ) {
-				$path = wp_parse_url( $url, PHP_URL_PATH );
+				$path  = wp_parse_url( $url, PHP_URL_PATH );
 				$path  = $path ? trim( $path, '/' ) : '';
 				$parts = explode( '/', $path );
 				$name  = implode( '/', array_splice( $parts, 0, 2 ) );

diff --git a/inc/Runner.php b/inc/Runner.php
@@ -22,7 +22,7 @@ class Runner {
 	 *
 	 * @var \Required\Traduttore\Loader VCS loader.
 	 */
-	protected $loader;
+	protected Loader $loader;
 
 	/**
 	 * Updater instance.
@@ -31,7 +31,7 @@ class Runner {
 	 *
 	 * @var \Required\Traduttore\Updater Translation updater.
 	 */
-	protected $updater;
+	protected Updater $updater;
 
 	/**
 	 * Runner constructor.

diff --git a/inc/Updater.php b/inc/Updater.php
@@ -32,7 +32,7 @@ class Updater {
 	 *
 	 * @var \Required\Traduttore\Project Project information.
 	 */
-	protected $project;
+	protected Project $project;
 
 	/**
 	 * Returns a new loader instance for a given project.
@@ -221,7 +221,7 @@ protected function create_pot_file( Configuration $config ): ?string {
 	 * @return string WP-CLI binary path.
 	 */
 	protected function get_wp_bin(): string {
-		if ( \defined( 'TRADUTTORE_WP_BIN' ) && TRADUTTORE_WP_BIN ) {
+		if ( \defined( 'TRADUTTORE_WP_BIN' ) && \is_string( TRADUTTORE_WP_BIN ) ) {
 			return TRADUTTORE_WP_BIN;
 		}
 

diff --git a/inc/WebhookHandler.php b/inc/WebhookHandler.php
@@ -20,9 +20,9 @@ interface WebhookHandler {
 	 *
 	 * @since 3.0.0
 	 *
-	 * @phpstan-param \WP_REST_Request<array{}> $request
-	 *
 	 * @param \WP_REST_Request $request Request object.
+	 *
+	 * @phpstan-param \WP_REST_Request<array{}> $request
 	 */
 	public function __construct( WP_REST_Request $request );
 
@@ -42,5 +42,5 @@ public function permission_callback(): ?bool;
 	 *
 	 * @return \WP_Error|\WP_REST_Response REST response on success, error object on failure.
 	 */
-	public function callback();
+	public function callback(): \WP_Error|\WP_REST_Response;
 }
diff --git a/inc/WebhookHandler/Base.php b/inc/WebhookHandler/Base.php
@@ -26,16 +26,16 @@ abstract class Base implements WebhookHandler {
 	 *
 	 * @phpstan-var \WP_REST_Request<array{}>
 	 */
-	protected $request;
+	protected WP_REST_Request $request;
 
 	/**
 	 * Class constructor.
 	 *
 	 * @since 3.0.0
 	 *
-	 * @phpstan-param \WP_REST_Request<array{}> $request
-	 *
 	 * @param \WP_REST_Request $request Request object.
+	 *
+	 * @phpstan-param \WP_REST_Request<array{}> $request
 	 */
 	public function __construct( WP_REST_Request $request ) {
 		$this->request = $request;
@@ -79,7 +79,7 @@ protected function get_secret( ?Project $project = null ): ?string {
 		 *
 		 * @since 3.0.0
 		 *
-		 * @param string                              $secret  Webhook sync secret.
+		 * @param string|null                         $secret  Webhook sync secret.
 		 * @param \Required\Traduttore\WebhookHandler $handler The current webhook handler instance.
 		 * @param \Required\Traduttore\Project|null   $project The current project if passed through.
 		 */

diff --git a/inc/WebhookHandler/Bitbucket.php b/inc/WebhookHandler/Bitbucket.php
@@ -34,7 +34,7 @@ public function permission_callback(): ?bool {
 			return false;
 		}
 
-		$token   = $this->request->get_header( 'x-hub-signature' );
+		$token   = $this->request->get_header( 'x-hub-signature-256' );
 		$params  = $this->request->get_params();
 		$locator = new ProjectLocator( $params['repository']['links']['html']['href'] ?? null );
 		$project = $locator->get_project();
@@ -60,7 +60,7 @@ public function permission_callback(): ?bool {
 	 *
 	 * @return \WP_Error|\WP_REST_Response REST response on success, error object on failure.
 	 */
-	public function callback() {
+	public function callback(): \WP_Error|\WP_REST_Response {
 		$params = $this->request->get_params();
 
 		$locator = new ProjectLocator( $params['repository']['links']['html']['href'] );