invoicing 0.1.0

data/test/ref-output/invoice2.html

@@ -0,0 +1,86 @@
+<h1 class="invoice">Invoice</h1>
+<table class="invoice addresses">
+    <tr>
+        <th class="recipient">Recipient</th>
+        <th class="sender">Sender</th>
+    </tr>
+    <tr>
+        <td class="recipient vcard">
+            <div class="fn org">Unlimited Limited</div>
+            <div class="contact">Mr B. Badger</div>
+            <div class="adr">
+                <span class="street-address">The Sett<br />5 Badger Lane</span><br />
+                <span class="locality">Badgertown</span><br />
+                <span class="postal-code">Badger999</span><br />
+                <span class="country-name">England</span>
+            </div>
+        </td>
+        <td class="sender vcard">
+            <div class="fn org">Lovely Customer Inc.</div>
+            <div class="contact">Fred</div>
+            <div class="adr">
+                <span class="street-address">The pasture</span><br />
+                <span class="locality">Mootown</span><br />
+                <span class="region">Cow Kingdom</span><br />
+                <span class="postal-code">MOOO</span><br />
+                <span class="country-name">Scotland</span>
+            </div>
+        </td>
+    </tr>
+    <tr>
+        <td class="recipient">
+            VAT number:<br /><span class="tax-number">123456789</span>
+        </td>
+        <td class="sender">
+            VAT number:<br /><span class="tax-number">987654321</span>
+        </td>
+    </tr>
+</table>
+<table class="invoice metadata">
+    <tr class="identifier">
+        <th>Invoice no.:</th>
+        <td>12-ASDF</td>
+    </tr>
+    <tr class="issue-date">
+        <th>Issue date:</th>
+        <td>2009-01-01</td>
+    </tr>
+    <tr class="period-start">
+        <th>Period from:</th>
+        <td>2008-01-01</td>
+    </tr>
+    <tr class="period-end">
+        <th>Period until:</th>
+        <td>2009-01-01</td>
+    </tr>
+    <tr class="due-date">
+        <th>Payment due:</th>
+        <td>2009-01-31</td>
+    </tr>
+</table>
+<p class="invoice description">InvoiceSubtype 2</p>
+<table class="invoice line-items">
+    <tr>
+        <th class="tax-point">Tax point</th>
+        <th class="quantity">Quantity</th>
+        <th class="description">Description</th>
+        <th class="net-amount">Net price</th>
+        <th class="tax-amount">VAT</th>
+    </tr>
+    <tr>
+        <td class="tax-point">2009-01-01</td>
+        <td class="quantity">1.0</td>
+        <td class="description">moo</td>
+        <td class="net-amount">£123.45</td>
+        <td class="tax-amount">£18.52</td>
+    </tr>
+    <tr class="subtotal">
+        <th colspan="3">Subtotal</th>
+        <td class="net-amount">Net: £123.45</td>
+        <td class="tax-amount">VAT: £18.52</td>
+    </tr>
+    <tr class="total">
+        <th colspan="4">Total</th>
+        <td class="total-amount">£141.97</td>
+    </tr>
+</table>

data/test/ref-output/invoice2.xml

@@ -0,0 +1,98 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<ubl:SelfBilledInvoice xmlns:cac="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2" xmlns:ubl="urn:oasis:names:specification:ubl:schema:xsd:SelfBilledInvoice-2" xmlns:cbc="urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2">
+    <cbc:ID>12-ASDF</cbc:ID>
+    <cbc:UUID>fe4d20a0-d1b9-012b-48a5-0017f22d32c0</cbc:UUID>
+    <cbc:IssueDate>2009-01-01</cbc:IssueDate>
+    <cbc:IssueTime>00:00:00+00:00</cbc:IssueTime>
+    <cbc:TaxPointDate>2009-01-01</cbc:TaxPointDate>
+    <cbc:InvoiceTypeCode>InvoiceSubtype</cbc:InvoiceTypeCode>
+    <cbc:Note>InvoiceSubtype 2</cbc:Note>
+    <cac:InvoicePeriod>
+        <cbc:StartDate>2008-01-01</cbc:StartDate>
+        <cbc:StartTime>00:00:00+00:00</cbc:StartTime>
+        <cbc:EndDate>2009-01-01</cbc:EndDate>
+        <cbc:EndTime>00:00:00+00:00</cbc:EndTime>
+    </cac:InvoicePeriod>
+    <cac:AccountingCustomerParty>
+        <cac:Party>
+            <cac:PartyName>
+                <cbc:Name>Unlimited Limited</cbc:Name>
+            </cac:PartyName>
+            <cac:PostalAddress>
+                <cbc:StreetName>The Sett</cbc:StreetName>
+                <cbc:AdditionalStreetName>5 Badger Lane</cbc:AdditionalStreetName>
+                <cbc:CityName>Badgertown</cbc:CityName>
+                <cbc:PostalZone>Badger999</cbc:PostalZone>
+                <cbc:CountrySubentity></cbc:CountrySubentity>
+                <cac:Country>
+                    <cbc:IdentificationCode>GB</cbc:IdentificationCode>
+                    <cbc:Name>England</cbc:Name>
+                </cac:Country>
+            </cac:PostalAddress>
+            <cac:PartyTaxScheme>
+                <cbc:CompanyID>123456789</cbc:CompanyID>
+                <cac:TaxScheme>
+                    <cbc:ID>VAT</cbc:ID>
+                </cac:TaxScheme>
+            </cac:PartyTaxScheme>
+            <cac:Contact>
+                <cbc:Name>Mr B. Badger</cbc:Name>
+            </cac:Contact>
+        </cac:Party>
+    </cac:AccountingCustomerParty>
+    <cac:AccountingSupplierParty>
+        <cbc:CustomerAssignedAccountID>2</cbc:CustomerAssignedAccountID>
+        <cac:Party>
+            <cac:PartyName>
+                <cbc:Name>Lovely Customer Inc.</cbc:Name>
+            </cac:PartyName>
+            <cac:PostalAddress>
+                <cbc:StreetName>The pasture</cbc:StreetName>
+                <cbc:CityName>Mootown</cbc:CityName>
+                <cbc:PostalZone>MOOO</cbc:PostalZone>
+                <cbc:CountrySubentity>Cow Kingdom</cbc:CountrySubentity>
+                <cac:Country>
+                    <cbc:IdentificationCode>GB</cbc:IdentificationCode>
+                    <cbc:Name>Scotland</cbc:Name>
+                </cac:Country>
+            </cac:PostalAddress>
+            <cac:PartyTaxScheme>
+                <cbc:CompanyID>987654321</cbc:CompanyID>
+                <cac:TaxScheme>
+                    <cbc:ID>VAT</cbc:ID>
+                </cac:TaxScheme>
+            </cac:PartyTaxScheme>
+            <cac:Contact>
+                <cbc:Name>Fred</cbc:Name>
+            </cac:Contact>
+        </cac:Party>
+    </cac:AccountingSupplierParty>
+    <cac:PaymentTerms>
+        <cac:SettlementPeriod>
+            <cbc:StartDate>2009-01-01</cbc:StartDate>
+            <cbc:StartTime>00:00:00+00:00</cbc:StartTime>
+            <cbc:EndDate>2009-01-31</cbc:EndDate>
+            <cbc:EndTime>00:00:00+00:00</cbc:EndTime>
+        </cac:SettlementPeriod>
+    </cac:PaymentTerms>
+    <cac:TaxTotal>
+        <cbc:TaxAmount currencyID="GBP">18.52</cbc:TaxAmount>
+    </cac:TaxTotal>
+    <cac:LegalMonetaryTotal>
+        <cbc:TaxExclusiveAmount currencyID="GBP">123.45</cbc:TaxExclusiveAmount>
+        <cbc:PayableAmount currencyID="GBP">141.97</cbc:PayableAmount>
+    </cac:LegalMonetaryTotal>
+    <cac:InvoiceLine>
+        <cbc:ID>3</cbc:ID>
+        <cbc:UUID>0cc66060-cfac-012b-481d-0017f22d32c0</cbc:UUID>
+        <cbc:InvoicedQuantity>1.0</cbc:InvoicedQuantity>
+        <cbc:LineExtensionAmount currencyID="GBP">123.45</cbc:LineExtensionAmount>
+        <cbc:TaxPointDate>2009-01-01</cbc:TaxPointDate>
+        <cac:TaxTotal>
+            <cbc:TaxAmount currencyID="GBP">18.52</cbc:TaxAmount>
+        </cac:TaxTotal>
+        <cac:Item>
+            <cbc:Description>moo</cbc:Description>
+        </cac:Item>
+    </cac:InvoiceLine>
+</ubl:SelfBilledInvoice>

data/test/ref-output/invoice_null.html

@@ -0,0 +1,36 @@
+<h1 class="invoice">Invoice</h1>
+<table class="invoice metadata">
+    <tr class="identifier">
+        <th>Invoice no.:</th>
+        <td></td>
+    </tr>
+</table>
+<p class="invoice description">foo</p>
+<table class="invoice line-items">
+    <tr>
+        <th class="tax-point">Tax point</th>
+        <th class="quantity">Quantity</th>
+        <th class="description">Description</th>
+        <th class="net-amount">Net price</th>
+        <th class="tax-amount">VAT</th>
+        <th class="gross-amount">Gross price</th>
+    </tr>
+    <tr>
+        <td class="tax-point"></td>
+        <td class="quantity"></td>
+        <td class="description">moo</td>
+        <td class="net-amount">—</td>
+        <td class="tax-amount">—</td>
+        <td class="gross-amount">—</td>
+    </tr>
+    <tr class="subtotal">
+        <th colspan="3">Subtotal</th>
+        <td class="net-amount">Net: —</td>
+        <td class="tax-amount">VAT: —</td>
+        <td class="gross-amount"></td>
+    </tr>
+    <tr class="total">
+        <th colspan="5">Total</th>
+        <td class="total-amount">—</td>
+    </tr>
+</table>

data/test/render_html_test.rb

@@ -0,0 +1,69 @@
+# encoding: utf-8
+
+require File.join(File.dirname(__FILE__), 'test_helper.rb')
+
+class RenderHTMLTest < Test::Unit::TestCase
+
+  def reference_output(filename)
+    IO.readlines(File.join(File.dirname(__FILE__), 'ref-output', filename)).join
+  end
+  
+  def test_render_default_html_invoice
+    assert_equal reference_output('invoice1.html'), MyInvoice.find(1).render_html
+  end
+  
+  def test_render_self_billed_html_invoice
+    assert_equal reference_output('invoice2.html'), MyInvoice.find(2).render_html
+  end
+  
+  def test_render_html_credit_note
+    #File.open(File.join(File.dirname(__FILE__), 'ref-output', 'debug3.html'), 'w') do |f|
+    #  f.syswrite(MyCreditNote.find(3).render_html)
+    #end
+    assert_equal reference_output('creditnote3.html'), MyCreditNote.find(3).render_html
+  end
+  
+  def test_render_with_custom_fragments
+    expected = reference_output('invoice1.html').split("\n")[0..60]
+    expected[0] = "<h1>INVOICE</h1>"
+    expected[3] = "        <th class=\"recipient\">Customer</th>"
+    expected[4] = "        <th class=\"sender\">Supplier</th>"
+    rendered = MyInvoice.find(1).render_html {|i|
+      i.invoice_label{ "INVOICE" }
+      i.sender_label "Supplier"
+      i.recipient_label "Customer"
+      i.title_tag {|param| "<h1>#{param[:title]}</h1>\n" }
+      i.line_items_table {|param| ""}
+    }
+    assert_equal expected.join("\n") + "\n", rendered
+  end
+  
+  def test_render_empty_invoice
+    invoice = MyInvoice.new
+    invoice.line_items2 << SuperLineItem.new
+    invoice.save!
+    invoice.tax_amount2 = nil
+    invoice.total_amount2 = nil
+    rendered = invoice.render_html({:tax_point_column => true, :quantity_column => true,
+      :description_column => true, :net_amount_column => true, :tax_amount_column => true,
+      :gross_amount_column => true}) {|i| i.addresses_table{|x| ""}; i.description "foo" }
+    assert_equal reference_output('invoice_null.html'), rendered
+  end
+  
+  def test_render_with_null_fragment
+    assert_raise ArgumentError do
+      MyInvoice.find(1).render_html do |i|
+        i.invoice_label
+      end
+    end
+  end
+  
+  def test_render_with_too_many_fragments
+    assert_raise ArgumentError do
+      MyInvoice.find(1).render_html do |i|
+        i.invoice_label "a", "b"
+      end
+    end
+  end
+  
+end

data/test/render_ubl_test.rb

@@ -0,0 +1,32 @@
+# encoding: utf-8
+
+require File.join(File.dirname(__FILE__), 'test_helper.rb')
+
+class RenderUBLTest < Test::Unit::TestCase
+  
+  def reference_output(filename)
+    IO.readlines(File.join(File.dirname(__FILE__), 'ref-output', filename)).join
+  end
+  
+  def test_render_ubl_invoice
+    assert_equal reference_output('invoice1.xml'), MyInvoice.find(1).render_ubl
+  end
+  
+  def test_render_ubl_self_billed_invoice
+    assert_equal reference_output('invoice2.xml'), MyInvoice.find(2).render_ubl
+  end
+  
+  def test_render_ubl_credit_note
+    #File.open(File.join(File.dirname(__FILE__), 'ref-output', 'debug3.xml'), 'w') do |f|
+    #  f.syswrite(MyCreditNote.find(3).render_ubl)
+    #end
+    assert_equal reference_output('creditnote3.xml'),  MyCreditNote.find(3).render_ubl
+  end
+  
+  def test_cannot_render_unknown_ledger_item_subtype
+    assert_raise RuntimeError do
+      CorporationTaxLiability.find(6).render_ubl
+    end
+  end
+  
+end

data/test/setup.rb

@@ -0,0 +1,37 @@
+# This file is silently executed before the entire test suite runs, when run by 'rake test'.
+# To see its output, set the environment variable VERBOSE=1
+
+require File.join(File.dirname(__FILE__), "test_helper.rb")
+
+connection = ActiveRecord::Base.connection
+
+Dir.glob(File.join(File.dirname(__FILE__), 'fixtures', '*.sql')) do |filename|
+  file = File.new(File.expand_path(filename))
+  
+  command = ''
+  file.each do |line|
+  
+    # Hacks to make fixture loading work with postgres. Very very ugly. Sorry :-(
+    if ActiveRecord::Base.connection.adapter_name == 'PostgreSQL'
+      line.gsub!(/datetime/, 'timestamp')
+      line.gsub!(/tinyint\(1\)/, 'boolean')
+      line.gsub!(/0(\).) \-\- false/, 'false\1')
+      line.gsub!(/1(\).) \-\- true/, 'true\1')
+      line.gsub!(/int primary key auto_increment/, 'serial primary key')
+      line.gsub!(/ENGINE=.*;/, ';')
+    else
+      line.gsub!(/ALTER SEQUENCE .*/, '')
+    end
+    
+    line.gsub!(/\-\-.*/, '') # ignore comments
+    
+    if line =~ /(.*);\s*\Z/ # cut off semicolons at the end of a command
+      command += ' ' + $1
+      puts command.strip
+      connection.execute command
+      command = ''
+    else
+      command += ' ' + line.strip
+    end
+  end
+end

data/test/tax_rate_test.rb

@@ -0,0 +1,9 @@
+require File.join(File.dirname(__FILE__), 'test_helper.rb')
+
+class TaxRateTest < Test::Unit::TestCase
+  
+  def test_should_be_true
+    assert_equal(1,1)
+  end
+  
+end

data/test/taxable_test.rb

@@ -0,0 +1,180 @@
+# encoding: utf-8
+
+require File.join(File.dirname(__FILE__), 'test_helper.rb')
+
+class TaxableTest < Test::Unit::TestCase
+  
+  class SimpleTaxLogic
+    def apply_tax(params)
+      if params[:attribute].to_s == 'amount'
+        params[:value] * (BigDecimal('1.0') + params[:model_object].tax_factor)
+      else
+        params[:value]
+      end
+    end
+    
+    def remove_tax(params)
+      if params[:attribute].to_s == 'amount'
+        params[:value] / (BigDecimal('1.0') + params[:model_object].tax_factor)
+      else
+        params[:value]
+      end
+    end
+    
+    def tax_info(params)
+      if params[:attribute].to_s == 'amount'
+        "(inc. tax)"
+      else
+        ""
+      end
+    end
+    
+    def tax_details(params)
+      if params[:attribute].to_s == 'amount'
+        "(including #{sprintf('%.2f', 100*params[:model_object].tax_factor)}% tax)"
+      else
+        "(tax not applicable)"
+      end
+    end
+    
+    def some_other_method(options, param1, param2)
+      param1 * param2 + options[:model_object].id
+    end
+    
+    def mixin_methods
+      [:some_other_method]
+    end
+  end
+
+
+  class TaxableRecord < ActiveRecord::Base
+    validates_numericality_of :amount
+    acts_as_taxable :amount, :gross_amount, :tax_logic => SimpleTaxLogic.new, :currency => :currency_code
+  end
+  
+  class NonsenseClass < ActiveRecord::Base
+    set_table_name 'taxable_record'
+  end
+
+
+  ######################################################################
+  
+  def test_raises_error_if_no_tax_logic_is_specified
+    assert_raise ArgumentError do
+      NonsenseClass.class_eval do
+        acts_as_taxable :amount
+      end
+    end
+  end
+  
+  def test_apply_tax_on_existing_record
+    record = TaxableRecord.find(1)
+    assert_equal BigDecimal('141.09'), record.amount_taxed
+    assert_equal BigDecimal('123.45'), record.amount
+  end
+  
+  def test_apply_tax_on_new_record
+    record = TaxableRecord.new(:amount => '200', :tax_factor => '0.4', :currency_code => 'USD')
+    assert_equal BigDecimal('280'), record.amount_taxed
+    assert_equal BigDecimal('200'), record.amount
+    assert_equal '$280.00', record.amount_taxed_formatted
+    assert_equal '$200.00', record.amount_formatted
+    assert_equal '200', record.amount_before_type_cast
+    record.save!
+    assert_equal([{'amount' => '200.0000'}],
+      ActiveRecord::Base.connection.select_all("SELECT amount FROM taxable_records WHERE id=#{record.id}"))
+  end
+  
+  def test_remove_tax_on_existing_record
+    record = TaxableRecord.find(1)
+    record.amount_taxed = 114.29
+    assert_equal BigDecimal('100.00'), record.amount
+    assert_equal BigDecimal('114.29'), record.amount_taxed
+    assert_equal '£100.00', record.amount_formatted
+    assert_equal '£114.29', record.amount_taxed_formatted
+    assert_equal 114.29, record.amount_taxed_before_type_cast
+    record.save!
+    assert_equal([{'amount' => '100.0000'}],
+      ActiveRecord::Base.connection.select_all("SELECT amount FROM taxable_records WHERE id=1"))
+  end
+  
+  def test_remove_tax_on_new_record
+    record = TaxableRecord.new(:amount_taxed => '360', :tax_factor => '0.2', :currency_code => 'USD')
+    assert_equal BigDecimal('300'), record.amount
+    assert_equal BigDecimal('360'), record.amount_taxed
+    assert_equal '$300.00', record.amount_formatted
+    assert_equal '$360.00', record.amount_taxed_formatted
+    assert_equal '360', record.amount_taxed_before_type_cast
+    record.save!
+    assert_equal([{'amount' => '300.0000'}],
+      ActiveRecord::Base.connection.select_all("SELECT amount FROM taxable_records WHERE id=#{record.id}"))
+  end
+  
+  def test_assign_taxed_then_untaxed
+    record = TaxableRecord.find(1)
+    record.amount_taxed = '333.33'
+    record.amount = '1210.11'
+    assert_equal BigDecimal('1382.98'), record.amount_taxed
+    assert_equal BigDecimal('1210.11'), record.amount
+    assert_equal '1210.11', record.amount_before_type_cast
+  end
+  
+  def test_assign_untaxed_then_taxed
+    record = TaxableRecord.find(1)
+    record.amount = '0.02'
+    record.amount_taxed = '1142.86'
+    assert_equal BigDecimal('1000.00'), record.amount
+    assert_equal BigDecimal('1142.86'), record.amount_taxed
+    assert_equal '1142.86', record.amount_taxed_before_type_cast
+  end
+  
+  def test_no_rounding_error
+    record = TaxableRecord.new(:amount_taxed => 100, :tax_factor => 1.0/3.0)
+    assert_equal BigDecimal('0'), record.amount_tax_rounding_error
+    assert_equal BigDecimal('100'), record.amount_taxed
+    assert_equal BigDecimal('75'), record.amount
+  end
+  
+  def test_rounding_error_high
+    record = TaxableRecord.new(:amount_taxed => 1.04, :tax_factor => 0.175)
+    assert_equal BigDecimal('0.01'), record.amount_tax_rounding_error
+    assert_equal BigDecimal('0.89'), record.amount
+    assert_equal BigDecimal('1.05'), record.amount_taxed
+  end
+  
+  def test_rounding_error_low
+    record = TaxableRecord.new(:amount_taxed => 1.11, :tax_factor => 0.175)
+    assert_equal BigDecimal('1.10'), record.amount_taxed
+    assert_equal BigDecimal('0.94'), record.amount
+    assert_equal BigDecimal('-0.01'), record.amount_tax_rounding_error
+  end
+  
+  def test_tax_info
+    record = TaxableRecord.find(1)
+    assert_equal "(inc. tax)", record.amount_tax_info
+    assert_equal "", record.gross_amount_tax_info
+  end
+  
+  def test_tax_details
+    record = TaxableRecord.find(1)
+    assert_equal "(including 14.29% tax)", record.amount_tax_details
+    assert_equal "(tax not applicable)", record.gross_amount_tax_details
+  end
+
+  def test_with_tax_info
+    record = TaxableRecord.find(1)
+    assert_equal "£141.09 (inc. tax)", record.amount_with_tax_info
+    assert_equal "£141.09", record.gross_amount_with_tax_info
+  end
+  
+  def test_with_tax_details
+    record = TaxableRecord.find(1)
+    assert_equal "£141.09 (including 14.29% tax)", record.amount_with_tax_details
+    assert_equal "£141.09 (tax not applicable)", record.gross_amount_with_tax_details
+  end
+  
+  def test_other_method
+    record = TaxableRecord.find(1)
+    assert_equal 49, record.some_other_method(6, 8)
+  end
+end