Renamed DataFilter to ReplaceFilter + formatting tweaks

Author: mnapoli

README.md

@@ -128,22 +128,22 @@ $myCopy = $deepCopy->copy($myObject);
 // $myCopy->category has not been touched
 ```
 
-### `DataFilter`
+### `ReplaceFilter`
 
-If you want modify data of property like value of an array you can use the `DataFilter`.
+If you want to replace the value of a property:
 
 ```php
 $deepCopy = new DeepCopy();
-$callback = function($data) { 
-    $data['options']['option1'] = false; return $data;
+$callback = function ($currentValue) {
+    return $currentValue . ' (copy)'
 };
-$deepCopy->addFilter(new DataFilter($callback), new PropertyMatcher('MyClass', 'myProperty'));
+$deepCopy->addFilter(new ReplaceFilter($callback), new PropertyMatcher('MyClass', 'title'));
 $myCopy = $deepCopy->copy($myObject);
 
-// $myCopy->myProperty will return data modified by your callback
+// $myCopy->title will contain the data returned by the callback, e.g. 'The title (copy)'
 ```
 
-**NOTE** : The "callback" parameter of the DataFilter constructor accepts any PHP callable.
+The `$callback` parameter of the `ReplaceFilter` constructor accepts any PHP callable.
 
 
 #### `DoctrineCollectionFilter`

src/DeepCopy/Filter/DataFilter.php

@@ -0,0 +1,35 @@
+<?php
+
+namespace DeepCopy\Filter;
+
+/**
+ * Replace the value of a property
+ */
+class ReplaceFilter implements Filter
+{
+    /**
+     * @var callable
+     */
+    protected $callback;
+
+    /**
+     * @param callable $callable Will be called to get the new value for each property to replace
+     */
+    public function __construct(callable $callable)
+    {
+        $this->callback = $callable;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function apply($object, $property, $objectCopier)
+    {
+        $reflectionProperty = new \ReflectionProperty($object, $property);
+        $reflectionProperty->setAccessible(true);
+
+        $value = call_user_func($this->callback, $reflectionProperty->getValue($object));
+
+        $reflectionProperty->setValue($object, $value);
+    }
+}

src/DeepCopy/Filter/ReplaceFilter.php

@@ -0,0 +1,89 @@
+<?php
+
+namespace DeepCopyTest\Filter;
+
+use DeepCopy\DeepCopy;
+use DeepCopy\Filter\ReplaceFilter;
+use DeepCopy\Matcher\PropertyMatcher;
+
+class ReplaceFilterTest extends \PHPUnit_Framework_TestCase
+{
+    /**
+     * @dataProvider handlerProvider
+     */
+    public function testApply(callable $callback, array $expected)
+    {
+        $object = new \stdClass();
+        $object->data = ['foo' => 'bar', 'baz' => 'foo'];
+
+        $filter = new ReplaceFilter($callback);
+
+        $filter->apply($object, 'data', function () {
+            return null;
+        });
+
+        $this->assertEquals($expected, $object->data);
+    }
+
+    public function handlerProvider()
+    {
+        $closure = function ($data) {
+            unset($data['baz']);
+            return $data;
+        };
+
+        return [
+            [$closure, ['foo' => 'bar']],
+            ['DeepCopyTest\Filter\Callback::copy', ['foo' => 'bar', 'baz' => 'foo', 'foobar' => 'baz']],
+            [[new Callback(), 'callback'], ['foo' => 'foo']]
+        ];
+    }
+
+    public function testIntegration()
+    {
+        // Prepare object to copy
+        $object = new \StdClass();
+        $object->data = [
+            'foo' => 'bar',
+            'baz' => ['bar' => 'foo'],
+            'bar' => 'foo'
+        ];
+
+        // Copy
+        $deepCopy = new DeepCopy();
+        $deepCopy->addFilter(new ReplaceFilter(function ($data) {
+            $data['baz']['bar'] = 'dummy_change';
+            unset($data['bar']);
+
+            return $data;
+        }), new PropertyMatcher(get_class($object), 'data'));
+
+        $copied = $deepCopy->copy($object);
+
+        // Check copied
+        $this->assertEquals([
+            'foo' => 'bar',
+            'baz' => ['bar' => 'dummy_change']
+        ], $copied->data);
+
+        // Check original object is unchanged
+        $this->assertEquals(
+            ['foo' => 'bar', 'baz' => ['bar' => 'foo'], 'bar' => 'foo'],
+            $object->data
+        );
+    }
+}
+
+class Callback
+{
+    public static function copy($data)
+    {
+        $data['foobar'] = 'baz';
+        return $data;
+    }
+
+    public function callback($data)
+    {
+        return ['foo' => 'foo'];
+    }
+}