Merge pull request #9 from alleyinteractive/feature/terminate-request

Add phpstan, use terminate request if found

Author: srtfisher

.gitattributes

@@ -6,12 +6,13 @@
 # Via WPCS.
 #
 /.github export-ignore
-/phpcs.xml export-ignore
 /.phpcs export-ignore
-/phpunit.xml export-ignore
-/tests export-ignore
 /configure.php export-ignore
 /Makefile export-ignore
+/phpcs.xml export-ignore
+/phpstan.neon export-ignore
+/phpunit.xml export-ignore
+/tests export-ignore
 
 #
 # Auto detect text files and perform LF normalization.

CHANGELOG.md

@@ -2,6 +2,11 @@
 
 All notable changes to `Create PHP Package` will be documented in this file.
 
+## v1.1.1
+
+- Added PHPStan testing.
+- Use Mantle's [`terminate_request`](https://mantle.alley.com/docs/features/support/helpers#terminate_request) helper to terminate requests if available.
+
 ## v1.0.0 - 2023-02-07
 
 - Initial release of standalone package.

composer.json

@@ -20,7 +20,8 @@
     },
     "require-dev": {
         "alleyinteractive/alley-coding-standards": "^2.0",
-        "mantle-framework/testkit": "^1.0"
+        "mantle-framework/testkit": "^1.8",
+        "szepeviktor/phpstan-wordpress": "^2.0"
     },
     "minimum-stability": "dev",
     "prefer-stable": true,
@@ -52,9 +53,11 @@
     "scripts": {
         "phpcbf": "phpcbf .",
         "phpcs": "phpcs .",
+        "phpstan": "phpstan --memory-limit=512M",
         "phpunit": "phpunit",
         "test": [
             "@phpcs",
+            "@phpstan",
             "@phpunit"
         ]
     }

phpstan.neon

@@ -0,0 +1,9 @@
+includes:
+  - vendor/szepeviktor/phpstan-wordpress/extension.neon
+
+parameters:
+	# Level 9 is the highest level
+	level: max
+
+	paths:
+		- src/

src/class-path-dispatch.php

@@ -10,38 +10,53 @@
 
 use WP_Query;
 
+use function Mantle\Support\Helpers\terminate_request;
+
 /**
  * Path Dispatch
+ *
+ * @phpstan-type PathArgs array{
+ *   path?: string,
+ *   callback?: callable,
+ *   action?: string,
+ *   rewrite?: array{
+ *     rule: string,
+ *     redirect?: string,
+ *     position?: 'top'|'bottom',
+ *     query_vars?: string|array<string>
+ *   },
+ *   template?: string
+ * }
  */
 class Path_Dispatch {
 
 	/**
 	 * Query vars that should be allowed.
 	 *
-	 * @var array
+	 * @var string[]
 	 */
-	public $qv = [ 'dispatch' ];
+	public array $qv = [ 'dispatch' ];
 
 	/**
 	 * Array of basic paths.
 	 *
-	 * @var array
+	 * @var array<string, PathArgs>
 	 */
-	public $basic_paths = [];
+	public array $basic_paths = [];
 
 	/**
 	 * Array of rewrite paths.
 	 *
-	 * @var array
+	 * @var array<string, PathArgs>
 	 */
-	public $rewrite_paths = [];
+	public array $rewrite_paths = [];
 
 	/**
 	 * Instance of this class.
 	 *
-	 * @var Path_Dispatch
+	 * @var Path_Dispatch|null
 	 */
-	private static $instance;
+	private static ?Path_Dispatch $instance;
 
 	/**
 	 * Don't allow __clone.
@@ -62,17 +77,18 @@ public function __wakeup() {
 	 *
 	 * @return Path_Dispatch
 	 */
-	public static function instance() {
+	public static function instance(): Path_Dispatch {
 		if ( ! isset( self::$instance ) ) {
 			self::$instance = new Path_Dispatch();
 		}
+
 		return self::$instance;
 	}
 
 	/**
 	 * Clear the instance of this class.
 	 */
-	public static function clear_instance() {
+	public static function clear_instance(): void {
 		self::$instance = null;
 	}
 
@@ -114,8 +130,9 @@ protected function __construct() {
 	 *                                         @see http://codex.wordpress.org/Plugin_API/Filter_Reference/query_vars
 	 *      }
 	 * }
+	 * @phpstan-param PathArgs|string $args
 	 */
-	public function add_path( $args = [] ) {
+	public function add_path( array|string $args = [] ): void {
 		if ( is_string( $args ) && ! empty( $args ) ) {
 			$args = [
 				'path' => $args,
@@ -143,11 +160,12 @@ public function add_path( $args = [] ) {
 	/**
 	 * Add multiple paths in one call.
 	 *
-	 * @see Path_Dispatch::add_path
+	 * @see Path_Dispatch::add_path()
 	 *
 	 * @param array $paths An array of arrays that would be passed to add_path.
+	 * @phpstan-param array<PathArgs> $paths
 	 */
-	public function add_paths( $paths ) {
+	public function add_paths( array $paths ): void {
 		foreach ( $paths as $path ) {
 			$this->add_path( $path );
 		}
@@ -156,17 +174,17 @@ public function add_paths( $paths ) {
 	/**
 	 * Add the class query var "dispatch" as well as any others added through add_path.
 	 *
-	 * @param array $qv The current query vars.
-	 * @return array The modified query vars.
+	 * @param string[] $qv The current query vars.
+	 * @return string[] The modified query vars.
 	 */
-	public function add_query_var( $qv ) {
+	public function add_query_var( array $qv ): array {
 		return array_merge( $qv, $this->qv );
 	}
 
 	/**
 	 * Add rewrite rules for our dispatched paths.
 	 */
-	public function add_rewrite_rules() {
+	public function add_rewrite_rules(): void {
 		if ( ! empty( $this->basic_paths ) ) {
 			$slugs = array_map( 'preg_quote', array_keys( $this->basic_paths ) );
 			$slugs = implode( '|', $slugs );
@@ -194,9 +212,9 @@ public function add_rewrite_rules() {
 	 *
 	 * @param WP_Query $query The WP_Query instance.
 	 */
-	public function dispatch_path( &$query ) {
+	public function dispatch_path( &$query ): void {
 		$path = get_query_var( 'dispatch' );
-		if ( $query->is_main_query() && $path ) {
+		if ( $query->is_main_query() && $path && is_string( $path ) ) {
 			$args = [];
 
 			if ( ! empty( $this->basic_paths[ $path ] ) ) {
@@ -213,8 +231,23 @@ public function dispatch_path( &$query ) {
 
 			if ( ! empty( $args['template'] ) ) {
 				get_template_part( 'dispatch', $args['template'] );
-				exit;
+
+				$this->terminate_request();
 			}
 		}
 	}
+
+	/**
+	 * Terminate the request.
+	 *
+	 * @param int $exit_status Exit status code.
+	 * @return never
+	 */
+	protected function terminate_request( int $exit_status = 0 ): never {
+		if ( function_exists( 'Mantle\Support\Helpers\terminate_request' ) ) {
+			\Mantle\Support\Helpers\terminate_request( $exit_status );
+		}
+
+		exit( (int) $exit_status );
+	}
 }

src/helpers.php

@@ -14,6 +14,6 @@
  *
  * @return Path_Dispatch
  */
-function Path_Dispatch() {
+function Path_Dispatch(): Path_Dispatch {
 	return Path_Dispatch::instance();
 }

tests/Feature/PathDispatchTest.php

@@ -4,6 +4,7 @@
 use WP_Path_Dispatch\Path_Dispatch;
 use WP_Path_Dispatch\Tests\TestCase;
 
+use function Mantle\Support\Helpers\terminate_request;
 use function WP_Path_Dispatch\Path_Dispatch;
 
 /**
@@ -29,6 +30,7 @@ public function test_add_simple_path() {
 				'path'     => 'some-path',
 				'callback' => function () {
 					echo 'some-response';
+					terminate_request();
 				},
 			]
 		);
@@ -37,7 +39,7 @@ public function test_add_simple_path() {
 
 		$this->get( '/some-path/' )
 			->assertStatus( 200 )
-			->assertSee( 'some-response' );
+			->assertContent( 'some-response' );
 	}
 
 	public function test_add_multiple_paths() {
@@ -47,12 +49,14 @@ public function test_add_multiple_paths() {
 					'path'     => 'some-path',
 					'callback' => function () {
 						echo 'some-response';
+						terminate_request();
 					},
 				],
 				[
 					'path'     => 'some-other-path',
 					'callback' => function () {
 						echo 'some-other-response';
+						terminate_request();
 					},
 				],
 			]
@@ -62,11 +66,11 @@ public function test_add_multiple_paths() {
 
 		$this->get( '/some-path/' )
 			->assertStatus( 200 )
-			->assertSee( 'some-response' );
+			->assertContent( 'some-response' );
 
 		$this->get( '/some-other-path/' )
 			->assertStatus( 200 )
-			->assertSee( 'some-other-response' );
+			->assertContent( 'some-other-response' );
 	}
 
 	public function test_action_path() {
@@ -95,6 +99,7 @@ public function test_custom_rewrite_path() {
 				],
 				'callback' => function () {
 					echo 'some-response: ' . get_query_var( 'some_query_var' );
+					terminate_request();
 				},
 			]
 		);
@@ -103,7 +108,30 @@ public function test_custom_rewrite_path() {
 
 		$this->get( '/example/foo/' )
 			->assertOk()
-			->assertSee( 'some-response: foo' );
+			->assertContent( 'some-response: foo' );
+	}
+
+	public function test_template_path(): void {
+		// Fake the template part being loaded.
+		add_action(
+			'get_template_part',
+			function (): void {
+				echo 'This is a template path response.';
+			}
+		);
+
+		Path_Dispatch()->add_path(
+			[
+				'path'     => 'some-path',
+				'template' => 'some-template',
+			]
+		);
+
+		$this->register_rules();
+
+		$this->get( '/some-path/' )
+			->assertOk()
+			->assertContent( 'This is a template path response.' );
 	}
 
 	protected function register_rules() {

tests/TestCase.php

@@ -1,7 +1,7 @@
 <?php
 namespace WP_Path_Dispatch\Tests;
 
-use Mantle\Testkit\Test_Case as TestkitTest_Case;
+use Mantle\Testkit\TestCase as TestkitTest_Case;
 
 /**
  * WP Path Dispatch Base Test Case