ruby-breakpoint 0.5.0 → 0.5.1

data/lib/binding_of_caller.rb

@@ -32,12 +32,26 @@ class Binding; end # for RDoc
 # If you don't do this an Exception will be raised. Because of
 # the way that Binding.of_caller is implemented it has to be
 # done this way.
+#
+# Please note that currently bindings returned by
+# Binding.of_caller() will have a wrong self context which
+# means you can not call methods, access instance variables and
+# so on on the calling object. You can work around this by
+# defining the method which uses the binding on all objects and
+# telling your users to use them without a receiver. This is
+# how ruby-breakpoint works around the problem.
+#
+# This is believed to be a bug in Ruby and has been reported to
+# ruby-core. See http://www.ruby-forum.com/topic/67255
 def Binding.of_caller(&block)
   old_critical = Thread.critical
   Thread.critical = true
   count = 0
   cc, result, error, extra_data = Continuation.create(nil, nil)
-  error.call if error
+  if error then
+    Thread.critical = old_critical
+    error.call
+  end
 
   tracer = lambda do |*args|
     type, context, extra_data = args[0], args[4], args
@@ -53,7 +67,7 @@ def Binding.of_caller(&block)
         # this is impossible without overloading set_trace_func
         # in current Ruby.
         set_trace_func(nil)
-        cc.call(eval("binding", context), nil, extra_data)
+        cc.call(context, nil, extra_data)
       end
     elsif type == "line" then
       nil

data/lib/breakpoint.rb

@@ -22,13 +22,13 @@ require 'drb/acl'
 require 'thread'
 
 module Breakpoint
-  id = %q$Id: breakpoint.rb 52 2005-02-26 19:43:19Z flgr $
+  id = %q$Id: breakpoint.rb 118 2006-05-28 11:44:14Z flgr $
   current_version = id.split(" ")[2]
   unless defined?(Version)
     # The Version of ruby-breakpoint you are using as String of the
     # 1.2.3 form where the digits stand for release, major and minor
     # version respectively.
-    Version = "0.5.0"
+    Version = "0.5.1"
   end
 
   extend self
@@ -54,7 +54,7 @@ module Breakpoint
   # breakpoints can also return a value. They will execute
   # a supplied block for getting a default return value.
   # A custom value can be returned from the session by doing
-  # +throw(:debug_return, value)+.
+  # <code>throw(:debug_return, value)</code>.
   #
   # You can also give names to break points which will be
   # used in the message that is displayed upon execution 
@@ -107,6 +107,16 @@ module Breakpoint
   # breakpoint_client.rb which is distributed with this
   # library. See the documentation of Breakpoint.activate_drb
   # for details.
+  #
+  # Please use breakpoint() instead of Breakpoint.breakpoint().
+  # If you use Breakpoint.breakpoint() you might get a shell with
+  # a wrong self context meaning that you will not be able to
+  # access instance variables, call methods on the object where
+  # you are breakpointing and so on. You will however still be
+  # able to access local variables.
+  #
+  # The former is believed to be caused by a bug in Ruby and it has
+  # been reported to ruby-core: http://www.ruby-forum.com/topic/67255
   def breakpoint(id = nil, context = nil, &block)
     callstack = caller
     callstack.slice!(0, 3) if callstack.first["breakpoint"]
@@ -144,6 +154,16 @@ module Breakpoint
         @eval_handler.call(code)
       end
 
+      # Need to work around an odd RubyGems issue that causes it
+      # to not load libraries...
+      def require(*args, &block)
+        begin
+          method_missing(:require__, *args, &block)
+        rescue LoadError
+          method_missing(:require, *args, &block)
+        end
+      end
+
       # Will execute the specified statement at the client.
       def method_missing(method, *args, &block)
         if args.empty? and not block
@@ -155,7 +175,7 @@ module Breakpoint
           # is that we would have to handle special expressions
           # like "self", "nil" or constants ourself which is hard.
           remote = eval %{
-            result = lambda { |block, *args| #{method}(*args, &block) }
+            result = lambda { |block, *args| self.send(#{method.inspect}, *args, &block) }
             def result.call_with_block(*args, &block)
               call(block, *args)
             end
@@ -290,8 +310,12 @@ module Breakpoint
     def initialize
       @handler = @eval_handler = @collision_handler = nil
 
-      IRB.instance_eval { @CONF[:RC] = true }
-      IRB.run_config
+      begin
+        IRB.instance_eval { @CONF[:RC] = true }
+        IRB.init_config(nil)
+        IRB.run_config
+      rescue Exception
+      end
     end
 
     def collision
@@ -504,7 +528,9 @@ module IRB # :nodoc:
       if Breakpoint.use_drb? then
         result = old_evaluate(*args)
         if args[0] != :no_proxy and
-          not [true, false, nil].include?(result)
+          not [true, false, nil].include?(result) and
+          not result.is_a?(String) and
+          not result.is_a?(Numeric)
         then
           result.extend(DRbUndumped) rescue nil
         end
@@ -529,6 +555,7 @@ module DRb # :nodoc:
   class DRbObject # :nodoc:
     undef :inspect if method_defined?(:inspect)
     undef :clone if method_defined?(:clone)
+    undef :to_yaml if method_defined?(:to_yaml)
   end
 end
 

data/lib/breakpoint_client.rb

@@ -0,0 +1,214 @@
+require 'breakpoint'
+require 'optparse'
+require 'timeout'
+require 'tmpdir'
+
+# Uses the following standard options overwritten by options that might
+# have been previously defined.
+Options = {} unless defined?(Options)
+Options.replace({
+  :ClientURI  => nil,
+  :ServerURI  => "druby://localhost:42531",
+  :RetryDelay => 3,
+  :Permanent  => false,
+  :Verbose    => false
+}.merge(Options))
+
+ARGV.options do |opts|
+  script_name = File.basename($0)
+  opts.banner = [
+    "Usage: ruby #{script_name} [Options] [server uri]",
+    "",
+    "This tool lets you connect to a breakpoint service ",
+    "which was started via Breakpoint.activate_drb.",
+    "",
+    "The server uri defaults to druby://localhost:42531",
+    "",
+    "Having trouble or need help?",
+    "* Homepage:  http://ruby-breakpoint.rubyforge.org/ (has FAQ!)",
+    "* Author:    Florian Gross, flgr@ccan.de (Read homepage first!)"
+  ].join("\n")
+
+  opts.separator ""
+
+  opts.on("-c", "--client-uri=uri",
+    "Run the client on the specified uri.",
+    "This can be used to specify the port",
+    "that the client uses to allow for back",
+    "connections from the server.",
+    "Default: Find a good URI automatically.",
+    "Example: -c druby://localhost:12345"
+  ) { |Options[:ClientURI]| }
+
+  opts.on("-s", "--server-uri=uri",
+    "Connect to the server specified at the",
+    "specified uri.",
+    "Default: druby://localhost:42531"
+  ) { |Options[:ServerURI]| }
+
+  opts.on("-R", "--retry-delay=delay", Integer,
+    "Automatically try to reconnect to the",
+    "server after delay seconds when the",
+    "connection failed or timed out.",
+    "A value of 0 disables automatical",
+    "reconnecting completely.",
+    "Default: 10"
+  ) { |Options[:RetryDelay]| }
+
+  opts.on("-P", "--[no-]permanent",
+    "Run the breakpoint client in permanent mode.",
+    "This means that the client will keep continue",
+    "running even after the server has closed the",
+    "connection. Useful for example in Rails.",
+    "Default: non-permanent"
+  ) { |Options[:Permanent]| }
+
+  opts.on("-V", "--[no-]verbose",
+    "Run the breakpoint client in verbose mode.",
+    "Will produce more messages, for example between",
+    "individual breakpoints. This might help in seeing",
+    "that the breakpoint client is still alive, but adds",
+    "quite a bit of clutter.",
+    "Default: non-verbose"
+  ) { |Options[:Verbose]| }
+
+  opts.separator ""
+
+  opts.on("-h", "--help",
+    "Show this help message."
+  ) { puts opts; exit }
+  opts.on("-v", "--version",
+    "Display the version information."
+  ) do
+    id = %q$Id: breakpoint_client 80 2005-07-28 18:15:20Z flgr $
+    puts id.sub("Id: ", "")
+    puts "(Breakpoint::Version = #{Breakpoint::Version})"
+    exit
+  end
+
+  opts.parse!
+end
+
+Options[:ServerURI] = ARGV[0] if ARGV[0]
+Options[:ClientURI] ||= case Options[:ServerURI]
+  when /^drbunix:(.+)$/i then
+    "drbunix:" << File.join(Dir.tmpdir, $1.gsub(/\W/, "_")) << ".breakpoint_client"
+  when %r{^druby://(localhost|127\.0\.0\.1|::1):(\d+)$}i then
+    "druby://" << $1 << ":" << $2.succ
+end
+puts "ClientURI is #{Options[:ClientURI] || "unspecified"}" if Options[:Verbose]
+
+module Handlers
+  extend self
+
+  def breakpoint_handler(workspace, message)
+    puts message
+    IRB.start(nil, nil, workspace)
+
+    puts ""
+    if Options[:Verbose] then
+      puts "Resumed execution. Waiting for next breakpoint...", ""
+    end
+  end
+
+  def eval_handler(code)
+    result = eval(code, TOPLEVEL_BINDING)
+    if result then
+      DRbObject.new(result)
+    else
+      result
+    end
+  end
+
+  def collision_handler()
+    msg = [
+      "  *** Breakpoint service collision ***",
+      "  Another Breakpoint service tried to use the",
+      "  port already occupied by this one. It will",
+      "  keep waiting until this Breakpoint service",
+      "  is shut down.",
+      "  ",
+      "  If you are using the Breakpoint library for",
+      "  debugging a Rails or other CGI application",
+      "  this likely means that this Breakpoint",
+      "  session belongs to an earlier, outdated",
+      "  request and should be shut down via 'exit'."
+    ].join("\n")
+
+    if RUBY_PLATFORM["win"] then
+      # This sucks. Sorry, I'm not doing this because
+      # I like funky message boxes -- I need to do this
+      # because on Windows I have no way of displaying
+      # my notification via puts() when gets() is still
+      # being performed on STDIN. I have not found a
+      # better solution.
+      begin
+        require 'tk'
+        root = TkRoot.new { withdraw }
+        Tk.messageBox('message' => msg, 'type' => 'ok')
+        root.destroy
+      rescue Exception
+        puts "", msg, ""
+      end
+    else
+      puts "", msg, ""
+    end
+  end
+end
+
+# Used for checking whether we are currently in the reconnecting loop.
+reconnecting = false
+
+loop do
+  DRb.start_service(Options[:ClientURI])
+
+  begin
+    service = DRbObject.new(nil, Options[:ServerURI])
+
+    begin
+      ehandler = Handlers.method(:eval_handler)
+      chandler = Handlers.method(:collision_handler)
+      handler = Handlers.method(:breakpoint_handler)
+      service.eval_handler = ehandler
+      service.collision_handler = chandler
+      service.handler = handler
+
+      reconnecting = false
+      if Options[:Verbose] then
+        puts "Connection established. Waiting for breakpoint...", ""
+      end
+
+      loop do
+        begin
+          service.ping
+        rescue DRb::DRbConnError => error
+          puts "Server exited. Closing connection...", ""
+          DRb.stop_service
+          exit! unless Options[:Permanent]
+          break
+        end
+
+        sleep(0.5)
+      end
+    ensure
+      service.eval_handler = nil
+      service.collision_handler = nil
+      service.handler = nil
+    end
+  rescue Exception => error
+    if Options[:RetryDelay] > 0 then
+      if not reconnecting then
+        reconnecting = true
+        puts "No connection to breakpoint service at #{Options[:ServerURI]} " +
+           "(#{error.class})"
+        puts error.backtrace if $DEBUG
+        puts "Tries to connect will be made every #{Options[:RetryDelay]} seconds..."
+      end
+
+      sleep Options[:RetryDelay]
+      retry
+    else
+      raise
+    end
+  end
+end

metadata

@@ -1,82 +1,88 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.8.5
+rubygems_version: 0.8.11
 specification_version: 1
 name: ruby-breakpoint
 version: !ruby/object:Gem::Version 
-  version: 0.5.0
-date: 2005-03-04
+  version: 0.5.1
+date: 2006-06-05 00:00:00 +02:00
 summary: ruby-breakpoint lets you inspect and modify state at run time.
 require_paths: 
-  - lib
+- lib
 email: flgr@ccan.de
 homepage: http://ruby-breakpoint.rubyforge.org/
 rubyforge_project: ruby-breakpoint
-description: "ruby-breakpoint lets you inspect and modify state at run time. This allows you
-  to diagnose bugs, patch applications and more all via IRB by simply doing a
-  method call at the place you want to investigate."
+description: ruby-breakpoint lets you inspect and modify state at run time. This allows you to diagnose bugs, patch applications and more all via IRB by simply doing a method call at the place you want to investigate.
 autorequire: breakpoint.rb
 default_executable: 
 bindir: bin
 has_rdoc: true
 required_ruby_version: !ruby/object:Gem::Version::Requirement 
   requirements: 
-    - 
-      - ">="
-      - !ruby/object:Gem::Version 
-        version: 1.8.2
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: 1.8.2
   version: 
 platform: ruby
+signing_key: 
+cert_chain: 
 authors: 
-  - Florian Gross
+- Florian Gross
 files: 
-  - bin
-  - COPYING
-  - doc
-  - GPL
-  - lib
-  - Manifest
-  - NEWS
-  - README
-  - setup.rb
-  - TODO
-  - bin/breakpoint_client
-  - doc/classes
-  - doc/created.rid
-  - doc/files
-  - doc/fr_class_index.html
-  - doc/fr_file_index.html
-  - doc/fr_method_index.html
-  - doc/index.html
-  - doc/rdoc-style.css
-  - doc/classes/Binding.html
-  - doc/classes/Breakpoint
-  - doc/classes/Breakpoint.html
-  - doc/classes/Breakpoint/CommandBundle
-  - doc/classes/Breakpoint/CommandBundle.html
-  - doc/classes/Breakpoint/FailedAssertError.html
-  - doc/classes/Breakpoint/CommandBundle/Client.html
-  - doc/files/COPYING.html
-  - doc/files/lib
-  - doc/files/NEWS.html
-  - doc/files/README.html
-  - doc/files/TODO.html
-  - doc/files/lib/binding_of_caller_rb.html
-  - doc/files/lib/breakpoint_rb.html
-  - lib/binding_of_caller.rb
-  - lib/breakpoint.rb
+- bin
+- COPYING
+- doc
+- GPL
+- lib
+- Manifest
+- NEWS
+- README
+- setup.rb
+- TODO
+- bin/breakpoint_client
+- doc/classes
+- doc/created.rid
+- doc/files
+- doc/fr_class_index.html
+- doc/fr_file_index.html
+- doc/fr_method_index.html
+- doc/index.html
+- doc/rdoc-style.css
+- doc/classes/Binding.html
+- doc/classes/Breakpoint
+- doc/classes/Breakpoint.html
+- doc/classes/Handlers.html
+- doc/classes/Breakpoint/CommandBundle
+- doc/classes/Breakpoint/CommandBundle.html
+- doc/classes/Breakpoint/FailedAssertError.html
+- doc/classes/Breakpoint/CommandBundle/Client.html
+- doc/files/COPYING.html
+- doc/files/lib
+- doc/files/NEWS.html
+- doc/files/README.html
+- doc/files/TODO.html
+- doc/files/lib/binding_of_caller_rb.html
+- doc/files/lib/breakpoint_client_rb.html
+- doc/files/lib/breakpoint_rb.html
+- lib/binding_of_caller.rb
+- lib/breakpoint.rb
+- lib/breakpoint_client.rb
 test_files: []
+
 rdoc_options: 
-  - "--inline-source"
-  - "--line-numbers"
-  - "--title"
-  - ruby-breakpoint
+- --inline-source
+- --line-numbers
+- --title
+- ruby-breakpoint
 extra_rdoc_files: 
-  - README
-  - NEWS
-  - TODO
-  - COPYING
+- README
+- NEWS
+- TODO
+- COPYING
 executables: 
-  - breakpoint_client
+- breakpoint_client
 extensions: []
+
 requirements: []
-dependencies: []
+
+dependencies: []
+