Merge pull request #7577 from vidusheeamoli/add-byebug

Set up Byebug debugger

.gitignore

@@ -18,6 +18,7 @@
 /Library/Homebrew/vendor/portable-ruby
 /Library/Taps
 /Library/PinnedTaps
+/Library/Homebrew/.byebug_history
 
 # Ignore Bundler files
 **/.bundle/bin
@@ -131,6 +132,7 @@
 **/vendor/bundle/ruby/*/gems/unf-*/
 **/vendor/bundle/ruby/*/gems/unicode-display_width-*/
 **/vendor/bundle/ruby/*/gems/webrobots-*/
+**/vendor/bundle/ruby/*/gems/byebug-*/
 
 # Ignore `bin` contents (again).
 /bin

Library/Homebrew/Gemfile

@@ -3,6 +3,7 @@
 source "https://rubygems.org"
 
 # installed gems
+gem "byebug"
 gem "coveralls", "~> 0.8", require: false
 gem "parallel_tests"
 gem "ronn", require: false

Library/Homebrew/Gemfile.lock

@@ -8,6 +8,7 @@ GEM
       tzinfo (~> 1.1)
       zeitwerk (~> 2.2, >= 2.2.2)
     ast (2.4.0)
+    byebug (11.1.3)
     concurrent-ruby (1.1.6)
     connection_pool (2.2.2)
     coveralls (0.8.23)
@@ -119,6 +120,7 @@ PLATFORMS
 
 DEPENDENCIES
   activesupport
+  byebug
   concurrent-ruby
   coveralls (~> 0.8)
   mechanize

Library/Homebrew/dev-cmd/tests.rb

@@ -22,6 +22,8 @@ module Homebrew
       switch "--online",
              description: "Include tests that use the GitHub API and tests that use any of the taps for "\
                           "official external commands."
+      switch "--byebug",
+             description: "Enable debugging using byebug."
       flag   "--only=",
              description: "Run only <test_script>`_spec.rb`. Appending `:`<line_number> will start at a "\
                           "specific line."
@@ -39,6 +41,8 @@ module Homebrew
     Homebrew.install_bundler_gems!
     gem_user_dir = Gem.user_dir
 
+    require "byebug" if args.byebug?
+
     HOMEBREW_LIBRARY_PATH.cd do
       ENV.delete("HOMEBREW_COLOR")
       ENV.delete("HOMEBREW_NO_COLOR")

Library/Homebrew/test/spec_helper.rb

@@ -39,6 +39,7 @@ require "rspec/retry"
 require "rubocop"
 require "rubocop/rspec/support"
 require "find"
+require "byebug"
 
 $LOAD_PATH.push(File.expand_path("#{ENV["HOMEBREW_LIBRARY"]}/Homebrew/test/support/lib"))
 
@@ -177,7 +178,7 @@ RSpec.configure do |config|
       @__stdout = $stdout.clone
       @__stderr = $stderr.clone
 
-      unless example.metadata.key?(:focus) || ENV.key?("VERBOSE_TESTS")
+      if (example.metadata.keys & [:focus, :byebug]).empty? && !ENV.key?("VERBOSE_TESTS")
         $stdout.reopen(File::NULL)
         $stderr.reopen(File::NULL)
       end

Library/Homebrew/vendor/bundle/bundler/setup.rb

@@ -65,3 +65,4 @@ $:.unshift "#{path}/../#{ruby_engine}/#{ruby_version}/gems/rubocop-0.83.0/lib"
 $:.unshift "#{path}/../#{ruby_engine}/#{ruby_version}/gems/rubocop-performance-1.5.2/lib"
 $:.unshift "#{path}/../#{ruby_engine}/#{ruby_version}/gems/rubocop-rspec-1.39.0/lib"
 $:.unshift "#{path}/../#{ruby_engine}/#{ruby_version}/gems/ruby-macho-2.2.0/lib"
+$:.unshift "#{path}/../#{ruby_engine}/#{ruby_version}/gems/byebug-11.1.3/lib"

docs/Manpage.md

@@ -1015,6 +1015,8 @@ Run Homebrew's unit and integration tests.
   Do not load the compatibility layer when running tests.
 * `--online`:
   Include tests that use the GitHub API and tests that use any of the taps for official external commands.
+* `--byebug`:
+  Enable debugging using byebug.
 * `--only`:
   Run only *`test_script`*`_spec.rb`. Appending `:`*`line_number`* will start at a specific line.
 * `--seed`:

manpages/brew.1

@@ -1307,6 +1307,10 @@ Do not load the compatibility layer when running tests\.
 Include tests that use the GitHub API and tests that use any of the taps for official external commands\.
 .
 .TP
+\fB\-\-byebug\fR
+Enable debugging using byebug\.
+.
+.TP
 \fB\-\-only\fR
 Run only \fItest_script\fR\fB_spec\.rb\fR\. Appending \fB:\fR\fIline_number\fR will start at a specific line\.
 .