plutus 0.10.1 → 0.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 9fcc5366c07c941520dd02ae4766c2f3a66bc86b
-  data.tar.gz: e65271810a8320451378f8ab75d4ac03ed14d4ba
+SHA256:
+  metadata.gz: f8065148547846775eb69a045ab294f98229eba48276fdeff5db760534264d6b
+  data.tar.gz: a1ccfe5713169766bc4ff1582489b91113e404b47ee345f7cb809dfa155718c9
 SHA512:
-  metadata.gz: bd9b9c732a986b477cd82777bfbf571303b41274f1a49f35fd9f0205c942ed037d330ebdab6cd764e1c2f32848cbd511e3322db99432bb2641edc41a16fec7ac
-  data.tar.gz: 6913884a7ca65b31f98abe1c978a585f3e8c212d0074a2dce4e7755b09163560e93c296b457659c3ca4c422832f845a148efd8ac78a03c7e625540bc211107e2
+  metadata.gz: abd85e610d29aa6ec688a89b6cc739aa6c3a8aae484908fa5fc85c65b1e162e1d2342316c2c282cfe4b773299251fcc0187776f9c14a04d9b07cd54546970490
+  data.tar.gz: 6df2d57b5a8972f40e2b065b94cb6b7cacd1edfba519d07105917c52dadf20a7b57f03a50d9060e5a37409c5e87e67d409ae7e111916739cfa2900af5c258fbb

data/README.markdown

@@ -1,14 +1,14 @@
 Plutus
 =================
-[![Build Status](https://secure.travis-ci.org/mbulat/plutus.png?branch=master)](http://travis-ci.org/mbulat/plutus)
+[![Build Status](https://travis-ci.org/mbulat/plutus.svg?branch=master)](https://travis-ci.org/mbulat/plutus) [![Coverage Status](https://coveralls.io/repos/github/mbulat/plutus/badge.svg?branch=master)](https://coveralls.io/github/mbulat/plutus?branch=master)
 
 The Plutus plugin is a Ruby on Rails Engine which provides a double entry accounting system for your application.
 
 Compatibility
 =============
 
-* Ruby versions: MRI 1.9.3, MRI 2.0, MRI 2.1, Rubinius 2.2, JRuby 1.7+
-* Rails versions: ~> 4.0
+* Ruby versions: MRI 2.2.2+ (should work with earlier versions if using Rails 4)
+* Rails versions: ~> 5.0, ~> 4.0
 
 For earlier versions, and upgrading, please see the section titled [Previous Versions](https://github.com/mbulat/plutus#previous-versions)
 
@@ -16,9 +16,7 @@ Installation
 ============
 
 - Add the gem to your Gemfile `gem "plutus"`
-
-- generate migration files `rails g plutus`
-
+- generate migration files `rake plutus:install:migrations`
 - run migrations `rake db:migrate`
 
 Overview
@@ -45,18 +43,21 @@ The Account class represents accounts in the system. The Account table uses sing
 
 Your Book of Accounts needs to be created prior to recording any entries. The simplest method is to have a number of `create` methods in your db/seeds.rb file like so:
 
-    Plutus::Asset.create(:name => "Accounts Receivable")
-    Plutus::Asset.create(:name => "Cash")
-    Plutus::Revenue.create(:name => "Sales Revenue")
-    Plutus::Liability.create(:name => "Unearned Revenue")
-    Plutus::Liability.create(:name => "Sales Tax Payable")
-    etc...
+```ruby
+Plutus::Asset.create(:name => "Accounts Receivable")
+Plutus::Asset.create(:name => "Cash")
+Plutus::Revenue.create(:name => "Sales Revenue")
+Plutus::Liability.create(:name => "Unearned Revenue")
+Plutus::Liability.create(:name => "Sales Tax Payable")
+```
 
 Then simply run `rake db:seed`
 
 Each account can also be marked as a "Contra Account". A contra account will have its normal balance swapped. For example, to remove equity, a "Drawing" account may be created as a contra equity account as follows:
 
-    Plutus::Equity.create(:name => "Drawing", :contra => true)
+```ruby
+Plutus::Equity.create(:name => "Drawing", :contra => true)
+```
 
 At all times the balance of all accounts should conform to the [Accounting
 Equation](http://en.wikipedia.org/wiki/Accounting_equation)
@@ -75,45 +76,56 @@ Recording an Entry
 
 Let's assume we're accounting on an [Accrual basis](http://en.wikipedia.org/wiki/Accounting_methods#Accrual_basis). We've just taken a customer's order for some widgets, which we've also billed him for. At this point we've actually added a liability to the company until we deliver the goods. To record this entry we'd need two accounts:
 
-    >> Plutus::Asset.create(:name => "Cash")
-    >> Plutus::Liability.create(:name => "Unearned Revenue")
+```ruby
+>> Plutus::Asset.create(:name => "Cash")
+>> Plutus::Liability.create(:name => "Unearned Revenue")
+```
 
-Next we'll build the entry we want to record. Plutus provides a simple interface to build the entry.
+Next we'll build the entry we want to record. Plutus uses ActiveRecord conventions to build the transaction and its associated amounts.
 
-    entry = Plutus::Entry.build(
-                    :description => "Order placed for widgets",
-                    :debits => [
-                      {:account => "Cash", :amount => 100.00}],
-                    :credits => [
-                      {:account => "Unearned Revenue", :amount => 100.00}])
+```ruby
+entry = Plutus::Entry.new(
+                :description => "Order placed for widgets",
+                :date => Date.yesterday,
+                :debits => [
+                  {:account_name => "Cash", :amount => 100.00}],
+                :credits => [
+                  {:account_name => "Unearned Revenue", :amount => 100.00}])
+```
 
-The build method takes a hash consisting of a description, and an array of debits and credits. Each debit and credit item is a hash that specifies the amount, and the account to be debited or credited. Simply pass in the string name you used when you created the account.
+Entries must specify a description, as well as at least one credit and debit amount. Specifying the date is optional; by default, the current date will be assigned to the entry before the record is saved. `debits` and `credits` must specify an array of hashes, with an amount value as well as an account, either by providing a `Plutus::Account` to `account` or by passing in an `account_name` string.
 
 Finally, save the entry.
 
-    >> entry.save
+```ruby
+>> entry.save
+```
 
-If there are any issues with your credit and debit amounts, the save will fail and return false. You can inspect the errors via `entry.errors`. Because we are doing double-entry accounting, your credit and debit amounts must always cancel out to keep the accounts in balance.
+If there are any issues with your credit and debit amounts, the save will fail and return false. You can inspect the errors via `entry.errors`. Because we are doing double-entry accounting, the sum total of your credit and debit amounts must always cancel out to keep the accounts in balance.
 
 Recording an Entry with multiple accounts
 -----------------------------------------
 
 Often times a single entry requires more than one type of account. A classic example would be a entry in which a tax is charged. We'll assume that we have not yet received payment for the order, so we'll need an "Accounts Receivable" Asset:
 
-    >> Plutus::Asset.create(:name => "Accounts Receivable")
-    >> Plutus::Revenue.create(:name => "Sales Revenue")
-    >> Plutus::Liability.create(:name => "Sales Tax Payable")
+```ruby
+>> Plutus::Asset.create(:name => "Accounts Receivable")
+>> Plutus::Revenue.create(:name => "Sales Revenue")
+>> Plutus::Liability.create(:name => "Sales Tax Payable")
+```
 
 And here's the entry:
 
-    entry = Plutus::Entry.build(
-                    :description => "Sold some widgets",
-                    :debits => [
-                      {:account => "Accounts Receivable", :amount => 50}],
-                    :credits => [
-                      {:account => "Sales Revenue", :amount => 45},
-                      {:account => "Sales Tax Payable", :amount => 5}])
-    entry.save
+```ruby
+entry = Plutus::Entry.build(
+                :description => "Sold some widgets",
+                :debits => [
+                  {:account_name => "Accounts Receivable", :amount => 50}],
+                :credits => [
+                  {:account_name => "Sales Revenue", :amount => 45},
+                  {:account_name => "Sales Tax Payable", :amount => 5}])
+entry.save
+```
 
 Associating Documents
 ---------------------
@@ -122,19 +134,23 @@ Although Plutus does not provide a mechanism for generating invoices or orders,
 
 Suppose we pull up our latest invoice in order to generate a entry for plutus (we'll assume you already have an Invoice model):
 
-    >> invoice = Invoice.last
+```ruby
+>> invoice = Invoice.last
+```
 
 Let's assume we're using the same entry from the last example
 
-    entry = Plutus::Entry.build(
-                    :description => "Sold some widgets",
-                    :commercial_document => invoice,
-                    :debits => [
-                      {:account => "Accounts Receivable", :amount => invoice.total_amount}],
-                    :credits => [
-                      {:account => "Sales Revenue", :amount => invoice.sales_amount},
-                      {:account => "Sales Tax Payable", :amount => invoice.tax_amount}])
-    entry.save
+```ruby
+entry = Plutus::Entry.new(
+                :description => "Sold some widgets",
+                :commercial_document => invoice,
+                :debits => [
+                  {:account_name => "Accounts Receivable", :amount => invoice.total_amount}],
+                :credits => [
+                  {:account_name => "Sales Revenue", :amount => invoice.sales_amount},
+                  {:account_name => "Sales Tax Payable", :amount => invoice.tax_amount}])
+entry.save
+```
 
 The commercial document attribute on the entry is a polymorphic association allowing you to associate any record from your models with a entry (i.e. Bills, Invoices, Receipts, Returns, etc.)
 
@@ -143,26 +159,46 @@ Checking the Balance of an  Individual Account
 
 Each account can report on its own balance. This number should normally be positive. If the number is negative, you may have a problem.
 
-    >> cash = Plutus::Asset.find_by_name("Cash")
-    >> cash.balance
-    => #<BigDecimal:103259bb8,'0.2E4',4(12)>
+```ruby
+>> cash = Plutus::Asset.find_by_name("Cash")
+>> cash.balance
+=> #<BigDecimal:103259bb8,'0.2E4',4(12)>
+```
+
+The balance can also be calculated within a specified date range. Dates can be strings in the format of "yyyy-mm-dd" or Ruby Date objects.
 
+```ruby
+>> cash = Plutus::Asset.find_by_name("Cash")
+>> cash.balance(:from_date => "2014-01-01", :to_date => Date.today)
+=> #<BigDecimal:103259bb8,'0.2E4',4(12)>
+```
 
 Checking the Balance of an Account Type
 ---------------------------------------
 
 Each subclass of accounts can report on the total balance of all the accounts of that type. This number should normally be positive. If the number is negative, you may have a problem.
 
-    >> Plutus::Asset.balance
-    => #<BigDecimal:103259bb8,'0.2E4',4(12)>
+```ruby
+>> Plutus::Asset.balance
+=> #<BigDecimal:103259bb8,'0.2E4',4(12)>
+```
+
+Again, a date range can be given
+
+```ruby
+>> Plutus::Asset.balance(:from_date => "2014-01-01", :to_date => Date.today)
+=> #<BigDecimal:103259bb8,'0.2E4',4(12)>
+```
 
 Calculating the Trial Balance
 -----------------------------
 
 The [Trial Balance](http://en.wikipedia.org/wiki/Trial_balance) for all accounts on the system can be found through the abstract Account class. This value should be 0 unless there is an error in the system.
 
-    >> Plutus::Account.trial_balance
-    => #<BigDecimal:1031c0d28,'0.0',4(12)>
+```ruby
+>> Plutus::Account.trial_balance
+=> #<BigDecimal:1031c0d28,'0.0',4(12)>
+```
 
 Contra Accounts and Complex Entries
 -----------------------------------
@@ -173,37 +209,61 @@ For complex entries, you should always ensure that you are balancing your accoun
 
 For example, let's assume the owner of a business wants to withdraw cash. First we'll assume that we have an asset account for "Cash" which the funds will be drawn from. We'll then need an Equity account to record where the funds are going, however, in this case, we can't simply create a regular Equity account. The "Cash" account must be credited for the decrease in its balance since it's an Asset. Likewise, Equity accounts are typically credited when there is an increase in their balance. Equity is considered an owner's rights to Assets in the business. In this case however, we are not simply increasing the owner's rights to assets within the business; we are actually removing capital from the business altogether. Hence both sides of our accounting equation will see a decrease. In order to accomplish this, we need to create a Contra-Equity account we'll call "Drawings". Since Equity accounts normally have credit balances, a Contra-Equity account will have a debit balance, which is what we need for our entry.
 
-    >> Plutus::Equity.create(:name => "Drawing", :contra => true)
-    >> Plutus::Asset.create(:name => "Cash")
+```ruby
+>> Plutus::Equity.create(:name => "Drawing", :contra => true)
+>> Plutus::Asset.create(:name => "Cash")
+```
 
 We would then create the following entry:
 
-    entry = Plutus::Entry.build(
-                    :description => "Owner withdrawing cash",
-                    :debits => [
-                      {:account => "Drawing", :amount => 1000}],
-                    :credits => [
-                      {:account => "Cash", :amount => 1000}])
-    entry.save
+```ruby
+entry = Plutus::Entry.new(
+                :description => "Owner withdrawing cash",
+                :debits => [
+                  {:account_name => "Drawing", :amount => 1000}],
+                :credits => [
+                  {:account_name => "Cash", :amount => 1000}])
+entry.save
+```
 
 To make the example clearer, imagine instead that the owner decides to invest his money into the business in exchange for some type of equity security. In this case we might have the following accounts:
 
-    >> Plutus::Equity.create(:name => "Common Stock")
-    >> Plutus::Asset.create(:name => "Cash")
+```ruby
+>> Plutus::Equity.create(:name => "Common Stock")
+>> Plutus::Asset.create(:name => "Cash")
+```
 
 And out entry would be:
 
-    entry = Plutus::Entry.build(
-                    :description => "Owner investing cash",
-                    :debits => [
-                      {:account => "Cash", :amount => 1000}],
-                    :credits => [
-                      {:account => "Common Stock", :amount => 1000}])
-    entry.save
+```ruby
+entry = Plutus::Entry.new(
+                :description => "Owner investing cash",
+                :debits => [
+                  {:account_name => "Cash", :amount => 1000}],
+                :credits => [
+                  {:account_name => "Common Stock", :amount => 1000}])
+entry.save
+```
 
 In this case, we've increase our cash Asset, and simultaneously increased the other side of our accounting equation in
 Equity, keeping everything balanced.
 
+Money & Currency Support
+========================
+
+Plutus aims to be agnostic about the values used for amounts. All fields are maintained as BigDecimal values, with `:precision => 20, :scale => 10`, which means that any currency can be safely stored in the tables.
+
+Plutus is also compatible with the [Money](https://github.com/RubyMoney/money) gem. With Money versions greater than 6.0, the `money.amount` will returns a BigDecimal which you can use with plutus as follows:
+
+```ruby
+entry = Plutus::Entry.build(
+                :description => "Order placed for widgets",
+                :debits => [
+                  {:account_name => "Cash", :amount => money.amount}],
+                :credits => [
+                  {:account_name => "Unearned Revenue", :amount => money.amount}])
+```
+
 Multitenancy Support
 =====================
 
@@ -212,47 +272,61 @@ Plutus supports multitenant applications. Multitenancy is acheived by associatin
 - Generate the migration which will add `tenant_id` to the plutus accounts table
 
 ```sh
-  bundle exec rails g plutus:tenancy
+bundle exec rails g plutus:tenancy
 ```
 
 - Run the migration
 
 ```sh
-  rake db:migrate
+rake db:migrate
 ```
 
 - Add an initializer to your Rails application, i.e. `config/initializers/plutus.rb`
 
 ```ruby
-  Plutus.config do |config|
-    config.enable_tenancy = true
-    config.tenant_class = 'Tenant'
-  end
+Plutus.config do |config|
+  config.enable_tenancy = true
+  config.tenant_class = 'Tenant'
+end
 ```
+*NOTE: When building entries, be sure to specify the account directly, rather than use the `account_name` feature. Otherwise you'll probably end up with the wrong account.*
 
-Access & Security
-=================
+```ruby
+debit_account = Plutus::Account.where(:name => "Cash", :tenant => my_tenant).last
+credit_account = Plutus::Account.where(:name => "Unearned Revenue", :tenant => my_tenant).last
+entry = Plutus::Entry.new(
+                :description => "Order placed for widgets",
+                :date => Date.yesterday,
+                :debits => [
+                  {:account => debit_account, :amount => 100.00}],
+                :credits => [
+                  {:account => credit_account, :amount => 100.00}])
+```
 
-The Engine provides controllers and views for viewing Accounts and Entries via the `Plutus::AccountsController` and `Plutus::EntriesController` classes. The controllers will render HTML, XML and JSON.
+Reporting Views
+===============
 
-These controllers are read-only for reporting purposes. It is assumed entry creation will occur within your applications code.
+The Engine provides controllers and views for rendering basic reports, including a Balance Sheet and Income Statement.
+
+These views and controllers are read-only for reporting purposes. It is assumed entry creation will occur within your applications code.
 
 Routing is supplied via an engine mount point. Plutus can be mounted on a subpath in your existing Rails 3 app by adding the following to your routes.rb:
 
-    mount Plutus::Engine => "/plutus", :as => "plutus"
+```ruby
+mount Plutus::Engine => "/plutus", :as => "plutus"
+```
 
-*NOTE: If you enable routing, you should ensure that your ApplicationController enforces its own authentication and authorization, which this controller will inherit.*
+*NOTE: The `Plutus::ApplicationController` does not currently support authentication. If you enable routing, the views will be publicly available on your mount point. Authentication can be added by overriding the controller.*
 
-Sample stylesheets can also be applied by adding the following to your application layout:
+*Future versions of plutus will allow for customization of authentication.*
 
-    <%= stylesheet_link_tag    "plutus/application" %>
 
 Previous Versions
 =================
 
 For the rails 3 version, you can go here:
 
-[https://github.com/mbulat/plutus](https://github.com/mbulat/plutus/tree/rails3)
+[https://github.com/mbulat/plutus/tree/rails3](https://github.com/mbulat/plutus/tree/rails3)
 
 For the rails 2 version, you can go here:
 
@@ -261,25 +335,26 @@ For the rails 2 version, you can go here:
 * Gems in RubyGems.org >= 0.5.0 support Rails 3
 * Gems in RubyGems.org >= 0.8.0 support Rails 4
 * Gems in RubyGems.org >= 0.9.0 support Rails ~> 4.1
+* Gems in RubyGems.org >= 0.13.0 support Rails ~> 5.0
 
-Upgrading from < 0.9
---------------------
+Upgrading from older versions
+-----------------------------
 
-Versions of Plutus prior to 0.9 used a "Transaction" class to keep track of entries. Rails 4.1 introduced a change that
-raises an error with Plutus due to an ActiveRecord method conflict with "transaction". Therefore the Transaction class
-has been renamed "Entry". To generate a migration which will update your database run the following:
+As Plutus is still in alpha, there have been some breaking changes with previous versions.
 
-- `rails g plutus:upgrade_plutus`
+If you are upgrading, please check the Wiki for guides on how to properly upgrade plutus to deal with the changes:
 
-You only need to do this when upgrading a previously installed version of Plutus.
+[Upgrade Notes](https://github.com/mbulat/plutus/wiki/Updrade-Notes)
 
 Testing
 =======
 
 [Rspec](http://rspec.info/) tests are provided. Run `bundle install` then `rake`.
 
-Contributors
-============
+Contributing and Contributors
+=============================
+
+There's a guide to contributing to Plutus (both code and general help) over in [CONTRIBUTING](https://github.com/mbulat/plutus/blob/master/CONTRIBUTING.md)
 
 Many thanks to all our contributors! Check them all at:
 
@@ -297,14 +372,12 @@ Plutus is free software, but if you'd like to support development, feel free to
 
 `1QFSdJheyFkLcsV8X428J8e3pYqX1nmW39`
 
-![bitcoin](https://dl.dropboxusercontent.com/u/8428240/plutus_tip.png)
-
 Also, if anyone is using Plutus for bitcoin related accounting, I'd love to hear about it! Drop me a line.
 
 ToDo
 ====
 
-* Better views, including paging and ledgers
+* Better views, including paging
 * Reference for common accounting entries
 
 Reference
@@ -316,4 +389,4 @@ For a complete reference on Accounting principles, we recommend the following te
 
 * * *
 
-Copyright (c) 2010-2012 Michael Bulat
+Copyright (c) 2010-2016 Michael Bulat

data/app/assets/javascripts/plutus/application.js

@@ -2,14 +2,15 @@
 // listed below.
 //
 // Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
-// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
 //
 // It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
-// the compiled file.
+// compiled file.
 //
-// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
-// GO AFTER THE REQUIRES BELOW.
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
 //
 //= require jquery
 //= require jquery_ujs
+//= require jquery-ui/widgets/datepicker
 //= require_tree .