acts_as_account 1.1.1 → 1.1.5

data/README.rdoc

@@ -1,16 +1,21 @@
-acts_as_account implements double entry accounting for Rails models. Your models get accounts and you can do consistent transactions between them. Since the documentation is sparse, see the transfer.feature for usage examples.
+= acts_as_account
 
 == Theory
 
-Acts as account hooks into ActiveRecord and allows to add accounts to any model by 
-simply adding "has_account" to your model. Because the accounts
-are connected via a has_many relation no migration to the account-hoder
+ActsAsAccount implements a "Double Entry Accounting" system for your 
+Rails-models.
+
+It hooks into ActiveRecord and allows to add accounts to any model by 
+simply means of adding "has_account" to your model. Because the accounts
+are connected via a has_many relation no migration to the account-holder
 tables is needed.
 
 We also hook into the ActionController request cycle to warn the developer 
-if a Request has left the uncommitted changes in the system.
+if a request has left the uncommitted changes in the system.
+
+== How to test
 
-If you would like to run the cucumber features from the acs_as_account gem, just execute
+Run the cucumber features from the acs_as_account gem, just execute
 * rake features:create_database 
 * cucumber
 
@@ -18,14 +23,10 @@ If you would like to run the cucumber features from the acs_as_account gem, just
 
 * Double Entry Accounting in a Relational Database: http://homepages.tcp.co.uk/~m-wigley/gc_wp_ded.html
 
-== Todo
-
-* add transaction isolation tests
-
 == Credits
 
-This gem was written for the payment backend of betterplace.org by Thies C. Arntzen (http://github.com/thieso2) and Norman Timmler (http://github.com/unnu).
+This gem was written for the payment backend of betterplace.org by Thies C. Arntzen (http://github.com/thieso2) and Norman Timmler (github.com/unnu).
 
 == Copyright
-
-Copyright (c) 2010 gut.org gAG
+ 
+Copyright (c) 2010 gut.org gAG

data/Rakefile

@@ -10,6 +10,9 @@ begin
     gem.email = "thieso@gmail.com"
     gem.homepage = "http://github.com/betterplace/acts_as_account"
     gem.authors = ["Thies C. Arntzen, Norman Timmler, Matthias Frick, Phillip Oertel"]
+    gem.add_dependency 'activerecord'
+    gem.add_dependency 'actionpack'
+    gem.add_dependency 'database_cleaner'
   end
   Jeweler::GemcutterTasks.new
 rescue LoadError

data/VERSION

@@ -1 +1 @@
-1.1.1
+1.1.5

data/db/database.yml

@@ -5,11 +5,3 @@ acts_as_account:
   username: root
   password:
   host: localhost
-
-betterplace:
-  adapter: mysql
-  encoding: utf8
-  database: betterplace_production20100222
-  username: root
-  password:
-  host: localhost

data/features/step_definitions/account_steps.rb

@@ -45,7 +45,7 @@ Then /^the global (\w+) account balance is (-?\d+) €$/ do |name, balance|
   assert_equal balance.to_i, Account.for(name).balance
 end
 
-When /^I transfer (\d+) € from (\w+)'s account to (\w+)'s account$/ do |amount, from, to|
+When /^I transfer (-?\d+) € from (\w+)'s account to (\w+)'s account$/ do |amount, from, to|
   from_account = User.find_by_name(from).account
   to_account = User.find_by_name(to).account
   Journal.current.transfer(amount.to_i, from_account, to_account, @reference, @valuta)
@@ -122,4 +122,12 @@ end
 Then /^(\w+) with (\w+) (\w+) references all postings$/ do |reference_class, name, value|
   reference = reference_class.constantize.find(:first, :conditions => "#{name} = #{value}")
   assert_equal Posting.all, reference.postings 
+end
+
+Then /^the order of the postings is correct$/ do
+  # make sure we always book "Soll an Haben"
+  Posting.all.in_groups_of(2) do |from, to|
+    assert from.amount < 0
+    assert to.amount > 0
+  end
 end

data/features/support/cheque.rb

@@ -1,3 +1,3 @@
 class Cheque < ActiveRecord::Base
-  has_postings
+  is_reference
 end

data/features/support/env.rb

@@ -1,5 +1,4 @@
 require 'rubygems'
-
 gem 'mysql'
 gem 'activerecord'
 gem 'actionpack'

data/features/transfer/transfer.feature

@@ -9,7 +9,16 @@ Feature: Transfer
     When I transfer 30 € from Thies's account to Norman's account
     Then Thies's account balance is -30 €
     And Norman's account balance is 30 €
+    And the order of the postings is correct
     
+  Scenario: I transfer a negative amount between accounts having holders
+    Given I create a user Thies
+    Given I create a user Norman
+    When I transfer -30 € from Thies's account to Norman's account
+    Then Thies's account balance is 30 €
+    And Norman's account balance is -30 €
+    And the order of the postings is correct
+
   Scenario: I transfer money between global accounts
     Given I create a global wirecard account
     Given I create a global anonymous_donation account

data/init.rb

@@ -1 +1 @@
-require 'acts_as_account'
+require 'acts_as_account'

data/lib/acts_as_account.rb

@@ -13,4 +13,5 @@ ActiveRecord::Base.class_eval do
   include ActsAsAccount::ActiveRecordExtension
 end
 
-require 'acts_as_account/global_account'
+require 'acts_as_account/global_account'
+require 'acts_as_account/manually_created_account'

data/lib/acts_as_account/account.rb

@@ -13,6 +13,34 @@ module ActsAsAccount
     # validates_presence_of :holder
     
     class << self
+      
+      def recalculate_all_balances
+        ActsAsAccount::Account.update_all(:balance => 0, :postings_count => 0, :last_valuta => nil)
+        sql = <<-EOT
+        SELECT 
+          account_id as id, 
+          count(*) as calculated_postings_count,
+          sum(amount) as calculated_balance,
+          max(valuta) as calculated_valuta
+        FROM
+          acts_as_account_postings 
+        GROUP BY 
+          account_id 
+        HAVING 
+          calculated_postings_count > 0
+        EOT
+
+        ActsAsAccount::Account.find_by_sql(sql).each do |account|
+          account.lock!
+          account.update_attributes(
+            :balance => account.calculated_balance, 
+            :postings_count => account.calculated_postings_count,
+            :last_valuta => account.calculated_valuta)
+
+          puts "account:#{account.id}, balance:#{account.balance}, postings_count:#{account.postings_count}, last_valuta:#{account.last_valuta}"
+        end
+      end
+      
       def for(name)
         GlobalAccount.find_or_create_by_name(name.to_s).account
       end
@@ -29,6 +57,16 @@ module ActsAsAccount
         end
       end
       
+      def delete_account(number)
+        transaction do
+          account = find(number)
+          raise ActiveRecord::ActiveRecordError, "Cannot be deleted" unless account.deleteable?
+          
+          account.holder.destroy if [ManuallyCreatedAccount, GlobalAccount].include?(account.holder.class)
+          account.destroy
+        end
+      end
+      
       def find_on_error(attributes)
         yield
         
@@ -45,5 +83,9 @@ module ActsAsAccount
         record || raise
       end
     end
+
+    def deleteable?
+      postings.empty? && journals.empty?
+    end
   end
-end
+end

data/lib/acts_as_account/active_record_extensions.rb

@@ -18,8 +18,13 @@ module ActsAsAccount
         end
       end
       
-      def has_postings
+      def is_reference
         has_many :postings, :class_name => "ActsAsAccount::Posting", :as => :reference
+        class_eval <<-EOS
+          def booked?
+            postings.any?
+          end
+        EOS
       end
 
       def has_global_account(name)

data/lib/acts_as_account/journal.rb

@@ -18,17 +18,28 @@ module ActsAsAccount
         Thread.current[:acts_as_account_current] = nil
       end
     end
+    
+    def transfers
+      returning([]) do |transfers|
+        postings.in_groups_of(2) { |postings| transfers << Transfer.new(*postings) }
+      end
+    end
 
     def transfer(amount, from_account, to_account, reference = nil, valuta = Time.now)
       transaction do
+        if (amount < 0) 
+          # change order if amount is negative
+          amount, from_account, to_account = -amount, to_account, from_account
+        end
+
         logger.debug { "ActsAsAccount::Journal.transfer amount: #{amount} from:#{from_account.id} to:#{to_account.id} reference:#{reference.class.name}(#{reference.id}) valuta:#{valuta}" } if logger
         
         # to avoid possible deadlocks we need to ensure that the locking order is always
         # the same therfore the sort by id. 
         [from_account, to_account].sort_by(&:id).map(&:lock!)
-
-        add_posting(amount * -1, from_account,   to_account, reference, valuta)
-        add_posting(amount,        to_account, from_account, reference, valuta)
+        
+        add_posting(-amount,  from_account,   to_account, reference, valuta)
+        add_posting( amount,    to_account, from_account, reference, valuta)
       end
     end
     
@@ -43,8 +54,13 @@ module ActsAsAccount
 
         account.balance += posting.amount
         account.postings_count += 1
-        account.last_valuta = account.last_valuta ? [account.last_valuta, posting.valuta].max : posting.valuta
-      
+
+        # The last valuta will be the most recent date btw this posting valuta (payment.created_at)
+        # and the last valuta.
+        # TODO 2010-05-20 jm: Ask Holger how the last valuta could be more recent than the payment ???
+
+
+        # TODO 2010-05-20 jm: Ask Holger with saving *without* validations ???
         posting.save_without_validation
         account.save_without_validation
       end

data/lib/acts_as_account/manually_created_account.rb

@@ -0,0 +1,9 @@
+module ActsAsAccount
+  class ManuallyCreatedAccount < ActiveRecord::Base
+    set_table_name :acts_as_account_manually_created_accounts
+    
+    has_account
+    
+    validates_length_of :name, :minimum => 1
+  end
+end

data/lib/acts_as_account/posting.rb

@@ -6,5 +6,10 @@ module ActsAsAccount
     belongs_to :other_account, :class_name => 'Account'
     belongs_to :journal
     belongs_to :reference, :polymorphic => true
+    
+    named_scope :soll,  :conditions => 'amount >= 0'
+    named_scope :haben, :conditions => 'amount < 0'
+    named_scope :start_date,  lambda{|date| {:conditions => ['DATE(valuta) >= ?', date]}}
+    named_scope :end_date,    lambda{|date| {:conditions => ['DATE(valuta) <= ?', date]}}
   end
 end

data/lib/acts_as_account/transfer.rb

@@ -1,20 +1,21 @@
 module ActsAsAccount
   class Transfer
-    attr_accessor :amount, :reference, :from, :to, :journal
+    attr_accessor :amount, :reference, :from, :to, :journal, :valuta
   
     def initialize(posting_1, posting_2)
       @amount, @reference = posting_2.amount, posting_2.reference
       @from, @to = posting_1.account, posting_2.account
       @journal = posting_1.journal
+      @valuta = posting_1.valuta
     end
   
     def referencing_a?(klasse)
       reference.kind_of?(klasse)
     end
     
-    def reverse(reference = @reference, valuta = Time.now)
+    def reverse(valuta = Time.now, reference = @reference, amount = @amount)
       @journal.transfer(
-        @amount,
+        amount,
         @to,
         @from,
         reference,

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: acts_as_account
 version: !ruby/object:Gem::Version 
-  hash: 17
+  hash: 25
   prerelease: false
   segments: 
   - 1
   - 1
-  - 1
-  version: 1.1.1
+  - 5
+  version: 1.1.5
 platform: ruby
 authors: 
 - Thies C. Arntzen, Norman Timmler, Matthias Frick, Phillip Oertel
@@ -15,10 +15,51 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-12 00:00:00 +01:00
+date: 2010-11-15 00:00:00 +01:00
 default_executable: 
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: actionpack
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: database_cleaner
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
 description: acts_as_account implements double entry accounting for Rails models. Your models get accounts and you can do consistent transactions between them. Since the documentation is sparse, see the transfer.feature for usage examples.
 email: thieso@gmail.com
 executables: []
@@ -26,17 +67,17 @@ executables: []
 extensions: []
 
 extra_rdoc_files: 
+- LICENSE
 - README.rdoc
 files: 
 - .specification
-- MIT-LICENSE
+- LICENSE
 - README.rdoc
 - Rakefile
 - VERSION
 - cucumber.yml
 - db/database.yml
 - db/schema.rb
-- env.sh
 - features/account/account_creation.feature
 - features/step_definitions/account_steps.rb
 - features/support/cheque.rb
@@ -50,6 +91,7 @@ files:
 - lib/acts_as_account/active_record_extensions.rb
 - lib/acts_as_account/global_account.rb
 - lib/acts_as_account/journal.rb
+- lib/acts_as_account/manually_created_account.rb
 - lib/acts_as_account/posting.rb
 - lib/acts_as_account/transfer.rb
 has_rdoc: true

data/env.sh

@@ -1 +0,0 @@
-rvm use ruby-1.8.6-p399@rails235