make taxon comparable

oallain · pamil · commit f5c12d08eb54 · 2020-04-07T12:02:59.000+02:00
diff --git a/src/Sylius/Component/Core/Model/Taxon.php b/src/Sylius/Component/Core/Model/Taxon.php
@@ -15,11 +15,12 @@
 
 use Doctrine\Common\Collections\ArrayCollection;
 use Doctrine\Common\Collections\Collection;
+use Doctrine\Common\Comparable;
 use Sylius\Component\Resource\Model\TimestampableTrait;
 use Sylius\Component\Taxonomy\Model\Taxon as BaseTaxon;
 use Sylius\Component\Taxonomy\Model\TaxonTranslation;
 
-class Taxon extends BaseTaxon implements TaxonInterface
+class Taxon extends BaseTaxon implements TaxonInterface, Comparable
 {
     use TimestampableTrait;
 
@@ -101,4 +102,12 @@ public static function getTranslationClass(): string
     {
         return TaxonTranslation::class;
     }
+
+    /**
+     * @inheritDoc
+     */
+    public function compareTo($other): int
+    {
+        return $this->code === $other->getCode() ? 0 : 1;
+    }
 }
diff --git a/src/Sylius/Component/Core/spec/Model/TaxonSpec.php b/src/Sylius/Component/Core/spec/Model/TaxonSpec.php
@@ -15,9 +15,11 @@
 
 use Doctrine\Common\Collections\ArrayCollection;
 use Doctrine\Common\Collections\Collection;
+use Doctrine\Common\Comparable;
 use PhpSpec\ObjectBehavior;
 use Sylius\Component\Core\Model\ImageInterface;
 use Sylius\Component\Core\Model\ImagesAwareInterface;
+use Sylius\Component\Core\Model\Taxon;
 use Sylius\Component\Core\Model\TaxonInterface;
 
 final class TaxonSpec extends ObjectBehavior
@@ -32,6 +34,11 @@ function it_implements_an_image_aware_interface(): void
         $this->shouldImplement(ImagesAwareInterface::class);
     }
 
+    function it_implements_doctrine_comparable(): void
+    {
+        $this->shouldImplement(Comparable::class);
+    }
+
     function it_initializes_an_image_collection_by_default(): void
     {
         $this->getImages()->shouldHaveType(Collection::class);
@@ -60,4 +67,16 @@ function it_returns_images_by_type(ImageInterface $image): void
 
         $this->getImagesByType('thumbnail')->shouldBeLike(new ArrayCollection([$image->getWrappedObject()]));
     }
+
+    function it_is_comparable(): void
+    {
+        $this->setCode('test');
+
+        $otherTaxon = new Taxon();
+        $otherTaxon->setCode('test');
+        $this->compareTo($otherTaxon)->shouldReturn(0);
+
+        $otherTaxon->setCode('other');
+        $this->compareTo($otherTaxon)->shouldReturn(1);
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -15,11 +15,12 @@`
`15`	`15`
`16`	`16`	`use Doctrine\Common\Collections\ArrayCollection;`
`17`	`17`	`use Doctrine\Common\Collections\Collection;`
	`18`	`+use Doctrine\Common\Comparable;`
`18`	`19`	`use Sylius\Component\Resource\Model\TimestampableTrait;`
`19`	`20`	`use Sylius\Component\Taxonomy\Model\Taxon as BaseTaxon;`
`20`	`21`	`use Sylius\Component\Taxonomy\Model\TaxonTranslation;`
`21`	`22`
`22`		`-class Taxon extends BaseTaxon implements TaxonInterface`
	`23`	`+class Taxon extends BaseTaxon implements TaxonInterface, Comparable`
`23`	`24`	`{`
`24`	`25`	`use TimestampableTrait;`
`25`	`26`
`@@ -101,4 +102,12 @@ public static function getTranslationClass(): string`
`101`	`102`	`{`
`102`	`103`	`return TaxonTranslation::class;`
`103`	`104`	`}`
	`105`	`+`
	`106`	`+ /**`
	`107`	`+ * @inheritDoc`
	`108`	`+ */`
	`109`	`+ public function compareTo($other): int`
	`110`	`+ {`
	`111`	`+ return $this->code === $other->getCode() ? 0 : 1;`
	`112`	`+ }`
`104`	`113`	`}`