Merge pull request #14646 from deivid-rodriguez/provide_byebug_by_default

Improve debugging support

8 files changed, 76 insertions, 35 deletions

diff --git a/railties/lib/rails/commands/console.rb b/railties/lib/rails/commands/console.rb
index f6bdf129d6..555d8f31e1 100644
--- a/railties/lib/rails/commands/console.rb
+++ b/railties/lib/rails/commands/console.rb
@@ -18,7 +18,14 @@ module Rails
           opt.on("-e", "--environment=name", String,
                   "Specifies the environment to run this console under (test/development/production).",
                   "Default: development") { |v| options[:environment] = v.strip }
-          opt.on("--debugger", 'Enable the debugger.') { |v| options[:debugger] = v }
+          opt.on("--debugger", 'Enable the debugger.') do |v|
+            if RUBY_VERSION < '2.0.0'
+              options[:debugger] = v
+            else
+              puts "=> Notice: debugger option is ignored since ruby 2.0 and " \
+                   "it will be removed in future versions"
+            end
+          end
           opt.parse!(arguments)
         end
 
@@ -69,12 +76,25 @@ module Rails
       Rails.env = environment
     end
 
-    def debugger?
-      options[:debugger]
+    if RUBY_VERSION < '2.0.0'
+      def debugger?
+        options[:debugger]
+      end
+
+      def require_debugger
+        require 'debugger'
+        puts "=> Debugger enabled"
+      rescue LoadError
+        puts "You're missing the 'debugger' gem. Add it to your Gemfile, bundle it and try again."
+        exit(1)
+      end
     end
 
     def start
-      require_debugger if debugger?
+      if RUBY_VERSION < '2.0.0'
+        require_debugger if debugger?
+      end
+
       set_environment! if environment?
 
       if sandbox?
@@ -89,13 +109,5 @@ module Rails
       end
       console.start
     end
-
-    def require_debugger
-      require 'debugger'
-      puts "=> Debugger enabled"
-    rescue LoadError
-      puts "You're missing the 'debugger' gem. Add it to your Gemfile, bundle it and try again."
-      exit(1)
-    end
   end
 end
diff --git a/railties/lib/rails/commands/server.rb b/railties/lib/rails/commands/server.rb
index fec4962fb5..6146b6c1db 100644
--- a/railties/lib/rails/commands/server.rb
+++ b/railties/lib/rails/commands/server.rb
@@ -18,7 +18,14 @@ module Rails
           opts.on("-c", "--config=file", String,
                   "Use custom rackup configuration file") { |v| options[:config] = v }
           opts.on("-d", "--daemon", "Make server run as a Daemon.") { options[:daemonize] = true }
-          opts.on("-u", "--debugger", "Enable the debugger") { options[:debugger] = true }
+          opts.on("-u", "--debugger", "Enable the debugger") do
+            if RUBY_VERSION < '2.0.0'
+              options[:debugger] = true
+            else
+              puts "=> Notice: debugger option is ignored since ruby 2.0 and " \
+                   "it will be removed in future versions"
+            end
+          end
           opts.on("-e", "--environment=name", String,
                   "Specifies the environment to run this server under (test/development/production).",
                   "Default: development") { |v| options[:environment] = v }
@@ -75,7 +82,9 @@ module Rails
 
     def middleware
       middlewares = []
-      middlewares << [Rails::Rack::Debugger] if options[:debugger]
+      if RUBY_VERSION < '2.0.0'
+        middlewares << [Rails::Rack::Debugger] if options[:debugger]
+      end
       middlewares << [::Rack::ContentLength]
 
       # FIXME: add Rack::Lock in the case people are using webrick.
diff --git a/railties/lib/rails/generators/rails/app/templates/Gemfile b/railties/lib/rails/generators/rails/app/templates/Gemfile
index a9b6787894..756c334772 100644
--- a/railties/lib/rails/generators/rails/app/templates/Gemfile
+++ b/railties/lib/rails/generators/rails/app/templates/Gemfile
@@ -23,8 +23,12 @@ source 'https://rubygems.org'
 # gem 'capistrano-rails', group: :development
 
 <% unless defined?(JRUBY_VERSION) -%>
-# Use debugger
+# To use a debugger
+  <%- if RUBY_VERSION < '2.0.0' -%>
 # gem 'debugger', group: [:development, :test]
+  <%- else -%>
+# gem 'byebug', group: [:development, :test]
+  <%- end -%>
 <% end -%>
 
 <% if RUBY_PLATFORM.match(/bccwin|cygwin|emx|mingw|mswin|wince/) -%>
diff --git a/railties/lib/rails/generators/rails/plugin/templates/Gemfile b/railties/lib/rails/generators/rails/plugin/templates/Gemfile
index f0a832f783..1f704db510 100644
--- a/railties/lib/rails/generators/rails/plugin/templates/Gemfile
+++ b/railties/lib/rails/generators/rails/plugin/templates/Gemfile
@@ -38,6 +38,10 @@ end
 
 <% end -%>
 <% unless defined?(JRUBY_VERSION) -%>
-# To use debugger
-# gem 'debugger'
+# To use a debugger
+  <%- if RUBY_VERSION < '2.0.0' -%>
+# gem 'debugger', group: [:development, :test]
+  <%- else -%>
+# gem 'byebug', group: [:development, :test]
+  <%- end -%>
 <% end -%>
diff --git a/railties/lib/rails/rack.rb b/railties/lib/rails/rack.rb
index d1ee96f7fd..886f0e52e1 100644
--- a/railties/lib/rails/rack.rb
+++ b/railties/lib/rails/rack.rb
@@ -1,6 +1,6 @@
 module Rails
   module Rack
-    autoload :Debugger,      "rails/rack/debugger"
+    autoload :Debugger,      "rails/rack/debugger"   if RUBY_VERSION < '2.0.0'
     autoload :Logger,        "rails/rack/logger"
     autoload :LogTailer,     "rails/rack/log_tailer"
   end
diff --git a/railties/test/commands/console_test.rb b/railties/test/commands/console_test.rb
index a34beaedb3..1273f9d4c2 100644
--- a/railties/test/commands/console_test.rb
+++ b/railties/test/commands/console_test.rb
@@ -19,14 +19,8 @@ class Rails::ConsoleTest < ActiveSupport::TestCase
     assert console.sandbox?
   end
 
-  def test_debugger_option
-    console = Rails::Console.new(app, parse_arguments(["--debugger"]))
-    assert console.debugger?
-  end
-
   def test_no_options
     console = Rails::Console.new(app, parse_arguments([]))
-    assert !console.debugger?
     assert !console.sandbox?
   end
 
@@ -36,13 +30,6 @@ class Rails::ConsoleTest < ActiveSupport::TestCase
     assert_match(/Loading \w+ environment \(Rails/, output)
   end
 
-  def test_start_with_debugger
-    rails_console = Rails::Console.new(app, parse_arguments(["--debugger"]))
-    rails_console.expects(:require_debugger).returns(nil)
-
-    silence_stream(STDOUT) { rails_console.start }
-  end
-
   def test_start_with_sandbox
     app.expects(:sandbox=).with(true)
     FakeConsole.expects(:start)
@@ -52,6 +39,25 @@ class Rails::ConsoleTest < ActiveSupport::TestCase
     assert_match(/Loading \w+ environment in sandbox \(Rails/, output)
   end
 
+  if RUBY_VERSION < '2.0.0'
+    def test_debugger_option
+      console = Rails::Console.new(app, parse_arguments(["--debugger"]))
+      assert console.debugger?
+    end
+
+    def test_no_options_does_not_set_debugger_flag
+      console = Rails::Console.new(app, parse_arguments([]))
+      assert !console.debugger?
+    end
+
+    def test_start_with_debugger
+      rails_console = Rails::Console.new(app, parse_arguments(["--debugger"]))
+      rails_console.expects(:require_debugger).returns(nil)
+
+      silence_stream(STDOUT) { rails_console.start }
+    end
+  end
+
   def test_console_with_environment
     start ["-e production"]
     assert_match(/\sproduction\s/, output)
diff --git a/railties/test/generators/app_generator_test.rb b/railties/test/generators/app_generator_test.rb
index b7bc721247..007dd886da 100644
--- a/railties/test/generators/app_generator_test.rb
+++ b/railties/test/generators/app_generator_test.rb
@@ -305,14 +305,17 @@ class AppGeneratorTest < Rails::Generators::TestCase
     assert_file "Gemfile", /gem 'jbuilder'/
   end
 
-  def test_inclusion_of_debugger
+  def test_inclusion_of_a_debugger
     run_generator
     if defined?(JRUBY_VERSION)
       assert_file "Gemfile" do |content|
+        assert_no_match(/byebug/, content)
         assert_no_match(/debugger/, content)
       end
-    else
+    elsif RUBY_VERSION < '2.0.0'
       assert_file "Gemfile", /# gem 'debugger'/
+    else
+      assert_file "Gemfile", /# gem 'byebug'/
     end
   end
 
diff --git a/railties/test/generators/plugin_generator_test.rb b/railties/test/generators/plugin_generator_test.rb
index 7a2701f813..853af80111 100644
--- a/railties/test/generators/plugin_generator_test.rb
+++ b/railties/test/generators/plugin_generator_test.rb
@@ -64,14 +64,17 @@ class PluginGeneratorTest < Rails::Generators::TestCase
     assert_file "test/integration/navigation_test.rb", /ActionDispatch::IntegrationTest/
   end
 
-  def test_inclusion_of_debugger
+  def test_inclusion_of_a_debugger
     run_generator [destination_root, '--full']
     if defined?(JRUBY_VERSION)
       assert_file "Gemfile" do |content|
+        assert_no_match(/byebug/, content)
         assert_no_match(/debugger/, content)
       end
-    else
+    elsif RUBY_VERSION < '2.0.0'
       assert_file "Gemfile", /# gem 'debugger'/
+    else
+      assert_file "Gemfile", /# gem 'byebug'/
     end
   end