Class: DoubleEntry::Line

Inherits:
ActiveRecord::Base
  • Object
show all
Extended by:
EncapsulateAsMoney
Defined in:
lib/double_entry/line.rb

Overview

This is the table to end all tables!

Every financial transaction gets two entries in here: one for the source account, and one for the destination account. Normal double-entry accounting principles are followed.

This is a log table, and should (ideally) never be updated.

Indexes

The indexes on this table are carefully chosen, as it's both big and heavily loaded.

lines_scope_account_id_idx

ADD INDEX `lines_scope_account_id_idx` (scope, account, id)

This is the important one. It's used primarily for querying the current balance of an account. eg:

SELECT * FROM `lines` WHERE scope = ? AND account = ? ORDER BY id DESC LIMIT 1

lines_scope_account_created_at_idx

ADD INDEX `lines_scope_account_created_at_idx` (scope, account, created_at)

Used for querying historic balances:

SELECT * FROM `lines` WHERE scope = ? AND account = ? AND created_at < ? ORDER BY id DESC LIMIT 1

And for reporting on account changes over a time period:

SELECT SUM(amount) FROM `lines` WHERE scope = ? AND account = ? AND created_at BETWEEN ? AND ?

lines_account_created_at_idx and lines_account_code_created_at_idx

ADD INDEX `lines_account_created_at_idx` (account, created_at);
ADD INDEX `lines_account_code_created_at_idx` (account, code, created_at);

These two are used for generating reports, which need to sum things by account, or account and code, over a particular period.

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.find_id_and_created_at(options) ⇒ Object

Query out just the id and created_at fields for lines, without instantiating any ActiveRecord objects.



127
128
129
130
131
132
 
# File 'lib/double_entry/line.rb', line 127

def self.find_id_and_created_at(options)
  connection.select_rows <<-SQL
    SELECT id, created_at FROM #{Line.quoted_table_name} #{options[:joins]}
     WHERE #{sanitize_sql_for_conditions(options[:conditions])}
  SQL
end

Instance Method Details

#account ⇒ Object 



91
92
93
 
# File 'lib/double_entry/line.rb', line 91

def 
  DoubleEntry.(self[:account].to_sym, :scope => scope)
end

#account=(account) ⇒ Object 



85
86
87
88
89
 
# File 'lib/double_entry/line.rb', line 85

def account=()
  self[:account] = .identifier.to_s
  self.scope = .scope_identity
  
end

#code ⇒ Object 



71
72
73
 
# File 'lib/double_entry/line.rb', line 71

def code
  self[:code].try(:to_sym)
end

#code=(code) ⇒ Object 



66
67
68
69
 
# File 'lib/double_entry/line.rb', line 66

def code=(code)
  self[:code] = code.try(:to_s)
  code
end

#credit? ⇒ Boolean

Returns:

  • (Boolean) 


117
118
119
 
# File 'lib/double_entry/line.rb', line 117

def credit?
  amount < Money.empty
end

#debit? ⇒ Boolean

Returns:

  • (Boolean) 


121
122
123
 
# File 'lib/double_entry/line.rb', line 121

def debit?
  amount > Money.empty
end

#meta ⇒ Object 



80
81
82
83
 
# File 'lib/double_entry/line.rb', line 80

def meta
  meta = self[:meta]
  meta ? Marshal.load(meta) : {}
end

#meta=(meta) ⇒ Object 



75
76
77
78
 
# File 'lib/double_entry/line.rb', line 75

def meta=(meta)
  self[:meta] = Marshal.dump(meta)
  meta
end

#pair ⇒ Object 



109
110
111
112
113
114
115
 
# File 'lib/double_entry/line.rb', line 109

def pair
  if credit?
    [self, partner]
  else
    [partner, self]
  end
end

#partner ⇒ Object 



105
106
107
 
# File 'lib/double_entry/line.rb', line 105

def partner
  self.class.find(partner_id)
end

#partner_account ⇒ Object 



101
102
103
 
# File 'lib/double_entry/line.rb', line 101

def 
  DoubleEntry.(self[:partner_account].to_sym, :scope => partner_scope)
end

#partner_account=(partner_account) ⇒ Object 



95
96
97
98
99
 
# File 'lib/double_entry/line.rb', line 95

def partner_account=()
  self[:partner_account] = .identifier.to_s
  self.partner_scope = .scope_identity
  
end