tax_girl 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 087b91f189fe9d5686163b072844520170ee5b91
+  data.tar.gz: c7bb6ddf2965a90572b462619e55cd218f727ebc
+SHA512:
+  metadata.gz: 3f61e9fba050d4ba6a97ae9ef95d25f8eeb4035f1d24b05cb8d54346b8771de1bcb7443d48df592bf281adb1a0967d0f01142209bdf4361b7bf1dab31fa5b740
+  data.tar.gz: f803151d0889d17e0033f7585a3436027cadf354bcdff53394616a264da6bf945fb4f4ea18e93c4ec731d762b328d3e4a75aa3e87e7e6537ebdd80d36e2b0fc1

data/.gitignore

@@ -0,0 +1,35 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+.ruby-version

data/.rspec

@@ -0,0 +1 @@
+--color

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Oswaldo S Ferreira
+
+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.md

@@ -0,0 +1,116 @@
+tax_girl
+=======
+
+### Introduction
+
+TaxGirl is a simple tool that help's keeping calculation logic explicit using a pretty
+ruby DSL. It also avoids the hard work of seaching for layers and layers of calculation methods.
+
+### Composing price
+
+#### Increase block
+
+Block where you define which methods will be triggered to compose the main price amount.
+
+#### Params
+
+**currency** and **percentage** - Accepts a method or list of methods symbols that will be triggered
+on the moment you call the method passed as param to taxgirl (*price* on the example below).
+
+Obs: *percentage* methods amounts will be applied on typed order.
+
+```ruby
+class Product
+  taxgirl :price do
+    increase do
+      currency   :provider_price, :convenience_fee
+      percentage :commission_fee, :another_fee
+    end
+  end
+  
+  def provider_price
+    105.5
+  end
+
+  def convenience_fee
+    5.0
+  end
+
+  def commission_fee
+    # It means 10% to tax girl
+    10.0
+  end
+
+  def another_fee
+    # It means 5.5% to tax girl
+    5.5
+  end
+end
+
+product = Product.new
+product.price
+
+=> 128.23525
+
+```
+
+Obs: *price* will be calculated every time it's called.
+
+#### Discount block
+
+Block where you define which methods will be triggered to discount the main price amount calculated on *increase block*.
+
+```ruby
+class Product
+  taxgirl :price do
+    increase do
+      currency   :provider_price, :convenience_fee
+      percentage :commission_fee, :another_fee
+    end
+
+    discount do
+      currency   :special_coupon_discount
+      percentage :black_friday_discount
+    end
+  end
+  
+  def provider_price
+    105.5
+  end
+
+  def convenience_fee
+    5.0
+  end
+
+  def commission_fee
+    # It means 10% to tax girl
+    10.0
+  end
+
+  def another_fee
+    # It means 5.5% to tax girl
+    5.5
+  end
+
+  def special_coupon_discount
+    20.0
+  end
+
+  def black_friday_discount
+    # It means 15% to tax girl
+    15.0
+  end
+end
+
+product = Product.new
+product.price
+
+=> 91.99996250000001
+```
+
+### Contributing
+
+- Create an issue
+- Fork the project
+- Send a pull request
+- Have fun! :)

data/lib/tax_girl.rb

@@ -0,0 +1,16 @@
+require 'tax_girl/composer'
+require 'tax_girl/increaser'
+require 'tax_girl/discounter'
+
+def taxgirl(price_attr, &main_block)
+  composer = Composer.new(main_block)
+
+  define_method price_attr do
+    Increaser.new(composer, self)
+    Discounter.new(composer, self)
+
+    composer.total
+  end
+
+  composer.evaluate!
+end

data/lib/tax_girl/composer.rb

@@ -0,0 +1,36 @@
+class Composer
+  attr_accessor :demand_methods,
+                :current_demand,
+                :total
+
+  def initialize(taxgirl_block)
+    @demand_methods = { discount: { currency: [], percentage: [] }, increase: { currency: [], percentage: [] } }
+    @current_demand = nil
+    @taxgirl_block = taxgirl_block
+    @total = 0
+  end
+
+  def evaluate!
+    instance_eval(&@taxgirl_block)
+  end
+
+  def increase
+    @current_demand = :increase
+
+    yield
+  end
+
+  def discount
+    @current_demand = :discount
+
+    yield
+  end
+
+  def currency(*args)
+    demand_methods[current_demand][:currency] = args
+  end
+
+  def percentage(*args)
+    demand_methods[current_demand][:percentage] = args
+  end
+end

data/lib/tax_girl/discounter.rb

@@ -0,0 +1,30 @@
+class Discounter
+  attr_accessor :composer, :scope
+
+  def initialize(composer, scope)
+    @composer          = composer
+    @scope             = scope
+    @currency_demand   = composer.demand_methods[:discount][:currency]
+    @percentage_demand = composer.demand_methods[:discount][:percentage]
+
+    calculate_amount if @currency_demand.any?
+  end
+
+  def calculate_amount
+    calculate_currency
+    calculate_percentage
+  end
+
+  def calculate_currency
+    self.composer.total -= @currency_demand.map do |method|
+      scope.send(method) || 0
+    end.reduce(:+)
+  end
+
+  def calculate_percentage
+    @percentage_demand.each do |method|
+      value = scope.send(method) || 0
+      self.composer.total -= (value.to_f / 100) * composer.total
+    end
+  end
+end

data/lib/tax_girl/increaser.rb

@@ -0,0 +1,33 @@
+class Increaser
+  attr_accessor :composer, :scope, :amount
+
+  def initialize(composer, scope)
+    @composer          = composer
+    @scope             = scope
+    @amount            = 0
+    @currency_demand   = composer.demand_methods[:increase][:currency]
+    @percentage_demand = composer.demand_methods[:increase][:percentage]
+
+    calculate_amount if @currency_demand.any?
+  end
+
+  def calculate_amount
+    calculate_currency
+    calculate_percentage
+
+    composer.total = amount
+  end
+
+  def calculate_currency
+    self.amount += @currency_demand.map do |method|
+      scope.send(method) || 0
+    end.reduce(:+)
+  end
+
+  def calculate_percentage
+    @percentage_demand.each do |method|
+      value = scope.send(method) || 0
+      self.amount += (value.to_f / 100) * amount
+    end
+  end
+end

data/spec/basic_dummy.rb

@@ -0,0 +1,36 @@
+require 'tax_girl'
+
+class BasicDummy
+  taxgirl :price do
+    increase do
+      currency   :provider_price, :convenience_fee
+      percentage :commission_fee, :another_percentage_tax
+    end
+
+    discount do
+      currency   :coupon_discount, :another_fix_discount
+      percentage :black_friday_discount, :another_percentage_discount
+    end
+  end
+
+  # Just to improve the spec initialization (it's not needed)
+  def initialize(opts)
+    self.provider_price              = opts[:provider_price]
+    self.convenience_fee             = opts[:convenience_fee]
+    self.commission_fee              = opts[:commission_fee]
+    self.another_percentage_tax      = opts[:another_percentage_tax]
+    self.coupon_discount             = opts[:coupon_discount]
+    self.another_fix_discount        = opts[:another_fix_discount]
+    self.black_friday_discount       = opts[:black_friday_discount]
+    self.another_percentage_discount = opts[:another_percentage_discount]
+  end
+
+  attr_accessor :provider_price,
+                :convenience_fee,
+                :commission_fee,
+                :another_percentage_tax,
+                :coupon_discount,
+                :another_fix_discount,
+                :black_friday_discount,
+                :another_percentage_discount
+end

data/spec/tax_girl_spec.rb

@@ -0,0 +1,120 @@
+require 'basic_dummy'
+require 'tax_girl'
+
+describe 'TaxGirl initial syntax' do
+  describe '#taxgirl' do
+    let!(:simple_dummy) {
+      BasicDummy.new provider_price:         10,
+                     convenience_fee:        20,
+                     commission_fee:         5,
+                     another_percentage_tax: 2
+    }
+
+    let!(:complete_dummy) {
+      BasicDummy.new provider_price:              100,
+                     convenience_fee:             0,
+                     commission_fee:              0,
+                     another_percentage_tax:      0,
+                     coupon_discount:             10,
+                     another_fix_discount:        20,
+                     black_friday_discount:       50,
+                     another_percentage_discount: 1
+    }
+
+    context 'when only increase methods (simple_dummy)' do
+      it 'main taxgirl attribute returns calculated tax' do
+        expect(simple_dummy.price).to eq 32.13
+      end
+
+      it 'multiple calls does not affect calculation result' do
+        simple_dummy.price
+        expect(simple_dummy.price).to eq 32.13
+      end
+
+      it 'changes on the fly are considered on calculation result' do
+        simple_dummy.provider_price = 100
+        expect(simple_dummy.price).to eq 128.52
+      end
+    end
+
+    context 'when increase and discount methods (complete_dummy)' do
+      it 'main taxgirl attribute returns calculated tax' do
+        expect(complete_dummy.price).to eq 34.65
+
+        complete_dummy.provider_price = 90
+      end
+
+      it 'multiple calls does not affect calculation result' do
+        complete_dummy.price
+        expect(complete_dummy.price).to eq 34.65
+      end
+
+      it 'changes on the fly are considered on calculation result' do
+        complete_dummy.provider_price = 90
+        expect(complete_dummy.price).to eq 29.7
+      end
+    end
+
+    context 'when no value from a currency method' do
+      it '0 is returned from it' do
+        simple_dummy.provider_price = nil
+        expect(simple_dummy.price).to eq 21.42
+      end
+    end
+
+    context 'when no value from a percentage method' do
+      it '0 is returned from it' do
+        simple_dummy.commission_fee = nil
+        expect(simple_dummy.price).to eq 30.6
+      end
+    end
+
+    context 'when theres no discount block' do
+      let!(:dummy) do
+        class Dummy
+          taxgirl :price do
+            increase do
+              currency :p1
+            end
+          end
+
+          def p1
+            100
+          end
+        end
+
+        Dummy.new
+      end
+
+      it 'discounter does not calculate amount' do
+        expect_any_instance_of(Discounter).not_to receive(:calculate_amount)
+
+        dummy.price
+      end
+    end
+
+    context 'when theres no increase block' do
+      let!(:dummy) do
+        class Dummy
+          taxgirl :price do
+            discount do
+              currency :p1
+            end
+          end
+
+          def p1
+            100
+          end
+        end
+
+        Dummy.new
+      end
+
+      it 'increaser does not calculate amount' do
+        expect_any_instance_of(Increaser).not_to receive(:calculate_amount)
+
+        dummy.price
+      end
+    end
+  end
+end

data/tax_girl.gemspec

@@ -0,0 +1,23 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |s|
+  s.name             = 'tax_girl'
+  s.version          = '0.0.1'
+  s.date             = '2015-02-05'
+  s.summary          = 'DSL for calculation methods organization.'
+  s.description      = 'TaxGirl is a simple tool that helps keeping calculation logic explicit using a ruby DSL.'
+  s.authors          = ['Oswaldo Ferreira']
+  s.email            = 'oswluizf@gmail.com'
+  s.homepage         = 'https://github.com/oswaldoferreira/tax_girl'
+  s.license          = 'MIT'
+
+  s.files         = `git ls-files -z`.split("\x0")
+  s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency 'bundler', '~> 1.7'
+  s.add_development_dependency 'rspec', '~> 3.1', '>= 3.1.0'
+end
+

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: tax_girl
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Oswaldo Ferreira
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+description: TaxGirl is a simple tool that helps keeping calculation logic explicit
+  using a ruby DSL.
+email: oswluizf@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- LICENSE
+- README.md
+- lib/tax_girl.rb
+- lib/tax_girl/composer.rb
+- lib/tax_girl/discounter.rb
+- lib/tax_girl/increaser.rb
+- spec/basic_dummy.rb
+- spec/tax_girl_spec.rb
+- tax_girl.gemspec
+homepage: https://github.com/oswaldoferreira/tax_girl
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+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: 2.4.5
+signing_key: 
+specification_version: 4
+summary: DSL for calculation methods organization.
+test_files:
+- spec/basic_dummy.rb
+- spec/tax_girl_spec.rb