double_entry 0.10.0 → 0.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5979a152f5320a2cb5fc2838a966925abe66fbd6
-  data.tar.gz: b9486092cdaf973950bd38c27b64379064c34000
+  metadata.gz: a89a7b1a2bfa39a0c51b309f107fc625af9643f0
+  data.tar.gz: 1ac1862d044333c98bb26e78c6ba7d2c508203b4
 SHA512:
-  metadata.gz: c3a79f8cffcb4925ed6146360477d5c97d8c49464ac7b550daf452bc3d4d10aac8c6221c3f2f2fa913181e72851fa16e3735c9adeb1137088ce6e2b50419a9a4
-  data.tar.gz: 11e7067886e3b813235f1cdae8affbfb7215fea67cc36e4bbec42f6e1bd900baf960ca4dc8ca4dec3e63542c366b3e31587489f5c9e4c24b07f61d3463d0c2e7
+  metadata.gz: 235592b9bce67bfdbb4aa474e722a9dd54573ad495797fc1338521d6807e7d51648c7d3eb6258bbde8bdfa8b4b04a5fb6993dca63f21aadd123b9d76d4364dd3
+  data.tar.gz: 28f0afca58a850bca2efc4a28bfa967639f54e383b5b16cc9e5959cef65b5eb8f3d8a72efb0e519f745e9491252fe2ff5c7ca86fa90168e6e41da9a2e1152765

data/.rspec

@@ -1 +1,2 @@
---colour
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,55 @@
+AllCops:
+  Exclude:
+    - .bundle/**/*
+    - bin/**/*
+    - tmp/**/*
+    - script/jack_hammer
+    - spec/support/schema.rb
+    - lib/generators/double_entry/install/templates/**/*
+
+Style/AccessModifierIndentation:
+  EnforcedStyle: outdent
+
+Style/DotPosition:
+  EnforcedStyle: trailing
+
+Style/GuardClause:
+  Enabled: false
+
+Style/HashSyntax:
+  EnforcedStyle: hash_rockets
+
+Style/SpecialGlobalVars:
+  Enabled: false
+
+Style/TrailingComma:
+  EnforcedStyleForMultiline: comma
+
+# TODO Enable these checks and fix codes
+
+Style/ClassVars:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/DoubleNegation:
+  Enabled: false
+
+Style/ModuleFunction:
+  Enabled: false
+
+Metrics/AbcSize:
+  Max: 47 #15
+
+Metrics/CyclomaticComplexity:
+  Max: 13 #6
+
+Metrics/LineLength:
+  Max: 185
+
+Metrics/MethodLength:
+  Max: 30 # 10
+
+Metrics/PerceivedComplexity:
+  Max: 13 #7

data/.travis.yml

@@ -1,12 +1,4 @@
 language: ruby
-rvm:
-  - 1.9.3
-  - 2.0.0
-  - 2.1.5
-env:
-  - DB=mysql
-  - DB=postgres
-  - DB=sqlite
 before_script:
   - cp spec/support/database.travis.yml spec/support/database.yml
   - mysql -e 'create database double_entry_test;'
@@ -14,7 +6,26 @@ before_script:
 script:
   - rake spec
   - ruby script/jack_hammer -t 2000
-gemfile:
-  - spec/support/gemfiles/Gemfile.rails-3.2.x
-  - spec/support/gemfiles/Gemfile.rails-4.1.x
-  - spec/support/gemfiles/Gemfile.rails-4.2.x
+matrix:
+  include:
+    - rvm: 1.9.3
+      gemfile: spec/support/gemfiles/Gemfile.rails-4.2.x
+      env: DB=mysql
+    - rvm: 2.0.0
+      gemfile: spec/support/gemfiles/Gemfile.rails-4.2.x
+      env: DB=mysql
+    - rvm: 2.2.0
+      gemfile: spec/support/gemfiles/Gemfile.rails-4.1.x
+      env: DB=mysql
+    - rvm: 2.2.0
+      gemfile: spec/support/gemfiles/Gemfile.rails-4.2.x
+      env: DB=mysql
+    - rvm: 2.2.0
+      gemfile: spec/support/gemfiles/Gemfile.rails-4.2.x
+      env: DB=sqlite
+    - rvm: 2.2.0
+      gemfile: spec/support/gemfiles/Gemfile.rails-4.2.x
+      env: DB=postgres
+    - rvm: 2.1.5
+      gemfile: spec/support/gemfiles/Gemfile.rails-3.2.x
+      env: DB=mysql

data/README.md

@@ -1,7 +1,9 @@
 # DoubleEntry
 
+
+[![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)](https://travis-ci.org/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.png)](https://codeclimate.com/github/envato/double_entry)
 
 ![Show me the Money](http://24.media.tumblr.com/tumblr_m3bwbqNJIG1rrgbmqo1_500.gif)
@@ -21,7 +23,9 @@ DoubleEntry is tested against:
 
 Ruby
  * 1.9.3
+ * 2.0.0
  * 2.1.5
+ * 2.2.0
 
 Rails
  * 3.2.x

data/Rakefile

@@ -1,14 +1,19 @@
-require "rspec/core/rake_task"
-require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+require 'bundler/gem_tasks'
+require 'rubocop/rake_task'
 
 RSpec::Core::RakeTask.new(:spec) do |t|
   t.verbose = false
+  t.ruby_opts = '-w'
 end
 
+RuboCop::RakeTask.new(:rubocop)
+
 task :default do
   %w(mysql postgres sqlite).each do |db|
     puts "Running tests with `DB=#{db}`"
     ENV['DB'] = db
-    Rake::Task["spec"].execute
+    Rake::Task['spec'].execute
   end
+  Rake::Task['rubocop'].execute
 end

data/double_entry.gemspec

@@ -1,5 +1,4 @@
 # encoding: utf-8
-
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
@@ -10,12 +9,11 @@ Gem::Specification.new do |gem|
   gem.version       = DoubleEntry::VERSION
   gem.authors       = ['Anthony Sellitti', 'Keith Pitt', 'Martin Jagusch', 'Martin Spickermann', 'Mark Turnley', 'Orien Madgwick', 'Pete Yandall', 'Stephanie Staub']
   gem.email         = ['anthony.sellitti@envato.com', 'me@keithpitt.com', '_@mj.io', 'spickemann@gmail.com', 'mark@envato.com', '_@orien.io', 'pete@envato.com', 'staub.steph@gmail.com']
-  # gem.description   = %q{}
   gem.summary       = 'Tools to build your double entry financial ledger'
   gem.homepage      = 'https://github.com/envato/double_entry'
 
   gem.files         = `git ls-files`.split($/)
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.executables   = gem.files.grep(%r{bin/}).map { |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ['lib']
 
@@ -28,10 +26,13 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'mysql2'
   gem.add_development_dependency 'pg'
   gem.add_development_dependency 'sqlite3'
+
   gem.add_development_dependency 'rspec'
   gem.add_development_dependency 'rspec-its'
+  gem.add_development_dependency 'rspec-instafail'
   gem.add_development_dependency 'database_cleaner'
   gem.add_development_dependency 'generator_spec'
   gem.add_development_dependency 'machinist'
   gem.add_development_dependency 'timecop'
+  gem.add_development_dependency 'rubocop'
 end

data/lib/active_record/locking_extensions.rb

@@ -1,34 +1,28 @@
 # encoding: utf-8
-require "active_support/notifications"
+require 'active_support/notifications'
 
 module ActiveRecord
-
   # These methods are available as class methods on ActiveRecord::Base.
   module LockingExtensions
-
     # Execute the given block within a database transaction, and retry the
     # transaction from the beginning if a RestartTransaction exception is raised.
     def restartable_transaction(&block)
-      begin
-        transaction(&block)
-      rescue ActiveRecord::RestartTransaction
-        retry
-      end
+      transaction(&block)
+    rescue ActiveRecord::RestartTransaction
+      retry
     end
 
     # Execute the given block, and retry the current restartable transaction if a
     # MySQL deadlock occurs.
     def with_restart_on_deadlock
-      begin
-        yield
-      rescue ActiveRecord::StatementInvalid => exception
-        if exception.message =~ /deadlock/i || exception.message =~ /database is locked/i
-          ActiveSupport::Notifications.publish("deadlock_restart.active_record", :exception => exception)
+      yield
+    rescue ActiveRecord::StatementInvalid => exception
+      if exception.message =~ /deadlock/i || exception.message =~ /database is locked/i
+        ActiveSupport::Notifications.publish('deadlock_restart.active_record', :exception => exception)
 
-          raise ActiveRecord::RestartTransaction
-        else
-          raise
-        end
+        raise ActiveRecord::RestartTransaction
+      else
+        raise
       end
     end
 
@@ -42,23 +36,21 @@ module ActiveRecord
       end
     end
 
-    private
+  private
 
     def ignoring_duplicates
       # Error examples:
       #   PG::Error: ERROR:  duplicate key value violates unique constraint
       #   Mysql2::Error: Duplicate entry 'keith' for key 'index_users_on_username': INSERT INTO `users...
       #   ActiveRecord::RecordNotUnique  SQLite3::ConstraintException: column username is not unique: INSERT INTO "users"...
-      begin
-        yield
-      rescue ActiveRecord::StatementInvalid, ActiveRecord::RecordNotUnique => exception
-        if  exception.message =~ /duplicate/i || exception.message =~ /ConstraintException/
-          ActiveSupport::Notifications.publish("duplicate_ignore.active_record", :exception => exception)
+      yield
+    rescue ActiveRecord::StatementInvalid, ActiveRecord::RecordNotUnique => exception
+      if  exception.message =~ /duplicate/i || exception.message =~ /ConstraintException/
+        ActiveSupport::Notifications.publish('duplicate_ignore.active_record', :exception => exception)
 
-          # Just ignore it...someone else has already created the record.
-        else
-          raise
-        end
+        # Just ignore it...someone else has already created the record.
+      else
+        raise
       end
     end
 
@@ -66,18 +58,16 @@ module ActiveRecord
       # Error examples:
       #   PG::Error: ERROR:  deadlock detected
       #   Mysql::Error: Deadlock found when trying to get lock
-      begin
-        yield
-      rescue ActiveRecord::StatementInvalid, ActiveRecord::RecordNotUnique => exception
-        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.active_record", :exception => exception)
+      yield
+    rescue ActiveRecord::StatementInvalid, ActiveRecord::RecordNotUnique => exception
+      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.active_record', :exception => exception)
 
-          retry
-        else
-          raise
-        end
+        retry
+      else
+        raise
       end
     end
   end
@@ -85,8 +75,6 @@ module ActiveRecord
   # Raise this inside a restartable_transaction to retry the transaction from the beginning.
   class RestartTransaction < RuntimeError
   end
-
 end
 
-
 ActiveRecord::Base.extend(ActiveRecord::LockingExtensions)

data/lib/active_record/locking_extensions/log_subscriber.rb

@@ -1,21 +1,21 @@
 # encoding: utf-8
-require "active_support/log_subscriber"
+require 'active_support/log_subscriber'
 
 module ActiveRecord
   module LockingExtensions
     class LogSubscriber < ActiveSupport::LogSubscriber
       def deadlock_restart(event)
-        info "Deadlock causing restart"
+        info 'Deadlock causing restart'
         debug event[:exception]
       end
 
       def deadlock_retry(event)
-        info "Deadlock causing retry"
+        info 'Deadlock causing retry'
         debug event[:exception]
       end
 
       def duplicate_ignore(event)
-        info "Duplicate ignored"
+        info 'Duplicate ignored'
         debug event[:exception]
       end
 

data/lib/double_entry.rb

@@ -23,9 +23,7 @@ require 'double_entry/validation'
 # This module provides the public interfaces for everything to do with
 # transferring money around the system.
 module DoubleEntry
-
   class << self
-
     # Get the particular account instance with the provided identifier and
     # scope.
     #

data/lib/double_entry/account.rb

@@ -1,7 +1,6 @@
 # encoding: utf-8
 module DoubleEntry
   class Account
-
     class << self
       attr_writer :accounts, :scope_identifier_max_length, :account_identifier_max_length
 
@@ -39,18 +38,18 @@ module DoubleEntry
       end
 
       def find(identifier, scoped)
-        account = detect do |account|
+        found_account = detect do |account|
           account.identifier == identifier && account.scoped? == scoped
         end
-        raise UnknownAccount.new("account: #{identifier} scoped?: #{scoped}") unless account
-        return account
+        fail UnknownAccount, "account: #{identifier} scoped?: #{scoped}" unless found_account
+        found_account
       end
 
       def <<(account)
         if any? { |a| a.identifier == account.identifier }
-          raise DuplicateAccount.new
+          fail DuplicateAccount
         else
-          super(account)
+          super
         end
       end
 
@@ -72,7 +71,7 @@ module DoubleEntry
           when String, Fixnum
             value
           else
-            raise AccountScopeMismatchError.new("Expected instance of `#{@active_record_class}`, received instance of `#{value.class}`")
+            fail AccountScopeMismatchError, "Expected instance of `#{@active_record_class}`, received instance of `#{value.class}`"
           end
         end
       end
@@ -115,8 +114,8 @@ module DoubleEntry
         self == other
       end
 
-      def <=>(account)
-        [scope_identity.to_s, identifier.to_s] <=> [account.scope_identity.to_s, account.identifier.to_s]
+      def <=>(other)
+        [scope_identity.to_s, identifier.to_s] <=> [other.scope_identity.to_s, other.identifier.to_s]
       end
 
       def hash
@@ -135,14 +134,13 @@ module DoubleEntry
         to_s
       end
 
-      private
+    private
 
       def ensure_scope_is_valid
         identity = scope_identity
         if identity && identity.length > Account.scope_identifier_max_length
-          raise ScopeIdentifierTooLongError.new(
-            "scope identifier '#{identity}' is too long. Please limit it to #{Account.scope_identifier_max_length} characters."
-          )
+          fail ScopeIdentifierTooLongError,
+               "scope identifier '#{identity}' is too long. Please limit it to #{Account.scope_identifier_max_length} characters."
         end
       end
     end
@@ -156,9 +154,8 @@ module DoubleEntry
       @negative_only = args[:negative_only]
       @currency = args[:currency] || Money.default_currency
       if identifier.length > Account.account_identifier_max_length
-        raise AccountIdentifierTooLongError.new(
-          "account identifier '#{identifier}' is too long. Please limit it to #{Account.account_identifier_max_length} characters."
-        )
+        fail AccountIdentifierTooLongError,
+             "account identifier '#{identifier}' is too long. Please limit it to #{Account.account_identifier_max_length} characters."
       end
     end
 

data/lib/double_entry/account_balance.rb

@@ -1,6 +1,5 @@
 # encoding: utf-8
 module DoubleEntry
-
   # Account balance records cache the current balance for each account. They
   # also provide a database representation of an account that we can use to do
   # DB level locking.
@@ -9,7 +8,6 @@ module DoubleEntry
   #
   # Account balances are created on demand when transfers occur.
   class AccountBalance < ActiveRecord::Base
-
     delegate :currency, :to => :account
 
     def balance
@@ -35,7 +33,5 @@ module DoubleEntry
       scope = scope.lock(true) if options[:lock]
       scope.first
     end
-
   end
-
 end