caution 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5ac1001fd1b5e7504dd8b415bc915ce3c2b9ba91
+  data.tar.gz: 8959252e7804879bfce6e5b1711cbad0902d8573
+SHA512:
+  metadata.gz: 9b1fc759ef7f3f5fb5f18ac118e0b374c3253ddfddcab1fa105e9a4031ea5554d06dda3b6e5ac3483e45238cb68a36ee9504342cc3cbefbe06c47f72a3e02f8a
+  data.tar.gz: fb228a07b111cf43a3a0a792a428df721a662f6b7f85734d502450516e918ec8b8644753579b3dab4636e429688b598ad502eb0e7706b7a6de8bad41440bff3c

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,23 @@
+AllCops:
+  Exclude:
+    - 'bin/**/*'
+    - 'vendor/**/*'
+  DisplayCopNames: true
+  TargetRubyVersion: 2.3.8
+
+Metrics/BlockLength:
+  Enabled: true
+  Exclude:
+    - spec/**/*_spec.rb
+
+Metrics/LineLength:
+  Max: 100
+
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: comma

data/.travis.yml

@@ -0,0 +1,15 @@
+sudo: false
+language: ruby
+rvm:
+- 2.3.8
+- 2.4.5
+- 2.5.3
+cache: bundler
+before_install: gem install bundler -v 1.17.2
+script:
+  - bundle exec rspec
+  - bundle exec rubocop
+notifications:
+  hipchat:
+    rooms:
+      secure: QAkfosLUyeazHpg215UKvMonOHMsV2QRxN7hPvrdhIujNme7xm1EU5sLjAf8NFS5qrLBK9qqZpUcR32dqM/uQ+Sodi9FjZ29Q2YpFGHxy5N+yHLo1bla7dW+Uj8soLh6Sd12nO45xDbQM5N5t+dZAfQPyewxr//PR5bmC/HuhW5tBcsRZX+lkp1YPs8h17u4lnNcf8g5EtBq0CdughBdgIjDJGiERx6OclyDh8HQ2BZhhFITsWs2/dDAOPRfSk6CcRVard47aybFnEFvOu21/r3J3UNN0dy1pf9o0L7qBOEoinm5UAbllEHq+EyYHVeNa5YnjX6m51k/X13D+2BzaiLZ06VS95v5Irj0mWJj+vUJ2WY0ED0ywyRf2F6VIJXzL8FXVz/mIFIvMmyinm1slv7G+6jFeJaHhm3HiYoAwBfbvYoT20cUxYl0Lsu3h0yLbt7YvxwoURCpCFAW/wl7gLIL3nD0lncHFTAScsL2QMbOe5eX/CBLR1TBe+5ZjNe1NsWyvPuWeS8V6fllg3ve1AIMRaI4PZXbjXqFusAGVttZ8a8P7YxachsXkVdYKGJ3Dr3EDXh2cYwxlG80XIWaHulVJPyC5RyX2U0qwdFuWaPUdDfH8rQ2o4YmakG69Zoy7cqbK/rukFHhCc9RA8yn4g2gqwVyGY/10eWH+LDGFrU=

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+
+## 0.1.0 (December, 12, 2018)
+
+* Initial release.

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in caution.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,53 @@
+PATH
+  remote: .
+  specs:
+    caution (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    diff-lcs (1.3)
+    jaro_winkler (1.5.1)
+    parallel (1.12.1)
+    parser (2.5.3.0)
+      ast (~> 2.4.0)
+    powerpack (0.1.2)
+    rainbow (3.0.0)
+    rake (12.3.1)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    rubocop (0.60.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.4.0)
+    ruby-progressbar (1.10.0)
+    unicode-display_width (1.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  caution!
+  rake
+  rspec
+  rubocop
+
+BUNDLED WITH
+   1.17.2

data/LICENSE

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

data/README.md

@@ -0,0 +1,97 @@
+# ⚠️ Caution ⚠️
+
+[![Build Status](https://travis-ci.org/bluemarblepayroll/caution.svg?branch=master)](https://travis-ci.org/bluemarblepayroll/caution)
+
+Essential general purpose Ruby error classes.
+
+## Usage
+
+Two error classes are provided. The first is IllegalStateError which is intended to be raised from inside a method when the current internal state would prevent a successful operation. For those coming from Java or .Net, this is analogous to an IllegalStateError or an InvalidOperationException.
+
+### Caution::IllegalStateError Example
+
+```ruby
+  def delete
+    raise Caution::IllegalStateError, 'can not delete when not persisted' unless persisted?
+
+    # logic here to actually perform the delete
+  end
+```
+
+The second class is CauseInjectingError which is intended for cases when wrapping a low level exception with a higher level exception. It is intended to be subclassed with an error class which fits the application's domain. The benefit it provides is that information about the lower level exception is available in the CauseInjectingError's message. This can be helpful when using application frameworks which are not aware of Ruby's fairly recent [Exception#cause](https://ruby-doc.org/core-2.6.0.preview2/Exception.html#method-i-cause) method.
+
+### Caution::CauseInjectingError Example
+
+```ruby
+  # Define your own subclass:
+  class HighLevelError < Caution::CauseInjectingError; end
+
+  # Then use the error to wrap a low level error:
+  def process_records
+    records.each do |record|
+      begin
+        # some low level code to process the record which could raise a LowLevelError
+      rescue LowLevelError
+        # Like all Ruby 2 exceptions, the LowLevelError is captured in the cause:
+        raise HighLevelError, 'Could not process record #{record.id}'
+      end
+    end
+  end
+
+  def main
+    process_records
+  rescue => error
+    # The HighLevelError message is printed along with the LowLevelError
+    # message and stack trace. Without CauseInjectingError, only HighLevelError
+    # information is included in the message.
+    $stderr.puts("An unexpected error occured: #{error.message}")
+  end
+```
+
+## Installation
+
+To install through Rubygems:
+
+````
+gem install install caution
+````
+
+You can also add this to your Gemfile:
+
+````
+bundle add caution
+````
+
+## Contributing
+
+### Development Environment Configuration
+
+Basic steps to take to get this repository set up:
+
+1. Install [Ruby](https://www.ruby-lang.org/en/documentation/installation/) (check caution.gemspec for versions supported)
+2. Install bundler (`gem install bundler`)
+3. Clone the repository (`git clone git@github.com:bluemarblepayroll/caution.git`)
+4. Navigate to the root folder (`cd caution`)
+5. Install dependencies (`bundle`)
+
+### Running Tests
+
+To execute the test suite run:
+
+````
+rspec
+````
+
+Also be sure to run Rubocop:
+
+```
+rubocop
+```
+
+### Pull Requests
+
+Pull requests are welcome! Please ensure that the tests and Rubocop are passing before submission.
+
+## License
+
+This project is MIT Licensed.

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,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "caution"
+
+# 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

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/caution.gemspec

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'caution/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'caution'
+  spec.version       = Caution::VERSION
+  spec.authors       = ['Ryan Gerry']
+  spec.email         = ['rgerry@bluemarblepayroll.com']
+
+  spec.summary       = 'Essential general purpose Ruby error classes.'
+  spec.description   = 'Provides several usefull error classes for common use-cases.'
+  spec.homepage    = 'https://github.com/bluemarblepayroll/caution'
+  spec.license     = 'MIT'
+
+  spec.required_ruby_version = '>= 2.3'
+
+  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'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rubocop'
+end

data/lib/caution.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'caution/version'
+
+require 'caution/cause_injecting_error'
+require 'caution/illegal_state_error'
+
+# Defines the root level module for the gem. See the README.md for an overview.
+module Caution
+  # Your code goes here...
+end

data/lib/caution/cause_injecting_error.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Caution
+  # This provide some context as to which lower level exception casued the error.
+  # Nested exceptions are a relatively new idea to the Ruby ecosystem most things do not
+  # print out the entire exception chain. This works around that by injecting the original
+  # stack trace into the error message.
+  #
+  # Usage:
+  #
+  # begin
+  #   # Some code which may raise an exception
+  # end
+  # rescue
+  #   raise CauseInjectingError, 'An helpful message'
+  # end
+  #
+  # CauseInjectingError will automatically save the original error using the "cause" functionality
+  # of Exception.
+  #
+  # See http://www.virtuouscode.com/2013/12/25/exception-causes-in-ruby-2-1/ for more
+  # information.
+  class CauseInjectingError < StandardError
+    def message
+      if cause
+        "#{super}\n" \
+          "Caused by: #{cause.class}: #{cause.message}\n" \
+          "The original stack trace was:\n" \
+          "#{cause.backtrace.join("\n")}\n" \
+          "END original stack trace \n\n"
+      else
+        super
+      end
+    end
+  end
+end

data/lib/caution/illegal_state_error.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Caution
+  # An error to raise when an object or system is in an unsupported state.
+  # Inspired by Java's IllegalStateException
+  # (https://docs.oracle.com/javase/8/docs/api/index.html?java/lang/IllegalStateException.html)
+  # and .Net's InvalidOperationException
+  # (https://docs.microsoft.com/en-us/dotnet/api/system.invalidoperationexception?view=netframework-4.7.2).
+  #
+  # Note that this is named IllegalStateError and not IllegalStateException as it inherits from
+  # StandardError and all of the classes which inherit from StandardError in the Ruby Standard
+  # Library end in Error.
+  class IllegalStateError < StandardError
+  end
+end

data/lib/caution/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Caution
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: caution
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ryan Gerry
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-12-12 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'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Provides several usefull error classes for common use-cases.
+email:
+- rgerry@bluemarblepayroll.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- caution.gemspec
+- lib/caution.rb
+- lib/caution/cause_injecting_error.rb
+- lib/caution/illegal_state_error.rb
+- lib/caution/version.rb
+homepage: https://github.com/bluemarblepayroll/caution
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2.3
+signing_key: 
+specification_version: 4
+summary: Essential general purpose Ruby error classes.
+test_files: []