humanize_fraction 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e0beddb356fa1d63e5658dd2e25fb4916414fbd0
+  data.tar.gz: 520506910e547967f3f5f485c51c8d8bb75fe6eb
+SHA512:
+  metadata.gz: 07e78cdf965891de22a42f8b92b41e366ac6f18dd58dccadd8783b8ec46b9b2114a1d1cb9fd68429c526d711eebd74f58232ba45ab2f8cbde533c4cc48c79198
+  data.tar.gz: 8b4c46ebc18c7ae1f57c26a748c7599769fb82c05336c8bd553667cd6d4c16a8a5dd236fa8aac23a021ead71d4f1a790c58fc7ac773e4cce4de9f7979f58cda9

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+*.gem

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in humanize_fraction.gemspec
+gemspec

data/README.md

@@ -0,0 +1,37 @@
+# humanize_fraction [![CircleCI](https://circleci.com/gh/6/humanize_fraction.svg?style=svg)](https://circleci.com/gh/6/humanize_fraction)
+
+Rubygem to convert fraction to words, like 1 ⅓ => one and a third. Examples:
+
+```ruby
+"1/8".humanize_fraction
+#=> "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"
+"1/1000000".humanize_fraction(shorthand: true)
+#=> "a millionth"
+"222/333".humanize_fraction
+#=> "two hundred and twenty-two three hundred thirty-thirds"
+```
+
+## Installation
+
+Add this line to your application's Gemfile and execute `bundle` to install:
+
+```ruby
+gem 'humanize_fraction'
+```
+
+If you wish to use the monkey-patched `String#humanize_fraction`, add the following into an initializer/config:
+
+```ruby
+require 'humanize_fraction'
+String.include(CoreExtensions::String::HumanizeFraction)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "humanize_fraction"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/circle.yml

@@ -0,0 +1,3 @@
+machine:
+  ruby:
+    version: 2.3.0

data/humanize_fraction.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "humanize_fraction/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "humanize_fraction"
+  spec.version       = HumanizeFraction::VERSION
+  spec.authors       = ["Peter Graham"]
+  spec.email         = ["peterghm@gmail.com"]
+
+  spec.summary       = %q{Convert fractions to words, 3/5 => three fifths.}
+  spec.description   = %q{Convert fractions to words, such as 3/5 to three fifths.}
+  spec.homepage      = "https://github.com/6/humanize_fraction"
+  spec.license       = "MIT"
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  spec.license       = "MIT"
+  spec.required_ruby_version = ">= 2.3.0"
+
+  spec.add_runtime_dependency "activesupport", ">= 4"
+  spec.add_runtime_dependency "humanize", "~> 1.4"
+  spec.add_runtime_dependency "twitter_cldr", "~> 4.4"
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rspec-its", "~> 1.2"
+end

data/lib/core_extensions/string/humanize_fraction.rb

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

data/lib/humanize_fraction/humanizer.rb

@@ -0,0 +1,105 @@
+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*$/
+
+    attr_reader :numerator, :denominator, :integer_part, :quarter, :shorthand
+
+    def initialize(numerator:, denominator:, integer_part: nil, shorthand: false, quarter: false)
+      [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}"
+      end
+      @integer_part = integer_part
+      @numerator = numerator
+      @denominator = denominator
+      @shorthand = shorthand
+      @quarter = quarter
+    end
+    alias_method :quarter?, :quarter
+    alias_method :shorthand?, :shorthand
+
+    def to_s
+      words = []
+      words << humanize_integer_part if !integer_part.nil?
+      words << humanize_numerator
+      words << humanize_denominator
+      words.join(" ")
+    end
+
+    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(integer_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
+    end
+
+    private
+
+    def humanize_integer_part
+      "#{integer_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"
+      else
+        numerator.humanize
+      end
+      number
+    end
+
+    def humanize_denominator
+      number = case denominator
+      when 2
+        "half"
+      when 4
+        quarter? ? "quarter" : "fourth"
+      else
+        denominator.localize(:en).to_rbnf_s("SpelloutRules", "spellout-ordinal")
+      end
+      # Handle case of `a millionth`, `a thousandth`, etc.
+      if shorthand? && denominator >= 100 &&
+        first_digit(denominator) == 1 && remaining_digits_zeros?(denominator)
+        number.sub!(/\Aone\s/, "")
+      end
+      if numerator != 1
+        number = ActiveSupport::Inflector.pluralize(number)
+      end
+      number
+    end
+
+    def first_digit(number)
+      number.to_s.split("").first.to_i
+    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?)
+    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

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

data/lib/humanize_fraction.rb

@@ -0,0 +1,10 @@
+require "active_support/inflector"
+require "humanize"
+require "twitter_cldr"
+
+require "humanize_fraction/humanizer"
+require "humanize_fraction/version"
+require "core_extensions/string/humanize_fraction"
+
+module HumanizeFraction
+end

metadata

@@ -0,0 +1,155 @@
+--- !ruby/object:Gem::Specification
+name: humanize_fraction
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Peter Graham
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-07-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: humanize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: twitter_cldr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.4'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+description: Convert fractions to words, such as 3/5 to three fifths.
+email:
+- peterghm@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- circle.yml
+- humanize_fraction.gemspec
+- lib/core_extensions/string/humanize_fraction.rb
+- lib/humanize_fraction.rb
+- lib/humanize_fraction/humanizer.rb
+- lib/humanize_fraction/version.rb
+homepage: https://github.com/6/humanize_fraction
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Convert fractions to words, 3/5 => three fifths.
+test_files: []