Merge pull request #18 from TheDragonCode/2.x

Added the ability to pass an array object to `keys` and `tags` methods

Author: Andrey Helldar

README.md

@@ -27,7 +27,30 @@ Or manually update `require` block of `composer.json` and run `composer update`.
 
 ## Using
 
-### Keys Handling
+### Keys And Tags
+
+In addition to passing an explicit value, you can also pass objects and arrays to the `keys` and `tags` methods.
+
+For example:
+
+```php
+use DragonCode\Cache\Services\Cache;
+use DragonCode\SimpleDataTransferObject\DataTransferObject;
+
+$arr1 = ['foo', 'bar']
+$arr2 = new ArrayObject(['foo', 'bar'])
+$arr3 = DataTransferObject::make(['foo', 'bar'])
+
+Cache::make()->key($arr1)->tags($arr1);
+Cache::make()->key($arr2)->tags($arr3);
+Cache::make()->key($arr2)->tags($arr3);
+
+Cache::make()->key([$arr1, $arr2, $arr3, 'foo', 'bar'])->tags([$arr1, $arr2, $arr3, 'foo', 'bar']);
+Cache::make()->key([$arr1, $arr2, $arr3, 'foo', 'bar'])->tags([$arr1, $arr2, $arr3, 'foo', 'bar']);
+Cache::make()->key([$arr1, $arr2, $arr3, 'foo', 'bar'])->tags([$arr1, $arr2, $arr3, 'foo', 'bar']);
+```
+
+#### Keys Handling
 
 Since the main problem of working with the cache's key compilation, this package solves it.
 
@@ -36,7 +59,9 @@ By passing values to the `keys` method, we get a ready-made key at the output.
 For example:
 
 ```php
-$cache = Cache::make()->key('foo', 'bar', ['baz', 'baq']);
+use DragonCode\Cache\Services\Cache;
+
+$cache = Cache::make()->key('foo', 'bar', [null, 'baz', 'baq']);
 
 // Key is `acbd18db4cc2f85cedef654fccc4a4d8:37b51d194a7513e45b56f6524f2d51f2:73feffa4b7f6bb68e44cf984c85f6e88:b47951d522316fdd8811b23fc9c2f583`
 ```
@@ -46,6 +71,8 @@ This means that when writing to the cache, the tree view will be used.
 For example:
 
 ```php
+use DragonCode\Cache\Services\Cache;
+
 Cache::make()->key('foo', 'foo')->put('foo');
 Cache::make()->key('foo', 'bar')->put('bar');
 Cache::make()->key('baz')->put('baz');

src/Concerns/Arrayable.php

@@ -4,15 +4,60 @@
 
 namespace DragonCode\Cache\Concerns;
 
+use ArrayObject;
+use Closure;
+use DragonCode\Contracts\Support\Arrayable as DragonCodeArrayable;
 use DragonCode\Support\Facades\Helpers\Ables\Arrayable as Helper;
+use DragonCode\Support\Facades\Helpers\Arr;
+use DragonCode\Support\Facades\Helpers\Instance;
+use DragonCode\Support\Helpers\Ables\Arrayable as ArrayableHelper;
+use Illuminate\Contracts\Support\Arrayable as IlluminateArrayable;
 
 trait Arrayable
 {
     protected function arrayMap(array $values, callable $callback): array
     {
         return Helper::of($values)
+            ->map(function ($value) {
+                if ($this->isArrayable($value)) {
+                    return Arr::toArray($value);
+                }
+
+                return $value;
+            })
             ->flatten()
+            ->filter()
             ->map($callback)
+            ->values()
             ->get();
     }
+
+    protected function toArray($value): array
+    {
+        $value = $this->resolveArray($value);
+
+        return Arr::wrap($value);
+    }
+
+    protected function resolveArray($value): array
+    {
+        if ($this->isArrayable($value)) {
+            return Arr::toArray($value);
+        }
+
+        return $value;
+    }
+
+    protected function isArrayable($value): bool
+    {
+        if (Instance::of($value, [DragonCodeArrayable::class, IlluminateArrayable::class, ArrayableHelper::class, ArrayObject::class])) {
+            return true;
+        }
+
+        if (Instance::of($value, Closure::class) && method_exists($value, 'toArray')) {
+            return true;
+        }
+
+        return false;
+    }
 }

src/Concerns/Call.php

@@ -4,16 +4,10 @@
 
 namespace DragonCode\Cache\Concerns;
 
-use ArrayObject;
-use Closure;
-use DragonCode\Contracts\Support\Arrayable as DragonCodeArrayable;
-use DragonCode\Support\Facades\Helpers\Arr;
-use DragonCode\Support\Facades\Helpers\Instance;
-use DragonCode\Support\Helpers\Ables\Arrayable as ArrayableHelper;
-use Illuminate\Contracts\Support\Arrayable as IlluminateArrayable;
-
 trait Call
 {
+    use Arrayable;
+
     /**
      * @param  mixed  $callback
      *
@@ -42,30 +36,8 @@ protected function resolve($value)
         return $this->isArrayable($value) ? $this->resolveArray($value) : $value;
     }
 
-    protected function resolveArray($value): array
-    {
-        if ($this->isArrayable($value)) {
-            return Arr::toArray($value);
-        }
-
-        return $value;
-    }
-
     protected function isCallable($value): bool
     {
         return is_callable($value);
     }
-
-    protected function isArrayable($value): bool
-    {
-        if (Instance::of($value, [DragonCodeArrayable::class, IlluminateArrayable::class, ArrayableHelper::class, ArrayObject::class])) {
-            return true;
-        }
-
-        if (Instance::of($value, Closure::class) && method_exists($value, 'toArray')) {
-            return true;
-        }
-
-        return false;
-    }
 }

src/Facades/Support/Key.php

@@ -5,10 +5,12 @@
 namespace DragonCode\Cache\Facades\Support;
 
 use DragonCode\Cache\Support\Key as Support;
+use DragonCode\Contracts\DataTransferObject\DataTransferObject;
+use DragonCode\Contracts\Support\Arrayable;
 use Illuminate\Support\Facades\Facade;
 
 /**
- * @method static string get(string $separator, array $values)
+ * @method static string get(string $separator, array|Arrayable|\Illuminate\Contracts\Support\Arrayable|\ArrayObject|DataTransferObject $values)
  */
 class Key extends Facade
 {

src/Facades/Support/Tag.php

@@ -5,10 +5,12 @@
 namespace DragonCode\Cache\Facades\Support;
 
 use DragonCode\Cache\Support\Tag as Support;
+use DragonCode\Contracts\DataTransferObject\DataTransferObject;
+use DragonCode\Contracts\Support\Arrayable;
 use Illuminate\Support\Facades\Facade;
 
 /**
- * @method static array get(array $tags)
+ * @method static array get(array|Arrayable|\Illuminate\Contracts\Support\Arrayable|\ArrayObject|DataTransferObject $tags)
  */
 class Tag extends Facade
 {

src/Support/Key.php

@@ -5,13 +5,22 @@
 namespace DragonCode\Cache\Support;
 
 use DragonCode\Cache\Concerns\Arrayable;
+use DragonCode\Contracts\DataTransferObject\DataTransferObject;
 
 class Key
 {
     use Arrayable;
 
-    public function get(string $separator, array $values): string
+    /**
+     * @param  string  $separator
+     * @param  array|\DragonCode\Contracts\Support\Arrayable|\Illuminate\Contracts\Support\Arrayable|\ArrayObject|DataTransferObject  $values
+     *
+     * @return string
+     */
+    public function get(string $separator, $values): string
     {
+        $values = $this->toArray($values);
+
         $hashed = $this->hash($values);
 
         return $this->compile($hashed, $separator);

src/Support/Tag.php

@@ -5,13 +5,26 @@
 namespace DragonCode\Cache\Support;
 
 use DragonCode\Cache\Concerns\Arrayable;
+use DragonCode\Contracts\DataTransferObject\DataTransferObject;
 use DragonCode\Support\Facades\Helpers\Ables\Stringable;
 
 class Tag
 {
     use Arrayable;
 
-    public function get(array $tags): array
+    /**
+     * @param  array|\DragonCode\Contracts\Support\Arrayable|\Illuminate\Contracts\Support\Arrayable|\ArrayObject|DataTransferObject  $tags
+     *
+     * @return array
+     */
+    public function get($tags): array
+    {
+        $tags = $this->toArray($tags);
+
+        return $this->map($tags);
+    }
+
+    protected function map(array $tags): array
     {
         return $this->arrayMap($tags, function (string $tag) {
             return $this->slug($tag);

tests/Fixtures/Dto/CustomDto.php

@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tests\Fixtures\Dto;
+
+use DragonCode\SimpleDataTransferObject\DataTransferObject;
+
+class CustomDto extends DataTransferObject
+{
+    public $wasd = null;
+}

tests/Support/KeyTest.php

@@ -5,10 +5,20 @@
 namespace Tests\Support;
 
 use DragonCode\Cache\Facades\Support\Key;
+use Tests\Fixtures\Concerns\Dtoable;
+use Tests\Fixtures\Dto\CustomDto;
+use Tests\Fixtures\Dto\DtoObject;
 use Tests\TestCase;
 
 class KeyTest extends TestCase
 {
+    use Dtoable;
+
+    protected $value = [
+        'foo' => 'Foo',
+        'bar' => 'Bar',
+    ];
+
     public function testString()
     {
         $key = Key::get(':', ['Foo', 'Bar', 'Baz']);
@@ -48,4 +58,34 @@ public function testCombine()
 
         $this->assertSame($expected, $key);
     }
+
+    public function testArrayable()
+    {
+        $key = Key::get(':', $this->dto());
+
+        $expected = '1356c67d7ad1638d816bfb822dd2c25d:ddc35f88fa71b6ef142ae61f35364653';
+
+        $this->assertSame($expected, $key);
+    }
+
+    public function testMultiObjectArrays()
+    {
+        $key = Key::get(':', [
+            'qwe',
+            'rty',
+            DtoObject::make(['foo' => 'Foo']),
+            DtoObject::make(['bar' => 'Bar']),
+            CustomDto::make(['wasd' => 'WASD']),
+        ]);
+
+        // Before hashing, the keys look like this:
+        // qwe:rty:Foo:Bar:WASD
+
+        $expected =
+            '76d80224611fc919a5d54f0ff9fba446:24113791d2218cb84c9f0462e91596ef:' .
+            '1356c67d7ad1638d816bfb822dd2c25d:ddc35f88fa71b6ef142ae61f35364653:' .
+            '91412421a30e87ce15a4f10ea39f6682';
+
+        $this->assertSame($expected, $key);
+    }
 }

tests/Support/TagTest.php

@@ -5,10 +5,20 @@
 namespace Tests\Support;
 
 use DragonCode\Cache\Facades\Support\Tag;
+use Tests\Fixtures\Concerns\Dtoable;
+use Tests\Fixtures\Dto\CustomDto;
+use Tests\Fixtures\Dto\DtoObject;
 use Tests\TestCase;
 
 class TagTest extends TestCase
 {
+    use Dtoable;
+
+    protected $value = [
+        'foo' => 'Foo',
+        'bar' => 'Bar',
+    ];
+
     public function testString()
     {
         $tags = Tag::get(['FoO', 'Bar', 'a-aZ', ' Qwe Rt_y']);
@@ -39,4 +49,28 @@ public function testArray()
 
         $this->assertSame($expected, $tags);
     }
+
+    public function testArrayable()
+    {
+        $key = Tag::get($this->dto());
+
+        $expected = ['foo', 'bar'];
+
+        $this->assertSame($expected, $key);
+    }
+
+    public function testMultiObjectArrays()
+    {
+        $key = Tag::get([
+            'qwe',
+            'rty',
+            DtoObject::make(['foo' => 'Foo']),
+            DtoObject::make(['bar' => 'Bar']),
+            CustomDto::make(['wasd' => 'WASD']),
+        ]);
+
+        $expected = ['qwe', 'rty', 'foo', 'bar', 'wasd'];
+
+        $this->assertSame($expected, $key);
+    }
 }