hammertime19 0.0.4

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Avdi Grimm
+
+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.rdoc

@@ -0,0 +1,109 @@
+= hammertime19
+
+An interactive error console similar to those found in Lisp and Smalltalk environments.
+
+hammertime19 is a fork of Avid Grimm's hammertime gem: https://github.com/avdi/hammertime
+
+hammertime19 is a Ruby 1.9.2+ (MRI and RBX) only version that adds support for starting a pry (https://github.com/pry/pry)
+session at the exception raise site.
+
+== Install
+
+gem install hammertime19
+
+== Synopsis
+
+Simply require the Hammertime library:
+
+    require 'hammertime19'
+
+    $broken = true
+
+    def faulty_method
+      raise "Oh no!" if $broken
+    end
+
+    3.times do |n|
+      puts "Attempt (#{n+1}/3)"
+      begin
+        faulty_method
+        puts "No error raised"
+      rescue => error
+        puts "Error raised: #{error.inspect}"
+      end
+    end
+
+When an error is raised, a menu of possible actions will be presented at the console:
+
+    === Stop! Hammertime. ===
+    An error has occurred at example.rb:4:in `raise_runtime_error'
+    The error is: #<RuntimeError: Oh no!>
+    1. Continue (process the exception normally)
+    2. Ignore (proceed without raising an exception)
+    3. Permit by type (don't ask about future errors of this type)
+    4. Permit by line (don't ask about future errors raised from this point)
+    5. Backtrace (show the call stack leading up to the error)
+    6. Debug (start a debugger)
+    7. Console (start a pry session)
+    What now?
+
+This enables a fix-and-continue style of development:
+
+    $ ruby example.rb                                                
+    Attempt (1/3)
+
+    === Stop! Hammertime. ===
+    An error has occurred at example.rb:6:in `faulty_method'
+    The error is: #<RuntimeError: Oh no!>                   
+    1. Continue (process the exception normally)            
+    2. Ignore (proceed without raising an exception)        
+    3. Permit by type (don't ask about future errors of this type)
+    4. Permit by line (don't ask about future errors raised from this point)
+    5. Backtrace (show the call stack leading up to the error)              
+    6. Debug (start a debugger)                                             
+    7. Console (start a pry session)                                       
+    What now?
+    7
+
+    From: test.rb @ line 5 Object#faulty_method:
+
+        5: def faulty_method
+     => 6:   raise "Oh no!" if $broken
+        7: end
+
+    [1] pry(main)> $broken = false
+    => false
+    [2] pry(main)> exit
+
+    1. Continue (process the exception normally)
+    2. Ignore (proceed without raising an exception)
+    3. Permit by type (don't ask about future errors of this type)
+    4. Permit by line (don't ask about future errors raised from this point)
+    5. Backtrace (show the call stack leading up to the error)
+    6. Debug (start a debugger)
+    7. Console (start an IRB session)
+    What now?
+    2
+    No error raised
+    Attempt (2/3)
+    No error raised
+    Attempt (3/3)
+    No error raised
+
+== Known Bugs
+
+* Hammertime cannot intercept exceptions which are raised from native code.
+
+== TODO
+
+* Better integration with IRB to enable a "Retry" option.
+* Tests
+
+== Dependencies
+
+* pry (https://github.com/pry/pry)
+* binding_of_caller (https://github.com/banister/binding_of_caller)
+
+== Copyright
+
+Copyright (c) 2010 Avdi Grimm. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,13 @@
+#encoding: utf-8
+
+require 'rake'
+require 'rake/rdoctask'
+
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "hammertime #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.4

data/example.rb

@@ -0,0 +1,19 @@
+require 'lib/hammertime'
+
+$broken = true
+
+def faulty_method
+  raise "Oh no!" if $broken
+end
+
+3.times do |n|
+  puts "Attempt (#{n+1}/3)"
+  begin
+    faulty_method
+    puts "No error raised"
+  rescue => error
+    puts "Error raised: #{error.inspect}"
+  end
+end
+
+

data/examples/loaderror.rb

@@ -0,0 +1,11 @@
+# IN A WORLD... where ruby-debug and IRB is not in the load
+# path... one man will raise an exception.
+require 'rubygems'
+require '../lib/hammertime'
+
+# Clear out load path. Now LoadError will be raised when
+# Hammertime tries to load IRB or the debugger.
+$:.clear
+
+include Hammertime
+raise "Holy smokes!"

data/hammertime19.gemspec

@@ -0,0 +1,33 @@
+#encoding: utf-8
+
+Gem::Specification.new do |s|
+  s.name = "hammertime19"
+  s.version = "0.0.4"
+
+  s.authors = ["Kalle Lindstrom"]
+  s.date = "2012-08-20"
+  s.description = "When this library is required, it replaces the default Ruby exception-raising\nbehavior.  When an error is raised, the developer is presented with a menu\nenabling them to ignore the error, view a stack trace, debug the error using IRB\nor ruby-debug, and more.\n"
+  s.email = "lindstrom.kalle@gmail.com"
+  s.extra_rdoc_files = [
+    "LICENSE",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "LICENSE",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "example.rb",
+    "examples/loaderror.rb",
+    "hammertime19.gemspec",
+    "lib/hammertime19.rb"
+  ]
+  s.homepage = "http://github.com/kl/hammertime19"
+  s.require_paths = ["lib"]
+  s.summary = "Exception debugging console for Ruby"
+
+  s.add_dependency("highline", ["~> 1.5"])
+  s.add_dependency("pry", ">= 0.9.10")
+  s.add_dependency("binding_of_caller", ">= 0.6.7")
+end

data/lib/hammertime19.rb

@@ -0,0 +1,171 @@
+#encoding: utf-8
+
+# https://github.com/kl/hammertime
+# Forked from https://github.com/avdi/hammertime
+# This fork works only with MRI 1.9.2+ and RBX
+# Adds support for starting a Pry session at the call site of the exception.
+
+require 'thread'
+require 'highline'
+require 'pry'
+require 'binding_of_caller'
+
+module Hammertime
+  def self.ignored_errors
+    @ignored_errors ||= [LoadError]
+  end
+
+  def self.ignored_lines
+    @ignored_lines ||= []
+  end
+
+  def self.stopped
+    @stopped ||= false
+  end
+
+  def self.stopped=(value)
+    @stopped = value
+  end
+
+  def self.debug_supported?
+    require 'ruby-debug'
+    @debug_support = true
+  rescue LoadError
+    warn "Unable to load ruby-debug"
+    warn "Gem not installed or debugging not supported on your platform"
+    @debug_support = false
+  end
+
+  def hammertime_raise(*args)
+    backtrace = caller(2)
+    fallback = lambda do
+      hammertime_original_raise(*args)
+    end
+    exclusive_and_non_reentrant(fallback) do
+      error, backtrace =
+        case args.size
+        when 0 then [($!.nil? ? RuntimeError.new : $!), backtrace]
+        when 1 then
+          if args[0].is_a?(String)
+            [RuntimeError.exception(args[0]), backtrace]
+          else
+            [args[0].exception, backtrace]
+          end
+        when 2 then
+          [args[0].exception(args[1]), backtrace]
+        when 3 then
+          [args[0].exception(args[1]), args[2]]
+        else
+          super(ArgumentError, "wrong number of arguments", backtrace)
+        end
+      error.set_backtrace(backtrace)
+
+      if hammertime_ignore_error?(error, backtrace)
+        hammertime_original_raise(error)
+      else
+        ::Hammertime.stopped = true
+      end
+
+      c = ::Hammertime.hammertime_console
+      c.say "\n"
+      c.say "=== Stop! Hammertime. ==="
+      c.say "An error has occurred at #{backtrace.first}"
+      c.say "The error is: #{error.inspect}"
+      menu_config = lambda do |menu|
+        menu.prompt    = "What now?"
+        menu.default   = "Continue"
+        menu.select_by = :index_or_name
+
+        menu.choice "Continue (process the exception normally)" do
+          hammertime_original_raise(error)
+          true
+        end
+        menu.choice "Ignore (proceed without raising an exception)" do
+          true
+        end
+        menu.choice "Permit by type (don't ask about future errors of this type)" do
+          ::Hammertime.ignored_errors << error.class
+          c.say "Added #{error.class} to permitted error types"
+          hammertime_original_raise(error)
+          true
+        end
+        menu.choice "Permit by line (don't ask about future errors raised from this point)" do
+          ::Hammertime.ignored_lines << backtrace.first
+          c.say "Added #{backtrace.first} to permitted error lines"
+          hammertime_original_raise(error)
+          true
+        end
+        menu.choice "Backtrace (show the call stack leading up to the error)" do
+          backtrace.each do |frame| c.say frame end
+          false
+        end
+        if Hammertime.debug_supported?
+          menu.choice "Debug (start a debugger)" do
+            debugger
+            false
+          end
+        end
+        menu.choice "Console (start a pry session)" do
+          yield.pry
+          false
+        end
+      end
+      continue = c.choose(&menu_config) until continue
+    end
+  ensure
+    ::Hammertime.stopped = false
+  end
+
+  def hammertime_original_raise(*args)
+    Kernel.instance_method(:raise).bind(self).call(*args)
+  end
+
+  def fail(*args)
+    caller_binding = binding.of_caller(1)
+    hammertime_raise(*args) { caller_binding } 
+  end
+
+  def raise(*args)
+    caller_binding = binding.of_caller(1)    
+    hammertime_raise(*args) { caller_binding } 
+  end
+
+  private
+
+  # No lazy initialization where threads are concerned. We still use
+  # ||= on the off chance that this file gets loaded twice in 1.8.
+  @mutex ||= Mutex.new
+
+  def self.mutex
+    @mutex
+  end
+
+  def self.hammertime_console
+    @console ||= HighLine.new($stdin, $stderr)
+  end
+
+  def hammertime_ignore_error?(error, backtrace)
+    return true if ::Hammertime.stopped
+    return true if ::Hammertime.ignored_errors.any?{|e| error.is_a?(e)}
+    return true if ::Hammertime.ignored_lines.include?(backtrace.first)
+    return false
+  end
+
+  def exclusive_and_non_reentrant(fallback, &block)
+    lock_acquired = ::Hammertime.mutex.try_lock
+    if lock_acquired
+      yield
+      ::Hammertime.mutex.unlock
+    else
+      fallback.call
+    end
+  end
+
+end
+
+unless ::Object < Hammertime
+  class ::Object
+    include ::Hammertime
+  end
+  Debugger.start if $hammertime_debug_support
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: hammertime19
+version: !ruby/object:Gem::Version
+  version: 0.0.4
+  prerelease: 
+platform: ruby
+authors:
+- Kalle Lindstrom
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: highline
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.10
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.10
+- !ruby/object:Gem::Dependency
+  name: binding_of_caller
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.6.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.6.7
+description: ! 'When this library is required, it replaces the default Ruby exception-raising
+
+  behavior.  When an error is raised, the developer is presented with a menu
+
+  enabling them to ignore the error, view a stack trace, debug the error using IRB
+
+  or ruby-debug, and more.
+
+'
+email: lindstrom.kalle@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README.rdoc
+files:
+- .document
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- example.rb
+- examples/loaderror.rb
+- hammertime19.gemspec
+- lib/hammertime19.rb
+homepage: http://github.com/kl/hammertime19
+licenses: []
+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.24
+signing_key: 
+specification_version: 3
+summary: Exception debugging console for Ruby
+test_files: []