double_entry 2.0.0.beta3 → 2.0.0.beta4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ffb580cc13853357b19e242cc229d5b0f1d1d98c6cd9ac5657215b090b969741
-  data.tar.gz: 3da2d603f8de4f7a52763bb84729ebfd14e6e1d46f092dae338432c0d87c795c
+  metadata.gz: 2c695b54b7cec66c99e9e6e62e0452883412b2a73596d5ea6deae695d48403f7
+  data.tar.gz: e12facb9d3741e7d461788534826c93f0827fd08f90898d831ea0777879d9204
 SHA512:
-  metadata.gz: 78ab72241164ae7ba887df3aeebfd8a4f18d73a6c2700f9f44dd2abb998320089cfe8547d4aea62211683aea9d4955a16f006a56e5803ab5de386891d1cfed4c
-  data.tar.gz: 625ddec747fd33cb464a285ce334cf05be94093cc9766d0e0277786bcc79f061bd0805baa3e6644566a1dc83d5209ff0a81ac06846170caa317a5d5f2cbb373b
+  metadata.gz: f99f15db2934b0f5ca49f640a1373aefef4ca37fc62303afa440ff71c671783f586345149e681566cc9c27543c8f6c4979921ea457ccd5e46c68f3d20363d010
+  data.tar.gz: 215d09cbc9a0aafdd1fa6ebb518a0a86aea0ea8c757afe528126dbb95e0772ade2edb8948ddfa46445258102a12f09b41f81192f96495e26dbade111cab3ef01

data/CHANGELOG.md

@@ -7,6 +7,31 @@ 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
+
+## [2.0.0.beta4] - 2020-01-25
+
+### Added
+
+- Test against Rails 6.0, ([#176]).
+
+- Support for Ruby 2.7 ([#180]).
+
+### Changed
+
+- Metadata stored by default in a json(b) column for new installs ([#178]).
+
+- Remove `force: true` from migration ([#181]).
+
+- 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
+[#180]: https://github.com/envato/double_entry/pull/180
+[#181]: https://github.com/envato/double_entry/pull/181
+
 ## [2.0.0.beta3] - 2019-11-14
 
 ### Fixed
@@ -437,7 +462,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.beta3...HEAD
 [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

@@ -26,12 +26,14 @@ Ruby
  * 2.4.x
  * 2.5.x
  * 2.6.x
+ * 2.7.x
 
 Rails
  * 4.2.x
  * 5.0.x
  * 5.1.x
  * 5.2.x
+ * 6.0.x
 
 Databases
  * MySQL
@@ -54,6 +56,8 @@ bundle
 
 Generate Rails schema migrations for the required tables:
 
+> The default behavior is to store metadata in a json(b) column rather than a separate `double_entry_line_metadata` table. If you would like the old (1.x) behavior, you can add `--no-json-metadata`.
+
 ```sh
 rails generate double_entry:install
 ```
@@ -174,8 +178,7 @@ See **DoubleEntry::Line** for more info.
 AccountBalance records cache the current balance for each Account, and are used
 to perform database level locking.
 
-Transfer metadata is stored as key/value pairs associated with both the source and destination lines of the transfer.
-See **DoubleEntry::LineMetadata** for more info.
+Transfer metadata is stored in a json(b) column on both the source and destination lines of the transfer.
 
 ## Configuration
 
@@ -183,7 +186,7 @@ A configuration file should be used to define a set of accounts, optional scopes
 the accounts, and permitted transfers between those accounts.
 
 The configuration file should be kept in your application's load path.  For example,
-*config/initializers/double_entry.rb*
+*config/initializers/double_entry.rb*. By default, this file will be created when you run the installer, but you will need to fill out your accounts.
 
 For example, the following specifies two accounts, savings and checking.
 Each account is scoped by User (where User is an object with an ID), meaning
@@ -195,6 +198,9 @@ This configuration also specifies that money can be transferred between the two
 require 'double_entry'
 
 DoubleEntry.configure do |config|
+  # Use json(b) column in double_entry_lines table to store metadata instead of separate metadata table
+  config.json_metadata = true
+
   config.define_accounts do |accounts|
     user_scope = ->(user) do
       raise 'not a User' unless user.class.name == 'User'
@@ -328,6 +334,7 @@ Many thanks to those who have contributed to both this gem, and the library upon
   * Rizal Muthi - @rizalmuthi
   * Ryan Allen - @ryan-allen
   * Samuel Cochran - @sj26
+  * Stefan Wrobel - @swrobel
   * Stephanie Staub - @stephnacios
   * Trung Lê - @joneslee85
   * Vahid Ta'eed - @vahid

data/double_entry.gemspec

@@ -24,7 +24,7 @@ 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.2.0'
+  gem.required_ruby_version = '>= 2.3.0'
 
   gem.add_dependency 'activerecord',          '>= 3.2.0'
   gem.add_dependency 'activesupport',         '>= 3.2.0'

data/lib/double_entry.rb

@@ -4,6 +4,7 @@ require 'active_record/locking_extensions'
 require 'active_record/locking_extensions/log_subscriber'
 require 'active_support/all'
 require 'money'
+require 'rails/railtie'
 
 require 'double_entry/version'
 require 'double_entry/errors'
@@ -14,8 +15,6 @@ require 'double_entry/account_balance'
 require 'double_entry/balance_calculator'
 require 'double_entry/locking'
 require 'double_entry/transfer'
-require 'double_entry/line'
-require 'double_entry/line_metadata'
 require 'double_entry/validation'
 
 # Keep track of all the monies!
@@ -23,6 +22,16 @@ require 'double_entry/validation'
 # This module provides the public interfaces for everything to do with
 # transferring money around the system.
 module DoubleEntry
+  class Railtie < ::Rails::Railtie
+    # So we can access user config from initializer in their app
+    config.after_initialize do
+      unless DoubleEntry.config.json_metadata
+        require 'double_entry/line_metadata'
+      end
+      require 'double_entry/line'
+    end
+  end
+
   class << self
     # Get the particular account instance with the provided identifier and
     # scope.

data/lib/double_entry/configurable.rb

@@ -41,6 +41,7 @@ module DoubleEntry
       def configuration
         @configuration ||= self::Configuration.new
       end
+      alias config configuration
 
       def configure
         yield(configuration)

data/lib/double_entry/configuration.rb

@@ -3,6 +3,12 @@ module DoubleEntry
   include Configurable
 
   class Configuration
+    attr_accessor :json_metadata
+
+    def initialize
+      @json_metadata = false
+    end
+
     delegate(
       :accounts,
       :accounts=,

data/lib/double_entry/line.rb

@@ -56,7 +56,7 @@ module DoubleEntry
   #
   class Line < ActiveRecord::Base
     belongs_to :detail, :polymorphic => true
-    has_many :metadata, :class_name => 'DoubleEntry::LineMetadata'
+    has_many :metadata, :class_name => 'DoubleEntry::LineMetadata' unless -> { DoubleEntry.config.json_metadata }
     scope :with_id_greater_than, ->(id) { where('id > ?', id) }
 
     def amount

data/lib/double_entry/locking.rb

@@ -32,14 +32,14 @@ module DoubleEntry
     #
     # The transaction must be the outermost transaction to ensure data integrity. A
     # LockMustBeOutermostTransaction will be raised if it isn't.
-    def self.lock_accounts(*accounts)
+    def self.lock_accounts(*accounts, &block)
       lock = Lock.new(accounts)
 
       if lock.in_a_locked_transaction?
         lock.ensure_locked!
-        yield
+        block.call
       else
-        lock.perform_lock(&Proc.new)
+        lock.perform_lock(&block)
       end
 
     rescue ActiveRecord::StatementInvalid => exception

data/lib/double_entry/transfer.rb

@@ -88,12 +88,12 @@ module DoubleEntry
         fail MismatchedCurrencies, "Mismatched currency (#{to_account.currency} <> #{from_account.currency})"
       end
       Locking.lock_accounts(from_account, to_account) do
-        credit, debit = create_lines(amount, code, detail, from_account, to_account)
-        create_line_metadata(credit, debit, metadata) if metadata
+        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
     end
 
-    def create_lines(amount, code, detail, from_account, to_account)
+    def create_lines(amount, code, detail, from_account, to_account, metadata)
       credit, debit = Line.new, Line.new
 
       credit_balance = Locking.balance_for_locked_account(from_account)
@@ -107,6 +107,7 @@ module DoubleEntry
       credit.code, debit.code       = code, code
       credit.detail, debit.detail   = detail, detail
       credit.balance, debit.balance = credit_balance.balance, debit_balance.balance
+      credit.metadata, debit.metadata = metadata, metadata if DoubleEntry.config.json_metadata
 
       credit.partner_account, debit.partner_account = to_account, from_account
 

data/lib/double_entry/version.rb

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

data/lib/generators/double_entry/install/install_generator.rb

@@ -7,6 +7,8 @@ module DoubleEntry
     class InstallGenerator < Rails::Generators::Base
       include Rails::Generators::Migration
 
+      class_option :json_metadata, type: :boolean, default: true
+
       source_root File.expand_path('../templates', __FILE__)
 
       def self.next_migration_number(path)
@@ -17,6 +19,19 @@ module DoubleEntry
         migration_template 'migration.rb', 'db/migrate/create_double_entry_tables.rb', migration_version: migration_version
       end
 
+      def create_initializer
+        template 'initializer.rb', 'config/initializers/double_entry.rb'
+      end
+
+      def json_metadata
+        # MySQL JSON support added to AR 5.0
+        if ActiveRecord.version.version < '5'
+          false
+        else
+          options[:json_metadata]
+        end
+      end
+
       def migration_version
         if ActiveRecord.version.version > '5'
           "[#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}]"

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

@@ -0,0 +1,20 @@
+require 'double_entry'
+
+DoubleEntry.configure do |config|
+  # Use json(b) column in double_entry_lines table to store metadata instead of separate metadata table
+  config.json_metadata = <%= json_metadata %>
+
+  # config.define_accounts do |accounts|
+  #   user_scope = ->(user) do
+  #     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)
+  # end
+  #
+  # config.define_transfers do |transfers|
+  #   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,6 +1,6 @@
 class CreateDoubleEntryTables < ActiveRecord::Migration<%= migration_version %>
   def self.up
-    create_table "double_entry_account_balances", :force => true do |t|
+    create_table "double_entry_account_balances" do |t|
       t.string     "account", :null => false
       t.string     "scope"
       t.bigint     "balance", :null => false
@@ -10,7 +10,7 @@ class CreateDoubleEntryTables < ActiveRecord::Migration<%= migration_version %>
     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", :force => true do |t|
+    create_table "double_entry_lines" do |t|
       t.string     "account",         :null => false
       t.string     "scope"
       t.string     "code",            :null => false
@@ -20,6 +20,13 @@ class CreateDoubleEntryTables < ActiveRecord::Migration<%= migration_version %>
       t.string     "partner_account", :null => false
       t.string     "partner_scope"
       t.references "detail",                          :index => false, :polymorphic => true
+      <%- if json_metadata -%>
+      if ActiveRecord::Base.connection.adapter_name == "PostgreSQL"
+        t.jsonb "metadata"
+      else
+        t.json "metadata"
+      end
+      <%- end -%>
       t.timestamps                    :null => false
     end
 
@@ -28,7 +35,7 @@ class CreateDoubleEntryTables < ActiveRecord::Migration<%= migration_version %>
     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", :force => true do |t|
+    create_table "double_entry_line_checks" do |t|
       t.references "last_line",    :null => false, :index => false
       t.boolean    "errors_found", :null => false
       t.text       "log"
@@ -36,8 +43,9 @@ class CreateDoubleEntryTables < ActiveRecord::Migration<%= migration_version %>
     end
 
     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", :force => true do |t|
+    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
@@ -45,10 +53,11 @@ class CreateDoubleEntryTables < ActiveRecord::Migration<%= migration_version %>
     end
 
     add_index "double_entry_line_metadata", ["line_id", "key", "value"], :name => "lines_meta_line_id_key_value_idx"
+    <%- end -%>
   end
 
   def self.down
-    drop_table "double_entry_line_metadata"
+    drop_table "double_entry_line_metadata" if table_exists?("double_entry_line_metadata")
     drop_table "double_entry_line_checks"
     drop_table "double_entry_lines"
     drop_table "double_entry_account_balances"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: double_entry
 version: !ruby/object:Gem::Version
-  version: 2.0.0.beta3
+  version: 2.0.0.beta4
 platform: ruby
 authors:
 - Envato
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-13 00:00:00.000000000 Z
+date: 2020-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -249,15 +249,16 @@ files:
 - lib/double_entry/validation/line_check.rb
 - lib/double_entry/version.rb
 - lib/generators/double_entry/install/install_generator.rb
+- lib/generators/double_entry/install/templates/initializer.rb
 - lib/generators/double_entry/install/templates/migration.rb
 homepage: https://github.com/envato/double_entry
 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.beta3/CHANGELOG.md
-  documentation_uri: https://www.rubydoc.info/gems/double_entry/2.0.0.beta3
-  source_code_uri: https://github.com/envato/double_entry/tree/v2.0.0.beta3
+  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: 
 rdoc_options: []
 require_paths:
@@ -266,14 +267,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.2.0
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">"
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-rubygems_version: 3.0.4
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Tools to build your double entry financial ledger