sk_calc 0.0.3 → 0.0.4

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MWE1ZTA5MmYzYjE5MjM4NmRmNjA1ZTk1YWJjMTkxN2QzYTI0YmExYQ==
+  data.tar.gz: !binary |-
+    MjEzY2E4NTgwNjhmNmNkNTI1M2FmYzU2NjEyZDhkNmUxY2IwYjBmYw==
+SHA512:
+  metadata.gz: !binary |-
+    NjIzZmU0YTk5YmRlNTJhMTUzYTFmZmY4ODdkNTllN2ZkYzE4YTI2NDdmOGE1
+    MDNlNjkxZTdiNzhiMTU0YzQzYzliOTU2ODRmN2EzN2Y4MDU0NzQ5YTUyNzFm
+    YTZmYjUyMzc2NjliYjNkYThhNGMwYTk5YTk5MjgyNzNmZWE4OTc=
+  data.tar.gz: !binary |-
+    NTA5MzdhMDM3ZjY2YmQyNGJhYjY3OTg0MDc5NjUxYmMyMTc0MGQ4MjM5MmU2
+    N2U5NTRjNGM3ZTQ4Y2Y3MmU4ZTQ4MjM1MjI5MWE4ZmQwN2U5YzMzYWUwM2Ey
+    MjUyN2QzYjk3YmZmZmMwMWQyMDZiYzczYjRiZWUyNTIwMzgxOGQ=

data/.gitignore

@@ -1,9 +1,6 @@
 .rvmrc
-nbproject/*
 coverage/*
 rdoc/*
 pkg/*
-ci/Gemfile.lock
-ci/vendor
-ci/.bundle
+Gemfile.lock
 spec/settings.yml

data/.travis.yml

@@ -0,0 +1,4 @@
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3

data/Gemfile

@@ -1,4 +1,2 @@
 source 'https://rubygems.org'
-
-# Specify your gem's dependencies in ..gemspec
 gemspec

data/README.rdoc

@@ -1,4 +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]
 
 Why?
 
@@ -6,10 +7,10 @@ Why?
 2. Ever stumbled upon rounding problems, when calculating totals?
 3. Wouldn't it be nice to change a calculation strategy?
 
-We decided to open-source this part, so everybody can transparently see 
-how we calculate item and document totals. 
+We decided to open-source this part, so everybody can transparently see
+how we calculate item and document totals.
 
-You can take advantage of this lib for example when using our API and 
+You can take advantage of this lib for example when using our API and
 mixing it into your local classes.
 
 
@@ -18,12 +19,9 @@ mixing it into your local classes.
   gem install sk_calc
 
 
-== Classes
-
-
 == Usage
 
-Comming ..
+read spec/sk_calc/*.rb to see examples
 
   require 'sk_calc'
 

data/Rakefile

@@ -3,6 +3,7 @@ require 'rake'
 require 'rdoc/task'
 require 'rspec'
 require 'rspec/core/rake_task'
+require 'bundler/gem_tasks'
 
 desc 'Default: run specs.'
 task :default => :spec
@@ -13,13 +14,6 @@ RSpec::Core::RakeTask.new do |t|
   # Put spec opts in a file named .rspec in root
 end
 
-desc "Generate code coverage"
-RSpec::Core::RakeTask.new(:coverage) do |t|
-  t.pattern = "./spec/**/*_spec.rb" # don't need this, it's default.
-  t.rcov = true
-  t.rcov_opts = ['--exclude', 'spec']
-end
-
 desc 'Generate documentation.'
 Rake::RDocTask.new(:rdoc) do |rdoc|
   rdoc.rdoc_dir = 'rdoc'
@@ -29,7 +23,3 @@ Rake::RDocTask.new(:rdoc) do |rdoc|
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
-#require "bundler/gem_tasks"
-########### to be dropped when we go public
-require "bundler/gem_helper"
-Bundler::GemHelper.install_tasks

data/lib/sk_calc/helper.rb

@@ -2,7 +2,6 @@
 # - convert empty or integer values into BigDecimals
 module SK::Calc::Helper
 
-
   private
 
   # Init price single with 0 if nil and cast to BigDecimal
@@ -18,12 +17,12 @@ module SK::Calc::Helper
   def conv_tax
     to_bd(tax || 0)
   end
-  
+
   # Cast a val to BigDecimal
   # == Return
   # <BigDecimal>
-  def to_bd(val)    
-    val.is_a?(BigDecimal) ? val : BigDecimal.new("#{val}") 
+  def to_bd(val)
+    val.is_a?(BigDecimal) ? val : BigDecimal.new("#{val}")
   end
 
 end

data/lib/sk_calc/item.rb

@@ -49,14 +49,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
-  # ==== Returns
-  # <BigDecimal>::
+  # @return [BigDecimal]
   def net_total_base
-    (100 - discount) * total / 100
+    (100 - (discount||0)) * total / 100
   end
 
-  # ==== Returns
-  # <BigDecimal>:: total amount of tax
+  # @return [BigDecimal] total amount of tax
   def tax_total_base
     (net_total_base * conv_tax) / 100
   end
@@ -64,10 +62,9 @@ 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
-  # ==== Returns
-  # <BigDecimal>:: rounded 2 decimals
+  # @return [BigDecimal] rounded 2 decimals
   def net_single_base
-    conv_price_single * ( 1 - (discount / 100 ) )
+    conv_price_single * ( 1 - ((discount||0) / 100 ) )
   end
 
   def gross_single_base
@@ -75,23 +72,20 @@ module SK::Calc::Item
   end
 
   # Total gross price incl. discount
-  # ==== Returns
-  # <BigDecimal>:: total gross base
+  # @return [BigDecimal] total gross base
   def gross_total_base
     net_total_base + tax_total_base
   end
 
   # The discount amount unrounded
-  # ==== Returns
-  # <BigDecimal>:: rounded
+  # @return [BigDecimal] rounded
   def discount_total_base
-    total * (discount / 100)
+    total * ((discount||0) / 100)
   end
 
   # Unrounded item total price * quantity, excl discount
   # Use it to do calculations!
-  # ==== Returns
-  # <BigDecimal>::
+  # @return [BigDecimal]
   def total
     conv_price_single * ( quantity || 0)
   end
@@ -104,39 +98,32 @@ module SK::Calc::Item
   ### for calculations!
 
   # Total gross price incl. discount
-  # ==== Returns
-  # <BigDecimal>:: rounded 2 decimals
+  # @return [BigDecimal] rounded 2 decimals
   def gross_total
     gross_total_base.round(2)
   end
 
   # Total net price(2 decimals) incl. discount
-  # ==== Returns
-  # <BigDecimal>:: rounded 2 decimals
+  # @return [BigDecimal] rounded 2 decimals
   def net_total
     net_total_base.round(2)
   end
 
-
-  # ==== Returns
-  # <BigDecimal>:: rounded 2 decimals
+  # @return [BigDecimal] rounded 2 decimals
   def tax_total
     tax_total_base.round(2)
   end
 
   # The discount amount
-  # ==== Returns
-  # <BigDecimal>:: rounded 2 decimals
+  # @return [BigDecimal] rounded 2 decimals
   def discount_total
     discount_total_base.round(2)
   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
-  # ==== Returns
-  # <BigDecimal>:: rounded 2 decimals
+  # @return [BigDecimal] rounded 2 decimals
   def net_single
     net_single_base.round(2)
   end
@@ -144,8 +131,7 @@ 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
-  # ==== Returns
-  # <BigDecimal>:: rounded 2 decimals
+  # @return [BigDecimal] rounded 2 decimals
   def gross_single
     gross_single_base.round(2)
   end
@@ -158,29 +144,25 @@ module SK::Calc::Item
   ### for calculations!
 
   # Total gross price incl. discount
-  # ==== Returns
-  # <BigDecimal>:: rounded 2 decimals
+  # @return [BigDecimal] rounded 2 decimals
   def gross_total_4
     gross_total_base.round(4)
   end
 
-  # Total net price(2 decimals) incl. discount
-  # ==== Returns
-  # <BigDecimal>:: rounded 2 decimals
+  # Total net price
+  # @return [BigDecimal] rounded 4 decimals
   def net_total_4
     net_total_base.round(4)
   end
 
 
-  # ==== Returns
-  # <BigDecimal>:: rounded 2 decimals
+  # @return [BigDecimal] rounded 4 decimals
   def tax_total_4
     tax_total_base.round(4)
   end
 
   # The discount amount
-  # ==== Returns
-  # <BigDecimal>:: rounded 2 decimals
+  # @return [BigDecimal] rounded 4 decimals
   def discount_total_4
     discount_total_base.round(4)
   end
@@ -189,8 +171,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
-  # ==== Returns
-  # <BigDecimal>:: rounded 2 decimals
+  # @return [BigDecimal] rounded 4 decimals
   def net_single_4
     net_single_base.round(4)
   end
@@ -198,8 +179,7 @@ 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
-  # ==== Returns
-  # <BigDecimal>:: rounded 2 decimals
+  # @return [BigDecimal] rounded 4 decimals
   def gross_single_4
     gross_single_base.round(4)
   end
@@ -207,8 +187,7 @@ module SK::Calc::Item
   private
 
   # Init price single with 0 if nil and cast to BigDecimal
-  # == Return
-  # <BigDecimal>
+  # @return [BigDecimal]
   def conv_price_single
     to_bd(price_single || 0)
   end

data/lib/sk_calc/items.rb

@@ -1,44 +1,54 @@
 # Calculate totals for a multiple items eg in an invoice
 # Including class MUST respond to:
 # - price_total
-# - precision
 # - price_tax
 # - line_items
 module SK::Calc::Items
   include SK::Calc::Helper
 
-  # Unrounded net total so one can see the base sum of the line items before
-  # rounding
+  # Unrounded net total the taxation base
+  # @return [BigDecimal]
   def net_total_base
     conv_price_total
   end
 
-  # Gross total
+  # Gross total unrounded
+  # @return [BigDecimal]
   def gross_total_base
-    (net_total_base || 0) + conv_tax
+    (net_total_base || 0) + tax_total_base
   end
 
-  # Net total rounded to 2 decimals, the taxation base
+  # Net total rounded to 2 decimals
   def net_total
     net_total_base.round(2)
   end
 
   # Gross total rounded to 2 decimals
+  # @return [BigDecimal]
   def gross_total
     gross_total_base.round(2)
   end
 
-  # Rounded price_tax to 2 decimals
+  # Tax total rounded price_tax to 2 decimals
+  # @return [BigDecimal]
+  def tax_total_base
+    conv_tax
+  end
+
+  # Tax total rounded price_tax to 2 decimals
+  # @return [BigDecimal]
   def tax_total
     conv_tax.round(2)
   end
 
-  # Net total rounded to 2 decimals, the taxation base
+  # Net total rounded to 4 decimals
+  # @return [BigDecimal]
   def net_total_4
     net_total_base.round(4)
   end
 
-  # Rounded price_tax to 2 decimals
+  # Rounded price_tax to 4 decimals
+  # @return [BigDecimal]
   def tax_total_4
     conv_tax.round(4)
   end
@@ -55,22 +65,23 @@ module SK::Calc::Items
   end
 
   # Sums up the tax price of the line items, grouped by tax
-  # Results a sorted hash (=array) like [ [ 7, 3.50 ], [ 19, 47.50 ] ]
-  #==Example
-  # a sorted array like [ [ 7, 3.50 ], [ 19, 47.50 ] ] for each price/tax combination
+  #
+  # @example
+  # Sums up the price_total and calculate the tax -does not sum price_tax
+  # because of rounding errors!
+  # Returns a sorted sorted hash
+  #   { [ 7, 3.50 ], [ 19, 47.50 ] } for each price/tax combination
   # So if you are using two kinds of tax (7%/19%) in an document:
   #
   # [0] =>
   #       [0] => 7      # the tax percentage
   #       [1] => 14.00  # tax sum of all line item with this tax (items summ is 200.00)
   # [1] =>
-  #       [0] => 19   # the tax percentage
-  #       [1] => 57   # tax sum of all line item with this tax(items sum = 300)
-  #
+  #       [0] => 19
+  #       [1] => 57   #(items sum = 300)
   #
-  # Sum up the price_total and calculate the tax -
-  # don't sum price_tax because of rounding errors!
   #
+  # @return [Hash]
   def tax_grouped(items=nil)
     items ||= line_items
     result = {}
@@ -84,15 +95,13 @@ module SK::Calc::Items
   private
 
   # Init price single with 0 if nil and cast to BigDecimal
-  # == Return
-  # <BigDecimal>
+  # @return [BigDecimal]
   def conv_price_total
     to_bd(price_total || 0)
   end
 
   # Init tax with 0 if nil and cast to BigDecimal .. same in helper
-  # == Return
-  # <BigDecimal>
+  # @return [BigDecimal]
   def conv_tax
     to_bd(price_tax || 0)
   end

data/lib/sk_calc/version.rb

@@ -1,5 +1,5 @@
 module SK
   module Calc
-    VERSION = "0.0.3"
+    VERSION = '0.0.4'
   end
 end

data/lib/sk_calc.rb

@@ -1,5 +1,5 @@
 require 'bigdecimal'
-require "active_support/core_ext/enumerable"
+require 'active_support/core_ext/enumerable'
 module SK
   # calculation module
   # == Usage

data/sk_calc.gemspec

@@ -24,7 +24,7 @@ Gem::Specification.new do |s|
   s.summary = %q{SalesKing Calculation Module}
 
   s.add_development_dependency 'rspec'
-  s.add_development_dependency 'rcov'
+  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/spec_helper.rb

@@ -1,5 +1,13 @@
-require 'rubygems'
+# encoding: utf-8
+require 'simplecov'
 require 'yaml'
 require 'rspec'
-require "active_support"
+require 'active_support'
+
+SimpleCov.start do
+  root File.join(File.dirname(__FILE__), '..')
+  add_filter "/bin/"
+  add_filter "/spec/"
+end
+
 require "#{File.dirname(__FILE__)}/../lib/sk_calc"

metadata

@@ -1,112 +1,100 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: sk_calc
-version: !ruby/object:Gem::Version 
-  hash: 25
-  prerelease: 
-  segments: 
-  - 0
-  - 0
-  - 3
-  version: 0.0.3
+version: !ruby/object:Gem::Version
+  version: 0.0.4
 platform: ruby
-authors: 
+authors:
 - Georg Leciejewski
-- "Mike Po\xC5\x82tyn"
+- Mike Połtyn
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-02-15 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-02-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rspec
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: rcov
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: rdoc
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !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
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: activesupport
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  name: rake
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 63
-        segments: 
-        - 0
-        - 9
-        - 2
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 0.9.2
   type: :development
-  version_requirements: *id005
-description: Calculate document and line item totals. This moule is used inside SalesKIng and outsourced for transparency and reusability.
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+description: Calculate document and line item totals. This moule is used inside SalesKIng
+  and outsourced for transparency and reusability.
 email: gl@salesking.eu
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - README.rdoc
-files: 
+files:
 - .gitignore
+- .travis.yml
 - Gemfile
-- Gemfile.lock
 - LICENSE
 - README.rdoc
 - Rakefile
-- VERSION
-- ci/Gemfile
 - lib/sk_calc.rb
 - lib/sk_calc/helper.rb
 - lib/sk_calc/item.rb
@@ -118,38 +106,25 @@ files:
 - spec/spec_helper.rb
 homepage: http://github.com/salesking/sk_calc
 licenses: []
-
+metadata: {}
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+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: 1.8.6
+rubygems_version: 2.1.11
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: SalesKing Calculation Module
-test_files: 
-- spec/sk_calc/item_spec.rb
-- spec/sk_calc/items_spec.rb
-- spec/spec_helper.rb
+test_files: []

data/Gemfile.lock

@@ -1,36 +0,0 @@
-PATH
-  remote: .
-  specs:
-    sk_calc (0.0.1)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    activesupport (3.1.3)
-      multi_json (~> 1.0)
-    diff-lcs (1.1.3)
-    json (1.6.4)
-    multi_json (1.0.4)
-    rake (0.9.2.2)
-    rcov (0.9.11)
-    rdoc (3.12)
-      json (~> 1.4)
-    rspec (2.7.0)
-      rspec-core (~> 2.7.0)
-      rspec-expectations (~> 2.7.0)
-      rspec-mocks (~> 2.7.0)
-    rspec-core (2.7.1)
-    rspec-expectations (2.7.0)
-      diff-lcs (~> 1.1.2)
-    rspec-mocks (2.7.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  activesupport
-  rake (>= 0.9.2)
-  rcov
-  rdoc
-  rspec
-  sk_calc!

data/VERSION

@@ -1 +0,0 @@
-0.0.3

data/ci/Gemfile

@@ -1,8 +0,0 @@
-source :gemcutter
-gem "rake"
-gem "rdoc"
-gem "rcov"
-gem "activesupport"
-group :test do
-  gem "rspec"
-end