Merge pull request #16 from ergebnis/feature/compare

localheinz · web-flow · commit 27bbfaba39b8 · 2023-12-26T12:11:43.000+01:00
Enhancement: Allow comparing `Major`s
diff --git a/README.md b/README.md
@@ -187,13 +187,11 @@ declare(strict_types=1);
 use Ergebnis\Version;
 
 $one = Version\Major::fromString('1');
-$two = Version\Major::fromString('1');
-$three = Version\Major::fromString('2');
+$two = Version\Major::fromString('2');
 
-$one->equals($two); // true
-$one->equals($three); // false
-
-$one->equals($two); // true
+$one->compare($two); // -1
+$one->compare($one); // 0
+$two->compare($one); // 1
 ```
 
 ### Create a `Minor` from an `int`
diff --git a/psalm-baseline.xml b/psalm-baseline.xml
@@ -26,6 +26,7 @@
       <code>provideInvalidStringValue</code>
       <code>provideValidStringValue</code>
       <code>provideValueAndBumpedValue</code>
+      <code>provideValueOtherValueAndResult</code>
     </PossiblyUnusedMethod>
   </file>
   <file src="test/Unit/MinorTest.php">
diff --git a/src/Major.php b/src/Major.php
@@ -75,8 +75,8 @@ public function bump(): self
         return new self((string) ($valueCastedToInt + 1));
     }
 
-    public function equals(self $other): bool
+    public function compare(self $other): int
     {
-        return $this->value === $other->value;
+        return $this->value <=> $other->value;
     }
 }
diff --git a/test/Unit/MajorTest.php b/test/Unit/MajorTest.php
@@ -148,23 +148,47 @@ public static function provideValueAndBumpedValue(): \Generator
         }
     }
 
-    public function testEqualsReturnsFalseWhenValuesAreDifferent(): void
-    {
-        $faker = self::faker()->unique();
-
-        $one = Major::fromString((string) $faker->numberBetween(0));
-        $two = Major::fromString((string) $faker->numberBetween(0));
+    #[Framework\Attributes\DataProvider('provideValueOtherValueAndResult')]
+    public function testCompareReturnsResultOfComparingValues(
+        string $value,
+        string $otherValue,
+        int $result,
+    ): void {
+        $one = Major::fromString($value);
+        $two = Major::fromString($otherValue);
 
-        self::assertFalse($one->equals($two));
+        self::assertSame($result, $one->compare($two));
     }
 
-    public function testEqualsReturnsTrueWhenValueIsSame(): void
+    /**
+     * @return \Generator<string, array{0: string, 1: string, 2: int}>
+     */
+    public static function provideValueOtherValueAndResult(): \Generator
     {
-        $value = (string) self::faker()->numberBetween(0);
-
-        $one = Major::fromString($value);
-        $two = Major::fromString($value);
+        $values = [
+            'less' => [
+                '0',
+                '1',
+                -1,
+            ],
+            'same' => [
+                '1',
+                '1',
+                0,
+            ],
+            'greater' => [
+                '2',
+                '1',
+                1,
+            ],
+        ];
 
-        self::assertTrue($one->equals($two));
+        foreach ($values as $key => [$value, $otherValue, $result]) {
+            yield $key => [
+                $value,
+                $otherValue,
+                $result,
+            ];
+        }
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -75,8 +75,8 @@ public function bump(): self`
`75`	`75`	`return new self((string) ($valueCastedToInt + 1));`
`76`	`76`	`}`
`77`	`77`
`78`		`- public function equals(self $other): bool`
	`78`	`+ public function compare(self $other): int`
`79`	`79`	`{`
`80`		`- return $this->value === $other->value;`
	`80`	`+ return $this->value <=> $other->value;`
`81`	`81`	`}`
`82`	`82`	`}`