exceptions_tree 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fb18aab90a9fab876a96732f07b7a9115c745c15
+  data.tar.gz: b151a192c5a71787246468fb7afd10f8dd847fea
+SHA512:
+  metadata.gz: dee5fe6aeb74ceb254c62e7c36e74fabe8842f87ede8be5efd60a41a8e9287fef6d80eeefad9b4860c440d7650d8783622cc3e4535f2ba9b4070fc3e219bb53c
+  data.tar.gz: 65c56d21907248660c63a7438bd85ba0cc10c26afcca3358504b0e4c5a80194f68c53a89864cbc65d9dd375de6db23293c8cdde6cf397a43b42e84497167ad0c

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in exceptions_tree.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Alan Stebbens <aks@stebbens.org>,<alan.stebbens@procore.com>
+
+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,74 @@
+# ExceptionsTree
+
+When dealing with errors, ruby developers are encouraged to capture specific
+exceptions, but seeing which exceptions are currently configured (and thus
+possible) is a challenge, especially with exceptions being dynamically
+configured as gems are loaded.
+
+The `ExceptionsTree` ruby gem provides adds both a rake task and a script which
+allows developers to see the Exceptions hierarchy configured for the
+application.   If the application is based on Rails, this gem uses `railties`
+to tie in the rake task correctly.  However, this gem also works fine with ruby
+scripts that are not Rails based.
+
+The rake task is done with:
+
+    bundle exec rake exceptions
+
+The script is invoked:
+
+    display_exceptions
+
+The output can be quite long, as many applications have lots of gems that
+insert their own exceptions to the hierarchy. Of course, if you are searching
+for a particular exception, you can pipe the output through `grep` to find it.
+For example:
+
+    display_exceptions | grep IO    # _to find the IO exceptions_
+
+## Installation
+
+Add this line to your application's `Gemfile`:
+
+```ruby
+gem 'exceptions_tree'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install exceptions_tree
+
+## Usage
+
+    bundle exec rake exceptions
+
+    display_exceptions
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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/[USERNAME]/exceptions_tree. This project is intended to be
+a safe, welcoming space for collaboration, and contributors are expected to
+adhere to the [Contributor Covenant](http://contributor-covenant.org) code of
+conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

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

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "exceptions_tree"
+
+# 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
+
+ExceptionsTree.display_exceptions

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

@@ -0,0 +1,39 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'exceptions_tree/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "exceptions_tree"
+  spec.version       = ExceptionsTree::VERSION
+  spec.authors       = ["Alan Stebbens"]
+  spec.email         = ["aks@stebbens.org", "alan.stebbens@procore.com"]
+
+  spec.summary       = %q{Adds a rake task to show the currently configured Exception hierarchy.}
+  spec.description   = %q{\
+  Provides `rake task exceptions` or `display_exceptions` script which display the 
+  currently configured Exceptions hierarchy.
+  }
+  spec.homepage      = "https://github.com/aks/exceptions_tree.git"
+  spec.license       = "MIT"
+
+  # 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'] = "TODO: Set to 'http://mygemserver.com'"
+  #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        = "bin"
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  #spec.add_development_dependency "pry-byebug" # only when debugging
+end

data/lib/exceptions_tree.rb

@@ -0,0 +1,3 @@
+require 'exceptions_tree/version'
+require 'exceptions_tree/display.rb'
+require 'exceptions_tree/railtie.rb' if defined? Rails

data/lib/exceptions_tree/display.rb

@@ -0,0 +1,26 @@
+module ExceptionsTree
+
+  class <<self
+    def display_exceptions
+      exception_classes = []
+      exception_tree = {}
+      ObjectSpace.each_object(Class) do |klass|
+        next unless klass.ancestors.include? Exception
+        next if exception_classes.include? klass
+        next if klass.superclass == SystemCallError # don't want ERRNO
+        exception_classes << klass
+        klass.ancestors.delete_if {|e| [Object, Kernel].include? e }.
+            reverse.inject(exception_tree) {|memo,klass2| memo[klass2] ||= {}}
+      end
+      show_exception_tree(exception_tree, 0)
+    end
+
+    def show_exception_tree(tree, level)
+      tree.keys.sort {|k1, k2| k1.name <=> k2.name}.each do |class_name|
+        printf "%s%s\n", ('  ' * level), class_name
+        show_exception_tree(tree[class_name], level+1)
+      end
+    end
+  end
+
+end

data/lib/exceptions_tree/railtie.rb

@@ -0,0 +1,12 @@
+require 'exceptions_tree'
+require 'rails'
+
+module ExceptionsTree
+  class Railtie < Rails::Railtie
+    railtie_name :exceptions_tree
+
+    rake_tasks do
+      load "tasks/exceptions_tree.rake"
+    end
+  end
+end

data/lib/exceptions_tree/version.rb

@@ -0,0 +1,3 @@
+module ExceptionsTree
+  VERSION = "1.0.0"
+end

data/lib/tasks/exceptions_tree.rake

@@ -0,0 +1,5 @@
+# exceptions_tree gem
+desc "Describe the configured exceptions heirarchy"
+task :exceptions do
+  ExceptionsTree::display_exceptions
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: exceptions_tree
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Alan Stebbens
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-10-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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'
+description: "\\\n  Provides `rake task exceptions` or `display_exceptions` script
+  which display the \n  currently configured Exceptions hierarchy.\n  "
+email:
+- aks@stebbens.org
+- alan.stebbens@procore.com
+executables:
+- console
+- display_exceptions
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/display_exceptions
+- bin/setup
+- exceptions_tree.gemspec
+- lib/exceptions_tree.rb
+- lib/exceptions_tree/display.rb
+- lib/exceptions_tree/railtie.rb
+- lib/exceptions_tree/version.rb
+- lib/tasks/exceptions_tree.rake
+homepage: https://github.com/aks/exceptions_tree.git
+licenses:
+- MIT
+metadata: {}
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Adds a rake task to show the currently configured Exception hierarchy.
+test_files: []