panier 0.0.1

data/lib/panier/domain/tax_class.rb

@@ -0,0 +1,28 @@
+module Panier
+  module Domain
+    ##
+    # A tax class is a value object that describes a particular type of tax or
+    # duty applicable to products sold.
+    #
+    class TaxClass
+      attr_reader :name, :rate
+
+      ##
+      # Initializes the tax class using the given name and rate.
+      #
+      # @param name [String] A display name for the tax class.
+      # @param rate [Float] The rate of tax, where 0.1 would represent 10% tax.
+      def initialize(name, rate)
+        @name = name
+        self.rate = rate
+      end
+
+      protected
+
+      def rate=(rate)
+        fail ArgumentError, ':rate must be non-negative' if rate < 0
+        @rate = rate
+      end
+    end
+  end
+end

data/lib/panier/version.rb

@@ -0,0 +1,4 @@
+# Encoding: utf-8
+module Panier
+  VERSION = '0.0.1'
+end

data/lib/panier.rb

@@ -0,0 +1,22 @@
+# Encoding: utf-8
+require 'active_support'
+require 'active_support/dependencies'
+
+require 'panier/version'
+
+require 'panier/domain/line_item'
+require 'panier/domain/receipt'
+require 'panier/domain/product'
+require 'panier/domain/tax_class'
+
+require 'panier/application/input_reader'
+require 'panier/application/cli'
+require 'panier/application/sales_tax_service'
+
+##
+# The module containing all the panier code.
+#
+module Panier
+  relative_load_paths = %w(lib)
+  ActiveSupport::Dependencies.autoload_paths += relative_load_paths
+end

data/panier.gemspec

@@ -0,0 +1,29 @@
+# Encoding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'panier/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'panier'
+  spec.version       = Panier::VERSION
+  spec.authors       = ['Luke Eller']
+  spec.email         = ['luke.eller@bigcommerce.com']
+  spec.summary       = 'A gem demonstrating the calculation of sales taxes.'
+  spec.homepage      = ''
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(/^bin\//) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(/^(test|spec|features)\//)
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'money'
+  spec.add_dependency 'workflow'
+  spec.add_dependency 'activesupport'
+
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'factory_girl'
+  spec.add_development_dependency 'faker'
+end

data/spec/factories/line_item.rb

@@ -0,0 +1,17 @@
+FactoryGirl.define do
+  factory :line_item, class: Panier::Domain::LineItem do
+
+    ignore do
+      product_price Money.new(200)
+    end
+
+    product { build :product, price: product_price }
+    quantity 1
+
+    initialize_with { new(product, quantity) }
+
+    factory :taxable_line_item do
+      product { build :taxable_product, price: product_price }
+    end
+  end
+end

data/spec/factories/product.rb

@@ -0,0 +1,16 @@
+require 'money'
+
+FactoryGirl.define do
+  factory :product, class: Panier::Domain::Product do
+
+    name Faker::Commerce.product_name
+    price Money.new(200)
+    tax_classes []
+
+    initialize_with { new(name, price, tax_classes) }
+
+    factory :taxable_product do
+      tax_classes { [build(:tax_class)] }
+    end
+  end
+end

data/spec/factories/receipt.rb

@@ -0,0 +1,21 @@
+FactoryGirl.define do
+  factory :receipt, class: Panier::Domain::Receipt do
+    line_items { [build(:line_item)] }
+
+    initialize_with { new(line_items) }
+
+    factory :multi_item_receipt do
+
+      ignore do
+        item_count 5
+        product_price Money.new(100)
+      end
+
+      line_items do
+        Array.new(item_count) do
+          build(:line_item, product_price: product_price)
+        end
+      end
+    end
+  end
+end

data/spec/factories/tax_class.rb

@@ -0,0 +1,8 @@
+FactoryGirl.define do
+  factory :tax_class, class: Panier::Domain::TaxClass do
+    name 'Basic sales tax'
+    rate 0.1
+
+    initialize_with { new(name, rate) }
+  end
+end

data/spec/panier/application/input_reader_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe Panier::Application::InputReader do
+  describe '#create_line_item' do
+    it 'creates a line item from input' do
+
+      service = instance_double(Panier::Domain::ProductService)
+      product = build :product
+
+      expect(service).to receive(:find_by_name_and_price)
+                         .with(product.name, product.price) { product }
+
+      reader = Panier::Application::InputReader.new(service)
+      line_item = reader.parse_line("1, #{product.name}, #{product.price}")
+
+      expect(line_item.quantity).to eq(1)
+      expect(line_item.description).to eq(product.name)
+      expect(line_item.unit_amount).to eq(product.price)
+    end
+  end
+end

data/spec/panier/application/sales_tax_service_spec.rb

@@ -0,0 +1,83 @@
+require 'spec_helper'
+
+include Panier::Domain
+
+describe Panier::Application::SalesTaxService do
+  shared_examples 'produces CSV output' do
+    it 'should produce a CSV formatted receipt' do
+      service = Panier::Application::SalesTaxService.new
+
+      actual = service.evaluate_input(input)
+
+      expect(actual).to eq(expected)
+    end
+  end
+
+  describe '#evaluate_input' do
+    context 'given the data from input 1' do
+      include_examples 'produces CSV output' do
+        let(:input) do
+          'Quantity, Product, Price
+1, book, 12.49
+1, music CD, 14.99
+1, chocolate bar, 0.85
+'
+        end
+
+        let(:expected) do
+          '1, book, 12.49
+1, music CD, 16.49
+1, chocolate bar, 0.85
+
+Sales Taxes: 1.50
+Total: 29.83
+'
+        end
+      end
+    end
+
+    context 'given the data from input 2' do
+      include_examples 'produces CSV output' do
+        let(:input) do
+          'Quantity, Product, Price
+1, imported box of chocolates, 10.00
+1, imported bottle of perfume, 47.50
+'
+        end
+
+        let(:expected) do
+          '1, imported box of chocolates, 10.50
+1, imported bottle of perfume, 54.65
+
+Sales Taxes: 7.65
+Total: 65.15
+'
+        end
+      end
+    end
+
+    context 'given the data from input 3' do
+      include_examples 'produces CSV output' do
+        let(:input) do
+          'Quantity, Product, Price
+1, imported bottle of perfume, 27.99
+1, bottle of perfume, 18.99
+1, packet of headache pills, 9.75
+1, box of imported chocolates, 11.25
+'
+        end
+
+        let(:expected) do
+          '1, imported bottle of perfume, 32.19
+1, bottle of perfume, 20.89
+1, packet of headache pills, 9.75
+1, box of imported chocolates, 11.85
+
+Sales Taxes: 6.70
+Total: 74.68
+'
+        end
+      end
+    end
+  end
+end

data/spec/panier/decorators/receipt_decorator_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+include Panier::Domain
+
+describe Panier::Decorators::ReceiptDecorator do
+  describe '#to_csv' do
+    it 'should generate CSV containing details of the receipt' do
+      line_items = [
+        LineItem.new(Product.new('product 1', Money.new(1000), []), 1),
+        LineItem.new(Product.new('product 2', Money.new(1500),
+                                 [build(:tax_class)]), 1)
+      ]
+      receipt = Domain::Receipt.new(line_items)
+      decorator = Panier::Decorators::ReceiptDecorator.new(receipt)
+
+      expect(decorator.to_csv).to eq('1, product 1, 10.00
+1, product 2, 16.50
+
+Sales Taxes: 1.50
+Total: 26.50
+')
+    end
+  end
+end

data/spec/panier/domain/line_item_spec.rb

@@ -0,0 +1,100 @@
+require 'spec_helper'
+require 'money'
+
+include Panier
+
+describe Domain::LineItem do
+  describe '#initialize' do
+    before :each do
+      @product = build :taxable_product
+      @line_item = build :taxable_line_item, product: @product
+    end
+
+    it 'assigns the quantity argument to the quantity attribute' do
+      quantity = 5
+
+      line_item = build :line_item, quantity: quantity
+
+      expect(line_item.quantity).to eq(quantity)
+    end
+
+    it 'assigns the product argument to the product attribute' do
+      expect(@line_item.product).to eq(@product)
+    end
+
+    it 'assigns the description based on the product name' do
+      expect(@line_item.description).to eq(@product.name)
+    end
+
+    it 'assigns the unit amount based on the product price' do
+      expect(@line_item.unit_amount).to eq(@product.price)
+    end
+
+    it 'assigns the tax classes based on the product tax classes' do
+      expect(@line_item.tax_classes).to eq(@product.tax_classes)
+    end
+
+    it "does not hold a reference to the product's array of tax classes" do
+      expect(@line_item.tax_classes).to_not be(@product.tax_classes)
+    end
+
+    it 'rejects negative quantities' do
+      product = build :product
+      quantity = -5
+
+      expect { Domain::LineItem.new(product, quantity) }.to raise_exception
+    end
+  end
+
+  describe '#total_amount' do
+    it 'calculates the total value of the line item' do
+      line_item = build :taxable_line_item, quantity: 5
+      expect(line_item.total_amount).to eq(Money.new(1000))
+    end
+  end
+
+  describe '#total_tax' do
+    it 'calculates the total amount of tax included in the line item' do
+      line_item = build :taxable_line_item, quantity: 5
+      expect(line_item.total_tax).to eq(Money.new(100))
+    end
+  end
+
+  describe '#total_amount_inc_tax' do
+    it 'calculates the total value of the line item including tax' do
+      line_item = build :taxable_line_item, quantity: 5
+      expect(line_item.total_amount_inc_tax).to eq(Money.new(1100))
+    end
+  end
+
+  describe '#unit_amount_inc_tax' do
+    it 'calculates the total value of the line item including tax' do
+      line_item = build :taxable_line_item, quantity: 5
+      expect(line_item.unit_amount_inc_tax).to eq(Money.new(220))
+    end
+  end
+
+  describe '#unit_tax' do
+    describe 'tax rounding' do
+      it 'rounds low values up to the nearest 5 cents' do
+        line_item = build :taxable_line_item, product_price: Money.new(310)
+        expect(line_item.unit_tax).to eq(Money.new(35))
+      end
+
+      it 'rounds median values up to the nearest 5 cents' do
+        line_item = build :taxable_line_item, product_price: Money.new(125)
+        expect(line_item.unit_tax).to eq(Money.new(15))
+      end
+
+      it 'rounds high values up to the nearest 5 cents' do
+        line_item = build :taxable_line_item, product_price: Money.new(140)
+        expect(line_item.unit_tax).to eq(Money.new(15))
+      end
+
+      it 'does not change values divisible by 5' do
+        line_item = build :taxable_line_item, product_price: Money.new(150)
+        expect(line_item.unit_tax).to eq(Money.new(15))
+      end
+    end
+  end
+end

data/spec/panier/domain/product_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+include Panier
+
+describe Domain::Product do
+
+  describe '#initialize' do
+    it 'assigns its arguments to attributes' do
+      name = Faker::Commerce.product_name
+      price = Money.new(200)
+      tax_classes = [build(:tax_class)]
+      product = build :taxable_product,
+                      name: name, price: price, tax_classes: tax_classes
+
+      expect(product.name).to eq(name)
+      expect(product.price).to eq(price)
+      expect(product.tax_classes).to eq(tax_classes)
+    end
+  end
+
+  describe '#price=' do
+    it 'rejects negative prices' do
+      product = build :product
+
+      expect { product.price = Money.new(-1) }.to raise_exception
+    end
+  end
+end

data/spec/panier/domain/receipt_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+include Panier
+
+describe Domain::Receipt do
+  let(:line_items) do
+    [
+      build(:taxable_line_item, product_price: Money.new(100)),
+      build(:taxable_line_item, product_price: Money.new(200))
+    ]
+  end
+
+  describe '#initialize' do
+    it 'should initialize the line items' do
+      receipt = Domain::Receipt.new(line_items)
+      expect(receipt.line_items).to eq(line_items)
+    end
+  end
+
+  describe '#total_amount' do
+    it 'should calculate the total value of the receipt including tax' do
+      receipt = Domain::Receipt.new(line_items)
+      expect(receipt.total_amount).to eq(Money.new(330))
+    end
+  end
+
+  describe '#total_tax' do
+    it 'should calculate the total tax present on the receipt' do
+      receipt = Domain::Receipt.new(line_items)
+      expect(receipt.total_tax).to eq(Money.new(30))
+    end
+  end
+end

data/spec/panier/domain/round_up_rounding_spec.rb

@@ -0,0 +1,26 @@
+require 'rspec'
+
+include Panier
+
+describe Domain::RoundUpRounding do
+
+  it 'rounds low values up to the nearest increment' do
+    strategy = Domain::RoundUpRounding.new
+    expect(strategy.round(Money.new(11))).to eq(Money.new(15))
+  end
+
+  it 'rounds median values up to the nearest increment' do
+    strategy = Domain::RoundUpRounding.new(4)
+    expect(strategy.round(Money.new(2))).to eq(Money.new(4))
+  end
+
+  it 'rounds high values up to the nearest increment' do
+    strategy = Domain::RoundUpRounding.new
+    expect(strategy.round(Money.new(14))).to eq(Money.new(15))
+  end
+
+  it 'does not change values divisible by the increment' do
+    strategy = Domain::RoundUpRounding.new
+    expect(strategy.round(Money.new(15))).to eq(Money.new(15))
+  end
+end

data/spec/panier/domain/tax_class_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+include Panier
+
+describe Domain::TaxClass do
+  describe '#initialize' do
+    it 'assigns its arguments to attributes' do
+      name = 'Basic sales tax'
+      rate = 0.1
+      tax_class = Domain::TaxClass.new(name, rate)
+      expect(tax_class.name).to eq(name)
+      expect(tax_class.rate).to eq(rate)
+    end
+
+    it 'rejects negative tax rates' do
+      name = 'Backwards sales tax'
+      rate = -0.1
+      expect { Domain::TaxClass.new(name, rate) }.to raise_error
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require 'rspec'
+require 'faker'
+require 'factory_girl'
+require 'active_support'
+require 'active_support/dependencies'
+relative_load_paths = %w(lib)
+ActiveSupport::Dependencies.autoload_paths += relative_load_paths
+
+FactoryGirl.find_definitions
+
+# rspec
+RSpec.configure do |config|
+  config.include FactoryGirl::Syntax::Methods
+end