double_entry 2.0.0.beta5 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3fac339d10077ee1c807e16d37f4aa6bd7ad4d6179f8f94b4ad114085e83b83a
-  data.tar.gz: 5f50033972098dfada8195c0bd17923005f2e0601ed1a694cf25c43080d2f939
+  metadata.gz: 496d452f002312016c033d18ba23257b677a07072fdea0d5dfc85f77563a3cc3
+  data.tar.gz: a53729a0facc3b920c70c87050cacd93743cea8f2895974fbddbd32925126807
 SHA512:
-  metadata.gz: 2fb0041f4cf1af34416a5af798d1b7b32675565f39f9f0abec80d40d1ad30159dc1fe716427a41a43c1c608f9b1cd8ff63c998ee2c974895a28c873ba0e7250e
-  data.tar.gz: 66be7ef0d59ca846b5c9c588d68dd72be1577c2ef03069fc93d148ec7bc821aaf265b66ae75ad1cece6649d1605412f41f3e81284ba2d29c513804f6484af368
+  metadata.gz: 626f6ee8bc46253bec15f21ef9a619d894fc5748dca7aa2a07518032777f0c2313889393f7d8d31f974bdd11c26aa309b329f816e1648915978131e228a9d740
+  data.tar.gz: bf503a7c96e23fcde06a04fc64e38799341a60be9c73443eda3d3ffe2583191f33e3ddfb61acb349e4062b1ae568784a49a0d3bbb54c1efce70ccc966057e395

data/CHANGELOG.md

@@ -7,7 +7,41 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
-## [2.0.0.beta5] - 2020-01-25
+[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
 
@@ -471,7 +505,6 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 - Library released as Open Source!
 
-[Unreleased]: https://github.com/envato/double_entry/compare/v2.0.0.beta5...HEAD
 [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

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
@@ -164,7 +161,15 @@ See [DoubleEntry::Locking](lib/double_entry/locking.rb) for more info.
 
 ### Account Checker/Fixer
 
-Although it's unlikely, DoubleEntry has tools for checking accounts to make sure they tie out, and optionally fixing them if there is a discrepancy. It's recommended to run this 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 have an prevent new transactions from being written for a short time.
+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:
 
@@ -245,6 +250,20 @@ DoubleEntry.configure do |config|
 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.

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/double_entry/line.rb

@@ -57,6 +57,8 @@ module DoubleEntry
   class Line < ActiveRecord::Base
     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

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)

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

@@ -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.beta5'
+  VERSION = '2.0.0'
 end

data/lib/double_entry.rb

@@ -64,7 +64,7 @@ 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,
@@ -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.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: double_entry
 version: !ruby/object:Gem::Version
-  version: 2.0.0.beta5
+  version: 2.0.0
 platform: ruby
 authors:
 - Envato
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-02-24 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.beta5/CHANGELOG.md
-  documentation_uri: https://www.rubydoc.info/gems/double_entry/2.0.0.beta5
-  source_code_uri: https://github.com/envato/double_entry/tree/v2.0.0.beta5
-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,16 +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: []
-rubyforge_project: 
-rubygems_version: 2.7.3
-signing_key: 
+rubygems_version: 3.4.21
+signing_key:
 specification_version: 4
 summary: Tools to build your double entry financial ledger
 test_files: []