bouch 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 9d3a4f13ab472a43a9e8b40cbfe763c10966bdea
-  data.tar.gz: 16fe655a734aa70473303c03244b9656c175be9e
+SHA256:
+  metadata.gz: fb58a99429b5afdc33cb7f65053580cf742aca9da08f2461861429ceaa75325f
+  data.tar.gz: e15f9cab5a04bebd6ce4cd6f1aca42943ee82f18a8359911632709572559aabd
 SHA512:
-  metadata.gz: 57f18fa8111bdba78c8a91db428c7d0f335c8f84862ceb2ff4efe07ac2d8985a0091eb195d1bb6c5d259d316df34e6100c1c8fe103fd0c5979df85b71def8c43
-  data.tar.gz: e3a2f08b1fe37e449bd065eb6f6f70de9e8b446dbb8fd95410d5e9d763597cfc61c522d5206fbbc98a0c753c203a682deb9c3b1485420b431bbfd00176d97731
+  metadata.gz: 0a396b50771862a7ae3187f8da5ee6bd9e903b0c2e58a02b383541412bcc131c86f1ed0b0b79633e8cc92d711aa460bc7c1e4ac1f399e7050dd26b0505e297ec
+  data.tar.gz: b17ba90c8d8e9b4b090282c85accc8a6bcdaa3e9b0983c4b4122e9c72e01bdb2c673db304a2caeeb070a4dfebc829ea5a9bba348982703217a135ee68b6b13e5

data/Gemfile.lock

@@ -1,34 +1,34 @@
 PATH
   remote: .
   specs:
-    bouch (1.1.0)
+    bouch (1.2.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.0)
     diff-lcs (1.3)
-    docile (1.3.1)
-    json (2.1.0)
-    parallel (1.12.1)
-    parser (2.5.1.0)
+    docile (1.3.2)
+    json (2.3.0)
+    parallel (1.19.1)
+    parser (2.7.0.1)
       ast (~> 2.4.0)
-    powerpack (0.1.1)
+    powerpack (0.1.2)
     rainbow (3.0.0)
-    rake (12.3.1)
-    rspec (3.7.0)
-      rspec-core (~> 3.7.0)
-      rspec-expectations (~> 3.7.0)
-      rspec-mocks (~> 3.7.0)
-    rspec-core (3.7.1)
-      rspec-support (~> 3.7.0)
-    rspec-expectations (3.7.0)
+    rake (13.0.1)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-mocks (3.7.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-support (3.7.1)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
     rubocop (0.56.0)
       parallel (~> 1.10)
       parser (>= 2.5)
@@ -36,13 +36,13 @@ GEM
       rainbow (>= 2.2.2, < 4.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (~> 1.0, >= 1.0.1)
-    ruby-progressbar (1.9.0)
-    simplecov (0.16.1)
+    ruby-progressbar (1.10.1)
+    simplecov (0.17.1)
       docile (~> 1.1)
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.2)
-    unicode-display_width (1.4.0)
+    unicode-display_width (1.6.0)
 
 PLATFORMS
   ruby
@@ -59,4 +59,4 @@ RUBY VERSION
    ruby 2.5.0p0
 
 BUNDLED WITH
-   1.16.1
+   1.17.3

data/README.md

@@ -1,5 +1,5 @@
 # Bouch
-[![pipeline status](https://gitlab.com/ssofos/bouch/badges/master/pipeline.svg)](https://gitlab.com/ssofos/bouch/commits/master) [![coverage report](https://gitlab.com/ssofos/bouch/badges/master/coverage.svg)](https://gitlab.com/ssofos/bouch/commits/master)
+[![Gem Version](https://badge.fury.io/rb/bouch.svg)](https://badge.fury.io/rb/bouch) [![pipeline status](https://gitlab.com/ssofos/bouch/badges/master/pipeline.svg)](https://gitlab.com/ssofos/bouch/commits/master) [![coverage report](https://gitlab.com/ssofos/bouch/badges/master/coverage.svg)](https://gitlab.com/ssofos/bouch/commits/master)
 
 `Bouch` is the budget pouch. A simple tool to calculate and project your annual personal budget based on fiscal quarter expenditures, income, assets, and debts.
 
@@ -44,7 +44,9 @@ Budget Annual Total:           12100.00
 Budget Annual Income:          28808.00
 Budget Income Percent:         42.00%
 ----------------------
-Assets Total:                  1000.00
+Assets Total:                  500.00
+Equity Total:                  500.00
+Net Worth:                     1000.00
 ----------------------
 Debt Total:                    420.00
 Debt Ratio:                    0.4200
@@ -58,22 +60,23 @@ To use bouch to calculate your own budget you must create a customized budget po
 
 Budget pouch files are written in Ruby friendly YAML and currently use the following schema:
 
-* Deeply nested mappings, also know as hashes
-* Think of hashes as simple groupings of keys and values
+* Nested mappings, also know as hashes in Ruby
+* Think of hashes as simple groupings of keys value pairs
 * Primary hash keys:
   * **Budget**
   * **Salary**
   * **Assets**
+  * **Equity**
   * **Debts**
 * **Budget** nested keys and values:
     * **Q1**
         * foo
             * Value: Integer or Float
-            * Equals a budget item's quarterly cost
+            * Equals a single budget item's quarterly cost
         * bar
             * **cost**
                 * Value: Integer or Float
-                * Equals the monthly cost of any repeated payment
+                * Equals the repeated budget item's monthly cost
             * **repeat**
                 * Value: true
                 * Enables quarterly auto-calculation of the repeat payment
@@ -94,8 +97,12 @@ Budget pouch files are written in Ruby friendly YAML and currently use the follo
   * foo
       * Value: Integer or Float
       * Equals an asset's total valued amount
-* **Debts** nested keys and values:
+* **Equity** nested keys and values:
   * bar
+      * Value: Integer or Float
+      * Equals the total value of equity in a specific asset
+* **Debts** nested keys and values:
+  * fizz
       * Value: Integer or Float
       * Equals a debt's total valued amount
 * All non-primary nested keys are case insensitive
@@ -134,6 +141,7 @@ Salary:
   frequency: 2
 Assets:
   foo: 500
+Equity:
   bar: 500
 Debts:
   baz: 120

data/lib/bouch.rb

@@ -6,19 +6,21 @@ require 'bouch/calc'
 # Calculate and create simple financial budgets
 # by parsing a single YAML file as input
 class Bouch
-  attr_accessor :assets, :debts, :pouch, :quarters
+  attr_accessor :assets, :debts, :equity, :net_worth, :pouch, :quarters
   include BouchCalculate
 
   def initialize(file)
     @assets = Array.new
     @debts = Array.new
+    @equity = Array.new
+    @net_worth = nil
     @pouch = YAML.safe_load(IO.read(file))
     @quarters = Hash.new
   end
 
   # Summarize and show aggregate asset totals
   def show_assets_total
-    calc_assets(@pouch['Assets']) if @assets.empty?
+    calc_assets(@pouch['Assets'], 'assets') if @assets.empty?
     puts '----------------------'
     puts format('%-30s %.2f', 'Assets Total:', @assets.sum)
   end
@@ -33,14 +35,28 @@ class Bouch
   # Summarize and show debt ratio
   def show_debt_ratio
     calc_assets(@pouch['Assets']) if @assets.empty?
+    calc_assets(@pouch['Equity'], 'equity') if @equity.empty?
+    calc_net_worth(@assets, @equity) if @net_worth.nil?
     calc_debts(@pouch['Debts']) if @debts.empty?
-    puts format('%-30s %.4f', 'Debt Ratio:', calc_debt_ratio(@debts.sum, @assets.sum))
+    puts format('%-30s %.4f', 'Debt Ratio:', calc_debt_ratio(@debts.sum, @net_worth))
     puts format('%-30s %.2f%s', 'Debt Ratio Percent:',
-                calc_debt_ratio_percent(calc_debt_ratio(@debts.sum, @assets.sum)),
+                calc_debt_ratio_percent(calc_debt_ratio(@debts.sum, @net_worth)),
                 '%')
     puts '----------------------'
   end
 
+  # Summarize and show aggregate equity totals
+  def show_equity_total
+    calc_assets(@pouch['Equity'], 'equity') if @equity.empty?
+    puts format('%-30s %.2f', 'Equity Total:', @equity.sum)
+  end
+
+  # Summarize and show Net Worth
+  def show_net_worth
+    calc_net_worth(@assets, @equity) if @net_worth.nil?
+    puts format('%-30s %.2f', 'Net Worth:', @net_worth)
+  end
+
   # Summarize and show all financial quarter budgets
   def show_quarters
     calc_quarters_raw(@pouch['Budget']) if @quarters.empty?
@@ -83,6 +99,8 @@ class Bouch
     show_annual_income
     show_budget_percentage
     show_assets_total
+    show_equity_total
+    show_net_worth
     show_debts_total
     show_debt_ratio
   end

data/lib/bouch/calc.rb

@@ -3,9 +3,14 @@
 # Financial budget calculation and operations for Bouch
 module BouchCalculate
   # Calculate asset value aggregate amount
-  def calc_assets(assets)
+  def calc_assets(assets, type = 'assets')
     assets.each_value do |value|
-      @assets.push(value)
+      case type
+      when 'assets'
+        @assets.push(value)
+      when 'equity'
+        @equity.push(value)
+      end
     end
   end
 
@@ -31,6 +36,11 @@ module BouchCalculate
     (debt_ratio.to_f * 100).round(2)
   end
 
+  # Calcuate a Net Worth sum
+  def calc_net_worth(assets = [], equity = [])
+    @net_worth = (assets + equity).sum.to_f.round(2)
+  end
+
   # Calculate a quarterly repeating budget item amount
   def calc_repeating(item)
     (item.to_f * 3).round(2)

data/lib/bouch/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class Bouch
-  VERSION = '1.1.0'
+  VERSION = '1.2.0'
 end

data/pouch.example.yml

@@ -29,6 +29,7 @@ Salary:
   frequency: 2
 Assets:
   foo: 500
+Equity:
   bar: 500
 Debts:
   baz: 120

data/spec/bouch_calc_spec.rb

@@ -68,6 +68,17 @@ describe BouchCalculate do
     end
   end
 
+  describe '.calc_net_worth' do
+    context 'given an two Arrays of assets and equity' do
+      it 'returns a Float number' do
+        expect(@bouch.calc_net_worth([500], [500])).to be_a_kind_of(Float)
+      end
+      it 'returns a net worth sum of assets and equity' do
+        expect(@bouch.calc_net_worth([500], [500])).to eq(1000.00)
+      end
+    end
+  end
+
   describe '.calc_repeating' do
     context 'given a numerical cost amount' do
       it 'returns a Float number' do

data/spec/bouch_pouch_yaml_spec.rb

@@ -9,7 +9,7 @@ describe 'Pouch YAML Schema' do
   end
 
   it 'has four major Hash keys' do
-    expect(@pouch.keys.length).to eq(4)
+    expect(@pouch.keys.length).to eq(5)
   end
 
   it 'has a Hash key named Budget' do
@@ -24,6 +24,10 @@ describe 'Pouch YAML Schema' do
     expect(@pouch.key?('Assets')).to be_truthy
   end
 
+  it 'has a Hash key named Equity' do
+    expect(@pouch.key?('Equity')).to be_truthy
+  end
+
   it 'has a Hash key named Debts' do
     expect(@pouch.key?('Debts')).to be_truthy
   end

data/spec/bouch_spec.rb

@@ -24,6 +24,18 @@ describe Bouch do
     end
   end
 
+  describe '#equity' do
+    it 'returns an empty Array of equity' do
+      expect(@bouch.equity).to be_empty
+    end
+  end
+
+  describe '#net_worth' do
+    it 'returns a Nil net_worth' do
+      expect(@bouch.net_worth).to be_nil
+    end
+  end
+
   describe '#pouch' do
     it 'loads the budget pouch YAML file' do
       expect(@bouch.pouch).to eq(YAML.safe_load(IO.read(@yaml)))
@@ -54,6 +66,18 @@ describe Bouch do
     end
   end
 
+  describe '.show_equity_total' do
+    it 'outputs financial budget equity sum' do
+      expect { @bouch.show_equity_total }.to output.to_stdout
+    end
+  end
+
+  describe '.show_net_worth' do
+    it 'outputs financial budget net worth' do
+      expect { @bouch.show_net_worth }.to output.to_stdout
+    end
+  end
+
   describe '.show_quarters' do
     it 'outputs financial budget quarters sums' do
       expect { @bouch.show_quarters }.to output.to_stdout

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bouch
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Shane R. Sofos
@@ -131,8 +131,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: A simple tool to calculate and project your annual personal budget based