debitcredit 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6cfcdb2b31ab7056ea1dd628dda187da43281c4c
-  data.tar.gz: f507fc2e81e79a87938ae214d96701867dfe5bd1
+  metadata.gz: 9d5bcf4938491d376adc5a00d2635bd1d3c7de59
+  data.tar.gz: cb1ec56618c56492739e6f283bd6df21b0789928
 SHA512:
-  metadata.gz: f59d1cd9b5e394b8e467749e973508cd493a403775e335104130f66554034f3bc1b791b81433c8ab1f33ef84748dad476b31bdb21002114e29326eda7f4c5de1
-  data.tar.gz: 6ad0c2cb0b0bd1fe2815095d2ac4888a986b8a18d8ee725a7357fe7d5c9d4140f3256f68b6ed0a1812eb54192a55809aa842daa052399955db6a07b60283ed50
+  metadata.gz: d95a97ce0104513e21e0c354bf24d180b44727119fe738fe7b67ed0a508a48c2c6b9606463d6e7cd7cc737b26e5f0dd2a5b4e24519d57aed3f0aedb1e9c9ce15
+  data.tar.gz: ec3c2ac293655a912936f4455ea97212d57f28f95a42fa4a07a0a73fc95b09d6d73703d9fd5c192749d3b2ff05996166032894affc21360599cd035f609e75d9

data/README.md

@@ -7,15 +7,23 @@ Double Entry Accounting for Rails Applications
 
 ## Installation
 
-* add `get 'debitcredit'` to your `Gemfile`
+* add `gem 'debitcredit'` to your `Gemfile`
 * and run `bundle install`
-* run `rake debitcredit:install:migrations db:migrate`
+* run `rake debitcredit:install:migrations db:migrate db:test:prepare`
 
-## Installation
+## Upgrade
 
 * and run `bundle update debitcredit`
 * run `rake debitcredit:install:migrations db:migrate`
 
+### IMPORTANT: version 0.2.0 introduced backwards incompatible changes:
+
+Transactions were renamed to entries. You need to rename:
+
+* Transaction to Entry
+* transactions to entries
+* has_transactions to has_entries
+
 ## Account Types, Debits and Credits
 
 <http://en.wikipedia.org/wiki/Debits_and_credits>
@@ -27,7 +35,7 @@ Expense and Equity defined as follows:
 from which future economic benefits are expected to flow to the entity
 
 **Liability** is defined as an obligation of an entity arising from past
-transactions or events, the settlement of which may result in the transfer or
+entries or events, the settlement of which may result in the transfer or
 use of assets, provision of services or other yielding of economic benefits in
 the future.
 
@@ -45,7 +53,7 @@ equity participants.
 difference between the total assets of the entity and all its liabilities.
 
 
-In each transaction, sources are credited and destinations are debited.
+In each entry, sources are credited and destinations are debited.
 
 I repeat: credit is the **source** and debit is the **destination**.
 
@@ -97,7 +105,7 @@ Or better yet:
       include Debitcredit::Extension
 
       has_accounts
-      has_transactions do
+      has_entries do
         def pay!
           ...
         end
@@ -123,11 +131,11 @@ You can pass a block to `has_accounts` and to define referenced accounts:
 
     User.first.accounts.salary # will be created on first use
 
-## Transactions
+## Entries
 
-You can prepare transactions using DSL:
+You can prepare entries using DSL:
 
-    t = Transaction.prepare(description: 'rent payment') do
+    t = Entry.prepare(description: 'rent payment') do
       debit expense_account, 100, "you can also provide a comment"
       credit bank_account, 50
       credit creditcard, 50
@@ -137,21 +145,21 @@ You can prepare transactions using DSL:
 Sum of the debits must be equal to the sum of the credits. Amounts can not be
 negative.
 
-You can create transactions with a reference. For this case, and in case that
+You can create entries with a reference. For this case, and in case that
 reference has 'accounts' association, you can use account names instead of objects:
 
-    t = user1.transactions.prepare(description: 'sale') do
+    t = user1.entries.prepare(description: 'sale') do
       debit :checking, 100 # will use user1.accounts[:checking]
       credit user2.accounts[:checking], 100
     end
 
-You can prepare an inverse transaction. For example if you want to rollback an
-existing transaction:
+You can prepare an inverse entry. For example if you want to rollback an
+existing entry:
 
 rollback = existing.inverse(kind: 'refund', description: 'item is out of stock')
 rollback.save!
 
-> Note: by inverse transactions are allowed to take accounts into overdraft. if
+> Note: by inverse entries are allowed to take accounts into overdraft. if
 > this is undesirable, pass `enable_overdraft` to the `inverse` call.
 
 ## Contributing

data/app/models/debitcredit/{transaction.rb → entry.rb}

@@ -1,11 +1,11 @@
 require 'docile'
 module Debitcredit
-  class Transaction < ActiveRecord::Base
+  class Entry < ActiveRecord::Base
     belongs_to :reference, polymorphic: true
-    belongs_to :parent_transaction, class_name: 'Debitcredit::Transaction'
-    has_many :child_transactions, class_name: 'Debitcredit::Transaction', foreign_key: 'parent_transaction_id'
-    belongs_to :inverse_transaction, class_name: 'Debitcredit::Transaction'
-    has_many :items, dependent: :destroy, autosave: true
+    belongs_to :parent_entry, class_name: 'Debitcredit::Entry'
+    has_many :child_entries, class_name: 'Debitcredit::Entry', foreign_key: 'parent_entry_id'
+    belongs_to :inverse_entry, class_name: 'Debitcredit::Entry'
+    has_many :items, dependent: :destroy, autosave: true, inverse_of: :entry
 
     validates :reference, :description, presence: true
     validate :ensure_balanced
@@ -30,8 +30,8 @@ module Debitcredit
         res.description ||= "reverse of tr ##{id}: #{description}"
         res.kind ||= 'rollback'
         res.reference ||= reference
-        res.parent_transaction = self
-        self.inverse_transaction ||= res
+        res.parent_entry = self
+        self.inverse_entry ||= res
       end
     end
 
@@ -56,11 +56,11 @@ module Debitcredit
     end
 
     def save_parent
-      parent_transaction.save! if parent_transaction.try(:inverse_transaction) == self
+      parent_entry.save! if parent_entry.try(:inverse_entry) == self
     end
 
     def parent_not_inversed
-      errors.add(:base, :already_inversed) if parent_transaction.inverse_transaction_id
+      errors.add(:base, :already_inversed) if parent_entry.inverse_entry_id
     end
   end
 end

data/app/models/debitcredit/entry/dsl.rb

@@ -0,0 +1,36 @@
+class Debitcredit::Entry::Dsl
+  attr_accessor :entry
+  attr_accessor :accounts
+
+  def initialize(entry)
+    @entry = entry
+  end
+
+  def kind(kind)
+    @entry.kind = kind
+  end
+
+  def description(desc)
+    @entry.description = desc
+  end
+  alias desc description
+
+  def reference(ref)
+    @entry.reference = ref
+  end
+  alias ref reference
+
+  def debit(account, amount, comment = nil)
+    build_item true, account, amount, comment
+  end
+
+  def credit(account, amount, comment = nil)
+    build_item false, account, amount, comment
+  end
+
+  private
+  def build_item(debit, account, amount, comment)
+    account = entry.reference.accounts[account] if account.is_a?(Symbol) && entry.reference.try(:respond_to?, :accounts)
+    entry.items.build debit: debit, account: account, amount: amount, comment: comment
+  end
+end

data/app/models/debitcredit/extension.rb

@@ -18,8 +18,8 @@ module Debitcredit
         end
       end
 
-      def has_transactions(&block)
-        has_many :transactions, as: :reference, class_name: 'Debitcredit::Transaction' do
+      def has_entries(&block)
+        has_many :entries, as: :reference, class_name: 'Debitcredit::Entry' do
           def [](kind)
             find_by kind: kind
           end

data/app/models/debitcredit/item.rb

@@ -1,10 +1,10 @@
 module Debitcredit
   class Item < ActiveRecord::Base
-    belongs_to :transaction
+    belongs_to :entry
     belongs_to :account
 
-    validate :transaction, :account, presence: true
-    validate :amount, numericality: true, greater_than_or_equal_to: 0
+    validates :entry, :account, presence: true
+    validates :amount, numericality: {greater_than_or_equal_to: 0}
 
     scope :debit, ->{where(debit: true)}
     scope :credit, ->{where(debit: false)}
@@ -22,7 +22,7 @@ module Debitcredit
     end
 
     def inverse
-      self.class.new account: account, transaction: transaction, amount: amount, debit: credit?
+      self.class.new account: account, entry: entry, amount: amount, debit: credit?
     end
   end
 end

data/config/locales/en.yml

@@ -3,7 +3,7 @@ en:
   activerecord:
     errors:
       models:
-        debitcredit/transaction:
+        debitcredit/entry:
           unbalanced: item amounts must balance to 0
           already_inversed: parent transaction already inversed
         debitcredit/account:

data/db/migrate/20150106165647_rename_transactions.rb

@@ -0,0 +1,9 @@
+class RenameTransactions < ActiveRecord::Migration
+  def change
+    rename_table :debitcredit_transactions, :debitcredit_entries
+    rename_column :debitcredit_entries, :parent_transaction_id, :parent_entry_id
+    rename_column :debitcredit_entries, :inverse_transaction_id, :inverse_entry_id
+
+    rename_column :debitcredit_items, :transaction_id, :entry_id
+  end
+end

data/lib/debitcredit/version.rb

@@ -1,3 +1,3 @@
 module Debitcredit
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: debitcredit
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Vitaly Kushner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-04 00:00:00.000000000 Z
+date: 2015-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
         version: 4.0.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
         version: 4.0.4
 - !ruby/object:Gem::Dependency
@@ -189,14 +189,14 @@ files:
 - app/models/debitcredit/asset_account.rb
 - app/models/debitcredit/credit_account.rb
 - app/models/debitcredit/debit_account.rb
+- app/models/debitcredit/entry/dsl.rb
+- app/models/debitcredit/entry.rb
 - app/models/debitcredit/equity_account.rb
 - app/models/debitcredit/expense_account.rb
 - app/models/debitcredit/extension.rb
 - app/models/debitcredit/income_account.rb
 - app/models/debitcredit/item.rb
 - app/models/debitcredit/liability_account.rb
-- app/models/debitcredit/transaction/dsl.rb
-- app/models/debitcredit/transaction.rb
 - config/locales/en.yml
 - db/migrate/20140121145455_create_debitcredit_accounts.rb
 - db/migrate/20140121181304_create_debitcredit_transactions.rb
@@ -206,6 +206,7 @@ files:
 - db/migrate/20140128153104_add_account_overdraft.rb
 - db/migrate/20140130095257_no_overdraft_by_default.rb
 - db/migrate/20140612113944_add_inverse_transaction_id.rb
+- db/migrate/20150106165647_rename_transactions.rb
 - lib/debitcredit/engine.rb
 - lib/debitcredit/version.rb
 - lib/debitcredit.rb

data/app/models/debitcredit/transaction/dsl.rb

@@ -1,36 +0,0 @@
-class Debitcredit::Transaction::Dsl
-  attr_accessor :transaction
-  attr_accessor :accounts
-
-  def initialize(transaction)
-    @transaction = transaction
-  end
-
-  def kind(kind)
-    @transaction.kind = kind
-  end
-
-  def description(desc)
-    @transaction.description = desc
-  end
-  alias desc description
-
-  def reference(ref)
-    @transaction.reference = ref
-  end
-  alias ref reference
-
-  def debit(account, amount, comment = nil)
-    build_item true, account, amount, comment
-  end
-
-  def credit(account, amount, comment = nil)
-    build_item false, account, amount, comment
-  end
-
-  private
-  def build_item(debit, account, amount, comment)
-    account = transaction.reference.accounts[account] if account.is_a?(Symbol) && transaction.reference.try(:respond_to?, :accounts)
-    transaction.items.build debit: debit, account: account, amount: amount, comment: comment
-  end
-end