foundation_kit 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: afa1fd9ebda35a8589566b0a03c83501f0f897a5
+  data.tar.gz: 91b595a9e1d85428f3b2bcc30a18300a6cb80b8c
+SHA512:
+  metadata.gz: 1bf5eedaf8fe98c78267a0f22f5e69bfcd12be37cbaeba7c94705a97a36dfe5f1d849413bf9cf183b955280e220d9e135bfd3dae3bf78e064749cac7d6c806a4
+  data.tar.gz: eacae966c7ab6433de20de2a3d8244f2fdcd5dde1b8886c53968c010016cd5fe382dfac6e8008b3ca7fcfedca4bfc4fd9201b0cddb7167e84acc84366ab467f2

data/.gitignore

@@ -0,0 +1,50 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+.rspec_status
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.rubocop.yml

@@ -0,0 +1 @@
+inherit_from: .rubocop_todo.yml

data/.rubocop_todo.yml

@@ -0,0 +1,25 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2018-03-24 13:50:32 -0800 using RuboCop version 0.54.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 2
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+    - 'lib/foundation_kit/version.rb'
+
+# Offense count: 2
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# URISchemes: http, https
+Metrics/LineLength:
+  Enabled: false
+
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'

data/Gemfile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in foundation_kit.gemspec
+gemspec
+
+gem 'guard'
+gem 'guard-rspec'
+gem 'guard-rubocop'
+gem 'rubocop', require: false

data/Guardfile

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exists?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: 'bundle exec rspec' do
+  require 'guard/rspec/dsl'
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end
+
+guard :rubocop do
+  watch(/.+\.rb$/)
+  watch(%r{(?:.+/)?\.rubocop(?:_todo)?\.yml$}) { |m| File.dirname(m[0]) }
+end

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,30 @@
+# FoundationKit
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'foundation_kit'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install foundation_kit
+
+## Usage
+
+TODO
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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/jcrum/foundation_kit.

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'foundation_kit'
+
+# 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/foundation_kit.gemspec

@@ -0,0 +1,38 @@
+
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'foundation_kit/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'foundation_kit'
+  spec.version       = FoundationKit::VERSION::STRING
+  spec.authors       = ['Jason Crum']
+  spec.email         = ['me@jasonmcrum.com']
+
+  spec.summary       = 'FoundationKit provides....'
+  spec.description   = 'FoundationKit provides....'
+  spec.homepage      = 'https://github.com/jcrum/foundation_kit'
+
+  # 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'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
+  end
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'yard'
+end

data/lib/foundation_kit/base_class.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module FoundationKit
+  #
+  # BaseCass provides a core set of functionality for all
+  #  classes that extend from it.
+  #
+  # @author [jmc]
+  #
+  class BaseClass
+    # The initialize method - DUH
+    # @param **args it accepts all of the children arguments
+    def initialize(**args)
+      after_initialize(args)
+    end
+
+    # Returns a Hash representation of the current object
+    # @return [Hash]
+    # @example Convert an instance to a hash
+    #   myobj.to_h
+    def to_h
+      temp = {}
+      instance_variables.each do |var|
+        temp[var.to_s.delete('@').to_sym] = hide_instance_variables(var)
+      end
+      temp
+    end
+
+    def to_s
+      to_s_string = "#{self.class}: "
+      instance_variables.each do |var|
+        to_s_string += "#{var}: #{hide_instance_variables(var)}, "
+      end
+      to_s_string += "object_id: 0x00#{(object_id << 1).to_s(16)}"
+      to_s_string
+    end
+    alias inspect to_s
+
+    private
+
+    # After initialize hook - should be defined in children class
+    # @param **args should simple take in all the parameters from the initialize method by default
+    def hide_instance_variables(var)
+      if !%i[@password @pwd @pass].include? var
+        instance_variable_get(var)
+      else
+        '**************'
+      end
+    end
+
+    def after_initialize(**_args)
+      nil
+    end
+  end
+end

data/lib/foundation_kit/class.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+#
+# Adds additional behavior to Class
+#
+# @author [jcrum]
+#
+class Class
+  #
+  # Provides the ability to define an abstract method on a class
+  # @param *args
+  #
+  # @raise [FoundationKit::Errors::ClassNotImplmentedError]
+  # @raise [FoundationKit::Errors::MethodNotImplmentedError]
+  def abstract_definition(*args)
+    # rubocop:disable Style/GuardClause, Lint/UnusedBlockArgument, Lint/ShadowingOuterLocalVariable
+    args.each do |method_name|
+      define_method(method_name) do |*args|
+        if method_name == :initialize
+          raise FoundationKit::Errors::ClassNotImplementedError.new(class_name: self.class.name)
+        else
+          raise FoundationKit::Errors::MethodNotImplementedError.new(class_name: self.class.name, method_name: method_name)
+        end
+      end
+      # rubocop:enable Style/GuardClause, Lint/UnusedBlockArgument, Lint/ShadowingOuterLocalVariable
+    end
+  end
+end

data/lib/foundation_kit/command.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module FoundationKit
+  #
+  # Implements an abstract class for the command design pattern.
+  #
+  # @author jcrum
+  #
+  class Command < BaseClass
+    attr_reader :description
+    attr_reader :execution_order
+    attr_reader :result
+
+    #
+    # Creates an instance of the Command class
+    #
+    # @param description: nil [String] Description of the command.
+    # @param execution_order: nil [Integer] Used to determine order of execution
+    # .  if it is part of a composite command exection plan and order matters.
+    # @param **args Additional arguments used for subclasses to pass to
+    # .  post initialization hooks.
+    #
+    # @return [FoundationKit::Command]
+    def initialize(description: nil, execution_order: nil, **args)
+      @description = description
+      @execution_order = execution_order
+      @success = false
+
+      super(description: description, execution_order: execution_order, **args)
+    end
+
+    #
+    # Executes the logic for the command
+    #
+    # @abstract
+    # @raise [FoundationKit::Errors::MethodNotImplmentedError]
+    abstract_definition :execute
+
+    #
+    # Successful execution checker
+    #
+    # @return [Boolean] Was the execution of the command successful?
+    def success?
+      @success || false
+    end
+
+    #
+    # Hook to execute if the command was successful
+    #
+    # @abstract
+    # @raise [FoundationKit::Errors::MethodNotImplmentedError]
+    abstract_definition :on_success
+
+    #
+    # Hook to execute if the command was not successful
+    #
+    # @abstract
+    # @raise [FoundationKit::Errors::MethodNotImplmentedError]
+    abstract_definition :on_failure
+
+    #
+    # Hook to execute before the command executes the core logic
+    #
+    # @abstract
+    # @raise [FoundationKit::Errors::MethodNotImplmentedError]
+    abstract_definition :before_execution
+
+    #
+    # Hook to execute after the command executes the core logic
+    #
+    # @abstract
+    # @raise [FoundationKit::Errors::MethodNotImplmentedError]
+    abstract_definition :after_execution
+  end
+end

data/lib/foundation_kit/composite_command.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module FoundationKit
+  #
+  # Implements the Composite Command design pattern.
+  #
+  # @author jcrum
+  #
+  class CompositeCommand < BaseClass
+    attr_reader :commands
+
+    #
+    # Creates an instance of the Composite Command
+    # @param **args Additional arguments used for subclasses to pass to
+    # .  post initialization hooks.
+    #
+    # @return [FoundationKit::CompositeCommand]
+    #
+    def initialize(**args)
+      @commands = []
+
+      super(args)
+    end
+
+    #
+    # Adds a command for execution
+    # @param command [FoundationKit::Command] and instance of a class that
+    # .  extends FoundationKit::Command
+    #
+    def add_command(command)
+      commands << command
+    end
+
+    #
+    # Executes the commands
+    #
+    # @todo Implement execution order
+    #
+    def execute
+      commands.each(&:execute)
+    end
+  end
+end

data/lib/foundation_kit/connector.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module FoundationKit
+  #
+  # Base connector class
+  #
+  # @author [jcrum]
+  #
+  class Connector < BaseClass
+    #
+    # Connect method
+    #
+    # @abstract
+    # @raise [FoundationKit::Errors::MethodNotImplmentedError]
+    abstract_definition :connect
+    abstract_definition :disconnect
+
+    def initialize(**args)
+      @user = args[:user]
+      @password = args[:password]
+      @host = args[:host]
+      @port = args[:port]
+      @database = args[:database]
+      @options = args[:options]
+      @adapter = args[:adapter]
+      super(args)
+    end
+  end
+end

data/lib/foundation_kit/errors.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module FoundationKit
+  #
+  # FoundationKit::Errors
+  #
+  # @author [jcrum]
+  #
+  module Errors
+    #
+    # Abstract Method Error
+    #
+    # @author [jcrum]
+    #
+    class MethodNotImplementedError < StandardError
+      #
+      # @param class_name: [String] name of the class where the abstract method is called
+      # @param method_name: [String] name of the abstract method called
+      # @param message: 'is an abstract method and has not been implemented yet.' [String] message to override
+      #
+      # @return MethodNotImplementedError
+      def initialize(class_name:, method_name:, message: 'is an abstract method and has not been implemented yet.')
+        super("#{class_name}##{method_name} #{message}")
+      end
+    end
+
+    #
+    # Abstract Class Error
+    #
+    # @author [jcrum]
+    #
+    class ClassNotImplementedError < StandardError
+      #
+      # @param class_name: [String] name of the class where the abstract method is called
+      # @param message: 'is an abstract class and has not been implmented yet.' [String] message to override
+      #
+      # @return ClassNotImplementedError
+      def initialize(class_name:, message: 'is an abstract class and has not been implmented yet.')
+        super("#{class_name} #{message}")
+      end
+    end
+  end
+end

data/lib/foundation_kit/inventory.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+module FoundationKit
+  #
+  # Inventory mixin methods
+  #
+  # @author [jcrum]
+  #
+  module InventoryMixin
+    #
+    # Adds an item to inventory
+    # @param name: [String,Symbol] Name of the item being added
+    # @param item: [Object] The item being added to inventory
+    def add(name:, item:)
+      stock[name.to_sym] = item
+    end
+
+    #
+    # Returns the inventory count
+    #
+    # @return [Integer]
+    def count
+      stock.count
+    end
+
+    #
+    # Returns whether or not the inventory has items
+    #
+    # @return [Boolean]
+    def stock?
+      !stock.count.zero?
+    end
+
+    #
+    # Returns whether or not the Inventory is empty
+    #
+    # @return [type] [description]
+    def out_of_stock?
+      stock.count.zero?
+    end
+
+    #
+    # Removes an item from Inventory
+    # @param name: [String, Symbol] Item name to be removed
+    def remove(name:)
+      stock.delete(name.to_sym)
+    end
+
+    #
+    # Returns the current items in Inventory
+    #
+    # @return [Hash]
+    def stock
+      @stock ||= {}
+    end
+
+    #
+    # Allows an item in inventory to be used
+    # @param name: [String, Symbol]
+    #
+    # @return [Object] Item referenced by the supplied name
+    def use(name:)
+      stock[name.to_sym]
+    end
+  end
+
+  #
+  # Inventory provides ability to Store related items
+  #  and 'use' them by referencing their names
+  #
+  # @author [jcrum]
+  #
+  class Inventory
+    include FoundationKit::InventoryMixin
+  end
+end

data/lib/foundation_kit/repository.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module FoundationKit
+  #
+  # Base repository class
+  #
+  # @author [jcrum]
+  #
+  class Repository < BaseClass
+    #
+    # [initialize description]
+    # @param connector: nil [FoundationKit::Connector] Connector to use
+    # @param source: nil [type] [description]
+    #
+    # @return [type] [description]
+    def initialize(connector: nil, source: nil)
+      @connector = connector
+      @source = source
+      super
+    end
+
+    #
+    # Fetch method
+    #
+    # @abstract
+    # @raise [FoundationKit::Errors::MethodNotImplmentedError]
+    abstract_definition :fetch
+
+    #
+    # Create method
+    #
+    # @abstract
+    # @raise [FoundationKit::Errors::MethodNotImplmentedError]
+    abstract_definition :create
+
+    #
+    # Update method
+    #
+    # @abstract
+    # @raise [FoundationKit::Errors::MethodNotImplmentedError]
+    abstract_definition :update
+
+    #
+    # Delete method
+    #
+    # @abstract
+    # @raise [FoundationKit::Errors::MethodNotImplmentedError]
+    abstract_definition :delete
+  end
+end

data/lib/foundation_kit/version.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module FoundationKit
+  # Blatently stolen from Rails/version.rb
+  #  https://github.com/rails/rails/blob/master/version.rb
+  def self.gem_version
+    Gem::Version.new VERSION::STRING
+  end
+
+  module VERSION
+    MAJOR = 0
+    MINOR = 1
+    TINY  = 0
+    PRE   = nil
+
+    STRING = [MAJOR, MINOR, TINY, PRE].compact.join('.')
+  end
+end

data/lib/foundation_kit.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+Dir.glob("#{File.dirname(__FILE__)}/**/*.rb").sort.each { |path| require path }
+
+#
+# TODO
+#
+# @author [jcrum]
+#
+module FoundationKit
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: foundation_kit
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jason Crum
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-03-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  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: FoundationKit provides....
+email:
+- me@jasonmcrum.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- foundation_kit.gemspec
+- lib/foundation_kit.rb
+- lib/foundation_kit/base_class.rb
+- lib/foundation_kit/class.rb
+- lib/foundation_kit/command.rb
+- lib/foundation_kit/composite_command.rb
+- lib/foundation_kit/connector.rb
+- lib/foundation_kit/errors.rb
+- lib/foundation_kit/inventory.rb
+- lib/foundation_kit/repository.rb
+- lib/foundation_kit/version.rb
+homepage: https://github.com/jcrum/foundation_kit
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+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: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: FoundationKit provides....
+test_files: []