Merge pull request #29 from quant-php/dev

feat: add contract for Comparable to Core-package

Author: ThorstenSuckow

src/Quant/Core/Contract/Comparable.php

@@ -0,0 +1,19 @@
+<?php
+
+/**
+ * This file is part of the quant project.
+ *
+ * (c) 2023 Thorsten Suckow-Homberg <[email protected]>
+ *
+ * For full copyright and license information, please consult the LICENSE-file distributed
+ * with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace Quant\Core\Contract;
+
+interface Comparable
+{
+    public function compareTo(Comparable $target): int;
+}

src/Quant/Core/Tests/Contract/ComparableTest.php

@@ -0,0 +1,50 @@
+<?php
+
+/**
+ * This file is part of the quant project.
+ *
+ * (c) 2023 Thorsten Suckow-Homberg <[email protected]>
+ *
+ * For full copyright and license information, please consult the LICENSE-file distributed
+ * with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace Quant\Core\Tests;
+
+use PHPUnit\Framework\TestCase;
+use Quant\Core\Tests\Contract\Resources\Money;
+
+class ComparableTest extends TestCase
+{
+    public function testComparable(): void
+    {
+        $tests = [
+            [[10, 40], [10, 20], 1],
+            [[10, 40], [10, 40], 0],
+            [[10, 20], [10, 40], -1],
+            [[9, 20], [8, 40], 1],
+            [[3, 20], [8, 40], -1],
+        ];
+
+        foreach ($tests as $i => $test) {
+            $aAmount = $test[0][0];
+            $aCents = $test[0][1];
+            $bAmount = $test[1][0];
+            $bCents = $test[1][1];
+            $result = $test[2];
+
+            $moneyA = $this->getComparableClass($aAmount, $aCents);
+            $moneyB = $this->getComparableClass($bAmount, $bCents);
+
+            $this->assertSame($result, $moneyA->compareTo($moneyB));
+        }
+    }
+
+
+    protected function getComparableClass(int $amount, int $cent): Money
+    {
+        return new Money($amount, $cent);
+    }
+}

src/Quant/Core/Tests/Contract/Resources/Money.php

@@ -0,0 +1,49 @@
+<?php
+
+/**
+ * This file is part of the quant project.
+ *
+ * (c) 2023 Thorsten Suckow-Homberg <[email protected]>
+ *
+ * For full copyright and license information, please consult the LICENSE-file distributed
+ * with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace Quant\Core\Tests\Contract\Resources;
+
+use Quant\Core\Attribute\Getter;
+use Quant\Core\Contract\Comparable;
+use Quant\Core\Trait\AccessorTrait;
+
+class Money implements Comparable
+{
+    use AccessorTrait;
+
+    public function __construct(
+        #[Getter]
+        private int $amount,
+        #[Getter]
+        private int $cents
+    ) {
+    }
+
+    public function compareTo(Comparable $target): int
+    {
+        if (!($target instanceof Money)) {
+            return 1;
+        }
+
+        $aAmount = $this->getAmount();
+        $bAmount = $target->getAmount();
+
+        $aCents = $this->getCents();
+        $bCents = $target->getCents();
+
+
+        $c = ($aAmount === $bAmount ? 0 : ($aAmount < $bAmount ? -1 : 1));
+
+        return $c !== 0 ?  $c : ($aCents < $bCents ? -1 : ($aCents > $bCents ? 1 : 0));
+    }
+}