Class: Finrb::Transaction

Inherits:
Object
  • Object
show all
Defined in:
lib/finrb/transaction.rb,
sig/finrb.rbs

Overview

the Transaction class provides a general interface for working with individual cash flows.

Direct Known Subclasses

Interest, Payment

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(amount, opts = {}) ⇒ Transaction

create a new Transaction

Examples:

a simple transaction

t = Transaction.new(400)

a transaction with a period number

t = Transaction.new(400, :period => 3)

Parameters:

  • amount (Numeric) —

    the cash value of the transaction

  • opts (optional, Hash) (defaults to: {}) —

    sets optional attributes

  • (number)
  • (Hash[Symbol, untyped])

Options Hash (opts):

  • :period (String) —

    the period number of the transaction

Raises:

  • (ArgumentError) 


25
26
27
28
29
30
31
32
33
34
35
36
 
# File 'lib/finrb/transaction.rb', line 25

def initialize(amount, opts = {})
  raise(ArgumentError, 'options must be a Hash.') unless opts.is_a?(Hash)
  raise(ArgumentError, 'options may only contain date and period.') unless (opts.keys - %i[date period]).empty?

  self.amount = amount
  @original = @amount

  # Set optional attributes..
  opts.each do |key, value|
    __send__(:"#{key}=", value)
  end
end

Instance Attribute Details

#amount ⇒ Flt::DecNum

Returns the cash value of the transaction.

Returns:



9
10
11
 
# File 'lib/finrb/transaction.rb', line 9

def amount
  @amount
end

#date ⇒ Date

Returns the date of the transaction.

Returns:

  • (Date) —

    the date of the transaction



14
15
16
 
# File 'lib/finrb/transaction.rb', line 14

def date
  @date
end

#period ⇒ Integer

Note:

this attribute is mainly used in the case of mortgage amortization with no dates

Returns the period number of the transaction.

Returns:

  • (Integer) —

    the period number of the transaction



12
13
14
 
# File 'lib/finrb/transaction.rb', line 12

def period
  @period
end

Instance Method Details

#difference ⇒ Flt::DecNum

Returns the difference between the original transaction amount and the current amount.

Examples:

t = Transaction.new(500)
t.amount = 750
t.difference #=> Flt::DecNum('250')

Returns:

  • (Flt::DecNum) —

    the difference between the original transaction amount and the current amount



68
69
70
 
# File 'lib/finrb/transaction.rb', line 68

def difference
  @amount - @original
end

#inspect ⇒ String

Returns:

  • (String) 


82
83
84
 
# File 'lib/finrb/transaction.rb', line 82

def inspect
  "Transaction(#{@amount.round(2)}, date: #{@date})"
end

#interest? ⇒ Boolean

Returns whether or not the Transaction is an Interest transaction.

Examples:

pmt = Payment.new(500)
int = Interest.new(500)
pmt.interest? #=> False
int.interest? #=> True

Returns:

  • (Boolean) —

    whether or not the Transaction is an Interest transaction



78
79
80
 
# File 'lib/finrb/transaction.rb', line 78

def interest?
  instance_of?(Interest)
end

#modify {|arg0| ... } ⇒ Object

Note:

self is passed as the argument to the block. This makes any public attribute available.

Modify a Transaction's amount by passing a block

Examples:

add $100 to a monthly payment

pmt = Payment.new(-500)
pmt.modify { |t| t.amount-100 }
pmt.amount #=> -600

Yields:

Yield Parameters:

Yield Returns:

  • (number)

Returns:

  • none



93
94
95
 
# File 'lib/finrb/transaction.rb', line 93

def modify
  self.amount = yield(self)
end

#payment ⇒ Flt::DecNum

Deprecated.

Provided for backwards compatibility

Returns the cash value of the transaction.

Returns:



99
100
101
 
# File 'lib/finrb/transaction.rb', line 99

def payment
  @amount
end

#payment? ⇒ Boolean

Returns whether or not the Transaction is a Payment transaction.

Examples:

pmt = Payment.new(500)
int = Interest.new(500)
pmt.payment? #=> True
int.payment? #=> False

Returns:

  • (Boolean) —

    whether or not the Transaction is a Payment transaction



109
110
111
 
# File 'lib/finrb/transaction.rb', line 109

def payment?
  instance_of?(Payment)
end