From 8b76049c2556e9f30377826a1688afaf2fa723d5 Mon Sep 17 00:00:00 2001
From: Oliver Eglseder <oliver.eglseder@co-stack.com>
Date: Tue, 11 Feb 2020 23:29:46 +0100
Subject: [PATCH] [FEATURE] Add FixedPrefix, ApplyOnArrayValueByKey and more
 structure

---
 README.md                                     | 14 +++---
 src/Applicable/ApplyOnArrayValueByKey.php     | 44 +++++++++++++++++++
 .../ApplyOnArrayValueRecursively.php}         |  6 ++-
 src/{ => Applicable}/ReversiblePipe.php       |  4 +-
 .../Encoding/Base64Encoding.php               |  2 +-
 src/{ => Operation}/Encoding/JsonEncoding.php |  2 +-
 src/{ => Operation}/Encoding/RawUrlEncode.php |  2 +-
 .../Encoding/SerializationEncoding.php        |  2 +-
 src/{ => Operation}/Encoding/UrlEncode.php    |  2 +-
 src/Operation/Fixed/FixedPrefix.php           | 33 ++++++++++++++
 .../Mapping/ArrayKeyMapping.php               |  3 +-
 .../Transform/ImplodeTransform.php            |  2 +-
 12 files changed, 98 insertions(+), 18 deletions(-)
 create mode 100644 src/Applicable/ApplyOnArrayValueByKey.php
 rename src/{RecursiveReversible.php => Applicable/ApplyOnArrayValueRecursively.php} (85%)
 rename src/{ => Applicable}/ReversiblePipe.php (87%)
 rename src/{ => Operation}/Encoding/Base64Encoding.php (94%)
 rename src/{ => Operation}/Encoding/JsonEncoding.php (96%)
 rename src/{ => Operation}/Encoding/RawUrlEncode.php (91%)
 rename src/{ => Operation}/Encoding/SerializationEncoding.php (94%)
 rename src/{ => Operation}/Encoding/UrlEncode.php (91%)
 create mode 100644 src/Operation/Fixed/FixedPrefix.php
 rename src/{ => Operation}/Mapping/ArrayKeyMapping.php (93%)
 rename src/{ => Operation}/Transform/ImplodeTransform.php (95%)

diff --git a/README.md b/README.md
index 14f80dd..684cac9 100644
--- a/README.md
+++ b/README.md
@@ -36,11 +36,11 @@ $restoredInput = $encoding->reverse($output);
 
 ```php
  // Shared Library
- function getPipe(): \CoStack\Reversible\ReversiblePipe {
-    $pipe = new \CoStack\Reversible\ReversiblePipe();
-    $pipe->enqueue(new \CoStack\Reversible\Mapping\ArrayKeyMapping(['key1', 'key2', 'payload']));
-    $pipe->enqueue(new \CoStack\Reversible\RecursiveReversible(new \CoStack\Reversible\Encoding\Base64Encoding()));
-    $pipe->enqueue(new \CoStack\Reversible\Transform\ImplodeTransform());
+ function getPipe(): \CoStack\Reversible\Applicable\ReversiblePipe {
+    $pipe = new \CoStack\Reversible\Applicable\ReversiblePipe();
+    $pipe->enqueue(new \CoStack\Reversible\Operation\Mapping\ArrayKeyMapping(['key1', 'key2', 'payload']));
+    $pipe->enqueue(new \CoStack\Reversible\Applicable\ApplyOnArrayValueRecursively(new \CoStack\Reversible\Encoding\Base64Encoding()));
+    $pipe->enqueue(new \CoStack\Reversible\Operation\Transform\ImplodeTransform());
     return $pipe;
 }
  
@@ -65,8 +65,8 @@ Please notice that `ImplodeTransform` is lossy because `explode(',', implode(','
 
 ```php
 // Shared Library
-function getPipe(): \CoStack\Reversible\ReversiblePipe {
-    $pipe = new \CoStack\Reversible\ReversiblePipe();
+function getPipe(): \CoStack\Reversible\Applicable\ReversiblePipe {
+    $pipe = new \CoStack\Reversible\Applicable\ReversiblePipe();
     $pipe->enqueue(new \CoStack\Reversible\Encoding\SerializationEncoding());
     $pipe->enqueue(new \CoStack\Reversible\Encoding\UrlEncode());
     return $pipe;
diff --git a/src/Applicable/ApplyOnArrayValueByKey.php b/src/Applicable/ApplyOnArrayValueByKey.php
new file mode 100644
index 0000000..e787984
--- /dev/null
+++ b/src/Applicable/ApplyOnArrayValueByKey.php
@@ -0,0 +1,44 @@
+<?php
+declare(strict_types=1);
+namespace CoStack\Reversible\Applicable;
+
+use Closure;
+use CoStack\Reversible\AbstractReversible;
+use CoStack\Reversible\Reversible;
+
+class ApplyOnArrayValueByKey extends AbstractReversible
+{
+    private $reversible;
+    private $keys;
+
+    public function __construct(Reversible $reversible, array $keys)
+    {
+        $this->reversible = $reversible;
+        $this->keys = $keys;
+    }
+
+    public function getExecutionClosure(): Closure
+    {
+        return function(array $value): array {
+            foreach ($this->keys as $key) {
+                if (!empty($value[$key])) {
+                    $value[$key] = $this->reversible->execute($value[$key]);
+                }
+            }
+            return $value;
+        };
+    }
+
+    public function getReversionClosure(): Closure
+    {
+        return function(array $value): array {
+            foreach ($this->keys as $key) {
+                if (!empty($value[$key])) {
+                    $value[$key] = $this->reversible->reverse($value[$key]);
+                }
+            }
+            return $value;
+        };
+    }
+
+}
diff --git a/src/RecursiveReversible.php b/src/Applicable/ApplyOnArrayValueRecursively.php
similarity index 85%
rename from src/RecursiveReversible.php
rename to src/Applicable/ApplyOnArrayValueRecursively.php
index 6fe5451..98ffc87 100644
--- a/src/RecursiveReversible.php
+++ b/src/Applicable/ApplyOnArrayValueRecursively.php
@@ -1,12 +1,14 @@
 <?php
 declare(strict_types=1);
-namespace CoStack\Reversible;
+namespace CoStack\Reversible\Applicable;
 
 use Closure;
+use CoStack\Reversible\AbstractReversible;
+use CoStack\Reversible\Reversible;
 use function array_map;
 use function is_array;
 
-class RecursiveReversible extends AbstractReversible
+class ApplyOnArrayValueRecursively extends AbstractReversible
 {
     /** @var Reversible */
     private $reversible;
diff --git a/src/ReversiblePipe.php b/src/Applicable/ReversiblePipe.php
similarity index 87%
rename from src/ReversiblePipe.php
rename to src/Applicable/ReversiblePipe.php
index 369bbfe..a849081 100644
--- a/src/ReversiblePipe.php
+++ b/src/Applicable/ReversiblePipe.php
@@ -1,8 +1,10 @@
 <?php
 declare(strict_types=1);
-namespace CoStack\Reversible;
+namespace CoStack\Reversible\Applicable;
 
 use Closure;
+use CoStack\Reversible\AbstractReversible;
+use CoStack\Reversible\Reversible;
 use function array_reverse;
 
 class ReversiblePipe extends AbstractReversible
diff --git a/src/Encoding/Base64Encoding.php b/src/Operation/Encoding/Base64Encoding.php
similarity index 94%
rename from src/Encoding/Base64Encoding.php
rename to src/Operation/Encoding/Base64Encoding.php
index a3fe75a..8aab9c8 100644
--- a/src/Encoding/Base64Encoding.php
+++ b/src/Operation/Encoding/Base64Encoding.php
@@ -1,6 +1,6 @@
 <?php
 declare(strict_types=1);
-namespace CoStack\Reversible\Encoding;
+namespace CoStack\Reversible\Operation\Encoding;
 
 use Closure;
 use CoStack\Reversible\AbstractReversible;
diff --git a/src/Encoding/JsonEncoding.php b/src/Operation/Encoding/JsonEncoding.php
similarity index 96%
rename from src/Encoding/JsonEncoding.php
rename to src/Operation/Encoding/JsonEncoding.php
index f03e784..4312e83 100644
--- a/src/Encoding/JsonEncoding.php
+++ b/src/Operation/Encoding/JsonEncoding.php
@@ -1,6 +1,6 @@
 <?php
 declare(strict_types=1);
-namespace CoStack\Reversible\Encoding;
+namespace CoStack\Reversible\Operation\Encoding;
 
 use Closure;
 use CoStack\Reversible\AbstractReversible;
diff --git a/src/Encoding/RawUrlEncode.php b/src/Operation/Encoding/RawUrlEncode.php
similarity index 91%
rename from src/Encoding/RawUrlEncode.php
rename to src/Operation/Encoding/RawUrlEncode.php
index 3abe21c..ff5c8cb 100644
--- a/src/Encoding/RawUrlEncode.php
+++ b/src/Operation/Encoding/RawUrlEncode.php
@@ -1,6 +1,6 @@
 <?php
 declare(strict_types=1);
-namespace CoStack\Reversible\Encoding;
+namespace CoStack\Reversible\Operation\Encoding;
 
 use Closure;
 use CoStack\Reversible\AbstractReversible;
diff --git a/src/Encoding/SerializationEncoding.php b/src/Operation/Encoding/SerializationEncoding.php
similarity index 94%
rename from src/Encoding/SerializationEncoding.php
rename to src/Operation/Encoding/SerializationEncoding.php
index 1baa4c3..2d9edc4 100644
--- a/src/Encoding/SerializationEncoding.php
+++ b/src/Operation/Encoding/SerializationEncoding.php
@@ -1,6 +1,6 @@
 <?php
 declare(strict_types=1);
-namespace CoStack\Reversible\Encoding;
+namespace CoStack\Reversible\Operation\Encoding;
 
 use Closure;
 use CoStack\Reversible\AbstractReversible;
diff --git a/src/Encoding/UrlEncode.php b/src/Operation/Encoding/UrlEncode.php
similarity index 91%
rename from src/Encoding/UrlEncode.php
rename to src/Operation/Encoding/UrlEncode.php
index 6b0a15c..b464001 100644
--- a/src/Encoding/UrlEncode.php
+++ b/src/Operation/Encoding/UrlEncode.php
@@ -1,6 +1,6 @@
 <?php
 declare(strict_types=1);
-namespace CoStack\Reversible\Encoding;
+namespace CoStack\Reversible\Operation\Encoding;
 
 use Closure;
 use CoStack\Reversible\AbstractReversible;
diff --git a/src/Operation/Fixed/FixedPrefix.php b/src/Operation/Fixed/FixedPrefix.php
new file mode 100644
index 0000000..e843cf9
--- /dev/null
+++ b/src/Operation/Fixed/FixedPrefix.php
@@ -0,0 +1,33 @@
+<?php
+declare(strict_types=1);
+namespace CoStack\Reversible\Operation\Fixed;
+
+use Closure;
+use CoStack\Reversible\AbstractReversible;
+use function strlen;
+use function substr;
+
+class FixedPrefix extends AbstractReversible
+{
+    private $prefix;
+
+    public function __construct(string $prefix)
+    {
+        $this->prefix = $prefix;
+    }
+
+    public function getExecutionClosure(): Closure
+    {
+        return function(string $value): string {
+            return $this->prefix . $value;
+        };
+    }
+
+    public function getReversionClosure(): Closure
+    {
+        return function(string $value): string {
+            return substr($value, strlen($this->prefix));
+        };
+    }
+
+}
diff --git a/src/Mapping/ArrayKeyMapping.php b/src/Operation/Mapping/ArrayKeyMapping.php
similarity index 93%
rename from src/Mapping/ArrayKeyMapping.php
rename to src/Operation/Mapping/ArrayKeyMapping.php
index 38b22ef..ef2191a 100644
--- a/src/Mapping/ArrayKeyMapping.php
+++ b/src/Operation/Mapping/ArrayKeyMapping.php
@@ -1,6 +1,6 @@
 <?php
 declare(strict_types=1);
-namespace CoStack\Reversible\Mapping;
+namespace CoStack\Reversible\Operation\Mapping;
 
 use Closure;
 use CoStack\Reversible\AbstractReversible;
@@ -12,7 +12,6 @@ class ArrayKeyMapping extends AbstractReversible
     private $mapping;
 
     /**
-     * ArrayKeyMapping constructor.
      * @param array $mapping Key = Numeric, Value = assoc index
      */
     public function __construct(array $mapping)
diff --git a/src/Transform/ImplodeTransform.php b/src/Operation/Transform/ImplodeTransform.php
similarity index 95%
rename from src/Transform/ImplodeTransform.php
rename to src/Operation/Transform/ImplodeTransform.php
index 030c0c4..0df3935 100644
--- a/src/Transform/ImplodeTransform.php
+++ b/src/Operation/Transform/ImplodeTransform.php
@@ -1,6 +1,6 @@
 <?php
 declare(strict_types=1);
-namespace CoStack\Reversible\Transform;
+namespace CoStack\Reversible\Operation\Transform;
 
 use Closure;
 use CoStack\Reversible\AbstractReversible;