uomi 0.2.13

data/.gitignore

@@ -0,0 +1,6 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+spec/internal/db/*.sqlite
+spec/internal/config/database.yml

data/.rvmrc

@@ -0,0 +1 @@
+rvm use 1.9.2@invoicing --create

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+before_script:
+  - cp spec/internal/config/database.yml.sample spec/internal/config/database.yml

data/Gemfile

@@ -0,0 +1,10 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in invoicing.gemspec
+gemspec
+
+group :development do
+  gem 'rspec'
+  gem 'rspec-rails'
+  gem 'sqlite3'
+end

data/README.md

@@ -0,0 +1,35 @@
+
+[![Build Status](https://secure.travis-ci.org/tehtorq/invoicing.png)](http://travis-ci.org/tehtorq/invoicing)
+
+Basic Usage
+
+    seller = Seller.find(3)
+    book = Book.find(1) # implements CostItem
+    decorations = {whatever_you_want: 'here'}
+
+    invoice = Invoicing::generate do
+      from seller
+      line_item book
+      due Time.now + 7.days
+      payment_reference "REF2345"
+      decorate_with decorations
+    end
+
+Invoice Numbering:
+
+A default invoice number will be set with the format INV[invoice id].
+
+A custom invoice number can be specified as follows:
+
+    invoice = Invoicing::generate do
+      numbered "CUSTOMREF123"
+    end
+
+You can specify a custom invoice number containing the invoice id as follows:
+
+    invoice = Invoicing::generate do
+      numbered "CUSTOMREF{id}"
+    end
+
+  
+    

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec')
+
+# If you want to make this the default task
+task :default => :spec
+require "bundler/gem_tasks"

data/config.ru

@@ -0,0 +1,7 @@
+require 'rubygems'
+require 'bundler'
+
+Bundler.require :default, :development
+
+Combustion.initialize!
+run Combustion::Application

data/invoicing.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "invoicing/version"
+
+Gem::Specification.new do |s|
+  s.name        = "uomi"
+  s.version     = Invoicing::VERSION
+  s.authors     = ["Douglas Anderson", "Jeffrey van Aswegen"]
+  s.email       = ["i.am.douglas.anderson@gmail.com", "jeffmess@gmail.com"]
+  s.homepage    = 'https://github.com/tehtorq/invoicing'
+  s.summary     = %q{ An invoicing gem. }
+  s.description = %q{ Manage invoices. }
+
+  s.rubyforge_project = "uomi"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency "activesupport"
+  s.add_dependency "activerecord", "~> 3.0"
+  s.add_dependency "i18n"
+  s.add_dependency "workflow", '= 0.8.7'
+  
+  s.add_development_dependency 'combustion', '~> 0.3.1'
+end

data/lib/generators/active_record/invoicing_generator.rb

@@ -0,0 +1,30 @@
+module Invoicing
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+      
+      source_root File.expand_path("../templates", __FILE__)
+
+      desc <<-CONTENT
+        Copies the invoicing migration file to the migrations
+        folder.
+        
+        Please run rake db:migrate once the installer is 
+        complete.
+
+  CONTENT
+
+      def self.next_migration_number(dirname) #:nodoc:
+        if ActiveRecord::Base.timestamped_migrations
+          Time.now.utc.strftime("%Y%m%d%H%M%S")
+        else
+          "%.3d" % (current_migration_number(dirname) + 1)
+        end
+      end
+
+      def create_migration_file
+        migration_template 'migration.rb', 'db/migrate/create_invoicing_tables.rb'
+      end
+    end
+  end
+end

data/lib/generators/active_record/templates/migration.rb

@@ -0,0 +1,84 @@
+class CreateInvoicingTables < ActiveRecord::Migration
+  def self.change
+
+    create_table "invoicing_late_payments", :force => true do |t|
+      t.integer  "invoice_id"
+      t.integer "amount"
+      t.datetime "penalty_date"
+      t.boolean  "processed"
+      t.timestamps
+    end
+
+    create_table "invoicing_line_items", :force => true do |t|
+      t.integer "invoice_id"
+      t.string  "description"
+      t.integer "amount"
+      t.integer "tax"
+      t.integer "invoiceable_id"
+      t.string "invoiceable_type"
+      t.integer "line_item_type_id"
+      t.timestamps
+    end
+
+    create_table "invoicing_transactions", :force => true do |t|
+      t.integer "invoice_id"
+      t.string  "type"
+      t.integer "amount"
+      t.timestamps
+    end
+
+    create_table "invoicing_invoices", :force => true do |t|
+      t.integer  "seller_id"
+      t.integer  "buyer_id"
+      t.string   "invoice_number"
+      t.datetime "due_date"
+      t.datetime "issued_at"
+      t.integer  "total"
+      t.integer  "tax"
+      t.integer  "balance"
+      t.string   "type"
+      t.string   "workflow_state"
+      t.timestamps
+    end
+    
+    create_table "invoicing_payment_references", :force => true do |t|
+      t.integer "invoice_id"
+      t.string "reference"
+      t.timestamps
+    end
+    
+    create_table "invoicing_sellers", :force => true do |t|
+      t.integer "sellerable_id"
+      t.string "sellerable_type"
+      t.timestamps
+    end
+
+    create_table "invoicing_buyers", :force => true do |t|
+      t.integer "buyerable_id"
+      t.string "buyerable_type"
+      t.timestamps
+    end
+    
+    create_table "invoicing_invoice_decorators", :force => true do |t|
+      t.integer "invoice_id"
+      t.text "data"
+      t.timestamps
+    end
+
+    create_table "invoicing_credit_note_invoices", :force => true do |t|
+      t.integer "invoice_id"
+      t.integer "credit_note_id"
+    end
+
+    create_table "invoicing_credit_note_credit_transactions", :force => true do |t|
+      t.integer "credit_note_id"
+      t.integer "transaction_id"
+    end
+
+    create_table "invoicing_line_item_types", :force => true do |t|
+      t.string "name"
+    end
+ 
+  end
+
+end

data/lib/invoicing/buyer.rb

@@ -0,0 +1,10 @@
+module Invoicing
+  class Buyer < ActiveRecord::Base
+    has_many :invoices
+    belongs_to :buyerable, polymorphic: true
+
+    def self.for(buyerable)
+      Buyer.where(buyerable_type: buyerable.class.name, buyerable_id: buyerable.id).first || Buyer.create!(buyerable_type: buyerable.class.name, buyerable_id: buyerable.id)
+    end
+  end
+end

data/lib/invoicing/credit_note.rb

@@ -0,0 +1,70 @@
+module Invoicing
+  class CreditNote < Invoice
+    alias_attribute :receipt_number, :invoice_number
+
+    has_one :credit_note_invoice, dependent: :destroy
+    has_one :invoice, through: :credit_note_invoice
+    has_many :credit_note_credit_transactions, dependent: :destroy
+
+    def issue(issued_at = Time.now)
+      self.issued_at = issued_at
+      create_initial_transaction!
+      record_transaction_against_invoice!
+      record_credit_notes!
+    end
+
+    def record_transaction_against_invoice!
+      raise RuntimeError, "You must allocate a credit note against an invoice" if invoice.blank?
+      raise RuntimeError, "You must allocate a credit note against an issued invoice" unless invoice.issued?
+
+      invoice.add_credit_transaction(amount: total)
+      invoice.save!
+      CreditNoteCreditTransaction.create!(transaction: invoice.transactions.last, credit_note_id: self.id)
+    end
+
+    def credit(options={})
+      add_line_item(
+        invoiceable: options[:line_item].invoiceable,
+        amount: options[:amount] || 0,
+        tax: options[:tax] || 0,
+        description: options[:description] || "Credit note against #{options[:line_item].description}" #?
+      )
+    end
+
+    def against_invoice(invoice)
+      raise RuntimeError, "You must allocate a credit note against an invoice" if invoice.blank?
+      raise RuntimeError, "You must allocate a credit note against an issued invoice" unless invoice.issued?
+      
+      self.credit_note_invoice = CreditNoteInvoice.new(invoice_id: invoice.id)
+      self.buyer = invoice.buyer
+      self.seller = invoice.seller
+    end
+
+    def record_credit_notes!
+      line_items.each do |line_item|
+        invoiceable = line_item.invoiceable
+        next if invoiceable.blank?
+        invoiceable.handle_credit(line_item.amount) if invoiceable.respond_to?(:handle_credit)
+        invoiceable.save!
+      end
+    end
+
+    def annul(params={})
+      record_amount_against_invoice(params[:amount], params[:against_invoice]) if params[:against_invoice]
+    end
+
+    def default_numbering_prefix
+      "CN"
+    end
+
+    def create_initial_transaction!
+      if total > 0
+        add_credit_transaction amount: total
+      else
+        add_debit_transaction amount: total
+      end
+
+      save!
+    end
+  end
+end

data/lib/invoicing/credit_note_credit_transaction.rb

@@ -0,0 +1,6 @@
+module Invoicing
+  class CreditNoteCreditTransaction < ActiveRecord::Base
+    belongs_to :credit_note
+    belongs_to :transaction
+  end
+end

data/lib/invoicing/credit_note_invoice.rb

@@ -0,0 +1,6 @@
+module Invoicing
+  class CreditNoteInvoice < ActiveRecord::Base
+    belongs_to :credit_note
+    belongs_to :invoice
+  end
+end

data/lib/invoicing/credit_transaction.rb

@@ -0,0 +1,9 @@
+module Invoicing
+  class CreditTransaction < Transaction
+    
+    def credit?
+      true
+    end
+  
+  end
+end

data/lib/invoicing/debit_transaction.rb

@@ -0,0 +1,9 @@
+module Invoicing
+  class DebitTransaction < Transaction
+    
+    def debit?
+      true
+    end
+  
+  end
+end

data/lib/invoicing/exception.rb

@@ -0,0 +1,4 @@
+module Invoicing
+  class CannotVoidDocumentException < Exception; end
+  class CannotAdjustIssuedDocument < Exception; end
+end

data/lib/invoicing/invoice.rb

@@ -0,0 +1,233 @@
+module Invoicing
+  class Invoice < ActiveRecord::Base
+    include ::Workflow
+    has_many :line_items, dependent: :destroy
+    has_many :transactions, dependent: :destroy
+    has_many :payment_references, dependent: :destroy
+    has_one :late_payment, dependent: :destroy
+    belongs_to :seller
+    belongs_to :buyer
+    has_one :invoice_decorator, dependent: :destroy
+
+    validates_uniqueness_of :invoice_number, scope: [:seller_id]
+  
+    before_save :calculate_totals, :calculate_balance
+    after_create :set_invoice_number!
+    
+    alias :decorator :invoice_decorator
+
+    workflow do
+      state :draft do
+        event :issue, transitions_to: :issued
+        event :void, transitions_to: :voided
+      end
+      
+      state :issued do
+        event :settle, transitions_to: :settled
+        event :void, transitions_to: :voided
+      end
+
+      state :settled
+      state :voided
+    end
+
+    def issue(&block)
+      self.issued_at = Time.now
+      instance_eval(&block) if block_given?
+      create_initial_transaction!
+      mark_items_invoiced!
+      self
+    end
+    
+    def void
+      raise CannotVoidDocumentException, "Cannot void a document that has a transaction recorded against it!" if transactions.many?
+      annul_remaining_amount! unless self.draft?
+      mark_items_uninvoiced!
+      self
+    end
+    
+    def add_line_item(params)
+      self.line_items << LineItem.new(params)
+    end
+
+    def remove_line_item(item)
+      line_items.delete(item)
+    end
+    
+    def add_debit_transaction(params)
+      self.transactions << DebitTransaction.new(params)
+    end
+    
+    def add_credit_transaction(params)
+      self.transactions << CreditTransaction.new(params)
+    end
+    
+    def calculate_totals
+      self.total = line_items.inject(0) {|res, item| res + item.amount.to_i}
+      self.tax = line_items.inject(0) {|res, item| res + item.tax.to_i}
+    end
+
+    def annul_remaining_amount!
+      add_credit_transaction amount: balance.abs
+    end
+      
+    def create_initial_transaction!
+      if total < 0
+        add_credit_transaction amount: total
+      else
+        add_debit_transaction amount: total
+      end
+    end
+
+    def credit_notes
+      CreditNoteInvoice.where(invoice_id: id).map(&:credit_note)
+    end
+
+    def default_numbering_prefix
+      "INV"
+    end
+    
+    def set_invoice_number!
+      self.invoice_number ||= "#{default_numbering_prefix}#{id}"
+      self.invoice_number.gsub!("{id}", "#{id}")
+      save!
+    end
+      
+    def debit_transactions
+      transactions.select{|t| t.is_a? DebitTransaction}
+    end
+      
+    def credit_transactions
+      transactions.select{|t| t.is_a? CreditTransaction}
+    end
+      
+    def calculate_balance
+      self.balance = (0 - debit_transactions.sum(&:amount)) + credit_transactions.sum(&:amount)
+      settle! if should_settle?
+    end
+
+    def should_settle?
+      issued? && balance_zero?
+    end
+    
+    def net_total
+      total - tax
+    end
+
+    def balance_zero?
+      balance == 0
+    end
+      
+    def owing?
+      balance < 0
+    end
+      
+    def due_date_past?
+      due_date.to_date < Date.today
+    end
+      
+    def overdue?
+      owing? and due_date_past?
+    end
+    
+    def self.owing
+      where("balance < ?", 0)
+    end
+
+    def self.issued
+      where(workflow_state: "issued")
+    end
+
+    def self.draft
+      where(workflow_state: "draft")
+    end
+
+    def self.settled
+      where(workflow_state: "settled")
+    end
+
+    def self.voided
+      where(workflow_state: "voided")
+    end
+    
+    def add_payment_reference(params)
+      self.payment_references << PaymentReference.new(params)
+    end
+
+    def remove_payment_reference(payment_reference)
+      payment_references.delete(payment_reference)
+    end
+    
+    def self.for_payment_reference(reference)
+      PaymentReference.where(reference: reference).map(&:invoice)
+    end
+    
+    def mark_items_invoiced!
+      line_items.map(&:invoiceable).compact.each do |item|
+        item.mark_invoiced(self) if item.respond_to?(:mark_invoiced)
+      end
+    end
+
+    def mark_items_uninvoiced!
+      line_items.map(&:invoiceable).compact.each do |item|
+        item.mark_uninvoiced(self) if item.respond_to?(:mark_uninvoiced)
+      end
+    end
+    
+    def line_item(cost_item)
+      if cost_item.is_a? Hash
+        add_line_item(
+          amount: cost_item[:amount] || 0,
+          tax: cost_item[:tax] || 0,
+          description: cost_item[:description] || 'Line Item',
+          line_item_type_id: cost_item[:line_item_type_id]
+        )
+      else
+        add_line_item(
+          invoiceable: cost_item,
+          amount: cost_item.amount || 0,
+          tax: cost_item.tax || 0,
+          description: cost_item.description || 'Line Item',
+          line_item_type_id: cost_item.respond_to?(:line_item_type_id) ? cost_item.line_item_type_id : 0
+        )
+      end
+    end
+    
+    def payment_reference(reference)
+      add_payment_reference(reference: reference)
+    end
+    
+    def due(due_date)
+      self.due_date = due_date
+    end
+
+    def to(buyerable)
+      self.buyer = Buyer.for(buyerable)
+    end
+    
+    def from(sellerable)
+      self.seller = Seller.for(sellerable)
+    end
+    
+    def decorate_with(decorations)
+      if self.invoice_decorator
+        self.invoice_decorator.data = decorations
+      else
+        self.invoice_decorator = InvoiceDecorator.new(data: decorations)
+      end
+    end
+
+    def numbered(invoice_number)
+      self.invoice_number = invoice_number
+    end
+
+    def adjust(&block)
+      adjustment = InvoiceAdjustment.new(self)
+      adjustment.instance_eval(&block)
+      adjustment.persist!
+      adjustment.invoice
+    end
+  
+  end
+
+end

data/lib/invoicing/invoice_adjustment.rb

@@ -0,0 +1,59 @@
+module Invoicing
+
+  class InvoiceAdjustment
+
+    attr_accessor :invoice
+
+    def initialize(invoice)
+      raise CannotAdjustIssuedDocument unless invoice.draft?
+      self.invoice = invoice
+    end
+
+    def due(due_date)
+      invoice.due(due_date)
+    end
+
+    def add_line_item(params)
+      invoice.line_item(params)
+    end
+
+    def edit_line_item(item, params)
+      raise CannotEditNonExistantLineItem if invoice.line_items.find(item.id).blank?
+      self.invoice.line_items.for(item).update_attributes(params)
+    end
+
+    def remove_line_item(item)
+      invoice.line_items.delete(item)
+    end
+
+    def add_payment_reference(payment_reference)
+      invoice.payment_reference(payment_reference)
+    end
+
+    def remove_payment_reference(payment_reference)
+      invoice.remove_payment_reference(payment_reference)
+    end
+
+    def to(buyerable)
+      invoice.to(buyerable)
+    end
+
+    def numbered(invoice_number)
+      invoice.numbered(invoice_number)
+    end
+
+    def decorate_with(decorations)
+      invoice.decorate_with(decorations)
+    end
+
+    def persist!
+      # this method makes me a little sad.
+      self.invoice.transaction do 
+        self.invoice.invoice_decorator.save
+        self.invoice.line_items.map(&:reload)
+        self.invoice.save!
+      end
+    end
+  end
+
+end

data/lib/invoicing/invoice_decorator.rb

@@ -0,0 +1,6 @@
+module Invoicing
+  class InvoiceDecorator < ActiveRecord::Base
+    belongs_to :invoice
+    serialize :data
+  end
+end

data/lib/invoicing/invoiceable.rb

@@ -0,0 +1,22 @@
+# implement this module and override behaviour on items which will be invoiced
+
+module Invoicing
+  module Invoiceable
+  
+    attr_accessor :invoiced, :invoice_id, :amount, :tax, :line_item_type_id
+
+    def description
+      "Invoiceable Item"
+    end
+
+    def handle_credit(amount)
+    end
+
+    def mark_invoiced(invoice)
+    end
+
+    def mark_uninvoiced
+    end
+  
+  end
+end

data/lib/invoicing/late_payment.rb

@@ -0,0 +1,11 @@
+module Invoicing
+  class LatePayment < ActiveRecord::Base
+    belongs_to :invoice
+  
+    before_create :set_penalty_date
+  
+    def set_penalty_date
+      self.penalty_date = Date.today + 7.days
+    end
+  end
+end