rubocop-rspec 2.0.0.pre → 2.3.0

data/lib/rubocop-rspec.rb

@@ -5,26 +5,26 @@ require 'yaml'
 
 require 'rubocop'
 
-require_relative 'rubocop/rspec'
 require_relative 'rubocop/rspec/version'
 require_relative 'rubocop/rspec/inject'
 require_relative 'rubocop/rspec/node'
-require_relative 'rubocop/rspec/top_level_describe'
 require_relative 'rubocop/rspec/wording'
-require_relative 'rubocop/rspec/language'
 require_relative 'rubocop/rspec/language/node_pattern'
-require_relative 'rubocop/rspec/top_level_group'
+require_relative 'rubocop/rspec/language'
+
+require_relative 'rubocop/cop/rspec/mixin/top_level_group'
+require_relative 'rubocop/cop/rspec/mixin/variable'
+require_relative 'rubocop/cop/rspec/mixin/final_end_location'
+require_relative 'rubocop/cop/rspec/mixin/comments_help'
+require_relative 'rubocop/cop/rspec/mixin/empty_line_separation'
+
 require_relative 'rubocop/rspec/concept'
 require_relative 'rubocop/rspec/example_group'
 require_relative 'rubocop/rspec/example'
 require_relative 'rubocop/rspec/hook'
-require_relative 'rubocop/rspec/variable'
 require_relative 'rubocop/cop/rspec/base'
-require_relative 'rubocop/cop/rspec/cop'
 require_relative 'rubocop/rspec/align_let_brace'
 require_relative 'rubocop/rspec/factory_bot'
-require_relative 'rubocop/rspec/final_end_location'
-require_relative 'rubocop/rspec/empty_line_separation'
 require_relative 'rubocop/rspec/corrector/move_node'
 
 RuboCop::RSpec::Inject.defaults!

data/lib/rubocop/cop/rspec/align_left_let_brace.rb

@@ -27,11 +27,9 @@ module RuboCop
         end
 
         def on_new_investigation
+          super
           return if processed_source.blank?
 
-          token_aligner =
-            RuboCop::RSpec::AlignLetBrace.new(processed_source.ast, :begin)
-
           token_aligner.offending_tokens.each do |let|
             add_offense(let.loc.begin) do |corrector|
               corrector.insert_before(
@@ -40,6 +38,12 @@ module RuboCop
             end
           end
         end
+
+        private
+
+        def token_aligner
+          RuboCop::RSpec::AlignLetBrace.new(processed_source.ast, :begin)
+        end
       end
     end
   end

data/lib/rubocop/cop/rspec/align_right_let_brace.rb

@@ -27,11 +27,9 @@ module RuboCop
         end
 
         def on_new_investigation
+          super
           return if processed_source.blank?
 
-          token_aligner =
-            RuboCop::RSpec::AlignLetBrace.new(processed_source.ast, :end)
-
           token_aligner.offending_tokens.each do |let|
             add_offense(let.loc.end) do |corrector|
               corrector.insert_before(
@@ -40,6 +38,12 @@ module RuboCop
             end
           end
         end
+
+        private
+
+        def token_aligner
+          RuboCop::RSpec::AlignLetBrace.new(processed_source.ast, :end)
+        end
       end
     end
   end

data/lib/rubocop/cop/rspec/any_instance.rb

@@ -24,18 +24,14 @@ module RuboCop
       #   end
       class AnyInstance < Base
         MSG = 'Avoid stubbing using `%<method>s`.'
-
-        def_node_matcher :disallowed_stub, <<-PATTERN
-          (send _ ${:any_instance :allow_any_instance_of :expect_any_instance_of} ...)
-        PATTERN
+        RESTRICT_ON_SEND = %i[
+          any_instance
+          allow_any_instance_of
+          expect_any_instance_of
+        ].freeze
 
         def on_send(node)
-          disallowed_stub(node) do |method|
-            add_offense(
-              node,
-              message: format(MSG, method: method)
-            )
-          end
+          add_offense(node, message: format(MSG, method: node.method_name))
         end
       end
     end

data/lib/rubocop/cop/rspec/around_block.rb

@@ -27,13 +27,15 @@ module RuboCop
       #   end
       class AroundBlock < Base
         MSG_NO_ARG     = 'Test object should be passed to around block.'
-        MSG_UNUSED_ARG = 'You should call `%<arg>s.call` '\
+        MSG_UNUSED_ARG = 'You should call `%<arg>s.call` ' \
                          'or `%<arg>s.run`.'
 
+        # @!method hook(node)
         def_node_matcher :hook, <<-PATTERN
           (block (send nil? :around sym ?) (args $...) ...)
         PATTERN
 
+        # @!method find_arg_usage(node)
         def_node_search :find_arg_usage, <<-PATTERN
           {(send $... {:call :run}) (send _ _ $...) (yield $...) (block-pass $...)}
         PATTERN

data/lib/rubocop/cop/rspec/base.rb

@@ -4,30 +4,9 @@ module RuboCop
   module Cop
     module RSpec
       # @abstract parent class to RSpec cops
-      #
-      # The criteria for whether rubocop-rspec analyzes a certain ruby file
-      # is configured via `AllCops/RSpec`. For example, if you want to
-      # customize your project to scan all files within a `test/` directory
-      # then you could add this to your configuration:
-      #
-      # @example configuring analyzed paths
-      #   # .rubocop.yml
-      #   # AllCops:
-      #   #   RSpec:
-      #   #     Patterns:
-      #   #     - '_test.rb$'
-      #   #     - '(?:^|/)test/'
       class Base < ::RuboCop::Cop::Base
         include RuboCop::RSpec::Language
-        include RuboCop::RSpec::Language::NodePattern
-
-        DEFAULT_CONFIGURATION =
-          RuboCop::RSpec::CONFIG.fetch('AllCops').fetch('RSpec')
-
-        DEFAULT_PATTERN_RE = Regexp.union(
-          DEFAULT_CONFIGURATION.fetch('Patterns')
-                               .map(&Regexp.public_method(:new))
-        )
+        extend RuboCop::RSpec::Language::NodePattern
 
         exclude_from_registry
 
@@ -36,39 +15,11 @@ module RuboCop
           RuboCop::Cop::Base.inherited(subclass)
         end
 
-        def relevant_file?(file)
-          relevant_rubocop_rspec_file?(file) && super
-        end
-
-        private
-
-        def relevant_rubocop_rspec_file?(file)
-          rspec_pattern.match?(file)
-        end
-
-        def rspec_pattern
-          if rspec_pattern_config?
-            Regexp.union(rspec_pattern_config.map(&Regexp.public_method(:new)))
-          else
-            DEFAULT_PATTERN_RE
-          end
-        end
-
-        def all_cops_config
-          config
-            .for_all_cops
-        end
-
-        def rspec_pattern_config?
-          return unless all_cops_config.key?('RSpec')
-
-          all_cops_config.fetch('RSpec').key?('Patterns')
-        end
-
-        def rspec_pattern_config
-          all_cops_config
-            .fetch('RSpec', DEFAULT_CONFIGURATION)
-            .fetch('Patterns')
+        # Set the config for dynamic DSL configuration-aware helpers
+        # that have no other means of accessing the configuration.
+        def on_new_investigation
+          super
+          RuboCop::RSpec::Language.config = config['RSpec']['Language']
         end
       end
     end

data/lib/rubocop/cop/rspec/be.rb

@@ -20,10 +20,11 @@ module RuboCop
       #   expect(foo).to be(true)
       #
       class Be < Base
-        MSG = 'Don\'t use `be` without an argument.'
+        MSG = "Don't use `be` without an argument."
 
+        # @!method be_without_args(node)
         def_node_matcher :be_without_args, <<-PATTERN
-          (send _ #{Runners::ALL.node_pattern_union} $(send nil? :be))
+          (send _ #Runners.all $(send nil? :be))
         PATTERN
 
         def on_send(node)

data/lib/rubocop/cop/rspec/be_eql.rb

@@ -39,7 +39,9 @@ module RuboCop
         extend AutoCorrector
 
         MSG = 'Prefer `be` over `eql`.'
+        RESTRICT_ON_SEND = %i[to].freeze
 
+        # @!method eql_type_with_identity(node)
         def_node_matcher :eql_type_with_identity, <<-PATTERN
           (send _ :to $(send nil? :eql {true false int float sym nil_type?}))
         PATTERN

data/lib/rubocop/cop/rspec/before_after_all.rb

@@ -24,11 +24,14 @@ module RuboCop
       #     after(:each) { Widget.delete_all }
       #   end
       class BeforeAfterAll < Base
-        MSG = 'Beware of using `%<hook>s` as it may cause state to leak '\
-              'between tests. If you are using `rspec-rails`, and '\
-              '`use_transactional_fixtures` is enabled, then records created '\
+        MSG = 'Beware of using `%<hook>s` as it may cause state to leak ' \
+              'between tests. If you are using `rspec-rails`, and ' \
+              '`use_transactional_fixtures` is enabled, then records created ' \
               'in `%<hook>s` are not automatically rolled back.'
 
+        RESTRICT_ON_SEND = %i[before after].freeze
+
+        # @!method before_or_after_all(node)
         def_node_matcher :before_or_after_all, <<-PATTERN
           $(send _ {:before :after} (sym {:all :context}))
         PATTERN

data/lib/rubocop/cop/rspec/capybara/current_path_expectation.rb

@@ -30,20 +30,25 @@ module RuboCop
                 'Capybara feature specs - instead, use the ' \
                 '`have_current_path` matcher on `page`'
 
+          RESTRICT_ON_SEND = %i[expect].freeze
+
+          # @!method expectation_set_on_current_path(node)
           def_node_matcher :expectation_set_on_current_path, <<-PATTERN
             (send nil? :expect (send {(send nil? :page) nil?} :current_path))
           PATTERN
 
           # Supported matchers: eq(...) / match(/regexp/) / match('regexp')
+          # @!method as_is_matcher(node)
           def_node_matcher :as_is_matcher, <<-PATTERN
             (send
-              #expectation_set_on_current_path $#{Runners::ALL.node_pattern_union}
+              #expectation_set_on_current_path $#Runners.all
               ${(send nil? :eq ...) (send nil? :match (regexp ...))})
           PATTERN
 
+          # @!method regexp_str_matcher(node)
           def_node_matcher :regexp_str_matcher, <<-PATTERN
             (send
-              #expectation_set_on_current_path $#{Runners::ALL.node_pattern_union}
+              #expectation_set_on_current_path $#Runners.all
               $(send nil? :match (str $_)))
           PATTERN
 

data/lib/rubocop/cop/rspec/capybara/feature_methods.rb

@@ -55,15 +55,19 @@ module RuboCop
             feature:    :describe
           }.freeze
 
-          def_node_matcher :capybara_speak,
-                           SelectorSet.new(MAP.keys).node_pattern_union
+          # @!method capybara_speak(node)
+          def_node_matcher :capybara_speak, <<-PATTERN
+            {#{MAP.keys.map(&:inspect).join(' ')}}
+          PATTERN
 
+          # @!method spec?(node)
           def_node_matcher :spec?, <<-PATTERN
             (block
               (send #rspec? {:describe :feature} ...)
             ...)
           PATTERN
 
+          # @!method feature_method(node)
           def_node_matcher :feature_method, <<-PATTERN
             (block
               $(send #rspec? $#capybara_speak ...)

data/lib/rubocop/cop/rspec/capybara/visibility_matcher.rb

@@ -44,10 +44,14 @@ module RuboCop
             have_content
           ].freeze
 
+          RESTRICT_ON_SEND = CAPYBARA_MATCHER_METHODS
+
+          # @!method visible_true?(node)
           def_node_matcher :visible_true?, <<~PATTERN
             (send nil? #capybara_matcher? ... (hash <$(pair (sym :visible) true) ...>))
           PATTERN
 
+          # @!method visible_false?(node)
           def_node_matcher :visible_false?, <<~PATTERN
             (send nil? #capybara_matcher? ... (hash <$(pair (sym :visible) false) ...>))
           PATTERN

data/lib/rubocop/cop/rspec/context_method.rb

@@ -28,6 +28,7 @@ module RuboCop
 
         MSG = 'Use `describe` for testing methods.'
 
+        # @!method context_method(node)
         def_node_matcher :context_method, <<-PATTERN
           (block (send #rspec? :context $(str #method_name?) ...) ...)
         PATTERN

data/lib/rubocop/cop/rspec/context_wording.rb

@@ -8,6 +8,7 @@ module RuboCop
       # The default list of prefixes is minimal. Users are encouraged to tailor
       # the configuration to meet project needs. Other acceptable prefixes may
       # include `if`, `unless`, `for`, `before`, `after`, or `during`.
+      # They may consist of multiple words if desired.
       #
       # @see https://rspec.rubystyle.guide/#context-descriptions
       # @see http://www.betterspecs.org/#contexts
@@ -37,6 +38,7 @@ module RuboCop
       class ContextWording < Base
         MSG = 'Start context description with %<prefixes>s.'
 
+        # @!method context_wording(node)
         def_node_matcher :context_wording, <<-PATTERN
           (block (send #rspec? { :context :shared_context } $(str #bad_prefix?) ...) ...)
         PATTERN
@@ -51,7 +53,7 @@ module RuboCop
         private
 
         def bad_prefix?(description)
-          !prefixes.include?(description.split(/\b/).first)
+          !prefix_regex.match?(description)
         end
 
         def joined_prefixes
@@ -65,6 +67,10 @@ module RuboCop
         def prefixes
           cop_config['Prefixes'] || []
         end
+
+        def prefix_regex
+          /^#{Regexp.union(prefixes)}\b/
+        end
       end
     end
   end

data/lib/rubocop/cop/rspec/describe_class.rb

@@ -35,19 +35,22 @@ module RuboCop
       #   describe "A feature example", type: :feature do
       #   end
       class DescribeClass < Base
-        include RuboCop::RSpec::TopLevelGroup
+        include TopLevelGroup
 
-        MSG = 'The first argument to describe should be '\
+        MSG = 'The first argument to describe should be ' \
               'the class or module being tested.'
 
+        # @!method example_group_with_ignored_metadata?(node)
         def_node_matcher :example_group_with_ignored_metadata?, <<~PATTERN
           (send #rspec? :describe ... (hash <#ignored_metadata? ...>))
         PATTERN
 
+        # @!method not_a_const_described(node)
         def_node_matcher :not_a_const_described, <<~PATTERN
           (send #rspec? :describe $[!const !#string_constant?] ...)
         PATTERN
 
+        # @!method sym_pair(node)
         def_node_matcher :sym_pair, <<~PATTERN
           (pair $sym $sym)
         PATTERN

data/lib/rubocop/cop/rspec/describe_method.rb

@@ -17,11 +17,12 @@ module RuboCop
       #   describe MyClass, '.my_class_method' do
       #   end
       class DescribeMethod < Base
-        include RuboCop::RSpec::TopLevelGroup
+        include TopLevelGroup
 
-        MSG = 'The second argument to describe should be the method '\
+        MSG = 'The second argument to describe should be the method ' \
               "being tested. '#instance' or '.class'."
 
+        # @!method second_argument(node)
         def_node_matcher :second_argument, <<~PATTERN
           (block
             (send #rspec? :describe _first_argument $(str _) ...) ...

data/lib/rubocop/cop/rspec/describe_symbol.rb

@@ -19,7 +19,9 @@ module RuboCop
       # @see https://github.com/rspec/rspec-core/issues/1610
       class DescribeSymbol < Base
         MSG = 'Avoid describing symbols.'
+        RESTRICT_ON_SEND = %i[describe].freeze
 
+        # @!method describe_symbol?(node)
         def_node_matcher :describe_symbol?, <<-PATTERN
           (send #rspec? :describe $sym ...)
         PATTERN

data/lib/rubocop/cop/rspec/described_class.rb

@@ -61,19 +61,23 @@ module RuboCop
         DESCRIBED_CLASS = 'described_class'
         MSG             = 'Use `%<replacement>s` instead of `%<src>s`.'
 
+        # @!method common_instance_exec_closure?(node)
         def_node_matcher :common_instance_exec_closure?, <<-PATTERN
           (block (send (const nil? {:Class :Module :Struct}) :new ...) ...)
         PATTERN
 
-        def_node_matcher :rspec_block?,
-                         RuboCop::RSpec::Language::ALL.block_pattern
+        # @!method rspec_block?(node)
+        def_node_matcher :rspec_block?, block_pattern('#ALL.all')
 
+        # @!method scope_changing_syntax?(node)
         def_node_matcher :scope_changing_syntax?, '{def class module}'
 
+        # @!method described_constant(node)
         def_node_matcher :described_constant, <<-PATTERN
           (block (send _ :describe $(const ...) ...) (args) $_)
         PATTERN
 
+        # @!method contains_described_class?(node)
         def_node_search :contains_described_class?, <<-PATTERN
           (send nil? :described_class)
         PATTERN