plutus 0.8.1 → 0.9.0

data/app/views/plutus/{transactions → entries}/index.html.erb

@@ -1,5 +1,5 @@
 <div class="plutus_container">
-<h1>Transactions</h1>
+<h1>Entries</h1>
 
 <table cellspacing="0">
   <thead>
@@ -12,15 +12,15 @@
     </tr>
   </thead>
   <tbody>
-  <% @transactions.each do |transaction| %>
+  <% @entries.each do |entry| %>
     <tr class="<%= cycle("even", "odd") -%>">
-      <td><%=link_to(transaction.id, transaction_path(transaction)) %></td>
-      <td><%=h transaction.description %></td>
+      <td><%=link_to(entry.id, entry_path(entry)) %></td>
+      <td><%=h entry.description %></td>
       <td></td>
       <td></td>
-      <td><%=h transaction.created_at %></td>
+      <td><%=h entry.created_at %></td>
     </tr>
-    <% transaction.debit_amounts.each do |debit_amount| %>
+    <% entry.debit_amounts.each do |debit_amount| %>
       <tr class="<%= cycle("odd", "odd") -%>">
         <td></td>
         <td>&nbsp;&nbsp;&nbsp;&nbsp;<%=h "#{debit_amount.account.name}" %></td>
@@ -29,7 +29,7 @@
         <td></td>
       </tr>
     <% end %>
-    <% transaction.credit_amounts.each do |credit_amount| %>
+    <% entry.credit_amounts.each do |credit_amount| %>
       <tr class="<%= cycle("odd", "odd") -%>">
         <td></td>
         <td>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<%=h "#{credit_amount.account.name}" %></td>
@@ -45,4 +45,4 @@
 <br />
 
 <h3>Go to <%= link_to 'Accounts', accounts_path %></h3>
-</div>
+</div>

data/app/views/plutus/{transactions → entries}/show.html.erb

@@ -1,5 +1,5 @@
 <div class="plutus_container">
-<h1><%=h @transaction.description %> Transaction</h1>
+<h1><%=h @entry.description %> Entry</h1>
 
 <table cellspacing="0">
   <thead>
@@ -13,13 +13,13 @@
   </thead>
   <tbody>
     <tr class="<%= cycle("even", "odd") -%>">
-      <td><%=link_to(@transaction.id, transaction_path(@transaction)) %></td>
-      <td><%=h @transaction.description %></td>
+      <td><%=link_to(@entry.id, entry_path(@entry)) %></td>
+      <td><%=h @entry.description %></td>
       <td></td>
       <td></td>
-      <td><%=h @transaction.created_at %></td>
+      <td><%=h @entry.created_at %></td>
     </tr>
-    <% @transaction.debit_amounts.each do |debit_amount| %>
+    <% @entry.debit_amounts.each do |debit_amount| %>
       <tr class="<%= cycle("odd", "odd") -%>">
         <td></td>
         <td>&nbsp;&nbsp;&nbsp;&nbsp;<%=h "#{debit_amount.account.name}" %></td>
@@ -28,7 +28,7 @@
         <td></td>
       </tr>
     <% end %>
-    <% @transaction.credit_amounts.each do |credit_amount| %>
+    <% @entry.credit_amounts.each do |credit_amount| %>
       <tr class="<%= cycle("odd", "odd") -%>">
         <td></td>
         <td>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<%=h "#{credit_amount.account.name}" %></td>

data/config/routes.rb

@@ -2,5 +2,5 @@ Plutus::Engine.routes.draw do
   root :to => "accounts#index"
 
   resources :accounts
-  resources :transactions
+  resources :entries
 end

data/lib/generators/plutus/USAGE

@@ -1,11 +1,22 @@
 Description:
     Generator for Plutus Plugin
 
-Example:
+Installation:
     rails g plutus
 
-    This will create:
-        Create a migration in the application for the "Account" and Transaction" tables.
+    This will:
+        Create a migration in the application for the "Account",
+        "Entry" and "Amount" tables.
+
+    Once generated, simply run:
+        rake db:migrate
+
+Upgrade < 0.8 -> 0.9+:
+    rails g plutus:upgrade_plutus
+
+    This will:
+        Create a migration in the application for renaming the
+        "Transaction" table, columns and indexes to "Entry" tables.
         
     Once generated, simply run:
         rake db:migrate

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

@@ -9,29 +9,29 @@ class CreatePlutusTables < ActiveRecord::Migration
     end
     add_index :plutus_accounts, [:name, :type]
 
-    create_table :plutus_transactions do |t|
+    create_table :plutus_entries do |t|
       t.string :description
       t.integer :commercial_document_id
       t.string :commercial_document_type
 
       t.timestamps
     end
-    add_index :plutus_transactions, [:commercial_document_id, :commercial_document_type], :name => "index_transactions_on_commercial_doc"
+    add_index :plutus_entries, [:commercial_document_id, :commercial_document_type], :name => "index_entries_on_commercial_doc"
 
     create_table :plutus_amounts do |t|
       t.string :type
       t.references :account
-      t.references :transaction
+      t.references :entry
       t.decimal :amount, :precision => 20, :scale => 10
     end 
     add_index :plutus_amounts, :type
-    add_index :plutus_amounts, [:account_id, :transaction_id]
-    add_index :plutus_amounts, [:transaction_id, :account_id]
+    add_index :plutus_amounts, [:account_id, :entry_id]
+    add_index :plutus_amounts, [:entry_id, :account_id]
   end
 
   def self.down
     drop_table :plutus_accounts
-    drop_table :plutus_transactions
+    drop_table :plutus_entries
     drop_table :plutus_amounts
   end
 end

data/lib/generators/plutus/templates/update_migration.rb

@@ -0,0 +1,17 @@
+class UpdatePlutusTables < ActiveRecord::Migration
+  def change
+    # we have to remove these indexes because the temporary
+    # table index name is too long
+    remove_index :plutus_amounts, [:account_id, :transaction_id]
+    remove_index :plutus_amounts, [:transaction_id, :account_id]
+    remove_index :plutus_transactions, column: [:commercial_document_id, :commercial_document_type], :name => "index_transactions_on_commercial_doc"
+    
+    rename_table :plutus_transactions, :plutus_entries
+    rename_column :plutus_amounts, :transaction_id, :entry_id
+    
+    # adding the indexes back
+    add_index :plutus_amounts, [:account_id, :entry_id]
+    add_index :plutus_amounts, [:entry_id, :account_id]
+    add_index :plutus_entries, [:commercial_document_id, :commercial_document_type], :name => "index_entries_on_commercial_doc"
+  end
+end

data/lib/generators/plutus/upgrade_plutus_generator.rb

@@ -0,0 +1,28 @@
+# lib/generators/plutus/plutus_generator.rb
+require 'rails/generators'
+require 'rails/generators/migration'
+
+module Plutus
+class UpgradePlutusGenerator < Rails::Generators::Base
+ include Rails::Generators::Migration
+
+ def self.source_root
+		@source_root ||= File.join(File.dirname(__FILE__), 'templates')
+ end
+
+ # Implement the required interface for Rails::Generators::Migration.
+ # taken from http://github.com/rails/rails/blob/master/activerecord/lib/generators/active_record.rb
+ def self.next_migration_number(dirname)
+	 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 'update_migration.rb', 'db/migrate/update_plutus_tables.rb'
+ end
+
+end
+end

data/lib/plutus/version.rb

@@ -1,3 +1,3 @@
 module Plutus
-  VERSION = "0.8.1"
+  VERSION = "0.9.0"
 end

data/spec/controllers/entries_controller_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+module Plutus
+  describe EntriesController do
+    # Run these tests if you enable routing in your rails app. See README
+
+    #def mock_entry(stubs={})
+      #@mock_entry ||= mock_model(Entry, stubs)
+    #end
+
+    #describe "GET index" do
+      #it "assigns all entries as @entries" do
+        #Entry.stub(:find).with(:all).and_return([mock_entry])
+        #get :index
+        #assigns[:entries].should == [mock_entry]
+      #end
+    #end
+
+    #describe "GET show" do
+      #it "assigns the requested entry as @entry" do
+        #Entry.stub(:find).with("37").and_return(mock_entry)
+        #get :show, :id => "37"
+        #assigns[:entry].should equal(mock_entry)
+      #end
+    #end
+
+  end
+end

data/spec/factories/amount_factory.rb

@@ -1,19 +1,19 @@
 FactoryGirl.define do
   factory :amount, :class => Plutus::Amount do |amount|
     amount.amount BigDecimal.new('473')
-    amount.association :transaction, :factory => :transaction_with_credit_and_debit
+    amount.association :entry, :factory => :entry_with_credit_and_debit
     amount.association :account, :factory => :asset
   end
 
   factory :credit_amount, :class => Plutus::CreditAmount do |credit_amount|
     credit_amount.amount BigDecimal.new('473')
-    credit_amount.association :transaction, :factory => :transaction_with_credit_and_debit
+    credit_amount.association :entry, :factory => :entry_with_credit_and_debit
     credit_amount.association :account, :factory => :revenue
   end
 
   factory :debit_amount, :class => Plutus::DebitAmount do |debit_amount|
     debit_amount.amount BigDecimal.new('473')
-    debit_amount.association :transaction, :factory => :transaction_with_credit_and_debit
+    debit_amount.association :entry, :factory => :entry_with_credit_and_debit
     debit_amount.association :account, :factory => :asset
   end
 end

data/spec/factories/entry_factory.rb

@@ -0,0 +1,11 @@
+FactoryGirl.define do
+  factory :entry, :class => Plutus::Entry do |entry|
+    entry.description 'factory description'
+    factory :entry_with_credit_and_debit, :class => Plutus::Entry do |entry_cd|
+      entry_cd.after_build do |t|
+        t.credit_amounts << FactoryGirl.build(:credit_amount, :entry => t)
+        t.debit_amounts << FactoryGirl.build(:debit_amount, :entry => t)
+      end
+    end
+  end
+end

data/spec/models/account_spec.rb

@@ -24,11 +24,11 @@ module Plutus
       subject { Account.trial_balance }
       it { should be_kind_of BigDecimal }
       
-      context "when given no transactions" do
+      context "when given no entries" do
         it { should == 0 }
       end
       
-      context "when given correct transactions" do
+      context "when given correct entries" do
         before {
           # credit accounts
           liability = FactoryGirl.create(:liability)
@@ -56,11 +56,11 @@ module Plutus
           da4 = FactoryGirl.build(:debit_amount, :account => contra_equity, :amount => 2)
           da5 = FactoryGirl.build(:debit_amount, :account => contra_revenue, :amount => 333)
 
-          FactoryGirl.create(:transaction, :credit_amounts => [ca1], :debit_amounts => [da1])
-          FactoryGirl.create(:transaction, :credit_amounts => [ca2], :debit_amounts => [da2]) 
-          FactoryGirl.create(:transaction, :credit_amounts => [ca3], :debit_amounts => [da3])
-          FactoryGirl.create(:transaction, :credit_amounts => [ca4], :debit_amounts => [da4])
-          FactoryGirl.create(:transaction, :credit_amounts => [ca5], :debit_amounts => [da5])
+          FactoryGirl.create(:entry, :credit_amounts => [ca1], :debit_amounts => [da1])
+          FactoryGirl.create(:entry, :credit_amounts => [ca2], :debit_amounts => [da2]) 
+          FactoryGirl.create(:entry, :credit_amounts => [ca3], :debit_amounts => [da3])
+          FactoryGirl.create(:entry, :credit_amounts => [ca4], :debit_amounts => [da4])
+          FactoryGirl.create(:entry, :credit_amounts => [ca5], :debit_amounts => [da5])
         }
         
         it { should == 0 }

data/spec/models/entry_spec.rb

@@ -0,0 +1,91 @@
+require 'spec_helper'
+
+module Plutus
+  describe Entry do
+    let(:entry) { FactoryGirl.build(:entry) }
+    subject { entry }
+
+    it { should_not be_valid }
+
+    context "with credit and debit" do
+      let(:entry) { FactoryGirl.build(:entry_with_credit_and_debit) }
+      it { should be_valid }
+      
+      it "should require a description" do
+        entry.description = nil
+        entry.should_not be_valid
+      end
+    end
+
+    context "with a debit" do
+      before {
+        entry.debit_amounts << FactoryGirl.build(:debit_amount, entry: entry)
+      }
+      it { should_not be_valid }
+
+      context "with an invalid credit" do
+        before {
+          entry.credit_amounts << FactoryGirl.build(:credit_amount, entry: entry, amount: nil)
+        }
+        it { should_not be_valid }
+      end
+    end
+
+    context "with a credit" do
+      before {
+        entry.credit_amounts << FactoryGirl.build(:credit_amount, entry: entry)
+      }
+      it { should_not be_valid }
+
+      context "with an invalid debit" do
+        before {
+          entry.debit_amounts << FactoryGirl.build(:debit_amount, entry: entry, amount: nil)
+        }
+        it { should_not be_valid }
+      end
+    end
+
+    it "should require the debit and credit amounts to cancel" do
+      entry.credit_amounts << FactoryGirl.build(:credit_amount, :amount => 100, :entry => entry)
+      entry.debit_amounts << FactoryGirl.build(:debit_amount, :amount => 200, :entry => entry)
+      entry.should_not be_valid
+      entry.errors['base'].should == ["The credit and debit amounts are not equal"]
+    end
+
+    it "should require the debit and credit amounts to cancel even with fractions" do
+      entry = FactoryGirl.build(:entry)
+      entry.credit_amounts << FactoryGirl.build(:credit_amount, :amount => 100.1, :entry => entry)
+      entry.debit_amounts << FactoryGirl.build(:debit_amount, :amount => 100.2, :entry => entry)
+      entry.should_not be_valid
+      entry.errors['base'].should == ["The credit and debit amounts are not equal"]
+    end
+
+    it "should have a polymorphic commercial document associations" do
+      mock_document = FactoryGirl.create(:asset) # one would never do this, but it allows us to not require a migration for the test
+      entry = FactoryGirl.build(:entry_with_credit_and_debit, commercial_document: mock_document)
+      entry.save!
+      saved_entry = Entry.find(entry.id)
+      saved_entry.commercial_document.should == mock_document
+    end
+
+    it "should allow building an entry and credit and debits with a hash" do
+      FactoryGirl.create(:asset, name: "Accounts Receivable")
+      FactoryGirl.create(:revenue, name: "Sales Revenue")
+      FactoryGirl.create(:liability, name: "Sales Tax Payable")
+      mock_document = FactoryGirl.create(:asset)
+      entry = Entry.build(
+        description: "Sold some widgets",
+        commercial_document: mock_document,
+        debits: [
+          {account: "Accounts Receivable", amount: 50}], 
+        credits: [
+          {account: "Sales Revenue", amount: 45},
+          {account: "Sales Tax Payable", amount: 5}])
+      entry.save!
+
+      saved_entry = Entry.find(entry.id)
+      saved_entry.commercial_document.should == mock_document
+    end
+
+  end
+end

data/spec/routing/{transactions_routing_spec.rb → entries_routing_spec.rb}

@@ -1,31 +1,31 @@
 require 'spec_helper'
 
 module Plutus
-  describe TransactionsController do
+  describe EntriesController do
     # Run these tests if you enable routing in your rails app. See README 
     #describe "routing" do
       #it "recognizes and generates #index" do
-        #{ :get => "/transactions" }.should route_to(:controller => "transactions", :action => "index")
+        #{ :get => "/entries" }.should route_to(:controller => "entries", :action => "index")
       #end
 
       #it "recognizes and generates #show" do
-        #{ :get => "/transactions/1" }.should route_to(:controller => "transactions", :action => "show", :id => "1")
+        #{ :get => "/entries/1" }.should route_to(:controller => "entries", :action => "show", :id => "1")
       #end
 
       #it "recognizes and generates #edit" do
-        #{ :get => "/transactions/1/edit" }.should_not be_routable
+        #{ :get => "/entries/1/edit" }.should_not be_routable
       #end
 
       #it "recognizes and generates #create" do
-        #{ :post => "/transactions" }.should_not be_routable
+        #{ :post => "/entries" }.should_not be_routable
       #end
 
       #it "recognizes and generates #update" do
-        #{ :put => "/transactions/1" }.should_not be_routable
+        #{ :put => "/entries/1" }.should_not be_routable
       #end
 
       #it "recognizes and generates #destroy" do
-        #{ :delete => "/transactions/1" }.should_not be_routable
+        #{ :delete => "/entries/1" }.should_not be_routable
       #end
     #end
   end

data/spec/support/account_shared_examples.rb

@@ -16,8 +16,8 @@ shared_examples_for 'a Plutus::Account subtype' do |elements|
   describe "instance methods" do
     its(:balance) { should be_kind_of(BigDecimal) }
 
-    it { should respond_to(:credit_transactions) }
-    it { should respond_to(:debit_transactions) }
+    it { should respond_to(:credit_entries) }
+    it { should respond_to(:debit_entries) }
   end
 
   it "requires a name" do

data/spec/support/amount_shared_examples.rb

@@ -9,8 +9,8 @@ shared_examples_for 'a Plutus::Amount subtype' do |elements|
     amount.should_not be_valid
   end
 
-  it "should require a transaction" do
-    amount.transaction = nil
+  it "should require a entry" do
+    amount.entry = nil
     amount.should_not be_valid
   end