Add option second argument to abbreviate to round off decimals

readme.md

@@ -10,7 +10,7 @@ A dependency-free set of classes you may find useful for WordPress development.
 * [Periodic](#periodic)
   * [::check($option_name, $date_interval): bool](#periodic)
 * [Number](#number)
-  * [::abbreviate($number): string](#abbreviate)
+  * [::abbreviate($number, bool $round = false): string](#abbreviate)
 * [Timezone](#timezone)
   * [::site_timezone(): DateTimeZone](#site_timezone)
   * [::site_offset(): string](#site_offset)
@@ -72,7 +72,7 @@ Calls to `check` will always return a boolean value. The value will be `true` if
 
 ### Abbreviate
 
-**Number::abbreviate(int|float $number): string**
+**Number::abbreviate(int|float $number, bool $round = false): string**
 
 The `abbreviate` methods abbreviates large numbers such as `742898` into shorter strings such as `743K`.
 
@@ -84,6 +84,9 @@ use Proper\Number;
 Number::abbreviate(1260000); // 1.3M
 
 Number::abbreviate(133800); // 133.8K
+
+// Round off decimals 
+Number::abbreviate(133800, true); // 134K
 ```
 
 It provides abbreviations for:

source/Number.php

@@ -9,7 +9,7 @@ class Number
      *
      * @return string
      */
-    public static function abbreviate($number): string
+    public static function abbreviate($number, $round = false): string
     {
         $number        = (int) $number;
         $abbreviations = [
@@ -24,7 +24,7 @@ public static function abbreviate($number): string
             $upper_range = $abbreviation_value * 1000;
 
             if ($number < $upper_range) {
-                $decimals = $number < 1000 ? 0 : 1;
+                $decimals = $number < 1000 || $round ? 0 : 1;
                 $result   = $number / $abbreviation_value;
                 $result   = number_format_i18n($result, $decimals) . $abbreviation;
 

tests/NumberTest.php

@@ -33,6 +33,22 @@ public function test_thousands()
         $this->assertEquals($expected, $actual);
     }
 
+    public function test_rounding_option_down()
+    {
+        $actual   = Number::abbreviate(133300, true);
+        $expected = '133K';
+
+        $this->assertEquals($expected, $actual);
+    }
+
+    public function test_rounding_option_up()
+    {
+        $actual   = Number::abbreviate(133800, true);
+        $expected = '134K';
+
+        $this->assertEquals($expected, $actual);
+    }
+
     public function test_billions()
     {
         $actual   = Number::abbreviate(999000000000);