double_entry 2.0.0.beta4 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2c695b54b7cec66c99e9e6e62e0452883412b2a73596d5ea6deae695d48403f7
-  data.tar.gz: e12facb9d3741e7d461788534826c93f0827fd08f90898d831ea0777879d9204
+  metadata.gz: 496d452f002312016c033d18ba23257b677a07072fdea0d5dfc85f77563a3cc3
+  data.tar.gz: a53729a0facc3b920c70c87050cacd93743cea8f2895974fbddbd32925126807
 SHA512:
-  metadata.gz: f99f15db2934b0f5ca49f640a1373aefef4ca37fc62303afa440ff71c671783f586345149e681566cc9c27543c8f6c4979921ea457ccd5e46c68f3d20363d010
-  data.tar.gz: 215d09cbc9a0aafdd1fa6ebb518a0a86aea0ea8c757afe528126dbb95e0772ade2edb8948ddfa46445258102a12f09b41f81192f96495e26dbade111cab3ef01
+  metadata.gz: 626f6ee8bc46253bec15f21ef9a619d894fc5748dca7aa2a07518032777f0c2313889393f7d8d31f974bdd11c26aa309b329f816e1648915978131e228a9d740
+  data.tar.gz: bf503a7c96e23fcde06a04fc64e38799341a60be9c73443eda3d3ffe2583191f33e3ddfb61acb349e4062b1ae568784a49a0d3bbb54c1efce70ccc966057e395

data/CHANGELOG.md

@@ -7,7 +7,51 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
-[Unreleased]: https://github.com/envato/double_entry/compare/v2.0.0.beta4...HEAD
+[Unreleased]: https://github.com/envato/double_entry/compare/v2.0.0...HEAD
+
+## [2.0.0] - 2023-10-25
+
+### Fixed
+
+- Ensure LineCheck and AccountFixer can work correctly with unscoped accounts ([#207]).
+- Fixes for running on Ruby 3 ([#212]).
+
+### Changed
+
+- Return `[credit, debit]` from `DoubleEntry.transfer` ([#190]).
+- Run the test suite against Rails 6.1, 7.0, 7.1, and Ruby 3.1, 3.2 ([#203], [#214], [#217]).
+- Migrate CI to run on GitHub Actions ([#205])
+
+### Removed
+
+- Removed support for Rails < 6.1, and Ruby < 3.0 ([#215], [#217]).
+
+### Added
+
+- Add `credit` and `debit` scopes to the `Line` model ([#192]).
+
+[2.0.0]: https://github.com/envato/double_entry/compare/v2.0.0.beta5...v2.0.0
+[#190]: https://github.com/envato/double_entry/pull/190
+[#192]: https://github.com/envato/double_entry/pull/192
+[#203]: https://github.com/envato/double_entry/pull/203
+[#205]: https://github.com/envato/double_entry/pull/205
+[#207]: https://github.com/envato/double_entry/pull/207
+[#212]: https://github.com/envato/double_entry/pull/212
+[#214]: https://github.com/envato/double_entry/pull/214
+[#215]: https://github.com/envato/double_entry/pull/215
+[#217]: https://github.com/envato/double_entry/pull/217
+
+## [2.0.0.beta5] - 2021-02-24
+
+### Changed
+
+- Use the Ruby 1.9 hash syntax ([#182]).
+- Make the Line detail association optional ([#184]).
+- Support Ruby 3 ([#196]).
+
+[#182]: https://github.com/envato/double_entry/pull/182
+[#184]: https://github.com/envato/double_entry/pull/184
+[#196]: https://github.com/envato/double_entry/pull/196
 
 ## [2.0.0.beta4] - 2020-01-25
 
@@ -25,7 +69,6 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 - Prevent using Ruby 2.2 via restrictions in Gemfile and Gemspec ([#175]).
 
-[2.0.0.beta4]: https://github.com/envato/double_entry/compare/v2.0.0.beta3...v2.0.0.beta4
 [#175]: https://github.com/envato/double_entry/pull/175
 [#176]: https://github.com/envato/double_entry/pull/176
 [#178]: https://github.com/envato/double_entry/pull/178
@@ -462,6 +505,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 - Library released as Open Source!
 
+[2.0.0.beta5]: https://github.com/envato/double_entry/compare/v2.0.0.beta4...v2.0.0.beta5
+[2.0.0.beta4]: https://github.com/envato/double_entry/compare/v2.0.0.beta3...v2.0.0.beta4
 [2.0.0.beta3]: https://github.com/envato/double_entry/compare/v2.0.0.beta2...v2.0.0.beta3
 [2.0.0.beta2]: https://github.com/envato/double_entry/compare/v2.0.0.beta1...v2.0.0.beta2
 [2.0.0.beta1]: https://github.com/envato/double_entry/compare/v1.0.1...v2.0.0.beta1

data/README.md

@@ -3,7 +3,7 @@
 
 [![License MIT](https://img.shields.io/badge/license-MIT-brightgreen.svg)](https://github.com/envato/double_entry/blob/master/LICENSE.md)
 [![Gem Version](https://badge.fury.io/rb/double_entry.svg)](http://badge.fury.io/rb/double_entry)
-[![Build Status](https://travis-ci.org/envato/double_entry.svg?branch=master)](https://travis-ci.org/envato/double_entry)
+[![Build Status](https://github.com/envato/double_entry/actions/workflows/ci-workflow.yml/badge.svg)](https://github.com/envato/double_entry/actions/workflows/ci-workflow.yml)
 [![Code Climate](https://codeclimate.com/github/envato/double_entry/badges/gpa.svg)](https://codeclimate.com/github/envato/double_entry)
 
 ![Show me the Money](http://24.media.tumblr.com/tumblr_m3bwbqNJIG1rrgbmqo1_500.gif)
@@ -13,7 +13,7 @@ Keep track of all the monies!
 DoubleEntry is an accounting system based on the principles of a
 [Double-entry Bookkeeping](http://en.wikipedia.org/wiki/Double-entry_bookkeeping_system)
 system.  While this gem acts like a double-entry bookkeeping system, as it creates
-two entries in the database for each transfer, it does *not* enforce accounting rules.
+two entries in the database for each transfer, it does *not* enforce accounting rules, other than optionally ensuring a balance is positive, and through an allowlist of approved transfers. 
 
 DoubleEntry uses the [Money gem](https://github.com/RubyMoney/money) to encapsulate operations on currency values.
 
@@ -22,18 +22,15 @@ DoubleEntry uses the [Money gem](https://github.com/RubyMoney/money) to encapsul
 DoubleEntry is tested against:
 
 Ruby
- * 2.3.x
- * 2.4.x
- * 2.5.x
- * 2.6.x
  * 2.7.x
+ * 3.0.x
+ * 3.1.x
+ * 3.2.x
 
 Rails
- * 4.2.x
- * 5.0.x
- * 5.1.x
- * 5.2.x
  * 6.0.x
+ * 6.1.x
+ * 7.0.x
 
 Databases
  * MySQL
@@ -72,7 +69,7 @@ rake db:migrate
 ## Interface
 
 The entire API for recording financial transactions is available through a few
-methods in the **DoubleEntry** module. For full details on
+methods in the [DoubleEntry](lib/double_entry.rb) module. For full details on
 what the API provides, please view the documentation on these methods.
 
 A configuration file should be used to define a set of accounts, and potential
@@ -93,12 +90,12 @@ than scoped accounts due to lock contention.
 To get a particular account:
 
 ```ruby
-account = DoubleEntry.account(:spending, :scope => user)
+account = DoubleEntry.account(:spending, scope: user)
 ```
 
 (This actually returns an Account::Instance object.)
 
-See **DoubleEntry::Account** for more info.
+See [DoubleEntry::Account](lib/double_entry/account.rb) for more info.
 
 
 ### Balances
@@ -119,15 +116,15 @@ To transfer money between accounts:
 ```ruby
 DoubleEntry.transfer(
   Money.new(20_00),
-  :from => one_account,
-  :to   => another_account,
-  :code => :a_business_code_for_this_type_of_transfer,
+  from: one_account,
+  to:   another_account,
+  code: :a_business_code_for_this_type_of_transfer,
 )
 ```
 
 The possible transfers, and their codes, should be defined in the configuration.
 
-See **DoubleEntry::Transfer** for more info.
+See [DoubleEntry::Transfer](lib/double_entry/transfer.rb) for more info.
 
 ### Metadata
 
@@ -136,10 +133,10 @@ You may associate arbitrary metadata with transfers, for example:
 ```ruby
 DoubleEntry.transfer(
   Money.new(20_00),
-  :from => one_account,
-  :to   => another_account,
-  :code => :a_business_code_for_this_type_of_transfer,
-  :metadata => {:key1 => ['value 1', 'value 2'], :key2 => 'value 3'},
+  from: one_account,
+  to:   another_account,
+  code: :a_business_code_for_this_type_of_transfer,
+  metadata: {key1: ['value 1', 'value 2'], key2: 'value 3'},
 )
 ```
 
@@ -152,7 +149,7 @@ manually lock the accounts you're using:
 ```ruby
 DoubleEntry.lock_accounts(account_a, account_b) do
   # Perhaps transfer some money
-  DoubleEntry.transfer(Money.new(20_00), :from => account_a, :to => account_b, :code => :purchase)
+  DoubleEntry.transfer(Money.new(20_00), from: account_a, to: account_b, code: :purchase)
   # Perform other tasks that should be commited atomically with the transfer of funds...
 end
 ```
@@ -160,8 +157,31 @@ end
 The lock_accounts call generates a database transaction, which must be the
 outermost transaction.
 
-See **DoubleEntry::Locking** for more info.
+See [DoubleEntry::Locking](lib/double_entry/locking.rb) for more info.
 
+### Account Checker/Fixer
+
+DoubleEntry tries really hard to make sure that stored account balances reflect the running balances from the `double_entry_lines` table, but there is always the unlikely possibility that something will go wrong and the calculated balance might get out of sync with the actual running balance of the lines.
+
+DoubleEntry therefore provides a couple of tools to give you some confidence that things are working as expected.
+
+The `DoubleEntry::Validation::LineCheck` will check the `double_entry_lines` table to make sure that the `balance` column correctly reflects the calculated running balance, and that the `double_entry_account_balances` table has the correct value in the `balance` column. If either one of these turn out to be incorrect then it will write an entry into the `double_entry_line_checks` table reporting on the differences.
+
+You can alternatively pass a `fixer` to the `DoubleEntry::Validation::LineCheck.perform` method which will try and correct the balances. This gem provides the `DoubleEntry::Validation::AccountFixer` class which will correct the balance if it's out of sync.
+
+Using these classes is optional and both are provided for additional safety checks. If you want to make use of them then it's recommended to run them in a scheduled job, somewhere on the order of hourly to daily, depending on transaction volume. Keep in mind that this process locks accounts as it inspects their balances, so it will prevent new transactions from being written for a short time.
+
+Here are examples that could go in your scheduled job, depending on your needs:
+
+```ruby
+# Check all accounts & write the results to the double_entry_line_checks table
+DoubleEntry::Validation::LineCheck.perform!
+
+# Check & fix accounts (results will also be written to the table)
+DoubleEntry::Validation::LineCheck.perform!(fixer: DoubleEntry::Validation::AccountFixer.new)
+```
+
+See [DoubleEntry::Validation](lib/double_entry/validation) for more info.
 
 ## Implementation
 
@@ -173,7 +193,7 @@ Lines table entries also store the running balance for the account. To retrieve
 the current balance for an account, we find the most recent lines table entry
 for it.
 
-See **DoubleEntry::Line** for more info.
+See [DoubleEntry::Line](lib/double_entry/line.rb) for more info.
 
 AccountBalance records cache the current balance for each Account, and are used
 to perform database level locking.
@@ -206,13 +226,13 @@ DoubleEntry.configure do |config|
       raise 'not a User' unless user.class.name == 'User'
       user.id
     end
-    accounts.define(:identifier => :savings,  :scope_identifier => user_scope, :positive_only => true)
-    accounts.define(:identifier => :checking, :scope_identifier => user_scope)
+    accounts.define(identifier: :savings,  scope_identifier: user_scope, positive_only: true)
+    accounts.define(identifier: :checking, scope_identifier: user_scope)
   end
 
   config.define_transfers do |transfers|
-    transfers.define(:from => :checking, :to => :savings,  :code => :deposit)
-    transfers.define(:from => :savings,  :to => :checking, :code => :withdraw)
+    transfers.define(from: :checking, to: :savings,  code: :deposit)
+    transfers.define(from: :savings,  to: :checking, code: :withdraw)
   end
 end
 ```
@@ -225,11 +245,25 @@ Transfers between accounts of different currencies are not allowed.
 ```ruby
 DoubleEntry.configure do |config|
   config.define_accounts do |accounts|
-    accounts.define(:identifier => :savings,  :scope_identifier => user_scope, :currency => 'AUD')
+    accounts.define(identifier: :savings,  scope_identifier: user_scope, currency: 'AUD')
   end
 end
 ```
 
+## Testing with RSpec
+
+Transfering money needs to be run as a top level transaction. This conflicts with RSpec's default behavior of creating a new transaction for every test, causing an exception of type `DoubleEntry::Locking::LockMustBeOutermostTransaction` to be raised. This behavior may be disabled by adding the following lines into your `rails_helper.rb`.
+
+```ruby
+RSpec.configure do |config|
+  # ...
+  # This first line should already be there. You will need to add the second one
+  config.use_transactional_fixtures = true
+  DoubleEntry::Locking.configuration.running_inside_transactional_fixtures = true
+  # ...
+end
+```
+
 ## Jackhammer
 
 Run a concurrency test on the code.
@@ -277,42 +311,56 @@ See the Github project [issues](https://github.com/envato/double_entry/issues).
 
 ## Development Environment Setup
 
-1. Clone this repo.
+We're using Docker to provide a convenient and consistent environment for
+executing tests during development. This allows engineers to quickly set up
+a productive development environment.
 
-    ```sh
-    git clone git@github.com:envato/double_entry.git && cd double_entry
-    ```
+Note: Most development files are mounted in the Docker container. This
+enables engineers to edit files in their favourite editor (on the host
+OS) and have the changes immediately available in the Docker container
+to be exercised.
+
+One exception to this is the RSpec configuration. Changes to these files will
+require a rebuild of the Docker image (step 2).
+
+Prerequisites:
 
-2. Run the included setup script to install the gem dependencies.
+* Docker
+* Docker Compose
+* Git
+
+1. Clone this repo.
 
     ```sh
-    ./script/setup.sh
+    git clone git@github.com:envato/double_entry.git && cd double_entry
     ```
 
-3. Install MySQL, PostgreSQL and SQLite. We run tests against all three databases.
-4. Create a database in MySQL.
+2. Build the Docker image we'll use to run tests
 
     ```sh
-    mysql -u root -e 'create database double_entry_test;'
+    docker-compose build --pull double_entry
     ```
 
-5. Create a database in PostgreSQL.
+3. Startup a container and attach a terminal. This will also start up a
+   MySQL and Postgres database.
 
     ```sh
-    psql -c 'create database double_entry_test;' -U postgres
+    docker-compose run --rm double_entry ash
     ```
 
-6. Specify how the tests should connect to the database
+4. Run the tests
 
     ```sh
-    cp spec/support/{database.example.yml,database.yml}
-    vim spec/support/database.yml
+    DB=mysql bundle exec rspec
+    DB=postgres bundle exec rspec
+    DB=sqlite bundle exec rspec
     ```
 
-7. Run the tests
+5. When finished, exit the container terminal and shut down the databases.
 
     ```sh
-    bundle exec rake
+    exit
+    docker-compose down
     ```
 
 ## Contributors

data/double_entry.gemspec

@@ -24,12 +24,12 @@ Gem::Specification.new do |gem|
     f.match(%r{^(?:double_entry.gemspec|README|LICENSE|CHANGELOG|lib/)})
   end
   gem.require_paths         = ['lib']
-  gem.required_ruby_version = '>= 2.3.0'
+  gem.required_ruby_version = '>= 3'
 
-  gem.add_dependency 'activerecord',          '>= 3.2.0'
-  gem.add_dependency 'activesupport',         '>= 3.2.0'
+  gem.add_dependency 'activerecord',          '>= 6.1.0'
+  gem.add_dependency 'activesupport',         '>= 6.1.0'
   gem.add_dependency 'money',                 '>= 6.0.0'
-  gem.add_dependency 'railties',              '>= 3.2.0'
+  gem.add_dependency 'railties',              '>= 6.1.0'
 
   gem.add_development_dependency 'mysql2'
   gem.add_development_dependency 'pg'

data/lib/active_record/locking_extensions.rb

@@ -18,7 +18,7 @@ module ActiveRecord
       yield
     rescue ActiveRecord::StatementInvalid => exception
       if exception.message =~ /deadlock/i || exception.message =~ /database is locked/i
-        ActiveSupport::Notifications.publish('deadlock_restart.double_entry', :exception => exception)
+        ActiveSupport::Notifications.publish('deadlock_restart.double_entry', exception: exception)
 
         raise ActiveRecord::RestartTransaction
       else
@@ -46,7 +46,7 @@ module ActiveRecord
       yield
     rescue ActiveRecord::StatementInvalid, ActiveRecord::RecordNotUnique => exception
       if  exception.message =~ /duplicate/i || exception.message =~ /ConstraintException/
-        ActiveSupport::Notifications.publish('duplicate_ignore.double_entry', :exception => exception)
+        ActiveSupport::Notifications.publish('duplicate_ignore.double_entry', exception: exception)
 
         # Just ignore it...someone else has already created the record.
       else
@@ -63,7 +63,7 @@ module ActiveRecord
       if exception.message =~ /deadlock/i || exception.message =~ /database is locked/i
         # Somebody else is in the midst of creating the record. We'd better
         # retry, so we ensure they're done before we move on.
-        ActiveSupport::Notifications.publish('deadlock_retry.double_entry', :exception => exception)
+        ActiveSupport::Notifications.publish('deadlock_retry.double_entry', exception: exception)
 
         retry
       else

data/lib/double_entry/account.rb

@@ -15,7 +15,7 @@ module DoubleEntry
       # @api private
       def account(identifier, options = {})
         account = accounts.find(identifier, (options[:scope].present? || options[:scope_identity].present?))
-        Instance.new(:account => account, :scope => options[:scope], :scope_identity => options[:scope_identity])
+        Instance.new(account: account, scope: options[:scope], scope_identity: options[:scope_identity])
       end
 
       # @api private
@@ -67,7 +67,7 @@ module DoubleEntry
 
     class Instance
       attr_reader :account, :scope
-      delegate :identifier, :scope_identifier, :scoped?, :positive_only, :negative_only, :currency, :to => :account
+      delegate :identifier, :scope_identifier, :scoped?, :positive_only, :negative_only, :currency, to: :account
 
       def initialize(args)
         @account = args[:account]

data/lib/double_entry/account_balance.rb

@@ -8,7 +8,7 @@ module DoubleEntry
   #
   # Account balances are created on demand when transfers occur.
   class AccountBalance < ActiveRecord::Base
-    delegate :currency, :to => :account
+    delegate :currency, to: :account
 
     def balance
       self[:balance] && Money.new(self[:balance], currency)
@@ -25,11 +25,11 @@ module DoubleEntry
     end
 
     def account
-      DoubleEntry.account(self[:account].to_sym, :scope_identity => self[:scope])
+      DoubleEntry.account(self[:account].to_sym, scope_identity: self[:scope])
     end
 
     def self.find_by_account(account, options = {})
-      scope = where(:scope => account.scope_identity, :account => account.identifier.to_s)
+      scope = where(scope: account.scope_identity, account: account.identifier.to_s)
       scope = scope.lock(true) if options[:lock]
       scope.first
     end

data/lib/double_entry/balance_calculator.rb

@@ -79,18 +79,18 @@ module DoubleEntry
     # @api private
     class RelationBuilder
       attr_reader :options
-      delegate :account, :scope, :scope?, :from, :to, :between?, :at, :at?, :codes, :code?, :to => :options
+      delegate :account, :scope, :scope?, :from, :to, :between?, :at, :at?, :codes, :code?, to: :options
 
       def initialize(options)
         @options = options
       end
 
       def build
-        lines = Line.where(:account => account)
+        lines = Line.where(account: account)
         lines = lines.where('created_at <= ?', at) if at?
-        lines = lines.where(:created_at => from..to) if between?
-        lines = lines.where(:code => codes) if code?
-        lines = lines.where(:scope => scope) if scope?
+        lines = lines.where(created_at: from..to) if between?
+        lines = lines.where(code: codes) if code?
+        lines = lines.where(scope: scope) if scope?
         lines
       end
     end

data/lib/double_entry/configuration.rb

@@ -16,7 +16,7 @@ module DoubleEntry
       :scope_identifier_max_length=,
       :account_identifier_max_length,
       :account_identifier_max_length=,
-      :to => 'DoubleEntry::Account',
+      to: 'DoubleEntry::Account',
     )
 
     delegate(
@@ -24,7 +24,7 @@ module DoubleEntry
       :transfers=,
       :code_max_length,
       :code_max_length=,
-      :to => 'DoubleEntry::Transfer',
+      to: 'DoubleEntry::Transfer',
     )
 
     def define_accounts

data/lib/double_entry/line.rb

@@ -55,8 +55,10 @@ module DoubleEntry
   # by account, or account and code, over a particular period.
   #
   class Line < ActiveRecord::Base
-    belongs_to :detail, :polymorphic => true
-    has_many :metadata, :class_name => 'DoubleEntry::LineMetadata' unless -> { DoubleEntry.config.json_metadata }
+    belongs_to :detail, polymorphic: true, required: false
+    has_many :metadata, class_name: 'DoubleEntry::LineMetadata' unless -> { DoubleEntry.config.json_metadata }
+    scope :credits, -> { where('amount > 0') }
+    scope :debits, -> { where('amount < 0') }
     scope :with_id_greater_than, ->(id) { where('id > ?', id) }
 
     def amount
@@ -75,12 +77,12 @@ module DoubleEntry
       self[:balance] = (money && money.fractional)
     end
 
-    def save(*)
+    def save(**)
       check_balance_will_remain_valid
       super
     end
 
-    def save!(*)
+    def save!(**)
       check_balance_will_remain_valid
       super
     end
@@ -102,7 +104,7 @@ module DoubleEntry
     end
 
     def account
-      DoubleEntry.account(self[:account].to_sym, :scope_identity => scope)
+      DoubleEntry.account(self[:account].to_sym, scope_identity: scope)
     end
 
     def currency
@@ -117,7 +119,7 @@ module DoubleEntry
     end
 
     def partner_account
-      DoubleEntry.account(self[:partner_account].to_sym, :scope_identity => partner_scope)
+      DoubleEntry.account(self[:partner_account].to_sym, scope_identity: partner_scope)
     end
 
     def partner

data/lib/double_entry/locking.rb

@@ -149,7 +149,7 @@ module DoubleEntry
       # If one or more account balance records don't exist, set
       # accounts_with_balances to the corresponding accounts, and return false.
       def grab_locks
-        account_balances = @accounts.map { |account| AccountBalance.find_by_account(account, :lock => true) }
+        account_balances = @accounts.map { |account| AccountBalance.find_by_account(account, lock: true) }
 
         if account_balances.any?(&:nil?)
           @accounts_without_balances =  @accounts.zip(account_balances).
@@ -168,7 +168,7 @@ module DoubleEntry
           # Get the initial balance from the lines table.
           balance = account.balance
           # Try to create the balance record, but ignore it if someone else has done it in the meantime.
-          AccountBalance.create_ignoring_duplicates!(:account => account, :balance => balance)
+          AccountBalance.create_ignoring_duplicates!(account: account, balance: balance)
         end
       end
     end

data/lib/double_entry/transfer.rb

@@ -76,6 +76,7 @@ module DoubleEntry
     end
 
     def process(amount, options)
+      credit = debit = nil
       from_account = options[:from]
       to_account = options[:to]
       code = options[:code]
@@ -91,6 +92,7 @@ module DoubleEntry
         credit, debit = create_lines(amount, code, detail, from_account, to_account, metadata)
         create_line_metadata(credit, debit, metadata) if metadata && !DoubleEntry.config.json_metadata
       end
+      [credit, debit]
     end
 
     def create_lines(amount, code, detail, from_account, to_account, metadata)
@@ -121,8 +123,8 @@ module DoubleEntry
     def create_line_metadata(credit, debit, metadata)
       metadata.each_pair do |key, value|
         Array(value).each do |each_value|
-          LineMetadata.create!(:line => credit, :key => key, :value => each_value)
-          LineMetadata.create!(:line => debit, :key => key, :value => each_value)
+          LineMetadata.create!(line: credit, key: key, value: each_value)
+          LineMetadata.create!(line: debit, key: key, value: each_value)
         end
       end
     end

data/lib/double_entry/validation/account_fixer.rb

@@ -23,7 +23,7 @@ module DoubleEntry
       def lines_for_account(account)
         Line.where(
           account: account.identifier.to_s,
-          scope: account.scope_identity.to_s
+          scope: account.scope_identity&.to_s
         ).order(:id)
       end
 

data/lib/double_entry/validation/line_check.rb

@@ -34,9 +34,9 @@ module DoubleEntry
 
         unless active_accounts.empty?
           LineCheck.create!(
-            :errors_found => incorrect_accounts.any?,
-            :last_line_id => current_line_id,
-            :log          => log,
+            errors_found: incorrect_accounts.any?,
+            last_line_id: current_line_id,
+            log:          log,
           )
         end
       end
@@ -48,34 +48,50 @@ module DoubleEntry
       end
 
       def running_balance_correct?(line, log)
-        # Another work around for the MySQL 5.1 query optimiser bug that causes the ORDER BY
-        # on the query to fail in some circumstances, resulting in an old balance being
-        # returned. This was biting us intermittently in spec runs.
-        # See http://bugs.mysql.com/bug.php?id=51431
-        force_index = if Line.connection.adapter_name.match(/mysql/i)
-                        'FORCE INDEX (lines_scope_account_id_idx)'
-                      else
-                        ''
-                      end
+        previous_line = find_previous_line(line.account.identifier.to_s, line.scope, line.id)
+
+        previous_balance = previous_line.length == 1 ? previous_line[0].balance : Money.zero(line.account.currency)
+
+        if line.balance != (line.amount + previous_balance)
+          log << line_error_message(line, previous_line, previous_balance)
+        end
+
+        line.balance == previous_balance + line.amount
+      end
 
+      def find_previous_line(identifier, scope, id)
         # yes, it needs to be find_by_sql, because any other find will be affected
         # by the find_each call in perform!
-        previous_line = Line.find_by_sql([<<-SQL, line.account.identifier.to_s, line.scope, line.id])
+
+        if scope.nil?
+          Line.find_by_sql([<<-SQL, identifier, id])
+            SELECT * FROM #{Line.quoted_table_name} #{force_index}
+            WHERE account = ?
+            AND scope IS NULL
+            AND id < ?
+            ORDER BY id DESC
+            LIMIT 1
+          SQL
+        else
+          Line.find_by_sql([<<-SQL, identifier, scope, id])
           SELECT * FROM #{Line.quoted_table_name} #{force_index}
           WHERE account = ?
           AND scope = ?
           AND id < ?
           ORDER BY id DESC
           LIMIT 1
-        SQL
-
-        previous_balance = previous_line.length == 1 ? previous_line[0].balance : Money.zero(line.account.currency)
-
-        if line.balance != (line.amount + previous_balance)
-          log << line_error_message(line, previous_line, previous_balance)
+          SQL
         end
+      end
 
-        line.balance == previous_balance + line.amount
+      def force_index
+        # Another work around for the MySQL 5.1 query optimiser bug that causes the ORDER BY
+        # on the query to fail in some circumstances, resulting in an old balance being
+        # returned. This was biting us intermittently in spec runs.
+        # See http://bugs.mysql.com/bug.php?id=51431
+        return '' unless Line.connection.adapter_name.match(/mysql/i)
+
+        'FORCE INDEX (lines_scope_account_id_idx)'
       end
 
       def line_error_message(line, previous_line, previous_balance)

data/lib/double_entry/version.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
 
 module DoubleEntry
-  VERSION = '2.0.0.beta4'
+  VERSION = '2.0.0'
 end

data/lib/double_entry.rb

@@ -64,11 +64,11 @@ module DoubleEntry
     # @example Transfer $20 from a user's checking to savings account
     #   checking_account = DoubleEntry.account(:checking, scope: user)
     #   savings_account  = DoubleEntry.account(:savings,  scope: user)
-    #   DoubleEntry.transfer(
+    #   credit, debit = DoubleEntry.transfer(
     #     20.dollars,
-    #     :from => checking_account,
-    #     :to   => savings_account,
-    #     :code => :save,
+    #     from: checking_account,
+    #     to:   savings_account,
+    #     code: :save,
     #   )
     # @param [Money] amount The quantity of money to transfer from one account
     #   to the other.
@@ -80,6 +80,7 @@ module DoubleEntry
     #   type of transfer. As specified in the transfer configuration.
     # @option options :detail [ActiveRecord::Base] ActiveRecord model
     #   associated (via a polymorphic association) with the transfer.
+    # @return [[Line, Line]] The credit & debit (in that order) created by the transfer
     # @raise [DoubleEntry::TransferIsNegative] The amount is less than zero.
     # @raise [DoubleEntry::TransferNotAllowed] A transfer between these
     #   accounts with the provided code is not allowed. Check configuration.
@@ -91,35 +92,35 @@ module DoubleEntry
     # Get the current or historic balance of an account.
     #
     # @example Obtain the current balance of my checking account
-    #   checking_account = DoubleEntry.account(:checking, :scope => user)
+    #   checking_account = DoubleEntry.account(:checking, scope: user)
     #   DoubleEntry.balance(checking_account)
     # @example Obtain the current balance of my checking account (without account or user model)
-    #   DoubleEntry.balance(:checking, :scope => user_id)
+    #   DoubleEntry.balance(:checking, scope: user_id)
     # @example Obtain a historic balance of my checking account
-    #   checking_account = DoubleEntry.account(:checking, :scope => user)
-    #   DoubleEntry.balance(checking_account, :at => Time.new(2012, 1, 1))
+    #   checking_account = DoubleEntry.account(:checking, scope: user)
+    #   DoubleEntry.balance(checking_account, at: Time.new(2012, 1, 1))
     # @example Obtain the net balance of my checking account during may
-    #   checking_account = DoubleEntry.account(:checking, :scope => user)
+    #   checking_account = DoubleEntry.account(:checking, scope: user)
     #   DoubleEntry.balance(
     #     checking_account,
-    #     :from => Time.new(2012, 5,  1,  0,  0,  0),
-    #     :to   => Time.new(2012, 5, 31, 23, 59, 59),
+    #     from: Time.new(2012, 5,  1,  0,  0,  0),
+    #     to:   Time.new(2012, 5, 31, 23, 59, 59),
     #   )
     # @example Obtain the balance of salary deposits made to my checking account during may
-    #   checking_account = DoubleEntry.account(:checking, :scope => user)
+    #   checking_account = DoubleEntry.account(:checking, scope: user)
     #   DoubleEntry.balance(
     #     checking_account,
-    #     :code => :salary,
-    #     :from => Time.new(2012, 5,  1,  0,  0,  0),
-    #     :to   => Time.new(2012, 5, 31, 23, 59, 59),
+    #     code: :salary,
+    #     from: Time.new(2012, 5,  1,  0,  0,  0),
+    #     to:   Time.new(2012, 5, 31, 23, 59, 59),
     #   )
     # @example Obtain the balance of salary & lottery deposits made to my checking account during may
-    #   checking_account = DoubleEntry.account(:checking, :scope => user)
+    #   checking_account = DoubleEntry.account(:checking, scope: user)
     #   DoubleEntry.balance(
     #     checking_account,
-    #     :codes => [ :salary, :lottery ],
-    #     :from  => Time.new(2012, 5,  1,  0,  0,  0),
-    #     :to    => Time.new(2012, 5, 31, 23, 59, 59),
+    #     codes: [ :salary, :lottery ],
+    #     from:  Time.new(2012, 5,  1,  0,  0,  0),
+    #     to:    Time.new(2012, 5, 31, 23, 59, 59),
     #   )
     # @param [DoubleEntry::Account:Instance, Symbol] account Find the balance
     #   for this account

data/lib/generators/double_entry/install/templates/initializer.rb

@@ -9,12 +9,12 @@ DoubleEntry.configure do |config|
   #     raise 'not a User' unless user.class.name == 'User'
   #     user.id
   #   end
-  #   accounts.define(:identifier => :savings,  :scope_identifier => user_scope, :positive_only => true)
-  #   accounts.define(:identifier => :checking, :scope_identifier => user_scope)
+  #   accounts.define(identifier: :savings,  scope_identifier: user_scope, positive_only: true)
+  #   accounts.define(identifier: :checking, scope_identifier: user_scope)
   # end
   #
   # config.define_transfers do |transfers|
-  #   transfers.define(:from => :checking, :to => :savings,  :code => :deposit)
-  #   transfers.define(:from => :savings,  :to => :checking, :code => :withdraw)
+  #   transfers.define(from: :checking, to: :savings,  code: :deposit)
+  #   transfers.define(from: :savings,  to: :checking, code: :withdraw)
   # end
 end

data/lib/generators/double_entry/install/templates/migration.rb

@@ -1,25 +1,25 @@
 class CreateDoubleEntryTables < ActiveRecord::Migration<%= migration_version %>
   def self.up
     create_table "double_entry_account_balances" do |t|
-      t.string     "account", :null => false
+      t.string     "account", null: false
       t.string     "scope"
-      t.bigint     "balance", :null => false
-      t.timestamps            :null => false
+      t.bigint     "balance", null: false
+      t.timestamps            null: false
     end
 
-    add_index "double_entry_account_balances", ["account"],          :name => "index_account_balances_on_account"
-    add_index "double_entry_account_balances", ["scope", "account"], :name => "index_account_balances_on_scope_and_account", :unique => true
+    add_index "double_entry_account_balances", ["account"],          name: "index_account_balances_on_account"
+    add_index "double_entry_account_balances", ["scope", "account"], name: "index_account_balances_on_scope_and_account", unique: true
 
     create_table "double_entry_lines" do |t|
-      t.string     "account",         :null => false
+      t.string     "account",         null: false
       t.string     "scope"
-      t.string     "code",            :null => false
-      t.bigint     "amount",          :null => false
-      t.bigint     "balance",         :null => false
-      t.references "partner",                         :index => false
-      t.string     "partner_account", :null => false
+      t.string     "code",            null: false
+      t.bigint     "amount",          null: false
+      t.bigint     "balance",         null: false
+      t.references "partner",                         index: false
+      t.string     "partner_account", null: false
       t.string     "partner_scope"
-      t.references "detail",                          :index => false, :polymorphic => true
+      t.references "detail",                          index: false, polymorphic: true
       <%- if json_metadata -%>
       if ActiveRecord::Base.connection.adapter_name == "PostgreSQL"
         t.jsonb "metadata"
@@ -27,32 +27,32 @@ class CreateDoubleEntryTables < ActiveRecord::Migration<%= migration_version %>
         t.json "metadata"
       end
       <%- end -%>
-      t.timestamps                    :null => false
+      t.timestamps                    null: false
     end
 
-    add_index "double_entry_lines", ["account", "code", "created_at"],  :name => "lines_account_code_created_at_idx"
-    add_index "double_entry_lines", ["account", "created_at"],          :name => "lines_account_created_at_idx"
-    add_index "double_entry_lines", ["scope", "account", "created_at"], :name => "lines_scope_account_created_at_idx"
-    add_index "double_entry_lines", ["scope", "account", "id"],         :name => "lines_scope_account_id_idx"
+    add_index "double_entry_lines", ["account", "code", "created_at"],  name: "lines_account_code_created_at_idx"
+    add_index "double_entry_lines", ["account", "created_at"],          name: "lines_account_created_at_idx"
+    add_index "double_entry_lines", ["scope", "account", "created_at"], name: "lines_scope_account_created_at_idx"
+    add_index "double_entry_lines", ["scope", "account", "id"],         name: "lines_scope_account_id_idx"
 
     create_table "double_entry_line_checks" do |t|
-      t.references "last_line",    :null => false, :index => false
-      t.boolean    "errors_found", :null => false
+      t.references "last_line",    null: false, index: false
+      t.boolean    "errors_found", null: false
       t.text       "log"
-      t.timestamps                 :null => false
+      t.timestamps                 null: false
     end
 
-    add_index "double_entry_line_checks", ["created_at", "last_line_id"], :name => "line_checks_created_at_last_line_id_idx"
+    add_index "double_entry_line_checks", ["created_at", "last_line_id"], name: "line_checks_created_at_last_line_id_idx"
     <%- unless json_metadata -%>
 
     create_table "double_entry_line_metadata" do |t|
-      t.references "line",    :null => false, :index => false
-      t.string     "key",     :null => false
-      t.string     "value",   :null => false
-      t.timestamps            :null => false
+      t.references "line",    null: false, index: false
+      t.string     "key",     null: false
+      t.string     "value",   null: false
+      t.timestamps            null: false
     end
 
-    add_index "double_entry_line_metadata", ["line_id", "key", "value"], :name => "lines_meta_line_id_key_value_idx"
+    add_index "double_entry_line_metadata", ["line_id", "key", "value"], name: "lines_meta_line_id_key_value_idx"
     <%- end -%>
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: double_entry
 version: !ruby/object:Gem::Version
-  version: 2.0.0.beta4
+  version: 2.0.0
 platform: ruby
 authors:
 - Envato
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-01-25 00:00:00.000000000 Z
+date: 2023-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: 6.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: 6.1.0
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: 6.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: 6.1.0
 - !ruby/object:Gem::Dependency
   name: money
   requirement: !ruby/object:Gem::Requirement
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: 6.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: 6.1.0
 - !ruby/object:Gem::Dependency
   name: mysql2
   requirement: !ruby/object:Gem::Requirement
@@ -220,7 +220,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - rubygems@envato.com
 executables: []
@@ -256,10 +256,10 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/envato/double_entry/issues
-  changelog_uri: https://github.com/envato/double_entry/blob/v2.0.0.beta4/CHANGELOG.md
-  documentation_uri: https://www.rubydoc.info/gems/double_entry/2.0.0.beta4
-  source_code_uri: https://github.com/envato/double_entry/tree/v2.0.0.beta4
-post_install_message: 
+  changelog_uri: https://github.com/envato/double_entry/blob/v2.0.0/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/gems/double_entry/2.0.0
+  source_code_uri: https://github.com/envato/double_entry/tree/v2.0.0
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -267,15 +267,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: '3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.4.21
+signing_key:
 specification_version: 4
 summary: Tools to build your double entry financial ledger
 test_files: []