humanize_fraction 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e0beddb356fa1d63e5658dd2e25fb4916414fbd0
-  data.tar.gz: 520506910e547967f3f5f485c51c8d8bb75fe6eb
+  metadata.gz: 71e2420b7a27230601ab8ae89e38f3097908f13f
+  data.tar.gz: 80455bea8b7ae37f41a686570ced33c3ffa78914
 SHA512:
-  metadata.gz: 07e78cdf965891de22a42f8b92b41e366ac6f18dd58dccadd8783b8ec46b9b2114a1d1cb9fd68429c526d711eebd74f58232ba45ab2f8cbde533c4cc48c79198
-  data.tar.gz: 8b4c46ebc18c7ae1f57c26a748c7599769fb82c05336c8bd553667cd6d4c16a8a5dd236fa8aac23a021ead71d4f1a790c58fc7ac773e4cce4de9f7979f58cda9
+  metadata.gz: 47ecefd1c758ef9de3c81505d16f6312ff3d339f42929feb7c5f4a992c4056ff430d05c30f599b7b85bc784a9bab666fd75250306ee77d624f75c71b119bf942
+  data.tar.gz: 8a3d6b9e0fd2337dadbf331ad8d17f386d46adc450ca0c4bee112810e458b2acc497fce5cbc300dc47a2b7d4fe50cce8166979283b065bcf218a073aab5ae9da

data/README.md

@@ -1,4 +1,4 @@
-# humanize_fraction [![CircleCI](https://circleci.com/gh/6/humanize_fraction.svg?style=svg)](https://circleci.com/gh/6/humanize_fraction)
+# humanize_fraction [![CircleCI](https://circleci.com/gh/6/humanize_fraction.svg?style=svg)](https://circleci.com/gh/6/humanize_fraction) [![Gem Version](https://badge.fury.io/rb/humanize_fraction.svg)](https://rubygems.org/gems/humanize_fraction)
 
 Rubygem to convert fraction to words, like 1 ⅓ => one and a third. Examples:
 
@@ -15,6 +15,28 @@ Rubygem to convert fraction to words, like 1 ⅓ => one and a third. Examples:
 #=> "a millionth"
 "222/333".humanize_fraction
 #=> "two hundred and twenty-two three hundred thirty-thirds"
+"1/1000000000000000000000000000".humanize_fraction(shorthand: true)
+#=> "an octillionth"
+```
+
+If you don't want to monkey patch `String`, you can also use the Humanizer class directly:
+
+```ruby
+# From a string:
+fraction = HumanizeFraction::Humanizer.from_string("2 1/4")
+
+# From integers:
+fraction = HumanizeFraction::Humanizer.new(
+  whole_part: 2,
+  numerator: 1,
+  denominator: 4,
+)
+
+fraction.to_s
+# => "two and one fourth"
+
+fraction.to_s(shorthand: true, quarter: true)
+# => "two and a quarter"
 ```
 
 ## Installation

data/humanize_fraction.gemspec

@@ -24,7 +24,7 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency "activesupport", ">= 4"
   spec.add_runtime_dependency "humanize", "~> 1.4"
-  spec.add_runtime_dependency "twitter_cldr", "~> 4.4"
+  spec.add_runtime_dependency "numbers_and_words", "~> 0.11"
 
   spec.add_development_dependency "bundler", "~> 1.14"
   spec.add_development_dependency "rake", "~> 10.0"

data/lib/core_extensions/string/humanize_fraction.rb

@@ -2,7 +2,7 @@ module CoreExtensions
   module String
     module HumanizeFraction
       def humanize_fraction(options = {})
-        ::HumanizeFraction::Humanizer.from_string(self, options).to_s
+        ::HumanizeFraction::Humanizer.from_string(self).to_s(options)
       end
     end
   end

data/lib/humanize_fraction/humanizer.rb

@@ -1,34 +1,37 @@
 module HumanizeFraction
   class Humanizer
     # From: https://github.com/thechrisoshow/fractional/blob/master/lib/fractional.rb
-    SINGLE_FRACTION = /^\s*(\-?\d+)\/(\-?\d+)\s*$/
-    MIXED_FRACTION = /^\s*(\-?\d*)\s+(\d+)\/(\d+)\s*$/
+    SINGLE_FRACTION = /\A\s*(\-?\d+)\/(\-?\d+)\s*\z/
+    MIXED_FRACTION = /\A\s*(\-?\d*)\s+(\d+)\/(\d+)\s*\z/
 
-    attr_reader :numerator, :denominator, :integer_part, :quarter, :shorthand
+    # Numbers that should be prefixed with `a` instead of `an` even though they
+    # start with a vowel.
+    NUMBERS_STARTING_WITH_SILENT_VOWEL = [
+      "one",
+    ]
 
-    def initialize(numerator:, denominator:, integer_part: nil, shorthand: false, quarter: false)
+    attr_reader :numerator, :denominator, :whole_part
+
+    def initialize(numerator:, denominator:, whole_part: nil)
       [numerator, denominator].each do |number|
         if !number.is_a?(Integer)
           raise ArgumentError, "Expected Integers for numerator/denominator but got #{number.class.name}"
         end
       end
-      if !integer_part.nil? && !integer_part.is_a?(Integer)
-        raise ArgumentError, "Expected Integer or NilClass for integer_part but got #{integer_part.class.name}"
+      if !whole_part.nil? && !whole_part.is_a?(Integer)
+        raise ArgumentError, "Expected Integer or NilClass for whole_part but got #{whole_part.class.name}"
       end
-      @integer_part = integer_part
+      @whole_part = whole_part
       @numerator = numerator
       @denominator = denominator
-      @shorthand = shorthand
-      @quarter = quarter
     end
-    alias_method :quarter?, :quarter
-    alias_method :shorthand?, :shorthand
 
-    def to_s
+    def to_s(shorthand: false, quarter: false)
+      humanized_denominator = humanize_denominator(shorthand: shorthand, quarter: quarter)
       words = []
-      words << humanize_integer_part if !integer_part.nil?
-      words << humanize_numerator
-      words << humanize_denominator
+      words << humanize_whole_part if !whole_part.nil?
+      words << humanize_numerator(humanized_denominator, shorthand: shorthand)
+      words << humanized_denominator
       words.join(" ")
     end
 
@@ -38,7 +41,7 @@ module HumanizeFraction
       end
       if string_is_mixed_fraction?(string)
         whole, numerator, denominator = string.scan(MIXED_FRACTION).flatten.map(&:to_i)
-        new(integer_part: whole, numerator: numerator, denominator: denominator, **options)
+        new(whole_part: whole, numerator: numerator, denominator: denominator, **options)
       elsif string_is_single_fraction?(string)
         numerator, denominator = string.split("/").map(&:to_i)
         new(numerator: numerator, denominator: denominator, **options)
@@ -49,32 +52,31 @@ module HumanizeFraction
 
     private
 
-    def humanize_integer_part
-      "#{integer_part.humanize} and"
+    def humanize_whole_part
+      "#{whole_part.humanize} and"
     end
 
-    def humanize_numerator
-      number = if numerator == 1 && shorthand?
-        # 8 is the only(?) case where you want to prefix with `an` instead of `a`.
-        first_digit(denominator) == 8 ? "an" : "a"
+    def humanize_numerator(humanized_denominator, shorthand:)
+      number = if numerator == 1 && shorthand
+        first_number = humanized_denominator.split(" ").first
+        indefinite_article(first_number)
       else
         numerator.humanize
       end
       number
     end
 
-    def humanize_denominator
+    def humanize_denominator(shorthand:, quarter:)
       number = case denominator
       when 2
         "half"
       when 4
-        quarter? ? "quarter" : "fourth"
+        quarter ? "quarter" : "fourth"
       else
-        denominator.localize(:en).to_rbnf_s("SpelloutRules", "spellout-ordinal")
+        I18n.with_locale(:en) { denominator.to_words(ordinal: true) }
       end
       # Handle case of `a millionth`, `a thousandth`, etc.
-      if shorthand? && denominator >= 100 &&
-        first_digit(denominator) == 1 && remaining_digits_zeros?(denominator)
+      if shorthand && denominator >= 100 && one_followed_by_zeros?(denominator)
         number.sub!(/\Aone\s/, "")
       end
       if numerator != 1
@@ -83,15 +85,20 @@ module HumanizeFraction
       number
     end
 
-    def first_digit(number)
-      number.to_s.split("").first.to_i
+    # Checks number is a 1 followed by only zeros, e.g. 10 or 10000000
+    def one_followed_by_zeros?(number)
+      digits = number.to_s.split("")
+      first_digit = digits.shift
+      first_digit.to_i == 1 && digits.size > 0 && digits.map(&:to_i).all?(&:zero?)
     end
 
-    # Checks if everything after first digit are zeros.
-    def remaining_digits_zeros?(number)
-      numbers = number.to_s.split("")
-      numbers.shift
-      numbers.size > 0 && numbers.map(&:to_i).all?(&:zero?)
+    def indefinite_article(humanized_number)
+      if humanized_number.match(/\A[aeiou]/) &&
+        !NUMBERS_STARTING_WITH_SILENT_VOWEL.include?(humanized_number)
+        "an"
+      else
+        "a"
+      end
     end
 
     def self.string_is_mixed_fraction?(value)

data/lib/humanize_fraction/version.rb

@@ -1,3 +1,3 @@
 module HumanizeFraction
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/humanize_fraction.rb

@@ -1,6 +1,7 @@
 require "active_support/inflector"
 require "humanize"
-require "twitter_cldr"
+# TODO: figure out how to use this library without the monkey patching it does.
+require "numbers_and_words"
 
 require "humanize_fraction/humanizer"
 require "humanize_fraction/version"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: humanize_fraction
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Peter Graham
@@ -39,19 +39,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.4'
 - !ruby/object:Gem::Dependency
-  name: twitter_cldr
+  name: numbers_and_words
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.4'
+        version: '0.11'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.4'
+        version: '0.11'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement