chore: Use <> to specify special characters

Author: matapatos

src/Endpoint.php

@@ -74,8 +74,6 @@ class Endpoint implements EndpointInterface
 
     /**
      * The registered REST route with namespace and route
-     *
-     * @var string|null
      */
     protected ?string $fullRestRoute = null;
 
@@ -299,9 +297,6 @@ public function middleware(Middleware $middleware): Endpoint
 
     /**
      * Specifies a set of plugins that are needed by the endpoint
-     *
-     * @param string|array $plugins
-     * @return Endpoint
      */
     public function depends(string|array $plugins): Endpoint
     {
@@ -310,13 +305,12 @@ public function depends(string|array $plugins): Endpoint
         }
 
         $this->plugins += $plugins;
+
         return $this;
     }
 
     /**
      * Retrieves the registered REST route: namespace + route
-     *
-     * @return string|null
      */
     public function getFullRestRoute(): ?string
     {
@@ -325,8 +319,6 @@ public function getFullRestRoute(): ?string
 
     /**
      * Retrieves the HTTP method of the endpoint
-     *
-     * @return string
      */
     public function getHttpMethod(): string
     {
@@ -335,8 +327,6 @@ public function getHttpMethod(): string
 
     /**
      * Retrieves the required endpoint plugins
-     *
-     * @return array
      */
     public function getRequiredPlugins(): array
     {
@@ -453,7 +443,7 @@ protected function replaceSpecialValue(WP_REST_Request $request, string $value):
         // Checks if value matches a special value.
         // If so, replaces with request variable.
         $newValue = \trim($value);
-        if (! \str_starts_with($newValue, '{') && ! \str_ends_with($newValue, '}')) {
+        if (! \str_starts_with($newValue, '<') || ! \str_ends_with($newValue, '>')) {
             return $value;
         }
 

tests/Integration/Routers/PostsRouter.php

@@ -32,7 +32,7 @@
 })
     ->schema('Posts/Update')
     ->returns('Posts/Get')
-    ->hasCap('edit_post', '{ID}');
+    ->hasCap('edit_post', '<ID>');
 
 // Deletes a post
 $router->delete('(?P<ID>[\d]+)', function (string $ID) {
@@ -43,6 +43,6 @@
 
     return esc_html__('Post deleted with success');
 })
-    ->hasCap('delete_post', '{ID}');
+    ->hasCap('delete_post', '<ID>');
 
 return $router;

tests/Unit/EndpointTest.php

@@ -118,14 +118,14 @@
     $mockedRequest = Mockery::mock(\WP_REST_Request::class);
     $expectedParams = [];
     foreach ($args as $arg) {
-        if (! is_string($arg) || ! str_starts_with($arg, '{')) {
+        if (! is_string($arg) || ! str_starts_with($arg, '<')) {
             $expectedParams[] = $arg;
 
             continue;
         }
 
         $paramName = substr($arg, 1, -1);
-        $isArgumentMissing = $arg === '{argument-missing}';
+        $isArgumentMissing = $arg === '<argument-missing>';
         $mockedRequest
             ->shouldReceive('has_param')
             ->once()
@@ -152,7 +152,7 @@
     expect($permissionHandlers[0]($mockedRequest))->toBeTrue();
 })->with([
     'create_users', ['edit_plugins', 'delete_plugins', 98],
-    ['create_users', '{post_id}', '{another_var}', false],
+    ['create_users', '<post_id>', '{another_var}', false],
     ['edit_posts', '{argument-missing}'], '{custom-cap}',
 ])->group('endpoint', 'hasCap');
 
@@ -166,14 +166,14 @@
     $mockedRequest = Mockery::mock(\WP_REST_Request::class);
     $expectedParams = [];
     foreach ($args as $arg) {
-        if (! str_starts_with($arg, '{')) {
+        if (! str_starts_with($arg, '<')) {
             $expectedParams[] = $arg;
 
             continue;
         }
 
         $paramName = substr($arg, 1, -1);
-        $isArgumentMissing = $arg === '{argument-missing}';
+        $isArgumentMissing = $arg === '<argument-missing>';
         $mockedRequest
             ->shouldReceive('has_param')
             ->once()
@@ -205,8 +205,8 @@
         ->toHaveProperty('data', ['status' => 403]);
 })->with([
     'create_users', ['edit_plugins', 'delete_plugins'],
-    '{custom_capability}', ['create_users', '{post_id}', '{another_var}'],
-    ['create_users', '{post_id}', '{argument-missing}'],
+    '{custom_capability}', ['create_users', '<post_id>', '{another_var}'],
+    ['create_users', '<post_id>', '{argument-missing}'],
 ])->group('endpoint', 'hasCap');
 
 test('Missing capability', function () {