bouch 1.1.0

data/spec/bouch_cli_spec.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require 'bouch/cli'
+
+describe 'Bouch::CLI' do
+  before :all do
+    @cli = Bouch::CLI.new('pouch.example.yml')
+  end
+
+  it 'is a Bouch::CLI object' do
+    expect(@cli).to be_kind_of(Bouch::CLI)
+  end
+
+  describe '#yaml_file' do
+    it 'returns a name of a file that is a String' do
+      expect(@cli.yaml_file).to be_kind_of(String)
+    end
+  end
+
+  describe '.start' do
+    context 'when no file is supplied as the first CLI argument' do
+      it 'outputs warning and usage help messages' do
+        @cli.yaml_file = nil
+        expect { @cli.start }.to output.to_stdout
+      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'
+        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
+        @cli.yaml_file = 'foobar.yml'
+        expect { @cli.start }.to output.to_stdout
+      end
+    end
+  end
+
+  describe '.usage' do
+    it 'outputs a bouch usage help message' do
+      expect { @cli.usage }.to output.to_stdout
+    end
+  end
+end

data/spec/bouch_pouch_yaml_spec.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require 'yaml'
+
+describe 'Pouch YAML Schema' do
+  before :all do
+    @yaml = File.realdirpath('pouch.example.yml')
+    @pouch = YAML.safe_load(IO.read(@yaml))
+  end
+
+  it 'has four major Hash keys' do
+    expect(@pouch.keys.length).to eq(4)
+  end
+
+  it 'has a Hash key named Budget' do
+    expect(@pouch.key?('Budget')).to be_truthy
+  end
+
+  it 'has a Hash key named Salary' do
+    expect(@pouch.key?('Salary')).to be_truthy
+  end
+
+  it 'has a Hash key named Assets' do
+    expect(@pouch.key?('Assets')).to be_truthy
+  end
+
+  it 'has a Hash key named Debts' do
+    expect(@pouch.key?('Debts')).to be_truthy
+  end
+
+  it 'has Budget values that are Hashes' do
+    expect(@pouch['Budget']).to be_a_kind_of(Hash)
+  end
+
+  it 'has Salary values that are Hashes' do
+    expect(@pouch['Salary']).to be_a_kind_of(Hash)
+  end
+
+  it 'has Asset values that are Hashes' do
+    expect(@pouch['Assets']).to be_a_kind_of(Hash)
+  end
+
+  it 'has Debt values that are Hashes' do
+    expect(@pouch['Debts']).to be_a_kind_of(Hash)
+  end
+end

data/spec/bouch_spec.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+require 'bouch'
+
+describe Bouch do
+  before :all do
+    @yaml = File.realdirpath('pouch.example.yml')
+    @bouch = Bouch.new(@yaml)
+  end
+
+  it 'is a Bouch object' do
+    expect(@bouch).to be_kind_of(Bouch)
+  end
+
+  describe '#assets' do
+    it 'returns an empty Array of assets' do
+      expect(@bouch.assets).to be_empty
+    end
+  end
+
+  describe '#debts' do
+    it 'returns an empty Array of debts' do
+      expect(@bouch.debts).to be_empty
+    end
+  end
+
+  describe '#pouch' do
+    it 'loads the budget pouch YAML file' do
+      expect(@bouch.pouch).to eq(YAML.safe_load(IO.read(@yaml)))
+    end
+  end
+
+  describe '#quarters' do
+    it 'returns an empty Hash of fiscal quarters' do
+      expect(@bouch.quarters).to be_empty
+    end
+  end
+
+  describe '.show_assets_total' do
+    it 'outputs financial budget assests sum' do
+      expect { @bouch.show_assets_total }.to output.to_stdout
+    end
+  end
+
+  describe '.show_debts_total' do
+    it 'outputs financial budget debts sum' do
+      expect { @bouch.show_debts_total }.to output.to_stdout
+    end
+  end
+
+  describe '.show_debt_ratio' do
+    it 'outputs financial budget debt ratio' do
+      expect { @bouch.show_debt_ratio }.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
+    end
+  end
+
+  describe '.show_annual_total' do
+    it 'outputs financial budget quarters aggregate sum' do
+      expect { @bouch.show_annual_total }.to output.to_stdout
+    end
+  end
+
+  describe '.show_budget_percentage' do
+    it 'outputs financial budget income percentage' do
+      expect { @bouch.show_budget_percentage }.to output.to_stdout
+    end
+  end
+
+  describe '.show_annual_income' do
+    it 'outputs financial budget income sum' do
+      expect { @bouch.show_annual_income }.to output.to_stdout
+    end
+  end
+
+  describe '.show_budget' do
+    it 'outputs all financial budget summed components' do
+      expect { @bouch.show_budget }.to output.to_stdout
+    end
+  end
+end

data/spec/bouch_version_spec.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'bouch/version'
+
+describe 'Bouch::Version' do
+  it 'returns the RubyGem version of Bouch as a string' do
+    expect(Bouch::VERSION).to be_a_kind_of(String)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+require 'simplecov'
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  # config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+end

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: bouch
+version: !ruby/object:Gem::Version
+  version: 1.1.0
+platform: ruby
+authors:
+- Shane R. Sofos
+autorequire: 
+bindir:
+- bin
+cert_chain: []
+date: 2018-06-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: 0.56.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: 0.56.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: The Budget Pouch. Fast annual budget projections.
+email:
+- ssofos@gmail.com
+executables:
+- bouch
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".gitlab-ci.yml"
+- ".rspec"
+- ".rubocop.yml"
+- ".simplecov"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/bouch
+- bouch.gemspec
+- lib/bouch.rb
+- lib/bouch/calc.rb
+- lib/bouch/cli.rb
+- lib/bouch/version.rb
+- pouch.example.yml
+- 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
+homepage: https://gitlab.com/ssofos/bouch
+licenses:
+- GPL-3.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+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