borutus 0.1.0

data/spec/models/amount_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+module Borutus
+  describe Amount do
+
+    describe "attributes" do
+      it { is_expected.to delegate_method(:name).to(:account).with_prefix }
+    end
+
+    subject { FactoryGirl.build(:amount) }
+    it { is_expected.not_to be_valid }  # construct a child class instead
+  end
+end

data/spec/models/asset_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+module Borutus
+  describe Asset do
+    it_behaves_like 'a Borutus::Account subtype', kind: :asset, normal_balance: :debit
+  end
+end

data/spec/models/credit_amount_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+module Borutus
+  describe CreditAmount do
+    it_behaves_like 'a Borutus::Amount subtype', kind: :credit_amount
+  end
+end

data/spec/models/debit_amount_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+module Borutus
+  describe DebitAmount do
+    it_behaves_like 'a Borutus::Amount subtype', kind: :debit_amount
+  end
+end

data/spec/models/entry_spec.rb

@@ -0,0 +1,170 @@
+require 'spec_helper'
+
+module Borutus
+  describe Entry do
+    let(:entry) { FactoryGirl.build(:entry) }
+    subject { entry }
+
+    it { is_expected.not_to be_valid }
+
+    context "with credit and debit" do
+      let(:entry) { FactoryGirl.build(:entry_with_credit_and_debit) }
+      it { is_expected.to be_valid }
+
+      it "should require a description" do
+        entry.description = nil
+        expect(entry).not_to be_valid
+      end
+    end
+
+    context "with a debit" do
+      before {
+        entry.debit_amounts << FactoryGirl.build(:debit_amount, entry: entry)
+      }
+      it { is_expected.not_to be_valid }
+
+      context "with an invalid credit" do
+        before {
+          entry.credit_amounts << FactoryGirl.build(:credit_amount, entry: entry, amount: nil)
+        }
+        it { is_expected.not_to be_valid }
+      end
+    end
+
+    context "with a credit" do
+      before {
+        entry.credit_amounts << FactoryGirl.build(:credit_amount, entry: entry)
+      }
+      it { is_expected.not_to be_valid }
+
+      context "with an invalid debit" do
+        before {
+          entry.debit_amounts << FactoryGirl.build(:debit_amount, entry: entry, amount: nil)
+        }
+        it { is_expected.not_to be_valid }
+      end
+    end
+
+    context "without a date" do
+      let(:entry) { FactoryGirl.build(:entry_with_credit_and_debit, date: nil) }
+
+      context "should assign a default date before being saved" do
+        before { entry.save! }
+        its(:date) { is_expected.to eq(Time.now.to_date) }
+      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)
+      expect(entry).not_to be_valid
+      expect(entry.errors['base']).to eq(["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)
+      expect(entry).not_to be_valid
+      expect(entry.errors['base']).to eq(["The credit and debit amounts are not equal"])
+    end
+
+    it "should ignore debit and credit amounts marked for destruction to cancel" do
+      entry.credit_amounts << FactoryGirl.build(:credit_amount, :amount => 100, :entry => entry)
+      debit_amount = FactoryGirl.build(:debit_amount, :amount => 100, :entry => entry)
+      debit_amount.mark_for_destruction
+      entry.debit_amounts << debit_amount
+      expect(entry).not_to be_valid
+      expect(entry.errors['base']).to eq(["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)
+      expect(saved_entry.commercial_document).to eq(mock_document)
+    end
+
+    context "given a set of accounts" do
+      let(:mock_document) { FactoryGirl.create(:asset) }
+      let!(:accounts_receivable) { FactoryGirl.create(:asset, name: "Accounts Receivable") }
+      let!(:sales_revenue) { FactoryGirl.create(:revenue, name: "Sales Revenue") }
+      let!(:sales_tax_payable) { FactoryGirl.create(:liability, name: "Sales Tax Payable") }
+
+      shared_examples_for 'a built-from-hash Borutus::Entry' do
+        its(:credit_amounts) { is_expected.not_to be_empty }
+        its(:debit_amounts) { is_expected.not_to be_empty }
+        it { is_expected.to be_valid }
+
+        context "when saved" do
+          before { entry.save! }
+          its(:id) { is_expected.not_to be_nil }
+
+          context "when reloaded" do
+            let(:saved_transaction) { Entry.find(entry.id) }
+            subject { saved_transaction }
+            it("should have the correct commercial document") {
+              saved_transaction.commercial_document == mock_document
+            }
+          end
+        end
+      end
+
+      describe ".new" do
+        let(:entry) { Entry.new(hash) }
+        subject { entry }
+
+        context "when given a credit/debits hash with :account => Account" do
+          let(:hash) {
+            {
+                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}
+                ]
+            }
+          }
+          include_examples 'a built-from-hash Borutus::Entry'
+        end
+
+        context "when given a credit/debits hash with :account_name => String" do
+          let(:hash) {
+            {
+                description: "Sold some widgets",
+                commercial_document: mock_document,
+                debits: [{account_name: accounts_receivable.name, amount: 50}],
+                credits: [
+                    {account_name: sales_revenue.name, amount: 45},
+                    {account_name: sales_tax_payable.name, amount: 5}
+                ]
+            }
+          }
+          include_examples 'a built-from-hash Borutus::Entry'
+        end
+      end
+
+      describe ".build" do
+        let(:entry) { Entry.build(hash) }
+        subject { entry }
+
+        before { ::ActiveSupport::Deprecation.silenced = true }
+        after { ::ActiveSupport::Deprecation.silenced = false }
+
+        context "when used at all" do
+          let(:hash) { Hash.new }
+
+          it("should be deprecated") {
+            # .build is the only thing deprecated
+            expect(::ActiveSupport::Deprecation).to receive(:warn).once
+            entry
+          }
+        end
+
+      end
+    end
+
+  end
+end

data/spec/models/equity_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+module Borutus
+  describe Equity do
+    it_behaves_like 'a Borutus::Account subtype', kind: :equity, normal_balance: :credit
+  end
+end

data/spec/models/expense_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+module Borutus
+  describe Expense do
+    it_behaves_like 'a Borutus::Account subtype', kind: :expense, normal_balance: :debit
+  end
+end

data/spec/models/liability_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+module Borutus
+  describe Liability do
+    it_behaves_like 'a Borutus::Account subtype', kind: :liability, normal_balance: :credit
+  end
+end

data/spec/models/revenue_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+module Borutus
+  describe Revenue do
+    it_behaves_like 'a Borutus::Account subtype', kind: :revenue, normal_balance: :credit
+  end
+end

data/spec/models/tenancy_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+module Borutus
+  describe Account do
+    describe 'tenancy support' do
+      before(:each) do
+        ActiveSupportHelpers.clear_model('Account')
+        ActiveSupportHelpers.clear_model('Asset')
+
+        Borutus.enable_tenancy = true
+        Borutus.tenant_class = 'Borutus::Entry'
+
+        FactoryGirlHelpers.reload()
+        Borutus::Asset.new
+      end
+
+      after(:each) do
+        if Borutus.const_defined?(:Asset)
+          ActiveSupportHelpers.clear_model('Account')
+          ActiveSupportHelpers.clear_model('Asset')
+        end
+
+        Borutus.enable_tenancy = false
+        Borutus.tenant_class = nil
+
+        FactoryGirlHelpers.reload()
+      end
+
+      it 'validate uniqueness of name scoped to tenant' do
+        account = FactoryGirl.create(:asset, tenant_id: 10)
+
+        record = FactoryGirl.build(:asset, name: account.name, tenant_id: 10)
+        expect(record).not_to be_valid
+        expect(record.errors[:name]).to eq(['has already been taken'])
+      end
+
+      it 'allows same name scoped under a different tenant' do
+        account = FactoryGirl.create(:asset, tenant_id: 10)
+
+        record = FactoryGirl.build(:asset, name: account.name, tenant_id: 11)
+        expect(record).to be_valid
+      end
+    end
+  end
+end

data/spec/rcov.opts

@@ -0,0 +1,2 @@
+--exclude "spec/*,gems/*"
+--rails

data/spec/routing/accounts_routing_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+module Borutus
+  describe AccountsController do
+    routes { Borutus::Engine.routes }
+
+    describe "routing" do
+      it "recognizes and generates #index" do
+        expect(:get => "/accounts").to route_to(:controller => "borutus/accounts", :action => "index")
+      end
+    end
+  end
+end

data/spec/routing/entries_routing_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+module Borutus
+  describe EntriesController do
+    routes { Borutus::Engine.routes }
+
+    describe "routing" do
+      it "recognizes and generates #index" do
+        expect(:get => "/entries").to route_to(:controller => "borutus/entries", :action => "index")
+      end
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1,4 @@
+--colour
+--format progress
+--loadby mtime
+--reverse

data/spec/spec_helper.rb

@@ -0,0 +1,26 @@
+require 'coveralls'
+Coveralls.wear!
+
+ENV["RAILS_ENV"] ||= 'test'
+require File.expand_path(File.dirname(__FILE__) + "/../fixture_rails_root/config/environment")
+
+require Rails.root.join('db/schema').to_s
+require 'rspec/rails'
+
+$: << File.expand_path(File.dirname(__FILE__) + '/../lib/')
+require 'borutus'
+require 'kaminari'
+
+Dir[File.expand_path(File.join(File.dirname(__FILE__),'support','**','*.rb'))].each {|f| require f}
+
+require 'factory_girl'
+borutus_definitions = File.expand_path(File.join(File.dirname(__FILE__), 'factories'))
+FactoryGirl.definition_file_paths << borutus_definitions
+
+
+RSpec.configure do |config|
+  config.use_transactional_fixtures = true
+  config.infer_spec_type_from_file_location!
+end
+
+FactoryGirlHelpers.reload()

data/spec/support/account_shared_examples.rb

@@ -0,0 +1,60 @@
+shared_examples_for 'a Borutus::Account subtype' do |elements|
+  let(:contra) { false }
+  let(:account) { FactoryGirl.create(elements[:kind], contra: contra)}
+  subject { account }
+
+  describe "class methods" do
+    subject { account.class }
+    its(:balance) { is_expected.to be_kind_of(BigDecimal) }
+    describe "trial_balance" do
+      it "should raise NoMethodError" do
+        expect { subject.trial_balance }.to raise_error NoMethodError
+      end
+    end
+  end
+
+  describe "instance methods" do
+    its(:balance) { is_expected.to be_kind_of(BigDecimal) }
+
+    it "reports a balance with date range" do
+      expect(account.balance(:from_date => "2014-01-01", :to_date => Date.today)).to be_kind_of(BigDecimal)
+    end
+
+    it { is_expected.to respond_to(:credit_entries) }
+    it { is_expected.to respond_to(:debit_entries) }
+  end
+
+  it "requires a name" do
+    account.name = nil
+    expect(account).not_to be_valid
+  end
+
+  # Figure out which way credits and debits should apply
+  if elements[:normal_balance] == :debit
+     debit_condition = :>
+    credit_condition = :<
+  else
+    credit_condition = :>
+     debit_condition = :<
+  end
+
+  describe "when given a debit" do
+    before { FactoryGirl.create(:debit_amount, account: account) }
+    its(:balance) { is_expected.to be.send(debit_condition, 0) }
+
+    describe "on a contra account" do
+      let(:contra) { true }
+      its(:balance) { is_expected.to be.send(credit_condition, 0) }
+    end
+  end
+
+  describe "when given a credit" do
+    before { FactoryGirl.create(:credit_amount, account: account) }
+    its(:balance) { is_expected.to be.send(credit_condition, 0) }
+
+    describe "on a contra account" do
+      let(:contra) { true }
+      its(:balance) { is_expected.to be.send(debit_condition, 0) }
+    end
+  end
+end

data/spec/support/active_support_helpers.rb

@@ -0,0 +1,13 @@
+module ActiveSupportHelpers
+  # Helps in removing model, and force-reloading it next time This helper does 2
+  # things:
+  # * remove from $LOADED_FEATURES so that ruby 'require' reloads file again
+  # * remove the constant from active support dependencies
+  def self.clear_model(model_name)
+    ActiveSupport::Dependencies.remove_constant('Borutus::' + model_name)
+
+    models_dir = File.dirname(__FILE__) + '/../../app/models/borutus/'
+    path = File.expand_path(models_dir + model_name.downcase + '.rb')
+    $LOADED_FEATURES.delete(path)
+  end
+end

data/spec/support/amount_shared_examples.rb

@@ -0,0 +1,21 @@
+shared_examples_for 'a Borutus::Amount subtype' do |elements|
+  let(:amount) { FactoryGirl.build(elements[:kind]) }
+  subject { amount }
+
+  it { is_expected.to  be_valid }
+
+  it "should require an amount" do
+    amount.amount = nil
+    expect(amount).not_to be_valid
+  end
+
+  it "should require a entry" do
+    amount.entry = nil
+    expect(amount).not_to be_valid
+  end
+
+  it "should require an account" do
+    amount.account = nil
+    expect(amount).not_to be_valid
+  end
+end