humanize 3.0.0 → 3.1.0

data/lib/humanize/module.rb

@@ -0,0 +1,122 @@
+require 'bigdecimal'
+require_relative 'locales'
+
+module Humanize
+  # Big numbers are big: http://wiki.answers.com/Q/What_number_is_after_vigintillion&src=ansTT
+
+  class << self
+    def format(number,
+               locale: Humanize.config.default_locale,
+               decimals_as: Humanize.config.decimals_as)
+      locale_class, spacer = Humanize.for_locale(locale)
+
+      return locale_class::SUB_ONE_GROUPING[0] if number.zero?
+
+      infinity = number.to_f.infinite?
+      if infinity
+        infinity_word = locale_class::INFINITY
+        return infinity == 1 ? infinity_word : "#{locale_class::NEGATIVE}#{spacer}#{infinity_word}"
+      elsif number.is_a?(Float) && number.nan?
+        return locale_class::UNDEFINED
+      end
+
+      sign = locale_class::NEGATIVE if number.negative?
+
+      parts = locale_class.new.humanize(number.abs)
+      process_decimals(number, locale_class, locale, parts, decimals_as, spacer)
+      Humanize.stringify(parts, sign, spacer)
+    end
+
+    def for_locale(locale)
+      case locale.to_sym
+      # NOTE: add locales here in alphabetical order
+      when :az, :de, :en, :es, :fr, :id, :ms, :pt, :ru, :vi
+        [Object.const_get("Humanize::#{locale.capitalize}"), ' ']
+      when :th
+        [Humanize::Th, '']
+      when :tr
+        [Humanize::Tr, ' ']
+      when :jp
+        [Humanize::Jp, '']
+      when :'zh-tw'
+        [Humanize::ZhTw, '']
+      when :'fr-CH'
+        [Humanize::FrCh, ' ']
+      else
+        raise "Unsupported humanize locale: #{locale}"
+      end
+    end
+
+    def stringify(parts, sign, spacer)
+      output = parts.reverse.join(spacer).squeeze(spacer)
+      if locale_is?(:es) && sign
+        "#{output}#{spacer}#{sign}"
+      elsif sign
+        "#{sign}#{spacer}#{output}"
+      else
+        output
+      end
+    end
+
+    def locale_is?(locale)
+      Humanize.config.default_locale == locale
+    end
+
+    # rubocop:disable Metrics/ParameterLists
+    def process_decimals(number, locale_class, locale, parts, decimals_as, spacer)
+      # rubocop:enable Metrics/ParameterLists
+      return unless number.is_a?(Float) || number.is_a?(BigDecimal)
+
+      # Why 15?
+      # (byebug) BigDecimal.new(number, 15)
+      # 0.8000015e1
+      # (byebug) BigDecimal.new(number, 16)
+      # 0.8000014999999999e1
+      decimal = BigDecimal(number, 15) - BigDecimal(number.to_i)
+
+      _sign, significant_digits, _base, exponent = decimal.split
+      return if significant_digits == "0"
+
+      grouping = locale_class::SUB_ONE_GROUPING
+      leading_zeroes = [grouping[0]] * exponent.abs
+      decimals_as = :digits if leading_zeroes.any?
+
+      decimals_as_words =
+        case decimals_as
+        when :digits
+          digits = significant_digits.chars.map do |num|
+            grouping[num.to_i]
+          end
+
+          (leading_zeroes + digits).join(spacer)
+        when :number
+          Humanize.format(significant_digits.to_i, locale:)
+        end
+
+      parts.insert(0, decimals_as_words, locale_class::POINT)
+    end
+
+    attr_writer :config
+
+    def config
+      @config ||= Configuration.new
+    end
+
+    def reset_config
+      @config = Configuration.new
+    end
+
+    def configure
+      yield(config)
+    end
+  end
+
+  class Configuration
+    attr_accessor :default_locale, :decimals_as
+
+    def initialize
+      @default_locale = :en
+      @decimals_as = :digits
+    end
+  end
+end

data/lib/humanize.rb

@@ -1,129 +1,4 @@
-require 'bigdecimal'
-require_relative 'humanize/locales'
+# frozen_string_literal: true
 
-module Humanize
-  SPACE = ' '.freeze
-  EMPTY = ''.freeze
-  # Big numbers are big: http://wiki.answers.com/Q/What_number_is_after_vigintillion&src=ansTT
-
-  def humanize(locale: Humanize.config.default_locale,
-               decimals_as: Humanize.config.decimals_as)
-    locale_class, spacer = Humanize.for_locale(locale)
-
-    return locale_class::SUB_ONE_GROUPING[0] if zero?
-
-    infinity = to_f.infinite?
-    if infinity
-      infinity_word = locale_class::INFINITY
-      return infinity == 1 ? infinity_word : "#{locale_class::NEGATIVE}#{spacer}#{infinity_word}"
-    elsif is_a?(Float) && nan?
-      return locale_class::UNDEFINED
-    end
-
-    sign = locale_class::NEGATIVE if negative?
-
-    parts = locale_class.new.humanize(abs)
-    process_decimals(locale_class, locale, parts, decimals_as, spacer)
-    Humanize.stringify(parts, sign, spacer)
-  end
-
-  def self.for_locale(locale)
-    case locale.to_sym
-    # NOTE: add locales here in ealphabetical order
-    when :az, :de, :en, :es, :fr, :id, :ms, :pt, :ru, :vi
-      [Object.const_get("Humanize::#{locale.capitalize}"), SPACE]
-    when :th
-      [Humanize::Th, EMPTY]
-    when :tr
-      [Humanize::Tr, SPACE]
-    when :jp
-      [Humanize::Jp, EMPTY]
-    else
-      raise "Unsupported humanize locale: #{locale}"
-    end
-  end
-
-  def self.stringify(parts, sign, spacer)
-    output = parts.reverse.join(spacer).squeeze(spacer)
-    if locale_is?(:es) && sign
-      "#{output}#{spacer}#{sign}"
-    elsif sign
-      "#{sign}#{spacer}#{output}"
-    else
-      output
-    end
-  end
-
-  def self.locale_is?(locale)
-    Humanize.config.default_locale == locale
-  end
-
-  def process_decimals(locale_class, locale, parts, decimals_as, spacer)
-    return unless is_a?(Float) || is_a?(BigDecimal)
-
-    # Why 15?
-    # (byebug) BigDecimal.new(number, 15)
-    # 0.8000015e1
-    # (byebug) BigDecimal.new(number, 16)
-    # 0.8000014999999999e1
-    decimal = BigDecimal(self, 15) - BigDecimal(to_i)
-
-    _sign, significant_digits, _base, exponent = decimal.split
-    return if significant_digits == "0"
-
-    grouping = locale_class::SUB_ONE_GROUPING
-    leading_zeroes = [grouping[0]] * exponent.abs
-    decimals_as = :digits if leading_zeroes.any?
-
-    decimals_as_words =
-      case decimals_as
-      when :digits
-        digits = significant_digits.chars.map do |num|
-          grouping[num.to_i]
-        end
-
-        (leading_zeroes + digits).join(spacer)
-      when :number
-        significant_digits.to_i.humanize(locale:)
-      end
-
-    parts.insert(0, decimals_as_words, locale_class::POINT)
-  end
-
-  class << self
-    attr_writer :config
-  end
-
-  def self.config
-    @config ||= Configuration.new
-  end
-
-  def self.reset_config
-    @config = Configuration.new
-  end
-
-  def self.configure
-    yield(config)
-  end
-
-  class Configuration
-    attr_accessor :default_locale, :decimals_as
-
-    def initialize
-      @default_locale = :en
-      @decimals_as = :digits
-    end
-  end
-end
-
-class Integer
-  include Humanize
-end
-
-class Float
-  include Humanize
-end
-
-class BigDecimal
-  include Humanize
-end
+require "humanize/module" # require just this if you don't need the core_ext extensions to Integer, Float, BigDecimal
+require "humanize/core_ext"

data/spec/core_ext_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+
+RSpec.describe "Humanize core extensions to Ruby" do
+  after do
+    Humanize.reset_config
+  end
+
+  describe 'both options work together' do
+    it 'work together' do
+      expect(
+        0.42.humanize(locale: :fr, decimals_as: :number)
+      ).to eql('zéro virgule quarante-deux')
+    end
+  end
+
+  describe 'when called on instances of Rational, Complex, and Date::Infinity' do
+    it 'will raise NoMethodError' do
+      expect { Rational(1, 3).humanize }.to raise_error(NoMethodError, /humanize/)
+      expect { Complex(1 + 2i).humanize }.to raise_error(NoMethodError, /humanize/)
+      if defined? Date::Infinity
+        expect do
+          Date::Infinity.new.humanize
+        end.to raise_error(NoMethodError, /humanize/)
+      end
+    end
+  end
+
+  describe 'when called on conceptual number' do
+    it 'reads correctly' do
+      inf = Float::INFINITY
+      neg_inf = -inf
+      nan = inf + neg_inf
+
+      expect(inf.humanize).to eql('infinity')
+      expect(neg_inf.humanize).to eql('negative infinity')
+      expect(nan.humanize).to eql('undefined')
+    end
+  end
+
+  describe 'when called on bigdecimal with decimal fractions' do
+    it 'reads the decimal digits' do
+      expect(BigDecimal('123').humanize).to eql('one hundred and twenty-three')
+      expect(BigDecimal('123.45').humanize).to eql('one hundred and twenty-three point four five')
+    end
+  end
+end

data/spec/humanize_spec.rb

@@ -8,25 +8,25 @@ RSpec.describe "Humanize" do
   describe 'locale option' do
     it 'uses default locale' do
       Humanize.config.default_locale = :fr
-      expect(42.humanize).to eql('quarante-deux')
+      expect(Humanize.format(42)).to eql('quarante-deux')
     end
 
     it 'uses locale passed as argument if given' do
       Humanize.config.default_locale = :en
-      expect(42.humanize(locale: :fr)).to eql('quarante-deux')
+      expect(Humanize.format(42, locale: :fr)).to eql('quarante-deux')
     end
 
     describe 'turkish specific rules' do
       it 'one thousand and two equals "bin iki"' do
-        expect(1002.humanize(locale: :tr)).to eql('bin iki')
+        expect(Humanize.format(1002, locale: :tr)).to eql('bin iki')
       end
 
       it 'two thousand and one equals "iki bin bir' do
-        expect(2001.humanize(locale: :tr)).to eql('iki bin bir')
+        expect(Humanize.format(2001, locale: :tr)).to eql('iki bin bir')
       end
 
       it 'ten thousand equals "on bin"' do
-        expect(10_000.humanize(locale: :tr)).to eql('on bin')
+        expect(Humanize.format(10_000, locale: :tr)).to eql('on bin')
       end
     end
 
@@ -37,30 +37,30 @@ RSpec.describe "Humanize" do
 
       context 'one thousand' do
         it 'equals "satu ribu" when it is not the only thousand in its thousands range' do
-          expect(1_101_000.humanize).to eql('satu juta seratus satu ribu')
-          expect(2_201_042.humanize).to eql('dua juta dua ratus satu ribu empat puluh dua')
+          expect(Humanize.format(1_101_000)).to eql('satu juta seratus satu ribu')
+          expect(Humanize.format(2_201_042)).to eql('dua juta dua ratus satu ribu empat puluh dua')
         end
 
         it 'equals "seribu" when it is the lone thousand in its thousands range' do
-          expect(1_000.humanize).to eql('seribu')
-          expect(1_042.humanize).to eql('seribu empat puluh dua')
-          expect(1_001_042.humanize).to eql('satu juta seribu empat puluh dua')
-          expect(1_000_001_042.humanize).to eql('satu bilion seribu empat puluh dua')
+          expect(Humanize.format(1_000)).to eql('seribu')
+          expect(Humanize.format(1_042)).to eql('seribu empat puluh dua')
+          expect(Humanize.format(1_001_042)).to eql('satu juta seribu empat puluh dua')
+          expect(Humanize.format(1_000_001_042)).to eql('satu bilion seribu empat puluh dua')
         end
       end
     end
 
     describe 'azerbaijani specific rules' do
       it 'one thousand and two equals "min iki"' do
-        expect(1002.humanize(locale: :az)).to eql('min iki')
+        expect(Humanize.format(1002, locale: :az)).to eql('min iki')
       end
 
       it 'two thousand and one equals "iki min bir' do
-        expect(2001.humanize(locale: :az)).to eql('iki min bir')
+        expect(Humanize.format(2001, locale: :az)).to eql('iki min bir')
       end
 
       it 'ten thousand equals "on min"' do
-        expect(10_000.humanize(locale: :az)).to eql('on min')
+        expect(Humanize.format(10_000, locale: :az)).to eql('on min')
       end
     end
 
@@ -71,15 +71,15 @@ RSpec.describe "Humanize" do
 
       context 'one thousand' do
         it 'equals "satu ribu" when it is not the only thousand in its thousands range' do
-          expect(1_101_000.humanize).to eql('satu juta seratus satu ribu')
-          expect(2_201_042.humanize).to eql('dua juta dua ratus satu ribu empat puluh dua')
+          expect(Humanize.format(1_101_000)).to eql('satu juta seratus satu ribu')
+          expect(Humanize.format(2_201_042)).to eql('dua juta dua ratus satu ribu empat puluh dua')
         end
 
         it 'equals "seribu" when it is the lone thousand in its thousands range' do
-          expect(1_000.humanize).to eql('seribu')
-          expect(1_042.humanize).to eql('seribu empat puluh dua')
-          expect(1_001_042.humanize).to eql('satu juta seribu empat puluh dua')
-          expect(1_000_001_042.humanize).to eql('satu miliar seribu empat puluh dua')
+          expect(Humanize.format(1_000)).to eql('seribu')
+          expect(Humanize.format(1_042)).to eql('seribu empat puluh dua')
+          expect(Humanize.format(1_001_042)).to eql('satu juta seribu empat puluh dua')
+          expect(Humanize.format(1_000_001_042)).to eql('satu miliar seribu empat puluh dua')
         end
       end
     end
@@ -88,12 +88,12 @@ RSpec.describe "Humanize" do
   describe 'decimals_as option' do
     it 'uses value from configuration' do
       Humanize.config.decimals_as = :number
-      expect(0.42.humanize).to eql('zero point forty-two')
+      expect(Humanize.format(0.42)).to eql('zero point forty-two')
     end
 
     it 'uses value passed as argument if given' do
       Humanize.config.decimals_as = :number
-      expect(0.42.humanize(decimals_as: :digits)).to eql('zero point four two')
+      expect(Humanize.format(0.42, decimals_as: :digits)).to eql('zero point four two')
     end
 
     describe 'when set as number' do
@@ -102,8 +102,8 @@ RSpec.describe "Humanize" do
       end
 
       it 'reads the decimals as digits if led by zero(s)' do
-        expect(0.042.humanize).to eql('zero point zero four two')
-        expect(0.0042.humanize).to eql('zero point zero zero four two')
+        expect(Humanize.format(0.042)).to eql('zero point zero four two')
+        expect(Humanize.format(0.0042)).to eql('zero point zero zero four two')
       end
     end
   end
@@ -111,39 +111,27 @@ RSpec.describe "Humanize" do
   describe 'both options work together' do
     it 'work together' do
       expect(
-        0.42.humanize(locale: :fr, decimals_as: :number)
+        Humanize.format(0.42, locale: :fr, decimals_as: :number)
       ).to eql('zéro virgule quarante-deux')
     end
   end
 
-  describe 'when called on instances of Rational, Complex, and Date::Infinity' do
-    it 'will raise NoMethodError' do
-      expect { Rational(1, 3).humanize }.to raise_error(NoMethodError, /humanize/)
-      expect { Complex(1 + 2i).humanize }.to raise_error(NoMethodError, /humanize/)
-      if defined? Date::Infinity
-        expect do
-          Date::Infinity.new.humanize
-        end.to raise_error(NoMethodError, /humanize/)
-      end
-    end
-  end
-
   describe 'when called on conceptual number' do
     it 'reads correctly' do
       inf = Float::INFINITY
       neg_inf = -inf
       nan = inf + neg_inf
 
-      expect(inf.humanize).to eql('infinity')
-      expect(neg_inf.humanize).to eql('negative infinity')
-      expect(nan.humanize).to eql('undefined')
+      expect(Humanize.format(inf)).to eql('infinity')
+      expect(Humanize.format(neg_inf)).to eql('negative infinity')
+      expect(Humanize.format(nan)).to eql('undefined')
     end
   end
 
   describe 'when called on bigdecimal with decimal fractions' do
     it 'reads the decimal digits' do
-      expect(BigDecimal('123').humanize).to eql('one hundred and twenty-three')
-      expect(BigDecimal('123.45').humanize).to eql('one hundred and twenty-three point four five')
+      expect(Humanize.format(BigDecimal('123'))).to eql('one hundred and twenty-three')
+      expect(Humanize.format(BigDecimal('123.45'))).to eql('one hundred and twenty-three point four five')
     end
   end
 end

data/spec/locales/fr_ch_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+
+RSpec.describe Humanize, "fr CH locale" do
+  before do
+    Humanize.configure do |config|
+      config.default_locale = :'fr-CH'
+    end
+  end
+
+  tests = [
+    [71, 'septante-et-un'],
+    [80.15, 'huitante virgule un cinq'],
+    [1090, 'mille nonante'],
+    [2095, 'deux mille nonante-cinq'],
+    [10_000, 'dix mille'],
+    [1_000_000, "un million"],
+    [2_000_000, "deux millions"],
+    [5_000_000, "cinq millions"],
+    [1_000_000_000, "un milliard"],
+    [2_000_000_000, "deux milliards"],
+    [5_000_000_000, "cinq milliards"]
+  ]
+
+  tests.each do |num, output|
+    it "#{num} equals #{output}" do
+      expect(num.humanize).to eql(output)
+    end
+  end
+
+  context 'decimals: number' do
+    it 'returns the decimals as whole numbers' do
+      num = 8.15
+      expect(num.humanize(decimals_as: :number)).to eq('huit virgule quinze')
+    end
+  end
+
+  describe 'when called on conceptual number' do
+    it 'reads correctly' do
+      inf = Float::INFINITY
+      neg_inf = -inf
+      nan = inf + neg_inf
+
+      expect(inf.humanize).to eql('infini')
+      expect(neg_inf.humanize).to eql('négatif infini')
+      expect(nan.humanize).to eql('indéfini')
+    end
+  end
+end

data/spec/locales/zh_tw_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+
+RSpec.describe Humanize, 'zh tw locale' do
+  before do
+    Humanize.configure do |config|
+      config.default_locale = :'zh-tw'
+    end
+  end
+
+  tests = [
+    [1, '壹'],
+    [48, '肆拾捌'],
+    [100, '佰'],
+    [101, '佰壹'],
+    [110, '佰拾'],
+    [199, '佰玖拾玖'],
+    [999, '玖佰玖拾玖'],
+    [1000, '壹仟'],
+    [3456, '参仟肆佰伍拾陸'],
+    [9999, '玖仟玖佰玖拾玖'],
+    [21_111, '貳萬壹仟佰拾壹'],
+    [99_999, '玖萬玖仟玖佰玖拾玖'],
+    [9_876_543, '玖佰捌拾柒萬陸仟伍佰肆拾参'],
+    [10_000_000, '壹仟萬'],
+    [100_000_000, '壹億'],
+    [765_432_109, '柒億陸仟伍佰肆拾参萬貳仟佰玖'],
+    [-123_422_223.48_948_753, '負壹億貳仟参佰肆拾貳萬貳仟貳佰貳拾参・肆捌玖肆捌捌']
+  ]
+
+  tests.each do |num, output|
+    it "#{num} equals #{output}" do
+      expect(num.humanize).to eql(output)
+    end
+  end
+
+  context 'decimals: number' do
+    it 'returns the decimals as whole numbers' do
+      num = 8.1592
+      expect(num.humanize).to eq('捌・壹伍玖貳')
+      expect(num.humanize(decimals_as: :number)).to eq('捌・壹仟伍佰玖拾貳')
+    end
+  end
+
+  describe 'when called on conceptual number' do
+    it 'reads correctly' do
+      inf = Float::INFINITY
+      neg_inf = -inf
+      nan = inf + neg_inf
+
+      expect(inf.humanize).to eql('無限大')
+      expect(neg_inf.humanize).to eql('負無限大')
+      expect(nan.humanize).to eql('未定義')
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: humanize
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.1.0
 platform: ruby
 authors:
 - Jack Chen
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-03-29 00:00:00.000000000 Z
+date: 2024-05-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mutant
@@ -99,6 +99,7 @@ files:
 - bin/run_mutant
 - humanize.gemspec
 - lib/humanize.rb
+- lib/humanize/core_ext.rb
 - lib/humanize/locales.rb
 - lib/humanize/locales/az.rb
 - lib/humanize/locales/constants/az.rb
@@ -106,6 +107,7 @@ files:
 - lib/humanize/locales/constants/en.rb
 - lib/humanize/locales/constants/es.rb
 - lib/humanize/locales/constants/fr.rb
+- lib/humanize/locales/constants/fr_ch.rb
 - lib/humanize/locales/constants/id.rb
 - lib/humanize/locales/constants/jp.rb
 - lib/humanize/locales/constants/ms.rb
@@ -114,10 +116,12 @@ files:
 - lib/humanize/locales/constants/th.rb
 - lib/humanize/locales/constants/tr.rb
 - lib/humanize/locales/constants/vi.rb
+- lib/humanize/locales/constants/zh_tw.rb
 - lib/humanize/locales/de.rb
 - lib/humanize/locales/en.rb
 - lib/humanize/locales/es.rb
 - lib/humanize/locales/fr.rb
+- lib/humanize/locales/fr_ch.rb
 - lib/humanize/locales/id.rb
 - lib/humanize/locales/jp.rb
 - lib/humanize/locales/ms.rb
@@ -126,12 +130,16 @@ files:
 - lib/humanize/locales/th.rb
 - lib/humanize/locales/tr.rb
 - lib/humanize/locales/vi.rb
+- lib/humanize/locales/zh_tw.rb
+- lib/humanize/module.rb
 - spec/configuration_spec.rb
+- spec/core_ext_spec.rb
 - spec/humanize_spec.rb
 - spec/locales/az_spec.rb
 - spec/locales/de_spec.rb
 - spec/locales/en_spec.rb
 - spec/locales/es_spec.rb
+- spec/locales/fr_ch_spec.rb
 - spec/locales/fr_spec.rb
 - spec/locales/id_spec.rb
 - spec/locales/jp_spec.rb
@@ -141,6 +149,7 @@ files:
 - spec/locales/th_spec.rb
 - spec/locales/tr_spec.rb
 - spec/locales/vi_spec.rb
+- spec/locales/zh_tw_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/radar/humanize
 licenses: []