Moved toFloat() to Helper class.

Author: judgej

src/Omnipay/Common/Helper.php

@@ -5,6 +5,8 @@
 
 namespace Omnipay\Common;
 
+use InvalidArgumentException;
+
 /**
  * Helper class
  *
@@ -115,4 +117,30 @@ public static function getGatewayClassName($shortName)
 
         return '\\Omnipay\\'.$shortName.'Gateway';
     }
+
+    /**
+     * Convert an amount into a float.
+     * The float datatype can then be converted into the string
+     * format that the remote gateway requies.
+     *
+     * @var string|int|float $value The value to convert.
+     * @throws InvalidArgumentException on a validation failure.
+     * @return float The amount converted to a float.
+     */
+
+    public static function toFloat($value)
+    {
+        if (!is_string($value) && !is_int($value) && !is_float($value)) {
+            throw new InvalidArgumentException('Data type is not a valid decimal number.');
+        }
+
+        if (is_string($value)) {
+            // Validate generic number, with optional sign and decimals.
+            if (!preg_match('/^[-]?[0-9]+(\.[0-9]*)?$/', $value)) {
+                throw new InvalidArgumentException('String is not a valid decimal number.');
+            }
+        }
+
+        return (float)$value;
+    }
 }

src/Omnipay/Common/Message/AbstractRequest.php

@@ -14,6 +14,7 @@
 use Omnipay\Common\ItemBag;
 use Symfony\Component\HttpFoundation\ParameterBag;
 use Symfony\Component\HttpFoundation\Request as HttpRequest;
+use InvalidArgumentException;
 
 /**
  * Abstract Request
@@ -290,18 +291,12 @@ public function setCardReference($value)
 
     public function toFloat($value)
     {
-        if (!is_string($value) && ! is_int($value) && ! is_float($value)) {
-            throw new InvalidRequestException('Data type is not a valid decimal number.');
+        try {
+            return Helper::toFloat($value);
+        } catch (InvalidArgumentException $e) {
+            // Throw old exception for legacy implementations.
+            throw new InvalidRequestException($e->getMessage(), $e->getCode(), $e);
         }
-
-        if (is_string($value)) {
-            // Validate generic number, with optional sign and decimals.
-            if (!preg_match('/^[-]?[0-9]+(\.[0-9]*)?$/', $value)) {
-                throw new InvalidRequestException('String is not a valid decimal number.');
-            }
-        }
-
-        return (float)$value;
     }
 
     /**

tests/Omnipay/Common/HelperTest.php

@@ -134,4 +134,93 @@ public function testGetGatewayClassNameUnderscoreNamespace()
         $class = Helper::getGatewayClassName('PayPal_Express');
         $this->assertEquals('\\Omnipay\\PayPal\\ExpressGateway', $class);
     }
+
+    /**
+     * Some valid toFloat() inputs.
+     */
+    public function testToFloatFromFloat()
+    {
+        $shortName = Helper::toFloat(1.99);
+        $this->assertSame(1.99, $shortName);
+    }
+
+    public function testToFloatFromInt()
+    {
+        $shortName = Helper::toFloat(199);
+        $this->assertSame(199.0, $shortName);
+    }
+
+    public function testToFloatFromStringDecimal()
+    {
+        $shortName = Helper::toFloat("1.99");
+        $this->assertSame(1.99, $shortName);
+    }
+
+    public function testToFloatFromStringRedunantZeroes()
+    {
+        $shortName = Helper::toFloat("000009.99900000000");
+        $this->assertSame(9.999, $shortName);
+    }
+
+    public function testToFloatFromStringEmptyDecimal()
+    {
+        $shortName = Helper::toFloat("1.");
+        $this->assertSame(1.0, $shortName);
+    }
+
+    public function testToFloatFromStringInt()
+    {
+        $shortName = Helper::toFloat("199");
+        $this->assertSame(199.0, $shortName);
+    }
+
+    public function testToFloatFromStringIntNegative()
+    {
+        $shortName = Helper::toFloat("-199");
+        $this->assertSame(-199.0, $shortName);
+    }
+
+    /**
+     * Some invalid toFloat() inputs.
+     */
+
+    /**
+     * The number MUST always start with a digit.
+     * This is arguably an arbitrary rule that perhaps does not need
+     * to be enforced.
+     *
+     * @expectedException \InvalidArgumentException
+     * @expectedExceptionMessage String is not a valid decimal number
+     */
+    public function testToFloatFromStringEmptyIntegerPart()
+    {
+        $shortName = Helper::toFloat(".99");
+    }
+
+    /**
+     * @expectedException \InvalidArgumentException
+     * @expectedExceptionMessage String is not a valid decimal number
+     */
+    public function testToFloatFromStringTwoDecimalPoints()
+    {
+        $shortName = Helper::toFloat("1.99.");
+    }
+
+    /**
+     * @expectedException \InvalidArgumentException
+     * @expectedExceptionMessage String is not a valid decimal number
+     */
+    public function testToFloatFromStringWrongDecimalPoints()
+    {
+        $shortName = Helper::toFloat("1,99");
+    }
+
+    /**
+     * @expectedException \InvalidArgumentException
+     * @expectedExceptionMessage Data type is not a valid decimal number
+     */
+    public function testToFloatFromBoolean()
+    {
+        $shortName = Helper::toFloat(false);
+    }
 }