unroller 0.0.21 → 0.0.22

data/Readme

@@ -54,13 +54,21 @@ Say I have an ActiveRecord model and want to know exactly what actually goes on
 
 Screenshot[link:include/screenshot1.png]
 
-This is much more efficient and reliable than manually tracing through the execution yourself!  (Trying to guess which file the <tt>save!</tt> method would be defined in, searching for the file in the depths of <tt>/usr/lib/ruby/gems</tt>, scrolling down to the right line number, and repeating a zillion times...)
+(The above shows <tt>:display_style => :concise</tt>.)
+
+This is much more efficient and reliable than manually tracing through the execution yourself!  (Which would involve trying to guess which file the <tt>save!</tt> method would be defined in, searching for the file in the depths of <tt>/usr/lib/ruby/gems</tt>, scrolling down to the right line number, and repeating a zillion times...)
+
+Here's an example of the interactive debugger mode:
+
+Screenshot[link:include/screenshot_interactive.png]
+
+(The above shows <tt>:display_style => :show_entire_method_body</tt>.)
 
 ===Inspecting variables
 
-If you'd like to see the values of all arguments/parameters that were passed into the method for each method call, just pass in the :show_args => true option.
+If you'd like to see the values of all arguments/parameters that were passed into the method for each method call, just pass in the <tt>:show_args => true</tt> option.
 
-If you'd like to see the values of all local variables as they exist right before executing the current line, just pass in the :show_locals => true option.
+If you'd like to see the values of all local variables as they exist right before executing the current line, just pass in the <tt>:show_locals => true</tt> option.
 
 Note: You might like to know that the state of those variables is _after_ executing that line, too, but currently that's not possible.
 
@@ -166,6 +174,12 @@ Here's one way you could try to answer that question...
 
 ===Usage in Rails
 
+Unroller can be useful for debugging in development mode as well as in tests. Keep in mind that it requires a terminal onto which to output, so it will work if you've started your server with <tt>./script/server</tt>, but not if the server is detached from the terminal with <tt>./script/server -d</tt> or if it's being executed via FastCGI...
+
+Rails has a lot of levels of abstractions, so even a seemingly simple call can generate many, many method calls. You may want to try using some of the filtering options, such as <tt>:exclude_classes</tt>, to reduce the verbosity of the output.
+
+<b>Unrolling an action in your controller:</b>
+
 If you want to see all code that gets executed within a certain action in your controller, you can just add this snippet to your controller, request the page, and watch the console where you have Webrick running as pages and pages of ActionController/ActionRecord code go flying by...
 
   around_filter do |controller, action|
@@ -184,7 +198,7 @@ The dependencies include: facets, qualitysmith_extensions, colored, and extensio
 
 It's pretty much fully functional, but may still have a couple rough edges.
 
-Occasionally it has caused some segmentation faults and other weirdness for me while using it, but maybe I was just doing something stupid. Generally it behaves quite reliably and stably.
+Generally it behaves quite reliably and stably.
 
 (Don't even *think* about leaving this in your production code!)
 

data/lib/unroller.rb

@@ -3,10 +3,11 @@ gem 'facets'
 require 'facets/core/module/namespace'
 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/bracket'
 require 'facets/core/string/index_all'
+require 'facets/core/hash/reverse_merge'
 gem 'qualitysmith_extensions'
 require 'qualitysmith_extensions/object/send_if_not_nil'
 require 'qualitysmith_extensions/kernel/trap_chain'
@@ -21,6 +22,8 @@ require 'qualitysmith_extensions/enumerable/select_until'
 require 'qualitysmith_extensions/module/bool_attr_accessor'
 gem 'colored'
 require 'colored'
+gem 'extensions'
+require 'extensions/object'
 
 require 'English'
 require 'pp'
@@ -86,6 +89,13 @@ class Unroller
         "#{name} = #{value.inspect}"
       end.join('; ').bracket('   (', ')')
     end
+    def verbose_to_s
+      @variables.map do |variable|
+        name, value = *variable
+        "#{name} = " +
+          value.pp_s.gsub(/^/, '  ')
+      end.join("\n")
+    end
     def any?
       !@variables.empty?
     end
@@ -114,8 +124,12 @@ class Unroller
 
 
 
+  def self.debug(options = {}, &block)
+    options.reverse_merge! :interactive => true, :display_style => :show_entire_method_body
+    self.trace options, &block
+  end
+
   def self.trace(options = {}, &block)
-    #puts 'called self.trace'
     if @@instance and @@instance.tracing
       # In case they try to turn tracing on when it's already on... Assume it was an accident and don't do anything.
       #puts "@@instance.tracing=#{@@instance.tracing}"
@@ -332,23 +346,27 @@ class Unroller
                 #zzz
                 when 'call'
                   unless skip_line?
-                    column sprintf(' ' + '\\'.cyan + ' calling'.cyan + ' ' + '%s'.underline.cyan, fully_qualified_method), @column_widths[0]
+                    depth_debug = '' #" (internal_depth about to be #{@internal_depth+1})"
+                    column sprintf(' ' + '\\'.cyan + ' calling'.cyan + ' ' + '%s'.underline.cyan + depth_debug, 
+                                   fully_qualified_method), @column_widths[0]
                     newline
 
-                    puts
-                    header_before_code_for_entire_method(file, line_num)
-                    do_show_locals if show_args
-                    ret = code_for_entire_method(file, line, klass, id, line, 0)
-                    puts ret unless ret.nil?
-                    puts
+                    #puts
+                    #header_before_code_for_entire_method(file, line_num)
+                    #do_show_locals if show_args
+                    #ret = code_for_entire_method(file, line, klass, id, line, 0)
+                    #puts ret unless ret.nil?
+                    #puts
 
                     @lines_output += 1
 
 
                     @depth += 1
                   end
-                    @call_stack.push current_call
+
+                  @call_stack.push current_call
                   @internal_depth += 1
+                  #puts "(@internal_depth+=1 ... #{@internal_depth})"
 
 
                 when 'class'
@@ -363,7 +381,7 @@ class Unroller
                       unless @last_call == current_call  # Without this, I was seeing two consecutive events for the exact same line. This seems to be necessary because 'if foo()' is treated as two 'line' events: one for 'foo()' and one for 'if' (?)...
                         puts
                         header_before_code_for_entire_method(file, line_num)
-                        do_show_locals if show_locals
+                        do_show_locals if true #show_locals
                         ret = code_for_entire_method(inside_of.file, inside_of.line_num, @klass, @id, line, -1)
                         puts ret unless ret.nil?
                         puts
@@ -383,15 +401,16 @@ class Unroller
                         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') + ' | ' + 
+                          "Step into (Space)".menu_item(:green, 'i') + ' | ' + 
                           "show Locals".menu_item(:yellow, 'l') + ' | ' + 
                           "Run".menu_item(:blue) + 
                           ') > '
                         response = $stdin.getc.chr.downcase
+                        puts unless response == "\n"
 
                         case response
                         when 'l'
-                          do_show_locals if show_locals
+                          do_show_locals_verbosely
                           response = nil
                         end
                       end
@@ -402,6 +421,7 @@ class Unroller
                         @interactive = false
                       when 'u' # Step out
                         @silent_until_return_to_this_depth = @internal_depth - 1
+                        #puts "Setting @silent_until_return_to_this_depth = #{@silent_until_return_to_this_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
@@ -418,29 +438,33 @@ class Unroller
                 when 'return'
 
                   @internal_depth -= 1
+                  #puts "(@internal_depth-=1 ... #{@internal_depth})"
+
+                  # Did we just get out of an uninteresting call?? Are we back in interesting land again??
+                  if  @silent_until_return_to_this_depth and 
+                      @silent_until_return_to_this_depth == @internal_depth
+                    #puts "Yay, we're back in interesting land! (@internal_depth = #{@internal_depth})"
+                    @silent_until_return_to_this_depth = nil
+                  end
+
+
                   unless skip_line?
                     puts "Warning: @depth < 0. You may wish to call trace with a :depth => depth value greater than #{@initial_depth}" if @depth-1 < 0
                     @depth -= 1 unless @depth == 0
                     #puts "-- Decreased depth to #{depth}"
                     returning_from = @call_stack.last
 
-                    column sprintf(' ' + '/'.cyan + ' returning from'.cyan + ' ' + '%s'.cyan, returning_from && returning_from.full_name), @column_widths[0]
+                    depth_debug = '' #" (internal_depth was #{@internal_depth+1})"
+                    column sprintf(' ' + '/'.cyan + ' returning from'.cyan + ' ' + '%s'.cyan + depth_debug,
+                                   returning_from && returning_from.full_name), @column_widths[0]
                     newline
 
                     @lines_output += 1
                   end
 
-                  # Did we just get out of an uninteresting call?? Are we back in interesting land again??
-                  if  @silent_until_return_to_this_depth and 
-                      @silent_until_return_to_this_depth == @internal_depth
-                    puts "Yay, we're back in interesting land!"
-                    @silent_until_return_to_this_depth = nil
-                  end
-
                   @call_stack.pop
 
 
-
                 when 'raise'
                   if !skip_line? or @always_show_raise_events
                     # We probably always want to see these (?)... Never skip displaying them, even if we are "too deep".
@@ -850,6 +874,15 @@ protected
   def header_before_code_for_entire_method(file, line_num)
     puts '' + "#{fully_qualified_method} (#{file}:#{line_num}) (#{@event}):".magenta if show_filename_and_line_numbers
   end
+
+  def do_show_locals_verbosely
+    variables = Variables.new(:local, @binding)
+    if variables.any?
+      puts variables.verbose_to_s.yellow
+    end
+  end
+
+
 end # class Unroller
 
 
@@ -1138,7 +1171,7 @@ if $0 == __FILE__
   herald '-----------------------------------------------------------'
   herald 'Test @exclude_methods'
   herald 'Should only see calls to green, strong'
-  class Wasabi
+  class Wasabi #:nodoc:
     def green
       '...'
     end
@@ -1170,7 +1203,7 @@ if $0 == __FILE__
   herald '-----------------------------------------------------------'
   herald 'Test @exclude_classes'
   herald 'Should only see calls to Interesting::...'
-  class Interesting
+  class Interesting #:nodoc:
     def self.method
       '...'
     end
@@ -1179,9 +1212,9 @@ if $0 == __FILE__
     end
   
   end
-  module Uninteresting
+  module Uninteresting #:nodoc:
   
-    class ClassThatCluttersUpOnesTraces
+    class ClassThatCluttersUpOnesTraces #:nodoc:
       ('a'..last='h').each do |method_name|
         next_method_name = method_name.next unless method_name == last
         eval <<-End, binding, __FILE__, __LINE__ + 1
@@ -1251,7 +1284,7 @@ if $0 == __FILE__
   herald '-----------------------------------------------------------'
   herald 'Test class definition'
   Unroller::trace do
-    class NewClass
+    class NewClass #:nodoc:
       def hi
         'hi'
       end
@@ -1283,12 +1316,12 @@ if $0 == __FILE__
 
   herald '-----------------------------------------------------------'
   herald 'Testing the :rails "preset"'
-  module ActiveSupport
+  module ActiveSupport #:nodoc:
     def self.whatever
       'whatever'
     end
   end
-  module ActiveMongoose
+  module ActiveMongoose #:nodoc:
     def self.whatever
       'whatever'
     end
@@ -1301,14 +1334,14 @@ if $0 == __FILE__
 
   herald '-----------------------------------------------------------'
   herald 'Testing the :dependencies "preset"'
-  module ActiveSupport
-    module Dependencies
+  module ActiveSupport #:nodoc:
+    module Dependencies #:nodoc:
       def self.whatever
         'whatever'
       end
     end
   end
-  module Gem
+  module Gem #:nodoc:
     def self.whatever
       'whatever'
     end
@@ -1334,11 +1367,11 @@ if $0 == __FILE__
 
   herald '-----------------------------------------------------------'
   herald 'Testing watch_for_added_methods'
-  class Foo
+  class Foo #:nodoc:
     def existing_method; end
   end
   Unroller::watch_for_added_methods(Foo, /interesting/) do
-    class Foo
+    class Foo #:nodoc:
       def foo; end
       def an_interesting_method; end
     end
@@ -1371,6 +1404,19 @@ if $0 == __FILE__
     big_ol_gaggle
   end
 
+  herald '-----------------------------------------------------------'
+  herald 'Testing :interactive => true / interactive debugger'
+  def factorial(x)
+    if x == 1
+      x
+    else
+      x * factorial(x - 1)
+    end
+  end
+  Unroller::debug do
+    factorial(4)
+  end
+
   herald '-----------------------------------------------------------'
   herald 'Testing :interactive => true / interactive debugger'
   def subway
@@ -1396,7 +1442,8 @@ if $0 == __FILE__
     _do = nil
     _do = nil
   end
-  Unroller::trace :display_style => :show_entire_method_body, :interactive => true do
+  #Unroller::trace :display_style => :show_entire_method_body, :interactive => true do
+  Unroller::debug do
     subway
   end
 

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.2
 specification_version: 1
 name: unroller
 version: !ruby/object:Gem::Version 
-  version: 0.0.21
-date: 2007-06-06 00:00:00 -07:00
+  version: 0.0.22
+date: 2007-06-18 00:00:00 -07:00
 summary: "Ruby Code Unroller: A tool for generating human-readable \"execution traces\""
 require_paths: 
 - lib
@@ -84,3 +84,12 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 0.0.0
     version: 
+- !ruby/object:Gem::Dependency 
+  name: extensions
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">"
+      - !ruby/object:Gem::Version 
+        version: 0.0.0
+    version: