refactor! Rename operation classes to xxxHandler

Adds a `Handler` suffix to all current final operation handler class names, and
moves them to a `handlers` namespace.

This is not expected to affect end-users as the in-built handler classes are not
generally expected to be used outside the package.

This will avoid naming conflicts and confusion when we subsequently introduce
support for representing a patch as a set of operation DTOs.

Author: acoulton

.github/workflows/test.yml

@@ -1,4 +1,4 @@
-name: Test
+name: TestHandler
 
 on: push
 

src/FastJsonPatch.php

@@ -24,12 +24,12 @@
 use blancks\JsonPatch\operations\{
     PatchOperationInterface,
     PatchValidationTrait,
-    Add,
-    Copy,
-    Move,
-    Remove,
-    Replace,
-    Test
+    handlers\AddHandler,
+    handlers\CopyHandler,
+    handlers\MoveHandler,
+    handlers\RemoveHandler,
+    handlers\ReplaceHandler,
+    handlers\TestHandler
 };
 
 /**
@@ -91,12 +91,12 @@ public function __construct(
 
         $this->setJsonPointerHandler($JsonPointerHandler);
         $this->setJsonHandler($JsonHandler);
-        $this->registerOperation(new Add);
-        $this->registerOperation(new Copy);
-        $this->registerOperation(new Move);
-        $this->registerOperation(new Remove);
-        $this->registerOperation(new Replace);
-        $this->registerOperation(new Test);
+        $this->registerOperation(new AddHandler);
+        $this->registerOperation(new CopyHandler);
+        $this->registerOperation(new MoveHandler);
+        $this->registerOperation(new RemoveHandler);
+        $this->registerOperation(new ReplaceHandler);
+        $this->registerOperation(new TestHandler);
     }
 
     /**

src/operations/PatchOperation.php

@@ -18,12 +18,17 @@ abstract class PatchOperation implements
 
     /**
      * Returns the operation name that the class will handle.
-     * Please note that this method will assume the class short name as the name of the operation,
+     * Please note the default implementation takes this from the lowercased class short name, removing any "Handler"
+     * suffix.
      * feel free to override if this is not the behaviour you want for your operation handler class.
      * @return string
      */
     public function getOperation(): string
     {
-        return strtolower((new \ReflectionClass($this))->getShortName());
+        $name = strtolower((new \ReflectionClass($this))->getShortName());
+        if (str_ends_with($name, 'handler')) {
+            $name = substr($name, 0, -7);
+        }
+        return $name;
     }
 }

src/operations/Add.php src/operations/handlers/AddHandler.phpsrc/operations/Add.php renamed to src/operations/handlers/AddHandler.php

@@ -1,10 +1,11 @@
 <?php declare(strict_types=1);
 
-namespace blancks\JsonPatch\operations;
+namespace blancks\JsonPatch\operations\handlers;
 
 use blancks\JsonPatch\json\accessors\UndefinedValue;
+use blancks\JsonPatch\operations\PatchOperation;
 
-final class Add extends PatchOperation
+final class AddHandler extends PatchOperation
 {
     private mixed $previous;
 

src/operations/Copy.php src/operations/handlers/CopyHandler.phpsrc/operations/Copy.php renamed to src/operations/handlers/CopyHandler.php

@@ -1,10 +1,11 @@
 <?php declare(strict_types=1);
 
-namespace blancks\JsonPatch\operations;
+namespace blancks\JsonPatch\operations\handlers;
 
 use blancks\JsonPatch\json\accessors\UndefinedValue;
+use blancks\JsonPatch\operations\PatchOperation;
 
-final class Copy extends PatchOperation
+final class CopyHandler extends PatchOperation
 {
     private mixed $previous;
 

src/operations/Move.php src/operations/handlers/MoveHandler.phpsrc/operations/Move.php renamed to src/operations/handlers/MoveHandler.php

@@ -1,8 +1,10 @@
 <?php declare(strict_types=1);
 
-namespace blancks\JsonPatch\operations;
+namespace blancks\JsonPatch\operations\handlers;
 
-final class Move extends PatchOperation
+use blancks\JsonPatch\operations\PatchOperation;
+
+final class MoveHandler extends PatchOperation
 {
     /**
      * @param object{

src/operations/Remove.php src/operations/handlers/RemoveHandler.phpsrc/operations/Remove.php renamed to src/operations/handlers/RemoveHandler.php

@@ -1,8 +1,10 @@
 <?php declare(strict_types=1);
 
-namespace blancks\JsonPatch\operations;
+namespace blancks\JsonPatch\operations\handlers;
 
-final class Remove extends PatchOperation
+use blancks\JsonPatch\operations\PatchOperation;
+
+final class RemoveHandler extends PatchOperation
 {
     private mixed $previous;
 

src/operations/Replace.php …c/operations/handlers/ReplaceHandler.phpsrc/operations/Replace.php renamed to src/operations/handlers/ReplaceHandler.php src/operations/Replace.php renamed to src/operations/handlers/ReplaceHandler.php

@@ -1,8 +1,10 @@
 <?php declare(strict_types=1);
 
-namespace blancks\JsonPatch\operations;
+namespace blancks\JsonPatch\operations\handlers;
 
-final class Replace extends PatchOperation
+use blancks\JsonPatch\operations\PatchOperation;
+
+final class ReplaceHandler extends PatchOperation
 {
     private mixed $previous;
 

src/operations/Test.php src/operations/handlers/TestHandler.phpsrc/operations/Test.php renamed to src/operations/handlers/TestHandler.php

@@ -1,10 +1,11 @@
 <?php declare(strict_types=1);
 
-namespace blancks\JsonPatch\operations;
+namespace blancks\JsonPatch\operations\handlers;
 
 use blancks\JsonPatch\exceptions\FailedTestException;
+use blancks\JsonPatch\operations\PatchOperation;
 
-final class Test extends PatchOperation
+final class TestHandler extends PatchOperation
 {
     /**
      * @param object{
@@ -37,7 +38,7 @@ public function apply(mixed &$document, object $patch): void
         if (!$this->isJsonEquals($item, $patch->value)) {
             throw new FailedTestException(
                 sprintf(
-                    'Test operation failed asserting that "%s" equals "%s"',
+                    'TestHandler operation failed asserting that "%s" equals "%s"',
                     $this->JsonHandler->encode($item),
                     $this->JsonHandler->encode($patch->value)
                 ),

tests/FastJsonPatchTest.php

@@ -22,12 +22,12 @@
 };
 use blancks\JsonPatch\operations\{
     PatchOperation,
-    Add,
-    Copy,
-    Move,
-    Remove,
-    Replace,
-    Test
+    handlers\AddHandler,
+    handlers\CopyHandler,
+    handlers\MoveHandler,
+    handlers\RemoveHandler,
+    handlers\ReplaceHandler,
+    handlers\TestHandler
 };
 use blancks\JsonPatch\FastJsonPatch;
 use PHPUnit\Framework\Attributes\{
@@ -52,12 +52,12 @@
 #[UsesClass(BasicJsonHandler::class)]
 #[UsesClass(JsonPointer6901::class)]
 #[UsesClass(PatchOperation::class)]
-#[UsesClass(Add::class)]
-#[UsesClass(Copy::class)]
-#[UsesClass(Move::class)]
-#[UsesClass(Remove::class)]
-#[UsesClass(Replace::class)]
-#[UsesClass(Test::class)]
+#[UsesClass(AddHandler::class)]
+#[UsesClass(CopyHandler::class)]
+#[UsesClass(MoveHandler::class)]
+#[UsesClass(RemoveHandler::class)]
+#[UsesClass(ReplaceHandler::class)]
+#[UsesClass(TestHandler::class)]
 final class FastJsonPatchTest extends JsonPatchCompliance
 {
     public function testValidPatch(): void