financier 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4acef944cf6ffbdc5c777c207d0a240728b4294f241604e2a27e1b54b4da49c7
+  data.tar.gz: 78d3272877b1ea47b9ef04c62d61cd8920f41c2a2a36f56764a161cb48045e69
+SHA512:
+  metadata.gz: d44ff1f921631eb820a2c8a594c1c1dc85ceb81876f96b143a88611ba213c081bffb341d4e7ce84f976d9c669b22f7202d84e772e98d7cead012e4a3fca26271
+  data.tar.gz: 4bbd19def0055a54d7fb67ad4eabbe5c5e37ec1cd4d7bdf632578b821ea2187b5de01122f753e3a57c5dfd77c0ad8bbaaf48cc774fef0469976d7767ae397c89

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.idea
+/.yardoc
+/_yardoc/
+/.vscode/
+
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+*.gem
+*.swp
+
+Gemfile.lock

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.2
+before_install: gem install bundler -v 2.0.1

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Ethan Barron
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,39 @@
+# Financier
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/financier`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'financier'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install financier
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake rpsec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/financier.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require 'rake'
+require 'rake/clean'
+require 'rspec/core/rake_task'
+require 'bundler/gem_tasks'
+
+task default: :spec
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.fail_on_error = true
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "financier"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/financier

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+
+require "financier"

data/financier.gemspec

@@ -0,0 +1,48 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'financier/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'financier'
+  spec.version       = Financier::VERSION
+  spec.authors       = ['Ethan Barron']
+  spec.email         = ['ethan.barron@kalidy.com']
+
+  spec.summary       = 'Provides handy financial calculators.'
+  spec.description   = 'Ruby gem to deal with financial calculations.'
+  spec.homepage      = 'https://rubygems.org/gems/financier'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = 'https://github.com/Inkybro/financier'
+    # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0")
+  end
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+  spec.bindir        = 'exe'
+
+  spec.add_dependency 'activesupport', '>= 5.2.3'
+  spec.add_dependency 'chronic', '>= 0.10.2'
+  spec.add_dependency 'flt', '>= 1.5.0'
+
+  spec.add_development_dependency 'bundler', '~> 2.0.1'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '>= 3.8.0'
+  spec.add_development_dependency 'rubocop', '~> 0.67.2'
+end

data/lib/financier/amortization.rb

@@ -0,0 +1,138 @@
+module Financier
+  class Amortization
+    class << self
+      def payment(principal, rate, periods)
+        principal, rate, periods = [D(principal.to_s), D(rate.to_s), D(periods.to_s)]
+
+        return -(principal / periods).round(2) if rate.zero?
+
+        -(principal * (rate + (rate / ((1 + rate) ** periods - 1)))).round(2)
+      end
+
+      def interest(principal, rate)
+        (D(principal.to_s) * D(rate.to_s))
+      end
+    end
+
+    #attr_reader :principal, :rate, :closing_date, :first_payment_due
+    attr_reader :payment, :closing_date, :first_payment_due, :ledger
+
+    def initialize(principal, rate, closing_date: nil, first_payment_due: nil)
+      @principal = Flt::DecNum.new(principal.to_s)
+      @rate = rate
+
+      self.closing_date = closing_date || Time.now
+      self.first_payment_due = first_payment_due || (@closing_date + 30.days)
+
+      #@periods = rate.duration
+      #@period = 0
+
+      compute
+    end
+
+    def balance
+      return unless @ledger
+      @ledger.balance
+    end
+
+    def payments
+      return unless @ledger
+      @ledger.debits
+    end
+
+    def interest
+      return unless @ledger
+      @ledger.credits[1..(@ledger.credits.length - 1)]
+    end
+
+    def closing_date=(value)
+      @closing_date = Date[value]
+    end
+
+    def first_payment_due=(value)
+      @first_payment_due = Date[value]
+    end
+
+    def amortize
+      @payment = Amortization.payment(@principal + interim_interest, @rate.monthly, @rate.duration)
+      @ledger = Ledger.new(@principal)
+
+      current_date = @first_payment_due
+
+      @rate.duration.to_i.times do |period|
+        break if @ledger.balance.zero?
+
+        int = @ledger.balance * @rate.monthly
+        int += interim_interest * (1 + @rate.monthly) if period === 0
+        @ledger << Transaction.new(int.round(2), current_date)
+
+        pmt = @payment.abs <= @ledger.balance ? @payment : -@ledger.balance
+        @ledger << Transaction.new(pmt, current_date)
+
+        current_date += 1.month
+      end
+
+      @ledger.debits.last.amount -= @ledger.balance unless @ledger.balance.zero?
+    end
+
+    def compute
+      amortize
+    end
+
+    def schedule
+      @schedule = {}
+
+      @schedule[closing_date] = {
+        payment: 0.0,
+        interest: 0.0,
+        principal: 0.0,
+        balance: @principal.round(2).to_f
+      }
+
+      payments.each_with_index do |payment, index|
+        interest = self.interest[index]
+
+        pmt = payment.amount.abs.round(2).to_f
+        int = interest.amount.abs.round(2).to_f
+        princ = (pmt - int).round(2).to_f
+        bal = @ledger.balance(before: payment.date + 1.day).round(2).to_f
+
+        @schedule[payment.date] = {
+          payment: pmt,
+          interest: int,
+          principal: princ,
+          balance: bal
+        }
+      end
+
+      @schedule
+    end
+
+    private
+
+    def interim_interest
+      return D('0') if @closing_date == @first_payment_due
+      return D('0') if @closing_date == (@first_payment_due - 30.days)
+
+      Amortization.interest(@principal, @rate.daily) * interim_days
+    end
+
+    def interim_days
+      return D('0') if @first_payment_due == @closing_date
+
+      odd_days = (@first_payment_due - 30.days - @closing_date).to_i
+
+      raise NotImplementedError, "Short periods are not yet implemented!" unless odd_days >= 0
+
+      odd_days.positive? ? odd_days : (30 + odd_days) - 30
+    end
+  end
+end
+
+class Numeric
+  # @see Amortization#new
+  # @api public
+  def amortize(rate, opt = {})
+    Financier::Amortization.new(self, opt)
+  end
+end

data/lib/financier/date.rb

@@ -0,0 +1,13 @@
+module Financier
+  module Date
+    def self.[](value, default = nil)
+      return default unless value
+
+      return value if value.is_a?(::Date)
+      
+      return value.to_date if value.is_a?(Time)
+
+      Chronic.parse(value.to_s).to_date
+    end
+  end
+end

data/lib/financier/ledger.rb

@@ -0,0 +1,50 @@
+module Financier
+  class Ledger
+    attr_reader :transactions
+
+    def initialize(*transactions)
+      send(:transactions=, *transactions)
+    end
+
+    def transactions=(*transactions)
+      @transactions = []
+      transactions.flatten.each do |transaction|
+        send(:<<, transaction)
+      end
+      @transactions
+    end
+
+    def <<(transaction)
+      transaction = Transaction.new(transaction.to_s) unless
+        transaction.is_a?(Transaction)
+
+      @transactions << transaction
+      @transactions.sort {|a, b| a.date <=> b.date }
+
+      transaction
+    end
+    alias_method :push, :<<
+
+    def credits
+      transactions.select(&:credit?)
+    end
+
+    def debits
+      transactions.select(&:debit?)
+    end
+
+    def balance(before: nil, after: nil, between: nil, within: nil)
+      transactions_to_sum = transactions.dup
+
+      between = (within.first - 1.day)..(within.last + 1.day) if within
+      after, before = [between.first, between.last] if between
+      transactions_to_sum.select! { |t| t.before?(before) } if before
+      transactions_to_sum.select! { |t| t.after?(after) } if after
+
+      transactions_to_sum
+        .collect(&:amount)
+        .sum
+        .round(2)
+    end
+  end
+end

data/lib/financier/rate.rb

@@ -0,0 +1,148 @@
+module Financier
+  class Rate
+    class << self
+      def to_effective(rate, periods)
+        rate, periods = Flt::DecNum.new(rate.to_s), Flt::DecNum.new(periods.to_s)
+
+        return rate.exp - 1 if periods.infinite?
+
+        (1 + rate / periods) ** periods - 1
+      end
+
+      def to_nominal(rate, periods)
+        rate, periods = Flt::DecNum.new(rate.to_s), Flt::DecNum.new(periods.to_s)
+
+        return (rate + 1).log if periods.infinite?
+
+        periods * ((1 + rate) ** (1 / periods) - 1)
+      end
+    end
+
+    include Comparable
+
+    # Accepted rate types
+    TYPES = { :apr       => "effective",
+              :apy       => "effective",
+              :effective => "effective",
+              :nominal   => "nominal"
+            }
+
+    # @return [Integer] the duration for which the rate is valid, in months
+    # @api public
+    attr_accessor :duration
+    # @return [DecNum] the effective interest rate
+    # @api public
+    attr_reader :effective
+    # @return [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
+    # @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)
+    #   r1 <=> r2 #=> -1
+    # @api public
+    def <=>(rate)
+      @effective <=> rate.effective
+    end
+
+    # (see #effective)
+    # @api public
+    def apr
+      self.effective
+    end
+
+    # (see #effective)
+    # @api public
+    def apy
+      self.effective
+    end
+
+    # a convenience method which sets the value of @periods
+    # @return none
+    # @param [Symbol, Numeric] input the compounding frequency
+    # @raise [ArgumentError] if input is not an accepted keyword or Numeric
+    # @api private
+    def compounds=(input)
+      @periods = case input
+                 when :annually     then Flt::DecNum.new(1)
+                 when :continuously then Flt::DecNum.infinity
+                 when :daily        then Flt::DecNum.new(365)
+                 when :monthly      then Flt::DecNum.new(12)
+                 when :quarterly    then Flt::DecNum.new(4)
+                 when :semiannually then Flt::DecNum.new(2)
+                 when Numeric       then Flt::DecNum.new(input.to_s)
+                 else raise ArgumentError
+                 end
+    end
+
+    # set the effective interest rate
+    # @return none
+    # @param [DecNum] rate the effective interest rate
+    # @api private
+    def effective=(rate)
+      @effective = Flt::DecNum.new(rate.to_s)
+      @nominal = Rate.to_nominal(rate, @periods)
+    end
+
+    # create a new Rate instance
+    # @return [Rate]
+    # @param [Numeric] rate the decimal value of the interest rate
+    # @param [Symbol] type a valid {TYPES rate type}
+    # @param [optional, Hash] opts set optional attributes
+    # @option opts [String] :duration a time interval for which the rate is valid
+    # @option opts [String] :compounds (:monthly) the number of compounding periods per year
+    # @example create a 3.5% APR rate
+    #   Rate.new(0.035, :apr) #=> Rate(0.035, :apr)
+    # @see http://en.wikipedia.org/wiki/Effective_interest_rate
+    # @see http://en.wikipedia.org/wiki/Nominal_interest_rate
+    # @api public
+    def initialize(rate, type, opts={})
+      # Default monthly compounding.
+      opts = { :compounds => :monthly }.merge opts
+
+      # Set optional attributes..
+      opts.each do |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))
+      rescue KeyError
+        raise ArgumentError, "type must be one of #{TYPES.keys.join(', ')}", caller
+      end
+    end
+
+    def inspect
+      "Rate.new(#{self.apr.round(6)}, :apr)"
+    end
+
+    # @return [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')
+    # @api public
+    def monthly
+      (self.effective / 12).round(15)
+    end
+
+    def daily
+      # TODO - Add spec
+      (self.effective / 360).round(15)
+    end
+
+    # set the nominal interest rate
+    # @return none
+    # @param [DecNum] rate the nominal interest rate
+    # @api private
+    def nominal=(rate)
+      @nominal = Flt::DecNum.new(rate.to_s)
+      @effective = Rate.to_effective(rate, @periods)
+    end
+  end
+end

data/lib/financier/transaction.rb

@@ -0,0 +1,47 @@
+module Financier
+  class Transaction
+    attr_reader :amount
+    attr_reader :date
+
+    def initialize(amount, date = Date[Time.now])
+      send(:amount=, amount)
+      send(:date=, date)
+    end
+
+    def amount=(value)
+      @amount = Flt::DecNum.new(value.to_s).round(2)
+    end
+
+    def credit?
+      amount.positive?
+    end
+
+    def date=(value)
+      @date = value.to_date
+    end
+
+    def on?(other_date)
+      date === other_date.to_date
+    end
+
+    def before?(other_date)
+      date < other_date.to_date
+    end
+
+    def after?(other_date)
+      date > other_date.to_date
+    end
+
+    def debit?
+      amount.negative?
+    end
+
+    def zero?
+      amount.zero?
+    end
+
+    def to_s
+      amount.to_s
+    end
+  end
+end

data/lib/financier/version.rb

@@ -0,0 +1,3 @@
+module Financier
+  VERSION = '0.1.0'
+end

data/lib/financier.rb

@@ -0,0 +1,15 @@
+require 'active_support/all'
+require 'chronic'
+require 'flt'
+require 'flt/d'
+
+require 'financier/amortization'
+require 'financier/date'
+require 'financier/ledger'
+require 'financier/rate'
+require 'financier/transaction'
+require 'financier/version'
+
+module Financier
+  class Error < StandardError; end
+end

data/spec/financier/amortization_spec.rb

@@ -0,0 +1,11 @@
+require_relative '../spec_helper'
+
+describe Financier::Amortization do
+  describe 'payments' do
+    context 'no odd days' do
+      it 'calculates the monthly payment' do
+        expect(Financier::Amortization.payment(10000, (0.1499 / 12), 84)).to eq(-192.91)
+      end
+    end
+  end
+end

data/spec/financier/date_spec.rb

@@ -0,0 +1,28 @@
+require_relative '../spec_helper'
+
+describe Financier::Date do
+  let(:date_string) { Time.now.strftime('%Y-%m-%d') }
+  let(:date) { ::Date.today }
+  let(:time) { Time.now }
+
+  it 'parses dates from strings' do
+    expect(Financier::Date[date_string]).to be_a(::Date)
+    expect(Financier::Date[date_string]).to eq(::Date.today)
+  end
+
+  it 'parses dates from dates' do
+    expect(Financier::Date[date]).to be_a(::Date)
+  end
+
+  it 'parses dates from times' do
+    expect(Financier::Date[time]).to be_a(::Date)
+  end
+
+  it 'returns nil for nil values by default' do
+    expect(Financier::Date[nil]).to be(nil)
+  end
+
+  it 'returns specified default for nil values' do
+    expect(Financier::Date[time]).to be_a(::Date)
+  end
+end

data/spec/financier/ledger_spec.rb

@@ -0,0 +1,86 @@
+require_relative '../spec_helper'
+
+describe Financier::Ledger do
+  let(:transaction) { Financier::Transaction }
+
+  subject do
+    Financier::Ledger.new(
+      transaction.new(500, 1.year.ago),
+      transaction.new(-150, 6.months.ago),
+      transaction.new(-250, 2.weeks.ago)
+    )
+  end
+
+  describe 'transactions' do
+    describe '#<<' do
+      before { subject << transaction.new(2) }
+
+      it 'adds a transaction' do
+        expect(subject.transactions.length).to eq(4)        
+      end
+
+      it 'is aliased as push' do
+        expect(subject).to respond_to(:push)
+      end
+
+      it 'coerces non-transactions' do
+        subject << 120
+        expect(subject.transactions.last).to be_a(transaction)
+        expect(subject.transactions.last.amount).to eq(120)
+      end
+    end
+
+    describe '#transactions' do
+      it 'returns the transactions' do
+        expect(subject.transactions.length).to eq(3)
+      end
+    end
+
+    describe '#credits' do
+      it 'returns the credit transactions' do
+        expect(subject.credits.length).to eq(1)
+      end
+    end
+
+    describe '#debits' do
+      it 'returns the debit transactions' do
+        expect(subject.debits.length).to eq(2)
+      end
+    end
+  end
+
+  describe 'coercion' do
+  end
+
+  describe 'calculation' do
+    describe '#balance' do
+      it 'sums all transactions' do
+        expect(subject.balance).to eq(100)
+      end
+
+      describe 'before' do
+        it 'sums transactions before date' do
+          expect(subject.balance(before: 4.weeks.ago)).to eq(350)
+        end
+      end
+
+      describe 'after' do
+        it 'sums transactions after date' do
+          expect(subject.balance(after: 7.months.ago)).to eq(-400)
+        end
+      end
+
+      describe 'between' do
+        it 'sums transactions between dates' do
+          expect(subject.balance(between: 7.months.ago..4.weeks.ago)).to eq(-150)
+        end
+      end
+
+      describe 'within' do
+        it 'sums transactions within dates' do
+          expect(subject.balance(within: subject.transactions.first.date..subject.transactions[1].date)).to eq(350)
+        end
+      end
+    end
+  end
+end

data/spec/financier/rate_spec.rb

@@ -0,0 +1,188 @@
+require_relative '../spec_helper'
+
+shared_examples_for 'does not raise error' do
+  it 'does not raise an error' do
+    expect { subject }.to_not raise_error
+  end
+end
+
+describe Financier::Rate do
+  let(:test_rate)  { 0.15 }
+  let(:compounding_Period) { :monthly }
+  let(:type) { :nominal }
+  let(:opts) { nil }
+  let(:rate) { Financier::Rate.new(test_rate, type) }
+  
+  subject { rate }
+
+  context 'when given a duration' do
+    let(:type) { :effective }
+    let(:rate) { Financier::Rate.new(test_rate, type, duration: 360) }
+
+    subject { rate.duration }
+
+    it { is_expected.to eql 360 }
+  end
+
+  describe 'when compared to another interest rate' do
+    let(:r1) { rate }
+    let(:r2) { Financier::Rate.new(compared_rate, type) }
+
+    subject { r1 <=> r2 }
+
+    context 'when the other rate is smaller' do
+      let(:compared_rate) { test_rate - 0.01}
+      it { is_expected.to eql 1 }
+    end
+
+    context 'when the other rate is the same' do
+      let(:compared_rate) { test_rate }
+      it { is_expected.to eql 0 }
+    end
+
+    context 'when the other rate is bigger' do
+      let(:compared_rate) { test_rate + 0.01 }
+      it { is_expected.to eql -1 }
+      
+    end
+  end
+
+  describe "should convert to a monthly value" do
+    let(:type) { :effective }
+    let(:test_rate) { 0.0375 }
+
+    subject { rate.monthly }
+
+    it { is_expected.to eql D('0.003125') }
+  end
+
+  describe 'converts effective interest rates to nominal' do
+    context 'when the rates compounding period is finite' do
+      subject { Financier::Rate.to_nominal(D('0.0375'), 12).round(5) }
+
+      it { is_expected.to eql D('0.03687') }
+    end
+
+    context 'when the rate is continuously compounding' do
+      subject { Financier::Rate.to_nominal(D('0.0375'), Flt::DecNum.infinity).round(5) }
+
+      it { is_expected.to eql D('0.03681') }
+    end
+  end
+
+  context 'type is an unknown value' do
+    let(:type) { :foo }
+
+    it 'should raise an ArgumentError' do
+      expect { subject }.to raise_error ArgumentError
+    end
+  end
+
+  context 'with compounding period' do
+    let(:rate) { Financier::Rate.new(test_rate, type, compounds: compounding_period) }
+    
+    describe 'anually' do
+      let(:compounding_period) { :annually }
+      it_behaves_like 'does not raise error'
+    end
+
+    describe 'continuously' do
+      let(:compounding_period) { :continuously }
+      it_behaves_like 'does not raise error'
+    end
+
+    describe 'daily' do
+      let(:compounding_period) { :daily }
+      it_behaves_like 'does not raise error'
+    end
+
+    describe 'monthly' do
+      let(:compounding_period) { :monthly }
+      it_behaves_like 'does not raise error'
+    end
+
+    describe 'quarterly' do
+      let(:compounding_period) { :quarterly }
+      it_behaves_like 'does not raise error'
+    end
+
+    describe 'semiannually' do
+      let(:compounding_period) { :semiannually }
+      it_behaves_like 'does not raise error'
+    end
+
+    describe 'Numeric' do
+      let(:compounding_period) { 7 }
+      it_behaves_like 'does not raise error'
+    end
+
+    describe 'unknown string' do
+      let(:compounding_period) { :foo }
+      it 'raises an error' do
+        expect { subject }.to raise_error ArgumentError
+      end
+    end
+  end
+
+  describe '#inspect' do
+    subject { rate.inspect }
+
+    it { is_expected.to be_a String }
+    it { is_expected.to include ':apr' }
+  end
+
+  describe '#apr' do
+    subject { rate.apr }
+
+    it { is_expected.to eql rate.effective }
+  end
+
+  describe '#apy' do
+    subject { rate.apy }
+
+    it { is_expected.to eql rate.effective }
+  end
+
+  describe "#effective" do
+    context 'with compounding period' do
+      let(:rate) { Financier::Rate.new(test_rate, :nominal, compounds: compounding_period) }
+
+      subject { rate.effective.round(5) }
+
+      describe 'monthly' do
+        let(:compounding_period) { :monthly }
+        it { should == D('0.16075') }
+      end
+
+      describe 'annually' do
+        let(:compounding_period) { :annually }
+        it { should == D('0.15000') }
+      end
+
+      describe 'continuously' do
+        let(:compounding_period) { :continuously }
+        it { should == D('0.16183') }
+      end
+
+      describe 'daily' do
+        let(:compounding_period) { :daily }
+        it { should == D('0.16180') }
+      end
+
+      describe 'quarterly' do
+        let(:compounding_period) { :quarterly }
+        it { should == D('0.15865') }
+      end
+
+      describe 'semi-annually' do
+        let(:compounding_period) { :semiannually }
+        it { should == D('0.15563') }
+      end
+
+      describe 'Numeric' do
+        let(:compounding_period) { 7 }
+        it { should == D('0.15999') }
+      end
+    end
+  end
+end

data/spec/financier/transaction_spec.rb

@@ -0,0 +1,118 @@
+require_relative '../spec_helper'
+
+describe Financier::Transaction do
+  subject { Financier::Transaction }
+
+  let(:transaction) { subject.new(1) }
+
+  describe 'amount' do
+    it 'is gettable' do
+      expect(transaction).to respond_to(:amount)
+    end
+
+    describe 'setting' do
+      let!(:old_amt) { transaction.instance_variable_get('@amount') }
+      let(:new_amt) { transaction.instance_variable_get('@amount') }
+
+      before { transaction.amount = 2 }
+
+      it 'sets the amount' do
+        expect(new_amt).to_not eq(old_amt)
+      end
+
+      it 'converts the amount to DecNum' do
+        expect(new_amt).to be_a(Flt::DecNum)
+      end
+    end
+  end
+
+  describe 'date' do
+    it 'is gettable' do
+      expect(transaction).to respond_to(:date)
+    end
+
+    describe 'setting' do
+      let!(:old_date) { transaction.instance_variable_get('@date') }
+      let(:new_date) { transaction.instance_variable_get('@date') }
+
+      before { transaction.date = 1.day.ago }
+
+      it 'sets the date' do
+        expect(new_date).to_not eq(old_date)
+      end
+
+      it 'converts the date to a Date' do
+        expect(new_date).to be_a(Date)
+      end
+    end
+
+    describe '#on?' do
+      it 'returns appropriate responses' do
+        expect(transaction.on?(1.day.ago)).to be false
+        expect(transaction.on?(Date.today)).to be true
+        expect(transaction.on?(1.day.from_now)).to be false
+      end
+    end
+
+    describe '#before?' do
+      it 'returns appropriate responses' do
+        expect(transaction.before?(1.day.ago)).to be false
+        expect(transaction.before?(Date.today)).to be false
+        expect(transaction.before?(1.day.from_now)).to be true
+      end
+    end
+
+    describe '#after?' do
+      it 'returns appropriate responses' do
+        expect(transaction.after?(1.day.ago)).to be true
+        expect(transaction.after?(Date.today)).to be false
+        expect(transaction.after?(1.day.from_now)).to be false
+      end
+    end
+  end
+
+  describe 'credit/debit/zero' do
+    let(:credit) { subject.new(123) }
+    let(:debit) { subject.new(-123) }
+    let(:zero) { subject.new(0) }
+    let(:non_zero) { credit }
+
+    describe '#credit?' do
+      it 'is true for positive amounts' do
+        expect(credit.credit?).to be true
+      end
+
+      it 'is false for negative amounts' do
+        expect(debit.credit?).to be false
+      end
+
+      it 'is false for zero amounts' do
+        expect(zero.credit?).to be false
+      end
+    end
+
+    describe '#debit?' do
+      it 'is true for negative amounts' do
+        expect(debit.debit?).to be true
+      end
+
+      it 'is false for positive amounts' do
+        expect(credit.debit?).to be false
+      end
+
+      it 'is false for zero amounts' do
+        expect(zero.debit?).to be false
+      end
+    end
+
+    describe '#zero?' do
+      it 'is true for zero amounts' do
+        expect(zero.zero?).to be true
+      end
+
+      it 'is false for non-zero amounts' do
+        expect(non_zero.zero?).to be false
+      end
+    end
+  end
+end

data/spec/financier_spec.rb

@@ -0,0 +1,7 @@
+require_relative 'spec_helper'
+
+describe Financier do
+  it 'has a version' do
+    expect(subject.constants).to include(:VERSION)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require_relative '../lib/financier'

metadata

@@ -0,0 +1,176 @@
+--- !ruby/object:Gem::Specification
+name: financier
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ethan Barron
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-04-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.3
+- !ruby/object:Gem::Dependency
+  name: chronic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.2
+- !ruby/object:Gem::Dependency
+  name: flt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.8.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.67.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.67.2
+description: Ruby gem to deal with financial calculations.
+email:
+- ethan.barron@kalidy.com
+executables:
+- financier
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/financier
+- financier.gemspec
+- lib/financier.rb
+- lib/financier/amortization.rb
+- lib/financier/date.rb
+- lib/financier/ledger.rb
+- lib/financier/rate.rb
+- lib/financier/transaction.rb
+- lib/financier/version.rb
+- spec/financier/amortization_spec.rb
+- spec/financier/date_spec.rb
+- spec/financier/ledger_spec.rb
+- spec/financier/rate_spec.rb
+- spec/financier/transaction_spec.rb
+- spec/financier_spec.rb
+- spec/spec_helper.rb
+homepage: https://rubygems.org/gems/financier
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://rubygems.org/gems/financier
+  source_code_uri: https://github.com/Inkybro/financier
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Provides handy financial calculators.
+test_files:
+- spec/financier/amortization_spec.rb
+- spec/financier/date_spec.rb
+- spec/financier/ledger_spec.rb
+- spec/financier/rate_spec.rb
+- spec/financier/transaction_spec.rb
+- spec/financier_spec.rb
+- spec/spec_helper.rb