tax_manipulator 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e3a84266c4dd89b984374003d4f1a6655c908ca6
+  data.tar.gz: 939140582ec3ea7434f90a4c634d4463014d88db
+SHA512:
+  metadata.gz: 3e8cc5bb56a3acd6a7c06f8e1185d41dfe5914d3a098b2516be8e85f7c7d16434ed49acfa12c9b568441fe91e8186a63bf1ae7c8c91970c3ebba31478709b42a
+  data.tar.gz: 147833880f1597395b9de21ad72707767b6545bdaa6e837d197d77fdd4d81d8075fde82507daef5150d184f0b35219ca3c704c8db5c549edfda5fd8d87dcbbc1

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.7
+  - 2.2.3

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Marion Duprey
+
+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,79 @@
+[![Build Status](https://travis-ci.org/TiteiKo/tax_manipulator.svg?branch=master)](https://travis-ci.org/TiteiKo/tax_manipulator)
+[![Code Climate](https://codeclimate.com/github/TiteiKo/tax_manipulator/badges/gpa.svg)](https://codeclimate.com/github/TiteiKo/tax_manipulator)
+
+# TaxManipulator
+
+2014, France. Taxes go up from 19.6% to 20% on the 1st of January.
+
+I then changed the class we used to compute prices (taxes amount and without taxes prices)
+to be able to compute it depending on the date.
+
+Today, I think it's finally time for me to cleanup and open source this bit of code !
+
+## Installation
+
+TaxManipulator requires **ruby >= 2.1** as it takes advantages of named parameters.
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'tax_manipulator'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tax_manipulator
+
+## Usage
+
+config/initializers/tax_manipulator.rb
+
+```ruby
+TaxManipulator.configure do |config|
+  config.add_rate rate: 19.6, ending: Date.parse('2013-12-31')
+  config.add_rate rate: 2.0, starting: Date.parse('2014-01-01')
+
+  # optional: default scheme for the price given (:incl_tax or :excl_tax)
+  config.default_scheme :incl_tax
+end
+```
+
+Examples:
+
+```ruby
+# if you have your price including tax
+TaxManipulator.for(42, scheme: :incl_tax).price_excl_tax
+TaxManipulator.for(42, scheme: :incl_tax).vat
+TaxManipulator.for(42, scheme: :incl_tax, date: Date.parse('2013-12-10')).vat
+
+# if you have your price excluding tax
+TaxManipulator.for(42, scheme: :excl_tax).price_incl_tax
+TaxManipulator.for(42, scheme: :excl_tax).vat
+TaxManipulator.for(42, scheme: :excl_tax, date: Date.parse('2013-12-10')).vat
+
+# if the default scheme is set
+TaxManipulator.for(42).vat
+TaxManipulator.for(42, date: Date.parse('2013-12-10')).vat
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt
+that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the
+version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version,
+push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/TiteiKo/tax_manipulator/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Run the tests and write your owns (`bundle exec rake`)
+4. Commit your changes (`git commit -am 'Add some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,12 @@
+require "bundler/gem_tasks"
+
+%w(bundler find rake/testtask).each { |lib| require lib }
+
+Rake::TestTask.new do |t|
+  t.libs << "lib"
+  t.libs << "test"
+  t.test_files = FileList['test/**/test_*.rb', 'test/**/*_spec.rb']
+  t.verbose = true
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "tax_manipulator"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/tax_manipulator.rb

@@ -0,0 +1,36 @@
+require 'tax_manipulator/version'
+require 'tax_manipulator/errors'
+require 'tax_manipulator/configuration'
+
+require 'tax_manipulator/rate'
+
+require 'tax_manipulator/manipulators/base'
+require 'tax_manipulator/manipulators/excluding_tax'
+require 'tax_manipulator/manipulators/including_tax'
+
+module TaxManipulator
+  def self.config
+    @config ||= Configuration.new
+  end
+
+  def self.configure
+    yield(config)
+  end
+
+  def self.for(price, scheme: nil, date: Date.today)
+    scheme ||= config.default_scheme
+
+    case scheme
+    when :excl_tax
+      Manipulator::ExcludingTax.new(price, date)
+    when :incl_tax
+      Manipulator::IncludingTax.new(price, date)
+    else
+      raise UnknownStrategyError
+    end
+  end
+
+  def self.reset_config!
+    @config = Configuration.new
+  end
+end

data/lib/tax_manipulator/configuration.rb

@@ -0,0 +1,19 @@
+module TaxManipulator
+  class Configuration
+    attr_reader :rates, :default_scheme
+
+    def initialize
+      @rates = []
+    end
+
+    def add_rate(rate:, starting: nil, ending: nil)
+      rates << Rate.new(rate: rate, starting: starting, ending: ending)
+    end
+
+    def default_scheme=(scheme)
+      raise UnknownStrategyError unless scheme.nil? || [:excl_tax, :incl_tax].include?(scheme)
+
+      @default_scheme = scheme
+    end
+  end
+end

data/lib/tax_manipulator/errors.rb

@@ -0,0 +1,5 @@
+module TaxManipulator
+  class Error < StandardError; end
+
+  class UnknownStrategyError < Error; end
+end

data/lib/tax_manipulator/manipulators/base.rb

@@ -0,0 +1,17 @@
+module TaxManipulator
+  module Manipulator
+    class Base
+      attr_reader :price, :date
+
+      def initialize(price, date)
+        @price, @date = price.to_f, date
+      end
+
+      def rate
+        @rate ||= begin
+          TaxManipulator.config.rates.find { |r| r.match?(date) }.rate / 100.0
+        end
+      end
+    end
+  end
+end

data/lib/tax_manipulator/manipulators/excluding_tax.rb

@@ -0,0 +1,17 @@
+module TaxManipulator
+  module Manipulator
+    class ExcludingTax < Base
+      def vat
+        (rate * price).round(2)
+      end
+
+      def price_incl_tax
+        (price + vat).round(2)
+      end
+
+      def price_excl_tax
+        price.round(2)
+      end
+    end
+  end
+end

data/lib/tax_manipulator/manipulators/including_tax.rb

@@ -0,0 +1,17 @@
+module TaxManipulator
+  module Manipulator
+    class IncludingTax < Base
+      def vat
+        (price - (price / (rate + 1))).round(2)
+      end
+
+      def price_incl_tax
+        price.round(2)
+      end
+
+      def price_excl_tax
+        (price - vat).round(2)
+      end
+    end
+  end
+end

data/lib/tax_manipulator/rate.rb

@@ -0,0 +1,16 @@
+module TaxManipulator
+  class Rate
+    attr_accessor :rate, :starting, :ending
+
+    def initialize(params)
+      params.each { |key, value| send "#{key}=", value }
+    end
+
+    def match?(date)
+      return true if starting.nil? && ending.nil?
+      return date <= ending if starting.nil?
+      return date >= starting if ending.nil?
+      date <= ending && date >= starting
+    end
+  end
+end

data/lib/tax_manipulator/version.rb

@@ -0,0 +1,3 @@
+module TaxManipulator
+  VERSION = "0.1.0"
+end

data/tax_manipulator.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tax_manipulator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "tax_manipulator"
+  spec.version       = TaxManipulator::VERSION
+  spec.authors       = ["Marion Duprey"]
+  spec.email         = ["titeiko@gmail.com"]
+
+  spec.summary       = %q{Configurable vat, price including tax and price excluding tax computing}
+  spec.homepage      = "https://github.com/TiteiKo/tax_manipulator"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = '>= 2.1'
+
+  spec.add_development_dependency 'bundler', '>= 1.7'
+  spec.add_development_dependency 'rake', '>= 10.0'
+  spec.add_development_dependency 'minitest'
+  spec.add_development_dependency 'minitest-reporters'
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: tax_manipulator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Marion Duprey
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-08-23 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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  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: minitest-reporters
+  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'
+description: 
+email:
+- titeiko@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/tax_manipulator.rb
+- lib/tax_manipulator/configuration.rb
+- lib/tax_manipulator/errors.rb
+- lib/tax_manipulator/manipulators/base.rb
+- lib/tax_manipulator/manipulators/excluding_tax.rb
+- lib/tax_manipulator/manipulators/including_tax.rb
+- lib/tax_manipulator/rate.rb
+- lib/tax_manipulator/version.rb
+- tax_manipulator.gemspec
+homepage: https://github.com/TiteiKo/tax_manipulator
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.1'
+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: Configurable vat, price including tax and price excluding tax computing
+test_files: []