invoicing_generator 0.2.0

data/History.txt

@@ -0,0 +1,21 @@
+== 0.2.0 2009-04-20
+
+* 4 major enhancements:
+  * New associated gem invoicing_generator for generating an invoicing component in a Rails project
+    (script/generate invoicing_ledger)
+  * Generated controller and views for rendering statements and ledger
+  * Comes with a nice default stylesheet out of the box
+  * More flexible formatting of currency values
+* 1 bugfix:
+  * Accidental overwriting of total_amount value on payment LedgerItems without LineItems
+
+== 0.1.0 2009-02-10
+
+* 2 major enhancements:
+  * Core API is now usable
+  * RCov reports 100% test coverage
+
+== 0.0.1 2009-01-05
+
+* 1 major enhancement:
+  * Initial public release

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Martin Kleppmann
+Copyright (c) 2009 Ept Computing 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
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/Manifest.txt

@@ -0,0 +1,29 @@
+History.txt
+LICENSE
+Manifest.txt
+PostInstall.txt
+README.rdoc
+Rakefile
+lib/invoicing_generator.rb
+lib/invoicing_generator/generator_extensions.rb
+lib/invoicing_generator/name_tools.rb
+lib/invoicing_generator/option_tools.rb
+rails_generators/invoicing_ledger/USAGE
+rails_generators/invoicing_ledger/invoicing_ledger_generator.rb
+rails_generators/invoicing_ledger/templates/controller.rb
+rails_generators/invoicing_ledger/templates/credit_note.rb
+rails_generators/invoicing_ledger/templates/initializer.rb
+rails_generators/invoicing_ledger/templates/invoice.rb
+rails_generators/invoicing_ledger/templates/ledger_item.rb
+rails_generators/invoicing_ledger/templates/ledger_view.html
+rails_generators/invoicing_ledger/templates/line_item.rb
+rails_generators/invoicing_ledger/templates/migration.rb
+rails_generators/invoicing_ledger/templates/payment.rb
+rails_generators/invoicing_ledger/templates/statement_view.html
+rails_generators/invoicing_ledger/templates/stylesheet.css
+script/console
+script/destroy
+script/generate
+test/test_generator_helper.rb
+test/test_helper.rb
+test/test_invoicing_ledger_generator.rb

data/PostInstall.txt

@@ -0,0 +1,10 @@
+
+Thanks for trying the Ruby Invoicing Gem. Hope you find it useful.
+Do please blog and tweet about it (tag your posts with #invgem).
+
+Now please go to the root of your Rails project and type:
+    script/generate invoicing_ledger billing --currency=GBP
+(replace GBP with your currency if you do not use Pounds Sterling).
+For more information please go to http://ept.github.com/invoicing/
+
+

data/README.rdoc

@@ -0,0 +1,55 @@
+= Ruby Invoicing Framework
+
+* {Ruby Invoicing Framework website}[http://ept.github.com/invoicing/]
+* {API Reference Docs}[http://invoicing.rubyforge.org/doc/]
+* {Browse the code on GitHub}[http://github.com/ept/invoicing/]
+* {RubyForge project}[http://rubyforge.org/projects/invoicing/]
+* Email: Martin Kleppmann <ept@rubyforge.org>
+
+== 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.
+
+The Ruby Invoicing Framework is based on
+{ActiveRecord}[http://api.rubyonrails.org/classes/ActiveRecord/Base.html].
+
+Please see {the website}[http://ept.github.com/invoicing/] for an introduction
+to using Invoicing, and check the
+{API reference}[http://invoicing.rubyforge.org/doc/] for in-depth details.
+
+== FEATURES
+
+* TODO
+
+== REQUIREMENTS
+
+* ActiveRecord >= 2.1
+* Only MySQL and PostgreSQL databases are currently supported
+
+== INSTALL
+
+sudo gem install invoicing
+
+== STATUS
+
+So far, the Ruby Invoicing Framework has been tested with ActiveRecord 2.2.2,
+MySQL 5.0.67 and PostgreSQL 8.3.5. We will be testing it across a wider
+variety of versions soon.
+
+== 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.
+
+This gem is made publicly available under the terms of the MIT license.
+See LICENSE and/or COPYING for details.

data/Rakefile

@@ -0,0 +1,25 @@
+%w[rubygems rake rake/clean fileutils newgem rubigen].each { |f| require f }
+require File.dirname(__FILE__) + '/lib/invoicing_generator'
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new('invoicing_generator', InvoicingGenerator::VERSION) do |p|
+  p.developer('Martin Kleppmann', 'rubyforge@eptcomputing.com')
+  p.changes              = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  p.post_install_message = 'PostInstall.txt'
+  p.rubyforge_name       = 'invoicing'
+  p.extra_deps         = [
+    ['invoicing', "= #{InvoicingGenerator::VERSION}"],
+  ]
+  p.extra_dev_deps = [
+    ['newgem', ">= #{::Newgem::VERSION}"]
+  ]
+  
+  p.clean_globs |= %w[**/.DS_Store tmp *.log]
+  path = (p.rubyforge_name == p.name) ? p.rubyforge_name : "\#{p.rubyforge_name}/\#{p.name}"
+  p.remote_rdoc_dir = File.join(path.gsub(/^#{p.rubyforge_name}\/?/,''), 'rdoc')
+  p.rsync_args = '-av --delete --ignore-errors'
+end
+
+require 'newgem/tasks' # load /tasks/*.rake
+Dir['tasks/**/*.rake'].each { |t| load t }

data/lib/invoicing_generator.rb

@@ -0,0 +1,18 @@
+[
+  File.dirname(__FILE__),
+  File.join(File.dirname(__FILE__), '..', '..', 'invoicing', 'lib')
+].each do |dir|
+  unless !File.exists?(dir) || $:.include?(dir) || $:.include?(File.expand_path(dir))
+    $:.unshift dir
+  end
+end
+
+require 'invoicing'
+
+require 'invoicing_generator/generator_extensions'
+require 'invoicing_generator/name_tools'
+require 'invoicing_generator/option_tools'
+
+module InvoicingGenerator
+  VERSION = Invoicing::VERSION
+end

data/lib/invoicing_generator/generator_extensions.rb

@@ -0,0 +1,55 @@
+# Inject a custom command into the rails generator -- useful for rendering classes
+# nested inside modules.
+module Rails #:nodoc:
+  module Generator
+    module Commands
+      class Create
+        # A bit like the 'template' method, but wraps the rendered template output in a Ruby
+        # class definition, potentially nested in one or more module definitions.
+        # +class_details+ should be a hash in the form returned by
+        # InvoicingGenerator::NameTools#extract_name_details, detailing information about
+        # the class and to which file it should be written.
+        def nested_class_template(relative_source, class_details, template_options = {})
+          # Render the relative_source template
+          inside_template = render_file(source_path(relative_source), template_options) do |file|
+            vars = template_options[:assigns] || {}
+            b = binding
+            vars.each { |k,v| eval "#{k} = vars[:#{k}] || vars['#{k}']", b }
+            # Render the source file with the temporary binding
+            ERB.new(file.read, nil, '-').result(b)
+          end
+          
+          # Prepare class and module definitions
+          nesting = class_details[:class_nesting_array]
+          index = -1
+          header = nesting.map{|mod| index += 1; ('  ' * index) + "module #{mod}\n"}.join
+          header << ('  ' * nesting.size) + "class #{class_details[:class_name_base]}"
+          header << " < #{class_details[:superclass]}" unless [nil, ''].include? class_details[:superclass]
+          header << "\n"
+          footer = (0..nesting.size).to_a.reverse.map{|n| ('  ' * n) + "end\n"}.join
+          indent = '  ' * (nesting.size + 1)
+          
+          # Write everything to file
+          file(relative_source, class_details[:file_path_full], template_options) do
+            header + inside_template.split("\n").map{|line| "#{indent}#{line}"}.join("\n") + "\n" + footer
+          end
+        end
+        
+        # Based on the 'route_resources' method, but less restrictive. Adds arbitrary lines to
+        # the config/routes.rb file.
+        def add_routes(*lines)
+          text = (lines.flatten.map do |line|
+            line.strip!
+            logger.route line
+            "  #{line}\n"
+          end).join
+
+          sentinel = 'ActionController::Routing::Routes.draw do |map|'
+          unless options[:pretend]
+            gsub_file('config/routes.rb', /(#{Regexp.escape(sentinel)})/mi) {|match| "#{match}\n#{text}" }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/invoicing_generator/name_tools.rb

@@ -0,0 +1,83 @@
+# Tools for dealing with names of controllers or models, passed to us by the user
+# from the command line when invoking the generator. Designed to be included into
+# a subclass of Rails::Generator::NamedBase.
+#
+# This code is inspired by the generator in restful_authentication.
+module InvoicingGenerator
+  module NameTools
+  
+    # Analyses a name provided by the user on the command line, and returns a hash
+    # of useful bits of string based on that name:
+    #   extract_name_details 'MegaBlurb/foo/BAR_BLOBS', :kind => :controller, :extension => '.rb'
+    #   => {
+    #        :underscore_base     => 'bar_blobs',           # last part of the name, underscored
+    #        :camel_base          => 'BarBlobs',            # last part of the name, camelized
+    #        :underscore_singular => 'bar_blob',            # underscore_base forced to singular form
+    #        :camel_singular      => 'BarBlob',             # camel_base forced to singular form
+    #        :underscore_plural   => 'bar_blobs',           # underscore_base forced to plural form
+    #        :camel_plural        => 'BarBlobs',            # camel_base forced to plural form
+    #        :class_path_array    => ['mega_blurb', 'foo'], # array of lowercase, underscored directory names
+    #        :class_path          => 'mega_blurb/foo',      # class_path_array joined by filesystem separator
+    #        :class_nesting_array => ['MegaBlurb', 'Foo'],  # array of camelized module names
+    #        :class_nesting       => 'MegaBlurb::Foo',      # class_nesting_array joined by double colon
+    #        :nesting_depth       => 2,                     # length of class_path array
+    #
+    #        # The following depend on the given :kind
+    #        :file_path_base      => 'bar_blobs_controller.rb'                 # based on underscore_*
+    #        :file_path_full      => 'app/controllers/mega_blurb/foo/bar_blobs_controller.rb', # full file path
+    #        :class_name_base     => 'BarBlobsController',                     # file_path_base.camelize
+    #        :class_name_full     => 'MegaBlurb::Foo::BarBlobsController',     # = class_nesting + class_name_base
+    #      }
+    #
+    # Recognised options:
+    #   :kind => :model -- use conventions for creating a model object from the name
+    #   :kind => :controller -- use conventions for creating a controller from the name
+    def extract_name_details(user_specified_name, options={})
+      result = {}
+
+      # See Rails::Generator::NamedBase#extract_modules
+      modules = extract_modules(user_specified_name)
+      base_name                 = modules.shift
+      result[:class_path_array] = modules.shift
+      file_path                 = modules.shift
+      result[:class_nesting]    = modules.shift
+      result[:nesting_depth]    = modules.shift
+      result[:class_path]       = File.join(result[:class_path_array])
+      result[:class_nesting_array] = result[:class_nesting].split('::')
+      
+      result[:underscore_base]     = base_name.underscore
+      result[:camel_base]          = result[:underscore_base].camelize
+      result[:underscore_singular] = result[:underscore_base].singularize
+      result[:camel_singular]      = result[:underscore_singular].camelize
+      result[:underscore_plural]   = result[:underscore_singular].pluralize
+      result[:camel_plural]        = result[:underscore_plural].camelize
+      
+      if options[:kind] == :controller
+        result[:file_path_base] = "#{result[:underscore_base]}_controller"
+        path_prefix = File.join('app', 'controllers')
+      elsif options[:kind] == :model
+        result[:file_path_base] = result[:underscore_singular]
+        path_prefix = File.join('app', 'models')
+      else
+        raise 'unknown kind of name'
+      end
+      
+      result[:class_name_base] = result[:file_path_base].camelize
+      result[:file_path_base] += (options[:extension] || ".rb")
+      
+      if result[:nesting_depth] == 0
+        result[:file_path_full] = File.join(path_prefix, result[:file_path_base])
+        result[:class_name_full] = result[:class_name_base]
+      else
+        result[:file_path_full] = File.join(path_prefix, result[:class_path], result[:file_path_base])
+        result[:class_name_full] = "#{result[:class_nesting]}::#{result[:class_name_base]}"
+      end
+    
+      #result[:routing_name] = result[:singular_name]
+      #result[:routing_path] = result[:file_path].singularize
+      #result[:controller_name] = result[:plural_name]
+
+      result
+    end
+  end
+end

data/lib/invoicing_generator/option_tools.rb

@@ -0,0 +1,34 @@
+# Tools for parsing command line options. Designed to be included into
+# a subclass of Rails::Generator::NamedBase.
+module InvoicingGenerator
+  module OptionTools
+    protected
+    
+    # Overrides Rails::Generator::Options#add_options!
+    # Expects with_or_without_options to be defined in the importing class.
+    def add_options!(opt)
+      opt.separator ''
+      opt.separator 'Optional flags:'
+      with_or_without_options.each_pair do |key, val|
+        opt.on "--with-#{key}", val + (options[key] ? " (default)" : "") do
+          options[key] = true
+        end
+        opt.on "--without-#{key}", "don't #{val}" + (options[key] ? " (default)" : "") do
+          options[key] = false
+        end
+      end
+      opt.on("--debug", "print debugging output") { options[:debug] = true }
+    end
+    
+    # Output debugging info
+    def dump_details
+      name_details.each_pair do |key1, val1|
+        puts "#{key1}:"
+        val1.each_pair do |key2, val2|
+          puts "    %-40s %s" % ["#{key2}:", val2.inspect]
+        end
+      end
+    end
+    
+  end
+end

data/rails_generators/invoicing_ledger/USAGE

@@ -0,0 +1,20 @@
+Description:
+    Generates several model classes, a database migration, a controller and a
+    few views in a Rails project, constituting the core structure you need in
+    order to make use of the invoicing gem in your application.
+    
+    Once you have this structure in place you can start creating your own
+    Invoice and LineItem subclasses and store them in the database; the
+    generated controller/views will pick these up and present them nicely
+    out of the box.
+    
+    You can use the option flags to configure which fields you would like to
+    include in your database tables.
+  
+    After running this generator you should take a look at the generated
+    controller and model classes and search for occurrences of 'FIXME', since
+    a few manual tweaks will be required to integrate the generated code into
+    your project.
+
+Examples:
+    `./script/generate invoicing_ledger billing --currency=GBP`

data/rails_generators/invoicing_ledger/invoicing_ledger_generator.rb

@@ -0,0 +1,107 @@
+require 'invoicing_generator'
+
+# Rails generator which creates the migration, models and a controller to support a basic ledger.
+class InvoicingLedgerGenerator < Rails::Generator::NamedBase
+
+  include InvoicingGenerator::NameTools
+  include InvoicingGenerator::OptionTools
+
+  default_options :description => true, :period => true, :uuid => true, :due_date => true,
+    :tax_point => true, :quantity => true, :creator => true, :identifier => false,
+    :timestamps => true, :debug => false
+
+  attr_reader :name_details
+
+  def initialize(runtime_args, runtime_options = {})
+    super
+    @name_details = {
+      :controller  => extract_name_details(@name,                               :kind => :controller),
+      :ledger_item => extract_name_details(args.shift || 'Billing::LedgerItem', :kind => :model),
+      :line_item   => extract_name_details(args.shift || 'Billing::LineItem',   :kind => :model)
+    }
+    subclass_nesting = name_details[:ledger_item][:class_nesting]
+    subclass_nesting << '::' unless subclass_nesting == ''
+    name_details[:invoice]     = extract_name_details("#{subclass_nesting}Invoice",    :kind => :model)
+    name_details[:credit_note] = extract_name_details("#{subclass_nesting}CreditNote", :kind => :model)
+    name_details[:payment]     = extract_name_details("#{subclass_nesting}Payment",    :kind => :model)
+    
+    name_details[:controller ][:superclass] = 'ApplicationController'
+    name_details[:ledger_item][:superclass] = 'ActiveRecord::Base'
+    name_details[:invoice    ][:superclass] = name_details[:ledger_item][:class_name_base]
+    name_details[:credit_note][:superclass] = name_details[:ledger_item][:class_name_base]
+    name_details[:payment    ][:superclass] = name_details[:ledger_item][:class_name_base]
+    name_details[:line_item  ][:superclass] = 'ActiveRecord::Base'
+    
+    dump_details if options[:debug]
+  end
+  
+  def manifest
+    record do |m|
+      name_details.each_pair do |key, details|
+        # Check for class naming collisions.
+        m.class_collisions details[:class_path_array], details[:class_name_base]
+        
+        # Create directories
+        m.directory File.dirname(details[:file_path_full])
+        
+        # Create classes
+        m.nested_class_template "#{key}.rb", details, :assigns => { :name_details => name_details }
+      end
+      
+      # Migration
+      m.migration_template 'migration.rb', 'db/migrate', :migration_file_name => 'create_invoicing_ledger'
+      
+      # Static files
+      m.directory 'config/initializers'
+      m.file 'initializer.rb', 'config/initializers/invoicing.rb'
+      view_directory = File.join('app/views', name_details[:controller][:underscore_base])
+      m.directory view_directory
+      m.file 'statement_view.html', File.join(view_directory, 'statement.html.erb')
+      m.file 'ledger_view.html',    File.join(view_directory, 'ledger.html.erb')
+      m.file 'stylesheet.css',      File.join('public/stylesheets', 'invoicing_ledger.css')
+      
+      # Routes
+      ctrl = name_details[:controller][:underscore_base]
+      m.add_routes(
+        "map.ledger '#{ctrl}/:id/ledger', :controller => '#{ctrl}', :action => 'ledger'",
+        "map.statement '#{ctrl}/:id/:other_id', :controller => '#{ctrl}', :action => 'statement', :id => /\\d+/, :other_id => nil",
+        "map.document '#{ctrl}/document/:id', :controller => '#{ctrl}', :action => 'document'"
+      )
+    end
+  end
+
+  protected
+    def banner
+      <<-EOS
+Creates the model classes and migration for a ledger of accounting data.
+
+USAGE: #{$0} invoicing_ledger ControllerName [LedgerItemsModelName] [LineItemsModelName] [options]
+
+The recommended ControllerName is 'Billing'.
+The default model names are 'Billing::LedgerItem' and 'Billing::LineItem', respectively.
+EOS
+    end
+    
+    def with_or_without_options
+      {
+        :description => "create a description column for ledger and line items",
+        :period => "create start_period/end_period columns for ledger items",
+        :uuid => "create uuid columns for ledger and line items",
+        :due_date => "create a due_date column for ledger items",
+        :tax_point => "create a tax_point column for line items",
+        :quantity => "create a quantity column for line items",
+        :creator => "create a creator_id column for line items",
+        :identifier => "create an identifier column for ledger items",
+        :timestamps => "create created_at/updated_at columns"
+      }
+    end
+    
+    def add_options!(opt)
+      super
+      opt.separator ''
+      opt.separator 'Optional configuration values:'
+      opt.on "--currency=CODE", "set a default currency (3-letter code, e.g. USD or GBP)" do |currency|
+        options[:currency] = currency.nil? ? nil : currency.upcase
+      end
+    end
+end

data/rails_generators/invoicing_ledger/templates/controller.rb

@@ -0,0 +1,40 @@
+# GET /<%= name_details[:controller][:underscore_base] %>
+def index
+  # We suggest that you make this a redirect to the ledger or statement of the currently
+  # logged-in party, e.g.
+  #redirect_to ledger_url(current_user.company)
+end
+
+# Display a summary of sales, purchases, payments and receipts on accounts.
+# GET /<%= name_details[:controller][:underscore_base] %>/1/ledger  => From the point of view of party 1
+def ledger
+  # FIXME check if the current user is allowed to access this ledger
+  @self_id = params[:id].to_i
+  @summaries = <%= name_details[:ledger_item][:class_name_full] %>.account_summaries(@self_id)
+  @names = <%= name_details[:ledger_item][:class_name_full] %>.sender_recipient_name_map(@self_id, @summaries.keys)
+end
+
+# GET /<%= name_details[:controller][:underscore_base] %>/1    => Show list of transactions where 1 is sender_id or recipient_id
+# GET /<%= name_details[:controller][:underscore_base] %>/1/2  => Show list of transactions between parties 1 and 2
+def statement
+  # FIXME check if the current user is allowed to access this account statement
+  @self_id = params[:id].to_i
+  scope = <%= name_details[:ledger_item][:class_name_full] %>.exclude_empty_invoices.sent_or_received_by(@self_id).sorted(:issue_date)
+  scope = scope.sent_or_received_by(params[:other_id]) if params[:other_id]
+  @in_effect = scope.in_effect.all
+  @open_or_pending = scope.open_or_pending.all
+  @summary = <%= name_details[:ledger_item][:class_name_full] %>.account_summary(@self_id, params[:other_id])
+end
+
+# Display an invoice or credit note.
+# GET /<%= name_details[:controller][:underscore_base] %>/document/1
+# GET /<%= name_details[:controller][:underscore_base] %>/document/1.xml
+def document
+  # FIXME check if the current user is allowed to access this ledger item
+  @<%= name_details[:ledger_item][:underscore_singular] %> = <%= name_details[:ledger_item][:class_name_full] %>.find(params[:id])
+  
+  respond_to do |format|
+    format.html { render :text => @<%= name_details[:ledger_item][:underscore_singular] %>.render_html, :layout => true }
+    format.xml  { render :xml => @<%= name_details[:ledger_item][:underscore_singular] %>.render_ubl }
+  end
+end

data/rails_generators/invoicing_ledger/templates/credit_note.rb

@@ -0,0 +1 @@
+acts_as_credit_note

data/rails_generators/invoicing_ledger/templates/initializer.rb

@@ -0,0 +1,2 @@
+# Load the invoicing gem
+require 'invoicing'

data/rails_generators/invoicing_ledger/templates/invoice.rb

@@ -0,0 +1 @@
+acts_as_invoice

data/rails_generators/invoicing_ledger/templates/ledger_item.rb

@@ -0,0 +1,49 @@
+<% if name_details[:line_item][:underscore_plural] != 'line_items' -%>
+acts_as_ledger_item :line_items => :<%= name_details[:line_item][:underscore_plural] %>
+<% else -%>
+acts_as_ledger_item
+<% end -%>
+
+has_many :<%= name_details[:line_item][:underscore_plural] %>, :class_name => '<%= name_details[:line_item][:class_name_full] %>'
+
+# Change the following associations to refer to your customer or supplier model class
+#belongs_to :sender, :class_name => 'FIXME'
+#belongs_to :recipient, :class_name => 'FIXME'
+
+# Returns a hash containing details about the sender of this invoice, credit note or payment. This allows
+# you to integrate the invoicing gem with your existing model objects for users and customers/suppliers.
+#
+# The returned hash should have the following keys:
+# <tt>:is_self</tt>::      +true+ if these details refer to yourself, i.e. the person or organsiation who owns/operates
+#                          this application. +false+ if these details refer to any other party.
+# <tt>:name</tt>::         The name of the person or organisation whose billing address is defined below.
+# <tt>:contact_name</tt>:: The name of a person/department within the organisation named by <tt>:name</tt>.
+# <tt>:address</tt>::      The body of the billing address (not including city, postcode, state and country); may be
+#                          a multi-line string, with lines separated by '\n' line breaks.
+# <tt>:city</tt>::         The name of the city or town in the billing address.
+# <tt>:state</tt>::        The state/region/province/county of the billing address as appropriate.
+# <tt>:postal_code</tt>::  The postal code of the billing address (e.g. ZIP code in the US).
+# <tt>:country</tt>::      The billing address country (human-readable).
+# <tt>:country_code</tt>:: The two-letter country code of the billing address, according to
+#                          ISO-3166-1[http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2].
+# <tt>:tax_number</tt>::   The Value Added Tax registration code of this person or organisation, if they have
+#                          one, preferably including the country identifier at the beginning. This is important for
+#                          transactions within the European Union.
+def sender_details
+  raise 'FIXME: you must implement <%= name_details[:ledger_item][:class_name_full] %>#sender_details'
+end
+
+# Returns a hash containing details about the recipient of this invoice, credit note or payment,
+# in the same format as returned by +sender_details+.
+def recipient_details
+  raise 'FIXME: you must implement <%= name_details[:ledger_item][:class_name_full] %>#recipient_details'
+end
+
+<% if !options[:identifier] -%>
+# Returns the user-visible identifier for a document, e.g. the invoice number. The default is to simply
+# use the primary key generated by the database, but if you want to customise invoice numbers, you can
+# also create a database column called 'identifier'.
+def identifier
+  id
+end
+<% end -%>

data/rails_generators/invoicing_ledger/templates/ledger_view.html

@@ -0,0 +1,26 @@
+<h1 class="ledger">Sales and purchase ledger</h1>
+
+<table class="ledger">
+  <tr>
+    <th class="name">Name</th>
+    <th class="currency">Currency</th>
+    <th class="sales">Sales</th>
+    <th class="purchases">Purchases</th>
+    <th class="sale-receipts">Sale Receipts</th>
+    <th class="purchase-payments">Purchase Payments</th>
+    <th class="balance">Balance</th>
+  </tr>
+  <% @summaries.keys.sort.each do |id| -%>
+    <% @summaries[id].keys.sort.each do |currency| -%>
+      <tr>
+        <td class="name"><%= link_to h(@names[id]), statement_path(:id => @self_id, :other_id => id) %></td>
+        <td class="currency"><%=h currency %></td>
+        <td class="sales"><%=h @summaries[id][currency].sales_formatted %></td>
+        <td class="purchases"><%=h @summaries[id][currency].purchases_formatted %></td>
+        <td class="sale-receipts"><%=h @summaries[id][currency].sale_receipts_formatted %></td>
+        <td class="purchase-payments"><%=h @summaries[id][currency].purchase_payments_formatted %></td>
+        <td class="balance"><%=h @summaries[id][currency].balance_formatted %></td>
+      </tr>
+    <% end -%>
+  <% end -%>
+</table>

data/rails_generators/invoicing_ledger/templates/line_item.rb

@@ -0,0 +1,7 @@
+<% if name_details[:ledger_item][:underscore_singular] != 'ledger_item' -%>
+acts_as_line_item :ledger_item => :<%= name_details[:ledger_item][:underscore_singular] %>
+<% else -%>
+acts_as_line_item
+<% end -%>
+
+belongs_to :<%= name_details[:ledger_item][:underscore_singular] %>, :class_name => '<%= name_details[:ledger_item][:class_name_full] %>'

data/rails_generators/invoicing_ledger/templates/migration.rb

@@ -0,0 +1,63 @@
+class CreateInvoicingLedger < ActiveRecord::Migration
+  def self.up
+    create_table :<%= name_details[:ledger_item][:underscore_plural] %> do |t|
+      t.string :type
+      t.integer :sender_id
+      t.integer :recipient_id
+      t.datetime :issue_date
+      t.string :currency, :limit => 3, :null => false<%= options[:currency] ? ", :default => '#{options[:currency]}'" : '' %>
+      t.decimal :total_amount, :precision => 20, :scale => 4
+      t.decimal :tax_amount, :precision => 20, :scale => 4
+      t.string :status, :limit => 20
+<% if options[:identifier] -%>
+      t.string :identifier, :limit => 50
+<% end -%>
+<% if options[:description] -%>
+      t.string :description
+<% end -%>
+<% if options[:period] -%>
+      t.datetime :period_start
+      t.datetime :period_end
+<% end -%>
+<% if options[:uuid] -%>
+      t.string :uuid, :limit => 40
+<% end -%>
+<% if options[:due_date] -%>
+      t.datetime :due_date
+<% end -%>
+<% if options[:timestamps] -%>
+      t.timestamps
+<% end -%>
+    end
+    
+    create_table :<%= name_details[:line_item][:underscore_plural] %> do |t|
+      t.string :type
+      t.references :<%= name_details[:ledger_item][:underscore_singular] %>
+      t.decimal :net_amount, :precision => 20, :scale => 4
+      t.decimal :tax_amount, :precision => 20, :scale => 4
+<% if options[:description] -%>
+      t.string :description
+<% end -%>
+<% if options[:uuid] -%>
+      t.string :uuid, :limit => 40
+<% end -%>
+<% if options[:tax_point] -%>
+      t.datetime :tax_point
+<% end -%>
+<% if options[:quantity] -%>
+      t.decimal :quantity, :precision => 20, :scale => 4
+<% end -%>
+<% if options[:creator] -%>
+      t.integer :creator_id
+<% end -%>
+<% if options[:timestamps] -%>
+      t.timestamps
+<% end -%>
+    end
+  end 
+
+  def self.down
+    drop_table :<%= name_details[:line_item][:underscore_plural] %>
+    drop_table :<%= name_details[:ledger_item][:underscore_plural] %>
+  end
+end

data/rails_generators/invoicing_ledger/templates/payment.rb

@@ -0,0 +1 @@
+acts_as_payment

data/rails_generators/invoicing_ledger/templates/statement_view.html

@@ -0,0 +1,48 @@
+<h1 class="statement">Account statement</h1>
+
+<% unless @in_effect.empty? %>
+  <table class="statement in_effect">
+    <tr>
+      <th class="number">No.</th>
+      <th class="date">Date</th>
+      <th class="description">Description</th>
+      <th class="amount">Amount</th>
+    </tr>
+    <% for document in @in_effect %>
+      <tr>
+        <td class="number"><%= h document.identifier %></td>
+        <td class="date"><%= h (document.issue_date || document.updated_at).strftime('%Y-%m-%d') %></td>
+        <td class="description">
+          <% if document.class.is_payment -%>
+            <%= h document.description %>
+          <% else -%>
+            <%= link_to h(document.description), document_path(document) %>
+          <% end -%>
+        </td>
+        <td class="amount"><%= h document.total_amount_formatted(:debit => :negative, :self_id => @self_id) %></td>
+      </tr>
+    <% end %>
+    <% @summary.each_pair do |currency, balances| %>
+      <tr class="balance">
+        <th colspan="3">Balance due (<%= h currency %>)</th>
+        <td class="amount"><%= balances.balance_formatted %></td>
+      </tr>
+    <% end %>
+  </table>
+<% end %>
+
+<% unless @open_or_pending.empty? %>
+  <h2 class="statement open_or_pending">Charges not yet invoiced</h2>
+  <table class="statement open_or_pending">
+    <tr>
+      <th class="description">Description</th>
+      <th class="amount">Amount</th>
+    </tr>
+    <% for document in @open_or_pending %>
+      <tr>
+        <td class="description"><%= link_to h(document.description), document_path(document) %></td>
+        <td class="amount"><%= h document.total_amount_formatted(:debit => :negative, :self_id => @self_id) %></td>
+      </tr>
+    <% end %>
+  </table>
+<% end %>

data/rails_generators/invoicing_ledger/templates/stylesheet.css

@@ -0,0 +1,127 @@
+table.invoice {
+  width: 800px;
+}
+
+table.invoice td, table.invoice th {
+  vertical-align: top;
+}
+
+table.invoice.addresses {
+  table-layout: fixed;
+  text-align: left;
+}
+
+table.invoice.addresses td, table.invoice.addresses th {
+  padding: 0.5em;
+}
+
+table.invoice.addresses td.vcard {
+  border: 1px solid black;
+}
+
+table.invoice.metadata {
+  table-layout: fixed;
+  margin: 2em 0 1em 0;
+}
+
+table.invoice.metadata tr {
+  text-align: right;
+}
+
+table.invoice.metadata td {
+  width: 20%;
+  text-align: left;
+}
+
+p.invoice.description {
+  font-weight: bold;
+  background-color: #eee;
+  width: 800px;
+  padding: 0.5em;
+}
+
+table.invoice.line-items {
+  border-collapse: collapse;
+  empty-cells: show;
+  margin-bottom: 5em;
+}
+
+table.invoice.line-items td, table.invoice.line-items th {
+  border: 1px solid black;
+  padding: 0.5em;
+  text-align: left;
+}
+
+table.invoice.line-items td.net-amount, table.invoice.line-items th.net-amount,
+table.invoice.line-items td.tax-amount, table.invoice.line-items th.tax-amount {
+  text-align: right;
+}
+
+table.invoice.line-items tr.subtotal td, table.invoice.line-items tr.subtotal th {
+  padding-top: 3em;
+  text-align: right;
+}
+
+table.invoice.line-items tr.total td, table.invoice.line-items tr.total th {
+  padding-top: 2em;
+  text-align: right;
+  font-weight: bold;
+}
+
+
+
+
+table.ledger {
+  border-collapse: collapse;
+  empty-cells: show;
+  margin: 2em 0 5em;
+  table-layout: fixed;
+  width: 900px;
+}
+
+table.ledger td, table.ledger th {
+  border: 1px solid black;
+  padding: 0.5em;
+  text-align: right;
+  vertical-align: top;
+}
+
+table.ledger td.name, table.ledger th.name {
+  text-align: left;
+  width: 25%;
+}
+
+
+
+table.statement {
+  border-collapse: collapse;
+  empty-cells: show;
+  margin: 2em 0 5em;
+  table-layout: fixed;
+  width: 800px;
+}
+
+table.statement td, table.statement th {
+  border: 1px solid black;
+  padding: 0.5em;
+  text-align: left;
+  vertical-align: top;
+}
+
+table.statement td.number, table.statement th.number {
+  width: 5%;
+}
+
+table.statement td.date, table.statement th.date,
+table.statement td.amount, table.statement th.amount {
+  width: 15%;
+}
+
+table.statement td.amount, table.statement th.amount {
+  text-align: right;
+}
+
+table.statement tr.balance td, table.statement tr.balance th {
+  text-align: right;
+  font-weight: bold;
+}

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/invoicing_generator.rb'}"
+puts "Loading invoicing_generator gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/test/test_generator_helper.rb

@@ -0,0 +1,36 @@
+begin
+  require File.dirname(__FILE__) + '/test_helper'
+rescue LoadError
+  require 'test/unit'
+end
+require 'fileutils'
+
+# Load generator libs in the form needed for generating a new rails project
+gem 'rails'
+require 'rails/version'
+require 'rails_generator'
+require 'rails_generator/scripts/generate'
+
+# Configure the path of the temporary rails project in which our component
+# generators will be run in tests.
+TMP_ROOT = File.dirname(__FILE__) + "/tmp" unless defined?(TMP_ROOT)
+PROJECT_NAME = "myproject" unless defined?(PROJECT_NAME)
+app_root = File.join(TMP_ROOT, PROJECT_NAME)
+if defined?(APP_ROOT)
+  APP_ROOT.replace(app_root)
+else
+  APP_ROOT = app_root
+end
+if defined?(RAILS_ROOT)
+  RAILS_ROOT.replace(app_root)
+else
+  RAILS_ROOT = app_root
+end
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/helpers/generator_test_helper'

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'stringio'
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/invoicing_generator'

data/test/test_invoicing_ledger_generator.rb

@@ -0,0 +1,46 @@
+require File.join(File.dirname(__FILE__), "test_generator_helper.rb")
+
+class TestInvoicingLedgerGenerator < Test::Unit::TestCase
+  include RubiGen::GeneratorTestHelper
+
+  def setup
+    bare_setup
+    Rails::Generator::Base.use_application_sources!
+    Rails::Generator::Scripts::Generate.new.run([APP_ROOT], :generator => 'app')
+  end
+
+  def teardown
+    bare_teardown
+  end
+
+  # Some generator-related assertions:
+  #   assert_generated_file(name, &block) # block passed the file contents
+  #   assert_directory_exists(name)
+  #   assert_generated_class(name, &block)
+  #   assert_generated_module(name, &block)
+  #   assert_generated_test_for(name, &block)
+  # The assert_generated_(class|module|test_for) &block is passed the body of the class/module within the file
+  #   assert_has_method(body, *methods) # check that the body has a list of methods (methods with parentheses not supported yet)
+  #
+  # Other helper methods are:
+  #   app_root_files - put this in teardown to show files generated by the test method (e.g. p app_root_files)
+  #   bare_setup - place this in setup method to create the APP_ROOT folder for each test
+  #   bare_teardown - place this in teardown method to destroy the TMP_ROOT or APP_ROOT folder after each test
+
+  def test_generator_without_options
+    name = "myapp"
+    run_generator('invoicing_ledger', [name], sources)
+    assert_directory_exists "some_folder"
+    assert_generated_file   "some_file_after_erb.rb"
+  end
+
+  private
+  def sources
+    [RubiGen::PathSource.new(:test, File.join(File.dirname(__FILE__),"..", generator_path))
+    ]
+  end
+
+  def generator_path
+    "rails_generators"
+  end
+end

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification 
+name: invoicing_generator
+version: !ruby/object:Gem::Version 
+  version: 0.2.0
+platform: ruby
+authors: 
+- Martin Kleppmann
+autorequire: 
+bindir: bin
+cert_chain: 
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIDQjCCAiqgAwIBAgIBADANBgkqhkiG9w0BAQUFADBHMRIwEAYDVQQDDAlydWJ5
+  Zm9yZ2UxHDAaBgoJkiaJk/IsZAEZFgxlcHRjb21wdXRpbmcxEzARBgoJkiaJk/Is
+  ZAEZFgNjb20wHhcNMDkwNDE0MTkwMTIwWhcNMTAwNDE0MTkwMTIwWjBHMRIwEAYD
+  VQQDDAlydWJ5Zm9yZ2UxHDAaBgoJkiaJk/IsZAEZFgxlcHRjb21wdXRpbmcxEzAR
+  BgoJkiaJk/IsZAEZFgNjb20wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIB
+  AQDTglrdKabHepgLjgzM1Z52ABCZZ/xsBbn+4pE2jm7aGj2c0fZ+5Uhg0/MfyKsz
+  g3jEFjj0GeNFW7l1sHJYf8mTrdCyAuaymyB2LcLwPtte7/3daAWcs6wAJR8nm9xa
+  CzoeAFjCLcbhZazNBURMizj1z9eTArxhpfpNw4uSIExxNRoykeiFGZ4iq5Getj5x
+  B/JNTdxM7m2KLx+3YKp2LsV0NLL7hRp6zZ6KW1NTWt1mQ58SjDUiRhThfxPfVpCA
+  NI3O+ikDERJWo+nLMUNAZXiB6iMimgUNIUm462tbrumloEjQ/wJE6veGyCRS4jfq
+  Ldnuf6CKFRIxhb9QaN+cu0lLAgMBAAGjOTA3MAkGA1UdEwQCMAAwCwYDVR0PBAQD
+  AgSwMB0GA1UdDgQWBBRR5pYhCiPVxI3rYNDwFcCSqOUGOTANBgkqhkiG9w0BAQUF
+  AAOCAQEAnrM8+tf8f5y8icgcWErHTZZ6oInZxbH8DbAbJ9zIdD/u2o8agzykc/ub
+  Kza0RLJoINt0f1Bb6hzIja82EPeEEQKgR6BJAwPZlxZLGYBTyZeZRy3PJ8IjQ9Zk
+  Fl6OOjmxFfjgF0UGvFHPYUJaNtN8kPs2lyZYmmUrf7qF0n6nwShnVkYePUlvyW0i
+  kqloUNEB5PbHhEwmSTSYOseqm2l2rOAgN3aKVzNFWiMjzZn8OwYaETtD83yB9zlK
+  hqnkWqtTW1V1mEZRyNIx71QdrsaovPQhIKp0bMFUwntYXklVKqxYGHebwt//Gb++
+  jT4Qh3sYJbvqWGFAQcuOIf4spvpNiA==
+  -----END CERTIFICATE-----
+
+date: 2009-04-20 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: invoicing
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 0.2.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: newgem
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.3.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.8.0
+    version: 
+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.  The Ruby Invoicing Framework is based on {ActiveRecord}[http://api.rubyonrails.org/classes/ActiveRecord/Base.html].  Please see {the website}[http://ept.github.com/invoicing/] for an introduction to using Invoicing, and check the {API reference}[http://invoicing.rubyforge.org/doc/] for in-depth details.
+email: 
+- rubyforge@eptcomputing.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+- README.rdoc
+files: 
+- History.txt
+- LICENSE
+- Manifest.txt
+- PostInstall.txt
+- README.rdoc
+- Rakefile
+- lib/invoicing_generator.rb
+- lib/invoicing_generator/generator_extensions.rb
+- lib/invoicing_generator/name_tools.rb
+- lib/invoicing_generator/option_tools.rb
+- rails_generators/invoicing_ledger/USAGE
+- rails_generators/invoicing_ledger/invoicing_ledger_generator.rb
+- rails_generators/invoicing_ledger/templates/controller.rb
+- rails_generators/invoicing_ledger/templates/credit_note.rb
+- rails_generators/invoicing_ledger/templates/initializer.rb
+- rails_generators/invoicing_ledger/templates/invoice.rb
+- rails_generators/invoicing_ledger/templates/ledger_item.rb
+- rails_generators/invoicing_ledger/templates/ledger_view.html
+- rails_generators/invoicing_ledger/templates/line_item.rb
+- rails_generators/invoicing_ledger/templates/migration.rb
+- rails_generators/invoicing_ledger/templates/payment.rb
+- rails_generators/invoicing_ledger/templates/statement_view.html
+- rails_generators/invoicing_ledger/templates/stylesheet.css
+- script/console
+- script/destroy
+- script/generate
+- test/test_generator_helper.rb
+- test/test_helper.rb
+- test/test_invoicing_ledger_generator.rb
+has_rdoc: true
+homepage: "{Ruby Invoicing Framework website}[http://ept.github.com/invoicing/]"
+post_install_message: PostInstall.txt
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: invoicing
+rubygems_version: 1.3.1
+signing_key: 
+specification_version: 2
+summary: This is a framework for generating and displaying invoices (ideal for commercial Rails apps)
+test_files: 
+- test/test_generator_helper.rb
+- test/test_helper.rb
+- test/test_invoicing_ledger_generator.rb