ruby-debug-passenger 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in ruby-debug-passenger.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,18 @@
+Copyright (c) 2012 Dave James Miller
+
+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.md

@@ -0,0 +1,62 @@
+# 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`.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

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

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

data/lib/ruby-debug-passenger.rb

@@ -0,0 +1,27 @@
+require "ruby-debug-passenger/version"
+require "rails"
+
+module RubyDebugPassenger
+  class Railtie < Rails::Railtie
+
+    # Initializer
+    initializer "ruby-debug-passenger" do
+      # When Passenger starts the app, this checks if debug.txt exists, and if
+      # so it waits for the debugger to connect before continuing. It will only
+      # 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'
+        File.delete(File.join(Rails.root, 'tmp', 'debug.txt'))
+        Debugger.wait_connection = true
+        Debugger.start_remote
+      end
+    end
+
+    # Rake task
+    rake_tasks do
+      load "tasks/debug.rake"
+    end
+
+  end
+end

data/lib/tasks/debug.rake

@@ -0,0 +1,34 @@
+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

data/ruby-debug-passenger.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "ruby-debug-passenger/version"
+
+Gem::Specification.new do |s|
+  s.name        = "ruby-debug-passenger"
+  s.version     = RubyDebugPassenger::VERSION
+  s.authors     = ["Dave James Miller"]
+  s.email       = ["dave@davejamesmiller.com"]
+  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.
+  EOF
+  s.license     = 'MIT'
+
+  s.rubyforge_project = "ruby-debug-passenger"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  # s.add_development_dependency "rspec"
+  # s.add_runtime_dependency "rest-client"
+end

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: ruby-debug-passenger
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Dave James Miller
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-11 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"
+email:
+- dave@davejamesmiller.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/ruby-debug-passenger.rb
+- lib/ruby-debug-passenger/version.rb
+- lib/tasks/debug.rake
+- ruby-debug-passenger.gemspec
+homepage: https://github.com/davejamesmiller/ruby-debug-passenger
+licenses:
+- MIT
+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: ruby-debug-passenger
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Adds a 'rake debug' task to Rails to restart Phusion Passenger with a debugger
+  connected
+test_files: []