acts_as_account 3.2.3 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6c6d94c77b41055a293cb92db325121dd8e40a9de54004ba017fd20bc301b243
-  data.tar.gz: '0582774b247afe230b9036f47fcea99d346f56993174fa9d4eac36e4ec817893'
+  metadata.gz: c148f57665d7973143472d6c9bf4d68098a136680e5f5f059d9432d5df3b74a0
+  data.tar.gz: f26b227813ab4a345d6d32944970e0b1817f636109bcaed4983e8f5554e788ab
 SHA512:
-  metadata.gz: a41ef812cff3dfeca6b723ae5367baa3af018687e3316b03b6a39ad76bcd1d1dbf3a92e0f9efdf863c4f41930c41e518dbf0c4909357b780829673da72c330d7
-  data.tar.gz: f9ad1dc779fa5fd623491d9267465a486ee6bc03ece7839f0dd9c6a88d5b05574249278a3e2fe8776c01180c441451194d7e3b6b33070d24473a6a10c077ca3d
+  metadata.gz: c579701e9a1bc66524633e003a19b091fa80ca329906c70dc9c38f6e05d4f0e11bb148c7189135de0c9fe3336affdc99d68fc9b5847869939ffb58d5e2a2344b
+  data.tar.gz: ca9b0f706088c6bebb3cccfb6703645aa25edb0ec47b48be8196fbd2763dc231e7db3ae5dfc5ebb0dd03ff56db22a1dbabd8be92c6dfab49944577035ac6a47e

data/.github/workflows/lint.yml

@@ -13,7 +13,7 @@ jobs:
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:
-        ruby-version: 2.7
+        ruby-version: 3.3
     - name: Cache gems
       uses: actions/cache@v1
       with:

data/.github/workflows/tests.yml

@@ -8,7 +8,7 @@ jobs:
 
     strategy:
       matrix:
-        ruby: [ '2.7', 'ruby-head' ]
+        ruby: [ '3.3', 'ruby-head' ]
 
     steps:
       - uses: actions/checkout@v2

data/README.md

@@ -15,6 +15,18 @@ tables is needed.
 We also hook into the ActionController request cycle to warn the developer
 if a request has left uncommitted changes in the system.
 
+## Configuration
+
+It is possible to configure if attributes (postings_count, balance, last_valuta) are persisted on the Account or if it is calculated on demand.
+```
+  ActsAsAccount.configure do |config|
+    # Default values:
+    # config.persist_attributes_on_account = true
+  end
+```
+Enabling persistence means that the sending and receiving account will aquire a lock when making a transfer to ensure correct data. This can be problematic in a high load scenario where many transfers to the same accounts are processed in parallel.
+
+
 ## How to test
 
 Run the cucumber features from the acs_as_account gem, just execute
@@ -23,7 +35,7 @@ Run the cucumber features from the acs_as_account gem, just execute
 
 ## How to release
 
-You need to update the data in `VERSION` and Rakefile and run `rake` (because it uses Gemhadar).
+You need to update the data in `VERSION` and Rakefile and run `rake` (because it uses GemHadar).
 `rake gem:push` will push the version to rubygems.
 
 ## Links

data/Rakefile

@@ -18,11 +18,11 @@ GemHadar do
 
   dependency 'activerecord',         '>= 5.1', '<8'
   dependency 'actionpack'  ,         '>= 4.1', '<8'
-  development_dependency 'cucumber', '~> 1.3'
+  development_dependency 'cucumber'
   development_dependency 'sqlite3'
-  development_dependency 'rspec',    '~> 3.1'
+  development_dependency 'rspec'
   development_dependency 'simplecov'
-  development_dependency 'database_cleaner',     '~> 1.3'
+  development_dependency 'database_cleaner'
   development_dependency 'rubocop'
 end
 
@@ -30,7 +30,7 @@ def connect_database
   require 'active_record'
   require 'yaml'
   db_config = YAML.load_file('features/db/database.yml')
-  ActiveRecord::Base.establish_connection(db_config).connection
+  ActiveRecord::Base.establish_connection(db_config).lease_connection
 end
 
 namespace :features do

data/VERSION

@@ -1 +1 @@
-3.2.3
+3.3.0

data/acts_as_account.gemspec

@@ -1,47 +1,33 @@
 # -*- encoding: utf-8 -*-
-# stub: acts_as_account 3.2.3 ruby lib
+# stub: acts_as_account 3.3.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "acts_as_account".freeze
-  s.version = "3.2.3"
+  s.version = "3.3.0".freeze
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
   s.authors = ["Thies C. Arntzen, Norman Timmler, Matthias Frick, Phillip Oertel".freeze]
-  s.date = "2022-07-20"
+  s.date = "2024-10-23"
   s.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.".freeze
   s.email = "developers@betterplace.org".freeze
-  s.extra_rdoc_files = ["README.md".freeze, "lib/acts_as_account.rb".freeze, "lib/acts_as_account/account.rb".freeze, "lib/acts_as_account/active_record_extensions.rb".freeze, "lib/acts_as_account/global_account.rb".freeze, "lib/acts_as_account/journal.rb".freeze, "lib/acts_as_account/manually_created_account.rb".freeze, "lib/acts_as_account/posting.rb".freeze, "lib/acts_as_account/rails.rb".freeze, "lib/acts_as_account/transfer.rb".freeze, "lib/acts_as_account/version.rb".freeze]
-  s.files = [".github/workflows/lint.yml".freeze, ".github/workflows/tests.yml".freeze, ".gitignore".freeze, ".rubocop.yml".freeze, "CHANGELOG.md".freeze, "Gemfile".freeze, "LICENSE".freeze, "README.md".freeze, "Rakefile".freeze, "VERSION".freeze, "acts_as_account.gemspec".freeze, "acts_as_account.sqlite".freeze, "cucumber.yml".freeze, "features/account/account_creation.feature".freeze, "features/db/database.yml".freeze, "features/db/schema.rb".freeze, "features/step_definitions/account_steps.rb".freeze, "features/support/abstract_user.rb".freeze, "features/support/cheque.rb".freeze, "features/support/env.rb".freeze, "features/support/inheriting_user.rb".freeze, "features/support/user.rb".freeze, "features/transfer/journal_creation.feature".freeze, "features/transfer/transfer.feature".freeze, "init.rb".freeze, "lib/acts_as_account.rb".freeze, "lib/acts_as_account/account.rb".freeze, "lib/acts_as_account/active_record_extensions.rb".freeze, "lib/acts_as_account/global_account.rb".freeze, "lib/acts_as_account/journal.rb".freeze, "lib/acts_as_account/manually_created_account.rb".freeze, "lib/acts_as_account/posting.rb".freeze, "lib/acts_as_account/rails.rb".freeze, "lib/acts_as_account/transfer.rb".freeze, "lib/acts_as_account/version.rb".freeze]
+  s.extra_rdoc_files = ["README.md".freeze, "lib/acts_as_account.rb".freeze, "lib/acts_as_account/account.rb".freeze, "lib/acts_as_account/active_record_extensions.rb".freeze, "lib/acts_as_account/configuration.rb".freeze, "lib/acts_as_account/global_account.rb".freeze, "lib/acts_as_account/journal.rb".freeze, "lib/acts_as_account/manually_created_account.rb".freeze, "lib/acts_as_account/posting.rb".freeze, "lib/acts_as_account/rails.rb".freeze, "lib/acts_as_account/transfer.rb".freeze, "lib/acts_as_account/version.rb".freeze]
+  s.files = [".github/workflows/lint.yml".freeze, ".github/workflows/tests.yml".freeze, ".gitignore".freeze, ".rubocop.yml".freeze, "CHANGELOG.md".freeze, "Gemfile".freeze, "LICENSE".freeze, "README.md".freeze, "Rakefile".freeze, "VERSION".freeze, "acts_as_account.gemspec".freeze, "acts_as_account.sqlite".freeze, "cucumber.yml".freeze, "features/account/account_creation.feature".freeze, "features/db/database.yml".freeze, "features/db/schema.rb".freeze, "features/step_definitions/account_steps.rb".freeze, "features/support/abstract_user.rb".freeze, "features/support/cheque.rb".freeze, "features/support/env.rb".freeze, "features/support/inheriting_user.rb".freeze, "features/support/user.rb".freeze, "features/transfer/journal_creation.feature".freeze, "features/transfer/transfer.feature".freeze, "init.rb".freeze, "lib/acts_as_account.rb".freeze, "lib/acts_as_account/account.rb".freeze, "lib/acts_as_account/active_record_extensions.rb".freeze, "lib/acts_as_account/configuration.rb".freeze, "lib/acts_as_account/global_account.rb".freeze, "lib/acts_as_account/journal.rb".freeze, "lib/acts_as_account/manually_created_account.rb".freeze, "lib/acts_as_account/posting.rb".freeze, "lib/acts_as_account/rails.rb".freeze, "lib/acts_as_account/transfer.rb".freeze, "lib/acts_as_account/version.rb".freeze]
   s.homepage = "https://github.com/betterplace/acts_as_account".freeze
   s.licenses = ["Apache-2.0".freeze]
   s.rdoc_options = ["--title".freeze, "ActsAsAccount -- More Math in Ruby".freeze, "--main".freeze, "README.md".freeze]
-  s.rubygems_version = "3.3.3".freeze
+  s.rubygems_version = "3.5.18".freeze
   s.summary = "acts_as_account implements double entry accounting for Rails models".freeze
 
-  if s.respond_to? :specification_version then
-    s.specification_version = 4
-  end
+  s.specification_version = 4
 
-  if s.respond_to? :add_runtime_dependency then
-    s.add_development_dependency(%q<gem_hadar>.freeze, ["~> 1.11.0"])
-    s.add_development_dependency(%q<cucumber>.freeze, ["~> 1.3"])
-    s.add_development_dependency(%q<sqlite3>.freeze, [">= 0"])
-    s.add_development_dependency(%q<rspec>.freeze, ["~> 3.1"])
-    s.add_development_dependency(%q<simplecov>.freeze, [">= 0"])
-    s.add_development_dependency(%q<database_cleaner>.freeze, ["~> 1.3"])
-    s.add_development_dependency(%q<rubocop>.freeze, [">= 0"])
-    s.add_runtime_dependency(%q<activerecord>.freeze, [">= 5.1", "< 8"])
-    s.add_runtime_dependency(%q<actionpack>.freeze, [">= 4.1", "< 8"])
-  else
-    s.add_dependency(%q<gem_hadar>.freeze, ["~> 1.11.0"])
-    s.add_dependency(%q<cucumber>.freeze, ["~> 1.3"])
-    s.add_dependency(%q<sqlite3>.freeze, [">= 0"])
-    s.add_dependency(%q<rspec>.freeze, ["~> 3.1"])
-    s.add_dependency(%q<simplecov>.freeze, [">= 0"])
-    s.add_dependency(%q<database_cleaner>.freeze, ["~> 1.3"])
-    s.add_dependency(%q<rubocop>.freeze, [">= 0"])
-    s.add_dependency(%q<activerecord>.freeze, [">= 5.1", "< 8"])
-    s.add_dependency(%q<actionpack>.freeze, [">= 4.1", "< 8"])
-  end
+  s.add_development_dependency(%q<gem_hadar>.freeze, ["~> 1.19".freeze])
+  s.add_development_dependency(%q<cucumber>.freeze, [">= 0".freeze])
+  s.add_development_dependency(%q<sqlite3>.freeze, [">= 0".freeze])
+  s.add_development_dependency(%q<rspec>.freeze, [">= 0".freeze])
+  s.add_development_dependency(%q<simplecov>.freeze, [">= 0".freeze])
+  s.add_development_dependency(%q<database_cleaner>.freeze, [">= 0".freeze])
+  s.add_development_dependency(%q<rubocop>.freeze, [">= 0".freeze])
+  s.add_runtime_dependency(%q<activerecord>.freeze, [">= 5.1".freeze, "< 8".freeze])
+  s.add_runtime_dependency(%q<actionpack>.freeze, [">= 4.1".freeze, "< 8".freeze])
 end

data/features/step_definitions/account_steps.rb

@@ -15,6 +15,10 @@ Given /^I create a user (\w+)$/ do |name|
   User.create!(:name => name)
 end
 
+Given /^I configure attribute persistence to be (\w+)$/ do |flag|
+  ActsAsAccount.configuration.persist_attributes_on_account = flag == 'true'
+end
+
 Given /^I have a user (\w+) that inherits from an abstract class$/ do |name|
   InheritingUser.create!(:name => name)
 end
@@ -67,9 +71,10 @@ Then /^the global (\w+) account balance is (-?\d+) €$/ do |name, balance|
 end
 
 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)
+  @from_account = User.find_by_name(from).account
+  @to_account = User.find_by_name(to).account
+  @previous_account_attributes = [@from_account.attributes, @to_account.attributes]
+  Journal.current.transfer(amount.to_i, @from_account, @to_account, @reference, @valuta)
 end
 
 When /^I transfer (\d+) € from global (\w+) account to global (\w+) account$/ do |amount, from, to|
@@ -172,3 +177,12 @@ end
 When /^I call 'account' on both it should be possible$/ do
   [@user1, @user2].each { |user| user.account }
 end
+
+Then('there are no changes to the accounts') do
+  @previous_account_attributes.should eq [@from_account.reload.attributes, @to_account.reload.attributes]
+end
+
+Then('the balance field changed on the accounts') do
+  @from_account.reload.read_attribute(:balance).should_not eq @previous_account_attributes.first['balance']
+  @to_account.reload.read_attribute(:balance).should_not eq @previous_account_attributes.last['balance']
+end

data/features/support/env.rb

@@ -24,3 +24,10 @@ require_relative 'cheque'
 After do
   ActsAsAccount::Journal.clear_current
 end
+
+Before do
+  ActsAsAccount.configure do |config|
+    # Default values:
+    # config.persist_attributes_on_account = true
+  end
+end

data/features/transfer/transfer.feature

@@ -3,14 +3,26 @@ Feature: Transfer
   As a Bank
   I want not to loose money
 
-  Scenario: I transfer money between accounts having holders
+  Scenario: I transfer money between accounts having holders with attribute persistence set to true
     Given I create a user Thies
     Given I create a user Norman
+    Given I configure attribute persistence to be true
     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
-    
+    And the balance field changed on the accounts
+
+  Scenario: I transfer money between accounts having holders with attribute persistence set to false
+    Given I create a user Thies
+    Given I create a user Norman
+    Given I configure attribute persistence to be false
+    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
+    And there are no changes to the accounts
+
   Scenario: I transfer a negative amount between accounts having holders
     Given I create a user Thies
     Given I create a user Norman
@@ -41,4 +53,4 @@ Feature: Transfer
     When I transfer 50 € from Thies's account to Norman's account and specify 22.05.1968 07:45 as the booking time
     Then Thies's account balance is -50 €
     And Norman's account balance is 50 €
-    And all postings have 22.05.1968 07:45 as the booking time
+    And all postings have 22.05.1968 07:45 as the booking time

data/lib/acts_as_account/account.rb

@@ -6,20 +6,16 @@ module ActsAsAccount
     has_many :postings, :class_name => 'ActsAsAccount::Posting'
     has_many :journals, :through => :postings
 
-    # TODO: discuss with norman:
-    # validates_presence_of will force an ActiveRecord::find on the object
-    # but we have to create accounts for deleted holder!
-    #
-    # validates_presence_of :holder
-
     class << self
       def recalculate_all_balances
+        warn "[DEPRECATION] `recalculate_all_balances` is deprecated and will be removed in a future version. Please use `recalculate_attributes` instead."
+
+        recalculate_attributes
+      end
+
+      def recalculate_attributes
         find_each do |account|
-          account.update_columns(
-            balance:        account.postings.sum(:amount),
-            postings_count: account.postings.count,
-            last_valuta:    account.postings.maximum(:valuta)
-          )
+          account.recalculate_attributes
         end
       end
 
@@ -67,6 +63,40 @@ module ActsAsAccount
       end
     end
 
+    def balance
+      if ActsAsAccount.configuration.persist_attributes_on_account
+        super
+      else
+        postings.sum(:amount)
+      end
+    end
+
+    def postings_count
+      if ActsAsAccount.configuration.persist_attributes_on_account
+        super
+      else
+        postings.count
+      end
+    end
+
+    def last_valuta
+      if ActsAsAccount.configuration.persist_attributes_on_account
+        super
+      else
+        postings.maximum(:valuta)
+      end
+    end
+
+    def recalculate_attributes
+      return unless ActsAsAccount.configuration.persist_attributes_on_account
+
+      update_columns(
+        last_valuta:    postings.maximum(:valuta),
+        balance:        postings.sum(:amount),
+        postings_count: postings.count
+      )
+    end
+
     def deleteable?
       postings.empty? && journals.empty?
     end

data/lib/acts_as_account/active_record_extensions.rb

@@ -10,7 +10,6 @@ module ActsAsAccount
     end
 
     module ClassMethods
-
       def has_account(name = :default)
         has_one :"#{name}_account", -> { where name: name }, class_name: "ActsAsAccount::Account", as: :holder
 

data/lib/acts_as_account/configuration.rb

@@ -0,0 +1,10 @@
+module ActsAsAccount
+  class Configuration
+    attr_accessor :persist_attributes_on_account
+
+    def initialize
+      # default values
+      @persist_attributes_on_account = true
+    end
+  end
+end

data/lib/acts_as_account/global_account.rb

@@ -1,7 +1,12 @@
 module ActsAsAccount
+  # A named account that is "global" (not tied to any specific entity
+  # in your database otherwise).
+  #
+  # This is useful for accounts that you don't want to model anything
+  # for via an ActiveRecord model (like "Cash").
   class GlobalAccount < ActiveRecord::Base
     self.table_name = :acts_as_account_global_accounts
 
     has_account
   end
-end
+end

data/lib/acts_as_account/journal.rb

@@ -36,7 +36,7 @@ module ActsAsAccount
 
         # 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!)
+        [from_account, to_account].sort_by(&:id).map(&:lock!) if ActsAsAccount.configuration.persist_attributes_on_account
 
         add_posting(-amount,  from_account,   to_account, reference, valuta)
         add_posting( amount,    to_account, from_account, reference, valuta)
@@ -53,10 +53,15 @@ module ActsAsAccount
           :reference => reference,
           :valuta => valuta)
 
-        account.class.update_counters account.id, :postings_count => 1, :balance => posting.amount
+        update_attributes_on(account, posting)
 
         posting.save(:validate => false)
-        account.save(:validate => false)
+      end
+
+      def update_attributes_on(account, posting)
+        return unless ActsAsAccount.configuration.persist_attributes_on_account
+
+        account.class.update_counters account.id, postings_count: 1, balance: posting.amount
       end
   end
 end

data/lib/acts_as_account/version.rb

@@ -1,6 +1,6 @@
 module ActsAsAccount
   # ActsAsAccount version
-  VERSION         = '3.2.3'
+  VERSION         = '3.3.0'
   VERSION_ARRAY   = VERSION.split('.').map(&:to_i) # :nodoc:
   VERSION_MAJOR   = VERSION_ARRAY[0] # :nodoc:
   VERSION_MINOR   = VERSION_ARRAY[1] # :nodoc:

data/lib/acts_as_account.rb

@@ -1,7 +1,16 @@
 require 'active_record'
 require 'action_controller'
+require 'acts_as_account/configuration'
 
 module ActsAsAccount
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
 end
 
 require 'acts_as_account/version'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: acts_as_account
 version: !ruby/object:Gem::Version
-  version: 3.2.3
+  version: 3.3.0
 platform: ruby
 authors:
 - Thies C. Arntzen, Norman Timmler, Matthias Frick, Phillip Oertel
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-07-20 00:00:00.000000000 Z
+date: 2024-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gem_hadar
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.11.0
+        version: '1.19'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.11.0
+        version: '1.19'
 - !ruby/object:Gem::Dependency
   name: cucumber
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -56,16 +56,16 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -84,16 +84,16 @@ dependencies:
   name: database_cleaner
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -159,6 +159,7 @@ extra_rdoc_files:
 - lib/acts_as_account.rb
 - lib/acts_as_account/account.rb
 - lib/acts_as_account/active_record_extensions.rb
+- lib/acts_as_account/configuration.rb
 - lib/acts_as_account/global_account.rb
 - lib/acts_as_account/journal.rb
 - lib/acts_as_account/manually_created_account.rb
@@ -195,6 +196,7 @@ files:
 - lib/acts_as_account.rb
 - lib/acts_as_account/account.rb
 - lib/acts_as_account/active_record_extensions.rb
+- lib/acts_as_account/configuration.rb
 - lib/acts_as_account/global_account.rb
 - lib/acts_as_account/journal.rb
 - lib/acts_as_account/manually_created_account.rb
@@ -225,7 +227,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.5.18
 signing_key:
 specification_version: 4
 summary: acts_as_account implements double entry accounting for Rails models