honeybadger 5.29.1 → 6.0.0

data/lib/honeybadger/cli/test.rb

@@ -1,7 +1,7 @@
-require 'erb'
-require 'forwardable'
-require 'honeybadger/cli/main'
-require 'pathname'
+require "erb"
+require "forwardable"
+require "honeybadger/cli/main"
+require "pathname"
 
 module Honeybadger
   module CLI
@@ -9,11 +9,11 @@ module Honeybadger
       extend Forwardable
 
       TEST_EXCEPTION = begin
-                         exception_name = ENV['EXCEPTION'] || 'HoneybadgerTestingException'
-                         Object.const_get(exception_name)
-                       rescue
-                         Object.const_set(exception_name, Class.new(Exception))
-                       end.new('Testing honeybadger via "honeybadger test". If you can see this, it works.')
+        exception_name = ENV["EXCEPTION"] || "HoneybadgerTestingException"
+        Object.const_get(exception_name)
+      rescue
+        Object.const_set(exception_name, Class.new(RuntimeError))
+      end.new('Testing honeybadger via "honeybadger test". If you can see this, it works.')
 
       class TestBackend
         def initialize(backend)
@@ -21,7 +21,7 @@ module Honeybadger
         end
 
         def self.callings
-          @callings ||= Hash.new {|h,k| h[k] = [] }
+          @callings ||= Hash.new { |h, k| h[k] = [] }
         end
 
         def self.events
@@ -48,14 +48,14 @@ module Honeybadger
 
       def run
         begin
-          require File.join(Dir.pwd, 'config', 'environment.rb')
+          require File.join(Dir.pwd, "config", "environment.rb")
           raise LoadError unless defined?(::Rails.application)
           say("Detected Rails #{Rails::VERSION::STRING}")
         rescue LoadError
-          require 'honeybadger/init/ruby'
+          require "honeybadger/init/ruby"
         end
 
-        if Honeybadger.config.get(:api_key).to_s =~ BLANK
+        if BLANK.match?(Honeybadger.config.get(:api_key).to_s)
           say("Unable to send test: Honeybadger API key is missing.", :red)
           exit(1)
         end
@@ -87,10 +87,10 @@ module Honeybadger
       end
 
       def test_exception_class
-        exception_name = ENV['EXCEPTION'] || 'HoneybadgerTestingException'
+        exception_name = ENV["EXCEPTION"] || "HoneybadgerTestingException"
         Object.const_get(exception_name)
       rescue
-        Object.const_set(exception_name, Class.new(Exception))
+        Object.const_set(exception_name, Class.new(RuntimeError))
       end
 
       def run_standalone_test
@@ -104,43 +104,58 @@ module Honeybadger
         # logging the framework trace (moved to ActionDispatch::DebugExceptions),
         # which caused cluttered output while running the test task.
         defined?(::ActionDispatch::DebugExceptions) and
-          ::ActionDispatch::DebugExceptions.class_eval { def logger(*args) ; @logger ||= Logger.new(nil) ; end }
+          ::ActionDispatch::DebugExceptions.class_eval {
+            def logger(*args)
+              @logger ||= Logger.new(nil)
+            end
+          }
         defined?(::ActionDispatch::ShowExceptions) and
-          ::ActionDispatch::ShowExceptions.class_eval { def logger(*args) ; @logger ||= Logger.new(nil) ; end }
+          ::ActionDispatch::ShowExceptions.class_eval {
+            def logger(*args)
+              @logger ||= Logger.new(nil)
+            end
+          }
 
         # Detect and disable the better_errors gem
         if defined?(::BetterErrors::Middleware)
-          say('Better Errors detected: temporarily disabling middleware.', :yellow)
-          ::BetterErrors::Middleware.class_eval { def call(env) @app.call(env); end }
+          say("Better Errors detected: temporarily disabling middleware.", :yellow)
+          ::BetterErrors::Middleware.class_eval {
+            def call(env)
+              @app.call(env)
+            end
+          }
         end
 
         begin
-          require './app/controllers/application_controller'
+          require "./app/controllers/application_controller"
         rescue LoadError
           nil
         end
 
         unless defined?(::ApplicationController)
-          say('Error: No ApplicationController found.', :red)
+          say("Error: No ApplicationController found.", :red)
           return false
         end
 
-        eval(<<-CONTROLLER)
-        class Honeybadger::TestController < ApplicationController
-          # This is to bypass any filters that may prevent access to the action.
-          if respond_to?(:prepend_before_action)
-            prepend_before_action :test_honeybadger
-          else
-            prepend_before_filter :test_honeybadger
-          end
-          def test_honeybadger
-            puts "Raising '#{Honeybadger::CLI::Test::TEST_EXCEPTION.class.name}' to simulate application failure."
-            raise Honeybadger::CLI::Test::TEST_EXCEPTION
+        # Define the test controller class
+        controller_code = <<~RUBY
+          class Honeybadger::TestController < ApplicationController
+            # This is to bypass any filters that may prevent access to the action.
+            if respond_to?(:prepend_before_action)
+              prepend_before_action :test_honeybadger
+            else
+              prepend_before_filter :test_honeybadger
+            end
+            def test_honeybadger
+              puts "Raising '\#{Honeybadger::CLI::Test::TEST_EXCEPTION.class.name}' to simulate application failure."
+              raise Honeybadger::CLI::Test::TEST_EXCEPTION
+            end
+            # Ensure we actually have an action to go to.
+            def verify; end
           end
-          # Ensure we actually have an action to go to.
-          def verify; end
-        end
-        CONTROLLER
+        RUBY
+
+        Honeybadger.module_eval(controller_code, __FILE__, __LINE__)
 
         ::Rails.application.try(:reload_routes_unless_loaded)
         ::Rails.application.routes.tap do |r|
@@ -152,9 +167,9 @@ module Honeybadger
             r.disable_clear_and_finalize = true
             r.clear!
             r.draw do
-              match 'verify' => 'honeybadger/test#verify', :as => "verify_#{SecureRandom.hex}", :via => :get
+              match "verify" => "honeybadger/test#verify", :as => "verify_#{SecureRandom.hex}", :via => :get
             end
-            ::Rails.application.routes_reloader.paths.each{ |path| load(path) }
+            ::Rails.application.routes_reloader.paths.each { |path| load(path) }
             ::ActiveSupport.on_load(:action_controller) { r.finalize! }
           ensure
             r.disable_clear_and_finalize = d
@@ -162,7 +177,7 @@ module Honeybadger
         end
 
         ssl = defined?(::Rails.configuration.force_ssl) && ::Rails.configuration.force_ssl
-        env = ::Rack::MockRequest.env_for("http#{ ssl ? 's' : nil }://www.example.com/verify", 'REMOTE_ADDR' => '127.0.0.1', 'HTTP_HOST' => 'localhost')
+        env = ::Rack::MockRequest.env_for("http#{ssl ? "s" : nil}://www.example.com/verify", "REMOTE_ADDR" => "127.0.0.1", "HTTP_HOST" => "localhost")
 
         ::Rails.application.call(env)
       end
@@ -170,28 +185,28 @@ module Honeybadger
       def verify_test
         Honeybadger.flush
 
-        if calling = TestBackend.callings[:notices].find {|c| c[0].exception.eql?(TEST_EXCEPTION) }
-          notice, response = *calling
+        if (calling = TestBackend.callings[:notices].find { |c| c[0].exception.eql?(TEST_EXCEPTION) })
+          _, response = *calling
 
           if !response.success?
-            host = Honeybadger.config.get(:'connection.host')
-            say(<<-MSG, :red)
-!! --- Honeybadger test failed ------------------------------------------------ !!
+            host = Honeybadger.config.get(:"connection.host")
+            say(<<~MSG, :red)
+              !! --- Honeybadger test failed ------------------------------------------------ !!
 
-The error notifier is installed, but we encountered an error:
+              The error notifier is installed, but we encountered an error:
 
-  #{response.error_message}
+                #{response.error_message}
 
-To fix this issue, please try the following:
+              To fix this issue, please try the following:
 
-  - Make sure the gem is configured properly.
-  - Retry executing this command a few times.
-  - Make sure you can connect to #{host} (`curl https://#{host}/v1/notices`).
-  - Email support@honeybadger.io for help. Include as much debug info as you
-    can for a faster resolution!
+                - Make sure the gem is configured properly.
+                - Retry executing this command a few times.
+                - Make sure you can connect to #{host} (`curl https://#{host}/v1/notices`).
+                - Email support@honeybadger.io for help. Include as much debug info as you
+                  can for a faster resolution!
 
-!! --- End -------------------------------------------------------------------- !!
-MSG
+              !! --- End -------------------------------------------------------------------- !!
+            MSG
             exit(1)
           end
 
@@ -200,27 +215,27 @@ MSG
           exit(0)
         end
 
-        say(<<-MSG, :red)
-!! --- Honeybadger test failed ------------------------------------------------ !!
+        say(<<~MSG, :red)
+          !! --- Honeybadger test failed ------------------------------------------------ !!
 
-Error: The test exception was not reported; the application may not be
-configured properly.
+          Error: The test exception was not reported; the application may not be
+          configured properly.
 
-This is usually caused by one of the following issues:
+          This is usually caused by one of the following issues:
 
-  - There was a problem loading your application. Check your logs to see if a
-    different exception is being raised.
-  - The exception is being rescued before it reaches our Rack middleware. If
-    you're using `rescue` or `rescue_from` you may need to notify Honeybadger
-    manually: `Honeybadger.notify(exception)`.
-  - The honeybadger gem is misconfigured. Check the settings in your
-    honeybadger.yml file.
-MSG
+            - There was a problem loading your application. Check your logs to see if a
+              different exception is being raised.
+            - The exception is being rescued before it reaches our Rack middleware. If
+              you're using `rescue` or `rescue_from` you may need to notify Honeybadger
+              manually: `Honeybadger.notify(exception)`.
+            - The honeybadger gem is misconfigured. Check the settings in your
+              honeybadger.yml file.
+        MSG
 
         notices = TestBackend.callings[:notices].map(&:first)
         unless notices.empty?
           say("\nThe following errors were reported:", :red)
-          notices.each {|n| say("\n  - #{n.error_class}: #{n.error_message}", :red) }
+          notices.each { |n| say("\n  - #{n.error_class}: #{n.error_message}", :red) }
         end
 
         say("\nSee https://docs.honeybadger.io/gem-troubleshooting for more troubleshooting help.\n\n", :red)
@@ -230,48 +245,48 @@ MSG
       end
 
       def generate_success_message(response)
-        notice_id = JSON.parse(response.body)['id']
+        notice_id = JSON.parse(response.body)["id"]
         notice_url = "https://app.honeybadger.io/notice/#{notice_id}"
 
         unless options[:install]
           return "⚡ Success: #{notice_url}"
         end
 
-        <<-MSG
-⚡ --- Honeybadger is installed! -----------------------------------------------
+        <<~MSG
+          ⚡ --- Honeybadger is installed! -----------------------------------------------
 
-Good news: You're one deploy away from seeing all of your exceptions in
-Honeybadger. For now, we've generated a test exception for you:
+          Good news: You're one deploy away from seeing all of your exceptions in
+          Honeybadger. For now, we've generated a test exception for you:
 
-  #{notice_url}
+            #{notice_url}
 
-Optional steps:
+          Optional steps:
 
-  - Show a feedback form on your error page:
-    https://docs.honeybadger.io/gem-feedback
-  - Show a UUID or link to Honeybadger on your error page:
-    https://docs.honeybadger.io/gem-informer
-  - Track deployments (if you're using Capistrano, we already did this):
-    https://docs.honeybadger.io/gem-deploys
+            - Show a feedback form on your error page:
+              https://docs.honeybadger.io/gem-feedback
+            - Show a UUID or link to Honeybadger on your error page:
+              https://docs.honeybadger.io/gem-informer
+            - Track deployments (if you're using Capistrano, we already did this):
+              https://docs.honeybadger.io/gem-deploys
 
-If you ever need help:
+          If you ever need help:
 
-  - Read the gem troubleshooting guide: https://docs.honeybadger.io/gem-troubleshooting
-  - Check out our documentation: https://docs.honeybadger.io/
-  - Email the founders: support@honeybadger.io
+            - Read the gem troubleshooting guide: https://docs.honeybadger.io/gem-troubleshooting
+            - Check out our documentation: https://docs.honeybadger.io/
+            - Email the founders: support@honeybadger.io
 
-Most people don't realize that Honeybadger is a small, bootstrapped company. We
-really couldn't do this without you. Thank you for allowing us to do what we
-love: making developers awesome.
+          Most people don't realize that Honeybadger is a small, bootstrapped company. We
+          really couldn't do this without you. Thank you for allowing us to do what we
+          love: making developers awesome.
 
-Happy 'badgering!
+          Happy 'badgering!
 
-Sincerely,
-The Honeybadger Crew
-https://www.honeybadger.io/about/
+          Sincerely,
+          The Honeybadger Crew
+          https://www.honeybadger.io/about/
 
-⚡ --- End --------------------------------------------------------------------
-MSG
+          ⚡ --- End --------------------------------------------------------------------
+        MSG
       end
     end
   end

data/lib/honeybadger/cli.rb

@@ -1,8 +1,8 @@
-$:.unshift(File.expand_path('../../../vendor/cli', __FILE__))
+$:.unshift(File.expand_path("../../../vendor/cli", __FILE__))
 
-require 'thor'
+require "thor"
 
-require 'honeybadger/cli/main'
+require "honeybadger/cli/main"
 
 module Honeybadger
   # @api private