pacioli 0.0.10 → 0.0.11

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

@@ -9,10 +9,11 @@ class CreatePacioliTables < ActiveRecord::Migration
       t.timestamps
     end
 
-    create_table :pacioli_customers, :force => true do |t|
+    create_table :pacioli_parties, :force => true do |t|
       t.references :pacioli_company
-      t.integer :customerable_id
-      t.string :customerable_type
+      t.integer :partyable_id
+      t.string :partyable_type
+      t.string :type
       t.string :name
 
       t.timestamps
@@ -44,7 +45,7 @@ class CreatePacioliTables < ActiveRecord::Migration
     create_table :pacioli_transactions, :force => true do |t|
       t.references :pacioli_journal_entry
       t.references :pacioli_account
-      t.references :pacioli_customer
+      t.references :pacioli_party
 
       t.string :type
       t.decimal :amount, :precision => 20, :scale => 10

data/lib/pacioli/company.rb

@@ -5,7 +5,7 @@ module Pacioli
     has_many :chart_of_accounts, through: :accounts
     has_many :journal_entries, foreign_key: :pacioli_company_id, dependent: :destroy
     has_many :posting_rules, foreign_key: :pacioli_company_id, dependent: :destroy
-    has_many :customers, foreign_key: :pacioli_company_id, dependent: :destroy
+    has_many :parties, foreign_key: :pacioli_company_id, dependent: :destroy
 
     def self.for(company)
       Company.where(companyable_type: company.class.name, companyable_id: company.id).first 
@@ -102,13 +102,23 @@ module Pacioli
       end
     end
 
-    def register_customer(&block)
+    def register_debtor(&block)
       self.transaction do 
-        customer = Customer.new
-        self.customers << customer
-        customer.instance_eval(&block)
-        customer.save!
-        customer
+        debtor = Debtor.new
+        self.parties << debtor
+        debtor.instance_eval(&block)
+        debtor.save!
+        debtor
+      end
+    end
+
+    def register_creditor(&block)
+      self.transaction do 
+        creditor = Creditor.new
+        self.parties << creditor
+        creditor.instance_eval(&block)
+        creditor.save!
+        creditor
       end
     end
   end

data/lib/pacioli/credit.rb

@@ -5,5 +5,9 @@ module Pacioli
       true
     end
 
+    def to_hash
+      {description: self.journal_entry.description, date: self.dated, credit_amount: self.amount, debit_amount: "", balance: self.party.balance_at(self.dated)}
+    end
+
   end
 end

data/lib/pacioli/creditor.rb

@@ -0,0 +1,5 @@
+module Pacioli
+  class Creditor < Party
+
+  end
+end

data/lib/pacioli/debit.rb

@@ -5,5 +5,9 @@ module Pacioli
       true
     end
 
+    def to_hash
+      {description: self.journal_entry.description, date: self.dated, credit_amount: "", debit_amount: self.amount, balance: self.party.balance_at(self.dated)}
+    end
+
   end
 end

data/lib/pacioli/debtor.rb

@@ -0,0 +1,5 @@
+module Pacioli
+  class Debtor < Party
+
+  end
+end

data/lib/pacioli/journal_entry.rb

@@ -27,14 +27,14 @@ module Pacioli
     def debit(options={})
       account = self.company.accounts.where(name: options[:account]).first
       debit = Debit.new(journal_entry: self, account: account, amount: options[:amount], dated: self.dated)
-      debit.customer = options[:against_customer] if options.has_key? :against_customer
+      debit.party = options[:against_party] if options.has_key? :against_party
       self.transactions << debit
     end
 
     def credit(options={})
       account = self.company.accounts.where(name: options[:account]).first
       credit = Credit.new(journal_entry: self, account: account, amount: options[:amount], dated: self.dated)
-      credit.customer = options[:against_customer] if options.has_key? :against_customer
+      credit.party = options[:against_party] if options.has_key? :against_party
       self.transactions << credit
     end
 
@@ -75,7 +75,7 @@ module Pacioli
     # Could be used to update a journal entry and affect other accounts
     # eg. a payment into our bank would result in a journal entry but 
     # we may not know where it came from. At a later stage we could allocate
-    # the payment to a customer/invoice etc.
+    # the payment to a debtor/invoice etc.
 
     def record(&block)
       self.transaction do

data/lib/pacioli/party.rb

@@ -0,0 +1,49 @@
+module Pacioli
+  class Party < ActiveRecord::Base
+    belongs_to :partyable, polymorphic: true
+    belongs_to :company, foreign_key: :pacioli_company_id
+    has_many :transactions, foreign_key: :pacioli_party_id
+
+    def self.for(party)
+      Party.where(partyable_type: party.class.name, partyable_id: party.id) #.first || Customer.create!(customerable_type: customer.class.name, customerable_id: customer.id)
+    end
+
+    def with_name(party_name)
+      self.name = party_name
+    end
+
+    def with_source(partyable_object)
+      self.partyable = partyable_object
+    end
+
+    def debits
+      transactions.where(type: 'Pacioli::Debit')
+    end
+
+    def credits
+      transactions.where(type: 'Pacioli::Credit')
+    end
+
+    def balance
+      debits.sum(&:amount) - credits.sum(&:amount)
+    end
+
+    def balance_at(date=Time.now)
+      debits.before(date).sum(&:amount) - credits.before(date).sum(&:amount)
+    end
+
+    def statement_between_dates(start_date, end_date=Time.now)
+      start_date ||= (Date.today - 1.month).to_time
+
+      temp_array = []
+
+      temp_array << {description: "Opening Balance", date: start_date, credit_amount: "", debit_amount: "", balance: balance_at(start_date)}
+
+      temp_array << transactions.between(start_date, end_date).map(&:to_hash)
+
+      temp_array << {description: "Closing Balance", date: end_date, credit_amount: "", debit_amount: "", balance: balance_at(end_date)}
+
+      temp_array.flatten
+    end
+  end
+end

data/lib/pacioli/transaction.rb

@@ -2,7 +2,15 @@ module Pacioli
   class Transaction < ActiveRecord::Base
     belongs_to :journal_entry, foreign_key: :pacioli_journal_entry_id
     belongs_to :account, foreign_key: :pacioli_account_id
-    belongs_to :customer, foreign_key: :pacioli_customer_id
+    belongs_to :party, foreign_key: :pacioli_party_id
+
+    def self.before(date=Time.now)
+      where("dated < :q", q: date.to_time.beginning_of_day)
+    end
+
+    def self.between(start_date, end_date)
+      where("dated >= :s AND dated <= :e", {s: start_date.to_time.beginning_of_day, e: end_date.to_time.end_of_day}).order(:dated)
+    end
 
     def debit?
       false

data/lib/pacioli/version.rb

@@ -1,3 +1,3 @@
 module Pacioli
-  VERSION = "0.0.10"
+  VERSION = "0.0.11"
 end

data/lib/pacioli.rb

@@ -16,7 +16,9 @@ module Pacioli
 end
 
 require "pacioli/company"
-require "pacioli/customer"
+require "pacioli/party"
+require "pacioli/creditor"
+require "pacioli/debtor"
 require "pacioli/account"
 require "pacioli/asset_account"
 require "pacioli/liability_account"

data/spec/internal/db/schema.rb

@@ -8,10 +8,11 @@ ActiveRecord::Schema.define do
     t.timestamps
   end
 
-  create_table :pacioli_customers, :force => true do |t|
+  create_table :pacioli_parties, :force => true do |t|
     t.references :pacioli_company
-    t.integer :customerable_id
-    t.string :customerable_type
+    t.integer :partyable_id
+    t.string :partyable_type
+    t.string :type
     t.string :name
 
     t.timestamps
@@ -43,7 +44,7 @@ ActiveRecord::Schema.define do
   create_table :pacioli_transactions, :force => true do |t|
     t.references :pacioli_journal_entry
     t.references :pacioli_account
-    t.references :pacioli_customer
+    t.references :pacioli_party
 
     t.string :type
     t.decimal :amount, :precision => 20, :scale => 10

data/spec/lib/pacioli/journal_entry_spec.rb

@@ -203,7 +203,7 @@ describe Pacioli::Account do
 
     context "Recording against a customer with a source document" do
       before(:each) do
-        @customer = @company.register_customer do
+        @customer = @company.register_debtor do
           with_name "Leonardo da Vinci"
         end
       end
@@ -215,7 +215,7 @@ describe Pacioli::Account do
           @company.record_journal_entry do
             with_description "Invoice 123 for November Rent"
             with_source_document customer # source should be the invoice! 
-            debit account: "Accounts Receivable", amount: 4500.00, against_customer: customer
+            debit account: "Accounts Receivable", amount: 4500.00, against_party: customer
             credit account: "Sales", amount: 4500.00
           end
         end
@@ -236,7 +236,7 @@ describe Pacioli::Account do
             @company.record_journal_entry do
               with_description "PMT Received"
               debit account: "Cash in Bank", amount: 4500.00
-              credit account: "Accounts Receivable", amount: 4500.00, against_customer: customer
+              credit account: "Accounts Receivable", amount: 4500.00, against_party: customer
             end
           end
 

data/spec/lib/pacioli/party_spec.rb

@@ -0,0 +1,85 @@
+require 'spec_helper'
+
+describe Pacioli::Party do 
+  include Helpers
+
+  before(:each) do
+    tear_it_down
+
+    @company = Pacioli::register_company do
+      with_name "Coca-Cola"
+
+      add_asset_account name: "Accounts Receivable", code: "100"
+      add_asset_account name: "Cash in Bank", code: "101"
+      add_income_account name: "Sales", code: "301"
+      add_liability_account name: "Sales Tax", code: "401"
+    end
+
+    @debtor = @company.register_debtor do
+      with_name "Leonardo da Vinci"
+    end
+  end
+
+  it "should create a debtor" do
+    Pacioli::Debtor.all.count.should == 1
+    @debtor.name.should == "Leonardo da Vinci"
+    @debtor.company.should == @company
+  end
+
+  context "Debtors Statement for past 11 weeks" do
+
+    before(:each) do
+      debtor = @debtor
+
+      debit_entries = [
+        {description: "Invoice 123 for Rent #{Date.today - 12.weeks}", dated: Date.today - 12.weeks, source: debtor, amt: 5000.00, against: debtor},
+        {description: "Invoice 124 for Rent #{Date.today - 8.weeks}", dated: Date.today - 8.weeks, source: debtor, amt: 2000.00, against: debtor},
+        {description: "Invoice 125 for Rent #{Date.today - 4.weeks}", dated: Date.today - 4.weeks, source: debtor, amt: 3000.00, against: debtor},
+        {description: "Invoice 126 for Fee #{Date.today - 2.weeks}", dated: Date.today - 2.weeks, source: debtor, amt: 4000.00, against: debtor}
+      ]
+
+      credit_entries = [
+        {description: "PMT Received for Invoice 123 #{Date.today - 7.weeks}", dated: Date.today - 7.weeks, source: debtor, amt: 5000.00, against: debtor},
+        {description: "PMT Received for Invoice 123 #{Date.today - 3.weeks}", source: debtor, dated: Date.today - 3.weeks, amt: 2000.00, against: debtor},
+      ]
+
+      credit_entries.each do |credit_entry|
+        @company.record_journal_entry do
+          with_description credit_entry[:description]
+          with_source_document credit_entry[:source]
+          with_date credit_entry[:dated]
+
+          debit account: "Cash in Bank", amount: credit_entry[:amt]
+          credit account: "Accounts Receivable", amount: credit_entry[:amt], against_party: credit_entry[:against]
+        end
+      end
+
+      debit_entries.each do |debit_entry|
+        @company.record_journal_entry do
+          with_description debit_entry[:description]
+          with_source_document debit_entry[:source]
+          with_date debit_entry[:dated]
+
+          debit account: "Accounts Receivable", amount: debit_entry[:amt], against_party: debit_entry[:against]
+          credit account: "Sales", amount: debit_entry[:amt]
+        end
+      end
+
+      @statement = @debtor.statement_between_dates(Date.today - 11.weeks, Date.today)
+    end
+
+    it "should have an opening balance of 5000.00" do
+      @statement.first[:balance].should == 5000.00
+    end
+
+    it "should have 3 debit entries to the value of 9000.00" do
+      @statement.select {|entry| !entry[:debit_amount].blank?}.count.should == 3
+      @statement.select {|entry| !entry[:debit_amount].blank?}.map {|i| i[:debit_amount]}.sum().should == 9000.00
+    end
+
+    it "should have a closing balance of 7000.00" do
+      @statement.last[:balance].should == 7000.00
+    end
+
+  end
+end

data/spec/support/helpers.rb

@@ -5,7 +5,7 @@ module Helpers
     Pacioli::JournalEntry.delete_all
     Pacioli::Transaction.delete_all
     Pacioli::PostingRule.destroy_all
-    Pacioli::Customer.destroy_all
+    Pacioli::Party.destroy_all
   end
 end                                                                                                                                   
         

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pacioli
 version: !ruby/object:Gem::Version
-  version: 0.0.10
+  version: 0.0.11
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2013-02-12 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70249036092760 !ruby/object:Gem::Requirement
+  requirement: &70280538886600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70249036092760
+  version_requirements: *70280538886600
 - !ruby/object:Gem::Dependency
   name: activerecord
-  requirement: &70249036092260 !ruby/object:Gem::Requirement
+  requirement: &70280538886100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: '3.0'
   type: :runtime
   prerelease: false
-  version_requirements: *70249036092260
+  version_requirements: *70280538886100
 - !ruby/object:Gem::Dependency
   name: i18n
-  requirement: &70249036091840 !ruby/object:Gem::Requirement
+  requirement: &70280538885680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70249036091840
+  version_requirements: *70280538885680
 - !ruby/object:Gem::Dependency
   name: combustion
-  requirement: &70249036091300 !ruby/object:Gem::Requirement
+  requirement: &70280538885140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,7 +54,7 @@ dependencies:
         version: 0.3.1
   type: :development
   prerelease: false
-  version_requirements: *70249036091300
+  version_requirements: *70280538885140
 description: A double-entry bookkeeping system for Ruby on Rails
 email:
 - jeffmess@gmail.com
@@ -77,14 +77,16 @@ files:
 - lib/pacioli/asset_account.rb
 - lib/pacioli/company.rb
 - lib/pacioli/credit.rb
-- lib/pacioli/customer.rb
+- lib/pacioli/creditor.rb
 - lib/pacioli/debit.rb
+- lib/pacioli/debtor.rb
 - lib/pacioli/equity_account.rb
 - lib/pacioli/exception.rb
 - lib/pacioli/expense_account.rb
 - lib/pacioli/income_account.rb
 - lib/pacioli/journal_entry.rb
 - lib/pacioli/liability_account.rb
+- lib/pacioli/party.rb
 - lib/pacioli/posting_rule.rb
 - lib/pacioli/transaction.rb
 - lib/pacioli/validations/company_validator.rb
@@ -101,8 +103,8 @@ files:
 - spec/internal/public/favicon.ico
 - spec/lib/pacioli/account_spec.rb
 - spec/lib/pacioli/company_spec.rb
-- spec/lib/pacioli/customer_spec.rb
 - spec/lib/pacioli/journal_entry_spec.rb
+- spec/lib/pacioli/party_spec.rb
 - spec/lib/pacioli/posting_rule_spec.rb
 - spec/spec_helper.rb
 - spec/support/helpers.rb
@@ -140,8 +142,8 @@ test_files:
 - spec/internal/public/favicon.ico
 - spec/lib/pacioli/account_spec.rb
 - spec/lib/pacioli/company_spec.rb
-- spec/lib/pacioli/customer_spec.rb
 - spec/lib/pacioli/journal_entry_spec.rb
+- spec/lib/pacioli/party_spec.rb
 - spec/lib/pacioli/posting_rule_spec.rb
 - spec/spec_helper.rb
 - spec/support/helpers.rb

data/lib/pacioli/customer.rb

@@ -1,31 +0,0 @@
-module Pacioli
-  class Customer < ActiveRecord::Base
-    belongs_to :customerable, polymorphic: true
-    belongs_to :company, foreign_key: :pacioli_company_id
-    has_many :transactions, foreign_key: :pacioli_customer_id
-
-    def self.for(customer)
-      Customer.where(customerable_type: customer.class.name, customerable_id: customer.id).first || Customer.create!(customerable_type: customer.class.name, customerable_id: customer.id)
-    end
-
-    def with_name(customer_name)
-      self.name = customer_name
-    end
-
-    def with_source(customerable_object)
-      self.customerable = customerable_object
-    end
-
-    def debits
-      transactions.where(type: 'Pacioli::Debit')
-    end
-
-    def credits
-      transactions.where(type: 'Pacioli::Credit')
-    end
-
-    def balance
-      debits.sum(&:amount) - credits.sum(&:amount)
-    end
-  end
-end

data/spec/lib/pacioli/customer_spec.rb

@@ -1,23 +0,0 @@
-require 'spec_helper'
-
-describe Pacioli::Customer do 
-  include Helpers
-
-  before(:each) do
-    tear_it_down
-
-    @company = Pacioli::register_company do
-      with_name "Coca-Cola"
-    end
-
-    @customer = @company.register_customer do
-      with_name "Leonardo da Vinci"
-    end
-  end
-
-  it "should create a customer" do
-    Pacioli::Customer.all.count.should == 1
-    @customer.name.should == "Leonardo da Vinci"
-    @customer.company.should == @company
-  end
-end