sk_calc 0.0.6 → 1.0.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    OWQ1Njk0NmNiZjk0NjM0OWUzMDA1NDMxMWIwMjZmZGQ0OGFiYjEyNg==
+    OTI1NzM2ZTM1YmJhOGFmMDgwODYwYTE3MWRkYTMzZjM4MDgxNDJkNA==
   data.tar.gz: !binary |-
-    YTNjOWU4YTViMmZiYjkwYTU0YWFiOWFhMGQ0OGUzMmI2ODM1ZDM0OA==
+    MTJlMDVmMjNkMDg3Y2E4NmIxMWU5YzA3NGE0ZjgxZTg5ZDVjZGQ3ZA==
 SHA512:
   metadata.gz: !binary |-
-    MDk2NWU1ZjVmYjg4NjgzYTk3MTVmMTUxOWJmZTNiYzZjZjg1ZWY5YmIwZTQ4
-    NGIyMjU4Y2Q0ZmUyYmFkZjc3MzExYmE2MTBmNWNjNDcyNTFkMzA1NGFkN2Vj
-    YTk2YTk5Yzk3NjEzODMxZDljNzQxMDBiZDUxZjQ2MTgxMWFiYzQ=
+    YjcyNGZiYmExNDcwMGY4MzkxNjM4YmJiNWQ2NWE3YzYxODllODVmZmMzMGVm
+    OGZlNTU5ODgwMTBiMjNlZTM5NDg3OGFiNGEzNzRmZDQ4MTVhNjNhODU1ZGIz
+    OGVhNDhjNWIzZmZiZTFiMDA5MDNlMzU2NTk2ODI4MjdhMzIwOTI=
   data.tar.gz: !binary |-
-    ZTYzODNiZTI5ZWQ0NjdhYzA0ZjY3ZjEwZTRiZTA1ZDlhMWZiMjEzMTFhYjQ0
-    ODBhMDRjZjg4MmEwMjZmZjMyYjI4MTY2NWNlNjM5ZjY3MDc4YzA3NmRlYzQ0
-    NjY3N2E5NzU4ZWY3NzdhZjUyYjU4MGRiMjY1YTcwNjgxN2FiNDM=
+    NjA4ZmM4NjgyNTI1YWFlZThiNzY4YzZmYmY5Y2QyYjI0NDM0NGQ3NjQxMzA2
+    ZDBiNTgyOTA0ZDVhNmViNTYzZGViNTRmNGE0ODc1ZDRmOGFmYjZjOWQ5MWVk
+    NWE4NmNiMWZiOGYzNGI4Nzk2MDllMGRlMGQxYzM1YTg4Y2I0MmE=

data/.travis.yml

@@ -1,4 +1,3 @@
 rvm:
-  - 1.8.7
-  - 1.9.2
   - 1.9.3
+  - 2.2

data/{README.rdoc → README.md}

@@ -1,5 +1,5 @@
-= SalesKing Calculation
-{<img src="https://secure.travis-ci.org/salesking/sk_calc.png?branch=master" alt="Build Status" />}[http://travis-ci.org/salesking/sk_calc]
+# SalesKing Calculation
+[![Build Status](https://travis-ci.org/salesking/sk_calc.svg?branch=master)](https://travis-ci.org/salesking/sk_calc)
 
 Why?
 
@@ -24,7 +24,14 @@ mixing it into your local classes.
 read spec/sk_calc/*.rb to see examples
 
   require 'sk_calc'
+  class LineItem
+    calculates :item
+  end
+  
+  class Invoice
+    calculates :items
+   end
 
 == Tests
 
-Copyright (c) 2011 Georg Leciejewski, released under the MIT license
+Copyright (c) 2011-2016 Georg Leciejewski, released under the MIT license

data/Rakefile

@@ -1,6 +1,5 @@
 #!/usr/bin/env rake
 require 'rake'
-require 'rdoc/task'
 require 'rspec'
 require 'rspec/core/rake_task'
 require 'bundler/gem_tasks'
@@ -13,13 +12,3 @@ RSpec::Core::RakeTask.new do |t|
   t.pattern = "./spec/**/*_spec.rb" # don't need this, it's default.
   # Put spec opts in a file named .rspec in root
 end
-
-desc 'Generate documentation.'
-Rake::RDocTask.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'SalesKing Calculation'
-  rdoc.options << '--line-numbers' << '--inline-source'
-  rdoc.rdoc_files.include('README')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
-

data/lib/sk_calc.rb

@@ -13,12 +13,20 @@ module SK
   #   end
   module Calc
 
+    # Global calculation precision setting. If you save values to db with 8
+    # decimal places you should use a precision of 8
+    def self.precision
+      @precision || 6
+    end
+
+    def self.precision=(val)
+      @precision = val
+    end
+
     def self.included(base)
-      autoload :Helper, 'sk_calc/helper'
       autoload :Item, 'sk_calc/item'
       autoload :Items, 'sk_calc/items'
       base.extend(ClassMethods)
-  #    base.send(:include, InstanceMethods)
     end
 
     module ClassMethods
@@ -26,10 +34,11 @@ module SK
       def calculates(kind, opts={})
         include Item if kind == :item
         include Items if kind == :items
+        if opts[:precision]
+          SK::Calc.precision = opts[:precision]
+        end
       end
     end
 
-    module InstanceMethods; end
-
   end
 end

data/lib/sk_calc/item.rb

@@ -30,14 +30,6 @@
 #   discount_total
 #
 module SK::Calc::Item
-  include SK::Calc::Helper
-
-  def self.round_mode
-    @rmd || BigDecimal::ROUND_HALF_UP
-  end
-  def self.round_mode=(mode)
-    @rmd = mode
-  end
 
   ############################################
   ### BASE VALUES
@@ -49,12 +41,12 @@ module SK::Calc::Item
   # Total unrounded net basis incl discount
   # Use this internally to do calculations! Differs from net_total_base which is
   # used to output the rounded & formatted values
-  # @return [BigDecimal]
+  # @return [Rational]
   def net_total_base
     (100 - conv_discount) * total / 100
   end
 
-  # @return [BigDecimal] total amount of tax
+  # @return [Rational] total amount of tax
   def tax_total_base
     (net_total_base * conv_tax) / 100
   end
@@ -62,7 +54,7 @@ module SK::Calc::Item
   # Single net price with discount applied
   # DO NOT use this method to calculate(eg. totals for a document) use net_total
   # or gross_total instead
-  # @return [BigDecimal] rounded 2 decimals
+  # @return [Rational] rounded 2 decimals
   def net_single_base
     conv_price_single * ( 1 - (conv_discount / 100 ) )
   end
@@ -72,20 +64,20 @@ module SK::Calc::Item
   end
 
   # Total gross price incl. discount
-  # @return [BigDecimal] total gross base
+  # @return [Rational] total gross base
   def gross_total_base
     net_total_base + tax_total_base
   end
 
   # The discount amount unrounded
-  # @return [BigDecimal] rounded
+  # @return [Rational] rounded
   def discount_total_base
     total * (conv_discount / 100)
   end
 
   # Unrounded item total price * quantity, excl discount
   # Use it to do calculations!
-  # @return [BigDecimal]
+  # @return [Rational]
   def total
     conv_price_single * ( quantity || 0)
   end
@@ -98,24 +90,24 @@ module SK::Calc::Item
   ### for calculations!
 
   # Total gross price incl. discount
-  # @return [BigDecimal] rounded 2 decimals
+  # @return [Rational] rounded 2 decimals
   def gross_total
     gross_total_base.round(2)
   end
 
   # Total net price(2 decimals) incl. discount
-  # @return [BigDecimal] rounded 2 decimals
+  # @return [Rational] rounded 2 decimals
   def net_total
     net_total_base.round(2)
   end
 
-  # @return [BigDecimal] rounded 2 decimals
+  # @return [Rational] rounded 2 decimals
   def tax_total
     tax_total_base.round(2)
   end
 
   # The discount amount
-  # @return [BigDecimal] rounded 2 decimals
+  # @return [Rational] rounded 2 decimals
   def discount_total
     discount_total_base.round(2)
   end
@@ -123,7 +115,7 @@ module SK::Calc::Item
   # Single net price with discount applied rounded 2.
   # DO NOT use this method to calculate(eg. totals for a document) use net_total
   # or gross_total instead
-  # @return [BigDecimal] rounded 2 decimals
+  # @return [Rational] rounded 2 decimals
   def net_single
     net_single_base.round(2)
   end
@@ -131,72 +123,30 @@ module SK::Calc::Item
   # Single gross price rounded 2.
   # DONT use this method to calculate(eg. totals for a document) use net_total
   # or gross_total instead
-  # @return [BigDecimal] rounded 2 decimals
+  # @return [Rational] rounded 2 decimals
   def gross_single
     gross_single_base.round(2)
   end
 
-  ############################################
-  ### DISPLAY VALUES 4
-  ############################################
-  ### These values are used only to display to a user.
-  ### Use values under BASE VALUES section
-  ### for calculations!
-
-  # Total gross price incl. discount
-  # @return [BigDecimal] rounded 2 decimals
-  def gross_total_4
-    gross_total_base.round(4)
-  end
-
-  # Total net price
-  # @return [BigDecimal] rounded 4 decimals
-  def net_total_4
-    net_total_base.round(4)
-  end
-
-
-  # @return [BigDecimal] rounded 4 decimals
-  def tax_total_4
-    tax_total_base.round(4)
-  end
-
-  # The discount amount
-  # @return [BigDecimal] rounded 4 decimals
-  def discount_total_4
-    discount_total_base.round(4)
-  end
-
-
-  # Single net price with discount applied rounded 2.
-  # DO NOT use this method to calculate(eg. totals for a document) use net_total
-  # or gross_total instead
-  # @return [BigDecimal] rounded 4 decimals
-  def net_single_4
-    net_single_base.round(4)
-  end
-
-  # Single gross price rounded 2.
-  # DONT use this method to calculate(eg. totals for a document) use net_total
-  # or gross_total instead
-  # @return [BigDecimal] rounded 4 decimals
-  def gross_single_4
-    gross_single_base.round(4)
-  end
 
   private
 
-  # Init price single with 0 if nil and cast to BigDecimal
-  # @return [BigDecimal]
+  # Init price single with 0 if nil
+  # @return [Rational]
   def conv_price_single
-    to_bd(price_single || 0)
+    (price_single || 0).to_r.round(SK::Calc.precision)
   end
 
   # Init discount with 0 gracefully ignores if it is not defined.
-  # If nil and cast to BigDecimal
-  # @return [BigDecimal]
+  # @return [Rational]
   def conv_discount
-    to_bd( (self.respond_to?(:discount) && discount) || 0)
+    ((self.respond_to?(:discount) && discount) || 0).to_r
+  end
+
+  # Init tax with 0 if nil
+  # @return [Rational]
+  def conv_tax
+    ((self.respond_to?(:tax) && tax) || 0).to_r
   end
 
 end

data/lib/sk_calc/items.rb

@@ -4,16 +4,14 @@
 # - price_tax: the tax total for all items
 # - line_items
 module SK::Calc::Items
-  include SK::Calc::Helper
-
   # Unrounded net total which is the sum of all items net_total, the taxation base
-  # @return [BigDecimal]
+  # @return [Rational]
   def net_total_base
     conv_price_total
   end
 
   # Gross total unrounded
-  # @return [BigDecimal]
+  # @return [Rational]
   def gross_total_base
     (net_total_base || 0) + tax_total_base
   end
@@ -24,35 +22,23 @@ module SK::Calc::Items
   end
 
   # Gross total rounded to 2 decimals
-  # @return [BigDecimal]
+  # @return [Rational]
   def gross_total
     gross_total_base.round(2)
   end
 
   # Tax total rounded price_tax to 2 decimals
-  # @return [BigDecimal]
+  # @return [Rational]
   def tax_total_base
     conv_tax
   end
 
   # Tax total rounded price_tax to 2 decimals
-  # @return [BigDecimal]
+  # @return [Rational]
   def tax_total
     conv_tax.round(2)
   end
 
-  # Net total rounded to 4 decimals
-  # @return [BigDecimal]
-  def net_total_4
-    net_total_base.round(4)
-  end
-
-  # Rounded price_tax to 4 decimals
-  # @return [BigDecimal]
-  def tax_total_4
-    conv_tax.round(4)
-  end
-
   # Save items sums of net total and summed taxes into the price_total,
   # tax_total
   def sum_items(items=nil)
@@ -87,22 +73,22 @@ module SK::Calc::Items
     result = {}
     items.group_by(&:tax).each do |tax, item_group|
       net_total_sum = item_group.to_a.sum(&:net_total_base)
-      result[tax] = (net_total_sum * tax / 100.0) if tax && !tax.zero?
+      result[tax] = (net_total_sum * tax / 100.0).round(SK::Calc.precision) if tax && !tax.zero?
     end
     result.sort
   end
 
   private
 
-  # Init total with 0 if nil and cast to BigDecimal
-  # @return [BigDecimal]
+  # Init total with 0 if nil and cast to Rational
+  # @return [Rational]
   def conv_price_total
-    to_bd(price_total || 0)
+    (price_total || 0).to_r.round(SK::Calc.precision)
   end
 
-  # Init tax with 0 if nil and cast to BigDecimal .. same in helper
-  # @return [BigDecimal]
+  # Init tax with 0 if nil and cast to Rational
+  # @return [Rational]
   def conv_tax
-    to_bd(price_tax || 0)
+    (price_tax || 0).to_r
   end
 end

data/lib/sk_calc/version.rb

@@ -1,5 +1,5 @@
 module SK
   module Calc
-    VERSION = '0.0.6'
+    VERSION = '1.0.0'
   end
 end

data/sk_calc.gemspec

@@ -12,9 +12,7 @@ Gem::Specification.new do |s|
   s.description = %q{Calculate document and line item totals. This moule is used inside SalesKIng and outsourced for transparency and reusability.}
   s.email = %q{gl@salesking.eu}
   s.homepage = %q{http://github.com/salesking/sk_calc}
-  s.extra_rdoc_files = [
-    "README.rdoc"
-  ]
+
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
@@ -25,7 +23,6 @@ Gem::Specification.new do |s|
 
   s.add_development_dependency 'rspec'
   s.add_development_dependency 'simplecov'
-  s.add_development_dependency 'rdoc'
   s.add_development_dependency 'activesupport'
   s.add_development_dependency 'rake', '>= 0.9.2'
 

data/spec/sk_calc/item_spec.rb

@@ -14,16 +14,28 @@ end
 
 describe SK::Calc do
 
- describe 'optional fields' do
-   it 'should have conv_tax' do
+ describe 'private convert methods' do
+   it 'conv_tax' do
      i = ItemWithoutFields.new
-     i.conv_tax.should == 0
+     i.send(:conv_tax).should == 0
    end
-   it 'should have conv_discount' do
+   it 'conv_price_single' do
      i = ItemWithoutFields.new
-     i.conv_discount.should == 0
+     i.send(:conv_price_single).should == 0
+   end
+
+   it 'rounds to max 6 conv_price_single' do
+     i = ItemWithoutFields.new
+     i.price_single = 1.12345678
+     i.send(:conv_price_single).to_f.should == 1.123457
+   end
+
+   it 'conv_discount' do
+     i = ItemWithoutFields.new
+     i.send(:conv_discount).should == 0
    end
  end
+
  describe 'item calculations' do
 
     before :each do
@@ -96,10 +108,6 @@ describe SK::Calc do
       @i.tax_total_base.should == 2.39495
     end
 
-    it "should calc tax_total_4" do
-      @i.tax_total_4.should == 2.395
-    end
-
     it "should calc tax_total" do
       @i.tax_total.should == 2.39
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sk_calc
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 1.0.0
 platform: ruby
 authors:
 - Georg Leciejewski
@@ -39,20 +39,6 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: rdoc
-  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: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -86,17 +72,15 @@ description: Calculate document and line item totals. This moule is used inside
 email: gl@salesking.eu
 executables: []
 extensions: []
-extra_rdoc_files:
-- README.rdoc
+extra_rdoc_files: []
 files:
 - .gitignore
 - .travis.yml
 - Gemfile
 - LICENSE
-- README.rdoc
+- README.md
 - Rakefile
 - lib/sk_calc.rb
-- lib/sk_calc/helper.rb
 - lib/sk_calc/item.rb
 - lib/sk_calc/items.rb
 - lib/sk_calc/version.rb
@@ -123,7 +107,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.11
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: SalesKing Calculation Module

data/lib/sk_calc/helper.rb

@@ -1,28 +0,0 @@
-# Helper methods to
-# - convert empty or integer values into BigDecimals
-module SK::Calc::Helper
-
-  private
-
-  # Init price single with 0 if nil and cast to BigDecimal
-  # == Return
-  # <BigDecimal>
-  def conv_price_single
-    to_bd(price_single || 0)
-  end
-
-  # Init tax with 0 if nil and cast to BigDecimal
-  # == Return
-  # <BigDecimal>
-  def conv_tax
-    to_bd( (self.respond_to?(:tax) && tax) || 0)
-  end
-
-  # Cast a val to BigDecimal
-  # == Return
-  # <BigDecimal>
-  def to_bd(val)
-    val.is_a?(BigDecimal) ? val : BigDecimal.new("#{val}")
-  end
-
-end