percentage 1.0.0 → 1.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3c32ff68bc5ee26ca6f82898ffb94d6aba49153d8187999d1206c2920a6d132b
+  data.tar.gz: 6c46179997da767a0cce9dba903d9b33b4ca5a00a7fe62e7ae8c2a5131c409bb
+SHA512:
+  metadata.gz: 77c8e9753c605d8ff006d7c50db1fd78478eef8983a1020951fb8c46ec752438933f30829baee3d0d303877b8533b1be8c376001fc98a0ca6cce6826fb08d072
+  data.tar.gz: 51a800e6f7ebd074925b7cc91dc603fb1c064f5965026276645c0781ec92b95388cd5ba5708caa7dce3fc063a9b9802c8ad077d220502f869801a02a229551ca

data/LICENSE.txt

@@ -0,0 +1,4 @@
+Copyright (c) 2012-2018 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,20 @@
-Percentage
-==========
+# 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)
 
-A little library for working with percentages.
 
+A little Ruby library for working with percentages.
 
-Feature Tour
-------------
 
-The `Percentage` method converts Integer/BigDecimal/Rational objects
-to percentage objects with values that you would expect:
+## Installation
+
+    $ 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 +25,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 +35,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 +64,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 +79,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/Rakefile.rb

@@ -4,4 +4,5 @@ task :default => :spec
 
 Rake::TestTask.new(:spec) do |t|
   t.test_files = FileList['spec/*_spec.rb']
+  t.warning = true
 end

data/lib/percentage.rb

@@ -1,4 +1,3 @@
-require 'rational'
 require 'bigdecimal'
 
 class Percentage
@@ -98,7 +97,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 +111,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/percentage.gemspec

@@ -1,12 +1,16 @@
 Gem::Specification.new do |s|
   s.name = 'percentage'
-  s.version = '1.0.0'
+  s.version = '1.1.0'
+  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.summary = 'See description'
-  s.files = Dir.glob('{lib,spec}/**/*') + %w(README.md Rakefile.rb percentage.gemspec)
+  s.files = Dir.glob('{lib,spec}/**/*') + %w(LICENSE.txt README.md Rakefile.rb 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'
 end

data/spec/percentage_spec.rb

@@ -187,7 +187,7 @@ describe 'Percentage object initialized with a decimal value' do
 
   describe 'zero query method' do
     it 'returns true if the percentage has a zero value' do
-      Percentage.new(BigDecimal(0)).zero?.must_equal(true)
+      Percentage.new(BigDecimal('0')).zero?.must_equal(true)
     end
 
     it 'returns false otherwise' do
@@ -319,6 +319,22 @@ describe 'Percentage change method' do
   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'))
@@ -327,6 +343,14 @@ describe 'BigDecimal as_percentage_of method' do
   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
@@ -338,7 +362,7 @@ 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(BigDecimal('15')).must_equal(BigDecimal('1.5'))
     10.percent_of(Rational(150, 2)).must_equal(Rational(15, 2))
   end
 end

metadata

@@ -1,16 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: percentage
 version: !ruby/object:Gem::Version
-  version: 1.0.0
-  prerelease: 
+  version: 1.1.0
 platform: ruby
 authors:
 - Tim Craft
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-29 00:00:00.000000000 Z
-dependencies: []
+date: 2018-08-24 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
 email:
 - mail@timcraft.com
@@ -18,34 +45,34 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/percentage.rb
-- spec/percentage_spec.rb
+- LICENSE.txt
 - README.md
 - Rakefile.rb
+- lib/percentage.rb
 - percentage.gemspec
+- spec/percentage_spec.rb
 homepage: http://github.com/timcraft/percentage
-licenses: []
+licenses:
+- LGPL-3.0
+metadata: {}
 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
+rubygems_version: 2.7.6
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: See description
 test_files: []
-has_rdoc: