Merge pull request #37 from TheDragonCode/2.x

Added `$only` and `$except` properties

Author: Andrey Helldar

src/DataTransferObject.php

@@ -26,9 +26,13 @@ abstract class DataTransferObject implements Contract
     use Reflection;
     use To;
 
+    protected const DISALLOW = ['map', 'only', 'except'];
+
     protected $map = [];
 
-    protected $disallow = ['map', 'disallow'];
+    protected $only = [];
+
+    protected $except = [];
 
     /**
      * @param array $items
@@ -69,6 +73,8 @@ public function set(string $key, $value): DataTransferObject
      */
     public function merge(array $items): DataTransferObject
     {
+        $items = $this->filter($items);
+
         $this->setMap($items);
         $this->setItems($items);
 
@@ -85,6 +91,31 @@ public function toArray(): array
         return $this->getProperties($this);
     }
 
+    protected function filter(array $items): array
+    {
+        return $this->filterOnly(
+            $this->filterExcept($items)
+        );
+    }
+
+    protected function filterOnly(array $items): array
+    {
+        if ($keys = $this->only) {
+            return Arr::only($items, $keys);
+        }
+
+        return $items;
+    }
+
+    protected function filterExcept(array $items): array
+    {
+        if ($keys = $this->except) {
+            return Arr::except($items, $keys);
+        }
+
+        return $items;
+    }
+
     /**
      * @param array $items
      *
@@ -169,7 +200,7 @@ protected function isAllowProperty(string $key): bool
 
     protected function isAllowKey(string $key): bool
     {
-        return ! in_array(Str::lower($key), $this->disallow, true);
+        return ! in_array(Str::lower($key), self::DISALLOW, true);
     }
 
     protected function sourceKeyDoesntExist(array $items, string $key): bool

tests/Fixtures/Except.php

@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tests\Fixtures;
+
+use DragonCode\SimpleDataTransferObject\DataTransferObject;
+
+class Except extends DataTransferObject
+{
+    public $foo;
+
+    public $bar;
+
+    public $baq;
+
+    protected $map = [
+        'qwe' => 'foo',
+        'rty' => 'bar',
+    ];
+
+    protected $except = [
+        'bar',
+    ];
+}

tests/Fixtures/Only.php

@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tests\Fixtures;
+
+use DragonCode\SimpleDataTransferObject\DataTransferObject;
+
+class Only extends DataTransferObject
+{
+    public $foo;
+
+    public $bar;
+
+    public $baq;
+
+    protected $map = [
+        'qwe' => 'foo',
+        'rty' => 'bar',
+    ];
+
+    protected $only = [
+        'foo',
+    ];
+}

tests/TestCase.php

@@ -13,4 +13,6 @@ abstract class TestCase extends BaseTestCase
     protected $bar = 'Bar';
 
     protected $baz = 'Baz';
+
+    protected $baq = 'Baq';
 }

tests/Unit/ExceptTest.php

@@ -0,0 +1,29 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tests\Unit;
+
+use Tests\Fixtures\Except;
+use Tests\TestCase;
+
+class ExceptTest extends TestCase
+{
+    public function testMake()
+    {
+        $object = Except::make([
+            'bar' => $this->bar,
+            'baq' => $this->baq,
+            'qwe' => $this->foo,
+            'rty' => $this->baq,
+        ]);
+
+        $this->assertIsArray($object->toArray());
+
+        $this->assertSame([
+            'foo' => $this->foo,
+            'bar' => $this->baq,
+            'baq' => $this->baq,
+        ], $object->toArray());
+    }
+}

tests/Unit/OnlyTest.php

@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tests\Unit;
+
+use Tests\Fixtures\Only;
+use Tests\TestCase;
+
+class OnlyTest extends TestCase
+{
+    public function testMake()
+    {
+        $object = Only::make([
+            'foo' => $this->foo,
+            'bar' => $this->bar,
+            'baq' => $this->baq,
+        ]);
+
+        $this->assertSame($this->foo, $object->foo);
+
+        $this->assertNull($object->bar);
+        $this->assertNull($object->baq);
+    }
+}