ruby-debug-passenger 0.0.1 → 0.1.0

data/README.md

@@ -1,62 +1,83 @@
-# ruby-debug-passenger
-
-## Background
-I wanted to use Phusion Passenger as an Apache module (not standalone) but still
-be able to use the interactive Ruby debugger.
-
-Thanks to
-[Adam Meehan](http://duckpunching.com/passenger-mod_rails-for-development-now-with-debugger)
-I was able to do that, and I decided to make it into a reusable Gem.
-
-## Requirements
-This is been tested on:
-
-* Rails 3.2.2
-* Ruby (MRI) 1.9.2
-* Ruby Debugger 0.11.6
-* Phusion Passenger 3.0.11
-
-It will probably work on other versions, but not on Rails 2.
-
-It may or may not work on Ruby 1.8.
-
-## Installation
-Add this to your `Gemfile` (assuming you are on Ruby 1.9):
-
-```ruby
-gem "ruby-debug19", require: "ruby-debug"
-gem "ruby-debug-passenger"
-```
-
-Or if you're using Ruby 1.8 you can try the following, but it hasn't been tested!
-
-```ruby
-gem "ruby-debug"
-gem "ruby-debug-passenger"
-```
-
-Then run `bundle install` to install it.
-
-## Usage
-Add `debugger` anywhere in your Ruby code that you want to invoke the debugger.
-(Or in an ERB template add `<% debugger %>`.)
-
-Run `rake debug` to restart Phusion Passenger and connect to the debugger. (You
-will be prompted to reload the app in your browser.)
-
-## Suggested configuration
-I recommend putting this in your `~/.rdebugrc`:
-
-```ruby
-set autolist
-set autoeval
-set autoreload
-```
-
-## Recommended reading
-* [ruby-debug documentation](http://bashdb.sourceforge.net/ruby-debug.html)
-* [RailsCast #54](http://railscasts.com/episodes/54-debugging-with-ruby-debug)
-  (the setup steps are out of date, but it shows why ruby-debug can be useful)
-
-## License
-MIT License - see `LICENSE.txt`.
+# ruby-debug-passenger
+
+## Background
+I wanted to use Phusion Passenger as an Apache module (not standalone) but still
+be able to use the interactive Ruby debugger.
+
+Thanks to
+[Adam Meehan](http://duckpunching.com/passenger-mod_rails-for-development-now-with-debugger)
+I was able to do that, and I decided to make it into a reusable Gem.
+
+## Requirements
+This is been tested on:
+
+* Rails 3.2.2
+* Ruby (MRI) 1.9.2
+* Old Ruby Debugger 0.11.6
+* Phusion Passenger 3.0.11
+
+and
+
+* Rails 3.0.14
+* Ruby (MRI) 1.9.3-p125
+* Debugger gem 1.1.4
+* Phusion Passenger 3.0.12 and 3.0.13
+
+It will probably work on other versions, but not on Rails 2.
+
+It may or may not work on Ruby 1.8.
+
+## Installation
+Add this to your `Gemfile` (assuming you are on Ruby 1.9):
+
+```ruby
+gem "debugger"
+gem "ruby-debug-passenger"
+```
+
+or use the old ruby-debug gem:
+
+```ruby
+gem "ruby-debug19", require: "ruby-debug"
+gem "ruby-debug-passenger"
+```
+
+Or if you're using Ruby 1.8 you can try the following, but it hasn't been tested!
+
+```ruby
+gem "ruby-debug"
+gem "ruby-debug-passenger"
+```
+
+Then run `bundle install` to install it.
+
+## Usage
+Add `debugger` anywhere in your Ruby code that you want to invoke the debugger.
+(Or in an ERB template add `<% debugger %>`.)
+
+Run `rake debug` to restart Phusion Passenger and connect to the debugger. (You
+will be prompted to reload the app in your browser.)
+
+## Suggested configuration
+I recommend putting this in your `~/.rdebugrc`:
+
+```ruby
+set autolist
+set autoeval
+set autoreload
+```
+
+## Recommended reading
+* [ruby-debug documentation](http://bashdb.sourceforge.net/ruby-debug.html)
+* [RailsCast #54](http://railscasts.com/episodes/54-debugging-with-ruby-debug)
+  (the setup steps are out of date, but it shows why ruby-debug can be useful)
+
+## Changelog
+### 0.1.0
+* Support for `debugger` gem (Kai Middleton) #1
+
+### 0.0.1
+* Initial release
+
+## License
+MIT License - see `LICENSE.txt`.

data/lib/ruby-debug-passenger/version.rb

@@ -1,3 +1,3 @@
 module RubyDebugPassenger
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/lib/ruby-debug-passenger.rb

@@ -11,7 +11,15 @@ module RubyDebugPassenger
       # ever run in the development environment (for safety more than anything
       # else).
       if Rails.env.development? && File.exists?(File.join(Rails.root, 'tmp', 'debug.txt'))
-        require 'ruby-debug'
+        begin
+          require 'debugger'
+        rescue LoadError
+          begin
+            require 'ruby-debug'
+          rescue LoadError
+            raise "One of the gems 'debugger' or 'ruby-debug' must be present when using the gem 'ruby-debug-passenger'"
+          end
+        end
         File.delete(File.join(Rails.root, 'tmp', 'debug.txt'))
         Debugger.wait_connection = true
         Debugger.start_remote

data/lib/tasks/debug.rake

@@ -1,34 +1,43 @@
-desc "Restart the app with debugging enabled, then launch the debugger"
-task :debug do
-
-  require 'ruby-debug'
-
-  # This instructs the app to wait for the debugger to connect after loading
-  # See config/environments/development.rb
-  FileUtils.touch(File.join(Rails.root, 'tmp', 'debug.txt'))
-
-  # Instruct Phusion Passenger to restart the app
-  FileUtils.touch(File.join(Rails.root, 'tmp', 'restart.txt'))
-
-  # Wait for it to restart (requires the user to load a page)
-  puts "Waiting for restart (please reload the app in your web browser)..."
-  begin
-    while File.exists?(File.join(Rails.root, 'tmp', 'debug.txt'))
-      sleep 0.5
-    end
-    sleep 1
-  rescue Interrupt
-    File.delete(File.join(Rails.root, 'tmp', 'debug.txt'))
-    puts "\rCancelled."
-    exit 1
-  end
-
-  puts "Loading debugger..."
-  begin
-    Debugger.start_client
-  rescue Interrupt
-    # Clear the "^C" that is displayed when you press Ctrl-C
-    puts "\r\e[0KDisconnected."
-  end
-
-end
+desc "Restart the app with debugging enabled, then launch the debugger"
+task :debug do
+
+  begin
+    require 'debugger'
+  rescue LoadError
+    begin
+      require 'ruby-debug'
+    rescue LoadError
+      puts "One of the gems 'debugger' or 'ruby-debug' must be present for this task to work"
+      exit 1
+    end
+  end
+
+  # This instructs the app to wait for the debugger to connect after loading
+  # See config/environments/development.rb
+  FileUtils.touch(File.join(Rails.root, 'tmp', 'debug.txt'))
+
+  # Instruct Phusion Passenger to restart the app
+  FileUtils.touch(File.join(Rails.root, 'tmp', 'restart.txt'))
+
+  # Wait for it to restart (requires the user to load a page)
+  puts "Waiting for restart (please reload the app in your web browser)..."
+  begin
+    while File.exists?(File.join(Rails.root, 'tmp', 'debug.txt'))
+      sleep 0.5
+    end
+    sleep 1
+  rescue Interrupt
+    File.delete(File.join(Rails.root, 'tmp', 'debug.txt'))
+    puts "\rCancelled."
+    exit 1
+  end
+
+  puts "Loading debugger..."
+  begin
+    Debugger.start_client
+  rescue Interrupt
+    # Clear the "^C" that is displayed when you press Ctrl-C
+    puts "\r\e[0KDisconnected."
+  end
+
+end

data/ruby-debug-passenger.gemspec

@@ -10,10 +10,11 @@ Gem::Specification.new do |s|
   s.homepage    = "https://github.com/davejamesmiller/ruby-debug-passenger"
   s.summary     = %q{Adds a 'rake debug' task to Rails to restart Phusion Passenger with a debugger connected}
   s.description = <<-EOF
-    Adds an initializer that loads 'ruby-debug' and starts the debugger, and a
-    'rake debug' task that tells Phusion Passenger to restart with debugging
-    enabled. This makes it possible to do interactive debugging when using the
-    Phusion Passenger Apache module - it does not require the standalone server.
+    Adds an initializer that loads 'ruby-debug' or 'debugger' and starts the
+    debugger, and a 'rake debug' task that tells Phusion Passenger to restart
+    with debugging enabled. This makes it possible to do interactive debugging
+    when using the Phusion Passenger Apache module - it does not require the
+    standalone server.
   EOF
   s.license     = 'MIT'
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby-debug-passenger
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,12 +9,13 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-11 00:00:00.000000000Z
+date: 2012-07-01 00:00:00.000000000Z
 dependencies: []
-description: ! "    Adds an initializer that loads 'ruby-debug' and starts the debugger,
-  and a\n    'rake debug' task that tells Phusion Passenger to restart with debugging\n
-  \   enabled. This makes it possible to do interactive debugging when using the\n
-  \   Phusion Passenger Apache module - it does not require the standalone server.\n"
+description: ! "    Adds an initializer that loads 'ruby-debug' or 'debugger' and
+  starts the\n    debugger, and a 'rake debug' task that tells Phusion Passenger to
+  restart\n    with debugging enabled. This makes it possible to do interactive debugging\n
+  \   when using the Phusion Passenger Apache module - it does not require the\n    standalone
+  server.\n"
 email:
 - dave@davejamesmiller.com
 executables: []