finrb 0.1.0 → 0.1.2

data/lib/finrb/rates.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative "decimal"
+require_relative 'decimal'
 
 module Finrb
   # the Rate class provides an interface for working with interest rates.
@@ -8,6 +8,47 @@ module Finrb
   # @api public
   class Rate
     include Comparable
+    # Accepted rate types
+    TYPES = { apr: 'effective', apy: 'effective', effective: 'effective', nominal: 'nominal' }.freeze
+    public_constant :TYPES
+
+    # convert a nominal interest rate to an effective interest rate
+    # @return [Flt::DecNum] the effective interest rate
+    # @param [Numeric] rate the nominal interest rate
+    # @param [Numeric] periods the number of compounding periods per year
+    # @example
+    #   Rate.to_effective(0.05, 4) #=> Flt::DecNum('0.05095')
+    # @api public
+    def self.to_effective(rate, periods)
+      rate = Flt::DecNum.new(rate.to_s)
+      periods = Flt::DecNum.new(periods.to_s)
+
+      if periods.infinite?
+        rate.exp - 1
+      else
+        (((rate / periods) + 1)**periods) - 1
+      end
+    end
+
+    # convert an effective interest rate to a nominal interest rate
+    # @return [Flt::DecNum] the nominal interest rate
+    # @param [Numeric] rate the effective interest rate
+    # @param [Numeric] periods the number of compounding periods per year
+    # @example
+    #   Rate.to_nominal(0.06, 365) #=> Flt::DecNum('0.05827')
+    # @see https://www.miniwebtool.com/nominal-interest-rate-calculator/
+    # @api public
+    def self.to_nominal(rate, periods)
+      rate = Flt::DecNum.new(rate.to_s)
+      periods = Flt::DecNum.new(periods.to_s)
+
+      if periods.infinite?
+        (rate + 1).log
+      else
+        periods * (((rate + 1)**(1.to_f / periods)) - 1)
+      end
+    end
+
     # create a new Rate instance
     # @return [Rate]
     # @param [Numeric] rate the decimal value of the interest rate
@@ -26,33 +67,30 @@ module Finrb
 
       # Set optional attributes..
       opts.each do |key, value|
-        send("#{key}=", value)
+        __send__("#{key}=", value)
       end
 
       # Set the rate in the proper way, based on the value of type.
       begin
-        send("#{TYPES.fetch(type)}=", Flt::DecNum.new(rate.to_s))
+        __send__("#{TYPES.fetch(type)}=", Flt::DecNum.new(rate.to_s))
       rescue KeyError
         raise(ArgumentError, "type must be one of #{TYPES.keys.join(', ')}", caller)
       end
     end
 
-    # Accepted rate types
-    TYPES = { apr: "effective", apy: "effective", effective: "effective", nominal: "nominal" }.freeze
-
     # @return [Integer] the duration for which the rate is valid, in months
     # @api public
     attr_accessor :duration
-    # @return [DecNum] the effective interest rate
+    # @return [Flt::DecNum] the effective interest rate
     # @api public
     attr_reader :effective
-    # @return [DecNum] the nominal interest rate
+    # @return [Flt::DecNum] the nominal interest rate
     # @api public
     attr_reader :nominal
 
     # compare two Rates, using the effective rate
     # @return [Numeric] one of -1, 0, +1
-    # @param [Rate] rate the comparison Rate
+    # @param [Rate] other the comparison Rate
     # @example Which is better, a nominal rate of 15% compounded monthly, or 15.5% compounded semiannually?
     #   r1 = Rate.new(0.15, :nominal) #=> Rate.new(0.160755, :apr)
     #   r2 = Rate.new(0.155, :nominal, :compounds => :semiannually) #=> Rate.new(0.161006, :apr)
@@ -95,7 +133,7 @@ module Finrb
 
     # set the effective interest rate
     # @return none
-    # @param [DecNum] rate the effective interest rate
+    # @param [Flt::DecNum] rate the effective interest rate
     # @api private
     def effective=(rate)
       @effective = rate
@@ -106,11 +144,11 @@ module Finrb
       "Rate.new(#{apr.round(6)}, :apr)"
     end
 
-    # @return [DecNum] the monthly effective interest rate
+    # @return [Flt::DecNum] the monthly effective interest rate
     # @example
     #   rate = Rate.new(0.15, :nominal)
-    #   rate.apr.round(6) #=> DecNum('0.160755')
-    #   rate.monthly.round(6) #=> DecNum('0.013396')
+    #   rate.apr.round(6) #=> Flt::DecNum('0.160755')
+    #   rate.monthly.round(6) #=> Flt::DecNum('0.013396')
     # @api public
     def monthly
       (effective / 12).round(15)
@@ -118,50 +156,13 @@ module Finrb
 
     # set the nominal interest rate
     # @return none
-    # @param [DecNum] rate the nominal interest rate
+    # @param [Flt::DecNum] rate the nominal interest rate
     # @api private
     def nominal=(rate)
       @nominal = rate
       @effective = Rate.to_effective(rate, @periods)
     end
 
-    # convert a nominal interest rate to an effective interest rate
-    # @return [DecNum] the effective interest rate
-    # @param [Numeric] rate the nominal interest rate
-    # @param [Numeric] periods the number of compounding periods per year
-    # @example
-    #   Rate.to_effective(0.05, 4) #=> DecNum('0.05095')
-    # @api public
-    def self.to_effective(rate, periods)
-      rate = Flt::DecNum.new(rate.to_s)
-      periods = Flt::DecNum.new(periods.to_s)
-
-      if periods.infinite?
-        rate.exp - 1
-      else
-        ((1 + (rate / periods))**periods) - 1
-      end
-    end
-
-    # convert an effective interest rate to a nominal interest rate
-    # @return [DecNum] the nominal interest rate
-    # @param [Numeric] rate the effective interest rate
-    # @param [Numeric] periods the number of compounding periods per year
-    # @example
-    #   Rate.to_nominal(0.06, 365) #=> DecNum('0.05827')
-    # @see https://www.miniwebtool.com/nominal-interest-rate-calculator/
-    # @api public
-    def self.to_nominal(rate, periods)
-      rate = Flt::DecNum.new(rate.to_s)
-      periods = Flt::DecNum.new(periods.to_s)
-
-      if periods.infinite?
-        (rate + 1).log
-      else
-        periods * (((1 + rate)**(1 / periods)) - 1)
-      end
-    end
-
     private :compounds=, :effective=, :nominal=
   end
 end

data/lib/finrb/transaction.rb

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
-require_relative "decimal"
+require_relative 'decimal'
 
 module Finrb
   # the Transaction class provides a general interface for working with individual cash flows.
   # @api public
   class Transaction
-    # @return [DecNum] the cash value of the transaction
+    # @return [Flt::DecNum] the cash value of the transaction
     # @api public
     attr_reader :amount
     # @return [Integer] the period number of the transaction
@@ -33,7 +33,7 @@ module Finrb
 
       # Set optional attributes..
       opts.each do |key, value|
-        send("#{key}=", value)
+        __send__("#{key}=", value)
       end
     end
 
@@ -49,12 +49,12 @@ module Finrb
       @amount = Flt::DecNum.new(value.to_s) || 0
     end
 
-    # @return [DecNum] the difference between the original transaction
+    # @return [Flt::DecNum] the difference between the original transaction
     #   amount and the current amount
     # @example
     #   t = Transaction.new(500)
     #   t.amount = 750
-    #   t.difference #=> DecNum('250')
+    #   t.difference #=> Flt::DecNum('250')
     # @api public
     def difference
       @amount - @original