invoicing 0.2.1 → 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 460fa683bd1ba56dede941135a9db41b2b7236cf
+  data.tar.gz: 0ab573110cdf7d5c6bb424b2f69880f2f3a6d347
+SHA512:
+  metadata.gz: cf54abdd39ade52d2c41ad3757cd4b4b482853bb189e0ac0fe8371a6b5641de5f702557159a61a3d0332a012493b0258420ed7624306b5ff8cb6edb8e306c7b8
+  data.tar.gz: 4a41f9ba2236663d0463348cf5880a89e4d54e4d342e59ba147de4d8d33a4a1ba607422112e6b6db2d18d86d68c7c4eeb124eace3c2c9af7ed81451026466edc

data/LICENSE

@@ -1,5 +1,6 @@
 Copyright (c) 2009 Martin Kleppmann
 Copyright (c) 2009 Ept Computing Limited
+Copyright (c) 2014 Codemancers Tech Pvt Limited
 
 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

data/README.md

@@ -0,0 +1,57 @@
+# Ruby Invoicing Framework
+[![Build Status](https://travis-ci.org/code-mancers/invoicing.svg?branch=master)](https://travis-ci.org/code-mancers/invoicing)
+[![Code Climate](https://codeclimate.com/github/code-mancers/invoicing.png)](https://codeclimate.com/github/code-mancers/invoicing)
+
+## Description
+
+This is a framework for generating and displaying invoices (ideal for commercial
+Rails apps). It allows for flexible business logic; provides tools for tax handling,
+commission calculation etc. It aims to be both developer-friendly and
+accountant-friendly. Please visit invoicing [page](http://invoicing.codemancers.com/)
+for more information about how to install and use.
+
+## Features
+
+1. Store any number of different types of invoice, credit note and payment
+   record
+2. Represent customer accounts, supplier accounts, and even complicated
+   multi-party billing relationships
+3. Automatically format currency values beautifully
+4. Automatically round currency values to the customary precision for that
+   particular currency, e.g. based on the smallest coin in circulation
+5. Support any number of different currencies simultaneously
+6. Render invoices, account statements etc. into HTML (fully styleable and
+   internationalisable)
+7. Export into the UBL XML format for sharing data with other systems
+8. Provide you with a default Value Added Tax (VAT) implementation, but you
+   can also easily plug in your own tax logic
+9. Dynamically display tax-inclusive or tax-exclusive prices depending on
+   your customer's location and preferences
+10. Deal with tax rates or prices changing over time, and automatically
+    switch to the new rate at the right moment
+11. Efficiently summarise account balances, sales statements etc. under
+    arbitrary conditions (e.g. data from one quarter, or payments due at a
+    particular date)
+
+## TODOs
+
+1. Slowly move away from `acts-as` model.
+2. Multiple taxes can be applied on goodies.
+3. Improve documentation for taxes
+
+
+## Credits
+
+The Ruby invoicing framework originated as part of the website
+[Bid for Wine](http://www.bidforwine.co.uk), developed by Patrick Dietrich,
+Conrad Irwin, Michael Arnold and Martin Kleppmann for Ept Computing Ltd.
+It was extracted from the Bid for Wine codebase and substantially extended
+by Martin Kleppmann.
+
+## License
+
+Copyright (c) 2009 Martin Kleppmann, Ept Computing Limited.
+Copyright (c) 2014 Codemancers Tech Pvt Ltd
+
+This gem is made publicly available under the terms of the MIT license.
+See LICENSE and/or COPYING for details.

data/Rakefile

@@ -1,43 +1,22 @@
-%w[rubygems rake rake/clean fileutils newgem rubigen hoe].each { |f| require f }
-require File.dirname(__FILE__) + '/lib/invoicing'
-
-# Hoe calls Ruby with the "-w" set by default; unfortunately, ActiveRecord (at version 2.2.2
-# at least) causes a lot of warnings internally, by no fault of our own, which clutters
-# the output. Comment out the following four lines to see those warnings.
-class Hoe
-  RUBY_FLAGS = ENV['RUBY_FLAGS'] || "-I#{%w(lib test).join(File::PATH_SEPARATOR)}" +
-      ((defined?(RUBY_DEBUG) && RUBY_DEBUG) ? " #{RUBY_DEBUG}" : '')
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
 end
 
-# Generate all the Rake tasks
-# Run 'rake -T' to see list of generated tasks (from gem root directory)
-$hoe = Hoe.spec 'invoicing' do |p|
-  p.version = Invoicing::VERSION
-  p.developer 'Martin Kleppmann', 'rubyforge@eptcomputing.com'
-
-  p.summary = p.paragraphs_of('README.rdoc', 3).join
-  p.description = p.paragraphs_of('README.rdoc', 3..5).join("\n\n")
-  p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n")
-  p.post_install_message = 'PostInstall.txt'
-  p.rubyforge_name = p.name
+require 'rubygems'
+require 'rake'
+require 'rake/clean'
+require 'fileutils'
+require 'rake/testtask'
 
-  p.extra_deps = [
-    ['activerecord', '>= 2.1.0'],
-    ['builder', '>= 2.0']
-  ]
-  p.extra_dev_deps = [
-    ['newgem', ">= #{::Newgem::VERSION}"]
-    #['invoicing_generator', "= #{Invoicing::VERSION}"] - causes a circular dependency in rubygems < 1.2
-  ]
+# Tasks to run by default
+task :default => [:test]
 
-  p.test_globs = %w[test/*_test.rb] # do not include test/models/*.rb
-  p.clean_globs |= %w[**/.DS_Store tmp *.log coverage]
-  p.rsync_args = '-av --delete --ignore-errors'
-  p.remote_rdoc_dir = 'doc'
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/**/*_test.rb']
+  t.warning = false
 end
 
-require 'newgem/tasks' # load /tasks/*.rake
-Dir['tasks/**/*.rake'].each { |t| load t }
-
-# Tasks to run by default
-# task :default => [:spec, :features]
+Bundler::GemHelper.install_tasks

data/lib/invoicing.rb

@@ -1,12 +1,22 @@
-$:.unshift(File.dirname(__FILE__)) unless
-  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+require "active_record"
 
-require 'activerecord'
+require "invoicing/class_info"  # load first because other modules depend on this
+require "invoicing/cached_record"
+require "invoicing/connection_adapter_ext"
+require "invoicing/currency_value"
+require "invoicing/find_subclasses"
+require "invoicing/ledger_item"
+require "invoicing/line_item"
+require "invoicing/price"
+require "invoicing/tax_rate"
+require "invoicing/taxable"
+require "invoicing/time_dependent"
 
-require 'invoicing/class_info'  # load first because other modules depend on this
-Dir.glob(File.join(File.dirname(__FILE__), 'invoicing/**/*.rb')).sort.each {|f| require f }
-
-# Mix all modules Invoicing::*::ActMethods into ActiveRecord::Base as class methods
-Invoicing.constants.map{|c| Invoicing.const_get(c) }.select{|m| m.is_a?(Module) && m.const_defined?('ActMethods') }.each{
-  |m| ActiveRecord::Base.send(:extend, m.const_get('ActMethods'))
-}
+ActiveRecord::Base.send(:extend, Invoicing::CachedRecord::ActMethods)
+ActiveRecord::Base.send(:extend, Invoicing::CurrencyValue::ActMethods)
+ActiveRecord::Base.send(:extend, Invoicing::LedgerItem::ActMethods)
+ActiveRecord::Base.send(:extend, Invoicing::LineItem::ActMethods)
+ActiveRecord::Base.send(:extend, Invoicing::Price::ActMethods)
+ActiveRecord::Base.send(:extend, Invoicing::TaxRate::ActMethods)
+ActiveRecord::Base.send(:extend, Invoicing::Taxable::ActMethods)
+ActiveRecord::Base.send(:extend, Invoicing::TimeDependent::ActMethods)

data/lib/invoicing/cached_record.rb

@@ -1,3 +1,5 @@
+require 'active_support/concern'
+
 module Invoicing
   # == Aggressive ActiveRecord cache
   #
@@ -20,6 +22,7 @@ module Invoicing
   # To activate +CachedRecord+, call +acts_as_cached_record+ in the scope of an
   # <tt>ActiveRecord::Base</tt> class.
   module CachedRecord
+    extend ActiveSupport::Concern
 
     module ActMethods
       # Call +acts_as_cached_record+ on an <tt>ActiveRecord::Base</tt> class to declare
@@ -63,7 +66,7 @@ module Invoicing
       def cached_record_list
         cached_record_class_info.list
       end
-      
+
       # Reloads the cached objects from the database.
       def reload_cache
         cached_record_class_info.reload_cache
@@ -78,12 +81,12 @@ module Invoicing
         super
         reload_cache
       end
-      
+
       def reload_cache
         @cache = {}
-        model_class.find(:all).each {|obj| @cache[get(obj, :id)] = obj }
+        model_class.all.each {|obj| @cache[get(obj, :id)] = obj }
       end
-  
+
       # Returns one object from the cache, given its ID.
       def find_one(id, options)
         if result = @cache[id]
@@ -92,12 +95,12 @@ module Invoicing
           raise ::ActiveRecord::RecordNotFound, "Couldn't find #{model_class.name} with ID=#{id}"
         end
       end
-      
+
       # Returns a list of objects from the cache, given a list of IDs.
       def find_some(ids, options)
         ids.map{|id| find_one(id, options) }
       end
-      
+
       # Returns a list of all objects in the cache.
       def list
         @cache.values

data/lib/invoicing/class_info.rb

@@ -18,19 +18,19 @@ module Invoicing
   #           Invoicing::ClassInfo.acts_as(MyNamespace::Teleporter, self, args)
   #         end
   #       end
-  #       
+  #
   #       def transmogrify_the_instance     # will become an instance method of the class on which the
   #         info = teleporter_class_info    # acts_as_ method is called.
   #         info.do_transmogrify
   #       end
-  #       
+  #
   #       module ClassMethods
   #         def transmogrify_the_class      # will become a class method of the class on which the
   #           info = teleporter_class_info  # acts_as_ method is called.
   #           info.do_transmogrify
   #         end
   #       end
-  #       
+  #
   #       class ClassInfo < Invoicing::ClassInfo::Base
   #         def do_transmogrify
   #           case all_options[:transmogrification]
@@ -40,7 +40,7 @@ module Invoicing
   #       end
   #     end
   #   end
-  #   
+  #
   #   ActiveRecord::Base.send(:extend, MyNamespace::Teleporter::ActMethods)
   #
   #
@@ -51,11 +51,11 @@ module Invoicing
   #   class Teleporter < ActiveRecord::Base
   #     acts_as_teleporter 'Zoom2020', :transmogrification => :total
   #   end
-  #   
+  #
   #   Teleporter.transmogrify_the_class               # both return "Transmogrified by Zoom2020"
   #   Teleporter.find(42).transmogrify_the_instance
   module ClassInfo
-    
+
     # Provides the main implementation pattern for an +acts_as_+ method. See the example above
     # for usage.
     # +source_module+:: The module object which is using the +ClassInfo+ pattern
@@ -65,28 +65,28 @@ module Invoicing
       # The name by which the particular module using ClassInfo is known
       module_name = source_module.name.split('::').last.underscore
       class_info_method = "#{module_name}_class_info"
-      
-      previous_info = if calling_class.private_instance_methods(true).include?(class_info_method)
-        # acts_as has been called before on the same class, or a superclass
-        calling_class.send(class_info_method)
-      else
-        # acts_as is being called for the first time -- do the mixins!
-        calling_class.send(:include, source_module)
-        calling_class.send(:extend,  source_module.const_get('ClassMethods')) if source_module.constants.include? 'ClassMethods'
-        nil # no previous_info
-      end
-      
+
+      previous_info =
+        if calling_class.respond_to?(class_info_method, true)
+          # acts_as has been called before on the same class, or a superclass
+          calling_class.send(class_info_method) || calling_class.superclass.send(class_info_method)
+        else
+          # acts_as is being called for the first time -- do the mixins!
+          calling_class.send(:include, source_module)
+          nil # no previous_info
+        end
+
       # Instantiate the ClassInfo::Base subclass and assign it to an instance variable in calling_class
       class_info_class = source_module.const_get('ClassInfo')
       class_info = class_info_class.new(calling_class, previous_info, args)
       calling_class.instance_variable_set("@#{class_info_method}", class_info)
-      
+
       # Define a getter class method on calling_class through which the ClassInfo::Base
       # instance can be accessed.
       calling_class.class_eval <<-CLASSEVAL
         class << self
           def #{class_info_method}
-            if superclass.private_instance_methods(true).include?("#{class_info_method}")
+            if superclass.respond_to?("#{class_info_method}", true)
               @#{class_info_method} ||= superclass.send("#{class_info_method}")
             end
             @#{class_info_method}
@@ -94,7 +94,7 @@ module Invoicing
           private "#{class_info_method}"
         end
       CLASSEVAL
-      
+
       # For convenience, also define an instance method which does the same as the class method
       calling_class.class_eval do
         define_method class_info_method do
@@ -103,8 +103,8 @@ module Invoicing
         private class_info_method
       end
     end
-    
-     
+
+
     # Base class for +ClassInfo+ objects, from which you need to derive a subclass in each module where
     # you want to use +ClassInfo+. An instance of a <tt>ClassInfo::Base</tt> subclass is created every
     # time an +acts_as_+ method is called, and that instance can be accessed through the
@@ -112,27 +112,27 @@ module Invoicing
     class Base
       # The class on which the +acts_as_+ method was called
       attr_reader :model_class
-      
+
       # The <tt>ClassInfo::Base</tt> instance created by the last +acts_as_+ method
       # call on the same class (or its superclass); +nil+ if this is the first call.
       attr_reader :previous_info
-      
+
       # The list of arguments passed to the current +acts_as_+ method call (excluding the final options hash)
       attr_reader :current_args
-      
+
       # Union of +current_args+ and <tt>previous_info.all_args</tt>
       attr_reader :all_args
-      
+
       # <tt>self.all_args - previous_info.all_args</tt>
       attr_reader :new_args
-      
+
       # The options hash passed to the current +acts_as_+ method call
       attr_reader :current_options
-      
+
       # Hash of options with symbolized keys, with +option_defaults+ overridden by +previous_info+ options,
       # in turn overridden by +current_options+.
       attr_reader :all_options
-      
+
       # Initialises a <tt>ClassInfo::Base</tt> instance and parses arguments.
       # If subclasses override +initialize+ they should call +super+.
       # +model_class+::   The class on which the +acts_as+ method was called
@@ -150,26 +150,26 @@ module Invoicing
         @current_options = args.extract_options!.symbolize_keys
         @all_options = (@previous_info.nil? ? option_defaults : @previous_info.all_options).clone
         @all_options.update(@current_options)
-        
+
         @all_args = @new_args = @current_args = args.flatten.uniq
         unless @previous_info.nil?
           @all_args = (@previous_info.all_args + @all_args).uniq
           @new_args = @all_args - previous_info.all_args
         end
       end
-      
+
       # Override this method to return a hash of default option values.
       def option_defaults
         {}
       end
-    
+
       # If there is an option with the given key, returns the associated value; otherwise returns
       # the key. This is useful for mapping method names to their renamed equivalents through options.
       def method(name)
         name = name.to_sym
         (all_options[name] || name).to_s
       end
-      
+
       # Returns the value returned by calling +method_name+ (renamed through options using +method+)
       # on +object+. Returns +nil+ if +object+ is +nil+ or +object+ does not respond to that method.
       def get(object, method_name)
@@ -184,4 +184,4 @@ module Invoicing
       end
     end
   end
-end
+end

data/lib/invoicing/connection_adapter_ext.rb

@@ -2,20 +2,20 @@ module Invoicing
   # Extensions specific to certain database adapters. Currently only MySQL and PostgreSQL are
   # supported.
   class ConnectionAdapterExt
-  
+
     # Creates a database-specific SQL fragment for evaluating a three-legged conditional function
     # in a query.
     def self.conditional_function(condition, value_if_true, value_if_false)
       case ActiveRecord::Base.connection.adapter_name
         when "MySQL"
           "IF(#{condition}, #{value_if_true}, #{value_if_false})"
-        when "PostgreSQL"
+        when "PostgreSQL", "SQLite"
           "CASE WHEN #{condition} THEN #{value_if_true} ELSE #{value_if_false} END"
         else
           raise "Database adapter #{ActiveRecord::Base.connection.adapter_name} not supported by invoicing gem"
       end
     end
-    
+
     # Suppose <tt>A has_many B</tt>, and you want to select all As, counting for each A how many
     # Bs it has. In MySQL you can just say:
     #   SELECT A.*, COUNT(B.id) AS number_of_bs FROM A LEFT JOIN B on A.id = B.a_id GROUP BY A.id
@@ -32,7 +32,7 @@ module Invoicing
         when "MySQL"
           model_class.quoted_table_name + "." +
             ActiveRecord::Base.connection.quote_column_name(model_class.primary_key)
-        when "PostgreSQL"
+        when "PostgreSQL", "SQLite"
           model_class.column_names.map{ |column|
             model_class.quoted_table_name + "." + ActiveRecord::Base.connection.quote_column_name(column)
           }.join(', ')

data/lib/invoicing/countries/uk.rb

@@ -6,27 +6,27 @@ module Invoicing
         def tax_rate(params)
           params[:model_object].send(:tax_rate)
         end
-        
+
         def tax_factor(params)
           BigDecimal('1') + tax_rate(params).rate
         end
-        
+
         def tax_percent(params)
           BigDecimal('100') * tax_rate(params).rate
         end
-        
+
         def apply_tax(params)
           params[:value] * tax_factor(params)
         end
-        
+
         def remove_tax(params)
           params[:value] / tax_factor(params)
         end
-        
+
         def tax_info(params)
           "(inc. VAT)"
         end
-        
+
         def tax_details(params)
           "(including VAT at #{tax_percent(params).to_s}%)"
         end