Fix copying of DateInterval objects

Author: theofidry

README.md

@@ -27,6 +27,7 @@ DeepCopy helps you create deep copies (clones) of your objects. It is designed t
         1. [`DoctrineProxyFilter`](#doctrineproxyfilter-filter)
         1. [`ReplaceFilter`](#replacefilter-type-filter)
         1. [`ShallowCopyFilter`](#doctrinecollectionfilter-type-filter)
+1. [Edge cases](#edge-cases)
 1. [Contributing](#contributing)
     1. [Tests](#tests)
 
@@ -297,6 +298,15 @@ $myServiceWithMocks = new MyService(m::mock(MyDependency1::class), m::mock(MyDep
 ```
 
 
+## Edge cases
+
+The following structures cannot be deep-copied with PHP Reflection. As a result they are shallow cloned and filters are
+not applied. There is two ways for you to handle them:
+
+- Implement your own `__clone()` method
+- Use a filter with a type matcher
+
+
 ## Contributing
 
 DeepCopy is distributed under the MIT license.

fixtures/f007/FooDateInterval.php

@@ -0,0 +1,15 @@
+<?php
+
+namespace DeepCopy\f007;
+
+use DateInterval;
+
+class FooDateInterval extends DateInterval
+{
+    public $cloned = false;
+
+    public function __clone()
+    {
+        $this->cloned = true;
+    }
+}

src/DeepCopy/DeepCopy.php

@@ -2,11 +2,13 @@
 
 namespace DeepCopy;
 
+use DateInterval;
 use DateTimeInterface;
 use DateTimeZone;
 use DeepCopy\Exception\CloneException;
 use DeepCopy\Filter\Filter;
 use DeepCopy\Matcher\Matcher;
+use DeepCopy\TypeFilter\Date\DateIntervalFilter;
 use DeepCopy\TypeFilter\Spl\SplDoublyLinkedListFilter;
 use DeepCopy\TypeFilter\TypeFilter;
 use DeepCopy\TypeMatcher\TypeMatcher;
@@ -57,6 +59,7 @@ public function __construct($useCloneMethod = false)
     {
         $this->useCloneMethod = $useCloneMethod;
 
+        $this->addTypeFilter(new DateIntervalFilter(), new TypeMatcher(DateInterval::class));
         $this->addTypeFilter(new SplDoublyLinkedListFilter($this), new TypeMatcher(SplDoublyLinkedList::class));
     }
 
@@ -186,7 +189,10 @@ private function copyObject($object)
             return $newObject;
         }
 
-        if ($newObject instanceof DateTimeInterface || get_class($newObject) === DateTimeZone::class) {
+        if ($newObject instanceof DateTimeInterface
+            || $newObject instanceof DateTimeZone
+            || $newObject instanceof DateInterval
+        ) {
             return $newObject;
         }
 
@@ -225,7 +231,6 @@ function ($object) {
             }
         }
 
-        // No filter has been applied: simply copy the value
         $property->setAccessible(true);
         $propertyValue = $property->getValue($object);
 

src/DeepCopy/TypeFilter/Date/DateIntervalFilter.php

@@ -0,0 +1,33 @@
+<?php
+
+namespace DeepCopy\TypeFilter\Date;
+
+use DateInterval;
+use DeepCopy\TypeFilter\TypeFilter;
+
+/**
+ * @final
+ *
+ * @deprecated Will be removed in 2.0. This filter will no longer be necessary in PHP 7.1+.
+ */
+class DateIntervalFilter implements TypeFilter
+{
+
+    /**
+     * {@inheritdoc}
+     *
+     * @param DateInterval $element
+     *
+     * @see http://news.php.net/php.bugs/205076
+     */
+    public function apply($element)
+    {
+        $copy = new DateInterval('P0D');
+
+        foreach ($element as $propertyName => $propertyValue) {
+            $copy->{$propertyName} = $propertyValue;
+        }
+
+        return $copy;
+    }
+}

src/DeepCopy/TypeFilter/Spl/SplDoublyLinkedListFilter.php

@@ -11,9 +11,6 @@
  */
 class SplDoublyLinkedListFilter implements TypeFilter
 {
-    /**
-     * @var DeepCopy
-     */
     private $deepCopy;
 
     public function __construct(DeepCopy $deepCopy)

tests/DeepCopyTest/DeepCopyTest.php

@@ -2,6 +2,7 @@
 
 namespace DeepCopyTest;
 
+use DateInterval;
 use DateTime;
 use DateTimeImmutable;
 use DateTimeZone;
@@ -13,6 +14,7 @@
 use DeepCopy\f004;
 use DeepCopy\f005;
 use DeepCopy\f006;
+use DeepCopy\f007;
 use DeepCopy\f008;
 use DeepCopy\Filter\KeepFilter;
 use DeepCopy\Filter\SetNullFilter;
@@ -136,6 +138,7 @@ public function test_it_copies_dynamic_properties()
     /**
      * @ticket https://github.com/myclabs/DeepCopy/issues/38
      * @ticket https://github.com/myclabs/DeepCopy/pull/70
+     * @ticket https://github.com/myclabs/DeepCopy/pull/76
      */
     public function test_it_can_copy_an_object_with_a_date_object_property()
     {
@@ -144,26 +147,54 @@ public function test_it_can_copy_an_object_with_a_date_object_property()
         $object->d1 = new DateTime();
         $object->d2 = new DateTimeImmutable();
         $object->dtz = new DateTimeZone('UTC');
+        $object->di = new DateInterval('P2D');
 
         $copy = deep_copy($object);
 
         $this->assertEqualButNotSame($object->d1, $copy->d1);
         $this->assertEqualButNotSame($object->d2, $copy->d2);
         $this->assertEqualButNotSame($object->dtz, $copy->dtz);
+        $this->assertEqualButNotSame($object->di, $copy->di);
     }
 
     /**
-     * @ticket https://github.com/myclabs/DeepCopy/pull/70g
+     * @ticket https://github.com/myclabs/DeepCopy/pull/70
      */
-    public function test_it_does_not_skip_the_copy_for_userland_datetimezone()
+    public function test_it_skips_the_copy_for_userland_datetimezone()
     {
+        $deepCopy = new DeepCopy();
+        $deepCopy->addFilter(
+            new SetNullFilter(),
+            new PropertyNameMatcher('cloned')
+        );
+
         $object = new stdClass();
 
-        $object->dtz = new DateTimeZone('UTC');
+        $object->dtz = new f007\FooDateTimeZone('UTC');
 
-        $copy = deep_copy($object);
+        $copy = $deepCopy->copy($object);
 
-        $this->assertEqualButNotSame($object->dtz, $copy->dtz);
+        $this->assertTrue($copy->dtz->cloned);
+    }
+
+    /**
+     * @ticket https://github.com/myclabs/DeepCopy/pull/76
+     */
+    public function test_it_skips_the_copy_for_userland_dateinterval()
+    {
+        $deepCopy = new DeepCopy();
+        $deepCopy->addFilter(
+            new SetNullFilter(),
+            new PropertyNameMatcher('cloned')
+        );
+
+        $object = new stdClass();
+
+        $object->di = new f007\FooDateInterval('P2D');
+
+        $copy = $deepCopy->copy($object);
+
+        $this->assertFalse($copy->di->cloned);
     }
 
     public function test_it_copies_the_private_properties_of_the_parent_class()

tests/DeepCopyTest/TypeFilter/Date/DateIntervalFilterTest.php

@@ -0,0 +1,25 @@
+<?php
+
+namespace DeepCopyTest\TypeFilter\Date;
+
+use DateInterval;
+use DeepCopy\TypeFilter\Date\DateIntervalFilter;
+use PHPUnit_Framework_TestCase;
+
+/**
+ * @covers \DeepCopy\TypeFilter\Date\DateIntervalFilter
+ */
+class DateIntervalFilterTest extends PHPUnit_Framework_TestCase
+{
+    public function test_it_deep_copies_a_DateInterval()
+    {
+        $object = new DateInterval('P2D');;
+
+        $filter = new DateIntervalFilter();
+
+        $copy = $filter->apply($object);
+
+        $this->assertEquals($object, $copy);
+        $this->assertNotSame($object, $copy);
+    }
+}

tests/DeepCopyTest/TypeFilter/Spl/SplDoublyLinkedListFilterTest.php

@@ -13,7 +13,7 @@
  */
 class SplDoublyLinkedListFilterTest extends PHPUnit_Framework_TestCase
 {
-    public function test_it_deeps_copy_a_doubly_linked_spl_list()
+    public function test_it_deep_copies_a_doubly_linked_spl_list()
     {
         $foo = new stdClass();