sk_calc 0.0.1

data/.gitignore

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

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,36 @@
+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/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2011 Michael Bumann
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,32 @@
+= SalesKing Calculation
+
+Why?
+
+1. We have had enough of "How do you calculate?"-Questions
+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. 
+
+You can take advantage of this lib for example when using our API and 
+mixing it into your local classes.
+
+
+== Install
+
+  gem install sk_calc
+
+
+== Classes
+
+
+== Usage
+
+Comming ..
+
+  require 'sk_calc'
+
+== Tests
+
+Copyright (c) 2011 Georg Leciejewski, released under the MIT license

data/Rakefile

@@ -0,0 +1,35 @@
+#!/usr/bin/env rake
+require 'rake'
+require 'rdoc/task'
+require 'rspec'
+require 'rspec/core/rake_task'
+
+desc 'Default: run specs.'
+task :default => :spec
+
+desc "Run specs"
+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 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'
+  rdoc.title    = 'SalesKing Calculation'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  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/VERSION

@@ -0,0 +1 @@
+0.0.1

data/ci/Gemfile

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

data/lib/sk_calc.rb

@@ -0,0 +1,35 @@
+require 'bigdecimal'
+require "active_support/core_ext/enumerable"
+module SK
+  # calculation module
+  # == Usage
+  #
+  #   class LineItem
+  #     calculates :item
+  #   end
+  #
+  #   class Invoice
+  #     calculates :items
+  #   end
+  module Calc
+
+    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
+
+      def calculates(kind, opts={})
+        include Item if kind == :item
+        include Items if kind == :items
+      end
+    end
+
+    module InstanceMethods; end
+
+  end
+end

data/lib/sk_calc/helper.rb

@@ -0,0 +1,29 @@
+# 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(tax || 0)
+  end
+  
+  # Cast a val to BigDecimal
+  # == Return
+  # <BigDecimal>
+  def to_bd(val)    
+    val.is_a?(BigDecimal) ? val : BigDecimal.new("#{val}") 
+  end
+
+end

data/lib/sk_calc/item.rb

@@ -0,0 +1,163 @@
+# Calculate totals for a single item
+# Including class MUST respond to:
+#
+# - discount
+# - price_single
+# - quantity
+# - tax
+#
+# == Information
+#
+# base data
+#   price_single
+#   quantity
+#   discount %
+#   tax %
+#
+# unrounded calculations
+#   total               price_single * quantity
+#   net_total_base      total * discount
+#   tax_total_base      net_total_base * tax
+#
+# rounded calculations
+#   net_total
+#   tax_total
+#   gross_total
+#
+# informative: should not be used in totals calc
+#   net_single
+#   gross_single
+#   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
+  ############################################
+  ### These values are used for calculations.
+  ### Use values under DISPLAY VALUES section
+  ### for displaying values to the end user!
+
+  # 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>::
+  def net_total_base
+    (100 - discount) * total / 100
+  end
+
+  # ==== Returns
+  # <BigDecimal>:: total amount of tax
+  def tax_total_base
+    (net_total_base * conv_tax) / 100
+  end
+
+  # 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
+  def net_single_base
+    conv_price_single * ( 1 - (discount / 100 ) )
+  end
+
+  def gross_single_base
+    net_single_base * ( 1 + conv_tax / 100)
+  end
+
+  # Total gross price incl. discount
+  # ==== Returns
+  # <BigDecimal>:: total gross base
+  def gross_total_base
+    net_total_base + tax_total_base
+  end
+
+  # The discount amount unrounded
+  # ==== Returns
+  # <BigDecimal>:: rounded
+  def discount_total_base
+    total * (discount / 100)
+  end
+
+  # Unrounded item total price * quantity, excl discount
+  # Use it to do calculations!
+  # ==== Returns
+  # <BigDecimal>::
+  def total
+    conv_price_single * ( quantity || 0)
+  end
+
+  ############################################
+  ### DISPLAY VALUES
+  ############################################
+  ### These values are used only to display to a user.
+  ### Use values under BASE VALUES section
+  ### for calculations!
+
+  # Total gross price incl. discount
+  # ==== Returns
+  # <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
+  def net_total
+    net_total_base.round(2)
+  end
+
+
+  # ==== Returns
+  # <BigDecimal>:: rounded 2 decimals
+  def tax_total
+    tax_total_base.round(2)
+  end
+
+  # The discount amount
+  # ==== Returns
+  # <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
+  def net_single
+    net_single_base.round(2)
+  end
+
+  # 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
+  def gross_single
+    gross_single_base.round(2)
+  end
+
+
+  private
+
+  # Init price single with 0 if nil and cast to BigDecimal
+  # == Return
+  # <BigDecimal>
+  def conv_price_single
+    to_bd(price_single || 0)
+  end
+
+end

data/lib/sk_calc/items.rb

@@ -0,0 +1,84 @@
+# 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
+  # Gross total always rounded to 2 decimals
+  def gross_total
+    val = (net_total_base || 0) + conv_tax
+    val.round(2)
+  end
+
+  # Net total rounded to 2 decimals, the taxation base
+  def net_total
+    net_total_base.round(2)
+  end
+
+  # Unrounded net total so one can see the base sum of the line items before
+  # rounding
+  def net_total_base
+    conv_price_total
+  end
+
+  # Rounded price_tax to 2 decimals
+  def tax_total
+    conv_tax.round(2)
+  end
+
+  # Save items sums of net total and summed taxes into the price_total,
+  # tax_total
+  def sum_items(items=nil)
+    items ||= line_items
+    # Sum up all the total prices of the items.
+    # .to_a to get out of activerecord collection into enum
+    self.price_total = items.to_a.sum(&:net_total_base)
+    # Sum up the tax, but use the tax_grouped to prevent rounding errors
+    self.price_tax = tax_grouped(items).sum { |tax_group| tax_group[1] }
+  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
+  # 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)
+  #
+  #
+  # Sum up the price_total and calculate the tax -
+  # don't sum price_tax because of rounding errors!
+  #
+  def tax_grouped(items=nil)
+    items ||= line_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) unless tax.zero?
+    end
+    result.sort
+  end
+
+  private
+
+  # Init price single with 0 if nil and cast to 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>
+  def conv_tax
+    to_bd(price_tax || 0)
+  end
+end

data/lib/sk_calc/version.rb

@@ -0,0 +1,5 @@
+module SK
+  module Calc
+    VERSION = "0.0.1"
+  end
+end

data/sk_calc.gemspec

@@ -0,0 +1,33 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+require 'sk_calc/version'
+
+Gem::Specification.new do |s|
+  s.name = %q{sk_calc}
+  s.version = SK::Calc::VERSION
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Georg Leciejewski"]
+  s.date = %q{2011-12-17}
+  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")
+
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.6.2}
+  s.summary = %q{SalesKing Calculation Module}
+
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'rcov'
+  s.add_development_dependency 'rdoc'
+  s.add_development_dependency 'activesupport'
+  s.add_development_dependency 'rake', '>= 0.9.2'
+
+end
+

data/spec/sk_calc/item_spec.rb

@@ -0,0 +1,88 @@
+require 'spec_helper'
+
+class LineItem
+  include SK::Calc
+  attr_accessor :price_single, :tax, :quantity, :discount
+  calculates :item
+end
+
+describe SK::Calc do
+
+ describe 'item calculations' do
+
+    before :each do
+      @i = LineItem.new
+      @i.price_single = 10.0
+      @i.discount = 0
+      @i.quantity = 1
+      @i.tax = 19.0
+    end
+
+    it "should calc net_single" do
+      @i.net_single.should == 10.00
+    end
+
+    it "should calc gross_single" do
+      @i.gross_single.should == 11.90
+    end
+
+    it "should calc total" do
+      @i.total.should == 10.0
+    end
+
+    it "should calc net_total" do
+      @i.net_total.should == 10.0
+    end
+
+    it "should calc gross_total" do
+      @i.gross_total.should == 11.90
+    end
+
+    it "should calc net_total_base" do
+      @i.net_total_base.should == 10.00
+    end
+
+    it "should calc tax_total" do
+      @i.tax_total.should == 1.90
+    end
+  end
+
+  describe 'calculates 15.00 gross price' do
+
+    before :each do
+      @i = LineItem.new
+      @i.price_single = 12.605
+      @i.discount = 0
+      @i.quantity = 1
+      @i.tax = 19.0
+    end
+
+    it "should calc total" do
+      @i.total.should == 12.605
+    end
+
+    it "should calc net_total" do
+      @i.net_total.to_f.should == 12.61
+    end
+
+    it "should calc gross_total" do
+      @i.gross_total.should == 15.0
+    end
+
+    it "should calc net_total_base" do
+      @i.net_total_base.should == 12.605
+    end
+    it "should calc net_total" do
+      @i.net_total.should == 12.61
+    end
+
+    it "should calc tax_total_base" do
+      @i.tax_total_base.should == 2.39495
+    end
+
+    it "should calc tax_total" do
+      @i.tax_total.should == 2.39
+    end
+
+  end
+end

data/spec/sk_calc/items_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+
+class LineItem
+  include SK::Calc
+  attr_accessor :price_single, :tax, :quantity, :discount
+  calculates :item
+end
+
+class Doc
+  include SK::Calc
+  attr_accessor :price_total, :price_tax, :line_items, :precision
+  calculates :items
+end
+
+describe SK::Calc, 'items calculations' do
+
+  before :each do
+    @i = LineItem.new
+    @i.price_single = 10.0
+    @i.discount = 0
+    @i.quantity = 1
+    @i.tax = 19.0
+    
+    @doc = Doc.new
+    @doc.line_items = [@i]
+    
+    
+  end
+
+  it "should calc net_total" do
+    @doc.sum_items
+    @doc.net_total.should == 10.0
+  end
+
+  it "should calc gross_total" do
+    @doc.sum_items
+    @doc.gross_total.should == 11.90
+  end
+
+  it "should sum totals" do
+    @doc.sum_items
+    @doc.price_total.should == 10.0
+    @doc.price_tax.should == 1.90
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'rubygems'
+require 'yaml'
+require 'rspec'
+require "active_support"
+require "#{File.dirname(__FILE__)}/../lib/sk_calc"

metadata

@@ -0,0 +1,152 @@
+--- !ruby/object:Gem::Specification 
+name: sk_calc
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Georg Leciejewski
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-12-17 00:00:00 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"
+  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"
+  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"
+  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"
+  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: 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.
+email: gl@salesking.eu
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- ci/Gemfile
+- lib/sk_calc.rb
+- lib/sk_calc/helper.rb
+- lib/sk_calc/item.rb
+- lib/sk_calc/items.rb
+- lib/sk_calc/version.rb
+- sk_calc.gemspec
+- spec/sk_calc/item_spec.rb
+- spec/sk_calc/items_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/salesking/sk_calc
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+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"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: SalesKing Calculation Module
+test_files: []
+