make product variant comparable

oallain · oallain · commit a5efeb5d31c2 · 2020-06-21T16:59:27.000+02:00
diff --git a/src/Sylius/Component/Core/Model/ProductVariant.php b/src/Sylius/Component/Core/Model/ProductVariant.php
@@ -15,11 +15,12 @@
 
 use Doctrine\Common\Collections\ArrayCollection;
 use Doctrine\Common\Collections\Collection;
+use Doctrine\Common\Comparable;
 use Sylius\Component\Product\Model\ProductVariant as BaseVariant;
 use Sylius\Component\Shipping\Model\ShippingCategoryInterface;
 use Sylius\Component\Taxation\Model\TaxCategoryInterface;
 
-class ProductVariant extends BaseVariant implements ProductVariantInterface
+class ProductVariant extends BaseVariant implements ProductVariantInterface, Comparable
 {
     /** @var int */
     protected $version = 1;
@@ -444,4 +445,12 @@ public function removeImage(ProductImageInterface $image): void
             $this->images->removeElement($image);
         }
     }
+
+    /**
+     * @inheritDoc
+     */
+    public function compareTo($other): int
+    {
+        return $this->code === $other->getCode() ? 0 : 1;
+    }
 }
diff --git a/src/Sylius/Component/Core/spec/Model/ProductVariantSpec.php b/src/Sylius/Component/Core/spec/Model/ProductVariantSpec.php
@@ -15,12 +15,14 @@
 
 use Doctrine\Common\Collections\ArrayCollection;
 use Doctrine\Common\Collections\Collection;
+use Doctrine\Common\Comparable;
 use PhpSpec\ObjectBehavior;
 use Sylius\Component\Core\Model\ChannelInterface;
 use Sylius\Component\Core\Model\ChannelPricingInterface;
 use Sylius\Component\Core\Model\Product;
 use Sylius\Component\Core\Model\ProductImageInterface;
 use Sylius\Component\Core\Model\ProductImagesAwareInterface;
+use Sylius\Component\Core\Model\ProductVariant;
 use Sylius\Component\Core\Model\ProductVariantInterface;
 use Sylius\Component\Product\Model\ProductVariant as BaseProductVariant;
 use Sylius\Component\Resource\Model\VersionedInterface;
@@ -41,6 +43,11 @@ function it_implements_a_taxable_interface(): void
         $this->shouldImplement(TaxableInterface::class);
     }
 
+    function it_implements_doctrine_comparable(): void
+    {
+        $this->shouldImplement(Comparable::class);
+    }
+
     function it_extends_a_product_variant_model(): void
     {
         $this->shouldHaveType(BaseProductVariant::class);
@@ -273,4 +280,16 @@ function it_returns_images_by_type(ProductImageInterface $image, Product $produc
         $this->addImage($image);
         $this->getImagesByType('thumbnail')->shouldBeLike(new ArrayCollection([$image->getWrappedObject()]));
     }
+
+    function it_is_comparable(): void
+    {
+        $this->setCode('test');
+
+        $otherTaxon = new ProductVariant();
+        $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\Product\Model\ProductVariant as BaseVariant;`
`19`	`20`	`use Sylius\Component\Shipping\Model\ShippingCategoryInterface;`
`20`	`21`	`use Sylius\Component\Taxation\Model\TaxCategoryInterface;`
`21`	`22`
`22`		`-class ProductVariant extends BaseVariant implements ProductVariantInterface`
	`23`	`+class ProductVariant extends BaseVariant implements ProductVariantInterface, Comparable`
`23`	`24`	`{`
`24`	`25`	`/** @var int */`
`25`	`26`	`protected $version = 1;`
`@@ -444,4 +445,12 @@ public function removeImage(ProductImageInterface $image): void`
`444`	`445`	`$this->images->removeElement($image);`
`445`	`446`	`}`
`446`	`447`	`}`
	`448`	`+`
	`449`	`+ /**`
	`450`	`+ * @inheritDoc`
	`451`	`+ */`
	`452`	`+ public function compareTo($other): int`
	`453`	`+ {`
	`454`	`+ return $this->code === $other->getCode() ? 0 : 1;`
	`455`	`+ }`
`447`	`456`	`}`