percentage 1.2.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d7dde72257c6d27abdfca2ca058a7048287cbdbcd1421b70e2e517144242e639
-  data.tar.gz: '0619980650ea0118d1127e3aee909076a8edba57e94cf3a9d686f4d358f00976'
+  metadata.gz: d73c317eceabcfd5b4b4f385f7def4664d5e7d827e925d101a306ba404170b69
+  data.tar.gz: 3f225768beb51e4d8a743f2550be17119773ef392550369c2756d603bf448d68
 SHA512:
-  metadata.gz: 69b9ab800bc4898f765dd2e5667ae35b74ae02a59276fe5d85680267a5eaf0ae3cda8fe4188d18dcf0a530c46a19e2a2d5c5691dadf9bfc0851592951911361e
-  data.tar.gz: 333b4e6f9d8867aebf17ecdceab9d36997b026d2bdc1efd09612dfb92797d68dbf6d5eab3f40a1921b0406ae981ef1589eeb7efd06db242abcfc1330cddc9cdd
+  metadata.gz: 50b8c3ca5f618908e1ea75c2bb5076bf87a27d902781f96267f76954b9ec4481965a3dddc1a2f259b677a151bcf6bd39f48093e42307430335eb459b7270d3e7
+  data.tar.gz: 16e31215f053b38882f6b96e49e8b5c13a106342d7fefc0f4a5a2e87e8ce60aae95f64d5d65b279c3ec2e04e86b6230ca136904140b93c3321079903732b02ac

data/CHANGES.md

@@ -0,0 +1,43 @@
+# 2.0.0
+
+* Added Percentage#to_d
+
+* Percentage instances are now frozen on initialization
+
+* Changed `Percentage.change` to return `nil` when first argument is zero
+
+# 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

@@ -1,4 +1,4 @@
-Copyright (c) 2012-2019 TIMCRAFT
+Copyright (c) 2012-2022 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,12 +1,19 @@
 # percentage
 
-[![Gem Version](https://badge.fury.io/rb/percentage.svg)](https://badge.fury.io/rb/percentage) [![Build Status](https://api.travis-ci.org/timcraft/percentage.svg?branch=master)](https://travis-ci.org/timcraft/percentage)
+![Gem Version](https://badge.fury.io/rb/percentage.svg)
+![Test Status](https://github.com/readysteady/percentage/actions/workflows/test.yml/badge.svg)
 
 
-A little Ruby library for working with percentages.
+Ruby gem for working with percentages.
 
 
-## Installation
+## Install
+
+Using Bundler:
+
+    $ bundle add percentage
+
+Using RubyGems:
 
     $ gem install percentage
 

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/lib/percentage.rb

@@ -7,6 +7,8 @@ class Percentage
 
   def initialize(value)
     @value = value
+
+    freeze
   end
 
   def to_i
@@ -25,6 +27,16 @@ class Percentage
     fractional_value.to_r
   end
 
+  def to_d
+    if @value.integer?
+      @value.to_d / 100
+    elsif BigDecimal === @value
+      @value
+    else
+      @value.to_d(0)
+    end
+  end
+
   def zero?
     @value.zero?
   end
@@ -75,8 +87,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)
@@ -107,7 +127,7 @@ def Percentage(object)
 end
 
 def Percentage.change(a, b)
-  Percentage.new((b - a).to_r / a)
+  Percentage.new((b - a).to_r / a) unless a.zero?
 end
 
 class BigDecimal

data/percentage.gemspec

@@ -1,16 +1,20 @@
 Gem::Specification.new do |s|
   s.name = 'percentage'
-  s.version = '1.2.0'
+  s.version = '2.0.0'
   s.license = 'LGPL-3.0'
   s.platform = Gem::Platform::RUBY
   s.authors = ['Tim Craft']
   s.email = ['mail@timcraft.com']
-  s.homepage = 'https://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(LICENSE.txt 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.add_development_dependency('rake', '~> 12')
-  s.add_development_dependency('minitest', '~> 5')
   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,61 +1,37 @@
 --- !ruby/object:Gem::Specification
 name: percentage
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Tim Craft
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-03-26 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '12'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '12'
-- !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5'
-description: A little library for working with percentages
+date: 2022-01-07 00:00:00.000000000 Z
+dependencies: []
+description: Ruby gem for working with percentages
 email:
 - mail@timcraft.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGES.md
 - LICENSE.txt
 - README.md
-- Rakefile.rb
 - lib/percentage.rb
+- lib/percentage/yaml.rb
 - percentage.gemspec
-- spec/percentage_spec.rb
-homepage: https://github.com/timcraft/percentage
+homepage: https://github.com/readysteady/percentage
 licenses:
 - LGPL-3.0
-metadata: {}
-post_install_message: 
+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
@@ -70,8 +46,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.3.3
+signing_key:
 specification_version: 4
 summary: See description
 test_files: []

data/Rakefile.rb

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

data/spec/percentage_spec.rb

@@ -1,382 +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
-
-  it 'can be frozen' do
-    percentage = Percentage.new(10).freeze
-    percentage.frozen?.must_equal(true)
-    percentage.to_i.must_equal(10)
-  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 to_percentage method' do
-  it 'returns a percentage object with the value of the decimal as a percentage' do
-    percentage = BigDecimal(90).to_percentage
-    percentage.must_be_instance_of(Percentage)
-    percentage.value.must_equal(BigDecimal('0.9'))
-  end
-end
-
-describe 'BigDecimal percent_of method' do
-  it 'returns the value of the receiver as a percentage multiplied by the argument' do
-    BigDecimal(90).percent_of(100).must_equal(90)
-    BigDecimal(90).percent_of(BigDecimal('15')).must_equal(BigDecimal('13.5'))
-    BigDecimal(90).percent_of(Rational(150, 2)).must_equal(Rational(135, 2))
-  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 to_percentage method' do
-  it 'returns a percentage object with the value of the integer' do
-    percentage = 10.to_percentage
-    percentage.must_be_instance_of(Percentage)
-    percentage.value.must_equal(10)
-  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