double_entry 0.10.3 → 1.0.0

data/spec/double_entry/reporting/line_aggregate_filter_spec.rb

@@ -0,0 +1,90 @@
+# encoding: utf-8
+RSpec.describe DoubleEntry::Reporting::LineAggregateFilter do
+  describe '.filter' do
+    let(:function) { :sum }
+    let(:account) { :account }
+    let(:code) { :transfer_code }
+    let(:filter_criteria) { nil }
+    let(:start) { Time.parse('2014-07-27 10:55:44 +1000') }
+    let(:finish) { Time.parse('2015-07-27 10:55:44 +1000') }
+    let(:range) do
+      instance_double(DoubleEntry::Reporting::MonthRange, :start  => start, :finish => finish)
+    end
+
+    let(:lines_scope) { spy(DoubleEntry::Line) }
+
+    subject(:filter) do
+      DoubleEntry::Reporting::LineAggregateFilter.new(account, code, range, filter_criteria)
+    end
+
+    before do
+      stub_const('DoubleEntry::Line', lines_scope)
+
+      allow(DoubleEntry::LineMetadata).to receive(:table_name).and_return('double_entry_line_metadata')
+
+      allow(lines_scope).to receive(:where).and_return(lines_scope)
+      allow(lines_scope).to receive(:joins).and_return(lines_scope)
+      allow(lines_scope).to receive(:ten_dollar_purchases).and_return(lines_scope)
+      allow(lines_scope).to receive(:ten_dollar_purchases_by_category).and_return(lines_scope)
+
+      filter.filter
+    end
+
+    context 'with named scopes specified' do
+      let(:filter_criteria) do
+        [
+          # an example of calling a named scope called with arguments
+          {
+            :scope => {
+              :name => :ten_dollar_purchases_by_category,
+              :arguments => [:cat_videos, :cat_pictures],
+            },
+          },
+          # an example of calling a named scope with no arguments
+          {
+            :scope => {
+              :name => :ten_dollar_purchases,
+            },
+          },
+          # an example of providing a single metadatum criteria to filter on
+          {
+            :metadata => {
+              :meme => 'business_cat',
+            },
+          },
+        ]
+      end
+
+      it 'filters by all the scopes provided' do
+        expect(DoubleEntry::Line).to have_received(:ten_dollar_purchases)
+        expect(DoubleEntry::Line).to have_received(:ten_dollar_purchases_by_category).
+          with(:cat_videos, :cat_pictures)
+      end
+
+      it 'filters by all the metadata provided' do
+        expect(DoubleEntry::Line).to have_received(:joins).with(:metadata)
+        expect(DoubleEntry::Line).to have_received(:where).
+          with(:double_entry_line_metadata => { :key => :meme, :value => 'business_cat' })
+      end
+    end
+
+    context 'with a code specified' do
+      let(:code) { :transfer_code }
+
+      it 'retrieves the appropriate lines for aggregation' do
+        expect(DoubleEntry::Line).to have_received(:where).with(:account => account)
+        expect(DoubleEntry::Line).to have_received(:where).with(:created_at => start..finish)
+        expect(DoubleEntry::Line).to have_received(:where).with(:code => code)
+      end
+    end
+
+    context 'with no code specified' do
+      let(:code) { nil }
+
+      it 'retrieves the appropriate lines for aggregation' do
+        expect(DoubleEntry::Line).to have_received(:where).with(:account => account)
+        expect(DoubleEntry::Line).to have_received(:where).with(:created_at => start..finish)
+      end
+    end
+  end
+end

data/spec/double_entry/reporting/line_aggregate_spec.rb

@@ -1,11 +1,39 @@
 # encoding: utf-8
-module DoubleEntry
-  module Reporting
-    RSpec.describe LineAggregate do
-      describe '.table_name' do
-        subject { LineAggregate.table_name }
-        it { should eq('double_entry_line_aggregates') }
-      end
+RSpec.describe DoubleEntry::Reporting::LineAggregate do
+  describe '.table_name' do
+    subject { DoubleEntry::Reporting::LineAggregate.table_name }
+    it { should eq('double_entry_line_aggregates') }
+  end
+
+  describe '#aggregate' do
+    let(:line_relation) { spy }
+    let(:filter) do
+      instance_double(DoubleEntry::Reporting::LineAggregateFilter, :filter => line_relation)
+    end
+
+    let(:function) { :sum }
+    let(:account) { spy }
+    let(:code) { spy }
+    let(:named_scopes) { spy }
+    let(:range) { spy }
+
+    subject(:aggregate) do
+      DoubleEntry::Reporting::LineAggregate.aggregate(function, account, code, range, named_scopes)
+    end
+
+    before do
+      allow(DoubleEntry::Reporting::LineAggregateFilter).to receive(:new).and_return(filter)
+      aggregate
+    end
+
+    it 'applies the specified filters' do
+      expect(DoubleEntry::Reporting::LineAggregateFilter).to have_received(:new).
+        with(account, code, range, named_scopes)
+      expect(filter).to have_received(:filter)
+    end
+
+    it 'performs the aggregation on the filtered lines' do
+      expect(line_relation).to have_received(:sum).with(:amount)
     end
   end
 end

data/spec/double_entry/reporting_spec.rb

@@ -42,4 +42,140 @@ RSpec.describe DoubleEntry::Reporting do
       end
     end
   end
+
+  describe '::aggregate' do
+    before do
+      # get rid of "helpful" predefined config
+      @config_accounts  = DoubleEntry.configuration.accounts
+      @config_transfers = DoubleEntry.configuration.transfers
+      DoubleEntry.configuration.accounts  = DoubleEntry::Account::Set.new
+      DoubleEntry.configuration.transfers = DoubleEntry::Transfer::Set.new
+
+      DoubleEntry.configure do |config|
+        config.define_accounts do |accounts|
+          accounts.define(:identifier => :savings)
+          accounts.define(:identifier => :cash)
+          accounts.define(:identifier => :credit)
+        end
+
+        config.define_transfers do |transfers|
+          transfers.define(:from => :savings, :to => :cash,    :code => :spend)
+          transfers.define(:from => :cash,    :to => :savings, :code => :save)
+          transfers.define(:from => :cash,    :to => :credit,  :code => :bill)
+        end
+      end
+
+      cash    = DoubleEntry.account(:cash)
+      savings = DoubleEntry.account(:savings)
+      credit  = DoubleEntry.account(:credit)
+      DoubleEntry.transfer(Money.new(10_00), :from => cash,    :to => savings, :code => :save, :metadata => { :reason => 'payday' })
+      DoubleEntry.transfer(Money.new(10_00), :from => cash,    :to => savings, :code => :save, :metadata => { :reason => 'payday' })
+      DoubleEntry.transfer(Money.new(20_00), :from => cash,    :to => savings, :code => :save)
+      DoubleEntry.transfer(Money.new(20_00), :from => cash,    :to => savings, :code => :save)
+      DoubleEntry.transfer(Money.new(30_00), :from => cash,    :to => credit,  :code => :bill)
+      DoubleEntry.transfer(Money.new(40_00), :from => cash,    :to => credit,  :code => :bill)
+      DoubleEntry.transfer(Money.new(50_00), :from => savings, :to => cash,    :code => :spend)
+      DoubleEntry.transfer(Money.new(60_00), :from => savings, :to => cash,    :code => :spend, :metadata => { :category => 'entertainment' })
+    end
+
+    after do
+      # restore "helpful" predefined config
+      DoubleEntry.configuration.accounts  = @config_accounts
+      DoubleEntry.configuration.transfers = @config_transfers
+    end
+
+    describe 'filter solely on transaction identifiers and time' do
+      let(:function) { :sum }
+      let(:account) { :savings }
+      let(:code) { :save }
+      let(:range) { DoubleEntry::Reporting::MonthRange.current }
+
+      subject(:aggregate) do
+        DoubleEntry::Reporting.aggregate(function, account, code, range)
+      end
+
+      specify 'Total attempted to save' do
+        expect(aggregate).to eq(Money.new(60_00))
+      end
+    end
+
+    describe 'filter by named scope that does not take arguments' do
+      let(:function) { :sum }
+      let(:account) { :savings }
+      let(:code) { :save }
+      let(:range) { DoubleEntry::Reporting::MonthRange.current }
+
+      subject(:aggregate) do
+        DoubleEntry::Reporting.aggregate(
+          function, account, code, range,
+          :filter => [
+            :scope => {
+              :name => :ten_dollar_transfers,
+            },
+          ]
+        )
+      end
+
+      before do
+        DoubleEntry::Line.class_eval do
+          scope :ten_dollar_transfers, -> { where(:amount => Money.new(10_00).fractional) }
+        end
+      end
+
+      specify 'Total amount of $10 transfers attempted to save' do
+        expect(aggregate).to eq(Money.new(20_00))
+      end
+    end
+
+    describe 'filter by named scope that takes arguments' do
+      let(:function) { :sum }
+      let(:account) { :savings }
+      let(:code) { :save }
+      let(:range) { DoubleEntry::Reporting::MonthRange.current }
+
+      subject(:aggregate) do
+        DoubleEntry::Reporting.aggregate(
+          function, account, code, range,
+          :filter => [
+            :scope => {
+              :name      => :specific_transfer_amount,
+              :arguments => [Money.new(20_00)],
+            },
+          ]
+        )
+      end
+
+      before do
+        DoubleEntry::Line.class_eval do
+          scope :specific_transfer_amount, ->(amount) { where(:amount => amount.fractional) }
+        end
+      end
+
+      specify 'Total amount of transfers of $20 attempted to save' do
+        expect(aggregate).to eq(Money.new(40_00))
+      end
+    end
+
+    describe 'filter by metadata' do
+      let(:function) { :sum }
+      let(:account) { :savings }
+      let(:code) { :save }
+      let(:range) { DoubleEntry::Reporting::MonthRange.current }
+
+      subject(:aggregate) do
+        DoubleEntry::Reporting.aggregate(
+          function, account, code, range,
+          :filter => [
+            :metadata => {
+              :reason => 'payday',
+            },
+          ]
+        )
+      end
+
+      specify 'Total amount of transfers saved because payday' do
+        expect(aggregate).to eq(Money.new(20_00))
+      end
+    end
+  end
 end

data/spec/double_entry/transfer_spec.rb

@@ -17,13 +17,70 @@ module DoubleEntry
       end
     end
 
+    describe '::transfer' do
+      let(:amount)  { Money.new(10_00) }
+      let(:user)    { User.make! }
+      let(:test)    { DoubleEntry.account(:test, :scope => user) }
+      let(:savings) { DoubleEntry.account(:savings, :scope => user) }
+      let(:new_lines) { Line.all[-2..-1] }
+
+      subject(:transfer) { Transfer.transfer(amount, options) }
+
+      context 'without metadata' do
+        let(:options) { { :from => test, :to => savings, :code => :bonus } }
+
+        it 'creates lines' do
+          expect { transfer }.to change { Line.count }.by 2
+        end
+
+        it 'does not create metadata lines' do
+          expect { transfer }.not_to change { LineMetadata.count }
+        end
+      end
+
+      context 'with metadata' do
+        let(:options) { { :from => test, :to => savings, :code => :bonus, :metadata => { :country => 'AU', :tax => 'GST' } } }
+        let(:new_metadata) { LineMetadata.all[-4..-1] }
+
+        it 'creates metadata lines' do
+          expect { transfer }.to change { LineMetadata.count }.by 4
+        end
+
+        it 'associates the metadata lines with the transfer lines' do
+          transfer
+          expect(new_metadata.count { |meta| meta.line == new_lines.first }).to be 2
+          expect(new_metadata.count { |meta| meta.line == new_lines.last }).to be 2
+        end
+
+        it 'stores the first key/value pair' do
+          transfer
+          countries = new_metadata.select { |meta| meta.key == :country }
+          expect(countries.size).to be 2
+          expect(countries.count { |meta| meta.value == 'AU' }).to be 2
+        end
+
+        it 'associates the first key/value pair with both lines' do
+          transfer
+          countries = new_metadata.select { |meta| meta.key == :country }
+          expect(countries.map(&:line).uniq.size).to be 2
+        end
+
+        it 'stores another key/value pair' do
+          transfer
+          taxes = new_metadata.select { |meta| meta.key == :tax }
+          expect(taxes.size).to be 2
+          expect(taxes.count { |meta| meta.value == 'GST' }).to be 2
+        end
+      end
+    end
+
     describe Transfer::Set do
       describe '#define' do
         before do
           subject.define(
             :code => 'code',
             :from => double(:identifier => 'from'),
-            :to => double(:identifier => 'to'),
+            :to   => double(:identifier => 'to'),
           )
         end
         its(:first) { should be_a Transfer }

data/spec/support/performance_helper.rb

@@ -0,0 +1,26 @@
+module PerformanceHelper
+  require 'ruby-prof'
+
+  def start_profiling(measure_mode = RubyProf::PROCESS_TIME)
+    RubyProf.measure_mode = measure_mode
+    RubyProf.start
+  end
+
+  def stop_profiling(profile_name = nil)
+    result = RubyProf.stop
+    puts "#{profile_name} Time: #{format('%#.3g', total_time(result))}s"
+    unless ENV.fetch('CI', false)
+      if profile_name
+        outdir = './profiles'
+        Dir.mkdir(outdir) unless Dir.exist?(outdir)
+        printer = RubyProf::MultiPrinter.new(result)
+        printer.print(:path => outdir, :profile => profile_name)
+      end
+    end
+    result
+  end
+
+  def total_time(result)
+    result.threads.inject(0) { |time, thread| time + thread.total_time }
+  end
+end

data/spec/support/schema.rb

@@ -55,6 +55,15 @@ ActiveRecord::Schema.define do
     t.timestamps                 :null => false
   end
 
+  create_table "double_entry_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 "double_entry_line_metadata", ["line_id", "key", "value"], :name => "lines_meta_line_id_key_value_idx"
+
   # test table only
   create_table "users", :force => true do |t|
     t.string     "username", :null => false

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: double_entry
 version: !ruby/object:Gem::Version
-  version: 0.10.3
+  version: 1.0.0
 platform: ruby
 authors:
 - Anthony Sellitti
@@ -15,7 +15,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-15 00:00:00.000000000 Z
+date: 2015-08-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: money
@@ -241,6 +241,90 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.32.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-doc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-stack_explorer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ruby-prof
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email:
 - anthony.sellitti@envato.com
@@ -275,6 +359,7 @@ files:
 - lib/double_entry/configuration.rb
 - lib/double_entry/errors.rb
 - lib/double_entry/line.rb
+- lib/double_entry/line_metadata.rb
 - lib/double_entry/locking.rb
 - lib/double_entry/reporting.rb
 - lib/double_entry/reporting/aggregate.rb
@@ -282,6 +367,7 @@ files:
 - lib/double_entry/reporting/day_range.rb
 - lib/double_entry/reporting/hour_range.rb
 - lib/double_entry/reporting/line_aggregate.rb
+- lib/double_entry/reporting/line_aggregate_filter.rb
 - lib/double_entry/reporting/month_range.rb
 - lib/double_entry/reporting/time_range.rb
 - lib/double_entry/reporting/time_range_array.rb
@@ -302,8 +388,11 @@ files:
 - spec/double_entry/configuration_spec.rb
 - spec/double_entry/line_spec.rb
 - spec/double_entry/locking_spec.rb
+- spec/double_entry/performance/double_entry_performance_spec.rb
+- spec/double_entry/performance/reporting/aggregate_performance_spec.rb
 - spec/double_entry/reporting/aggregate_array_spec.rb
 - spec/double_entry/reporting/aggregate_spec.rb
+- spec/double_entry/reporting/line_aggregate_filter_spec.rb
 - spec/double_entry/reporting/line_aggregate_spec.rb
 - spec/double_entry/reporting/month_range_spec.rb
 - spec/double_entry/reporting/time_range_array_spec.rb
@@ -323,12 +412,38 @@ files:
 - spec/support/gemfiles/Gemfile.rails-3.2.x
 - spec/support/gemfiles/Gemfile.rails-4.1.x
 - spec/support/gemfiles/Gemfile.rails-4.2.x
+- spec/support/performance_helper.rb
 - spec/support/reporting_configuration.rb
 - spec/support/schema.rb
 homepage: https://github.com/envato/double_entry
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message: |
+  Please note the following changes in DoubleEntry:
+   - New table `double_entry_line_metadata` has been introduced and is *required* for
+     aggregate reporting filtering to work. Existing applications must manually manage
+     this change via a migration similar to the following:
+
+      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
+
+    Please ensure that you update your database accordingly.
 rdoc_options: []
 require_paths:
 - lib
@@ -344,7 +459,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Tools to build your double entry financial ledger
@@ -356,8 +471,11 @@ test_files:
 - spec/double_entry/configuration_spec.rb
 - spec/double_entry/line_spec.rb
 - spec/double_entry/locking_spec.rb
+- spec/double_entry/performance/double_entry_performance_spec.rb
+- spec/double_entry/performance/reporting/aggregate_performance_spec.rb
 - spec/double_entry/reporting/aggregate_array_spec.rb
 - spec/double_entry/reporting/aggregate_spec.rb
+- spec/double_entry/reporting/line_aggregate_filter_spec.rb
 - spec/double_entry/reporting/line_aggregate_spec.rb
 - spec/double_entry/reporting/month_range_spec.rb
 - spec/double_entry/reporting/time_range_array_spec.rb
@@ -377,5 +495,7 @@ test_files:
 - spec/support/gemfiles/Gemfile.rails-3.2.x
 - spec/support/gemfiles/Gemfile.rails-4.1.x
 - spec/support/gemfiles/Gemfile.rails-4.2.x
+- spec/support/performance_helper.rb
 - spec/support/reporting_configuration.rb
 - spec/support/schema.rb
+has_rdoc: