exception_details 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+gemspec
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Eric Beland
+
+MIT License
+
+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,89 @@
+# Exception Details
+
+Exception Details causes instances of Exception to capture a binding at creation-time.
+It provides convenience methods on Exceptions to inspect all the variables and values
+from the time of the Exception and adds an informative log string.
+
+Features/benefits:
+
+	* Get detail (variables/values) about your Exception circumstances *without* reproducing the problem first.
+
+	* Reduced need for debug/logging code to find out what went wrong.
+
+	* Minimize ambiguous errors (which variable was nil?).
+
+	* A single statement method for a loggable string (avoid repeating exception log string creation)
+
+	* Get Pry like debug knowledge from cron job errors and running system logs without being there.
+
+	* Pry type information with less overhead/dependencies--binding_of_caller is the only dependency.
+
+
+## Example Usage
+
+	begin
+		greeting = 'hello'
+		@name = nil
+		puts greeting + name
+	rescue Exception => e
+		puts e.details
+		puts e.inspect_variables
+	end
+
+
+	e.details ->
+
+		Exception:
+			can't convert nil into String
+		Variables:
+			<String>greeting = "hello"
+			<TypeError>e = #<TypeError: can't convert nil into String>
+			<NilClass>@name = nil
+		Backtrace:
+			/Users/someguy/apps/exception_details/spec/exception_details_spec.rb:20:in `+'
+		/Users/someguy/apps/exception_details/spec/exception_details_spec.rb:20:in `block (3 levels) in <top (required)>'
+		/Users/someguy/.rvm/gems/ruby-1.9.3-p374/gems/rspec-core-2.14.3/lib/rspec/core/example.rb:114:in `instance_eval'
+		and so forth ...
+
+
+	e.inspect_variables ->
+
+		<String>greeting = "hello"
+		<TypeError>e = #<TypeError: can't convert nil into String>
+		<NilClass>@name = nil
+
+Or access the variables in the binding yourself...
+
+	e.binding_during_exception.eval("puts #{greeting}")
+
+## Installation
+
+Add to your Gemfile:
+
+    gem 'exception_details'
+
+Execute:
+
+    $ bundle
+
+Require it:
+
+	require 'exception_details'
+
+## Limitations
+- This gem requires [binding\_of\_caller]:https://github.com/banister/binding_of_caller, so it should only work with MRI 1.9.2, 1.9.3, 2.0
+and RBX (Rubinius). Does not work in 1.8.7, but there is a well known (continuation-based)
+hack to get a Binding#of_caller there. There is some mention about binding of caller supporting
+jruby, so feel free to try it out.
+
+- Getting a binding from a NameError seems to be problematic.
+
+- This gem is still new...
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/exception_details.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'exception_details/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "exception_details"
+  spec.version       = ExceptionDetails::VERSION
+  spec.authors       = ["Eric Beland"]
+  spec.email         = ["ebeland@gmail.com"]
+  spec.description   = %q{Inspect variables captured at exception-time to get info about your exceptions}
+  spec.summary       = %q{Exception Details extends Exception to let you inspect variable values at exception-time for logging etc.}
+  spec.homepage      = "https://github.com/ericbeland/exception_details"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+
+  spec.add_dependency "binding_of_caller"
+
+end

data/lib/exception_details.rb

@@ -0,0 +1,6 @@
+require 'binding_of_caller'
+
+require "exception_details/version"
+require "exception_details/inspect_variables"
+require "exception_details/log_color_helpers"
+require "exception_details/exception"

data/lib/exception_details/exception.rb

@@ -0,0 +1,53 @@
+require_relative '../exception_details'
+
+# Extend the Ruby Exception class with our helper methods.
+class Exception
+	include ExceptionDetails::InspectVariables
+	include ExceptionDetails::LogColorHelpers
+
+	# binding_during_exception lets you actually directly access
+	# the exception-time binding.
+	attr_accessor :binding_during_exception
+
+	# Provides a string with the variable names and values
+	# captured at exception time.
+	def inspect_variables(opts = {})
+		variable_inspect_string(binding_during_exception, opts)
+	end
+
+	# .details provides a fairly complete string for logging purposes.
+	# The message, variables in the exception's scope, and their current
+	# values are outputted, followed by the whole backtrace.
+	# * +options+ - options[:scope] default: [:local_variables, :instance_variables, :class_variables]
+	#  						- options[:colorize] true / false. Whether to add color to the output (for terminal/log)
+	def details(options = {})
+		options = {colorize:  true}.merge(options)
+		inspect_results = inspect_variables(options)
+		parts = []
+		parts << (options[:colorize] ? red('Exception:') : 'Exception:')
+		parts << "\t" + message
+		parts << (options[:colorize] ? red('Variables:') : 'Variables:')
+		parts << inspect_results
+		parts << (options[:colorize] ? red('Backtrace:') : 'Backtrace:')
+		parts << "\t" + backtrace.to_a.join("\n")
+		parts.join("\n")
+	end
+
+	class << self
+		alias :__new__ :new
+
+		def inherited(subclass)
+      class << subclass
+        alias :new :__new__
+      end
+    end
+	end
+
+		# override the .new method on exception to grab the binding where the exception occurred.
+		def self.new(*args, &block)
+			e = __new__(*args)
+			e.binding_during_exception = binding.of_caller(1)
+			e
+		end
+
+end

data/lib/exception_details/inspect_variables.rb

@@ -0,0 +1,50 @@
+module ExceptionDetails
+
+	# Mixin that provides methods for dumping variables
+	module InspectVariables
+
+	 SCOPES = [:local_variables, :instance_variables, :class_variables]
+
+	 private
+
+		# For each variable scope, build an array of strings displaying
+		# type, name and value of each variable in that scope
+		# * +target_binding+ - Binding context to inspect.
+		# * +variable_scope+ - Variable scope to dump. One of :local_variables,
+		# 										:instance_variables, :class_variables, :global variables
+
+		def dump_variables(target_binding, variable_scope)
+			variable_strings = []
+			if target_binding.eval("respond_to?(:#{variable_scope}, true)")
+				variable_names = target_binding.eval(variable_scope.to_s)
+				variable_names.each do |vname|
+					value = target_binding.eval(vname.to_s)
+					variable_value_string = "\t<#{value.class}>#{vname} = #{value.inspect}"
+					variable_strings << variable_value_string
+				end
+			end
+			variable_strings.sort
+		end
+
+		# Dump all variables and values in selected scopes into a string
+		# * +target_binding+ - Binding context to inspect.
+		# * +options+ - options[:scope] default: [:local_variables, :instance_variables, :class_variables]
+		#  						- :global_variables is valid as well. Can be an array, or single scope-name symbol
+		# or an array
+		def variable_inspect_string(target_binding, options = {})
+			if options[:scopes]
+				scopes = [options[:scopes]].flatten
+			end
+			return ["exception_details: Variable inspection unavailable (no binding captured)"] if target_binding.nil?
+			variable_scopes = scopes || SCOPES
+			dump_arrays = []
+			variable_scopes.each do |variable_scope|
+				variable_string_array = dump_variables(target_binding, variable_scope.to_s)
+				dump_arrays << variable_string_array if variable_string_array.length > 0
+			end
+			dump_arrays.join("\n")
+		end
+
+	end
+
+end

data/lib/exception_details/log_color_helpers.rb

@@ -0,0 +1,23 @@
+# Helper methods for printing colored output into the log/terminal
+module ExceptionDetails
+	module LogColorHelpers
+		def black(str);          "\033[30m#{str}\033[0m" end
+		def red(str);            "\033[31m#{str}\033[0m" end
+		def green(str);          "\033[32m#{str}\033[0m" end
+		def brown(str);          "\033[33m#{str}\033[0m" end
+		def blue(str);           "\033[34m#{str}\033[0m" end
+		def magenta(str);        "\033[35m#{str}\033[0m" end
+		def cyan(str);           "\033[36m#{str}\033[0m" end
+		def gray(str);           "\033[37m#{str}\033[0m" end
+		def bg_black(str);       "\033[40m#{str}\0330m"  end
+		def bg_red(str);         "\033[41m#{str}\033[0m" end
+		def bg_green(str);       "\033[42m#{str}\033[0m" end
+		def bg_brown(str);       "\033[43m#{str}\033[0m" end
+		def bg_blue(str);        "\033[44m#{str}\033[0m" end
+		def bg_magenta(str);     "\033[45m#{str}\033[0m" end
+		def bg_cyan(str);        "\033[46m#{str}\033[0m" end
+		def bg_gray(str);        "\033[47m#{str}\033[0m" end
+		def bold(str);           "\033[1m#{str}\033[22m" end
+		def reverse_color(str);  "\033[7m#{str}\033[27m" end
+	end
+end

data/lib/exception_details/version.rb

@@ -0,0 +1,3 @@
+module ExceptionDetails
+  VERSION = "0.0.1"
+end

data/spec/exception_details_spec.rb

@@ -0,0 +1,107 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+require 'exception_details'
+
+describe "ExceptionDetails" do
+
+  before(:each) do
+    v         = VariableScopeTestObject.new
+    @e        = v.make_exception
+    @class_e  = VariableScopeTestObject.make_class_level_exception
+  end
+
+  context ".details" do
+    it "should provide exception details method with back trace" do
+      @e.details.include?('.rb').should be_true
+    end
+
+    it "should provide exception message" do
+      @e.details.include?(@e.message).should be_true
+    end
+
+    it "should include inspect_variables output" do
+      @e.details.include?(@e.inspect_variables).should be_true
+    end
+
+  end
+
+  context "exception detail functions" do
+
+    it "should be available on exceptions created by raise and a string" do
+      begin
+        raise "Foo"
+      rescue Exception => e
+        e.binding_during_exception.should be_an_instance_of Binding
+      end
+    end
+
+    it "should be available on Exceptions" do
+      reality_check = true
+      e = Exception.new
+      e.binding_during_exception.should be_an_instance_of Binding
+      e.inspect_variables.include?("reality_check").should be_true
+    end
+
+    it "should be available on subclasses of exception like Standard Error" do
+      reality_check = true
+      e = StandardError.new
+      e.binding_during_exception.should be_an_instance_of Binding
+      e.inspect_variables.include?("reality_check").should be_true
+     # end
+    end
+
+    it "should be available on grandchild subclasses" do
+      begin
+        # cause an arugument error
+        should_be_in_output = true
+        "UP".downcase("", "")
+      rescue Exception => e
+        e.binding_during_exception.should be_an_instance_of Binding
+        e.inspect_variables.include?("should_be_in_output").should be_true
+       end
+    end
+
+    pending "Need to investigate why NameError won't capture a binding (any takers?)" do
+      it "should capture a binding for NameError" do
+        begin
+          reality_check = true
+          'hello' + made_up_variable
+        rescue Exception =>e
+          e.binding_during_exception.should be_an_instance_of Binding
+          e.inspect_variables.include?("reality_check").should be_true
+        end
+      end
+    end
+
+  end
+
+  context "inspect variables" do
+
+    it "should include variable values" do
+      @e.inspect_variables.include?('1nstance').should be_true
+      @e.inspect_variables.include?('1ocal').should be_true
+
+      @class_e.inspect_variables.include?('c1ass').should be_true
+    end
+
+    it "should include variable names" do
+      names = %w{@instance local @@class}
+      @e.inspect_variables.include?('@instance').should be_true
+      @e.inspect_variables.include?('local').should be_true
+
+      @class_e.inspect_variables.include?('@@class').should be_true
+    end
+
+    it "should not include global variables by default" do
+      @e.details.include?('g1obal').should be_false
+    end
+
+    it "should let me select scopes" do
+      d = @e.details(:scopes => :local_variables)
+      @e.details(:scopes => :local_variables).include?('1nstance').should be_false
+      @e.details(:scopes => :class_variables).include?('g1obal').should be_false
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'exception_details'
+require 'variable_scope_test_object'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/helpers/**/*.rb"].each {|f| require f }
+
+RSpec.configure do |config|
+
+
+end

data/spec/variable_scope_test_object.rb

@@ -0,0 +1,24 @@
+class VariableScopeTestObject
+
+  @@class = 'c1ass'
+  $global = 'g1obal'
+
+	def initialize
+    @instance = '1nstance'
+  end
+
+  def make_exception
+   local = '1ocal'
+   e =  Exception.new("Foo")
+   e.set_backtrace(['somemadeupfileforbacktrace.rb:435'])
+   e
+	end
+
+  def self.make_class_level_exception
+   local = '1ocal'
+   e =  Exception.new("Foo")
+   e.set_backtrace(['somemadeupfileforbacktrace.rb:435'])
+   e
+  end
+
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: exception_details
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Eric Beland
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: binding_of_caller
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Inspect variables captured at exception-time to get info about your exceptions
+email:
+- ebeland@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- exception_details.gemspec
+- lib/exception_details.rb
+- lib/exception_details/exception.rb
+- lib/exception_details/inspect_variables.rb
+- lib/exception_details/log_color_helpers.rb
+- lib/exception_details/version.rb
+- spec/exception_details_spec.rb
+- spec/spec_helper.rb
+- spec/variable_scope_test_object.rb
+homepage: https://github.com/ericbeland/exception_details
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Exception Details extends Exception to let you inspect variable values at
+  exception-time for logging etc.
+test_files:
+- spec/exception_details_spec.rb
+- spec/spec_helper.rb
+- spec/variable_scope_test_object.rb
+has_rdoc: