unroller 0.0.18 → 0.0.19

data/lib/unroller.rb

@@ -5,6 +5,8 @@ require 'facets/core/kernel/with'
 require 'facets/core/kernel/set_with'
 require 'facets/core/string/bracket'
 require 'facets/core/kernel/singleton_class'
+require 'facets/core/symbol/to_proc'
+require 'facets/core/string/index_all'
 gem 'qualitysmith_extensions'
 require 'qualitysmith_extensions/object/send_if_not_nil'
 require 'qualitysmith_extensions/kernel/trap_chain'
@@ -19,8 +21,13 @@ require 'qualitysmith_extensions/enumerable/select_until'
 require 'qualitysmith_extensions/module/bool_attr_accessor'
 gem 'colored'
 require 'colored'
-gem 'extensions'
-require 'extensions/symbol'   # to_proc
+
+require 'English'
+require 'pp'
+require 'stringio'
+gem 'termios'
+require 'termios'
+gem 'colored'
 
 # To disable color, uncomment this:
 #class String
@@ -29,8 +36,39 @@ require 'extensions/symbol'   # to_proc
 #  end
 #end
 
+begin
+  # Set up termios so that it returns immediately when you press a key.
+  # (http://blog.rezra.com/articles/2005/12/05/single-character-input)
+  t = Termios.tcgetattr(STDIN)
+  save_terminal_attributes = t.dup
+  t.lflag &= ~Termios::ICANON
+  Termios.tcsetattr(STDIN, 0, t)
+end
 
+class String
+  # Makes the first character bold and underlined. Makes the whole string of the given color.
+  # :todo: Move out to extensions/console/menu_item
+  def menu_item(color = :white, letter = self[0..0], which_occurence = 0)
+    index = index_all(/#{letter}/)[which_occurence]
+    raise "Could not find a #{which_occurence}th occurence of '#{letter}' in string '#{self}'" if index.nil?
+    before = self[0..index-1].send(color) unless index == 0
+    middle = self[index..index].send(color).bold.underline
+    after  = self[index+1..-1].send(color)
+    before.to_s + middle + after
+  end
+end
+def confirm(question, options = ['Yes', 'No'])
+  print question + " " +
+    "Yes".menu_item(:red) + ", " +
+    "No".menu_item(:green) + 
+    " > "
+  response = ''
+  # Currently allow user to press Enter to accept the default.
+  response = $stdin.getc.chr.downcase while !['y', 'n', "\n"].include?(begin response.downcase!; response end)
+  response
+end
 
+begin  # Reset terminal_attributes
 
 class Unroller
   #-------------------------------------------------------------------------------------------------
@@ -123,6 +161,7 @@ class Unroller
     @always_show_raise_events = false
     @show_file_load_errors = false
     @interactive = false   # Set to true to make it more like an interactive debugger.
+    @show_menu = true      # Set to false if you don't need the hints.
       # (In the future, might add "break out of this call" option to stop watching anything until we return from the current method... etc.)
     instance_variables.each do |v|
       self.class.class_eval do
@@ -261,10 +300,23 @@ class Unroller
             #printf "- (event=%8s) (klass=%10s) (id=%10s) (%s:%-2d)\n", event, klass, id, file, line #if klass.to_s == 'false'
             #puts 'false!!!!!!!'+klass.inspect if klass.to_s == 'false'
 
-            return if ['c-call', 'c-return'].include? event unless include_c_calls
+            return if ['c-call', 'c-return'].include?(event) unless include_c_calls
             #(puts 'exclude') if @silent_until_return_to_this_depth unless event == 'return' # Until we hit a return and can break out of this uninteresting call, we don't want to do *anything*.
             #return if uninteresting_class?(klass.to_s) unless (klass == false)
 
+            if @only_makes_sense_if_next_event_is_call
+              if event == 'call'
+                @only_makes_sense_if_next_event_is_call = nil
+              else
+                # Cancel @silent_until_return_to_this_depth because it didn't make sense / wasn't necessary. They could have 
+                # ("should have") simply done a 'step into', because unless it's a 'call', there's nothing to step over anyway...
+                # Not only is it unnecessary, but it would cause confusing behavior unless we cancelled this. As in, it
+                # wouldn't show *any* tracing for the remainder of the method, because it's kind of looking for a "return"...
+                #puts "Cancelling @silent_until_return_to_this_depth..."
+                @silent_until_return_to_this_depth = nil
+              end
+            end
+
             if too_far?
               puts "We've read #{@max_lines} (@max_lines) lines now. Turning off tracing..."
               trace_off
@@ -294,10 +346,10 @@ class Unroller
 
                     @lines_output += 1
 
-                    @call_stack.push current_call
 
                     @depth += 1
                   end
+                    @call_stack.push current_call
                   @internal_depth += 1
 
 
@@ -326,14 +378,25 @@ class Unroller
 
                     # Interactive debugger!
                     response = nil
-                    unless @last_call == current_call
-                      (print '(o = Step out of | s = Skip = Step over | default = Step into > '; response = $stdin.gets) if @interactive
+                    if @interactive && !(@last_call == current_call)
+                      #(print '(o = Step out of | s = Skip = Step over | default = Step into > '; response = $stdin.gets) if @interactive
+
+                      print "Debugger (" +
+                        "Step out".menu_item(:red, 'u') + ' | ' +
+                        "Step over (or Enter key)".menu_item(:cyan, 'v') + ' | ' +
+                        "Step into (Space or any key)".menu_item(:green, 'i') + 
+                        ') > '
+                      response = $stdin.getc.chr.downcase
                     end
                     if response
-                      if response[0].chr == 'out'[0].chr
+                      case response
+                      when 'u' # Step out
                         @silent_until_return_to_this_depth = @internal_depth - 1
-                      elsif response[0].chr == 'skip'[0].chr  # Step over = Ignore anything with a greater depth.
+                      when 'v', "\n"  # Step over = Ignore anything with a greater depth.
+                        @only_makes_sense_if_next_event_is_call = true
                         @silent_until_return_to_this_depth = @internal_depth
+                      else
+                        # 'i', ' ', or any other key will simply do the default, which is to keep right on tracing...
                       end
                     end
 
@@ -1331,3 +1394,8 @@ if $0 == __FILE__
   herald '-----------------------------------------------------------'
 
 end # if $0 == __FILE__ (Tests)
+
+ensure  # Or should this be in an at_exit?
+  # Set terminal_attributes back to how we found them...
+  Termios.tcsetattr(STDIN, 0, save_terminal_attributes)
+end

metadata

@@ -3,13 +3,13 @@ rubygems_version: 0.9.2
 specification_version: 1
 name: unroller
 version: !ruby/object:Gem::Version 
-  version: 0.0.18
+  version: 0.0.19
 date: 2007-06-05 00:00:00 -07:00
-summary: A tool for generating human-readable "execution traces"
+summary: "Ruby Code Unroller: A tool for generating human-readable \"execution traces\""
 require_paths: 
 - lib
 email: 
-homepage: http://rdoc.qualitysmith.com/unroller
+homepage: http://unroller.rubyforge.org
 rubyforge_project: unroller
 description: A debugging/tracing tool for Ruby. While it is enabled, it will watch every Ruby statement and method call that gets executed and will display the source code that is being executed in real time on your screen.
 autorequire: 
@@ -76,7 +76,7 @@ dependencies:
         version: 0.0.0
     version: 
 - !ruby/object:Gem::Dependency 
-  name: extensions
+  name: termios
   version_requirement: 
   version_requirements: !ruby/object:Gem::Version::Requirement 
     requirements: