tax_easy 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b801401f6727d9ffbf7838dfd26eb7a849545be8
+  data.tar.gz: a8ebad4b88b66cf754cb182000fa4e5970e023cf
+SHA512:
+  metadata.gz: cc2b5fb7a150438e50444a9a373bf36c861790c63769ceb75c5f200be038913b62b69552a42e363520fe9d7523cfa44c7201c254045f8278e67d15359b5e9364
+  data.tar.gz: d43114b33f6ee99018d0d9d8617136c9dc4d5d2c6250cc4c5e0b8fb8d44ff3bedae21d0c5de927613504101bd99c92797e37c6315f216d61f3ba881de8558689

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2016 Victor Alencar
+
+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/Rakefile

@@ -0,0 +1,34 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'TaxEasy'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/tasks/tax_easy_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :tax_easy do
+#   # Task goes here
+# end

data/lib/tax_easy/calculator/installment.rb

@@ -0,0 +1,16 @@
+require 'exonio'
+
+module TaxEasy
+  module Calculator
+    class Installment
+
+      def initialize(overrides = {})
+        @calculator = overrides.fetch(:calculator) { Exonio }
+      end
+
+      def calculate(interest, financing_time_months, total)
+        @calculator.pmt(interest/100, financing_time_months, -total)
+      end
+    end
+  end
+end

data/lib/tax_easy/financial/brazil/iof.rb

@@ -0,0 +1,76 @@
+require 'tax_easy/calculator/installment'
+
+module TaxEasy
+  module Financial
+    module Brazil
+      class IOF
+        DEFAULT_IOF_DAY = 0.000041
+        DEFAULT_IOF_ADDITIONAL = 0.0038
+
+        def initialize(overrides = {})
+          @iof_day = overrides.fetch(:iof_day) { DEFAULT_IOF_DAY }
+          @iof_additional = overrides.fetch(:iof_additional) { DEFAULT_IOF_ADDITIONAL }
+          @installment_calculator = overrides.fetch(:installment_calculator) { TaxEasy::Calculator::Installment.new }
+        end
+
+        # Calculates IOF for Loan in Brazil
+        # @param loan_value [Float]
+        # @param financing_time_months [Integer] The number of payments to be made
+        # @param interest_rate [Float] The interest rate as decimal (not per cent) per period
+        # @param loan_date [Date] The loan request date
+        # @return [Float]
+        #
+        # @example
+        #   TaxEasy::Financial::Brazil::IOF.new.calculate(20_000, 48, 1.5) # ==> 356.70671942746617
+        #
+        def calculate(loan_value, financing_time_months, interest_rate, loan_date = Date.today)
+          balance = loan_value
+          installment = installment_value(interest_rate, financing_time_months, loan_value)
+          installment_date = loan_date.next_month
+          iof = 0
+
+          financing_time_months.step(1, -1) do |_|
+            amortization = installment - interest_part(balance, interest_rate)
+
+            days = past_days(loan_date, installment_date)
+
+            iof += amortization*(@iof_day*(minimal_days(days)))
+            iof += amortization*@iof_additional
+
+            balance -= amortization
+            installment_date = installment_date.next_month
+          end
+
+          loan_iof(iof, loan_value)
+        end
+
+        private
+
+        ## Calcualtes installment value for loan
+        def installment_value(interest_rate, financing_time_months, loan_value)
+          @installment_calculator.calculate(interest_rate, financing_time_months, loan_value)
+        end
+
+        ## Calculates the final IOF base on IOF not loan value
+        def loan_iof(iof, loan_value)
+          (iof*loan_value)/(loan_value-iof)
+        end
+
+        ## Interest part to be payed on specific installment
+        def interest_part(balance, interest_rate)
+          balance*(interest_rate/100)
+        end
+
+        ## Past days from specific date
+        def past_days(start_date, end_date)
+          (end_date - start_date).to_i
+        end
+
+        ## Minimal days from 365 to calculate IOF
+        def minimal_days(past_days)
+          [past_days, 365].min
+        end
+      end
+    end
+  end
+end

data/lib/tax_easy/version.rb

@@ -0,0 +1,3 @@
+module TaxEasy
+  VERSION = "0.0.1"
+end

data/lib/tax_easy.rb

@@ -0,0 +1,4 @@
+require 'tax_easy/financial/brazil/iof'
+
+module TaxEasy
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: tax_easy
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Victor Alencar
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-06-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: exonio
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.2
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.99.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.99.0
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !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.0
+description: TaxEasy - Calculate Taxes
+email:
+- victor.a.alencar@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- Rakefile
+- lib/tasks/tax_easy_tasks.rake
+- lib/tax_easy.rb
+- lib/tax_easy/calculator/installment.rb
+- lib/tax_easy/financial/brazil/iof.rb
+- lib/tax_easy/version.rb
+homepage: https://github.com/valencar/tax_easy
+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.8
+signing_key: 
+specification_version: 4
+summary: TaxEasy - Calculate Taxes
+test_files: []