fractional 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e102c37bdea15e535451f4ace3e8427b5cd80ba3
-  data.tar.gz: aca489da451ff4ded33297324f3691878696dd8a
+  metadata.gz: 113941347da803b9e0f57e563c0f63061cd3903b
+  data.tar.gz: 4b68768934859d192abc47b3962cc67cecb2f10e
 SHA512:
-  metadata.gz: 4dae17fc2ee51bbe1ea07eb0596a759fa5ae34ebd6a9a2418ef9c600c8ff9432a8a5ff354b6f6669edb09f78286e9c8e2432101fbb4712722a66e37eaabf08e5
-  data.tar.gz: 8eb87fbff148bee9e9c6c39c860c598aa0fd9adc1741688597666c7c77d1b6550b39d87b650b756678131d112ff3e775590a302ef07999347627b74db7524e5c
+  metadata.gz: 035b92227c95a2652666c85a52c28b272d32d854388e6475a84b83b85371d38ad823aa0414e660a1d4334d316bb66687d154eafa3ab1d649fabfc79b2cf715f6
+  data.tar.gz: 4885f100ddb7365f7b67d65838067044e0daf526f57f8024f762d05cef8dbdbd1f36e71b0a73ced98166d0a6abab399a3daf48836d4bcf27ef69d9b68492628b

data/.rspec

@@ -1,3 +1,2 @@
 --color
---debug
 --order rand

data/README.rdoc

@@ -11,6 +11,19 @@ Convert floats to fractional strings:
  Fractional.new(1100.875).to_s   #=> "1100 7/8"
  Fractional.new(1100.875, :to_nearest => "1/2").to_s #=> "1101"
 
+Convert to human-friendly fractions:
+ Fractional.new(-1.331, :to_human).to_s #=> "-1 1/3"
+
+ Consider the following example:
+
+ Fractional.new(1.339999).to_s => "67/50"
+ Fractional.new(1.339999).to_s(mixed_number: true) => "1 17/50"
+
+ This is not very human-friendly if we're talking about amounts in cooking recipes, especially when we need to convert from Kg to Pounds etc. Instead use:
+
+ Fractional.new(1.339999, to_human: true).to_s => "1 1/3"
+
+
 Also does a great job of guessing repeating decimal values:
  Fractional.new(0.33333).to_s    #=> "1/3"
  Fractional.new(3.142857142857).to_s    #=> "22/7"

data/VERSION

@@ -1 +1 @@
-1.0.1
+1.1.0

data/fractional.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name          = "fractional"
-  spec.version       = "1.0.1"
+  spec.version       = "1.1.0"
   spec.authors       = ["Chris O'Sullivan"]
   spec.email         = ["thechrisoshow@gmail.com"]
   spec.description   = %q{Fractional is a Ruby library for parsing fractions.}
@@ -14,7 +14,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec"
-  spec.add_development_dependency "debugger"
+  spec.add_development_dependency "rake", '~> 0'
+  spec.add_development_dependency "rspec", '~> 0'
+  spec.add_development_dependency "byebug", '~> 0'
 end

data/lib/fractional.rb

@@ -14,7 +14,11 @@ class Fractional < Numeric
     when String
       @value = Fractional.string_to_fraction( value, options )
     when Fixnum
-      @value = Rational(value)
+      if @value == @value.to_i
+        @value = Rational(value)
+      else # It's still Rational if it's a natural number
+        @value = Fractional.float_to_fraction( value.to_f, options )
+      end
     when Numeric
       @value = Fractional.float_to_fraction( value.to_f, options )
     else
@@ -115,6 +119,10 @@ class Fractional < Numeric
       return self.round_to_nearest_fraction( value, options[:to_nearest] )
     end
 
+    if options[:to_human]
+      return self.round_to_human_fraction( value )
+    end
+
     # first try to convert a repeating decimal unless guesstimate is forbidden
     unless options[:exact]
       repeat = float_to_rational_repeat(value)
@@ -217,4 +225,27 @@ class Fractional < Numeric
     Fractional.new((Fractional.new(value).to_f / to_nearest_float).round * to_nearest_float)
   end
 
+  def self.numeric_to_mixed_number(amount)
+    sign_prefix = ( amount < 0 )? '-' : ''
+    amount = amount.abs
+    amount_as_integer = amount.to_i
+    if (amount_as_integer != amount.to_f) && (amount_as_integer > 0)
+      fraction = amount - amount_as_integer
+      "#{sign_prefix}#{amount_as_integer} #{fraction}"
+    else
+      if amount.denominator == 1
+        "#{sign_prefix}#{amount_as_integer}"
+      else
+        sign_prefix + amount.to_s
+      end
+    end
+  end
+
+  # Display numbers in human-readable manner. 
+  #  Examples: 0.5 -> 1/2, 2.333 -> 2 1/3, 0.666 -> 2/3 etc. 
+  #
+  def self.round_to_human_fraction(value)
+    numeric_to_mixed_number value.rationalize(Rational('0.01'))
+  end
+
 end

data/spec/fractional_spec.rb

@@ -1,4 +1,5 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'byebug'
 
 ##################################
 # CLASS METHODS                  #
@@ -115,93 +116,93 @@ end
 
 describe "Fractional::string_is_fraction?" do
   it "should recognize a simple fraction" do
-    Fractional.string_is_fraction?("3/4").should be_true
+    Fractional.string_is_fraction?("3/4").should be_truthy
   end
 
   it "should recognize a mixed fraction" do
-    Fractional.string_is_fraction?("1 11/12").should be_true
+    Fractional.string_is_fraction?("1 11/12").should be_truthy
   end
 
   it "should recognize a negative fraction" do
-    Fractional.string_is_fraction?("-3/4").should be_true
+    Fractional.string_is_fraction?("-3/4").should be_truthy
   end
 
   it "should recognize a negative mixed fraction" do
-    Fractional.string_is_fraction?("-6 2/9").should be_true
+    Fractional.string_is_fraction?("-6 2/9").should be_truthy
   end
 
   it "should accept more than one space between the whole number and fractional part" do
-    Fractional.string_is_fraction?("1  2/3").should be_true
-    Fractional.string_is_fraction?("3               1/2").should be_true
+    Fractional.string_is_fraction?("1  2/3").should be_truthy
+    Fractional.string_is_fraction?("3               1/2").should be_truthy
   end
 
   it "should accept fractions with front and rear padding" do
-    Fractional.string_is_fraction?("     2/3").should be_true
-    Fractional.string_is_fraction?("2/3      ").should be_true
-    Fractional.string_is_fraction?("      2/3     ").should be_true
-    Fractional.string_is_fraction?("   1 2/3").should be_true
-    Fractional.string_is_fraction?("1 2/3      ").should be_true
-    Fractional.string_is_fraction?("    1 2/3   ").should be_true
+    Fractional.string_is_fraction?("     2/3").should be_truthy
+    Fractional.string_is_fraction?("2/3      ").should be_truthy
+    Fractional.string_is_fraction?("      2/3     ").should be_truthy
+    Fractional.string_is_fraction?("   1 2/3").should be_truthy
+    Fractional.string_is_fraction?("1 2/3      ").should be_truthy
+    Fractional.string_is_fraction?("    1 2/3   ").should be_truthy
   end
 
   it "should not recognize decimals" do
-    Fractional.string_is_fraction?("2.3").should be_false
+    Fractional.string_is_fraction?("2.3").should be_falsey
   end
 
   it "should not recognize two consecutive fractions" do
-    Fractional.string_is_fraction?("2/3 9/5").should be_false
+    Fractional.string_is_fraction?("2/3 9/5").should be_falsey
   end
 
   it "should not recognize a string with a slash" do
-    Fractional.string_is_fraction?("n/a").should be_false
+    Fractional.string_is_fraction?("n/a").should be_falsey
   end
 
   it "should not recognize a fraction mixed with non-decimals" do
-    Fractional.string_is_fraction?("3a/4").should be_false
-    Fractional.string_is_fraction?("a2/3").should be_false
-    Fractional.string_is_fraction?("1 2/3a").should be_false
+    Fractional.string_is_fraction?("3a/4").should be_falsey
+    Fractional.string_is_fraction?("a2/3").should be_falsey
+    Fractional.string_is_fraction?("1 2/3a").should be_falsey
   end
 
   it "should not recognize fractions with improper spacing" do
-    Fractional.string_is_fraction?("2 /2").should be_false
-    Fractional.string_is_fraction?("1/ 3").should be_false
-    Fractional.string_is_fraction?("1  2/  3").should be_false
-    Fractional.string_is_fraction?("1 2    /3").should be_false
+    Fractional.string_is_fraction?("2 /2").should be_falsey
+    Fractional.string_is_fraction?("1/ 3").should be_falsey
+    Fractional.string_is_fraction?("1  2/  3").should be_falsey
+    Fractional.string_is_fraction?("1 2    /3").should be_falsey
   end
 
 end
 
 describe "Fractional::string_is_mixed_fraction?" do
   it "should recognize a mixed fraction" do
-    Fractional.string_is_mixed_fraction?("1 11/12").should be_true
+    Fractional.string_is_mixed_fraction?("1 11/12").should be_truthy
   end
 
   it "should recognize a negative mixed fraciton" do
-    Fractional.string_is_mixed_fraction?("-1 11/12").should be_true
+    Fractional.string_is_mixed_fraction?("-1 11/12").should be_truthy
   end
 
   it "should not recognize a single fraction" do
-    Fractional.string_is_mixed_fraction?("3/4").should be_false
+    Fractional.string_is_mixed_fraction?("3/4").should be_falsey
   end
 
 end
 
 describe "Fractional::string_is_single_fraction?" do
   it "should recognize a single fraction" do
-    Fractional.string_is_single_fraction?("3/4").should be_true
+    Fractional.string_is_single_fraction?("3/4").should be_truthy
   end
 
   it "should recognize a negative numerator with a single fraction" do
-    Fractional.string_is_single_fraction?("-3/4").should be_true
+    Fractional.string_is_single_fraction?("-3/4").should be_truthy
   end
 
   it "should not recognize a mixed fraction" do
-    Fractional.string_is_single_fraction?("1 11/12").should be_false
+    Fractional.string_is_single_fraction?("1 11/12").should be_falsey
   end
 
   it "should allow for negative denominators in single fractions" do
-    Fractional.string_is_single_fraction?("1/-64").should be_true
-    Fractional.string_is_single_fraction?("-1/-64").should be_true
+    Fractional.string_is_single_fraction?("1/-64").should be_truthy
+    Fractional.string_is_single_fraction?("-1/-64").should be_truthy
   end
 
 end
@@ -313,15 +314,15 @@ end
 
 describe "Fractional#==" do
   it "should be equal to same Fractions" do
-    (Fractional.new(Rational(3,1)) == Fractional.new(Rational(3,1))).should be_true
+    (Fractional.new(Rational(3,1)) == Fractional.new(Rational(3,1))).should be_truthy
   end
 
   it "should not be equal to other Fractions" do
-    (Fractional.new(Rational(3,2)) == Fractional.new(Rational(3,1))).should be_false
+    (Fractional.new(Rational(3,2)) == Fractional.new(Rational(3,1))).should be_falsey
   end
 
   it "should be equal regardless of type" do
-    (Fractional.new(Rational(3,4)) == Fractional.new(0.75)).should be_true
+    (Fractional.new(Rational(3,4)) == Fractional.new(0.75)).should be_truthy
   end
 end
 
@@ -355,7 +356,7 @@ end
 
 describe "Frational", "comparsion" do
   it "should use the numerics included comparsion module" do
-    (Fractional.new(Rational(-3,4)) < Fractional.new(Rational(1,2))).should be_true
+    (Fractional.new(Rational(-3,4)) < Fractional.new(Rational(1,2))).should be_truthy
   end
 end
 
@@ -367,7 +368,6 @@ describe "Fractional#to_s" do
   it "should return nice representations of single fractions" do
     Fractional.new(0.75).to_s.should == "3/4"
     Fractional.new(-0.3333).to_s.should == "-1/3"
-
   end
 
   it "should return nice representations of mixed fractions" do
@@ -434,6 +434,23 @@ describe "Fractional", "round" do
   it "should round if passed a float" do
     Fractional.round_to_nearest_fraction(1100.875, 0.5).should == Fractional.new(1101)
   end
+
+  it "should round if passed a float" do
+    Fractional.round_to_human_fraction(0.9001).to_s.should == "9/10"
+    Fractional.round_to_human_fraction(-0.8012).to_s.should == "-4/5"
+    Fractional.round_to_human_fraction(0.337).to_s.should == "1/3"
+    Fractional.round_to_human_fraction(-1.331).to_s.should == "-1 1/3"
+    Fractional.round_to_human_fraction(5.691).to_s.should == "5 7/10"
+    Fractional.round_to_human_fraction(-3.668).to_s.should == "-3 2/3"
+    Fractional.round_to_human_fraction(2.0).to_s.should == "2"
+    Fractional.round_to_human_fraction(11).to_s.should == "11"
+  end
+
+  it "should round if passed 'to_human' that rounds to nearest whole number" do
+    Fractional.new(2.0, to_human: true).to_s.should == "2"
+    Fractional.new(-2.0, to_human: true).to_s.should == "-2"
+  end
+
 end
 
 ##################################
@@ -473,14 +490,14 @@ describe "deprecated methods" do
   end
 
   it "Fraction.fraction?" do
-    Fractional.fraction?("3/4").should be_true
+    Fractional.fraction?("3/4").should be_truthy
   end
 
   it "Fraction.mixed_fraction?" do
-    Fractional.mixed_fraction?("1 11/12").should be_true
+    Fractional.mixed_fraction?("1 11/12").should be_truthy
   end
 
   it "Fraction.single_fraction?" do
-     Fractional.single_fraction?("-3/4").should be_true
+     Fractional.single_fraction?("-3/4").should be_truthy
   end
-end
+end

metadata

@@ -1,69 +1,69 @@
 --- !ruby/object:Gem::Specification
 name: fractional
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Chris O'Sullivan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-13 00:00:00.000000000 Z
+date: 2015-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: debugger
+  name: byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
 description: Fractional is a Ruby library for parsing fractions.
@@ -73,8 +73,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
+- ".gitignore"
+- ".rspec"
 - Gemfile
 - LICENSE
 - README.rdoc
@@ -95,17 +95,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: 'You can use fractional to convert decimal numbers to string representations