RubyGems - borutus - Versions diffs - 0.1.0 - Mend

borutus 0.1.0

Files changed (82) hide show

checksums.yaml +7 -0
data/LICENSE +21 -0
data/README.md +346 -0
data/Rakefile +11 -0
data/app/assets/javascripts/borutus/application.js +16 -0
data/app/assets/javascripts/borutus/reports.js +5 -0
data/app/assets/stylesheets/bootstrap-theme.min.css +5 -0
data/app/assets/stylesheets/bootstrap.min.css +5 -0
data/app/assets/stylesheets/borutus/application.css +19 -0
data/app/controllers/borutus/accounts_controller.rb +30 -0
data/app/controllers/borutus/application_controller.rb +4 -0
data/app/controllers/borutus/entries_controller.rb +34 -0
data/app/controllers/borutus/reports_controller.rb +40 -0
data/app/models/borutus/account.rb +180 -0
data/app/models/borutus/amount.rb +24 -0
data/app/models/borutus/amounts_extension.rb +42 -0
data/app/models/borutus/asset.rb +56 -0
data/app/models/borutus/credit_amount.rb +10 -0
data/app/models/borutus/debit_amount.rb +10 -0
data/app/models/borutus/entry.rb +77 -0
data/app/models/borutus/equity.rb +56 -0
data/app/models/borutus/expense.rb +56 -0
data/app/models/borutus/liability.rb +56 -0
data/app/models/borutus/no_tenancy.rb +9 -0
data/app/models/borutus/revenue.rb +56 -0
data/app/models/borutus/tenancy.rb +15 -0
data/app/views/borutus/accounts/index.html.erb +26 -0
data/app/views/borutus/entries/index.html.erb +59 -0
data/app/views/borutus/reports/_account.html.erb +28 -0
data/app/views/borutus/reports/balance_sheet.html.erb +21 -0
data/app/views/borutus/reports/income_statement.html.erb +24 -0
data/app/views/layouts/borutus/_messages.html.erb +9 -0
data/app/views/layouts/borutus/_navigation.html.erb +19 -0
data/app/views/layouts/borutus/_navigation_links.html.erb +5 -0
data/app/views/layouts/borutus/application.html.erb +19 -0
data/config/backtrace_silencers.rb +7 -0
data/config/database.yml +5 -0
data/config/inflections.rb +10 -0
data/config/mime_types.rb +5 -0
data/config/routes.rb +9 -0
data/config/secret_token.rb +7 -0
data/config/session_store.rb +8 -0
data/db/migrate/20160422010135_create_borutus_tables.rb +33 -0
data/lib/borutus.rb +20 -0
data/lib/borutus/engine.rb +5 -0
data/lib/borutus/version.rb +3 -0
data/lib/generators/borutus/USAGE +13 -0
data/lib/generators/borutus/add_date_upgrade_generator.rb +11 -0
data/lib/generators/borutus/base_generator.rb +19 -0
data/lib/generators/borutus/borutus_generator.rb +12 -0
data/lib/generators/borutus/templates/tenant_migration.rb +6 -0
data/lib/generators/borutus/tenancy_generator.rb +12 -0
data/lib/generators/borutus/upgrade_borutus_generator.rb +12 -0
data/spec/controllers/accounts_controller_spec.rb +19 -0
data/spec/controllers/entries_controller_spec.rb +19 -0
data/spec/controllers/reports_controller_spec.rb +24 -0
data/spec/factories/account_factory.rb +35 -0
data/spec/factories/amount_factory.rb +19 -0
data/spec/factories/entry_factory.rb +11 -0
data/spec/lib/borutus_spec.rb +0 -0
data/spec/models/account_spec.rb +140 -0
data/spec/models/amount_spec.rb +13 -0
data/spec/models/asset_spec.rb +7 -0
data/spec/models/credit_amount_spec.rb +7 -0
data/spec/models/debit_amount_spec.rb +7 -0
data/spec/models/entry_spec.rb +170 -0
data/spec/models/equity_spec.rb +7 -0
data/spec/models/expense_spec.rb +7 -0
data/spec/models/liability_spec.rb +7 -0
data/spec/models/revenue_spec.rb +7 -0
data/spec/models/tenancy_spec.rb +45 -0
data/spec/rcov.opts +2 -0
data/spec/routing/accounts_routing_spec.rb +13 -0
data/spec/routing/entries_routing_spec.rb +13 -0
data/spec/spec.opts +4 -0
data/spec/spec_helper.rb +26 -0
data/spec/support/account_shared_examples.rb +60 -0
data/spec/support/active_support_helpers.rb +13 -0
data/spec/support/amount_shared_examples.rb +21 -0
data/spec/support/factory_girl_helpers.rb +8 -0
data/spec/support/shoulda_matchers.rb +8 -0
metadata +243 -0

data/app/views/layouts/borutus/_navigation_links.html.erb ADDED

@@ -0,0 +1,5 @@
+<%# add navigation links to this file %>
+<li><%= link_to "Balance Sheet", reports_balance_sheet_path%></li>
+<li><%= link_to "Income Statement", reports_income_statement_path%></li>
+<li><%= link_to "General Ledger", accounts_path%></li>
+<li><%= link_to "Journal", entries_path%></li>

data/app/views/layouts/borutus/application.html.erb ADDED

@@ -0,0 +1,19 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  <title>Borutus</title>
+  <%= stylesheet_link_tag    "borutus/application", media: "all" %>
+  <%= javascript_include_tag "borutus/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+    <header>
+      <%= render 'layouts/borutus/navigation' %>
+    </header>
+    <main role="main">
+       <%= render 'layouts/borutus/messages' %>
+       <%= yield %>
+    </main>
+</body>
+</html>

data/config/backtrace_silencers.rb ADDED

@@ -0,0 +1,7 @@
+# Be sure to restart your server when you modify this file.
+# You can add backtrace silencers for libraries that you're using but don't wish to see in your backtraces.
+# Rails.backtrace_cleaner.add_silencer { |line| line =~ /my_noisy_library/ }
+# You can also remove all the silencers if you're trying to debug a problem that might stem from framework code.
+# Rails.backtrace_cleaner.remove_silencers!

data/config/database.yml ADDED

@@ -0,0 +1,5 @@
+# config/database.yml in Rails
+test:
+  adapter: sqlite3
+  database: ":memory:"
+  timeout: 500

data/config/inflections.rb ADDED

@@ -0,0 +1,10 @@
+# Be sure to restart your server when you modify this file.
+# Add new inflection rules using the following format
+# (all these examples are active by default):
+# ActiveSupport::Inflector.inflections do |inflect|
+#   inflect.plural /^(ox)$/i, '\1en'
+#   inflect.singular /^(ox)en/i, '\1'
+#   inflect.irregular 'person', 'people'
+#   inflect.uncountable %w( fish sheep )
+# end

data/config/mime_types.rb ADDED

@@ -0,0 +1,5 @@
+# Be sure to restart your server when you modify this file.
+# Add new mime types for use in respond_to blocks:
+# Mime::Type.register "text/richtext", :rtf
+# Mime::Type.register_alias "text/html", :iphone

data/config/routes.rb ADDED

@@ -0,0 +1,9 @@
+Borutus::Engine.routes.draw do
+  root :to => 'reports#balance_sheet'
+  get 'reports/balance_sheet' => 'reports#balance_sheet'
+  get 'reports/income_statement' => 'reports#income_statement'
+  resources :accounts, only: [:index]
+  resources :entries, only: [:index]
+end

data/config/secret_token.rb ADDED

@@ -0,0 +1,7 @@
+# Be sure to restart your server when you modify this file.
+# Your secret key for verifying the integrity of signed cookies.
+# If you change this key, all old signed cookies will become invalid!
+# Make sure the secret is at least 30 characters and all random,
+# no regular words or you'll be exposed to dictionary attacks.
+Borutus::Application.config.secret_token = 'f6b9c48aaf200fda4bbcf1642319084d5e5cda2bd95ac0a43220aab19f4ee240f9cdab08b77c3284b3a6396b13b1fe8be12a227af04fc5f5a8b7a52b626c4fdd'

data/config/session_store.rb ADDED

@@ -0,0 +1,8 @@
+# Be sure to restart your server when you modify this file.
+Borutus::Application.config.session_store :cookie_store, :key => '_borutus_session'
+# Use the database for sessions instead of the cookie-based default,
+# which shouldn't be used to store highly confidential information
+# (create the session table with "rails generate session_migration")
+# Testtest::Application.config.session_store :active_record_store

data/db/migrate/20160422010135_create_borutus_tables.rb ADDED

@@ -0,0 +1,33 @@
+class CreateBorutusTables < ActiveRecord::Migration[4.2]
+  def change
+    create_table :borutus_accounts do |t|
+      t.string :name
+      t.string :type
+      t.boolean :contra, default: false
+      t.timestamps
+    end
+    add_index :borutus_accounts, [:name, :type]
+    create_table :borutus_entries do |t|
+      t.string :description
+      t.date :date
+      t.integer :commercial_document_id
+      t.string :commercial_document_type
+      t.timestamps
+    end
+    add_index :borutus_entries, :date
+    add_index :borutus_entries, [:commercial_document_id, :commercial_document_type], :name => "index_entries_on_commercial_doc"
+    create_table :borutus_amounts do |t|
+      t.string :type
+      t.references :account
+      t.references :entry
+      t.decimal :amount, :precision => 20, :scale => 10
+    end
+    add_index :borutus_amounts, :type
+    add_index :borutus_amounts, [:account_id, :entry_id]
+    add_index :borutus_amounts, [:entry_id, :account_id]
+  end
+end

data/lib/borutus.rb ADDED

@@ -0,0 +1,20 @@
+# Borutus
+require "rails"
+module Borutus
+  # ------------------------------ tenancy ------------------------------
+  # configuration to enable or disable tenancy
+  mattr_accessor :enable_tenancy
+  enable_tenancy = false
+  mattr_accessor :tenant_class
+  tenant_class = nil
+  # provide hook to configure attributes
+  def self.config
+    yield(self)
+  end
+end
+require "borutus/engine"

data/lib/borutus/engine.rb ADDED

@@ -0,0 +1,5 @@
+module Borutus
+  class Engine < Rails::Engine
+    isolate_namespace Borutus
+  end
+end

data/lib/borutus/version.rb ADDED

@@ -0,0 +1,3 @@
+module Borutus
+  VERSION = "0.1.0"
+end

data/lib/generators/borutus/USAGE ADDED

@@ -0,0 +1,13 @@
+Description:
+    Generator for Borutus Plugin
+Installation:
+    rails g borutus:install:migrations
+    This will:
+        Create a migration in the application for the "Account",
+        "Entry" and "Amount" tables.
+    Once generated, simply run:
+        rake db:migrate

data/lib/generators/borutus/add_date_upgrade_generator.rb ADDED

@@ -0,0 +1,11 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+require_relative 'base_generator'
+module Borutus
+  class AddDateUpgradeGenerator < BaseGenerator
+    def create_migration_file
+      migration_template 'add_date_migration.rb', 'db/migrate/add_date_to_borutus_entries.rb'
+    end
+  end
+end

data/lib/generators/borutus/base_generator.rb ADDED

@@ -0,0 +1,19 @@
+module Borutus
+  class BaseGenerator < 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.
+    # See http://apidock.com/rails/ActiveRecord/Generators/Base/next_migration_number/class
+    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
+  end
+end

data/lib/generators/borutus/borutus_generator.rb ADDED

@@ -0,0 +1,12 @@
+# lib/generators/borutus/borutus_generator.rb
+require 'rails/generators'
+require 'rails/generators/migration'
+require_relative 'base_generator'
+module Borutus
+  class BorutusGenerator < BaseGenerator
+    def create_migration_file
+      migration_template 'migration.rb', 'db/migrate/create_borutus_tables.rb'
+    end
+  end
+end

data/lib/generators/borutus/templates/tenant_migration.rb ADDED

@@ -0,0 +1,6 @@
+class TenantBorutusTables < ActiveRecord::Migration[4.2]
+  def change
+    # add a tenant column to borutus accounts table.
+    add_column :borutus_accounts, :tenant_id, :integer, index: true
+  end
+end

data/lib/generators/borutus/tenancy_generator.rb ADDED

@@ -0,0 +1,12 @@
+# lib/generators/borutus/borutus_generator.rb
+require 'rails/generators'
+require 'rails/generators/migration'
+require_relative 'base_generator'
+module Borutus
+  class TenancyGenerator < BaseGenerator
+    def create_migration_file
+      migration_template 'tenant_migration.rb', 'db/migrate/tenant_borutus_tables.rb'
+    end
+  end
+end

data/lib/generators/borutus/upgrade_borutus_generator.rb ADDED

@@ -0,0 +1,12 @@
+# lib/generators/borutus/borutus_generator.rb
+require 'rails/generators'
+require 'rails/generators/migration'
+require_relative 'base_generator'
+module Borutus
+  class UpgradeBorutusGenerator < BaseGenerator
+    def create_migration_file
+      migration_template 'update_migration.rb', 'db/migrate/update_borutus_tables.rb'
+    end
+  end
+end

data/spec/controllers/accounts_controller_spec.rb ADDED

@@ -0,0 +1,19 @@
+require 'spec_helper'
+module Borutus
+  describe AccountsController do
+    routes { Borutus::Engine.routes }
+    def mock_account(stubs={})
+      @mock_account ||= FactoryGirl.create(:asset)
+    end
+    describe "GET index" do
+      it "assigns all accounts as @accounts" do
+        allow(Account).to receive(:all).and_return([mock_account])
+        get :index
+        expect(assigns[:accounts]).to eq([mock_account])
+      end
+    end
+  end
+end

data/spec/controllers/entries_controller_spec.rb ADDED

@@ -0,0 +1,19 @@
+require 'spec_helper'
+module Borutus
+  describe EntriesController do
+    routes { Borutus::Engine.routes }
+    def mock_entry(stubs={})
+      @mock_entry ||= FactoryGirl.create(:entry_with_credit_and_debit)
+    end
+    describe "GET index" do
+      it "assigns all entries as @entries" do
+        allow(Entry).to receive_message_chain(:per, :order).and_return([mock_entry])
+        get :index
+        expect(assigns[:entries]).to eq([mock_entry])
+      end
+    end
+  end
+end

data/spec/controllers/reports_controller_spec.rb ADDED

@@ -0,0 +1,24 @@
+require 'spec_helper'
+module Borutus
+  describe ReportsController do
+    routes { Borutus::Engine.routes }
+    def mock_entry(stubs={})
+      @mock_entry ||= FactoryGirl.create(:entry_with_credit_and_debit)
+    end
+    describe "GET balance_sheet" do
+      it "renders when one entry exists" do
+        allow(Entry).to receive_message_chain(:order).and_return([mock_entry])
+        get :balance_sheet
+        expect(response).to be_success
+      end
+      it "renders when no entries exist" do
+        allow(Entry).to receive_message_chain(:order).and_return([])
+        get :balance_sheet
+        expect(response).to be_success
+      end
+    end
+  end
+end

data/spec/factories/account_factory.rb ADDED

@@ -0,0 +1,35 @@
+FactoryGirl.define do
+  factory :account, :class => Borutus::Account do |account|
+    account.name
+    account.contra false
+  end
+  factory :asset, :class => Borutus::Asset do |account|
+    account.name
+    account.contra false
+  end
+  factory :equity, :class => Borutus::Equity do |account|
+    account.name
+    account.contra false
+  end
+  factory :expense, :class => Borutus::Expense do |account|
+    account.name
+    account.contra false
+  end
+  factory :liability, :class => Borutus::Liability do |account|
+    account.name
+    account.contra false
+  end
+  factory :revenue, :class => Borutus::Revenue do |account|
+    account.name
+    account.contra false
+  end
+  sequence :name do |n|
+    "Factory Name #{n}"
+  end
+end

data/spec/factories/amount_factory.rb ADDED

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

data/spec/factories/entry_factory.rb ADDED

@@ -0,0 +1,11 @@
+FactoryGirl.define do
+  factory :entry, :class => Borutus::Entry do |entry|
+    entry.description 'factory description'
+    factory :entry_with_credit_and_debit, :class => Borutus::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/lib/borutus_spec.rb ADDED

File without changes

data/spec/models/account_spec.rb ADDED

@@ -0,0 +1,140 @@
+require 'spec_helper'
+module Borutus
+  describe Account do
+    let(:account) { FactoryGirl.build(:account) }
+    subject { account }
+    it { is_expected.not_to be_valid }  # must construct a child type instead
+    describe ".types" do
+      it "lists the available types" do
+        expect(described_class.types).
+          to match_array([Asset, Equity, Expense, Liability, Revenue])
+      end
+    end
+    describe "when using a child type" do
+      let(:account) { FactoryGirl.create(:account, type: "Finance::Asset") }
+      it { is_expected.to be_valid }
+      it "should be unique per name" do
+        conflict = FactoryGirl.build(:account, name: account.name, type: account.type)
+        expect(conflict).not_to be_valid
+        expect(conflict.errors[:name]).to eq(["has already been taken"])
+      end
+    end
+    it "calling the instance method #balance should raise a NoMethodError" do
+      expect { subject.balance }.to raise_error NoMethodError, "undefined method 'balance'"
+    end
+    it "calling the class method ::balance should raise a NoMethodError" do
+      expect { subject.class.balance }.to raise_error NoMethodError, "undefined method 'balance'"
+    end
+    describe ".trial_balance" do
+      subject { Account.trial_balance }
+      it { is_expected.to be_kind_of BigDecimal }
+      context "when given no entries" do
+        it { is_expected.to eq(0) }
+      end
+      context "when given correct entries" do
+        before {
+          # credit accounts
+          liability = FactoryGirl.create(:liability)
+          equity = FactoryGirl.create(:equity)
+          revenue = FactoryGirl.create(:revenue)
+          contra_asset = FactoryGirl.create(:asset, :contra => true)
+          contra_expense = FactoryGirl.create(:expense, :contra => true)
+          # credit amounts
+          ca1 = FactoryGirl.build(:credit_amount, :account => liability, :amount => 100000)
+          ca2 = FactoryGirl.build(:credit_amount, :account => equity, :amount => 1000)
+          ca3 = FactoryGirl.build(:credit_amount, :account => revenue, :amount => 40404)
+          ca4 = FactoryGirl.build(:credit_amount, :account => contra_asset, :amount => 2)
+          ca5 = FactoryGirl.build(:credit_amount, :account => contra_expense, :amount => 333)
+          # debit accounts
+          asset = FactoryGirl.create(:asset)
+          expense = FactoryGirl.create(:expense)
+          contra_liability = FactoryGirl.create(:liability, :contra => true)
+          contra_equity = FactoryGirl.create(:equity, :contra => true)
+          contra_revenue = FactoryGirl.create(:revenue, :contra => true)
+          # debit amounts
+          da1 = FactoryGirl.build(:debit_amount, :account => asset, :amount => 100000)
+          da2 = FactoryGirl.build(:debit_amount, :account => expense, :amount => 1000)
+          da3 = FactoryGirl.build(:debit_amount, :account => contra_liability, :amount => 40404)
+          da4 = FactoryGirl.build(:debit_amount, :account => contra_equity, :amount => 2)
+          da5 = FactoryGirl.build(:debit_amount, :account => contra_revenue, :amount => 333)
+          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 { is_expected.to eq(0) }
+      end
+    end
+    describe "#amounts" do
+      it "returns all credit and debit amounts" do
+        equity = FactoryGirl.create(:equity)
+        asset = FactoryGirl.create(:asset)
+        expense = FactoryGirl.create(:expense)
+        investment = Entry.new(
+          description: "Initial investment",
+          date: Date.today,
+          debits: [{ account_name: equity.name, amount: 1000 }],
+          credits: [{ account_name: asset.name, amount: 1000 }],
+        )
+        investment.save
+        purchase = Entry.new(
+          description: "First computer",
+          date: Date.today,
+          debits: [{ account_name: asset.name, amount: 900 }],
+          credits: [{ account_name: expense.name, amount: 900 }],
+        )
+        purchase.save
+        expect(equity.amounts.size).to eq 1
+        expect(asset.amounts.size).to eq 2
+        expect(expense.amounts.size).to eq 1
+      end
+    end
+    describe "#entries" do
+      it "returns all credit and debit entries" do
+        equity = FactoryGirl.create(:equity)
+        asset = FactoryGirl.create(:asset)
+        expense = FactoryGirl.create(:expense)
+        investment = Entry.new(
+          description: "Initial investment",
+          date: Date.today,
+          debits: [{ account_name: equity.name, amount: 1000 }],
+          credits: [{ account_name: asset.name, amount: 1000 }],
+        )
+        investment.save
+        purchase = Entry.new(
+          description: "First computer",
+          date: Date.today,
+          debits: [{ account_name: asset.name, amount: 900 }],
+          credits: [{ account_name: expense.name, amount: 900 }],
+        )
+        purchase.save
+        expect(equity.entries.size).to eq 1
+        expect(asset.entries.size).to eq 2
+        expect(expense.entries.size).to eq 1
+      end
+    end
+  end
+end