double_entry 0.7.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 05aef36c2326f83e2a5e81ef732b88eb375d40db
-  data.tar.gz: 14e53582a9aaa42cfb5acbff3273d036d29f7c5b
+  metadata.gz: 614ed4f674917475306caf7d8ebbd2d71c72a5b0
+  data.tar.gz: ff2a94aa12cb75fa558ecab769c47a59cf40226e
 SHA512:
-  metadata.gz: 6affae6cedb93232bd40af21f8e2d9386e90014aaed30bfa41d4bf0ff3117d16879e21afc07eaea78e5308e7ccb5ae4b12d6d7e27a7854613a3df21df39bf267
-  data.tar.gz: 8176ff4543e6ffaad668ef63fe2862e472ebb7a160971f6d6749446ed350e334ebe309536e20e2c315b57a2849a17a21fb6a0c931ae93a0f068b40416fb63a17
+  metadata.gz: 1c98e390fa45e02e0e117c7283964db04b6eb7d4b5c27d3de54f8d541284c40c6c557c46c47ef15d6caadb94db5341da1c4095f6adaa269675f6c5e0f100329f
+  data.tar.gz: da1243b2adf4f047a90250cd30ecefb49d478869dc1ed2b44bb3d0263e34ed831e8afd155bdfcf7d5c33cba077f282e1e0ac6ae28c2a20a202bda8c5131d12a2

data/.travis.yml

@@ -1,7 +1,6 @@
 language: ruby
 rvm:
   - 2.1.4
-  - 2.0.0
   - 1.9.3
 env:
   - DB=mysql
@@ -16,5 +15,4 @@ script:
   - ruby script/jack_hammer -t 2000
 gemfile:
   - spec/support/gemfiles/Gemfile.rails-3.2.x
-  - spec/support/gemfiles/Gemfile.rails-4.0.x
   - spec/support/gemfiles/Gemfile.rails-4.1.x

data/README.md

@@ -13,17 +13,21 @@ DoubleEntry is an accounting system based on the principles of a
 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.
 
-DoubleEntry uses the Money gem to avoid floating point rounding errors.
+DoubleEntry uses the [Money gem](https://github.com/RubyMoney/money) to encapsulate operations on currency values.
 
 ## Compatibility
 
-DoubleEntry has been tested with:
+DoubleEntry is tested against:
 
-Ruby Versions: 1.9.3, 2.0.0, 2.1.2
+Ruby
+ * 1.9.3
+ * 2.1.4
 
-Rails Versions: Rails 3.2.x, 4.0.x, 4.1.x
+Rails
+ * 3.2.x
+ * 4.1.x
 
-**Databases Supported:**
+Databases
  * MySQL
  * PostgreSQL
  * SQLite
@@ -104,7 +108,7 @@ To transfer money between accounts:
 
 ```ruby
 DoubleEntry.transfer(
-  20.dollars,
+  Money.new(20_00),
   :from => one_account,
   :to   => another_account,
   :code => :a_business_code_for_this_type_of_transfer,

data/lib/double_entry.rb

@@ -37,6 +37,8 @@ module DoubleEntry
     # @return [DoubleEntry::Account::Instance]
     # @raise [DoubleEntry::UnknownAccount] The described account has not been
     #   configured. It is unknown.
+    # @raise [DoubleEntry::AccountScopeMismatchError] The provided scope does not
+    #   match that defined on the account.
     #
     def account(identifier, options = {})
       Account.account(configuration.accounts, identifier, options)
@@ -124,7 +126,12 @@ module DoubleEntry
     # @option options :codes [Array<Symbol>] consider only the transfers with
     #   these codes
     # @return [Money] The balance
+    # @raise [DoubleEntry::UnknownAccount] The described account has not been
+    #   configured. It is unknown.
+    # @raise [DoubleEntry::AccountScopeMismatchError] The provided scope does not
+    #   match that defined on the account.
     def balance(account, options = {})
+      account = account(account, options) if account.is_a? Symbol
       BalanceCalculator.calculate(account, options)
     end
 

data/lib/double_entry/account.rb

@@ -52,7 +52,16 @@ module DoubleEntry
       end
 
       def scope_identifier
-        ->(value) { value.is_a?(@active_record_class) ? value.id : value }
+        lambda do |value|
+          case value
+          when @active_record_class
+            value.id
+          when String, Fixnum
+            value
+          else
+            raise AccountScopeMismatchError.new("Expected instance of `#{@active_record_class}`, received instance of `#{value.class}`")
+          end
+        end
       end
     end
 
@@ -62,6 +71,7 @@ module DoubleEntry
 
       def initialize(attributes)
         attributes.each { |name, value| send("#{name}=", value) }
+        ensure_scope_is_valid
       end
 
       def scope_identity
@@ -110,6 +120,12 @@ module DoubleEntry
       def inspect
         to_s
       end
+
+      private
+
+      def ensure_scope_is_valid
+        scope_identity
+      end
     end
 
     attr_accessor :identifier, :scope_identifier, :positive_only, :currency

data/lib/double_entry/balance_calculator.rb

@@ -5,8 +5,7 @@ module DoubleEntry
 
     # Get the current or historic balance of an account.
     #
-    # @param account [DoubleEntry::Account:Instance, Symbol]
-    # @option args :scope [Object, String]
+    # @param account [DoubleEntry::Account:Instance]
     # @option args :from [Time]
     # @option args :to [Time]
     # @option args :at [Time]
@@ -53,13 +52,8 @@ module DoubleEntry
       attr_reader :account, :scope, :from, :to, :at, :codes
 
       def initialize(account, args = {})
-        if account.is_a? Symbol
-          @account = account.to_s
-          @scope = args[:scope].present? ? args[:scope].id.to_s : nil
-        else
-          @account = account.identifier.to_s
-          @scope = account.scope_identity
-        end
+        @account = account.identifier.to_s
+        @scope = account.scope_identity
         @codes = (args[:codes].to_a << args[:code]).compact
         @from = args[:from]
         @to = args[:to]

data/lib/double_entry/errors.rb

@@ -1,6 +1,5 @@
 # encoding: utf-8
 module DoubleEntry
-
   class UnknownAccount < RuntimeError; end
   class TransferNotAllowed < RuntimeError; end
   class TransferIsNegative < RuntimeError; end
@@ -9,4 +8,5 @@ module DoubleEntry
   class AccountWouldBeSentNegative < RuntimeError; end
   class MismatchedCurrencies < RuntimeError; end
   class MissingAccountError < RuntimeError; end;
+  class AccountScopeMismatchError < RuntimeError; end;
 end

data/lib/double_entry/version.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
 
 module DoubleEntry
-  VERSION = "0.7.0"
+  VERSION = "0.7.1"
 end

data/spec/double_entry/account_spec.rb

@@ -73,6 +73,13 @@ module DoubleEntry
             it { should eq 32 }
           end
 
+          context "given differing model instance with ID 32" do
+            let(:value) { double(:id => 32) }
+            it "raises an error" do
+              expect { scope_identifier.call(value) }.to raise_error DoubleEntry::AccountScopeMismatchError
+            end
+          end
+
           context "given the String 'I am a bearded lady'" do
             let(:value) { "I am a bearded lady" }
 

data/spec/double_entry/balance_calculator_spec.rb

@@ -5,7 +5,7 @@ describe DoubleEntry::BalanceCalculator do
 
   describe '#calculate' do
     let(:account) { DoubleEntry::account(:test, :scope => scope) }
-    let(:scope) { double(:id => 1) }
+    let(:scope) { User.make! }
     let(:from) { nil }
     let(:to) { nil }
     let(:at) { nil }
@@ -26,30 +26,6 @@ describe DoubleEntry::BalanceCalculator do
       )
     end
 
-    describe 'what happens with different accounts' do
-      context 'when the given account is a symbol' do
-        let(:account) { :test }
-
-        it 'scopes the lines summed by the account symbol' do
-          expect(DoubleEntry::Line).to have_received(:where).with(:account => 'test')
-        end
-
-        context 'with a scopeable entity provided' do
-          let(:scope) { double(:id => 'scope') }
-
-          it 'scopes the lines summed by the scope of the scopeable entity...scope' do
-            expect(relation).to have_received(:where).with(:scope => 'scope')
-          end
-        end
-
-        context 'with no scope provided' do
-          it 'does not scope the lines summed by the given scope' do
-            expect(relation).to_not have_received(:where).with(:scope => 'scope')
-          end
-        end
-      end
-    end
-
     describe 'what happens with different times' do
       context 'when we want to sum the lines before a given created_at date' do
         let(:at) { Time.parse('2014-06-19 15:09:18 +1000') }

data/spec/double_entry_spec.rb

@@ -356,9 +356,10 @@ describe DoubleEntry do
     before do
       DoubleEntry.configure do |config|
         config.define_accounts do |accounts|
+          user_scope = accounts.active_record_scope_identifier(User)
           accounts.define(:identifier => :bank)
-          accounts.define(:identifier => :cash,    :scope_identifier => ->(user) { user.id })
-          accounts.define(:identifier => :savings, :scope_identifier => ->(user) { user.id })
+          accounts.define(:identifier => :cash,    :scope_identifier => user_scope)
+          accounts.define(:identifier => :savings, :scope_identifier => user_scope)
         end
 
         config.define_transfers do |transfers|
@@ -400,6 +401,18 @@ describe DoubleEntry do
       expect(DoubleEntry.balance(:cash, :scope => ryan)).to eq -Money.new(10_00)
     end
 
+    it 'raises an exception if you try to scope with an object instance of differing class to that defined on the account' do
+      not_a_user = double(:id => 7)
+
+      expect {
+        DoubleEntry.account(:savings, :scope => not_a_user)
+      }.to raise_error DoubleEntry::AccountScopeMismatchError
+
+      expect {
+        DoubleEntry.balance(:savings, :scope => not_a_user)
+      }.to raise_error DoubleEntry::AccountScopeMismatchError
+    end
+
     it 'raises exception if you try to transfer between the same account, despite it being scoped' do
       expect do
         DoubleEntry.transfer(Money.new(10_00), :from => ryans_cash, :to => ryans_cash, :code => :xfer)
@@ -412,9 +425,8 @@ describe DoubleEntry do
       expect(ryans_savings.balance).to eq Money.new(100_00)
     end
 
-    it 'allows you to report on scoped accounts globally' do
-      expect(DoubleEntry.balance(:cash)).to eq ryans_cash.balance + johns_cash.balance
-      expect(DoubleEntry.balance(:savings)).to eq ryans_savings.balance + johns_savings.balance
+    it 'disallows you to report on scoped accounts globally' do
+      expect { DoubleEntry.balance(:cash) }.to raise_error DoubleEntry::UnknownAccount
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: double_entry
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.7.1
 platform: ruby
 authors:
 - Anthony Sellitti
@@ -15,7 +15,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-12 00:00:00.000000000 Z
+date: 2014-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: money
@@ -291,7 +291,6 @@ files:
 - spec/support/database.travis.yml
 - spec/support/double_entry_spec_helper.rb
 - spec/support/gemfiles/Gemfile.rails-3.2.x
-- spec/support/gemfiles/Gemfile.rails-4.0.x
 - spec/support/gemfiles/Gemfile.rails-4.1.x
 - spec/support/reporting_configuration.rb
 - spec/support/schema.rb
@@ -345,7 +344,6 @@ test_files:
 - spec/support/database.travis.yml
 - spec/support/double_entry_spec_helper.rb
 - spec/support/gemfiles/Gemfile.rails-3.2.x
-- spec/support/gemfiles/Gemfile.rails-4.0.x
 - spec/support/gemfiles/Gemfile.rails-4.1.x
 - spec/support/reporting_configuration.rb
 - spec/support/schema.rb

data/spec/support/gemfiles/Gemfile.rails-4.0.x

@@ -1,5 +0,0 @@
-source 'https://rubygems.org'
-
-gemspec :path => '../../../'
-
-gem 'rails', '~> 4.0.0'