Adjust directory structure to align with WP core

gziolo · gziolo · commit c1e76fcb0ca5 · 2025-08-14T12:40:45.000+02:00
See rules for PHP Tests at https://make.wordpress.org/core/handbook/testing/automated-testing/writing-phpunit-tests/. See best practices for plugins at https://developer.wordpress.org/plugins/plugin-basics/best-practices/.
diff --git a/abilities-api.php b/abilities-api.php
@@ -34,19 +34,19 @@
 /**
  * First the WP_Ability class that users can extend.
  */
-require_once WP_ABILITIES_API_DIR . 'src/class-wp-ability.php';
+require_once WP_ABILITIES_API_DIR . 'includes/abilities-api/class-wp-ability.php';
 
 /**
  * Then the WP_Abilities_Registry class that manages the abilities.
  */
-require_once WP_ABILITIES_API_DIR . 'src/class-wp-abilities-registry.php';
+require_once WP_ABILITIES_API_DIR . 'includes/abilities-api/class-wp-abilities-registry.php';
 
 /**
  * Then the public access functions that users can use to interact with the abilities.
  */
-require_once WP_ABILITIES_API_DIR . 'src/abilities-api.php';
+require_once WP_ABILITIES_API_DIR . 'includes/abilities-api.php';
 
 /**
  * Initialize REST API controllers.
  */
-require_once WP_ABILITIES_API_DIR . 'src/rest/class-wp-rest-abilities-init.php';
+require_once WP_ABILITIES_API_DIR . 'includes/rest/class-wp-rest-abilities-init.php';
diff --git a/includes/abilities-api.php b/includes/abilities-api.php
diff --git a/includes/abilities-api/class-wp-abilities-registry.php b/includes/abilities-api/class-wp-abilities-registry.php
diff --git a/includes/abilities-api/class-wp-ability.php b/includes/abilities-api/class-wp-ability.php
diff --git a/includes/rest-api/class-wp-rest-abilities-init.php b/includes/rest-api/class-wp-rest-abilities-init.php
@@ -22,8 +22,8 @@ class WP_REST_Abilities_Init {
 	 * @return void
 	 */
 	public static function register_routes(): void {
-		require_once __DIR__ . '/class-wp-rest-abilities-run-controller.php';
-		require_once __DIR__ . '/class-wp-rest-abilities-list-controller.php';
+		require_once __DIR__ . '/endpoints/class-wp-rest-abilities-run-controller.php';
+		require_once __DIR__ . '/endpoints/class-wp-rest-abilities-list-controller.php';
 
 		$run_controller = new WP_REST_Abilities_Run_Controller();
 		$run_controller->register_routes();
diff --git a/includes/rest-api/endpoints/class-wp-rest-abilities-list-controller.php b/includes/rest-api/endpoints/class-wp-rest-abilities-list-controller.php
diff --git a/includes/rest-api/endpoints/class-wp-rest-abilities-run-controller.php b/includes/rest-api/endpoints/class-wp-rest-abilities-run-controller.php
diff --git a/phpcs.xml.dist b/phpcs.xml.dist
@@ -7,7 +7,7 @@
 	<description>Sniffs for Abilities API plugin</description>
 
 	<!-- What to scan: include any root-level PHP files, and the /inc folder -->
-	<file>./src/</file>
+	<file>./includes/</file>
 	<file>./abilities-api.php</file>
 
 	<!-- These are excluded from the above paths.-->
@@ -193,21 +193,21 @@
 			<property name="enableStandaloneNullTrueFalseTypeHints" value="false" /><!-- Only available in PHP 8.2+ -->
 		</properties>
 	</rule>
-	
-	<!-- 
+
+	<!--
 		Exclude REST controllers from type hint requirements.
 		WordPress core's WP_REST_Controller doesn't have type hints on its methods.
 		Adding type hints to our overridden methods causes fatal errors at runtime
 		due to signature mismatch. We must match the parent class signatures exactly.
 	-->
 	<rule ref="SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint">
-		<exclude-pattern>src/rest/class-wp-rest-abilities-*-controller.php</exclude-pattern>
+		<exclude-pattern>includes/rest-api/endpoints/class-wp-rest-abilities-*-controller.php</exclude-pattern>
 	</rule>
 	<rule ref="SlevomatCodingStandard.TypeHints.ReturnTypeHint.MissingNativeTypeHint">
-		<exclude-pattern>src/rest/class-wp-rest-abilities-*-controller.php</exclude-pattern>
+		<exclude-pattern>includes/rest-api/endpoints/class-wp-rest-abilities-*-controller.php</exclude-pattern>
 	</rule>
 	<rule ref="Squiz.Commenting.FunctionComment.TypeHintMissing">
-		<exclude-pattern>src/rest/class-wp-rest-abilities-*-controller.php</exclude-pattern>
+		<exclude-pattern>includes/rest-api/endpoints/class-wp-rest-abilities-*-controller.php</exclude-pattern>
 	</rule>
 
 	<rule ref="SlevomatCodingStandard.Variables.DisallowVariableVariable" />
diff --git a/phpstan.neon.dist b/phpstan.neon.dist
@@ -21,7 +21,7 @@ parameters:
 				- abilities-api.php
 		paths:
 				- abilities-api.php
-				- src/
+				- includes/
 		excludePaths:
 			analyse:
 				- tests/
@@ -38,5 +38,5 @@ parameters:
 			-
 				message: '#has parameter \$request with generic class WP_REST_Request but does not specify its types#'
 				paths:
-					- src/rest/*.php
+					- includes/rest-api/**/*.php
 
diff --git a/phpunit.xml.dist b/phpunit.xml.dist
@@ -15,12 +15,12 @@
 >
 	<testsuites>
 		<testsuite name="unit">
-			<directory suffix="Test.php">tests/unit</directory>
+			<directory suffix=".php">tests/unit</directory>
 		</testsuite>
 	</testsuites>
 	<coverage processUncoveredFiles="false">
 		<include>
-			<directory suffix=".php">src</directory>
+			<directory suffix=".php">includes</directory>
 			<file>abilities-api.php</file>
 		</include>
 		<report>
diff --git a/tests/unit/abilities-api/wpAbilitiesRegistry.php b/tests/unit/abilities-api/wpAbilitiesRegistry.php
@@ -5,7 +5,7 @@
  *
  * @group abilities-api
  */
-class Tests_Abilities_API_wpAbilitiesRegistry extends WP_UnitTestCase {
+class Tests_Abilities_API_WpAbilitiesRegistry extends WP_UnitTestCase {
 
 	public static $test_ability_name       = 'test/add-numbers';
 	public static $test_ability_properties = array();
diff --git a/tests/unit/abilities-api/wpRegisterAbility.php b/tests/unit/abilities-api/wpRegisterAbility.php
@@ -8,7 +8,7 @@
  *
  * @group abilities-api
  */
-class AbilitiesAPITest extends WP_UnitTestCase {
+class Test_Abilities_API_WpRegisterAbility extends WP_UnitTestCase {
 
 	public static $test_ability_name       = 'test/add-numbers';
 	public static $test_ability_properties = array();
diff --git a/tests/unit/rest-api/wpRestAbilitiesInit.php b/tests/unit/rest-api/wpRestAbilitiesInit.php
@@ -2,12 +2,12 @@
 
 /**
  * Tests for WP_REST_Abilities_Init
- * 
+ *
  * @covers WP_REST_Abilities_Init
  * @group abilities-api
  * @group rest-api
  */
-class WPRESTAbilitiesInitTest extends WP_UnitTestCase {
+class Tests_REST_API_WpRestAbilitiesInit extends WP_UnitTestCase {
 
 	/**
 	 * REST Server instance.
@@ -64,14 +64,14 @@ public function test_correct_controllers_instantiated(): void {
 		do_action( 'rest_api_init' );
 
 		$routes = $this->server->get_routes();
-		
+
 		// Check list controller
 		$this->assertArrayHasKey( '/wp/v2/abilities', $routes );
 		$list_route = $routes['/wp/v2/abilities'][0];
 		$this->assertIsArray( $list_route['callback'] );
 		$this->assertInstanceOf( 'WP_REST_Abilities_List_Controller', $list_route['callback'][0] );
-		
-		// Check run controller  
+
+		// Check run controller
 		$this->assertArrayHasKey( '/wp/v2/abilities/(?P<name>[a-zA-Z0-9\\-\\/]+?)/run', $routes );
 		$run_route = $routes['/wp/v2/abilities/(?P<name>[a-zA-Z0-9\\-\\/]+?)/run'][0];
 		$this->assertIsArray( $run_route['callback'] );
@@ -95,7 +95,7 @@ public function test_routes_support_expected_methods(): void {
 		do_action( 'rest_api_init' );
 
 		$routes = $this->server->get_routes();
-		
+
 		// List endpoint should support GET
 		$list_methods = $routes['/wp/v2/abilities'][0]['methods'];
 		// Methods can be a string like 'GET' or an array of method constants
@@ -105,7 +105,7 @@ public function test_routes_support_expected_methods(): void {
 			// Just check it's set, don't check specific values
 			$this->assertNotEmpty( $list_methods );
 		}
-		
+
 		// Single ability endpoint should support GET
 		$single_methods = $routes['/wp/v2/abilities/(?P<name>[a-zA-Z0-9\\-\\/]+)'][0]['methods'];
 		// Methods can be a string like 'GET' or an array of method constants
@@ -115,7 +115,7 @@ public function test_routes_support_expected_methods(): void {
 			// Just check it's set, don't check specific values
 			$this->assertNotEmpty( $single_methods );
 		}
-		
+
 		// Run endpoint should support all methods (for type-based routing)
 		$run_route = $routes['/wp/v2/abilities/(?P<name>[a-zA-Z0-9\\-\\/]+?)/run'][0];
 		// ALLMETHODS can be a string or array
@@ -151,18 +151,18 @@ public function test_namespace_and_base_configuration(): void {
 	public function test_no_duplicate_routes_on_multiple_init(): void {
 		// First init
 		do_action( 'rest_api_init' );
-		
+
 		$routes_first = $this->server->get_routes();
 		$abilities_route_count_first = count( $routes_first['/wp/v2/abilities'] ?? array() );
-		
+
 		// Second init (simulating multiple calls)
 		// Note: WordPress doesn't prevent duplicate registration, so we expect 2x routes
 		WP_REST_Abilities_Init::register_routes();
-		
+
 		$routes_second = $this->server->get_routes();
 		$abilities_route_count_second = count( $routes_second['/wp/v2/abilities'] ?? array() );
-		
+
 		// WordPress allows duplicate route registration
 		$this->assertEquals( $abilities_route_count_first * 2, $abilities_route_count_second );
 	}
-}
+}
diff --git a/tests/unit/rest-api/wpRestAbilitiesListController.php b/tests/unit/rest-api/wpRestAbilitiesListController.php
@@ -5,7 +5,7 @@
  * @group abilities-api
  * @group rest-api
  */
-class WPRESTAbilitiesListControllerTest extends WP_UnitTestCase {
+class Tests_REST_API_WpRestAbilitiesListController extends WP_UnitTestCase {
 
 	/**
 	 * REST Server instance.
@@ -460,10 +460,10 @@ public function test_ability_name_with_invalid_special_characters( string $name
 	public function test_extremely_long_ability_names(): void {
 		// Create a very long but valid ability name
 		$long_name = 'test/' . str_repeat( 'a', 1000 );
-		
+
 		$request = new WP_REST_Request( 'GET', '/wp/v2/abilities/' . $long_name );
 		$response = $this->server->dispatch( $request );
-		
+
 		// Should return 404 as ability doesn't exist
 		$this->assertEquals( 404, $response->get_status() );
 	}
@@ -494,12 +494,12 @@ public function invalid_pagination_params_provider(): array {
 	public function test_invalid_pagination_parameters( array $params ): void {
 		$request = new WP_REST_Request( 'GET', '/wp/v2/abilities' );
 		$request->set_query_params( $params );
-		
+
 		$response = $this->server->dispatch( $request );
-		
+
 		// Should either use defaults or return error
 		$this->assertContains( $response->get_status(), array( 200, 400 ) );
-		
+
 		if ( $response->get_status() === 200 ) {
 			// Check that reasonable defaults were used
 			$data = $response->get_data();
diff --git a/tests/unit/rest-api/wpRestAbilitiesRunController.php b/tests/unit/rest-api/wpRestAbilitiesRunController.php
@@ -5,7 +5,7 @@
  * @group abilities-api
  * @group rest-api
  */
-class WPRESTAbilitiesRunControllerTest extends WP_UnitTestCase {
+class Tests_REST_API_WpRestAbilitiesRunController extends WP_UnitTestCase {
 
 	/**
 	 * REST Server instance.
@@ -516,7 +516,7 @@ public function test_invalid_json_in_post_body(): void {
 		$request->set_body( '{"input": {invalid json}' );
 
 		$response = $this->server->dispatch( $request );
-		
+
 		// When JSON is invalid, WordPress returns 400 Bad Request
 		$this->assertEquals( 400, $response->get_status() );
 	}
@@ -539,7 +539,7 @@ public function test_get_request_with_nested_input_array(): void {
 
 		$response = $this->server->dispatch( $request );
 		$this->assertEquals( 200, $response->get_status() );
-		
+
 		$data = $response->get_data();
 		$this->assertEquals( 'nested', $data['level1']['level2']['value'] );
 		$this->assertEquals( array( 1, 2, 3 ), $data['array'] );
@@ -609,7 +609,7 @@ public function test_output_validation_failure_returns_error(): void {
 		$request->set_body( wp_json_encode( array( 'input' => array() ) ) );
 
 		$response = $this->server->dispatch( $request );
-		
+
 		// Should return error when output validation fails
 		$this->assertEquals( 500, $response->get_status() );
 		$data = $response->get_data();
@@ -650,7 +650,7 @@ public function test_input_validation_failure_returns_error(): void {
 		$request->set_body( wp_json_encode( array( 'input' => array( 'other_field' => 'value' ) ) ) );
 
 		$response = $this->server->dispatch( $request );
-		
+
 		// Should return error when input validation fails (403 due to permission check)
 		$this->assertEquals( 403, $response->get_status() );
 		$data = $response->get_data();
@@ -684,7 +684,7 @@ public function test_ability_without_type_defaults_to_tool(): void {
 		$post_request = new WP_REST_Request( 'POST', '/wp/v2/abilities/test/no-type/run' );
 		$post_request->set_header( 'Content-Type', 'application/json' );
 		$post_request->set_body( wp_json_encode( array( 'input' => array() ) ) );
-		
+
 		$post_response = $this->server->dispatch( $post_request );
 		$this->assertEquals( 200, $post_response->get_status() );
 	}
@@ -714,10 +714,10 @@ public function test_permission_check_passes_when_callback_not_set(): void {
 		$request->set_body( wp_json_encode( array( 'input' => array() ) ) );
 
 		$response = $this->server->dispatch( $request );
-		
+
 		// Should succeed when no permission callback is set
 		$this->assertEquals( 200, $response->get_status() );
-		
+
 		// Restore user for other tests
 		wp_set_current_user( self::$user_id );
 	}
@@ -763,7 +763,7 @@ public function test_empty_input_handling(): void {
 		$post_request = new WP_REST_Request( 'POST', '/wp/v2/abilities/test/tool-empty/run' );
 		$post_request->set_header( 'Content-Type', 'application/json' );
 		$post_request->set_body( '{}' ); // Empty JSON object
-		
+
 		$post_response = $this->server->dispatch( $post_request );
 		$this->assertEquals( 200, $post_response->get_status() );
 		$this->assertTrue( $post_response->get_data()['input_was_empty'] );
@@ -799,7 +799,7 @@ public function test_malformed_json_post_body( string $json ): void {
 		$request->set_body( $json );
 
 		$response = $this->server->dispatch( $request );
-		
+
 		// Malformed JSON should result in 400 Bad Request
 		$this->assertEquals( 400, $response->get_status() );
 	}
@@ -840,7 +840,7 @@ public function test_php_type_strings_in_input(): void {
 		$request->set_body( wp_json_encode( array( 'input' => $inputs ) ) );
 
 		$response = $this->server->dispatch( $request );
-		
+
 		$this->assertEquals( 200, $response->get_status() );
 		$data = $response->get_data();
 		$this->assertEquals( $inputs, $data['echo'] );
@@ -879,10 +879,10 @@ public function test_mixed_encoding_in_input(): void {
 		$request->set_body( wp_json_encode( array( 'input' => $input ) ) );
 
 		$response = $this->server->dispatch( $request );
-		
+
 		$this->assertEquals( 200, $response->get_status() );
 		$data = $response->get_data();
-		
+
 		// Input should be preserved exactly
 		$this->assertEquals( $input['utf8'], $data['echo']['utf8'] );
 		$this->assertEquals( $input['emoji'], $data['echo']['emoji'] );
@@ -926,7 +926,7 @@ public function test_invalid_http_methods( string $method ): void {
 
 		$request = new WP_REST_Request( $method, '/wp/v2/abilities/test/method-test/run' );
 		$response = $this->server->dispatch( $request );
-		
+
 		// Tool abilities should only accept POST, so these should return 405
 		$this->assertEquals( 405, $response->get_status() );
 		$data = $response->get_data();
