Merge pull request #224 from koic/lazy_load_cops

Load cops lazily

Author: bquorning

.rubocop.yml

@@ -28,6 +28,7 @@ Layout/LineLength:
   Max: 80 # default: 120
   AllowedPatterns:
     - '^\s*# .*https?:\/\/.+\[.+\]\.?$' # Allow long asciidoc links
+    - '^\s*register_cop :' # Cop registrations in the department modules
 
 Layout/MultilineMethodCallIndentation:
   EnforcedStyle: indented

CHANGELOG.md

@@ -2,6 +2,7 @@
 
 ## Edge (Unreleased)
 
+- Speed up loading rubocop-capybara by lazily loading only the cops needed for a run. This requires RuboCop 1.89.0+. ([@koic])
 - Fix an incorrect autocorrect for `Capybara/RedundantWithinFind` when `find_by_id` uses a dynamic id. ([@ydah])
 - Fix a false positive for `Capybara/RSpec/HaveSelector` when `DefaultSelector` is unsupported. ([@ydah])
 - Fix an incorrect autocorrect for `Capybara/SpecificFinders` when a selector class is empty or contains an escaped dot. ([@ydah])

Rakefile

@@ -94,7 +94,7 @@ task :new_cop, [:cop] do |_task, args|
   generator = RuboCop::Capybara::Cop::Generator.new(cop_name)
   generator.write_source
   generator.write_spec
-  generator.inject_require(root_file_path: 'lib/rubocop/cop/capybara_cops.rb')
+  generator.inject_registration
   generator.inject_config
 
   puts generator.todo

docs/modules/ROOT/pages/development.adoc

@@ -14,7 +14,7 @@ Use the bundled rake task `new_cop` to generate a cop template:
 $ bundle exec rake 'new_cop[Capybara/CopName]'
 [create] lib/rubocop/cop/capybara/cop_name.rb
 [create] spec/rubocop/cop/capybara/cop_name_spec.rb
-[modify] lib/rubocop/cop/capybara_cops.rb - `require_relative 'capybara/cop_name'` was injected.
+[modify] lib/rubocop/cop/capybara.rb - `register_cop :CopName, "#{__dir__}/capybara/cop_name"` was injected.
 [modify] A configuration for the cop is added into config/default.yml.
 Do 4 steps:
   1. Modify the description of Capybara/CopName in config/default.yml

lib/rubocop-capybara.rb

@@ -9,7 +9,7 @@
 require_relative 'rubocop/cop/capybara/mixin/css_attributes_parser'
 require_relative 'rubocop/cop/capybara/mixin/css_selector'
 
-require_relative 'rubocop/cop/capybara_cops'
+require_relative 'rubocop/cop/capybara'
 
 RuboCop::Cop::Style::TrailingCommaInArguments.singleton_class.prepend(
   Module.new do

lib/rubocop/cop/capybara.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require_relative 'capybara/rspec'
+
+module RuboCop
+  module Cop
+    # Cops for the `Capybara` department. The department's cops are
+    # registered for lazy loading and their files are loaded on demand.
+    module Capybara
+      extend LazyLoader
+
+      register_cop :AmbiguousClick, "#{__dir__}/capybara/ambiguous_click"
+      register_cop :AssertStyle, "#{__dir__}/capybara/assert_style"
+      register_cop :FindAllFirst, "#{__dir__}/capybara/find_all_first"
+      register_cop :RedundantWithinFind, "#{__dir__}/capybara/redundant_within_find"
+      register_cop :SpecificActions, "#{__dir__}/capybara/specific_actions"
+      register_cop :SpecificFinders, "#{__dir__}/capybara/specific_finders"
+    end
+  end
+end

lib/rubocop/cop/capybara/rspec.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Capybara
+      # Cops for the `Capybara/RSpec` department. The department's cops are
+      # registered for lazy loading and their files are loaded on demand.
+      module RSpec
+        extend LazyLoader
+
+        register_cop :CurrentPathExpectation, "#{__dir__}/rspec/current_path_expectation"
+        register_cop :HaveContent, "#{__dir__}/rspec/have_content"
+        register_cop :HaveSelector, "#{__dir__}/rspec/have_selector"
+        register_cop :MatchStyle, "#{__dir__}/rspec/match_style"
+        register_cop :NegationMatcher, "#{__dir__}/rspec/negation_matcher"
+        register_cop :NegationMatcherAfterVisit, "#{__dir__}/rspec/negation_matcher_after_visit"
+        register_cop :PredicateMatcher, "#{__dir__}/rspec/predicate_matcher"
+        register_cop :SpecificMatcher, "#{__dir__}/rspec/specific_matcher"
+        register_cop :VisibilityMatcher, "#{__dir__}/rspec/visibility_matcher"
+      end
+    end
+  end
+end

lib/rubocop/cop/capybara_cops.rb

@@ -1,18 +1,6 @@
 # frozen_string_literal: true
 
-require_relative 'capybara/rspec/current_path_expectation'
-require_relative 'capybara/rspec/have_content'
-require_relative 'capybara/rspec/have_selector'
-require_relative 'capybara/rspec/match_style'
-require_relative 'capybara/rspec/negation_matcher'
-require_relative 'capybara/rspec/negation_matcher_after_visit'
-require_relative 'capybara/rspec/predicate_matcher'
-require_relative 'capybara/rspec/specific_matcher'
-require_relative 'capybara/rspec/visibility_matcher'
-
-require_relative 'capybara/ambiguous_click'
-require_relative 'capybara/assert_style'
-require_relative 'capybara/find_all_first'
-require_relative 'capybara/redundant_within_find'
-require_relative 'capybara/specific_actions'
-require_relative 'capybara/specific_finders'
+# @deprecated This file is deprecated. Cops are registered for lazy loading in
+#   `rubocop/cop/capybara`; this file is kept for compatibility with code that
+#   requires it directly.
+require_relative 'capybara'

rubocop-capybara.gemspec

@@ -34,5 +34,5 @@ Gem::Specification.new do |spec|
   }
 
   spec.add_dependency 'lint_roller', '~> 1.1'
-  spec.add_dependency 'rubocop', '~> 1.81'
+  spec.add_dependency 'rubocop', '~> 1.89'
 end

spec/project/default_config_spec.rb

@@ -13,14 +13,7 @@
   end
 
   let(:cop_names) do
-    glob = SpecHelper::ROOT.join('lib', 'rubocop', 'cop', 'capybara',
-                                 '{,rspec}', '*.rb')
-    Pathname.glob(glob).map do |file|
-      file_name = file.basename('.rb').to_s
-      cop_name  = file_name.gsub(/(^|_)(.)/) { Regexp.last_match(2).upcase }
-      namespace = namespaces[file.dirname.basename.to_s]
-      "#{namespace}/#{cop_name}"
-    end
+    RuboCop::Cop::Registry.global.names.grep(%r{\ACapybara/})
   end
 
   let(:config_keys) do