death_and_taxes 0.0.3 → 0.0.4

data/Gemfile.lock

@@ -1,74 +1,96 @@
 PATH
   remote: .
   specs:
-    death_and_taxes (0.0.0)
+    death_and_taxes (0.0.3)
       rails
 
 GEM
   remote: http://rubygems.org/
   specs:
-    abstract (1.0.0)
-    actionmailer (3.0.9)
-      actionpack (= 3.0.9)
-      mail (~> 2.2.19)
-    actionpack (3.0.9)
-      activemodel (= 3.0.9)
-      activesupport (= 3.0.9)
-      builder (~> 2.1.2)
-      erubis (~> 2.6.6)
-      i18n (~> 0.5.0)
-      rack (~> 1.2.1)
-      rack-mount (~> 0.6.14)
-      rack-test (~> 0.5.7)
-      tzinfo (~> 0.3.23)
-    activemodel (3.0.9)
-      activesupport (= 3.0.9)
-      builder (~> 2.1.2)
-      i18n (~> 0.5.0)
-    activerecord (3.0.9)
-      activemodel (= 3.0.9)
-      activesupport (= 3.0.9)
-      arel (~> 2.0.10)
-      tzinfo (~> 0.3.23)
-    activeresource (3.0.9)
-      activemodel (= 3.0.9)
-      activesupport (= 3.0.9)
-    activesupport (3.0.9)
-    arel (2.0.10)
-    builder (2.1.2)
-    erubis (2.6.6)
-      abstract (>= 1.0.0)
-    i18n (0.5.0)
-    mail (2.2.19)
-      activesupport (>= 2.3.6)
+    actionmailer (3.1.0.rc5)
+      actionpack (= 3.1.0.rc5)
+      mail (~> 2.3.0)
+    actionpack (3.1.0.rc5)
+      activemodel (= 3.1.0.rc5)
+      activesupport (= 3.1.0.rc5)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      i18n (~> 0.6)
+      rack (~> 1.3.1)
+      rack-cache (~> 1.0.2)
+      rack-mount (~> 0.8.1)
+      rack-test (~> 0.6.0)
+      sprockets (~> 2.0.0.beta.12)
+    activemodel (3.1.0.rc5)
+      activesupport (= 3.1.0.rc5)
+      bcrypt-ruby (~> 2.1.4)
+      builder (~> 3.0.0)
+      i18n (~> 0.6)
+    activerecord (3.1.0.rc5)
+      activemodel (= 3.1.0.rc5)
+      activesupport (= 3.1.0.rc5)
+      arel (~> 2.1.4)
+      tzinfo (~> 0.3.29)
+    activeresource (3.1.0.rc5)
+      activemodel (= 3.1.0.rc5)
+      activesupport (= 3.1.0.rc5)
+    activesupport (3.1.0.rc5)
+      multi_json (~> 1.0)
+    arel (2.1.4)
+    bcrypt-ruby (2.1.4)
+    builder (3.0.0)
+    diff-lcs (1.1.3)
+    erubis (2.7.0)
+    hike (1.2.0)
+    i18n (0.6.0)
+    mail (2.3.0)
       i18n (>= 0.4.0)
       mime-types (~> 1.16)
       treetop (~> 1.4.8)
     mime-types (1.16)
+    multi_json (1.0.3)
     polyglot (0.3.2)
-    rack (1.2.3)
-    rack-mount (0.6.14)
+    rack (1.3.2)
+    rack-cache (1.0.2)
+      rack (>= 0.4)
+    rack-mount (0.8.2)
       rack (>= 1.0.0)
-    rack-test (0.5.7)
+    rack-ssl (1.3.2)
+      rack
+    rack-test (0.6.1)
       rack (>= 1.0)
-    rails (3.0.9)
-      actionmailer (= 3.0.9)
-      actionpack (= 3.0.9)
-      activerecord (= 3.0.9)
-      activeresource (= 3.0.9)
-      activesupport (= 3.0.9)
+    rails (3.1.0.rc5)
+      actionmailer (= 3.1.0.rc5)
+      actionpack (= 3.1.0.rc5)
+      activerecord (= 3.1.0.rc5)
+      activeresource (= 3.1.0.rc5)
+      activesupport (= 3.1.0.rc5)
       bundler (~> 1.0)
-      railties (= 3.0.9)
-    railties (3.0.9)
-      actionpack (= 3.0.9)
-      activesupport (= 3.0.9)
+      railties (= 3.1.0.rc5)
+    railties (3.1.0.rc5)
+      actionpack (= 3.1.0.rc5)
+      activesupport (= 3.1.0.rc5)
+      rack-ssl (~> 1.3.2)
       rake (>= 0.8.7)
       rdoc (~> 3.4)
-      thor (~> 0.14.4)
+      thor (~> 0.14.6)
     rake (0.9.2)
-    rdoc (3.9.1)
+    rdoc (3.9.2)
+    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)
+    sprockets (2.0.0.beta.13)
+      hike (~> 1.2)
+      rack (~> 1.0)
+      tilt (!= 1.3.0, ~> 1.1)
     sqlite3 (1.3.4)
     thor (0.14.6)
+    tilt (1.3.2)
     treetop (1.4.10)
       polyglot
       polyglot (>= 0.3.1)
@@ -79,4 +101,5 @@ PLATFORMS
 
 DEPENDENCIES
   death_and_taxes!
+  rspec
   sqlite3

data/README.rdoc

@@ -1,8 +1,77 @@
-= death_and_taxes
+Death And Taxes
+===============
 
-Description goes here.
+> "In this world nothing can be said to be certain, 
+> except death and taxes." - Benjamin Franklin
 
-== Contributing to death_and_taxes
+
+Death And Taxes is a gem for ActiveRecord that makes it easier to handle Tax handling.
+
+
+DeathAndTaxes
+-------------
+
+If you want to se the taxes that are in the config file, you can use DeathAndTaxes.applicable_taxes 
+
+    DeathAndTaxes.applicable_taxes({:country => "ca", :state => "qc"}, {:country => "ca", :state => "qc"}, Date.today)
+    #=> ["GST", "QST"]
+
+To obtain the tax itself you can user DeathAndTaxes.build 
+
+    DeathAndTaxes.build "QST", Date.today
+    #=> #<DeathAndTaxes::Tax percentage: 8.5, name: "QST" ...>
+
+
+Tax
+---
+
+The tax model should have a name and a percentage. You configure them in the config/#{country}.yml file if you wish to use the _DeathAndTaxes::applicable\_taxes_ method.
+
+Taxes can be applied on another tax (like in Quebec before 2012) by having a tax itself.
+
+You can obtain the effective rate of a tax (after being compounded) by using
+
+    tax.multiplier
+
+Taxable
+-------
+
+You can make ActiveRecord models taxable. The taxable models must respond to 'amount'
+
+
+    class Product < ActiveRecord::Base
+      acts_as_taxable
+    end
+
+
+Taxable models have a method apply_taxes which applies the correct taxes as taxations.
+
+    product = Product.create :name => "Toto", :amount => 100
+    product.apply_taxes [DeathAndTaxes::Tax.new(:name => "GST", :percentage => 7)]
+    product.taxations
+    #=> [#<DeathAndTaxes::Taxation amount: 7, percentage: 7.0, name: "GST" ...>]
+
+
+Taxer
+-----
+
+Taxer model can have taxes associated. 
+    
+    class Organization < ActiveRecord::Base
+      acts_as_taxer
+    end
+    
+    organization.taxes << DeathAndTaxes::Tax.new(:name => "GST", :percentage => 7)
+
+
+Testing
+-------
+
+    rspec spec/test_death_and_taxes.rb
+
+
+Contributing to death_and_taxes
+===============================
  
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
 * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
@@ -12,7 +81,8 @@ Description goes here.
 * Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
 * Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
 
-== Copyright
+Copyright
+=========
 
 Copyright (c) 2011 Guillaume Malette. See LICENSE.txt for
 further details.

data/config/ca.yml

@@ -2,32 +2,36 @@ taxes:
   GST:
     versions:
       - starts: 2011-01-01
-        ends: 2011-12-31
+        ends: 2013-12-31
         percentage: 5
 
 states:
   qc:
     rules:
-      same_state: [GST, QST]
-      same_country: GST
+      - starts: 0001-01-01
+        ends: 2020-12-31
+        same_state: [GST, QST]
+        same_country: GST
     taxes:
       QST:
-        apply_on: GST
         versions:
           - starts: 2011-01-01
             ends: 2011-12-31
             percentage: 8.5
-        
+            apply_on: GST
+            
           - starts: 2012-01-01
             ends: 2012-12-31
             percentage: 9.5
   
-  on:
+  "on":
     rules:
-      same_country: HST
+      - starts: 0001-01-01
+        ends: 2020-12-31
+        same_country: HST
     taxes:
       HST:
         versions:
           - starts: 2011-01-01
             ends: 2012-12-31
-            percentage: 5
+            percentage: 13

data/death_and_taxes.gemspec

@@ -13,6 +13,7 @@ Gem::Specification.new do |gem|
   
   gem.add_runtime_dependency 'rails'
   gem.add_development_dependency 'sqlite3'
+  gem.add_development_dependency 'rspec'
   
   gem.executables   = []
   gem.files         = `git ls-files`.split("\n")

data/lib/death_and_taxes/country.rb

@@ -18,9 +18,9 @@ module DeathAndTaxes
       end
     end
     
-    def applicable_taxes from, to, date
-      if from[:country] == to[:country] && to[:country] == @code
-        @states[from[:state]].applicable_taxes to[:state], date
+    def applicable_taxes seller, buyer, date
+      if seller[:country] == buyer[:country] && seller[:country] == @code
+        @states[seller[:state]].applicable_taxes buyer[:state], date
       else
         []
       end
@@ -31,7 +31,7 @@ module DeathAndTaxes
     end
     
     def build_tax tax, date
-      @taxes[tax].try(:build, date) || @states.map{|t, s| s.build_tax(tax, date)}
+      @taxes[tax].try(:build, date) || @states.detect{|t, s| s.try(:build_tax, tax, date)}.try(:last).try(:build_tax, tax, date)
     end
   end
 end

data/lib/death_and_taxes/state.rb

@@ -13,15 +13,16 @@ module DeathAndTaxes
       yml['taxes'].each do |tax_name, infos|
         @taxes[tax_name] = TaxInfo.new(tax_name, infos)
       end
-      
+
       @rules = yml['rules']
     end
     
     def applicable_taxes to_state, date
-      taxes = if to_state == @code && @rules['same_state']
-        @rules['same_state']
-      elsif @rules['same_country']
-        @rules['same_country']
+      rule = @rules.select{|d| (d['starts']..d['ends']).cover? date}.first
+      taxes = if to_state == @code && rule['same_state']
+        rule['same_state']
+      elsif rule['same_country']
+        rule['same_country']
       else
         []
       end
@@ -29,7 +30,7 @@ module DeathAndTaxes
     end
     
     def build_tax tax, date
-      if i = @taxes[tax] && i.cover?(date)
+      if (i = @taxes[tax]) && i.cover?(date)
         i.build(date)
       end
     end

data/lib/death_and_taxes/tax_info.rb

@@ -6,20 +6,19 @@ module DeathAndTaxes
     end
     
     def parse yml
-      @apply_on = yml['apply_on']
       @versions = yml['versions'].collect do |version|
         TaxVersion.new(version)
       end
     end
     
     def cover? date
-      @versions.any?{ |version| v.cover? date }
+      @versions.any?{ |v| v.cover? date }
     end
     
     def build date
-      if v = @versions.detect{ |v| v.cover?(date) }
-        t = Tax.new :name => @name, :percentage => v['percentage']
-        t.tax = DeathAndTaxes.build_tax(@apply_on, date) if @apply_on
+      if v = @versions.detect{ |version| version.cover?(date) }
+        t = Tax.new :name => @name, :percentage => v.percentage
+        t.tax = DeathAndTaxes.build(v.apply_on, date) if v.apply_on
         t
       end
     end

data/lib/death_and_taxes/tax_version.rb

@@ -1,17 +1,15 @@
 module DeathAndTaxes
   class TaxVersion
+    attr_reader :starts, :ends, :percentage, :apply_on
     def initialize yml
-      @start = yml['start']
-      @end = yml['end']
+      @starts = yml['starts']
+      @ends = yml['ends']
       @percentage = yml['percentage']
+      @apply_on = yml['apply_on']
     end
     
     def cover? date
-      (@start..@end).cover? date
-    end
-    
-    def build
-      
+      (@starts..@ends).cover? date
     end
   end
 end

data/lib/death_and_taxes/version.rb

@@ -1,3 +1,3 @@
 module DeathAndTaxes
-  VERSION = '0.0.3'
+  VERSION = '0.0.4'
 end

data/lib/death_and_taxes.rb

@@ -3,11 +3,10 @@ require 'active_record/version'
 
 require 'active_support/core_ext'
 
-require File.join(File.dirname(__FILE__), 'death_and_taxes', 'railtie')
 
 module DeathAndTaxes
   %w( Country State Tax Taxable Taxation Taxer TaxInfo TaxVersion ).each do |class_name|
-    autoload class_name.to_sym, File.join(File.dirname(__FILE__), "death_and_taxes/#{class_name.underscore}")
+    require File.join(File.dirname(__FILE__), "death_and_taxes/#{class_name.underscore}")
   end
   
   Dir[File.join(File.dirname(__FILE__), '..', 'config', '*.yml')].each do |filename|
@@ -22,6 +21,9 @@ module DeathAndTaxes
   end
   
   def self.build tax, date
-    @countries.detect {|code, country| country.build_tax(tax, date)}
+    @countries.detect {|code, country| country.build_tax(tax, date)}.try(:last).try(:build_tax, tax, date)
   end
-end
+end
+
+ActiveRecord::Base.send(:include, DeathAndTaxes::Taxable)
+ActiveRecord::Base.send(:include, DeathAndTaxes::Taxer)

data/spec/helper.rb

@@ -0,0 +1,54 @@
+require 'rubygems'
+require 'bundler'
+require 'active_record'
+require 'active_support'
+require 'rake'
+require 'sqlite3'
+
+
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rspec'
+
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'death_and_taxes'
+require 'generators/death_and_taxes/migration/templates/active_record/migration'
+
+db_file = File.join(File.dirname(__FILE__), "death_and_taxes.sqlite3")
+
+File.delete db_file if File.exists? db_file
+
+ActiveRecord::Base.establish_connection(
+  :adapter => "sqlite3",
+  :database => db_file
+)
+
+
+RSpec.configure do |config|
+end
+
+ActiveRecord::Base.connection.execute("DROP TABLE IF EXISTS 'products'")
+ActiveRecord::Base.connection.create_table(:products) do |t|
+  t.string :name
+  t.integer :amount
+end
+
+DeathAndTaxesMigration.up
+
+class Product < ActiveRecord::Base
+  acts_as_taxable
+end
+
+def applicable_taxes from, to, date = nil
+  defaults = {:country => "ca", :state => "qc"}
+  from = defaults.merge from
+  to = defaults.merge to
+  DeathAndTaxes.applicable_taxes from, to, date
+end

data/spec/test_death_and_taxes.rb

@@ -0,0 +1,99 @@
+require 'helper'
+
+describe 'DeathAndTaxes' do
+  describe 'should find the correct taxes' do
+    it 'within Quebec, in 2011' do
+      applicable_taxes({:state => "qc"}, {:state => "qc"}, 
+        Date.new(2011,01,01)).should == ["GST", "QST"]
+    end
+    
+    it 'within Quebec, in 2012' do
+      applicable_taxes({:state => "qc"}, {:state => "qc"}, 
+        Date.new(2012,01,01)).should == ["GST", "QST"]
+    end
+    
+    it 'within Ontario, in 2011' do
+      applicable_taxes({:state => "on"}, {:state => "on"}, 
+        Date.new(2011,01,01)).should == ["HST"]
+    end
+    
+    it 'from Ontario to Quebec, in 2011' do
+      applicable_taxes({:state => "on"}, {:state => "qc"}, 
+        Date.new(2011,01,01)).should == ["HST"]
+    end
+  end
+  
+  describe 'should build the correct taxes' do
+    describe 'within Quebec' do
+      {2011 => 8.5, 2012 => 9.5}.each do |year, percentage|
+        it "in #{year}" do
+          date = Date.new(year,01,01)
+          taxes =  applicable_taxes({:state => "qc"}, {:state => "qc"}, 
+              date).map{|name| DeathAndTaxes::build name, date}
+                    
+          taxes.first.name.should == "GST"
+          taxes.first.percentage.should == 5.0
+    
+          taxes.last.name.should == "QST"
+          taxes.last.percentage.should == percentage
+        end
+      end
+    end
+    
+    it 'from Quebec to Ontario, in 2011' do
+      date = Date.new(2011,01,01)
+      taxes =  applicable_taxes({:state => "qc"}, {:state => "on"}, 
+          date).map{|name| DeathAndTaxes::build name, date}
+      
+      taxes.length.should == 1
+      
+      taxes.first.name.should == "GST"
+      taxes.first.percentage.should == 5.0
+    end
+    
+    it 'from Ontario to Quebec, in 2011' do
+      date = Date.new(2011,01,01)
+      taxes =  applicable_taxes({:state => "on"}, {:state => "qc"}, 
+          date).map{|name| DeathAndTaxes::build name, date}
+      
+      taxes.length.should == 1
+      taxes.first.name.should == "HST"
+      taxes.first.percentage.should == 13
+    end
+  end
+  
+  describe 'applicable_taxes' do
+    it 'should get the correct taxes to apply' do
+      taxes = DeathAndTaxes.applicable_taxes({:country => "ca", :state => "qc"}, {:country => "ca", :state => "qc"}, Date.new(2011, 1, 1))
+      taxes.should == ["GST", "QST"]
+    end
+  end
+  
+  describe 'building taxes' do
+    it 'should build the correct taxes' do
+      tax = DeathAndTaxes.build  "GST", Date.new(2011, 1, 1)
+      tax.name.should == "GST"
+      tax.percentage.should == 5
+      
+      tax = DeathAndTaxes.build  "QST", Date.new(2011, 1, 1)
+      tax.name.should == "QST"
+      tax.percentage.should == 8.5
+    end
+  end
+  
+  describe 'applying taxes' do
+    it 'should create the correct taxations' do
+      product = Product.create(:amount => 100_000)
+      taxes = ["GST", "QST"].map{|name| DeathAndTaxes.build name, Date.new(2011, 1, 1)}
+      product.apply_taxes taxes
+      taxations = product.taxations
+      
+      taxations.first.name.should == "GST"
+      taxations.first.amount.should == 5000
+      
+      taxations.last.name.should == "QST"
+      taxations.last.amount.should == 8925
+    end
+  end
+  
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: death_and_taxes
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,12 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-08-09 00:00:00.000000000 -04:00
-default_executable: 
+date: 2011-08-09 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &2153414940 !ruby/object:Gem::Requirement
+  requirement: &2164795680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2153414940
+  version_requirements: *2164795680
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &2153414520 !ruby/object:Gem::Requirement
+  requirement: &2164795260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,7 +32,18 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2153414520
+  version_requirements: *2164795260
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2164794840 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2164794840
 description: Death and Taxes allows to 'easily' calculate taxes on a model
 email: gmalette@gmail.com
 executables: []
@@ -51,7 +61,6 @@ files:
 - death_and_taxes.gemspec
 - lib/death_and_taxes.rb
 - lib/death_and_taxes/country.rb
-- lib/death_and_taxes/railtie.rb
 - lib/death_and_taxes/state.rb
 - lib/death_and_taxes/tax.rb
 - lib/death_and_taxes/tax_info.rb
@@ -62,9 +71,8 @@ files:
 - lib/death_and_taxes/version.rb
 - lib/generators/death_and_taxes/migration/migration_generator.rb
 - lib/generators/death_and_taxes/migration/templates/active_record/migration.rb
-- test/helper.rb
-- test/test_death_and_taxes.rb
-has_rdoc: true
+- spec/helper.rb
+- spec/test_death_and_taxes.rb
 homepage: ''
 licenses: []
 post_install_message: 
@@ -85,10 +93,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.8.6
 signing_key: 
 specification_version: 3
 summary: Tax calculations
 test_files:
-- test/helper.rb
-- test/test_death_and_taxes.rb
+- spec/helper.rb
+- spec/test_death_and_taxes.rb

data/lib/death_and_taxes/railtie.rb

@@ -1,11 +0,0 @@
-require 'rails'
-require 'death_and_taxes'
-
-module DeathAndTaxes
-  class Railtie < Rails::Railtie
-    config.to_prepare do
-      ActiveRecord::Base.send(:include, DeathAndTaxes::Taxable)
-      ActiveRecord::Base.send(:include, DeathAndTaxes::Taxer)
-    end
-  end
-end

data/test/helper.rb

@@ -1,18 +0,0 @@
-require 'rubygems'
-require 'bundler'
-begin
-  Bundler.setup(:default, :development)
-rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
-  exit e.status_code
-end
-require 'test/unit'
-require 'shoulda'
-
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-require 'death_and_taxes'
-
-class Test::Unit::TestCase
-end

data/test/test_death_and_taxes.rb

@@ -1,7 +0,0 @@
-require 'helper'
-
-class TestDeathAndTaxes < Test::Unit::TestCase
-  should "probably rename this file and start testing for real" do
-    flunk "hey buddy, you should probably rename this file and start testing for real"
-  end
-end