WIP: #1,#2,#3: Separate handlers into Data and Scrub handlers

README.md

@@ -29,7 +29,7 @@ Here is an example configuration used in the unit tests:
 ```php
 <?php
 
-use ClntDev\Scrubber\Handlers\FakerHandler;
+use ClntDev\Scrubber\DataHandlers\FakerHandler;
 
 return [
     'users' => [

src/Contracts/DataHandler.php

@@ -4,14 +4,9 @@
 
 interface DataHandler
 {
-    public function __construct(
-        string $table,
-        string $field,
-        mixed $input,
-        ?DatabaseKey $primaryKey = null,
-        ?string $type = null,
-        string $seed = 'scrubber',
-    );
+    public static function makeFromConfig(
+        array $config
+    ): self;
 
-    public function handle(); //phpcs:ignore
+    public function getValue(): mixed;
 }

src/Contracts/DatabaseHandler.php

@@ -0,0 +1,32 @@
+<?php
+
+namespace ClntDev\Scrubber\Contracts;
+
+interface DatabaseHandler
+{
+    /** @return mixed[] */
+    public function fetch(
+        string $table,
+        DatabaseKey $primaryKey
+    ): array;
+
+    public function update(
+        string $table,
+        string $field,
+        mixed $value,
+        string|int|array $primaryKeyValue,
+        DatabaseKey $primaryKey
+    ): bool;
+
+    public function delete(
+        string $table,
+        string $field,
+        string $value,
+        string|int|array $primaryKeyValue,
+        DatabaseKey $primaryKey
+    ): bool;
+
+    public function truncate(
+        string $table
+    ): bool;
+}

src/Contracts/DetectsApplicability.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace ClntDev\Scrubber\Contracts;
+
+interface DetectsApplicability
+{
+    public static function detect(mixed $value): bool;
+}

src/Contracts/ScrubHandler.php

@@ -0,0 +1,29 @@
+<?php
+
+namespace ClntDev\Scrubber\Contracts;
+
+interface ScrubHandler
+{
+    public function __construct(
+        string $table,
+        string $field,
+        DatabaseKey $primaryKey,
+        DataHandler $dataHandler,
+        ?string $type = 'pid'
+    );
+
+    public function scrub(
+        mixed $primaryKeyValues,
+        DatabaseHandler $database
+    ): void;
+
+    public function getTable(): string;
+
+    public function getField(): string;
+
+    public function getPrimaryKey(): DatabaseKey;
+
+    public function getDataHandler(): DataHandler;
+
+    public function getType(): ?string;
+}

src/Handlers/ArrayHandler.php → src/DataHandlers/ArrayHandler.php

@@ -1,12 +1,12 @@
 <?php
 
-namespace ClntDev\Scrubber\Handlers;
+namespace ClntDev\Scrubber\DataHandlers;
 
 use RuntimeException;
 
 class ArrayHandler extends Handler
 {
-    public function handle(): string|bool
+    public function getValue(): string|bool
     {
         if (is_array($this->input) === false) {
             throw new RuntimeException(

src/Handlers/CallableHandler.php → src/DataHandlers/CallableHandler.php

@@ -1,12 +1,12 @@
 <?php
 
-namespace ClntDev\Scrubber\Handlers;
+namespace ClntDev\Scrubber\DataHandlers;
 
 use RuntimeException;
 
 class CallableHandler extends Handler
 {
-    public function handle(): ?string
+    public function getValue(): ?string
     {
         if (is_callable($this->input) === false) {
             throw new RuntimeException('CallableHandler input is not callable');

src/Handlers/FakerHandler.php → src/DataHandlers/FakerHandler.php

@@ -1,12 +1,12 @@
 <?php
 
-namespace ClntDev\Scrubber\Handlers;
+namespace ClntDev\Scrubber\DataHandlers;
 
 use RuntimeException;
 
 class FakerHandler extends Handler
 {
-    public function handle(): ?string
+    public function getValue(): ?string
     {
         if (str_contains($this->input, 'faker.') === false) {
             throw new RuntimeException('FakerHandler invalid faker input format given');

src/DataHandlers/Handler.php

@@ -0,0 +1,48 @@
+<?php
+
+namespace ClntDev\Scrubber\DataHandlers;
+
+use ClntDev\Scrubber\Contracts\DatabaseKey;
+use ClntDev\Scrubber\Contracts\DataHandler;
+use ClntDev\Scrubber\Contracts\DetectsApplicability;
+use ClntDev\Scrubber\DatabaseKey as ScrubberDatabaseKey;
+use Faker\Factory as Faker;
+use Faker\Generator;
+
+abstract class Handler implements DataHandler, DetectsApplicability
+{
+    public mixed $input;
+
+    public ?string $type;
+
+    protected Generator $faker;
+
+    public static function makeFromConfig(array $config): DataHandler
+    {
+        return new static(
+            $config['value'] ?? null,
+            $config['type'] ?? null,
+            $config['seed'] ?? 'scrubber'
+        );
+    }
+
+    public function __construct(
+        mixed $input,
+        ?string $type,
+        string $seed,
+    ) {
+        $this->input = $input;
+        $this->type = $type;
+        $this->faker = Faker::create();
+        $this->faker->seed($seed);
+    }
+
+    public function getType(): ?string
+    {
+        return $this->type;
+    }
+
+    abstract public function getValue(): mixed;
+
+    abstract public static function detect(mixed $value): bool;
+}

src/Handlers/IntegerHandler.php → src/DataHandlers/IntegerHandler.php

@@ -1,12 +1,12 @@
 <?php
 
-namespace ClntDev\Scrubber\Handlers;
+namespace ClntDev\Scrubber\DataHandlers;
 
 use RuntimeException;
 
 class IntegerHandler extends Handler
 {
-    public function handle(): ?int
+    public function getValue(): ?int
     {
         if (is_numeric($this->input) === false) {
             throw new RuntimeException(

src/Handlers/ObjectHandler.php → src/DataHandlers/ObjectHandler.php

@@ -1,12 +1,12 @@
 <?php
 
-namespace ClntDev\Scrubber\Handlers;
+namespace ClntDev\Scrubber\DataHandlers;
 
 use RuntimeException;
 
 class ObjectHandler extends Handler
 {
-    public function handle(): ?string
+    public function getValue(): ?string
     {
         if (is_object($this->input) === false) {
             throw new RuntimeException('CallableHandler input is not an object');

src/Handlers/StringHandler.php → src/DataHandlers/StringHandler.php

@@ -1,12 +1,12 @@
 <?php
 
-namespace ClntDev\Scrubber\Handlers;
+namespace ClntDev\Scrubber\DataHandlers;
 
 use RuntimeException;
 
 class StringHandler extends Handler
 {
-    public function handle(): ?string
+    public function getValue(): ?string
     {
         if (is_string($this->input) === false && is_int($this->input) === false) {
             throw new RuntimeException(

src/Exceptions/InvalidHandler.php

@@ -0,0 +1,23 @@
+<?php
+
+namespace ClntDev\Scrubber\Exceptions;
+
+use RuntimeException;
+use Throwable;
+
+class InvalidHandler extends RuntimeException
+{
+    public mixed $value = '';
+
+    public function __construct(
+        mixed $value,
+        string $message = '',
+        int $code = 0,
+        ?Throwable $previous = null
+    ) {
+        $this->value = $value;
+        $message = $message !== '' ? $message : 'Invalid handler.';
+
+        parent::__construct($message, $code, $previous);
+    }
+}