Merge pull request #59 from petrkotek/comparison-methods

Add convenient comparison methods isGreaterThan() etc.

Author: Andrés Correa Casablanca

src/Decimal.php

@@ -455,6 +455,59 @@ public function comp(Decimal $b, int $scale = null): int
         );
     }
 
+
+    /**
+     * Returns true if $this > $b, otherwise false
+     *
+     * @param  Decimal $b
+     * @param  integer $scale
+     * @return bool
+     */
+    public function isGreaterThan(Decimal $b, int $scale = null): bool
+    {
+        return $this->comp($b, $scale) === 1;
+    }
+
+    /**
+     * Returns true if $this >= $b
+     *
+     * @param  Decimal $b
+     * @param  integer $scale
+     * @return bool
+     */
+    public function isGreaterOrEqualTo(Decimal $b, int $scale = null): bool
+    {
+        $comparisonResult = $this->comp($b, $scale);
+
+        return $comparisonResult === 1 || $comparisonResult === 0;
+    }
+
+    /**
+     * Returns true if $this < $b, otherwise false
+     *
+     * @param  Decimal $b
+     * @param  integer $scale
+     * @return bool
+     */
+    public function isLessThan(Decimal $b, int $scale = null): bool
+    {
+        return $this->comp($b, $scale) === -1;
+    }
+
+    /**
+     * Returns true if $this <= $b, otherwise false
+     *
+     * @param  Decimal $b
+     * @param  integer $scale
+     * @return bool
+     */
+    public function isLessOrEqualTo(Decimal $b, int $scale = null): bool
+    {
+        $comparisonResult = $this->comp($b, $scale);
+
+        return $comparisonResult === -1 || $comparisonResult === 0;
+    }
+
     /**
      * Returns the element's additive inverse.
      * @return Decimal

tests/Decimal/DecimalIsGreaterOrEqualToTest.php

@@ -0,0 +1,23 @@
+<?php
+declare(strict_types = 1);
+
+use Litipk\BigNumbers\Decimal;
+use PHPUnit\Framework\TestCase;
+
+class DecimalIsGreaterOrEqualToTest extends TestCase
+{
+    public function testGreater()
+    {
+        $this->assertTrue(Decimal::fromFloat(1.01)->isGreaterOrEqualTo(Decimal::fromFloat(1.001)));
+    }
+
+    public function testEqual()
+    {
+        $this->assertTrue(Decimal::fromFloat(1.001)->isGreaterOrEqualTo(Decimal::fromFloat(1.001)));
+    }
+
+    public function testLess()
+    {
+        $this->assertFalse(Decimal::fromFloat(1.001)->isGreaterOrEqualTo(Decimal::fromFloat(1.01)));
+    }
+}

tests/Decimal/DecimalIsGreaterThanTest.php

@@ -0,0 +1,23 @@
+<?php
+declare(strict_types = 1);
+
+use Litipk\BigNumbers\Decimal;
+use PHPUnit\Framework\TestCase;
+
+class DecimalIsGreaterThanTest extends TestCase
+{
+    public function testGreater()
+    {
+        $this->assertTrue(Decimal::fromFloat(1.01)->isGreaterThan(Decimal::fromFloat(1.001)));
+    }
+
+    public function testEqual()
+    {
+        $this->assertFalse(Decimal::fromFloat(1.001)->isGreaterThan(Decimal::fromFloat(1.001)));
+    }
+
+    public function testLess()
+    {
+        $this->assertFalse(Decimal::fromFloat(1.001)->isGreaterThan(Decimal::fromFloat(1.01)));
+    }
+}

tests/Decimal/DecimalIsLessOrEqualToTest.php

@@ -0,0 +1,23 @@
+<?php
+declare(strict_types = 1);
+
+use Litipk\BigNumbers\Decimal;
+use PHPUnit\Framework\TestCase;
+
+class DecimalIsLessOrEqualToTest extends TestCase
+{
+    public function testGreater()
+    {
+        $this->assertFalse(Decimal::fromFloat(1.01)->isLessOrEqualTo(Decimal::fromFloat(1.001)));
+    }
+
+    public function testEqual()
+    {
+        $this->assertTrue(Decimal::fromFloat(1.001)->isLessOrEqualTo(Decimal::fromFloat(1.001)));
+    }
+
+    public function testLess()
+    {
+        $this->assertTrue(Decimal::fromFloat(1.001)->isLessOrEqualTo(Decimal::fromFloat(1.01)));
+    }
+}

tests/Decimal/DecimalIsLessThanTest.php

@@ -0,0 +1,23 @@
+<?php
+declare(strict_types = 1);
+
+use Litipk\BigNumbers\Decimal;
+use PHPUnit\Framework\TestCase;
+
+class DecimalIsLessThanTest extends TestCase
+{
+    public function testGreater()
+    {
+        $this->assertFalse(Decimal::fromFloat(1.01)->isLessThan(Decimal::fromFloat(1.001)));
+    }
+
+    public function testEqual()
+    {
+        $this->assertFalse(Decimal::fromFloat(1.001)->isLessThan(Decimal::fromFloat(1.001)));
+    }
+
+    public function testLess()
+    {
+        $this->assertTrue(Decimal::fromFloat(1.001)->isLessThan(Decimal::fromFloat(1.01)));
+    }
+}