invoicing 0.2.1 → 1.0.0

data/lib/invoicing/ledger_item/render_ubl.rb

@@ -1,10 +1,12 @@
+require "active_support/concern"
 require 'builder'
 
 module Invoicing
   module LedgerItem
     # Included into ActiveRecord model object when +acts_as_ledger_item+ is invoked.
     module RenderUBL
-      
+      extend ActiveSupport::Concern
+
       # Renders this invoice or credit note into a complete XML document conforming to the
       # {OASIS Universal Business Language}[http://ubl.xml.org/] (UBL) open standard for interchange
       # of business documents ({specification}[http://www.oasis-open.org/committees/ubl/]). This
@@ -29,30 +31,30 @@ module Invoicing
       def render_ubl(options={})
         UBLOutputBuilder.new(self, options).build
       end
-      
-      
+
+
       class UBLOutputBuilder #:nodoc:
         # XML Namespaces required by UBL
         UBL_NAMESPACES = {
           "xmlns:cac" => "urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2",
           "xmlns:cbc" => "urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2"
         }
-        
+
         UBL_DOC_NAMESPACES = {
           :Invoice              => "urn:oasis:names:specification:ubl:schema:xsd:Invoice-2",
           :SelfBilledInvoice    => "urn:oasis:names:specification:ubl:schema:xsd:SelfBilledInvoice-2",
           :CreditNote           => "urn:oasis:names:specification:ubl:schema:xsd:CreditNote-2",
           :SelfBilledCreditNote => "urn:oasis:names:specification:ubl:schema:xsd:SelfBilledCreditNote-2"
         }
-        
+
         attr_reader :ledger_item, :options, :cached_values, :doc_type, :factor
-        
+
         def initialize(ledger_item, options)
           @ledger_item = ledger_item
           @options = options
           @cached_values = {}
           subtype = ledger_item.send(:ledger_item_class_info).subtype
-          @doc_type = 
+          @doc_type =
             if [:invoice, :credit_note].include? subtype
               if total_amount >= BigDecimal('0')
                 @factor = BigDecimal('1')
@@ -65,7 +67,7 @@ module Invoicing
               raise RuntimeError, "render_ubl not implemented for ledger item subtype #{subtype.inspect}"
             end
         end
-        
+
         # For convenience while building the XML structure, method_missing redirects method calls
         # to the ledger item (taking account of method renaming via acts_as_ledger_item options);
         # calls to foo_of(line_item) are redirected to line_item.foo (taking account of method
@@ -80,20 +82,20 @@ module Invoicing
             cached_values[method_id] ||= ledger_item.send(:ledger_item_class_info).get(ledger_item, method_id)
           end
         end
-        
+
         # Returns a UBL XML rendering of the ledger item previously passed to the constructor.
         def build
           ubl = Builder::XmlMarkup.new :indent => 4
           ubl.instruct! :xml
-          
+
           ubl.ubl doc_type, UBL_NAMESPACES.clone.update({'xmlns:ubl' => UBL_DOC_NAMESPACES[doc_type]}) do |invoice|
             invoice.cbc :ID, identifier
             invoice.cbc :UUID, uuid if uuid
-            
+
             issue_date_formatted, issue_time_formatted = date_and_time(issue_date || Time.now)
             invoice.cbc :IssueDate, issue_date_formatted
             invoice.cbc :IssueTime, issue_time_formatted
-            
+
             # Different document types have the child elements InvoiceTypeCode, Note and
             # TaxPointDate in a different order. WTF?!
             if doc_type == :Invoice
@@ -105,13 +107,13 @@ module Invoicing
               invoice.cbc :InvoiceTypeCode, method_missing(:type) if doc_type == :SelfBilledInvoice
               invoice.cbc :Note, description
             end
-            
+
             invoice.cac :InvoicePeriod do |invoice_period|
               build_period(invoice_period, period_start, period_end)
             end if period_start && period_end
-            
+
             if [:Invoice, :CreditNote].include?(doc_type)
-            
+
               invoice.cac :AccountingSupplierParty do |supplier|
                 build_party supplier, sender_details
               end
@@ -119,9 +121,9 @@ module Invoicing
                 customer.cbc :SupplierAssignedAccountID, recipient_id
                 build_party customer, recipient_details
               end
-              
+
             elsif [:SelfBilledInvoice, :SelfBilledCreditNote].include?(doc_type)
-            
+
               invoice.cac :AccountingCustomerParty do |customer|
                 build_party customer, recipient_details
               end
@@ -129,32 +131,32 @@ module Invoicing
                 supplier.cbc :CustomerAssignedAccountID, sender_id
                 build_party supplier, sender_details
               end
-              
+
             end
-            
+
             invoice.cac :PaymentTerms do |payment_terms|
               payment_terms.cac :SettlementPeriod do |settlement_period|
                 build_period(settlement_period, issue_date || Time.now, due_date)
               end
             end if due_date && [:Invoice, :SelfBilledInvoice].include?(doc_type)
-            
+
             invoice.cac :TaxTotal do |tax_total|
               tax_total.cbc :TaxAmount, (factor*tax_amount).to_s, :currencyID => currency
             end if tax_amount
-            
+
             invoice.cac :LegalMonetaryTotal do |monetary_total|
               monetary_total.cbc :TaxExclusiveAmount, (factor*(total_amount - tax_amount)).to_s,
                 :currencyID => currency if tax_amount
               monetary_total.cbc :PayableAmount, (factor*total_amount).to_s, :currencyID => currency
             end
-            
+
             line_items.sorted(:tax_point).each do |line_item|
               line_tag = if [:CreditNote, :SelfBilledCreditNote].include? doc_type
                 :CreditNoteLine
               else
                 :InvoiceLine
               end
-              
+
               invoice.cac line_tag do |invoice_line|
                 build_line_item(invoice_line, line_item)
               end
@@ -162,8 +164,8 @@ module Invoicing
           end
           ubl.target!
         end
-        
-        
+
+
         # Given a <tt>Builder::XmlMarkup</tt> instance and two datetime objects, builds a UBL
         # representation of the period between the two dates and times, something like the
         # following:
@@ -180,8 +182,8 @@ module Invoicing
           xml.cbc :EndDate, end_date
           xml.cbc :EndTime, end_time
         end
-        
-        
+
+
         # Given a <tt>Builder::XmlMarkup</tt> instance and a supplier/customer details hash (as
         # returned by <tt>LedgerItem#sender_details</tt> and <tt>LedgerItem#recipient_details</tt>,
         # builds a UBL representation of that party, something like the following:
@@ -203,7 +205,7 @@ module Invoicing
             party.cac :PartyName do |party_name|
               party_name.cbc :Name, details[:name]
             end if details[:name]
-            
+
             party.cac :PostalAddress do |postal_address|
               street1, street2 = details[:address].strip.split("\n", 2)
               postal_address.cbc :StreetName,           street1               if street1
@@ -216,21 +218,21 @@ module Invoicing
                 country.cbc :Name,               details[:country]      if details[:country]
               end if details[:country_code] || details[:country]
             end
-            
+
             party.cac :PartyTaxScheme do |party_tax_scheme|
               party_tax_scheme.cbc :CompanyID, details[:tax_number]
               party_tax_scheme.cac :TaxScheme do |tax_scheme|
                 tax_scheme.cbc :ID, "VAT" # TODO: make country-dependent (e.g. GST in Australia)
               end
             end if details[:tax_number]
-            
+
             party.cac :Contact do |contact|
               contact.cbc :Name, details[:contact_name]
             end if details[:contact_name]
           end
         end
-        
-        
+
+
         # Given a <tt>Builder::XmlMarkup</tt> instance and a +LineItem+ instance, builds a UBL
         # representation of that line item, something like the following:
         #
@@ -251,11 +253,11 @@ module Invoicing
             tax_point_date, tax_point_time = date_and_time(tax_point_of(line_item))
             invoice_line.cbc :TaxPointDate, tax_point_date
           end
-          
+
           invoice_line.cac :TaxTotal do |tax_total|
             tax_total.cbc :TaxAmount, (factor*tax_amount_of(line_item)).to_s, :currencyID => currency
           end if tax_amount_of(line_item)
-          
+
           invoice_line.cac :Item do |item|
             item.cbc :Description, description_of(line_item)
             #cac:BuyersItemIdentification
@@ -263,7 +265,7 @@ module Invoicing
             #cac:ClassifiedTaxCategory
             #cac:ItemInstance
           end
-            
+
           #cac:Price
         end
 

data/lib/invoicing/line_item.rb

@@ -1,3 +1,5 @@
+require "active_support/concern"
+
 module Invoicing
   # = Line item objects
   #
@@ -27,12 +29,12 @@ module Invoicing
   #
   #   class ProductSale < LineItem
   #     belongs_to :product
-  #     
+  #
   #     def description
   #       product.title
   #     end
   #   end
-  #   
+  #
   #   class ShippingCharges < LineItem
   #     def description
   #       "Shipping charges"
@@ -52,11 +54,11 @@ module Invoicing
   #
   # +type+::
   #   String to store the class name, for ActiveRecord single table inheritance.
-  #  
+  #
   # +ledger_item+::
   #   You should define an association <tt>belongs_to :ledger_item, ...</tt> which returns the
   #   +LedgerItem+ object (invoice/credit note) to which this line item belongs.
-  #  
+  #
   # +ledger_item_id+::
   #   A foreign key of integer type, which stores the ID of the model object returned by the
   #   +ledger_item+ association.
@@ -69,7 +71,7 @@ module Invoicing
   #   currencies within one invoice.) See the documentation of the +CurrencyValue+ module for notes
   #   on suitable datatypes for monetary values. +acts_as_currency_value+ is automatically applied
   #   to this attribute.
-  #   
+  #
   # +tax_amount+::
   #   A decimal column containing the monetary amount of tax which is added to +net_amount+ to
   #   obtain the total price. This may of course be zero if no tax applies; otherwise it should have
@@ -130,6 +132,8 @@ module Invoicing
   #   These standard datetime columns are also recommended.
   #
   module LineItem
+    extend ActiveSupport::Concern
+
     module ActMethods
       # Declares that the current class is a model for line items (i.e. individual items on invoices
       # and credit notes).
@@ -143,38 +147,39 @@ module Invoicing
       #   acts_as_line_item :net_amount => :net_price
       def acts_as_line_item(*args)
         Invoicing::ClassInfo.acts_as(Invoicing::LineItem, self, args)
-        
+
         info = line_item_class_info
         if info.previous_info.nil? # Called for the first time?
           # Set the 'amount' columns to act as currency values
           acts_as_currency_value(info.method(:net_amount), info.method(:tax_amount))
-          
-          before_validation :calculate_tax_amount
-          
+
           extend Invoicing::FindSubclasses
-          
-          # Dynamically created named scopes
-          named_scope :in_effect, lambda{
-            ledger_assoc_id = line_item_class_info.method(:ledger_item).to_sym
-            ledger_refl = reflections[ledger_assoc_id]
-            ledger_table = ledger_refl.table_name # not quoted_table_name because it'll be quoted again
-            status_column = ledger_refl.klass.send(:ledger_item_class_info).method(:status)
-            { :joins => ledger_assoc_id,
-              :conditions => {"#{ledger_table}.#{status_column}" => ['closed', 'cleared'] } }
-          }
-          
-          named_scope :sorted, lambda{|column|
-            column = line_item_class_info.method(column).to_s
-            if column_names.include?(column)
-              {:order => "#{connection.quote_column_name(column)}, #{connection.quote_column_name(primary_key)}"}
-            else
-              {:order => connection.quote_column_name(primary_key)}
-            end
-          }
         end
       end
     end
-    
+
+    included do
+      before_validation :calculate_tax_amount
+
+      # Dynamically created named scopes
+      scope :in_effect, lambda {
+        ledger_assoc = line_item_class_info.method(:ledger_item).to_sym
+        ledger_refl = reflections[ledger_assoc]
+        ledger_table = ledger_refl.table_name # not quoted_table_name because it'll be quoted again
+        status_column = ledger_refl.klass.send(:ledger_item_class_info).method(:status)
+        joins(ledger_assoc).where("#{ledger_table}.#{status_column}" => ['closed', 'cleared'])
+      }
+
+      scope :sorted, lambda { |column|
+        column = line_item_class_info.method(column).to_s
+        if column_names.include?(column)
+          order("#{connection.quote_column_name(column)}, #{connection.quote_column_name(primary_key)}")
+        else
+          order(connection.quote_column_name(primary_key))
+        end
+      }
+    end
+
     # Overrides the default constructor of <tt>ActiveRecord::Base</tt> when +acts_as_line_item+
     # is called. If the +uuid+ gem is installed, this constructor creates a new UUID and assigns
     # it to the +uuid+ property when a new line item model object is created.
@@ -193,12 +198,12 @@ module Invoicing
       raise RuntimeError, 'Cannot determine currency for line item without a ledger item' if ledger_item.nil?
       ledger_item.send(:ledger_item_class_info).get(ledger_item, :currency)
     end
-    
+
     def calculate_tax_amount
       return unless respond_to? :net_amount_taxed
       self.tax_amount = net_amount_taxed - net_amount
     end
-    
+
     # The sum of +net_amount+ and +tax_amount+.
     def gross_amount
       net_amount = line_item_class_info.get(self, :net_amount)
@@ -210,7 +215,7 @@ module Invoicing
     def gross_amount_formatted
       format_currency_value(gross_amount)
     end
-    
+
     # We don't actually implement anything using +method_missing+ at the moment, but use it to
     # generate slightly more useful error messages in certain cases.
     def method_missing(method_id, *args)
@@ -225,15 +230,15 @@ module Invoicing
         super
       end
     end
-    
-    
+
+
     # Stores state in the ActiveRecord class object
     class ClassInfo < Invoicing::ClassInfo::Base #:nodoc:
       attr_reader :uuid_generator
-      
+
       def initialize(model_class, previous_info, args)
         super
-        
+
         begin # try to load the UUID gem
           require 'uuid'
           @uuid_generator = UUID.new
@@ -241,7 +246,7 @@ module Invoicing
           @uuid_generator = nil
         end
       end
-      
+
       # Allow methods generated by +CurrencyValue+ to be renamed as well
       def method(name)
         if name.to_s =~ /^(.*)_formatted$/
@@ -252,4 +257,4 @@ module Invoicing
       end
     end
   end
-end
+end

data/lib/invoicing/price.rb

@@ -2,7 +2,7 @@ module Invoicing
   module Price
     module ActMethods
       def acts_as_price(*args)
-        
+
       end
     end
   end

data/lib/invoicing/tax_rate.rb

@@ -3,20 +3,17 @@ module Invoicing
     module ActMethods
       def acts_as_tax_rate(*args)
         Invoicing::ClassInfo.acts_as(Invoicing::TaxRate, self, args)
+
         info = tax_rate_class_info
-        
         if info.previous_info.nil? # Called for the first time?
           # Import TimeDependent functionality
           acts_as_time_dependent :value => :rate
         end
       end
     end
-    
+
     # Stores state in the ActiveRecord class object
     class ClassInfo < Invoicing::ClassInfo::Base #:nodoc:
-      def initialize(model_class, previous_info, args)
-        super
-      end
-    end    
+    end
   end
 end

data/lib/invoicing/taxable.rb

@@ -1,5 +1,7 @@
 # encoding: utf-8
 
+require "active_support/concern"
+
 module Invoicing
   # = Computation of tax on prices
   #
@@ -108,7 +110,7 @@ module Invoicing
   #     </tr>
   #   <% end %>
   #   </table>
-  #   
+  #
   #   <h1>New product</h1>
   #   <% form_for(@product) do |f| %>
   #     <%= f.error_messages %>
@@ -143,33 +145,33 @@ module Invoicing
   #       # Should return a number greater than or equal to the input value. Don't worry about rounding --
   #       # CurrencyValue deals with that.
   #     end
-  #    
+  #
   #     def remove_tax(params)
   #       # Does the reverse of apply_tax -- converts a value with tax into a value without tax. The params
   #       # hash has the same format. First applying tax and then removing it again should always result in the
   #       # starting value (for the the same object and the same environment -- it may depend on time,
   #       # global variables, etc).
   #     end
-  #    
+  #
   #     def tax_info(params, *args)
   #       # Should return a short string to explain to users which operation has been performed by apply_tax
   #       # (e.g. if apply_tax has added VAT, the string could be "inc. VAT"). The params hash is the same as
   #       # given to apply_tax. Additional parameters are optional; if any arguments are passed to a call to
   #       # model_object.<attr>_tax_info then they are passed on here.
   #     end
-  #    
+  #
   #     def tax_details(params, *args)
   #       # Like tax_info, but should return a longer string for use in user interface elements which are less
   #       # limited in size.
   #     end
-  #    
+  #
   #     def mixin_methods
   #       # Optionally you can define a method mixin_methods which returns a list of method names which should
   #       # be included in classes which use this tax logic. Methods defined here become instance methods of
   #       # model objects with acts_as_taxable attributes. For example:
   #       [:some_other_method]
   #     end
-  #    
+  #
   #     def some_other_method(params, *args)
   #       # some_other_method was named by mixin_methods to be included in model objects. For example, if the
   #       # class MyProduct uses MyTaxLogic, then MyProduct.find(1).some_other_method(:foo, 'bar') will
@@ -181,7 +183,7 @@ module Invoicing
   #
   #
   # == Currency rounding errors
-  # 
+  #
   # Both the taxed and the untaxed value of an attribute are currency values, and so they must both be rounded
   # to the accuracy which is conventional for the currency in use (see the discussion of precision and rounding
   # in the +CurrencyValue+ module). If we are always storing untaxed values and outputting taxed values to the
@@ -191,20 +193,22 @@ module Invoicing
   # again, it is again rounded to the currency's conventional precision, and displayed to the user. If the
   # rounding steps have rounded the number upwards twice, or downwards twice, it may happen that the value
   # displayed to the user differs slightly from the one they originally entered.
-  # 
+  #
   # We believe that storing untaxed values and performing currency rounding are the right things to do, and this
   # apparent rounding error is a natural consequence. This module therefore tries to deal with the error
   # elegantly: If you assign a value to a taxed attribute and immediately read it again, it will return the
   # same value as if it had been stored and loaded again (i.e. the number you read has been rounded twice --
   # make sure the currency code has been assigned to the object beforehand, so that the +CurrencyValue+ module
   # knows which precision to apply).
-  # 
+  #
   # Moreover, after assigning a value to a <tt><attr>_taxed=</tt> attribute, the <tt><attr>_tax_rounding_error</tt>
   # method can tell you whether and by how much the value has changed as a result of removing and re-applying
   # tax. A negative number indicates that the converted amount is less than the input; a positive number indicates
   # that it is more than entered by the user; and zero means that there was no difference.
-  # 
+  #
   module Taxable
+    extend ActiveSupport::Concern
+
     module ActMethods
       # Declares that one or more attributes on this model object store monetary values to which tax may be
       # applied. Takes one or more attribute names, followed by an options hash:
@@ -216,14 +220,14 @@ module Invoicing
       # +acts_as_taxable+ implies +acts_as_currency_value+ with the same options. See the +Taxable+ for details.
       def acts_as_taxable(*args)
         Invoicing::ClassInfo.acts_as(Invoicing::Taxable, self, args)
-        
+
         attrs = taxable_class_info.new_args.map{|a| a.to_s }
         currency_attrs = attrs + attrs.map{|attr| "#{attr}_taxed"}
         currency_opts = taxable_class_info.all_options.update({:conversion_input => :convert_taxable_value})
         acts_as_currency_value(currency_attrs, currency_opts)
-        
+
         attrs.each {|attr| generate_attr_taxable_methods(attr) }
-        
+
         if tax_logic = taxable_class_info.all_options[:tax_logic]
           other_methods = (tax_logic.respond_to?(:mixin_methods) ? tax_logic.mixin_methods : []) || []
           other_methods.each {|method_name| generate_attr_taxable_other_method(method_name.to_s) }
@@ -232,7 +236,7 @@ module Invoicing
         end
       end
     end
-    
+
     # If +write_attribute+ is called on a taxable attribute, we note whether the taxed or the untaxed
     # version contains the latest correct value. We don't do the conversion immediately in case the tax
     # logic requires the value of another attribute (which may be assigned later) to do its calculation.
@@ -241,18 +245,19 @@ module Invoicing
       attr_regex = taxable_class_info.all_args.map{|a| a.to_s }.join('|')
       @taxed_or_untaxed ||= {}
       @taxed_attributes ||= {}
-      
+
       if attribute =~ /^(#{attr_regex})$/
         @taxed_or_untaxed[attribute] = :untaxed
         @taxed_attributes[attribute] = nil
       elsif attribute =~ /^(#{attr_regex})_taxed$/
+        @attributes[attribute] = value
         @taxed_or_untaxed[$1] = :taxed
         @taxed_attributes[$1] = value
       end
-      
+
       super
     end
-    
+
     # Called internally to convert between taxed and untaxed values. You shouldn't usually need to
     # call this method from elsewhere.
     def convert_taxable_value(attr) #:nodoc:
@@ -262,10 +267,10 @@ module Invoicing
 
       @taxed_or_untaxed ||= {}
       from_status = @taxed_or_untaxed[attr_without_suffix] || :untaxed # taxed or untaxed most recently assigned?
-      
+
       attr_to_read = attr_without_suffix
       attr_to_read += '_taxed' if from_status == :taxed
-      
+
       if from_status == :taxed && to_status == :taxed
         # Special case: remove tax, apply rounding errors, apply tax again, apply rounding errors again.
         write_attribute(attr_without_suffix, send(attr_without_suffix))
@@ -274,21 +279,21 @@ module Invoicing
         taxable_class_info.convert(self, attr_without_suffix, read_attribute(attr_to_read), from_status, to_status)
       end
     end
-    
+
     protected :write_attribute, :convert_taxable_value
 
 
     module ClassMethods #:nodoc:
       # Generate additional accessor method for attribute with getter +method_name+.
       def generate_attr_taxable_methods(method_name) #:nodoc:
-        
+
         define_method("#{method_name}_tax_rounding_error") do
           original_value = read_attribute("#{method_name}_taxed")
           return nil if original_value.nil? # Can only have a rounding error if the taxed attr was assigned
-          
+
           original_value = BigDecimal.new(original_value.to_s)
           converted_value = send("#{method_name}_taxed")
-          
+
           return nil if converted_value.nil?
           converted_value - original_value
         end
@@ -302,19 +307,19 @@ module Invoicing
           tax_logic = taxable_class_info.all_options[:tax_logic]
           tax_logic.tax_details({:model_object => self, :attribute => method_name, :value => send(method_name)}, *args)
         end
-        
+
         define_method("#{method_name}_with_tax_info") do |*args|
           amount = send("#{method_name}_taxed_formatted")
           tax_info = send("#{method_name}_tax_info").to_s
           tax_info.blank? ? amount : "#{amount} #{tax_info}"
         end
-        
+
         define_method("#{method_name}_with_tax_details") do |*args|
           amount = send("#{method_name}_taxed_formatted")
           tax_details = send("#{method_name}_tax_details").to_s
           tax_details.blank? ? amount : "#{amount} #{tax_details}"
         end
-        
+
         define_method("#{method_name}_taxed_before_type_cast") do
           @taxed_attributes ||= {}
           @taxed_attributes[method_name] ||
@@ -322,7 +327,7 @@ module Invoicing
             send("#{method_name}_taxed")
         end
       end
-      
+
       # Generate a proxy method called +method_name+ which is forwarded to the +tax_logic+ object.
       def generate_attr_taxable_other_method(method_name) #:nodoc:
         define_method(method_name) do |*args|
@@ -333,8 +338,8 @@ module Invoicing
 
       private :generate_attr_taxable_methods, :generate_attr_taxable_other_method
     end # module ClassMethods
-    
-    
+
+
     class ClassInfo < Invoicing::ClassInfo::Base #:nodoc:
       # Performs the conversion between taxed and untaxed values. Arguments +from_status+ and
       # +to_status+ must each be either <tt>:taxed</tt> or <tt>:untaxed</tt>.
@@ -342,7 +347,7 @@ module Invoicing
         return nil if value.nil?
         value = BigDecimal.new(value.to_s)
         return value if from_status == to_status
-        
+
         if to_status == :taxed
           all_options[:tax_logic].apply_tax({:model_object => object, :attribute => attr_without_suffix, :value => value})
         else
@@ -350,6 +355,6 @@ module Invoicing
         end
       end
     end
-    
+
   end
-end
+end