Adds number_to_human and several improvements in NumberHelper. [#4239 state:resolved]

Signed-off-by: José Valim <jose.valim@gmail.com>

1 files changed, 151 insertions, 19 deletions

diff --git a/actionpack/test/template/number_helper_test.rb b/actionpack/test/template/number_helper_test.rb
index 0a2b82bd89..c90d89fb61 100644
--- a/actionpack/test/template/number_helper_test.rb
+++ b/actionpack/test/template/number_helper_test.rb
@@ -19,6 +19,15 @@ class NumberHelperTest < ActionView::TestCase
     gigabytes(number) * 1024
   end
 
+  def silence_deprecation_warnings
+    @old_deprecatios_silenced = ActiveSupport::Deprecation.silenced
+    ActiveSupport::Deprecation.silenced  = true
+  end
+
+  def restore_deprecation_warnings
+    ActiveSupport::Deprecation.silenced  = @old_deprecatios_silenced
+  end
+
   def test_number_to_phone
     assert_equal("555-1234", number_to_phone(5551234))
     assert_equal("800-555-1212", number_to_phone(8005551212))
@@ -43,7 +52,7 @@ class NumberHelperTest < ActionView::TestCase
     assert_equal("&pound;1234567890,50", number_to_currency(1234567890.50, {:unit => "&pound;", :separator => ",", :delimiter => ""}))
     assert_equal("$1,234,567,890.50", number_to_currency("1234567890.50"))
     assert_equal("1,234,567,890.50 K&#269;", number_to_currency("1234567890.50", {:unit => "K&#269;", :format => "%n %u"}))
-    #assert_equal("$x.", number_to_currency("x")) # fails due to API consolidation
+    assert_equal("$x.", number_to_currency("x."))
     assert_equal("$x", number_to_currency("x"))
     assert_nil number_to_currency(nil)
   end
@@ -55,6 +64,7 @@ class NumberHelperTest < ActionView::TestCase
     assert_equal("100.000%", number_to_percentage("100"))
     assert_equal("1000.000%", number_to_percentage("1000"))
     assert_equal("x%", number_to_percentage("x"))
+    assert_equal("123.4%", number_to_percentage(123.400, :precision => 3, :strip_unsignificant_zeros => true))
     assert_equal("1.000,000%", number_to_percentage(1000, :delimiter => '.', :separator => ','))
     assert_nil number_to_percentage(nil)
   end
@@ -81,6 +91,16 @@ class NumberHelperTest < ActionView::TestCase
     assert_equal '12.345.678,05', number_with_delimiter(12345678.05, :delimiter => '.', :separator => ',')
   end
 
+  def test_number_with_delimiter_old_api
+    silence_deprecation_warnings
+    assert_equal '12 345 678', number_with_delimiter(12345678, " ")
+    assert_equal '12-345-678.05', number_with_delimiter(12345678.05, '-')
+    assert_equal '12.345.678,05', number_with_delimiter(12345678.05, '.', ',')
+    assert_equal '12,345,678.05', number_with_delimiter(12345678.05, ',', '.')
+    assert_equal '12 345 678-05', number_with_delimiter(12345678.05, ',', '.', :delimiter => ' ', :separator => '-')
+    restore_deprecation_warnings
+  end
+
   def test_number_with_precision
     assert_equal("111.235", number_with_precision(111.2346))
     assert_equal("31.83", number_with_precision(31.825, :precision => 2))
@@ -93,6 +113,7 @@ class NumberHelperTest < ActionView::TestCase
     assert_equal("1234567892", number_with_precision(1234567891.50, :precision => 0))
 
     # Return non-numeric params unchanged.
+    assert_equal("x.", number_with_precision("x."))
     assert_equal("x", number_with_precision("x"))
     assert_nil number_with_precision(nil)
   end
@@ -102,48 +123,159 @@ class NumberHelperTest < ActionView::TestCase
     assert_equal '1.231,83',    number_with_precision(1231.825, :precision => 2, :separator => ',', :delimiter => '.')
   end
 
+  def test_number_with_precision_with_significant_digits
+    assert_equal "124000", number_with_precision(123987, :precision => 3, :significant => true)
+    assert_equal "120000000", number_with_precision(123987876, :precision => 2, :significant => true )
+    assert_equal "40000", number_with_precision("43523", :precision => 1, :significant => true )
+    assert_equal "9775", number_with_precision(9775, :precision => 4, :significant => true )
+    assert_equal "5.4", number_with_precision(5.3923, :precision => 2, :significant => true )
+    assert_equal "5", number_with_precision(5.3923, :precision => 1, :significant => true )
+    assert_equal "1", number_with_precision(1.232, :precision => 1, :significant => true )
+    assert_equal "7", number_with_precision(7, :precision => 1, :significant => true )
+    assert_equal "1", number_with_precision(1, :precision => 1, :significant => true )
+    assert_equal "53", number_with_precision(52.7923, :precision => 2, :significant => true )
+    assert_equal "9775.00", number_with_precision(9775, :precision => 6, :significant => true )
+    assert_equal "5.392900", number_with_precision(5.3929, :precision => 7, :significant => true )
+  end
+
+  def test_number_with_precision_with_strip_unsignificant_zeros
+    assert_equal "9775.43", number_with_precision(9775.43, :precision => 4, :strip_unsignificant_zeros => true )
+    assert_equal "9775.2", number_with_precision(9775.2, :precision => 6, :significant => true, :strip_unsignificant_zeros => true )
+  end
+
+  def test_number_with_precision_with_significant_true_and_zero_precision
+    # Zero precision with significant is a mistake (would always return zero),
+    # so we treat it as if significant was false (increases backwards compatibily for number_to_human_size)
+    assert_equal "124", number_with_precision(123.987, :precision => 0, :significant => true)
+    assert_equal "12", number_with_precision(12, :precision => 0, :significant => true )
+    assert_equal "12", number_with_precision("12.3", :precision => 0, :significant => true )
+  end
+
+  def test_number_with_precision_old_api
+    silence_deprecation_warnings
+    assert_equal("31.8250", number_with_precision(31.825, 4))
+    assert_equal("111.235", number_with_precision(111.2346, 3))
+    assert_equal("111.00", number_with_precision(111, 2))
+    assert_equal("111.000", number_with_precision(111, 2, :precision =>3))
+    restore_deprecation_warnings
+  end
+
   def test_number_to_human_size
     assert_equal '0 Bytes',   number_to_human_size(0)
     assert_equal '1 Byte',    number_to_human_size(1)
     assert_equal '3 Bytes',   number_to_human_size(3.14159265)
     assert_equal '123 Bytes', number_to_human_size(123.0)
     assert_equal '123 Bytes', number_to_human_size(123)
-    assert_equal '1.2 KB',    number_to_human_size(1234)
+    assert_equal '1.21 KB',    number_to_human_size(1234)
     assert_equal '12.1 KB',   number_to_human_size(12345)
-    assert_equal '1.2 MB',    number_to_human_size(1234567)
-    assert_equal '1.1 GB',    number_to_human_size(1234567890)
-    assert_equal '1.1 TB',    number_to_human_size(1234567890123)
-    assert_equal '1025 TB',   number_to_human_size(terabytes(1025))
+    assert_equal '1.18 MB',    number_to_human_size(1234567)
+    assert_equal '1.15 GB',    number_to_human_size(1234567890)
+    assert_equal '1.12 TB',    number_to_human_size(1234567890123)
+    assert_equal '1030 TB',   number_to_human_size(terabytes(1026))
     assert_equal '444 KB',    number_to_human_size(kilobytes(444))
-    assert_equal '1023 MB',   number_to_human_size(megabytes(1023))
+    assert_equal '1020 MB',   number_to_human_size(megabytes(1023))
     assert_equal '3 TB',      number_to_human_size(terabytes(3))
-    assert_equal '1.18 MB',   number_to_human_size(1234567, :precision => 2)
+    assert_equal '1.2 MB',   number_to_human_size(1234567, :precision => 2)
     assert_equal '3 Bytes',   number_to_human_size(3.14159265, :precision => 4)
-    assert_equal("123 Bytes", number_to_human_size("123"))
-    assert_equal '1.01 KB',   number_to_human_size(kilobytes(1.0123), :precision => 2)
+    assert_equal '123 Bytes', number_to_human_size('123')
+    assert_equal '1 KB',   number_to_human_size(kilobytes(1.0123), :precision => 2)
     assert_equal '1.01 KB',   number_to_human_size(kilobytes(1.0100), :precision => 4)
     assert_equal '10 KB',   number_to_human_size(kilobytes(10.000), :precision => 4)
     assert_equal '1 Byte',   number_to_human_size(1.1)
     assert_equal '10 Bytes', number_to_human_size(10)
-    #assert_nil number_to_human_size('x') # fails due to API consolidation
+
+    # Return non-numeric params unchanged.
+    assert_equal "x", number_to_human_size('x')
     assert_nil number_to_human_size(nil)
   end
 
   def test_number_to_human_size_with_options_hash
-    assert_equal '1.18 MB',   number_to_human_size(1234567, :precision => 2)
+    assert_equal '1.2 MB',   number_to_human_size(1234567, :precision => 2)
     assert_equal '3 Bytes',   number_to_human_size(3.14159265, :precision => 4)
-    assert_equal '1.01 KB',   number_to_human_size(kilobytes(1.0123), :precision => 2)
+    assert_equal '1 KB',   number_to_human_size(kilobytes(1.0123), :precision => 2)
     assert_equal '1.01 KB',   number_to_human_size(kilobytes(1.0100), :precision => 4)
     assert_equal '10 KB',     number_to_human_size(kilobytes(10.000), :precision => 4)
-    assert_equal '1 TB', number_to_human_size(1234567890123, :precision => 0)
-    assert_equal '500 MB', number_to_human_size(524288000, :precision=>0)
-    assert_equal '40 KB', number_to_human_size(41010, :precision => 0)
-    assert_equal '40 KB', number_to_human_size(41100, :precision => 0)
+    assert_equal '1 TB', number_to_human_size(1234567890123, :precision => 1)
+    assert_equal '500 MB', number_to_human_size(524288000, :precision=>3)
+    assert_equal '40 KB', number_to_human_size(41010, :precision => 1)
+    assert_equal '40 KB', number_to_human_size(41100, :precision => 2)
+    assert_equal '1.0 KB',   number_to_human_size(kilobytes(1.0123), :precision => 2, :strip_unsignificant_zeros => false)
+    assert_equal '1.012 KB',   number_to_human_size(kilobytes(1.0123), :precision => 3, :significant => false)
+    assert_equal '1 KB',   number_to_human_size(kilobytes(1.0123), :precision => 0, :significant => true) #ignores significant it precision is 0
   end
 
   def test_number_to_human_size_with_custom_delimiter_and_separator
-    assert_equal '1,01 KB',     number_to_human_size(kilobytes(1.0123), :precision => 2, :separator => ',')
+    assert_equal '1,01 KB',     number_to_human_size(kilobytes(1.0123), :precision => 3, :separator => ',')
     assert_equal '1,01 KB',     number_to_human_size(kilobytes(1.0100), :precision => 4, :separator => ',')
-    assert_equal '1.000,1 TB',  number_to_human_size(terabytes(1000.1), :delimiter => '.', :separator => ',')
+    assert_equal '1.000,1 TB',  number_to_human_size(terabytes(1000.1), :precision => 5, :delimiter => '.', :separator => ',')
+  end
+
+  def test_number_to_human_size_old_api
+    silence_deprecation_warnings
+    assert_equal '1.3143 KB',   number_to_human_size(kilobytes(1.3143), 4, :significant => false)
+    assert_equal '10.45 KB',   number_to_human_size(kilobytes(10.453), 4)
+    assert_equal '10 KB',   number_to_human_size(kilobytes(10.453), 4, :precision => 2)
+    restore_deprecation_warnings
+  end
+
+  def test_number_to_human
+     assert_equal '123', number_to_human(123)
+     assert_equal '1.23 Thousand', number_to_human(1234)
+     assert_equal '12.3 Thousand', number_to_human(12345)
+     assert_equal '1.23 Million', number_to_human(1234567)
+     assert_equal '1.23 Billion', number_to_human(1234567890)
+     assert_equal '1.23 Trillion', number_to_human(1234567890123)
+     assert_equal '1.23 Quadrillion', number_to_human(1234567890123456)
+     assert_equal '1230 Quadrillion', number_to_human(1234567890123456789)
+     assert_equal '490 Thousand', number_to_human(489939, :precision => 2)
+     assert_equal '489.9 Thousand', number_to_human(489939, :precision => 4)
+     assert_equal '489 Thousand', number_to_human(489000, :precision => 4)
+     assert_equal '489.0 Thousand', number_to_human(489000, :precision => 4, :strip_unsignificant_zeros => false)
+     assert_equal '1.2346 Million', number_to_human(1234567, :precision => 4, :significant => false)
+     assert_equal '1,2 Million', number_to_human(1234567, :precision => 1, :significant => false, :separator => ',')
+     assert_equal '1 Million', number_to_human(1234567, :precision => 0, :significant => true, :separator => ',') #significant forced to false
+
+     # Return non-numeric params unchanged.
+     assert_equal "x", number_to_human('x')
+     assert_nil number_to_human(nil)
+  end
+
+  def test_number_to_human_with_custom_units
+     #Only integers
+     volume = {:unit => "ml", :thousand => "lt", :million => "m3"}
+     assert_equal '123 lt', number_to_human(123456, :units => volume)
+     assert_equal '12 ml', number_to_human(12, :units => volume)
+     assert_equal '1.23 m3', number_to_human(1234567, :units => volume)
+
+     #Including fractionals
+     distance = {:mili => "mm", :centi => "cm", :deci => "dm", :unit => "m", :ten => "dam", :hundred => "hm", :thousand => "km"}
+     assert_equal '1.23 mm', number_to_human(0.00123, :units => distance)
+     assert_equal '1.23 cm', number_to_human(0.0123, :units => distance)
+     assert_equal '1.23 dm', number_to_human(0.123, :units => distance)
+     assert_equal '1.23 m', number_to_human(1.23, :units => distance)
+     assert_equal '1.23 dam', number_to_human(12.3, :units => distance)
+     assert_equal '1.23 hm', number_to_human(123, :units => distance)
+     assert_equal '1.23 km', number_to_human(1230, :units => distance)
+     assert_equal '1.23 km', number_to_human(1230, :units => distance)
+     assert_equal '1.23 km', number_to_human(1230, :units => distance)
+     assert_equal '12.3 km', number_to_human(12300, :units => distance)
+
+     #The quantifiers don't need to be a continuous sequence
+     gangster = {:hundred => "hundred bucks", :million => "thousand quids"}
+     assert_equal '1 hundred bucks', number_to_human(100, :units => gangster)
+     assert_equal '25 hundred bucks', number_to_human(2500, :units => gangster)
+     assert_equal '25 thousand quids', number_to_human(25000000, :units => gangster)
+     assert_equal '12300 thousand quids', number_to_human(12345000000, :units => gangster)
+
+     #Spaces are stripped from the resulting string
+     assert_equal '4', number_to_human(4, :units => {:unit => "", :ten => 'tens '})
+     assert_equal '4.5  tens', number_to_human(45, :units => {:unit => "", :ten => ' tens   '})
   end
+
+  def test_number_to_human_with_custom_format
+    assert_equal '123 times Thousand', number_to_human(123456, :format => "%n times %u")
+    volume = {:unit => "ml", :thousand => "lt", :million => "m3"}
+    assert_equal '123.lt', number_to_human(123456, :units => volume, :format => "%n.%u")
+  end
+
 end