stamp_duty 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1147690e21ebe12467c191b40afbd6f29e4c4c90
+  data.tar.gz: 63fe7bd8fabb23dc64f76c71d030b821b3a7a765
+SHA512:
+  metadata.gz: dfaed9758a2773e05453e368f6d97a244350203973256c2f849acbb6315f802373420690cd025ea68d424f01e3db41ac3e9915fe8ba04b35b7fec8fd3a22611a
+  data.tar.gz: 26763a41182056a87a64a2fbeeae8187b3341504bad4d74113680f9141d75b91fbaf9c11c8f41c165d5ca318e288d74711a39498ced0ccd30d6464d9ce17ba31

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.3.0
+before_install: gem install bundler -v 1.11.2

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 James Doyley
+
+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,71 @@
+# StampDuty
+
+StampDuty is a stamp duty calculator for the UK property market.  Currently only
+for residential property, and doesn't include the extra 3% for owning multiple properties
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'stamp_duty'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install stamp_duty
+
+## Usage
+
+```ruby
+calc = StampDuty.for(275000)
+calc.calculate
+
+# .to_s("F") as returns a big decimal
+calc.stamp_duty.to_s("F") # => 3750.0
+```
+
+You can also can get each the amount in each band
+
+```ruby
+calc.band_amounts.each do |ba|
+ puts ba.description
+ puts ba.amount.to_s("F")
+ puts ba.percentage_rate
+end
+```
+
+Which would return
+
+Up to 125,000  
+0.0  
+0
+
+Above 125,000 and up to 250,000  
+2500.0  
+2
+
+Above 250,000 and up to 925,000  
+1250.0  
+5
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also 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`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/jdexx/stamp_duty.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "stamp_duty"
+
+# 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,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/stamp_duty/band.rb

@@ -0,0 +1,31 @@
+module StampDuty
+  class Band
+    attr_reader :lower_bound, :upper_bound, :percentage_rate
+
+    def initialize(lower_bound, upper_bound, percentage_rate)
+      @lower_bound = lower_bound
+      @upper_bound = upper_bound
+      @percentage_rate = percentage_rate
+    end
+
+    def description
+      return "Up to #{ formatted_upper_bound }" if lower_bound.zero?
+      return "Above #{ formatted_lower_bound }+" if upper_bound.nil?
+      "Above #{ formatted_lower_bound } and up to #{ formatted_upper_bound }"
+    end
+
+    def decimal_percentage_rate
+      percentage_rate.to_d / 100
+    end
+
+    private
+
+    def formatted_lower_bound
+      lower_bound.to_s.reverse.scan(/\d{1,3}/).join(",").reverse
+    end
+
+    def formatted_upper_bound
+      upper_bound.to_s.reverse.scan(/\d{1,3}/).join(",").reverse
+    end
+  end
+end

data/lib/stamp_duty/band_amount.rb

@@ -0,0 +1,24 @@
+module StampDuty
+  class BandAmount
+    extend Forwardable
+
+    def_delegators :@band, :lower_bound, :percentage_rate, :decimal_percentage_rate, :description
+    attr_reader :price, :band
+
+    def initialize(price:, band:)
+      @price = price
+      @band = band
+    end
+
+    def amount
+      @amount ||= decimal_percentage_rate * rateable_amount
+    end
+
+    private
+
+    def rateable_amount
+      @rateable_amount ||= price - lower_bound
+    end
+
+  end
+end

data/lib/stamp_duty/band_selector.rb

@@ -0,0 +1,35 @@
+module StampDuty
+  class BandSelector
+    BAND_DATA = [
+      { lower_bound: 0, upper_bound: 125000, percentage_rate: 0 },
+      { lower_bound: 125000, upper_bound: 250000, percentage_rate: 2 },
+      { lower_bound: 250000, upper_bound: 925000, percentage_rate: 5 },
+      { lower_bound: 925000, upper_bound: 1500000, percentage_rate: 10 },
+      { lower_bound: 1500000, percentage_rate: 12 }
+    ]
+
+    attr_reader :price
+
+    def initialize(price)
+      @price = price
+    end
+
+    def bands
+      sorted_band_data.map{ |band_data| build_band(band_data) }
+    end
+
+    private
+
+    def build_band(band_data)
+      StampDuty::Band.new(band_data[:lower_bound], band_data[:upper_bound], band_data[:percentage_rate])
+    end
+
+    def sorted_band_data
+      band_data_for_price.sort_by{ |band| band[:lower_band] }.reverse!
+    end
+
+    def band_data_for_price
+      BAND_DATA.select{ |band| price > band[:lower_bound] }
+    end
+  end
+end

data/lib/stamp_duty/residential_calculator.rb

@@ -0,0 +1,32 @@
+module StampDuty
+  class ResidentialCalculator
+
+    attr_reader :purchase_price, :band_amounts, :bands
+
+    def initialize(purchase_price, bands)
+      @purchase_price = purchase_price.to_d
+      @bands = bands
+      @band_amounts = []
+    end
+
+    def stamp_duty
+      band_amounts.map(&:amount).reduce(0, :+)
+    end
+
+    def calculate
+      price = purchase_price
+      while price > 0
+        bands.each do |band|
+          add_band_amount(band, price)
+          price = band.lower_bound
+        end
+      end
+    end
+
+    private
+
+    def add_band_amount(band, price)
+      @band_amounts.unshift(StampDuty::BandAmount.new(price: price, band: band))
+    end
+  end
+end

data/lib/stamp_duty/version.rb

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

data/lib/stamp_duty.rb

@@ -0,0 +1,14 @@
+require "bigdecimal"
+require "bigdecimal/util"
+require "stamp_duty/version"
+require "stamp_duty/band"
+require "stamp_duty/band_selector"
+require "stamp_duty/band_amount"
+require "stamp_duty/residential_calculator"
+
+module StampDuty
+  def self.for(price)
+    bands = StampDuty::BandSelector.new(price).bands
+    StampDuty::ResidentialCalculator.new(price, bands)
+  end
+end

data/stamp_duty.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'stamp_duty/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "stamp_duty"
+  spec.version       = StampDuty::VERSION
+  spec.authors       = ["James Doyley"]
+  spec.email         = ["jdoyley@gmail.com"]
+
+  spec.summary       = %q{ A UK proerty stamp duty calculator }
+  spec.homepage      = "https://github.com/j-dexx/stamp_duty"
+  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.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "simplecov", "~> 0.11.2"
+  spec.add_development_dependency "mocha", "~> 1.1.0"
+  spec.add_development_dependency "pry"
+end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: stamp_duty
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- James Doyley
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-04-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.2
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  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:
+- jdoyley@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/stamp_duty.rb
+- lib/stamp_duty/band.rb
+- lib/stamp_duty/band_amount.rb
+- lib/stamp_duty/band_selector.rb
+- lib/stamp_duty/residential_calculator.rb
+- lib/stamp_duty/version.rb
+- stamp_duty.gemspec
+homepage: https://github.com/j-dexx/stamp_duty
+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.5.1
+signing_key: 
+specification_version: 4
+summary: A UK proerty stamp duty calculator
+test_files: []