double_entry 1.0.1 → 2.0.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 4d879d4baf12d4479b4533fb5032c27c0ef4968f
-  data.tar.gz: dfeda86d6a9147c2cb99313c3136f1fe2bbe3ca3
+SHA256:
+  metadata.gz: bd62c2e42e510db804162a1de625cc123d04c65c6183eb1e1004061eef376e46
+  data.tar.gz: ffde728e5768509bd391e4056971dbb63128ad46ef02a9780497facaaa31415e
 SHA512:
-  metadata.gz: 4415c2eae26420297541d515cabf79eb2eb7833c10c4984724e391d9f3ebad20f86178837fad21ee91baebf9ee57332554c617a2ab3cb856375b21df9a92dc07
-  data.tar.gz: 45c892f2e32784e8aefcbadb014372729e59ce9089c7ab5ebd075679b50be04a87bc5b81f9c00638dca4d79466cd18a6390f8b970a24ed9377d3eaabf89d83b3
+  metadata.gz: 3c30e7b10ebeac99660c122ecedfafccbb115f36ed309e9a7c0b41bc122ea5a86d51baac92c28c0a5bcff4850b752fa7ffd356a94267812cb79fa4c7ef029bfd
+  data.tar.gz: 145104fb048131b5f49d075f9a8e0b94d6e5fd73c5450cad0b4bdf522ecc9f6c311571e809457017383fa4b0d4576859a3a3e4aa991ff45d672189fd9434ff46

data/CHANGELOG.md

@@ -0,0 +1,432 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
+and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [2.0.0.beta1] - 2018-12-31
+
+### Added
+
+- Added contributor credits to README.
+
+- Added support for Ruby 2.3, 2.4, 2.5 and 2.6.
+
+- Added support for Rails 5.0, 5.1 and 5.2
+
+- Support passing an array of metadata values.
+
+    ```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' },
+    )
+    ```
+
+- Allow partner account to be specified for aggregates.
+
+- Allow filtering aggregates by multiple metadata key/value pairs.
+
+- Add index on the `double_entry_line_checks` table. This covers the query to
+  obtain the last line check.
+
+  Add this index to your database via a migration like:
+
+    ```ruby
+    def up
+      add_index "double_entry_line_checks", ["created_at", "last_line_id"], :name => "line_checks_created_at_last_line_id_idx"
+    end
+    ```
+
+- Log account balance cache errors to the database when performing the line check:
+  `DoubleEntry::Validation::LineCheck::perform!`
+
+### Changed
+
+- Replaced Machinist with Factory Bot in test suite.
+
+- Implement `DoubleEntry::Transfer::Set` and `DoubleEntry::Account::Set` with
+  `Hash`es rather than `Array`s for performance.
+
+- Reporting API now uses keyword arguments. Note these reporting classes are
+  marked API private: their interface is not considered stable.
+  - `DoubleEntry::Reporting::aggregate`
+  - `DoubleEntry::Reporting::aggregate_array`
+  - `DoubleEntry::Reporting::Aggregate::new`
+  - `DoubleEntry::Reporting::Aggregate::formatted_amount`
+  - `DoubleEntry::Reporting::AggregateArray::new`
+  - `DoubleEntry::Reporting::LineAggregateFilter::new`
+
+- Loosened database string column contstraints to the default (255 characters).
+  Engineering teams can choose to apply this change, or apply their own column
+  length constraints specific to their needs. ([#152])
+
+- Removed default values for the length checks on `code`, `account` and `scope`
+  ([#152]). These checks will now only be performed when configured with a value:
+
+   ```ruby
+   DoubleEntry.configure do |config|
+     config.code_max_length = 47
+     config.account_identifier_max_length = 31
+     config.scope_identifier_max_length = 23
+   end
+   ```
+- Use `bigint` for monetary values in the database to avoid integer overflow
+  ([#154]). Apply changes via this migration:
+
+   ```ruby
+   change_column :double_entry_account_balances, :balance, :bigint, null: false
+
+   change_column :double_entry_line_aggregates, :amount, :bigint, null: false
+
+   change_column :double_entry_lines, :amount, :bigint, null: false
+   change_column :double_entry_lines, :balance, :bigint, null: false
+   ```
+- On Rails version 5.1 and above, use `bigint` for foreign key values in the
+  database to avoid integer overflow ([#154]). Apply changes via this
+  migration:
+
+   ```ruby
+   change_column :double_entry_line_checks, :last_line_id, :bigint, null: false
+
+   change_column :double_entry_line_metadata, :line_id, :bigint, null: false
+
+   change_column :double_entry_lines, :partner_id, :bigint, null: true
+   change_column :double_entry_lines, :detail_id, :bigint, null: true
+   ```
+
+- Line check validation no-longer performs corrections by default. The
+  `DoubleEntry::Validation::LineCheck::perform!` method will only log validation
+  failures in the database. To perform auto-correction pass the `fixer` option:
+  `LineCheck.perform!(fixer: DoubleEntry::Validation::AccountFixer.new)`
+
+### Removed
+
+- Removed support for Ruby 1.9, 2.0, 2.1 and 2.2.
+
+- Removed support for Rails 3.2, 4.0, and 4.1.
+
+- Removed unneeded development dependencies from Gemspec.
+
+- Removed spec and script files from gem package.
+
+- Removed the `active_record_scope_identifier` method for configuring scoped accounts.
+
+    ```ruby
+    user_scope = accounts.active_record_scope_identifier(User)
+    ```
+
+  As a replacement, please define your own with a lambda:
+
+    ```ruby
+    user_scope = ->(user) do
+      raise 'not a User' unless user.class.name == 'User'
+      user.id
+    end
+    ```
+
+### Fixed
+
+- Fixed more Ruby warnings.
+
+- Use `double_entry` namespace when publishing to
+  `ActiveSupport::Notifications`.
+
+- Fixed problem of Rails version number not being set in migration template for apps using Rails 5 or higher.
+
+[#152]: https://github.com/envato/double_entry/pull/152
+[#154]: https://github.com/envato/double_entry/pull/154
+
+## [1.0.1] - 2018-01-06
+
+### Removed
+
+- Removed Rubocop checks and build step.
+
+### Fixed
+
+- Use `Money#positive?` and `Money#negative?` rather than comparing to zero.
+  Resolves issues when dealing with multiple currencies.
+
+- Fixed typo in jack_hammer documentation.
+
+## [1.0.0] - 2015-08-04
+
+### Added
+
+- Record meta-data against transfers.
+
+    ```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', :key2 => 'value 2' },
+    )
+    ```
+
+  This feature requires a new DB table. Please add a migration similar to:
+
+    ```ruby
+    class CreateDoubleEntryLineMetadata < ActiveRecord::Migration
+      def self.up
+        create_table "#{DoubleEntry.table_name_prefix}line_metadata", :force => true do |t|
+          t.integer    "line_id",               :null => false
+          t.string     "key",     :limit => 48, :null => false
+          t.string     "value",   :limit => 64, :null => false
+          t.timestamps                          :null => false
+        end
+
+        add_index "#{DoubleEntry.table_name_prefix}line_metadata",
+                  ["line_id", "key", "value"],
+                  :name => "lines_meta_line_id_key_value_idx"
+      end
+
+      def self.down
+        drop_table "#{DoubleEntry.table_name_prefix}line_metadata"
+      end
+    end
+    ```
+
+### Changed
+
+- Raise `DoubleEntry::Locking::LockWaitTimeout` for lock wait timeouts.
+
+### Fixed
+
+- Ensure that a range is specified when performing an aggregate function over
+  lines.
+
+## [0.10.3] - 2015-07-15
+
+### Added
+
+- Check code format with Rubocop as part of the CI build.
+
+### Fixed
+
+- More Rubocop code formatting issues fixed.
+
+## [0.10.2] - 2015-07-10
+
+### Fixed
+
+- `DoubleEntry::Reporting::AggregateArray` correctly retreives previously
+  calculated aggregates.
+
+## [0.10.1] - 2015-07-06
+
+### Added
+
+- Run CI build against Ruby 2.2.0.
+
+- Added Rubocop and resolved code formatting issues.
+
+### Changed
+
+- Reduced permutations of DB, Ruby and Rails in CI build.
+
+- Build status badge displayed in README reports on just the master branch.
+
+- Update RSpec configuration with latest recommended options.
+
+### Fixed
+
+- Addressed Ruby warnings.
+
+- Fixed circular arg reference.
+
+## [0.10.0] - 2015-01-09
+
+### Added
+
+- Define accounts that can be negative only.
+
+    ```ruby
+    DoubleEntry.configure do |config|
+      config.define_accounts do |accounts|
+        accounts.define(
+          :identifier     => :my_account_that_never_goes_positive,
+          :negative_only  => true
+        )
+      end
+    end
+    ```
+
+- Run CI build against Rails 4.2
+
+## [0.9.0] - 2014-12-08
+
+### Changed
+
+- `DoubleEntry::Reporting::Agregate#formated_amount` no longer accepts
+  `currency` argument.
+
+## [0.8.0] - 2014-11-19
+
+### Added
+
+- Log when we encounter deadlocks causing restart/retry.
+
+## [0.7.2] - 2014-11-18
+
+### Removed
+
+- Removed `DoubleEntry::currency` method.
+
+## [0.7.1] - 2014-11-17
+
+### Fixed
+
+- `DoubleEntry::balance` and `DoubleEntry::account` now raise
+  `DoubleEntry::AccountScopeMismatchError` if the scope provided is not of
+  the same type in the account definition.
+
+- Speed up CI build.
+
+## [0.7.0] - 2014-11-12
+
+### Added
+
+- Added support for currency. :money_with_wings:
+
+### Changed
+
+- Require at least version 6.0 of Money gem.
+
+## [0.6.1] - 2014-10-10
+
+### Changed
+
+- Removed use of Active Record callbacks in `DoubleEntry::Line`.
+
+- Changed `DoubleEntry::Reporting::WeekRange` calculation to use
+`Date#cweek`.
+
+## [0.6.0] - 2014-08-23
+
+### Fixed
+
+- Fixed defect preventing locking a scoped and a non scoped account.
+
+## [0.5.0] - 2014-08-01
+
+### Added
+
+- Added a convenience method for defining active record scope identifiers.
+
+    ```ruby
+    DoubleEntry.configure do |config|
+      config.define_accounts do |accounts|
+        user_scope = accounts.active_record_scope_identifier(User)
+        accounts.define(:identifier => :checking, :scope_identifier => user_scope)
+      end
+    end
+    ```
+
+- Added support for SQLite.
+
+### Removed
+
+- Removed errors: `DoubleEntry::RequiredMetaMissing` and
+`DoubleEntry::UserAccountNotLocked`.
+
+### Fixed
+
+- Fixed `Reporting::reconciled?` support for account scopes.
+
+## [0.4.0] - 2014-07-17
+
+### Added
+
+- Added Yardoc documention to the `DoubleEntry::balance` method.
+
+### Changed
+
+- Changed `Line#debit?` to `Line#increase?` and `Line#credit?` to
+  `Line#decrease?`.
+
+### Removed
+
+- Removed the `DoubleEntry::Line#meta` attribute.
+
+## [0.3.1] - 2014-07-11
+
+### Fixed
+
+- Obtain a year range array without prioviding a start date.
+
+## [0.3.0] - 2014-07-11
+
+### Added
+
+- Add Yardoc to `Reporting` module.
+- Allow reporting month and year time ranges without a start date.
+
+### Changed
+
+- Use ruby18 hash syntax for configuration example in README.
+
+### Removed
+
+- Removed `DoubleEntry::describe` and `DoubleEntry::Line#description`
+  methods.
+
+## [0.2.0] - 2014-06-28
+
+### Added
+
+- Added a configuration class to define valid accounts and transfers.
+
+    ```ruby
+    DoubleEntry.configure do |config|
+      config.define_accounts do |accounts|
+        accounts.define(identifier: :savings,  positive_only: true)
+        accounts.define(identifier: :checking)
+      end
+
+      config.define_transfers do |transfers|
+        transfers.define(from: :checking, to: :savings,  code: :deposit)
+        transfers.define(from: :savings,  to: :checking, code: :withdraw)
+      end
+    end
+    ```
+
+### Changed
+
+- Move reporting classes into the `DoubleEntry::Reporting` namespace. Mark
+  this module as `@api private`: internal use only.
+
+## 0.1.0 - 2014-06-20
+
+### Added
+
+- Library released as Open Source!
+
+[Unreleased]: https://github.com/envato/double_entry/compare/v2.0.0.beta1...HEAD
+[2.0.0.beta1]: https://github.com/envato/double_entry/compare/v1.0.1...v2.0.0.beta1
+[1.0.1]: https://github.com/envato/double_entry/compare/v1.0.0...v1.0.1
+[1.0.0]: https://github.com/envato/double_entry/compare/v0.10.3...v1.0.0
+[0.10.3]: https://github.com/envato/double_entry/compare/v0.10.2...v0.10.3
+[0.10.2]: https://github.com/envato/double_entry/compare/v0.10.1...v0.10.2
+[0.10.1]: https://github.com/envato/double_entry/compare/v0.10.0...v0.10.1
+[0.10.0]: https://github.com/envato/double_entry/compare/v0.9.0...v0.10.0
+[0.9.0]: https://github.com/envato/double_entry/compare/v0.8.0...v0.9.0
+[0.8.0]: https://github.com/envato/double_entry/compare/v0.7.2...v0.8.0
+[0.7.2]: https://github.com/envato/double_entry/compare/v0.7.1...v0.7.2
+[0.7.1]: https://github.com/envato/double_entry/compare/v0.7.0...v0.7.1
+[0.7.0]: https://github.com/envato/double_entry/compare/v0.6.1...v0.7.0
+[0.6.1]: https://github.com/envato/double_entry/compare/v0.6.0...v0.6.1
+[0.6.0]: https://github.com/envato/double_entry/compare/v0.5.0...v0.6.0
+[0.5.0]: https://github.com/envato/double_entry/compare/v0.4.0...v0.5.0
+[0.4.0]: https://github.com/envato/double_entry/compare/v0.3.1...v0.4.0
+[0.3.1]: https://github.com/envato/double_entry/compare/v0.3.0...v0.3.1
+[0.3.0]: https://github.com/envato/double_entry/compare/v0.2.0...v0.3.0
+[0.2.0]: https://github.com/envato/double_entry/compare/v0.1.0...v0.2.0

data/README.md

@@ -3,8 +3,8 @@
 
 [![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=1-stable)](https://travis-ci.org/envato/double_entry)
-[![Code Climate](https://codeclimate.com/github/envato/double_entry.png)](https://codeclimate.com/github/envato/double_entry)
+[![Build Status](https://travis-ci.org/envato/double_entry.svg?branch=master)](https://travis-ci.org/envato/double_entry)
+[![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)
 
@@ -22,15 +22,16 @@ DoubleEntry uses the [Money gem](https://github.com/RubyMoney/money) to encapsul
 DoubleEntry is tested against:
 
 Ruby
- * 2.1.x
- * 2.2.x
  * 2.3.x
+ * 2.4.x
+ * 2.5.x
+ * 2.6.x
 
 Rails
- * 3.2.x
- * 4.1.x
  * 4.2.x
  * 5.0.x
+ * 5.1.x
+ * 5.2.x
 
 Databases
  * MySQL
@@ -134,7 +135,7 @@ DoubleEntry.transfer(
   :from => one_account,
   :to   => another_account,
   :code => :a_business_code_for_this_type_of_transfer,
-  :metadata => {:key1 => 'value 1', :key2 => 'value 2'},
+  :metadata => {:key1 => ['value 1', 'value 2'], :key2 => 'value 3'},
 )
 ```
 
@@ -195,7 +196,10 @@ require 'double_entry'
 
 DoubleEntry.configure do |config|
   config.define_accounts do |accounts|
-    user_scope = accounts.active_record_scope_identifier(User)
+    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
@@ -215,7 +219,7 @@ 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
 ```
@@ -304,3 +308,26 @@ See the Github project [issues](https://github.com/envato/double_entry/issues).
     ```sh
     bundle exec rake
     ```
+
+## Contributors
+
+Many thanks to those who have contributed to both this gem, and the library upon which it was based, over the years:
+  * Anthony Sellitti - @asellitt
+  * Clinton Forbes - @clinton
+  * Eaden McKee - @eadz
+  * Giancarlo Salamanca - @salamagd
+  * Jiexin Huang - @jiexinhuang
+  * Keith Pitt - @keithpitt
+  * Kelsey Hannan - @KelseyDH
+  * Mark Turnley - @rabidcarrot
+  * Martin Jagusch - @MJIO
+  * Martin Spickermann - @spickermann
+  * Mary-Anne Cosgrove - @macosgrove
+  * Orien Madgwick - @orien
+  * Pete Yandall - @notahat
+  * Rizal Muthi - @rizalmuthi
+  * Ryan Allen - @ryan-allen
+  * Samuel Cochran - @sj26
+  * Stephanie Staub - @stephnacios
+  * Trung Lê - @joneslee85
+  * Vahid Ta'eed - @vahid