bouch 1.1.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 9d3a4f13ab472a43a9e8b40cbfe763c10966bdea
-  data.tar.gz: 16fe655a734aa70473303c03244b9656c175be9e
+SHA256:
+  metadata.gz: 1703d82906883118087626db522e171f841ca1b3bfa9792731da9e05ebbbf08c
+  data.tar.gz: 8a956f18ac52e62a4648172743eb9ecbcd0e846913abc9ac6dac1f615b0e7a9d
 SHA512:
-  metadata.gz: 57f18fa8111bdba78c8a91db428c7d0f335c8f84862ceb2ff4efe07ac2d8985a0091eb195d1bb6c5d259d316df34e6100c1c8fe103fd0c5979df85b71def8c43
-  data.tar.gz: e3a2f08b1fe37e449bd065eb6f6f70de9e8b446dbb8fd95410d5e9d763597cfc61c522d5206fbbc98a0c753c203a682deb9c3b1485420b431bbfd00176d97731
+  metadata.gz: f8eee437173dc3411bd5378553995c633a266d4ebdbe1539cd9eb26dc10ee148c13c85190c90516ebd8d9304810804f93923c13535db87224c5e81e6a1ee6adc
+  data.tar.gz: be2a6e3cd8771180dcd430bd931326af2c8a261f9333c340be766cfc2ab85bce7475a18e97ceb596a57df2a59fd4471123c11314a9855009bf6fd4cb3d645b56

data/.gitlab-ci.yml

@@ -1,4 +1,6 @@
 ---
+image: ruby:4.0
+
 rspec:
   script:
     - bundle install
@@ -8,4 +10,10 @@ rubocop:
   script:
     - bundle install
     - bundle exec rubocop
+
+integration:
+  script:
+    - bundle install
+    - bundle exec bouch example > /tmp/my_budget.yml
+    - bundle exec bouch /tmp/my_budget.yml
 ...

data/.rubocop.yml

@@ -3,16 +3,24 @@ AllCops:
     - 'vendor/**/*'
     - 'spec/fixtures/**/*'
     - 'tmp/**/*'
-  TargetRubyVersion: 2.4
+  NewCops: disable
+  TargetRubyVersion: 4.0
+  SuggestExtensions: false
+
+#################### Gemspec #########################
+
+Gemspec/RequiredRubyVersion:
+  Enabled: false
 
 #################### Layout #############################
 Layout/IndentationWidth:
   Width: 2
 
-#################### Lint ###############################
-
-Lint/DeprecatedClassMethods:
-  Enabled: false
+Layout/LineLength:
+  Max: 140
+  AllowURI: true
+  URISchemes:
+    - https
 
 #################### Metrics ############################
 
@@ -31,12 +39,6 @@ Metrics/ClassLength:
 Metrics/CyclomaticComplexity:
   Enabled: false
 
-Metrics/LineLength:
-  Max: 120
-  AllowURI: true
-  URISchemes:
-    - https
-
 Metrics/MethodLength:
   Enabled: false
 
@@ -53,9 +55,6 @@ Naming/FileName:
 
 #################### Style ###########################
 
-Style/BracesAroundHashParameters:
-  Enabled: false
-
 Style/CommentAnnotation:
   Enabled: false
 

data/.simplecov

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 SimpleCov.start do
   add_group 'Libraries', 'lib'
   add_group 'RSpec Unit Tests', 'spec'

data/Gemfile

@@ -2,6 +2,6 @@
 
 source 'https://rubygems.org'
 
-ruby '>=2.4.3'
+ruby '>=3.2.10'
 
 gemspec

data/Gemfile.lock

@@ -1,48 +1,65 @@
 PATH
   remote: .
   specs:
-    bouch (1.1.0)
+    bouch (2.0.0)
+      paint (~> 2.3)
 
 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)
-      ast (~> 2.4.0)
-    powerpack (0.1.1)
-    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)
+    ast (2.4.3)
+    diff-lcs (1.6.2)
+    docile (1.4.1)
+    json (2.18.1)
+    language_server-protocol (3.17.0.5)
+    lint_roller (1.1.0)
+    paint (2.3.0)
+    parallel (1.27.0)
+    parser (3.3.10.2)
+      ast (~> 2.4.1)
+      racc
+    prism (1.9.0)
+    racc (1.8.1)
+    rainbow (3.1.1)
+    rake (13.3.1)
+    regexp_parser (2.11.3)
+    rspec (3.13.2)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.6)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.5)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-mocks (3.7.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.7)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-support (3.7.1)
-    rubocop (0.56.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.7)
+    rubocop (1.84.2)
+      json (~> 2.3)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
       parallel (~> 1.10)
-      parser (>= 2.5)
-      powerpack (~> 0.1)
+      parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.49.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (~> 1.0, >= 1.0.1)
-    ruby-progressbar (1.9.0)
-    simplecov (0.16.1)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.49.0)
+      parser (>= 3.3.7.2)
+      prism (~> 1.7)
+    ruby-progressbar (1.13.0)
+    simplecov (0.22.0)
       docile (~> 1.1)
-      json (>= 1.8, < 3)
-      simplecov-html (~> 0.10.0)
-    simplecov-html (0.10.2)
-    unicode-display_width (1.4.0)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.13.2)
+    simplecov_json_formatter (0.1.4)
+    unicode-display_width (3.2.0)
+      unicode-emoji (~> 4.1)
+    unicode-emoji (4.2.0)
 
 PLATFORMS
   ruby
@@ -52,11 +69,11 @@ DEPENDENCIES
   bundler
   rake
   rspec
-  rubocop (<= 0.56.0)
+  rubocop (~> 1.72)
   simplecov
 
 RUBY VERSION
-   ruby 2.5.0p0
+  ruby 4.0.1
 
 BUNDLED WITH
-   1.16.1
+  4.0.6

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.
 
@@ -23,33 +23,67 @@ gem 'bouch'
 
 Bouch takes a simple YAML file as its primary data input. This will be referred to as a budget pouch file.
 
-There is an example budget pouch file called **pouch.example.yml**.
+Generate an example budget pouch file and run it:
 
-Use this budget pouch file and execute the following command on your favorite terminal emulator's CLI:
+```
+bouch example > my_budget.yml
+bouch my_budget.yml
+```
+
+### Generate an Example Pouch File
+
+You can generate an example budget pouch YAML file to get started:
+
+```
+bouch example > my_budget.yml
+```
+
+Edit `my_budget.yml` with your own data, then run:
 
 ```
-bouch pouch.example.yml
+bouch my_budget.yml
 ```
 
-You should see the example budget summary output:
+### CLI Flags
 
 ```
-----------------------
+bouch [YAML_FILE]       # Calculate and display budget
+bouch example           # Print an example budget pouch YAML
+bouch --version / -v    # Print version
+bouch --help / -h       # Print usage help
+```
+
+### Example Output
+
+You should see the example budget summary output (with colorized sections):
+
+```
+──────────────────────────────────────────
+BUDGET
+──────────────────────────────────────────
 Quarter 1:                     3025.00
 Quarter 2:                     3025.00
 Quarter 3:                     3025.00
 Quarter 4:                     3025.00
-----------------------
 Budget Annual Total:           12100.00
+──────────────────────────────────────────
+INCOME
+──────────────────────────────────────────
 Budget Annual Income:          28808.00
 Budget Income Percent:         42.00%
-----------------------
-Assets Total:                  1000.00
-----------------------
+──────────────────────────────────────────
+ASSETS
+──────────────────────────────────────────
+Assets Total:                  500.00
+Equity Total:                  500.00
+Net Worth:                     1000.00
+──────────────────────────────────────────
+DEBTS
+──────────────────────────────────────────
 Debt Total:                    420.00
 Debt Ratio:                    0.4200
 Debt Ratio Percent:            42.00%
-----------------------
+──────────────────────────────────────────
 ```
 
 ### Pouch Schema
@@ -58,22 +92,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**
-  * **Debts**
+  * **Assets** (optional)
+  * **Equity** (optional)
+  * **Debts** (optional)
 * **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 +129,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 +173,7 @@ Salary:
   frequency: 2
 Assets:
   foo: 500
+Equity:
   bar: 500
 Debts:
   baz: 120

data/Rakefile

@@ -8,3 +8,8 @@ RSpec::Core::RakeTask.new
 RuboCop::RakeTask.new
 
 task default: %i[spec rubocop]
+
+desc 'Sign in to RubyGems.org'
+task :signin do
+  sh 'gem signin'
+end

data/bouch.gemspec

@@ -5,7 +5,6 @@ require 'bouch/version'
 
 Gem::Specification.new do |s|
   s.name        = 'bouch'
-  s.date        = '2018-06-09'
   s.version     = Bouch::VERSION
   s.authors     = ['Shane R. Sofos']
   s.email       = ['ssofos@gmail.com']
@@ -13,21 +12,22 @@ Gem::Specification.new do |s|
   s.license     = 'GPL-3.0'
   s.description = 'The Budget Pouch. Fast annual budget projections.'
   s.summary     =
-    'A simple tool to calculate and project your ' +
-    'annual personal budget based on fiscal quarters ' +
+    'A simple tool to calculate and project your ' \
+    'annual personal budget based on fiscal quarters ' \
     'expenditures, income, assets, and debts.'
 
-  s.files         = %x(git ls-files).split($INPUT_RECORD_SEPARATOR)
-  s.bindir        = ['bin']
+  s.files         = %x(git ls-files).split("\n")
+  s.bindir        = 'bin'
   s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
   s.require_paths = ['lib']
 
+  s.add_dependency 'paint', '~> 2.3'
+
   s.add_development_dependency 'bundler'
   s.add_development_dependency 'rake'
   s.add_development_dependency 'rspec'
-  s.add_development_dependency 'rubocop', '<=0.56.0'
+  s.add_development_dependency 'rubocop', '~> 1.72'
   s.add_development_dependency 'simplecov'
 
-  s.required_ruby_version = '>= 2.4.0'
+  s.required_ruby_version = '>= 3.2'
 end

data/lib/bouch/calc.rb

@@ -3,27 +3,36 @@
 # Financial budget calculation and operations for Bouch
 module BouchCalculate
   # Calculate asset value aggregate amount
-  def calc_assets(assets)
+  def calc_assets(assets, type = 'assets')
+    return if assets.nil?
+
     assets.each_value do |value|
-      @assets.push(value)
+      case type
+      when 'assets'
+        @assets << value
+      when 'equity'
+        @equity << value
+      end
     end
   end
 
   # Calculate the percentage of budget of a salary/income
   def calc_budget_percentage(total, salary)
-    ((total.to_f / salary.to_f) * 100).round(2)
+    ((total.to_f / salary) * 100).round(2)
   end
 
   # Calculate debt/liability aggregate amount
   def calc_debts(debts)
+    return if debts.nil?
+
     debts.each_value do |value|
-      @debts.push(value)
+      @debts << value
     end
   end
 
   # Calculate a debt ratio: total debts divided by total assets
   def calc_debt_ratio(debts, assets)
-    (debts.to_f / assets.to_f).round(4)
+    (debts.to_f / assets).round(4)
   end
 
   # Calculate a debt ratio percentage
@@ -31,6 +40,11 @@ module BouchCalculate
     (debt_ratio.to_f * 100).round(2)
   end
 
+  # Calculate 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)
@@ -38,21 +52,22 @@ module BouchCalculate
 
   # Calculate an annual income based on a weekly frequency salary
   def calc_salary(amount, freq)
-    (amount.to_f * (52 / freq)).round(2)
+    (amount.to_f * (52.0 / freq)).round(2)
   end
 
   # Calculate each financial quarters budget items, including repeating ones
   def calc_quarters_raw(budget)
     budget.each_value do |items|
-      @quarters[@quarters.length.to_s] = Array.new
+      idx = @quarters.length
+      @quarters[idx] = []
       items.each_value do |value|
         case value
         when Hash
           if value.key?('repeat')
-            @quarters[(@quarters.length - 1).to_s].push(calc_repeating(value['cost']))
+            @quarters[idx] << calc_repeating(value['cost'])
           end
         else
-          @quarters[(@quarters.length - 1).to_s].push(value)
+          @quarters[idx] << value
         end
       end
     end
@@ -60,6 +75,6 @@ module BouchCalculate
 
   # Calculate all financial quarter budget into an aggregate annual budget
   def calc_quarters_raw_total
-    @quarters['0'].sum + @quarters['1'].sum + @quarters['2'].sum + @quarters['3'].sum
+    @quarters[0].sum + @quarters[1].sum + @quarters[2].sum + @quarters[3].sum
   end
 end

data/lib/bouch/cli.rb

@@ -2,6 +2,8 @@
 
 require 'bouch'
 require 'bouch/version'
+require 'bouch/example'
+require 'paint'
 
 class Bouch
   # Parse the command line
@@ -13,20 +15,26 @@ class Bouch
     end
 
     def start
-      if @yaml_file.eql?(nil)
-        puts 'Please supply budget pouch YAML file path and rerun bouch.'
+      if @yaml_file.nil? || %w[--help -h].include?(@yaml_file)
         usage
+      elsif %w[--version -v].include?(@yaml_file)
+        puts Paint["bouch #{Bouch::VERSION}", :magenta, :bold]
+      elsif @yaml_file == 'example'
+        puts Bouch::EXAMPLE_POUCH
       elsif File.exist?(@yaml_file)
         budget = Bouch.new(@yaml_file)
         budget.show_budget
       else
-        puts "Whoops. The budget pouch file specified: #{@yaml_file} ; does not exist!"
+        puts Paint["Whoops. The budget pouch file specified: #{@yaml_file} ; does not exist!", :red]
         usage
       end
     end
 
     def usage
-      puts "<<bouch #{Bouch::VERSION}>>\nUsage: #{File.basename($PROGRAM_NAME)} [YAML_FILE]"
+      puts Paint["<<bouch #{Bouch::VERSION}>>", :magenta, :bold]
+      puts "Usage: #{Paint[File.basename($PROGRAM_NAME), :green]} #{Paint['[YAML_FILE]', :faint]}"
+      puts "       #{Paint[File.basename($PROGRAM_NAME), :green]} #{Paint['example', :magenta]}    # Print an example budget pouch YAML"
+      puts "       #{Paint[File.basename($PROGRAM_NAME), :green]} #{Paint['--version', :magenta]}  # Print version"
     end
   end
 end

data/lib/bouch/example.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+class Bouch
+  EXAMPLE_POUCH = <<~YAML
+    ---
+    Budget:
+      Q1:
+        Rent:
+          cost: 1000
+          repeat: true
+        foo: 20
+        bar: 5
+      Q2:
+        Rent:
+          cost: 1000
+          repeat: true
+        fizz: 20
+        buzz: 5
+      Q3:
+        Rent:
+          cost: 1000
+          repeat: true
+        bubble: 20
+        sort: 5
+      Q4:
+        Rent:
+          cost: 1000
+          repeat: true
+        baz: 20
+        qax: 5
+    Salary:
+      quantity: 1108.00
+      frequency: 2
+    Assets:
+      foo: 500
+    Equity:
+      bar: 500
+    Debts:
+      baz: 120
+      qax: 300
+    ...
+  YAML
+end

data/lib/bouch/version.rb

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

data/lib/bouch.rb

@@ -1,89 +1,140 @@
 # frozen_string_literal: true
 
 require 'yaml'
+require 'paint'
 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
 
+  SEPARATOR = Paint["\u2500" * 42, :faint]
+
   def initialize(file)
-    @assets = Array.new
-    @debts = Array.new
-    @pouch = YAML.safe_load(IO.read(file))
-    @quarters = Hash.new
+    @assets = []
+    @debts = []
+    @equity = []
+    @net_worth = nil
+    @pouch = YAML.safe_load(File.read(file))
+    @quarters = {}
   end
 
   # Summarize and show aggregate asset totals
   def show_assets_total
-    calc_assets(@pouch['Assets']) if @assets.empty?
-    puts '----------------------'
-    puts format('%-30s %.2f', 'Assets Total:', @assets.sum)
+    calc_assets(@pouch['Assets'], 'assets') if @assets.empty?
+    label = Paint[format('%-30s', 'Assets Total:'), :green]
+    value = Paint[format('%.2f', @assets.sum), :green, :bright]
+    puts "#{label} #{value}"
   end
 
   # Summarize and show aggregate liabilities totals
   def show_debts_total
     calc_debts(@pouch['Debts']) if @debts.empty?
-    puts '----------------------'
-    puts format('%-30s %.2f', 'Debt Total:', @debts.sum)
+    label = Paint[format('%-30s', 'Debt Total:'), :red]
+    value = Paint[format('%.2f', @debts.sum), :red, :bright]
+    puts "#{label} #{value}"
   end
 
   # 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 %.2f%s', 'Debt Ratio Percent:',
-                calc_debt_ratio_percent(calc_debt_ratio(@debts.sum, @assets.sum)),
-                '%')
-    puts '----------------------'
+    ratio = calc_debt_ratio(@debts.sum, @net_worth)
+    label1 = Paint[format('%-30s', 'Debt Ratio:'), :red]
+    value1 = Paint[format('%.4f', ratio), :red, :bright]
+    puts "#{label1} #{value1}"
+    label2 = Paint[format('%-30s', 'Debt Ratio Percent:'), :red]
+    value2 = Paint[format('%.2f%s', calc_debt_ratio_percent(ratio), '%'), :red, :bright]
+    puts "#{label2} #{value2}"
+  end
+
+  # Summarize and show aggregate equity totals
+  def show_equity_total
+    calc_assets(@pouch['Equity'], 'equity') if @equity.empty?
+    label = Paint[format('%-30s', 'Equity Total:'), :green]
+    value = Paint[format('%.2f', @equity.sum), :green, :bright]
+    puts "#{label} #{value}"
+  end
+
+  # Summarize and show Net Worth
+  def show_net_worth
+    calc_net_worth(@assets, @equity) if @net_worth.nil?
+    label = Paint[format('%-30s', 'Net Worth:'), :green]
+    value = Paint[format('%.2f', @net_worth), :green, :bright]
+    puts "#{label} #{value}"
   end
 
   # Summarize and show all financial quarter budgets
   def show_quarters
     calc_quarters_raw(@pouch['Budget']) if @quarters.empty?
-    puts '----------------------'
+    puts SEPARATOR
+    puts Paint['BUDGET', :magenta, :bold]
+    puts SEPARATOR
     4.times do |n|
-      puts format('%-30s %.2f', 'Quarter ' + (n + 1).to_s + ':', @quarters[n.to_s].sum)
+      label = Paint[format('%-30s', "Quarter #{n + 1}:"), :magenta]
+      value = Paint[format('%.2f', @quarters[n].sum), :magenta, :bright]
+      puts "#{label} #{value}"
     end
-    puts '----------------------'
   end
 
   # Summarize and show the aggregate annual budget totals
   def show_annual_total
     calc_quarters_raw(@pouch['Budget']) if @quarters.empty?
-    puts format('%-30s %.2f', 'Budget Annual Total:', calc_quarters_raw_total.to_s)
+    label = Paint[format('%-30s', 'Budget Annual Total:'), :magenta]
+    value = Paint[format('%.2f', calc_quarters_raw_total), :magenta, :bright]
+    puts "#{label} #{value}"
   end
 
   # Summarize and show the aggregate annual budget as a percentage of income
   def show_budget_percentage
     calc_quarters_raw(@pouch['Budget']) if @quarters.empty?
-    puts format('%-30s %.2f%s',
-                'Budget Income Percent:',
-                calc_budget_percentage(
-                  calc_quarters_raw_total,
-                  calc_salary(@pouch['Salary']['quantity'], @pouch['Salary']['frequency'])
-                ),
-                '%')
+    label = Paint[format('%-30s', 'Budget Income Percent:'), :magenta]
+    value = Paint[format('%.2f%s',
+                         calc_budget_percentage(
+                           calc_quarters_raw_total,
+                           calc_salary(@pouch['Salary']['quantity'], @pouch['Salary']['frequency'])
+                         ),
+                         '%'), :magenta, :bright]
+    puts "#{label} #{value}"
   end
 
   # Summarize and show annual income
   def show_annual_income
-    puts format('%-30s %.2f',
-                'Budget Annual Income:',
-                calc_salary(@pouch['Salary']['quantity'], @pouch['Salary']['frequency']))
+    label = Paint[format('%-30s', 'Budget Annual Income:'), :magenta]
+    value = Paint[format('%.2f',
+                         calc_salary(@pouch['Salary']['quantity'], @pouch['Salary']['frequency'])), :magenta, :bright]
+    puts "#{label} #{value}"
   end
 
   # Summarize and show all aggregate components of the quarterly, annual budgets, assets
   def show_budget
     show_quarters
     show_annual_total
+    puts SEPARATOR
+    puts Paint['INCOME', :magenta, :bold]
+    puts SEPARATOR
     show_annual_income
     show_budget_percentage
-    show_assets_total
-    show_debts_total
-    show_debt_ratio
+    if @pouch['Assets'] || @pouch['Equity']
+      puts SEPARATOR
+      puts Paint['ASSETS', :green, :bold]
+      puts SEPARATOR
+      show_assets_total if @pouch['Assets']
+      show_equity_total if @pouch['Equity']
+      show_net_worth
+    end
+    if @pouch['Debts']
+      puts SEPARATOR
+      puts Paint['DEBTS', :red, :bold]
+      puts SEPARATOR
+      show_debts_total
+      show_debt_ratio if @net_worth
+    end
+    puts SEPARATOR
   end
 end

data/spec/bouch_calc_spec.rb

@@ -6,8 +6,12 @@ require 'bouch/calc'
 
 describe BouchCalculate do
   before :all do
-    @yaml = File.realdirpath('pouch.example.yml')
-    @bouch = Bouch.new(@yaml)
+    @tempfile = create_example_pouch_tempfile
+    @bouch = Bouch.new(@tempfile.path)
+  end
+
+  after :all do
+    @tempfile.unlink
   end
 
   describe '.calc_assets' do
@@ -15,8 +19,6 @@ describe BouchCalculate do
       expect(@bouch.calc_assets(@bouch.pouch['Assets'])).to be_a_kind_of(Hash)
     end
     it 'creates array of assets greater than zero' do
-      # Uncomment line below for Debug
-      # puts @bouch.assets.inspect
       expect(@bouch.assets.length).to be > 0
     end
   end
@@ -34,8 +36,6 @@ describe BouchCalculate do
       expect(@bouch.calc_debts(@bouch.pouch['Debts'])).to be_a_kind_of(Hash)
     end
     it 'creates an array of debts greater than zero' do
-      # Uncomment line below for Debug
-      # puts @bouch.debts.inspect
       expect(@bouch.debts.length).to be > 0
     end
   end
@@ -55,19 +55,26 @@ describe BouchCalculate do
     context 'given a debt ratio' do
       it 'returns a Float number' do
         debt_ratio = @bouch.calc_debt_ratio(420.00, 1000.00)
-        # Uncomment line below for Debug
-        # puts debt_ratio
         expect(@bouch.calc_debt_ratio_percent(debt_ratio)).to be_a_kind_of(Float)
       end
       it 'returns a debt ratio percentage' do
         debt_ratio = @bouch.calc_debt_ratio(420.00, 1000.00)
-        # Uncomment line below for Debug
-        # puts debt_ratio
         expect(@bouch.calc_debt_ratio_percent(debt_ratio)).to eq(42.00)
       end
     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
@@ -96,24 +103,16 @@ describe BouchCalculate do
         expect(@bouch.calc_quarters_raw(@bouch.pouch['Budget'])).to be_a_kind_of(Hash)
       end
       it 'creates an array of financial quarter one budget items greater than zero' do
-        # Uncomment line below for Debug
-        # puts @bouch.quarters['0'].inspect
-        expect(@bouch.quarters['0'].length).to be > 0
+        expect(@bouch.quarters[0].length).to be > 0
       end
       it 'creates an array of financial quarter two budget items greater than zero' do
-        # Uncomment line below for Debug
-        # puts @bouch.quarters['1'].inspect
-        expect(@bouch.quarters['1'].length).to be > 0
+        expect(@bouch.quarters[1].length).to be > 0
       end
       it 'creates an array of financial quarter three budget items greater than zero' do
-        # Uncomment line below for Debug
-        # puts @bouch.quarters['2'].inspect
-        expect(@bouch.quarters['2'].length).to be > 0
+        expect(@bouch.quarters[2].length).to be > 0
       end
       it 'creates an array of financial quarter four budget items greater than zero' do
-        # Uncomment line below for Debug
-        # puts @bouch.quarters['3'].inspect
-        expect(@bouch.quarters['3'].length).to be > 0
+        expect(@bouch.quarters[3].length).to be > 0
       end
     end
   end

data/spec/bouch_cli_spec.rb

@@ -1,10 +1,17 @@
 # frozen_string_literal: true
 
+require 'stringio'
+require 'yaml'
 require 'bouch/cli'
 
 describe 'Bouch::CLI' do
   before :all do
-    @cli = Bouch::CLI.new('pouch.example.yml')
+    @tempfile = create_example_pouch_tempfile
+    @cli = Bouch::CLI.new(@tempfile.path)
+  end
+
+  after :all do
+    @tempfile.unlink
   end
 
   it 'is a Bouch::CLI object' do
@@ -25,15 +32,56 @@ describe 'Bouch::CLI' do
       end
     end
 
+    context 'when --help flag is supplied' do
+      it 'outputs usage help message' do
+        @cli.yaml_file = '--help'
+        expect { @cli.start }.to output(/Usage:/).to_stdout
+      end
+    end
+
+    context 'when -h flag is supplied' do
+      it 'outputs usage help message' do
+        @cli.yaml_file = '-h'
+        expect { @cli.start }.to output(/Usage:/).to_stdout
+      end
+    end
+
+    context 'when --version flag is supplied' do
+      it 'outputs the version' do
+        @cli.yaml_file = '--version'
+        expect { @cli.start }.to output(/bouch #{Bouch::VERSION}/).to_stdout
+      end
+    end
+
+    context 'when -v flag is supplied' do
+      it 'outputs the version' do
+        @cli.yaml_file = '-v'
+        expect { @cli.start }.to output(/bouch #{Bouch::VERSION}/).to_stdout
+      end
+    end
+
+    context 'when example subcommand is supplied' do
+      it 'outputs valid YAML with expected top-level keys' do
+        @cli.yaml_file = 'example'
+        output = capture_stdout { @cli.start }
+        parsed = YAML.safe_load(output)
+        expect(parsed).to have_key('Budget')
+        expect(parsed).to have_key('Salary')
+        expect(parsed).to have_key('Assets')
+        expect(parsed).to have_key('Equity')
+        expect(parsed).to have_key('Debts')
+      end
+    end
+
     context 'when an existent file is supplied as the first CLI argument' do
       it 'calculates a budget from a budget pouch file and outputs it' do
-        @cli.yaml_file = 'pouch.example.yml'
+        @cli.yaml_file = @tempfile.path
         expect { @cli.start }.to output.to_stdout
       end
     end
 
     context 'when a non-existent file is supplied as the first CLI argument' do
-      it 'ouputs a warning and usage help messsages' do
+      it 'outputs a warning and usage help messages' do
         @cli.yaml_file = 'foobar.yml'
         expect { @cli.start }.to output.to_stdout
       end
@@ -44,5 +92,18 @@ describe 'Bouch::CLI' do
     it 'outputs a bouch usage help message' do
       expect { @cli.usage }.to output.to_stdout
     end
+
+    it 'includes example subcommand in usage' do
+      expect { @cli.usage }.to output(/example/).to_stdout
+    end
   end
 end
+
+def capture_stdout
+  original_stdout = $stdout
+  $stdout = StringIO.new
+  yield
+  $stdout.string
+ensure
+  $stdout = original_stdout
+end

data/spec/bouch_pouch_yaml_spec.rb

@@ -1,15 +1,15 @@
 # frozen_string_literal: true
 
 require 'yaml'
+require 'bouch/example'
 
 describe 'Pouch YAML Schema' do
   before :all do
-    @yaml = File.realdirpath('pouch.example.yml')
-    @pouch = YAML.safe_load(IO.read(@yaml))
+    @pouch = YAML.safe_load(Bouch::EXAMPLE_POUCH)
   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

@@ -1,11 +1,16 @@
 # frozen_string_literal: true
 
+require 'tempfile'
 require 'bouch'
 
 describe Bouch do
   before :all do
-    @yaml = File.realdirpath('pouch.example.yml')
-    @bouch = Bouch.new(@yaml)
+    @tempfile = create_example_pouch_tempfile
+    @bouch = Bouch.new(@tempfile.path)
+  end
+
+  after :all do
+    @tempfile.unlink
   end
 
   it 'is a Bouch object' do
@@ -24,9 +29,21 @@ 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)))
+      expect(@bouch.pouch).to eq(YAML.safe_load(Bouch::EXAMPLE_POUCH))
     end
   end
 
@@ -37,7 +54,7 @@ describe Bouch do
   end
 
   describe '.show_assets_total' do
-    it 'outputs financial budget assests sum' do
+    it 'outputs financial budget assets sum' do
       expect { @bouch.show_assets_total }.to output.to_stdout
     end
   end
@@ -54,6 +71,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
@@ -83,4 +112,37 @@ describe Bouch do
       expect { @bouch.show_budget }.to output.to_stdout
     end
   end
+
+  describe 'missing YAML sections' do
+    before :all do
+      minimal = <<~YAML
+        ---
+        Budget:
+          Q1:
+            foo: 100
+          Q2:
+            bar: 200
+          Q3:
+            baz: 300
+          Q4:
+            qax: 400
+        Salary:
+          quantity: 1000
+          frequency: 2
+        ...
+      YAML
+      @minimal_yaml = Tempfile.new(['pouch', '.yml'])
+      @minimal_yaml.write(minimal)
+      @minimal_yaml.close
+      @minimal_bouch = Bouch.new(@minimal_yaml.path)
+    end
+
+    after :all do
+      @minimal_yaml.unlink
+    end
+
+    it 'does not crash when Assets, Equity, and Debts are missing' do
+      expect { @minimal_bouch.show_budget }.to output.to_stdout
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 require 'simplecov'
+require 'tempfile'
+require 'bouch/example'
 
 # This file was generated by the `rspec --init` command. Conventionally, all
 # specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
@@ -79,3 +81,11 @@ RSpec.configure do |config|
   # as the one that triggered the failure.
   Kernel.srand config.seed
 end
+
+# Write the embedded example pouch to a tempfile for use across specs
+def create_example_pouch_tempfile
+  tempfile = Tempfile.new(['pouch', '.yml'])
+  tempfile.write(Bouch::EXAMPLE_POUCH)
+  tempfile.close
+  tempfile
+end

metadata

@@ -1,16 +1,28 @@
 --- !ruby/object:Gem::Specification
 name: bouch
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Shane R. Sofos
-autorequire: 
-bindir:
-- bin
+bindir: bin
 cert_chain: []
-date: 2018-06-09 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: paint
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -57,16 +69,16 @@ dependencies:
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "<="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.56.0
+        version: '1.72'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "<="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.56.0
+        version: '1.72'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -104,8 +116,8 @@ files:
 - lib/bouch.rb
 - lib/bouch/calc.rb
 - lib/bouch/cli.rb
+- lib/bouch/example.rb
 - lib/bouch/version.rb
-- pouch.example.yml
 - spec/bouch_calc_spec.rb
 - spec/bouch_cli_spec.rb
 - spec/bouch_pouch_yaml_spec.rb
@@ -116,7 +128,6 @@ homepage: https://gitlab.com/ssofos/bouch
 licenses:
 - GPL-3.0
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -124,23 +135,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14
-signing_key: 
+rubygems_version: 4.0.3
 specification_version: 4
 summary: A simple tool to calculate and project your annual personal budget based
   on fiscal quarters expenditures, income, assets, and debts.
-test_files:
-- spec/bouch_calc_spec.rb
-- spec/bouch_cli_spec.rb
-- spec/bouch_pouch_yaml_spec.rb
-- spec/bouch_spec.rb
-- spec/bouch_version_spec.rb
-- spec/spec_helper.rb
+test_files: []

data/pouch.example.yml

@@ -1,36 +0,0 @@
----
-Budget:
-  Q1:
-    Rent:
-      cost: 1000
-      repeat: true
-    foo: 20
-    bar: 5
-  Q2:
-    Rent:
-      cost: 1000
-      repeat: true
-    fizz: 20
-    buzz: 5
-  Q3:
-    Rent:
-      cost: 1000
-      repeat: true
-    bubble: 20
-    sort: 5
-  Q4:
-    Rent:
-      cost: 1000
-      repeat: true
-    baz: 20
-    qax: 5
-Salary:
-  quantity: 1108.00
-  frequency: 2
-Assets:
-  foo: 500
-  bar: 500
-Debts:
-  baz: 120
-  qax: 300
-...