From 833c1c9a4d59090a96fe68a2676e6a2f5ed83299 Mon Sep 17 00:00:00 2001 From: zzak Date: Mon, 13 May 2024 13:37:15 +0900 Subject: [PATCH] Enable Lint/Debugger This will prevent issues like be0cb4e8f9, which would have resulted in: ``` guides/rails_guides/generator.rb:16:1: W: Lint/Debugger: Remove debugger entry point require "debug". require "debug" ^^^^^^^^^^^^^^^ ``` Disabled the cop in actionpack tests for screenshot_helper and page_dump_helper: ``` actionpack/test/controller/integration_test.rb:1369:9: W: Lint/Debugger: Remove debugger entry point save_and_open_page. save_and_open_page ^^^^^^^^^^^^^^^^^^ actionpack/test/controller/integration_test.rb:1381:11: W: Lint/Debugger: Remove debugger entry point save_and_open_page. save_and_open_page ^^^^^^^^^^^^^^^^^^ actionpack/test/controller/integration_test.rb:1391:39: W: Lint/Debugger: Remove debugger entry point save_and_open_page. assert_raise(InvalidResponse) { save_and_open_page } ^^^^^^^^^^^^^^^^^^ ``` ``` actionpack/lib/action_dispatch/system_testing/test_helpers/screenshot_helper.rb:111:13: W: Lint/Debugger: Remove debugger entry point page.save_page(absolute_html_path). page.save_page(absolute_html_path) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ actionpack/lib/action_dispatch/system_testing/test_helpers/screenshot_helper.rb:115:13: W: Lint/Debugger: Remove debugger entry point page.save_screenshot(absolute_image _path). page.save_screenshot(absolute_image_path) ``` The DebuggerRequires option was first available in rubocop v1.63.0, in rubocop/rubocop#12766. --- .rubocop.yml | 5 +++++ Gemfile.lock | 12 ++++++------ .../system_testing/test_helpers/screenshot_helper.rb | 2 ++ actionpack/test/controller/integration_test.rb | 2 ++ 4 files changed, 15 insertions(+), 6 deletions(-) diff --git a/.rubocop.yml b/.rubocop.yml index 922ea32681..506b0dd6a7 100644 --- a/.rubocop.yml +++ b/.rubocop.yml @@ -223,6 +223,11 @@ Lint/AmbiguousOperator: Lint/AmbiguousRegexpLiteral: Enabled: true +Lint/Debugger: + Enabled: true + DebuggerRequires: + - debug + Lint/DuplicateRequire: Enabled: true diff --git a/Gemfile.lock b/Gemfile.lock index 37737c688a..dc3e85540f 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -371,7 +371,7 @@ GEM racc (~> 1.4) os (1.1.4) parallel (1.24.0) - parser (3.2.2.4) + parser (3.3.1.0) ast (~> 2.4.1) racc path_expander (1.1.1) @@ -444,19 +444,19 @@ GEM retriable (3.1.2) rexml (3.2.6) rouge (4.2.0) - rubocop (1.59.0) + rubocop (1.63.5) json (~> 2.3) language_server-protocol (>= 3.17.0) parallel (~> 1.10) - parser (>= 3.2.2.4) + parser (>= 3.3.0.2) rainbow (>= 2.2.2, < 4.0) regexp_parser (>= 1.8, < 3.0) rexml (>= 3.2.5, < 4.0) - rubocop-ast (>= 1.30.0, < 2.0) + rubocop-ast (>= 1.31.1, < 2.0) ruby-progressbar (~> 1.7) unicode-display_width (>= 2.4.0, < 3.0) - rubocop-ast (1.30.0) - parser (>= 3.2.1.0) + rubocop-ast (1.31.3) + parser (>= 3.3.1.0) rubocop-md (1.2.2) rubocop (>= 1.0) rubocop-minitest (0.34.3) diff --git a/actionpack/lib/action_dispatch/system_testing/test_helpers/screenshot_helper.rb b/actionpack/lib/action_dispatch/system_testing/test_helpers/screenshot_helper.rb index 46c896f44a..5c1404c32f 100644 --- a/actionpack/lib/action_dispatch/system_testing/test_helpers/screenshot_helper.rb +++ b/actionpack/lib/action_dispatch/system_testing/test_helpers/screenshot_helper.rb @@ -107,6 +107,7 @@ def absolute_html_path "#{absolute_path}.html" end + # rubocop:disable Lint/Debugger def save_html page.save_page(absolute_html_path) end @@ -114,6 +115,7 @@ def save_html def save_image page.save_screenshot(absolute_image_path) end + # rubocop:enable Lint/Debugger def output_type # Environment variables have priority diff --git a/actionpack/test/controller/integration_test.rb b/actionpack/test/controller/integration_test.rb index 5d4d4267be..17af1c906d 100644 --- a/actionpack/test/controller/integration_test.rb +++ b/actionpack/test/controller/integration_test.rb @@ -1309,6 +1309,7 @@ def test_fixture_file_upload end end +# rubocop:disable Lint/Debugger class PageDumpIntegrationTest < ActionDispatch::IntegrationTest class FooController < ActionController::Base def index @@ -1392,3 +1393,4 @@ def remove_dumps end end end +# rubocop:enable Lint/Debugger