Better number overflow handling

Also we check for edge cases within the unit tests.

Author: swashata

.travis.yml

@@ -18,6 +18,7 @@ env:
 # Define the php versions against we want to test our code
 php:
     - 7.0
+    - 7.1
 
 matrix:
   fast_finish: true
@@ -40,9 +41,9 @@ install:
 # Testing the app (see phpunit.xml), generating Code Coverage report
 script:
   - ./vendor/bin/phpunit --coverage-clover build/logs/clover.xml
-  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT
 
-#after_failure:
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT
 
 # Tell Travis CI to monitor only 'master' branch
 branches:

src/Exception/NTWIndiaException.php

@@ -0,0 +1,11 @@
+<?php
+namespace NTWIndia\Exception;
+
+/**
+ * NTWIndiaInvalidNumber
+ *
+ * Exception raised within the NTWIndia class when invalid number is passed
+ */
+class NTWIndiaInvalidNumber extends \Exception {
+
+}

src/Exception/NTWIndiaInvalidNumber.php

@@ -0,0 +1,11 @@
+<?php
+namespace NTWIndia\Exception;
+
+/**
+ * NTWIndiaInvalidNumber
+ *
+ * Exception raised within the NTWIndia class when number is greater than acceptable value
+ */
+class NTWIndiaNumberOverflow extends \Exception {
+
+}

src/Exception/NTWIndiaNumberOverflow.php

@@ -123,11 +123,13 @@ class NTWIndia {
 	 * The number supplied has to be greater than 0. Negative numbers aren't
 	 * supported.
 	 *
-	 * @param      integer|float      $number  The number to convert
+	 * @param      integer|float                     $number  The number to
+	 *                                                        convert
 	 *
-	 * @throws     NTWIndiaException  When passed variable is not numeric
+	 * @throws     Exception\NTWIndiaInvalidNumber   When passed variable is not numeric
+	 * @throws     Exception\NTWIndiaNumberOverflow  When passed number is greater than system maximum
 	 *
-	 * @return     string             The covnerted value
+	 * @return     string                            The covnerted value
 	 */
 	public function numToWord( $number ) {
 		/**
@@ -136,7 +138,12 @@ public function numToWord( $number ) {
 		 * If not then log a warning
 		 */
 		if ( ! is_numeric( $number ) ) {
-			throw new Exception\NTWIndiaException( 'Valid number not given' );
+			throw new Exception\NTWIndiaInvalidNumber( 'Valid number not given.' );
+		}
+
+		// Check if number is exceeding the system maximum
+		if ( $number > PHP_INT_MAX ) {
+			throw new Exception\NTWIndiaNumberOverflow( 'Number is greater than system maximum.' );
 		}
 
 		// Convert to the absolute value
@@ -252,23 +259,24 @@ private function convertNumber( $number ) {
 	 * It can be called when you know the number is less than 100 to reduce
 	 * memory and calculation
 	 *
-	 * @param      int                                   $number  The number
+	 * @param      int                               $number  The number
 	 *
-	 * @throws     NTWIndia\Exception\NTWIndiaException  When a valid number is not given
+	 * @throws     Exception\NTWIndiaInvalidNumber   When a valid number is not given
+	 * @throws     Exception\NTWIndiaNumberOverflow  When number is greater than 99
 	 *
-	 * @return     string                                Word value of the number
+	 * @return     string                            Word value of the number
 	 */
 	public function numToWordSmall( $number ) {
 		// Check if number is numeric
 		if ( ! is_numeric( $number ) ) {
-			throw new Exception\NTWIndiaException( 'Valid number not given.' );
+			throw new Exception\NTWIndiaInvalidNumber( 'Valid number not given.' );
 		}
 		$number = floor( abs( $number ) );
 
 		// Check if number is greater than 99
-		// If so, then further breaking is needed
+		// If so, then just throw an exception
 		if ( $number > 99 ) {
-			return $this->convertNumber( $number );
+			throw new Exception\NTWIndiaNumberOverflow( 'Number is greater than 99. Use numToWord method.' );
 		}
 
 		// Calculate the last character beforehand

src/NTWIndia.php

@@ -51,6 +51,15 @@ public function testZeroValue() {
 		$this->assertEquals( $word, $this->ntw->numToWord( $num ) );
 	}
 
+	public function testFloatingValue() {
+		$num = 100.24;
+		$word = 'One Hundred And 24/100';
+		$this->assertEquals( $word, $this->ntw->numToWord( $num ) );
+		$num = 123.00;
+		$word = 'One Hundred And Twenty Three';
+		$this->assertEquals( $word, $this->ntw->numToWord( $num ) );
+	}
+
 	public function testNumToWdSmall() {
 		$num_to_wd = $this->getNumToWord();
 		foreach ( $num_to_wd as $num => $wd ) {
@@ -59,19 +68,33 @@ public function testNumToWdSmall() {
 	}
 
 	/**
-	 * @expectedException NTWIndia\Exception\NTWIndiaException
+	 * @expectedException NTWIndia\Exception\NTWIndiaInvalidNumber
 	 */
 	public function testNumToWordException() {
 		$this->ntw->numToWord( 'foo' );
 	}
 
 	/**
-	 * @expectedException NTWIndia\Exception\NTWIndiaException
+	 * @expectedException NTWIndia\Exception\NTWIndiaNumberOverflow
+	 */
+	public function testNumToWordOverflowException() {
+		$this->ntw->numToWord( 92233720368547758070 );
+	}
+
+	/**
+	 * @expectedException NTWIndia\Exception\NTWIndiaInvalidNumber
 	 */
 	public function testNumToWordSmallException() {
 		$this->ntw->numToWordSmall( 'bar' );
 	}
 
+	/**
+	 * @expectedException NTWIndia\Exception\NTWIndiaNumberOverflow
+	 */
+	public function testNumToWordSmallOverflowException() {
+		$this->ntw->numToWordSmall( 200 );
+	}
+
 	private function getNumToWord() {
 		return array(
 			'0'  => 'Zero',