Merge pull request #27 from michael-rubel/feat/underlying-object-forwarding

Forward methods to underlying object in `Number`

Author: michael-rubel

src/Collection/Primitive/Number.php

@@ -29,6 +29,17 @@
  * @method static static from(int|string $number, int $scale = 2)
  * @method static static makeOrNull(int|string|null $number, int $scale = 2)
  *
+ * @method string abs()
+ * @method string add(float|int|string $value)
+ * @method string divide(float|int|string $value)
+ * @method string multiply(float|int|string $value)
+ * @method string mod(float|int|string $value)
+ * @method string pow(int|string $value)
+ * @method string sqrt()
+ * @method string subtract(float|int|string $value)
+ *
+ * @see \PHP\Math\BigNumber\BigNumber
+ *
  * @extends ValueObject<TKey, TValue>
  */
 class Number extends ValueObject
@@ -86,4 +97,32 @@ public function asFloat(): float
     {
         return (float) $this->bigNumber->getValue();
     }
+
+    /**
+     * Get the underlying `BigNumber` object.
+     *
+     * @return BigNumber
+     */
+    public function asBigNumber(): BigNumber
+    {
+        return $this->bigNumber;
+    }
+
+    /**
+     * Forward call to underlying object if the method
+     * doesn't exist in `Number` and doesn't have a macro.
+     *
+     * @param  string  $method
+     * @param  array  $parameters
+     *
+     * @return mixed
+     */
+    public function __call($method, $parameters)
+    {
+        if (static::hasMacro($method)) {
+            return parent::__call($method, $parameters);
+        }
+
+        return $this->bigNumber->{$method}(...$parameters)->getValue();
+    }
 }

tests/Unit/Primitive/NumberTest.php

@@ -22,6 +22,21 @@
     $this->assertSame(36000.50, $valueObject->asFloat());
 });
 
+test('number as a big number', function () {
+    $number = new Number('20000.793', 3);
+    $this->assertEquals(new BigNumber('20000.793', 3, false), $number->asBigNumber());
+});
+
+test('number can be divided using magic call', function () {
+    $number = new Number('20000.793', 4);
+    $this->assertSame('10000.3965', $number->divide(2));
+});
+
+test('number can be multiplied using magic call', function () {
+    $number = new Number('20000.793', 3);
+    $this->assertSame('40001.586', $number->multiply(2));
+});
+
 test('number can accept string', function () {
     $valueObject = new Number('1');
     $this->assertSame('1.00', $valueObject->value());