humanize_fraction 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 71e2420b7a27230601ab8ae89e38f3097908f13f
-  data.tar.gz: 80455bea8b7ae37f41a686570ced33c3ffa78914
+  metadata.gz: 48b87152720622914c2118dd643e7ae53757892a
+  data.tar.gz: f4a156d8e3f0c5274544d7dc6c84b9f96c6aa22b
 SHA512:
-  metadata.gz: 47ecefd1c758ef9de3c81505d16f6312ff3d339f42929feb7c5f4a992c4056ff430d05c30f599b7b85bc784a9bab666fd75250306ee77d624f75c71b119bf942
-  data.tar.gz: 8a3d6b9e0fd2337dadbf331ad8d17f386d46adc450ca0c4bee112810e458b2acc497fce5cbc300dc47a2b7d4fe50cce8166979283b065bcf218a073aab5ae9da
+  metadata.gz: 0bec3257ee12d4158d8b61de48500614486f6685224299e21101701fbad654c165a9beee9b465ad87c835c3994a238b325a4f510c7ea90b7b4571b4f8962a3a5
+  data.tar.gz: 25155b9bd6c6c63df47e2cd205c1e126e40464a0c082c00c909b81df270fc1b9caa80bc44d2ad846b32136fe5d0bbd7d115b389901ad45881b2b3300e48301ff

data/README.md

@@ -7,10 +7,10 @@ Rubygem to convert fraction to words, like 1 ⅓ => one and a third. Examples:
 #=> "one eighth"
 "1/8".humanize_fraction(shorthand: true)
 #=> "an eighth"
-"2 3/4".humanize_fraction
-#=> "two and three fourths"
-"2 3/4".humanize_fraction(quarter: true)
-#=> "two and three quarters"
+"-2 3/4".humanize_fraction
+#=> "negative two and three fourths"
+"-2 3/4".humanize_fraction(quarter: true)
+#=> "negative two and three quarters"
 "1/1000000".humanize_fraction(shorthand: true)
 #=> "a millionth"
 "222/333".humanize_fraction

data/humanize_fraction.gemspec

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

data/lib/humanize_fraction.rb

@@ -2,8 +2,10 @@ require "active_support/inflector"
 require "humanize"
 # TODO: figure out how to use this library without the monkey patching it does.
 require "numbers_and_words"
+require "sig"
 
 require "humanize_fraction/humanizer"
+require "humanize_fraction/fraction_string_parser"
 require "humanize_fraction/version"
 require "core_extensions/string/humanize_fraction"
 

data/lib/humanize_fraction/fraction_string_parser.rb

@@ -0,0 +1,57 @@
+# This class takes a fraction string (e.g. "1 3/4") and parses it into the
+# individual fraction components of whole_part, numerator, and denominator.
+module HumanizeFraction
+  class FractionStringParser
+    # From: https://github.com/thechrisoshow/fractional/blob/master/lib/fractional.rb
+    SINGLE_FRACTION = /\A\s*(\-?\d+)\s*\/\s*(\-?\d+)\s*\z/
+    MIXED_FRACTION = /\A\s*(\-?\d*)\s+(\d+)\s*\/\s*(\d+)\s*\z/
+
+    attr_reader :string
+    sig String,
+    def initialize(string)
+      @string = string
+    end
+
+    def fraction_components
+      @fraction_components ||= begin
+        if string_is_mixed_fraction?
+          mixed_fraction_components
+        elsif string_is_single_fraction?
+          single_fraction_components
+        else
+          raise ArgumentError, "Unable to extract fraction from string #{string}"
+        end
+      end
+    end
+
+    private
+
+    def mixed_fraction_components
+      whole_part, numerator, denominator = string.scan(MIXED_FRACTION).flatten.map(&:to_i)
+      components = {whole_part: whole_part, numerator: numerator, denominator: denominator}
+      validate_fraction_components(components)
+      components
+    end
+
+    def single_fraction_components
+      numerator, denominator = string.split("/").map(&:to_i)
+      components = {whole_part: nil, numerator: numerator, denominator: denominator}
+      validate_fraction_components(components)
+      components
+    end
+
+    def string_is_mixed_fraction?
+      string.match(MIXED_FRACTION)
+    end
+
+    def string_is_single_fraction?
+      string.match(SINGLE_FRACTION)
+    end
+
+    def validate_fraction_components(components)
+      if components[:denominator].zero?
+        raise ArgumentError, "Unable to parse fraction with zero denominator"
+      end
+    end
+  end
+end

data/lib/humanize_fraction/humanizer.rb

@@ -1,9 +1,5 @@
 module HumanizeFraction
   class Humanizer
-    # From: https://github.com/thechrisoshow/fractional/blob/master/lib/fractional.rb
-    SINGLE_FRACTION = /\A\s*(\-?\d+)\/(\-?\d+)\s*\z/
-    MIXED_FRACTION = /\A\s*(\-?\d*)\s+(\d+)\/(\d+)\s*\z/
-
     # Numbers that should be prefixed with `a` instead of `an` even though they
     # start with a vowel.
     NUMBERS_STARTING_WITH_SILENT_VOWEL = [
@@ -12,15 +8,8 @@ module HumanizeFraction
 
     attr_reader :numerator, :denominator, :whole_part
 
+    sig [{numerator: Integer, denominator: Integer, whole_part: [NilClass, Integer]}],
     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 !whole_part.nil? && !whole_part.is_a?(Integer)
-        raise ArgumentError, "Expected Integer or NilClass for whole_part but got #{whole_part.class.name}"
-      end
       @whole_part = whole_part
       @numerator = numerator
       @denominator = denominator
@@ -35,19 +24,10 @@ module HumanizeFraction
       words.join(" ")
     end
 
+    sig_self [String, Hash],
     def self.from_string(string, options = {})
-      if !string.is_a?(String)
-        raise ArgumentError, "Expected String but got #{string.class.name}"
-      end
-      if string_is_mixed_fraction?(string)
-        whole, numerator, denominator = string.scan(MIXED_FRACTION).flatten.map(&:to_i)
-        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)
-      else
-        raise ArgumentError, "Unable to extract fraction from string #{string}"
-      end
+      parser = FractionStringParser.new(string)
+      new(**parser.fraction_components, **options)
     end
 
     private
@@ -100,13 +80,5 @@ module HumanizeFraction
         "a"
       end
     end
-
-    def self.string_is_mixed_fraction?(value)
-      value&.match(MIXED_FRACTION)
-    end
-
-    def self.string_is_single_fraction?(value)
-      value&.match(SINGLE_FRACTION)
-    end
   end
 end

data/lib/humanize_fraction/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: humanize_fraction
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Peter Graham
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: sig
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -126,6 +140,7 @@ files:
 - humanize_fraction.gemspec
 - lib/core_extensions/string/humanize_fraction.rb
 - lib/humanize_fraction.rb
+- lib/humanize_fraction/fraction_string_parser.rb
 - lib/humanize_fraction/humanizer.rb
 - lib/humanize_fraction/version.rb
 homepage: https://github.com/6/humanize_fraction