percentage 1.0.0 → 1.4.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 20e2362952bb7911cca151e3df92aa1fbd1673d165c745ca577aa7fa269c5d79
+  data.tar.gz: 82c0f31ba57b5e8eae7e4c9bf3e27cd202f32fa30d6f7ae544d519499e19cd37
+SHA512:
+  metadata.gz: 575215d64aaf5a84851d29e732902abc07239bf0be3e8a542ce8e332272b9c2470cfc6bc4c7d1337d180f2a2249cb854b3fbdf6fc3b697ef0a5f126680bc423b
+  data.tar.gz: 1e7ca91c861e49039fd592a82f54c9778ba335efc6286b9ab772c4f634db536e58eb429d9a839e1013684f435aa77c942210d8fcadfb2d49cac73dfbf449ea04

data/CHANGES.md

@@ -0,0 +1,35 @@
+# 1.4.1
+
+* Added CHANGES.md to gem files
+
+* Fixed outdated changelog_uri
+
+# 1.4.0
+
+* Added optional YAML integration
+
+This makes it possible to dump/load percentage objects to/from YAML as scalar values. For example:
+
+    require 'percentage/yaml'
+
+    puts YAML.dump([Percentage(BigDecimal('17.5'))])
+
+This functionality is not enabled by default, due to the use of Module#prepend.
+
+# 1.3.0
+
+* Added ndigits argument to Percentage#truncate
+
+# 1.2.0
+
+* Removed memoization so that Percentage objects can be frozen (thanks @iamvery)
+
+# 1.1.0
+
+* Added BigDecimal#to_percentage and Integer#to_percentage
+
+* Added BigDecimal#percent_of (thanks @mikeymicrophone)
+
+# 1.0.0
+
+* First version!

data/LICENSE.txt

@@ -0,0 +1,4 @@
+Copyright (c) 2012-2020 TIMCRAFT
+
+This is an Open Source project licensed under the terms of the LGPLv3 license.
+Please see <http://www.gnu.org/licenses/lgpl-3.0.html> for license text.

data/README.md

@@ -1,15 +1,27 @@
-Percentage
-==========
+# percentage
 
+![Gem Version](https://badge.fury.io/rb/percentage.svg)
+![Build Status](https://github.com/readysteady/percentage/workflows/Test/badge.svg)
 
-A little library for working with percentages.
 
+Ruby gem for working with percentages.
 
-Feature Tour
-------------
 
-The `Percentage` method converts Integer/BigDecimal/Rational objects
-to percentage objects with values that you would expect:
+## Install
+
+Using Bundler:
+
+    $ bundle add percentage
+
+Using RubyGems:
+
+    $ gem install percentage
+
+
+## Constructing Percentages
+
+The `Percentage` method converts numeric objects to percentage objects
+with values that you would expect:
 
 ```ruby
 Percentage(50)  # => 50%
@@ -20,7 +32,7 @@ Percentage(Rational(25, 2))  # => 12.5%
 ```
 
 Percentage objects can also be constructed directly, but in this case
-BigDecimal/Rational values are treated as fractions, for example:
+BigDecimal/Rational values are treated as fractions:
 
 ```ruby
 Percentage.new(50)  # => 50%
@@ -30,6 +42,19 @@ Percentage.new(BigDecimal('0.175'))  # => 17.5%
 Percentage.new(Rational(1, 8))  # => 12.5%
 ```
 
+Some shortcut methods are defined on Integer and BigDecimal for convenience:
+
+```ruby
+50.percent  # => 50%
+
+5.as_percentage_of(10)  # => 50.0%
+
+BigDecimal('2.9').to_percentage  # => 2.9%
+```
+
+
+## Numeric features
+
 As with other numerics, percentage objects are conceptually immutable.
 Common numeric functionality like `to_i`, `to_f`, `to_s`, `to_r`, `zero?`,
 and equality/comparison methods are defined.
@@ -46,9 +71,9 @@ They can also be "scaled up" using the `scale` method:
 Percentage(10).scale(5)  # => 50%
 ```
 
-Multiplication is then defined using the fractional value of the percentage.
-BigDecimal objects can't be coerced into rational objects, so the order of
-the multiplication will matter in some cases. For example:
+Multiplication is defined using the fractional value of the percentage.
+BigDecimal objects can't be coerced into rational objects, so the
+multiplication order will matter in some cases, for example:
 
 ```ruby
 Percentage(50) * 10  # => (5/1)
@@ -61,23 +86,19 @@ Percentage(50) * BigDecimal('150.00')  # raises TypeError
 ```
 
 
-Bonus Extras
-------------
+## Bonus extras
 
-Some shortcut methods are defined on Integer/BigDecimal for convenience:
+There's a #percent_of method defined on Integer and BigDecimal for percentage calculations:
 
 ```ruby
-50.percent  # => 50%
-
 50.percent_of(BigDecimal(150))  # => BigDecimal('75.00')
 
 10.percent_of(100)  # => (10/1)
 
-5.as_percentage_of(10)  # => 50.0%
+BigDecimal('0.5').percent_of(88)  # => BigDecimal('0.44')
 ```
 
-And there's also a class method for calculating the percentage
-change between two values:
+There's also a `Percentage.change` method for calculating the percentage change between two values:
 
 ```ruby
 Percentage.change(2, 3)  # => 50.0%

data/lib/percentage.rb

@@ -1,4 +1,3 @@
-require 'rational'
 require 'bigdecimal'
 
 class Percentage
@@ -76,8 +75,16 @@ class Percentage
     end
   end
 
-  def truncate(n)
-    self.class.new(fractional_value.truncate(n))
+  def truncate(ndigits = nil)
+    return self if @value.integer?
+
+    value = @value * 100
+
+    if ndigits.nil?
+      self.class.new(value.truncate)
+    else
+      self.class.new(value.truncate(ndigits) / 100)
+    end
   end
 
   def scale(n)
@@ -87,7 +94,7 @@ class Percentage
   protected
 
   def fractional_value
-    @fractional_value ||= @value.integer? ? Rational(@value, 100) : @value
+    @value.integer? ? Rational(@value, 100) : @value
   end
 
   private
@@ -98,7 +105,7 @@ class Percentage
     elsif BigDecimal === @value
       (@value * 100).to_s('F')
     else
-      BigDecimal(@value * 100, _precision=10).to_s('F')
+      (@value * 100).to_f.to_s
     end
   end
 end
@@ -112,18 +119,28 @@ def Percentage.change(a, b)
 end
 
 class BigDecimal
+  def to_percentage
+    Percentage(self)
+  end
+
+  def percent_of(n)
+    n * Percentage(self)
+  end
+
   def as_percentage_of(n)
     Percentage.new(self / n)
   end
 end
 
 class Integer
-  def percent
-    Percentage.new(self)
+  def to_percentage
+    Percentage(self)
   end
 
+  alias_method :percent, :to_percentage
+
   def percent_of(n)
-    n * Percentage.new(self)
+    n * Percentage(self)
   end
 
   def as_percentage_of(n)

data/lib/percentage/yaml.rb

@@ -0,0 +1,29 @@
+require 'yaml'
+
+class Percentage
+  def encode_with(coder)
+    coder.represent_scalar(nil, to_s)
+  end
+
+  module ScalarScannerPatch
+    INTEGER = /\A(\d+)%\z/
+
+    DECIMAL = /\A(\d+\.\d+)%\z/
+
+    def tokenize(string)
+      if !string.empty? && string.match(INTEGER)
+        return Percentage($1.to_i)
+      end
+
+      if !string.empty? && string.match(DECIMAL)
+        return Percentage(BigDecimal($1))
+      end
+
+      super string
+    end
+
+    YAML::ScalarScanner.prepend(self)
+  end
+
+  private_constant :ScalarScannerPatch
+end

data/percentage.gemspec

@@ -1,12 +1,20 @@
 Gem::Specification.new do |s|
   s.name = 'percentage'
-  s.version = '1.0.0'
+  s.version = '1.4.1'
+  s.license = 'LGPL-3.0'
   s.platform = Gem::Platform::RUBY
   s.authors = ['Tim Craft']
   s.email = ['mail@timcraft.com']
-  s.homepage = 'http://github.com/timcraft/percentage'
-  s.description = 'A little library for working with percentages'
+  s.homepage = 'https://github.com/readysteady/percentage'
+  s.description = 'Ruby gem for working with percentages'
   s.summary = 'See description'
-  s.files = Dir.glob('{lib,spec}/**/*') + %w(README.md Rakefile.rb percentage.gemspec)
+  s.files = Dir.glob('lib/**/*.rb') + %w[CHANGES.md LICENSE.txt README.md percentage.gemspec]
+  s.required_ruby_version = '>= 1.9.3'
   s.require_path = 'lib'
+  s.metadata = {
+    'homepage' => 'https://github.com/readysteady/percentage',
+    'source_code_uri' => 'https://github.com/readysteady/percentage',
+    'bug_tracker_uri' => 'https://github.com/readysteady/percentage/issues',
+    'changelog_uri' => 'https://github.com/readysteady/percentage/blob/main/CHANGES.md'
+  }
 end

metadata

@@ -1,51 +1,53 @@
 --- !ruby/object:Gem::Specification
 name: percentage
 version: !ruby/object:Gem::Version
-  version: 1.0.0
-  prerelease: 
+  version: 1.4.1
 platform: ruby
 authors:
 - Tim Craft
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2012-11-29 00:00:00.000000000 Z
+date: 2020-11-03 00:00:00.000000000 Z
 dependencies: []
-description: A little library for working with percentages
+description: Ruby gem for working with percentages
 email:
 - mail@timcraft.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/percentage.rb
-- spec/percentage_spec.rb
+- CHANGES.md
+- LICENSE.txt
 - README.md
-- Rakefile.rb
+- lib/percentage.rb
+- lib/percentage/yaml.rb
 - percentage.gemspec
-homepage: http://github.com/timcraft/percentage
-licenses: []
-post_install_message: 
+homepage: https://github.com/readysteady/percentage
+licenses:
+- LGPL-3.0
+metadata:
+  homepage: https://github.com/readysteady/percentage
+  source_code_uri: https://github.com/readysteady/percentage
+  bug_tracker_uri: https://github.com/readysteady/percentage/issues
+  changelog_uri: https://github.com/readysteady/percentage/blob/main/CHANGES.md
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 1.8.24
-signing_key: 
-specification_version: 3
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
 summary: See description
 test_files: []
-has_rdoc: 

data/Rakefile.rb

@@ -1,7 +0,0 @@
-require 'rake/testtask'
-
-task :default => :spec
-
-Rake::TestTask.new(:spec) do |t|
-  t.test_files = FileList['spec/*_spec.rb']
-end

data/spec/percentage_spec.rb

@@ -1,352 +0,0 @@
-require 'minitest/autorun'
-
-require_relative '../lib/percentage'
-
-describe 'Percentage object' do
-  it 'is comparable' do
-    percentage = Percentage.new(Rational(1, 8))
-
-    (Comparable === percentage).must_equal(true)
-  end
-
-  it 'is comparable to other objects of the same class' do
-    (Percentage.new(Rational(1, 8)) > Percentage.new(Rational(1, 10))).must_equal(true)
-  end
-
-  it 'is comparable to other numeric objects' do
-    (Percentage.new(Rational(1, 8)) > Rational(1, 10)).must_equal(true)
-  end
-
-  it 'can be used as a hash key' do
-    hash = Hash.new(0)
-
-    3.times { hash[Percentage.new(Rational(1, 10))] += 1 }
-
-    hash[Percentage.new(Rational(1, 10))].must_equal(3)
-  end
-end
-
-describe 'Percentage object initialized with an integer value' do
-  before do
-    @percentage = Percentage.new(10)
-  end
-
-  describe 'value method' do
-    it 'returns the value passed to the constructor' do
-      @percentage.value.must_equal(10)
-    end
-  end
-
-  describe 'to_i method' do
-    it 'returns the integer value of the percentage' do
-      @percentage.to_i.must_equal(10)
-    end
-  end
-
-  describe 'to_f method' do
-    it 'returns the float value of the percentage' do
-      @percentage.to_f.must_be_close_to(10.0)
-    end
-  end
-
-  describe 'to_s method' do
-    it 'returns the integer value of the percentage suffixed with the percent symbol' do
-      @percentage.to_s.must_equal('10%')
-    end
-  end
-
-  describe 'to_r method' do
-    it 'returns the rational value of the percentage' do
-      @percentage.to_r.must_equal(Rational(1, 10))
-    end
-  end
-
-  describe 'zero query method' do
-    it 'returns true if the percentage has a zero value' do
-      Percentage.new(0).zero?.must_equal(true)
-    end
-
-    it 'returns false otherwise' do
-      @percentage.zero?.must_equal(false)
-    end
-  end
-
-  describe 'truncate method' do
-    it 'returns a percentage object with a truncated rational value' do
-      percentage = @percentage.truncate(1)
-      percentage.must_be_instance_of(Percentage)
-      percentage.value.must_equal(Rational(1, 10))
-    end
-  end
-
-  describe 'scale method' do
-    it 'returns a percentage object with the value of the percentage multiplied by the integer argument' do
-      percentage = @percentage.scale(2)
-      percentage.must_be_instance_of(Percentage)
-      percentage.value.must_equal(20)
-    end
-  end
-end
-
-describe 'Percentage object initialized with a rational value' do
-  before do
-    @percentage = Percentage.new(Rational(1, 8))
-  end
-
-  describe 'value method' do
-    it 'returns the value passed to the constructor' do
-      @percentage.value.must_equal(Rational(1, 8))
-    end
-  end
-
-  describe 'to_i method' do
-    it 'returns the integer value of the percentage' do
-      @percentage.to_i.must_equal(12)
-    end
-  end
-
-  describe 'to_f method' do
-    it 'returns the float value of the percentage' do
-      @percentage.to_f.must_be_close_to(12.5)
-    end
-  end
-
-  describe 'to_s method' do
-    it 'returns the decimal value of the percentage suffixed with the percent symbol' do
-      @percentage.to_s.must_equal('12.5%')
-    end
-  end
-
-  describe 'to_r method' do
-    it 'returns the rational value of the percentage' do
-      @percentage.to_r.must_equal(Rational(1, 8))
-    end
-  end
-
-  describe 'zero query method' do
-    it 'returns true if the percentage has a zero value' do
-      Percentage.new(Rational(0)).zero?.must_equal(true)
-    end
-
-    it 'returns false otherwise' do
-      @percentage.zero?.must_equal(false)
-    end
-  end
-
-  describe 'truncate method' do
-    it 'returns a percentage object with a truncated rational value' do
-      percentage = @percentage.truncate(1)
-      percentage.must_be_instance_of(Percentage)
-      percentage.value.must_equal(Rational(1, 10))
-    end
-  end
-
-  describe 'scale method' do
-    it 'returns a percentage object with the value of the percentage multiplied by the integer argument' do
-      percentage = @percentage.scale(2)
-      percentage.must_be_instance_of(Percentage)
-      percentage.value.must_equal(Rational(1, 4))
-    end
-  end
-end
-
-describe 'Percentage object initialized with a decimal value' do
-  before do
-    @percentage = Percentage.new(BigDecimal('0.175'))
-  end
-
-  describe 'value method' do
-    it 'returns the value passed to the constructor' do
-      @percentage.value.must_equal(BigDecimal('0.175'))
-    end
-  end
-
-  describe 'to_i method' do
-    it 'returns the integer value of the percentage' do
-      @percentage.to_i.must_equal(17)
-    end
-  end
-
-  describe 'to_f method' do
-    it 'returns the float value of the percentage' do
-      @percentage.to_f.must_be_close_to(17.5)
-    end
-  end
-
-  describe 'to_s method' do
-    it 'returns the decimal value of the percentage suffixed with the percent symbol' do
-      @percentage.to_s.must_equal('17.5%')
-    end
-  end
-
-  describe 'to_r method' do
-    it 'returns the rational value of the percentage' do
-      @percentage.to_r.must_equal(Rational(175, 1000))
-    end
-  end
-
-  describe 'zero query method' do
-    it 'returns true if the percentage has a zero value' do
-      Percentage.new(BigDecimal(0)).zero?.must_equal(true)
-    end
-
-    it 'returns false otherwise' do
-      @percentage.zero?.must_equal(false)
-    end
-  end
-
-  describe 'truncate method' do
-    it 'returns a percentage object with a truncated decimal value' do
-      percentage = @percentage.truncate(1)
-      percentage.must_be_instance_of(Percentage)
-      percentage.value.must_equal(BigDecimal('0.1'))
-    end
-  end
-
-  describe 'scale method' do
-    it 'returns a percentage object with the value of the percentage multiplied by the integer argument' do
-      percentage = @percentage.scale(2)
-      percentage.must_be_instance_of(Percentage)
-      percentage.value.must_equal(BigDecimal('0.35'))
-    end
-  end
-end
-
-describe 'Addition of percentage objects' do
-  it 'returns a percentage object with the value of the two percentages added together' do
-    percentage = Percentage.new(10) + Percentage.new(10)
-    percentage.must_be_instance_of(Percentage)
-    percentage.value.must_equal(20)
-
-    percentage = Percentage.new(Rational(1, 8)) + Percentage.new(10)
-    percentage.must_be_instance_of(Percentage)
-    percentage.value.must_equal(Rational(9, 40))
-
-    percentage = Percentage.new(BigDecimal('0.175')) + Percentage.new(BigDecimal('0.025'))
-    percentage.must_be_instance_of(Percentage)
-    percentage.value.must_equal(BigDecimal('0.2'))
-  end
-end
-
-describe 'Addition of percentage object with another type of object' do
-  it 'raises an exception' do
-    proc { Percentage.new(10) + 5 }.must_raise(TypeError)
-  end
-end
-
-describe 'Multiplication of percentage objects' do
-  it 'returns a percentage object with the fractional value of the two percentages multiplied together' do
-    percentage = Percentage.new(10) * Percentage.new(10)
-    percentage.must_be_instance_of(Percentage)
-    percentage.value.must_equal(Rational(1, 100))
-
-    percentage = Percentage.new(Rational(1, 8)) * Percentage.new(10)
-    percentage.must_be_instance_of(Percentage)
-    percentage.value.must_equal(Rational(1, 80))
-
-    percentage = Percentage.new(BigDecimal('0.175')) * Percentage.new(10)
-    percentage.must_be_instance_of(Percentage)
-    percentage.value.must_equal(Rational(7, 400))
-  end
-end
-
-describe 'Multiplication of a decimal object with a percentage object' do
-  it 'returns a decimal object with the value of the decimal multiplied by the fractional value of the percentage' do
-    percentage, decimal = Percentage.new(BigDecimal('0.175')), BigDecimal('99.00')
-
-    (decimal * percentage).must_equal(BigDecimal('17.325'))
-    (percentage * decimal).must_equal(BigDecimal('17.325'))
-  end
-end
-
-describe 'Percentage object equality' do
-  describe 'double equals method' do
-    it 'returns true for percentage objects with the same fractional value' do
-      (Percentage.new(50) == Percentage.new(50)).must_equal(true)
-      (Percentage.new(50) == Percentage.new(Rational(1, 2))).must_equal(true)
-      (Percentage.new(50) == Percentage.new(BigDecimal('0.5'))).must_equal(true)
-    end
-
-    it 'returns false otherwise' do
-      (Percentage.new(50) == Percentage.new(100)).must_equal(false)
-    end
-  end
-
-  describe 'eql query method' do
-    it 'returns true for percentage objects with exactly the same fractional value' do
-      (Percentage.new(50).eql? Percentage.new(50)).must_equal(true)
-    end
-
-    it 'returns false otherwise' do
-      (Percentage.new(50).eql? Percentage.new(Rational(1, 2))).must_equal(false)
-      (Percentage.new(50).eql? Percentage.new(BigDecimal('0.5'))).must_equal(false)
-      (Percentage.new(50).eql? Percentage.new(100)).must_equal(false)
-    end
-  end
-end
-
-describe 'Percentage method' do
-  describe 'when called with an integer argument' do
-    it 'returns a percentage object with the integer value' do
-      percentage = Percentage(10)
-      percentage.must_be_instance_of(Percentage)
-      percentage.value.must_equal(10)
-    end
-  end
-
-  describe 'when called with a decimal argument' do
-    it 'returns a percentage object with the value of the argument divided by 100' do
-      percentage = Percentage(BigDecimal('17.5'))
-      percentage.must_be_instance_of(Percentage)
-      percentage.value.must_equal(BigDecimal('0.175'))
-    end
-  end
-
-  describe 'when called with a rational argument' do
-    it 'returns a percentage object with the value of the argument divided by 100' do
-      percentage = Percentage(Rational(100, 3))
-      percentage.must_be_instance_of(Percentage)
-      percentage.value.must_equal(Rational(1, 3))
-    end
-  end
-end
-
-describe 'Percentage change method' do
-  it 'returns the difference between the arguments as a percentage of the first argument' do
-    percentage = Percentage.change(2, 3)
-    percentage.must_be_instance_of(Percentage)
-    percentage.must_equal(Percentage.new(50))
-  end
-end
-
-describe 'BigDecimal as_percentage_of method' do
-  it 'returns a percentage object with the value of the decimal divided by the argument' do
-    percentage = BigDecimal('50.00').as_percentage_of(BigDecimal('100.00'))
-    percentage.must_be_instance_of(Percentage)
-    percentage.value.must_equal(BigDecimal('0.5'))
-  end
-end
-
-describe 'Integer percent method' do
-  it 'returns a percentage object with the value of the integer' do
-    percentage = 10.percent
-    percentage.must_be_instance_of(Percentage)
-    percentage.value.must_equal(10)
-  end
-end
-
-describe 'Integer percent_of method' do
-  it 'returns the value of the receiver as a percentage multiplied by the argument' do
-    10.percent_of(100).must_equal(10)
-    10.percent_of(BigDecimal(15)).must_equal(BigDecimal('1.5'))
-    10.percent_of(Rational(150, 2)).must_equal(Rational(15, 2))
-  end
-end
-
-describe 'Integer as_percentage_of method' do
-  it 'returns a percentage object with the value of the integer divided by the argument' do
-    percentage = 10.as_percentage_of(20)
-    percentage.must_be_instance_of(Percentage)
-    percentage.value.must_equal(Rational(1, 2))
-  end
-end