stamp_duty 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 1147690e21ebe12467c191b40afbd6f29e4c4c90
-  data.tar.gz: 63fe7bd8fabb23dc64f76c71d030b821b3a7a765
+SHA256:
+  metadata.gz: 71cfaf89bad2686407f8d31d767f30656f89c390f82fcaf05f53385df1d975d5
+  data.tar.gz: cd2f4a70c7409c3c7462f7280de4b192e6fc645a87b5b8679bb1b9ed70d1fcb8
 SHA512:
-  metadata.gz: dfaed9758a2773e05453e368f6d97a244350203973256c2f849acbb6315f802373420690cd025ea68d424f01e3db41ac3e9915fe8ba04b35b7fec8fd3a22611a
-  data.tar.gz: 26763a41182056a87a64a2fbeeae8187b3341504bad4d74113680f9141d75b91fbaf9c11c8f41c165d5ca318e288d74711a39498ced0ccd30d6464d9ce17ba31
+  metadata.gz: 722ef366bd8f96c5ee09fcb843a67ffe939c59c4232aef779f07b57f76a2e3f7d340561e5b5281e2364934afa350acf43c1f48d6fa4ce2eb41c90a349cfabd10
+  data.tar.gz: 589f6094772da6ba947131c0fef3e5d7c569cbd9727bc7f4cf9ae7dd06daed5c3e38c8dbe7e6336e47af0d2e575688c5f21f2cd94b571e2cb2a0b80d4aba500d

data/CHANGELOG.md

@@ -0,0 +1,27 @@
+# Changelog
+
+## 0.2.0
+
+### Breaking
+
+- Requires Ruby 3.3 or later.
+- `stamp_duty` is rounded down to the whole pound, matching HMRC.
+- Invalid prices (non-numeric, `nil`, negative, NaN, infinite) raise `ArgumentError`.
+  Numeric strings such as `"275000"` are no longer accepted.
+
+### Fixed
+
+- Gem failed to load on Ruby 3.x (`uninitialized constant Forwardable`).
+- Calling `calculate` more than once doubled the result.
+- `stamp_duty` returned 0 unless `calculate` had been called first; results are now computed lazily.
+
+### Changed
+
+- Declared `bigdecimal` as a runtime dependency (bundled gem from Ruby 3.4).
+- Updated development dependencies (rake 13, minitest 5.25, simplecov 0.22); dropped mocha and pry.
+- Require MFA for gem pushes (`rubygems_mfa_required`).
+- CI moved from Travis to GitHub Actions.
+
+## 0.1.0
+
+- Initial release.

data/CONTEXT.md

@@ -0,0 +1,31 @@
+# StampDuty
+
+Calculates Stamp Duty Land Tax owed on a residential property purchase in England and Northern Ireland at the standard rates.
+
+## Language
+
+**Stamp Duty**:
+Stamp Duty Land Tax (SDLT) owed on a purchase, rounded down to the whole pound.
+_Avoid_: LBTT, LTT (Scottish and Welsh equivalents, out of scope)
+
+**Purchase Price**:
+The amount paid for the property, on which Stamp Duty is charged. Never negative.
+_Avoid_: value, consideration
+
+**Band**:
+A slice of the Purchase Price between a lower and optional upper bound, taxed at a single percentage rate.
+_Avoid_: bracket, tier
+
+**Band Amount**:
+The tax due on the part of a Purchase Price that falls within one Band.
+
+## Relationships
+
+- A **Purchase Price** falls into one or more **Bands**, starting from the lowest
+- Each **Band** the price reaches produces one **Band Amount**
+- **Stamp Duty** is the sum of the **Band Amounts**, rounded down to the pound
+
+## Flagged ambiguities
+
+- "Stamp duty" colloquially covers Scottish LBTT and Welsh LTT; here it means SDLT for England and Northern Ireland only.
+- Surcharges (additional properties, non-residents) and reliefs (first-time buyers) are not modelled.

data/README.md

@@ -1,7 +1,11 @@
 # 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
+StampDuty is a Stamp Duty Land Tax (SDLT) calculator for residential property
+in England and Northern Ireland. It uses the standard residential rates and
+doesn't include surcharges (additional properties, non-residents) or reliefs
+(first-time buyers). Scotland (LBTT) and Wales (LTT) are not covered.
+
+Requires Ruby 3.3 or later.
 
 ## Installation
 
@@ -23,12 +27,22 @@ Or install it yourself as:
 
 ```ruby
 calc = StampDuty.for(275000)
-calc.calculate
 
-# .to_s("F") as returns a big decimal
+# returns a BigDecimal, rounded down to the whole pound as HMRC does
 calc.stamp_duty.to_s("F") # => 3750.0
 ```
 
+The price must be a non-negative, finite number (Integer, BigDecimal, Rational
+or Float). Anything else raises `ArgumentError`:
+
+```ruby
+StampDuty.for("275000") # => ArgumentError
+StampDuty.for(-1)       # => ArgumentError
+```
+
+`calc.calculate` still exists for backwards compatibility, but results are
+computed on first access so calling it is no longer necessary.
+
 You can also can get each the amount in each band
 
 ```ruby
@@ -62,7 +76,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/jdexx/stamp_duty.
+Bug reports and pull requests are welcome on GitHub at https://github.com/j-dexx/stamp_duty.
 
 
 ## License

data/lib/stamp_duty/band_selector.rb

@@ -25,7 +25,7 @@ module StampDuty
     end
 
     def sorted_band_data
-      band_data_for_price.sort_by{ |band| band[:lower_band] }.reverse!
+      band_data_for_price.sort_by { |band| -band[:lower_bound] }
     end
 
     def band_data_for_price

data/lib/stamp_duty/residential_calculator.rb

@@ -1,32 +1,38 @@
 module StampDuty
   class ResidentialCalculator
 
-    attr_reader :purchase_price, :band_amounts, :bands
+    attr_reader :purchase_price, :bands
 
     def initialize(purchase_price, bands)
-      @purchase_price = purchase_price.to_d
+      @purchase_price = StampDuty.normalize_price(purchase_price)
       @bands = bands
-      @band_amounts = []
     end
 
+    # Total tax, rounded down to the whole pound as HMRC does.
     def stamp_duty
-      band_amounts.map(&:amount).reduce(0, :+)
+      @stamp_duty ||= band_amounts.map(&:amount).reduce(BigDecimal(0), :+).round(0, BigDecimal::ROUND_FLOOR)
     end
 
+    # Band amounts ordered lowest band first.
+    def band_amounts
+      @band_amounts ||= build_band_amounts
+    end
+
+    # Kept for backwards compatibility; results are computed lazily.
     def calculate
-      price = purchase_price
-      while price > 0
-        bands.each do |band|
-          add_band_amount(band, price)
-          price = band.lower_bound
-        end
-      end
+      band_amounts
+      self
     end
 
     private
 
-    def add_band_amount(band, price)
-      @band_amounts.unshift(StampDuty::BandAmount.new(price: price, band: band))
+    def build_band_amounts
+      price = purchase_price
+      bands.sort_by { |band| -band.lower_bound }.map do |band|
+        band_amount = StampDuty::BandAmount.new(price: price, band: band)
+        price = band.lower_bound
+        band_amount
+      end.reverse
     end
   end
 end

data/lib/stamp_duty/version.rb

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

data/lib/stamp_duty.rb

@@ -1,5 +1,6 @@
 require "bigdecimal"
 require "bigdecimal/util"
+require "forwardable"
 require "stamp_duty/version"
 require "stamp_duty/band"
 require "stamp_duty/band_selector"
@@ -8,7 +9,18 @@ require "stamp_duty/residential_calculator"
 
 module StampDuty
   def self.for(price)
+    price = normalize_price(price)
     bands = StampDuty::BandSelector.new(price).bands
     StampDuty::ResidentialCalculator.new(price, bands)
   end
+
+  def self.normalize_price(price)
+    unless price.is_a?(Numeric) && price.real?
+      raise ArgumentError, "price must be a number, got #{price.inspect}"
+    end
+    raise ArgumentError, "price must be finite, got #{price.inspect}" unless price.finite?
+    raise ArgumentError, "price must not be negative, got #{price.inspect}" if price.negative?
+
+    price.is_a?(Rational) ? price.to_d(20) : price.to_d
+  end
 end

data/stamp_duty.gemspec

@@ -1,4 +1,3 @@
-# coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'stamp_duty/version'
@@ -9,20 +8,25 @@ Gem::Specification.new do |spec|
   spec.authors       = ["James Doyley"]
   spec.email         = ["jdoyley@gmail.com"]
 
-  spec.summary       = %q{ A UK proerty stamp duty calculator }
+  spec.summary       = %q{ A UK property 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.metadata = {
+    "source_code_uri" => spec.homepage,
+    "changelog_uri" => "#{spec.homepage}/blob/master/CHANGELOG.md",
+    "rubygems_mfa_required" => "true"
+  }
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features|bin|\.github)/}) }
   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.required_ruby_version = ">= 3.3"
+
+  spec.add_dependency "bigdecimal", ">= 3.1", "< 5"
 
-  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"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "minitest", "~> 5.25"
+  spec.add_development_dependency "simplecov", "~> 0.22"
 end

metadata

@@ -1,100 +1,78 @@
 --- !ruby/object:Gem::Specification
 name: stamp_duty
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - James Doyley
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2016-04-27 00:00:00.000000000 Z
+date: 2026-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: bigdecimal
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.11'
-  type: :development
+        version: '3.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '3.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.25'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.25'
 - !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
+        version: '0.22'
   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: 
+        version: '0.22'
+description:
 email:
 - jdoyley@gmail.com
 executables: []
@@ -102,13 +80,12 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
-- ".travis.yml"
+- CHANGELOG.md
+- CONTEXT.md
 - 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
@@ -119,25 +96,27 @@ files:
 homepage: https://github.com/j-dexx/stamp_duty
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  source_code_uri: https://github.com/j-dexx/stamp_duty
+  changelog_uri: https://github.com/j-dexx/stamp_duty/blob/master/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '2.1'
+      version: '3.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
-signing_key: 
+rubygems_version: 3.5.3
+signing_key:
 specification_version: 4
-summary: A UK proerty stamp duty calculator
+summary: A UK property stamp duty calculator
 test_files: []

data/.travis.yml

@@ -1,4 +0,0 @@
-language: ruby
-rvm:
-  - 2.3.0
-before_install: gem install bundler -v 1.11.2

data/bin/console

@@ -1,14 +0,0 @@
-#!/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

@@ -1,8 +0,0 @@
-#!/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