rubocop-rspec 2.0.0 → 2.4.0

data/lib/rubocop/cop/rspec/factory_bot/attribute_defined_statically.rb

@@ -29,10 +29,12 @@ module RuboCop
 
           MSG = 'Use a block to declare attribute values.'
 
+          # @!method value_matcher(node)
           def_node_matcher :value_matcher, <<-PATTERN
             (send _ !#reserved_method? $...)
           PATTERN
 
+          # @!method factory_attributes(node)
           def_node_matcher :factory_attributes, <<-PATTERN
             (block (send _ #attribute_defining_method? ...) _ { (begin $...) $(send ...) } )
           PATTERN
@@ -79,6 +81,7 @@ module RuboCop
             value_matcher(attribute).to_a.all?(&:block_pass_type?)
           end
 
+          # @!method association?(node)
           def_node_matcher :association?, '(hash <(pair (sym :factory) _) ...>)'
 
           def autocorrect_replacing_parens(corrector, node)

data/lib/rubocop/cop/rspec/factory_bot/create_list.rb

@@ -30,7 +30,9 @@ module RuboCop
 
           MSG_CREATE_LIST = 'Prefer create_list.'
           MSG_N_TIMES = 'Prefer %<number>s.times.'
+          RESTRICT_ON_SEND = %i[create_list].freeze
 
+          # @!method n_times_block_without_arg?(node)
           def_node_matcher :n_times_block_without_arg?, <<-PATTERN
             (block
               (send (int _) :times)
@@ -39,10 +41,12 @@ module RuboCop
             )
           PATTERN
 
+          # @!method factory_call(node)
           def_node_matcher :factory_call, <<-PATTERN
             (send ${(const nil? {:FactoryGirl :FactoryBot}) nil?} :create (sym $_) $...)
           PATTERN
 
+          # @!method factory_list_call(node)
           def_node_matcher :factory_list_call, <<-PATTERN
             (send {(const nil? {:FactoryGirl :FactoryBot}) nil?} :create_list (sym _) (int $_) ...)
           PATTERN

data/lib/rubocop/cop/rspec/factory_bot/factory_class_name.rb

@@ -25,7 +25,9 @@ module RuboCop
           MSG = "Pass '%<class_name>s' string instead of `%<class_name>s` " \
                 'constant.'
           ALLOWED_CONSTANTS = %w[Hash OpenStruct].freeze
+          RESTRICT_ON_SEND = %i[factory].freeze
 
+          # @!method class_name(node)
           def_node_matcher :class_name, <<~PATTERN
             (send _ :factory _ (hash <(pair (sym :class) $(const ...)) ...>))
           PATTERN

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

@@ -61,51 +61,64 @@ module RuboCop
 
         MSG = 'Spec path should end with `%<suffix>s`.'
 
-        def_node_matcher :const_described, <<~PATTERN
+        # @!method example_group(node)
+        def_node_matcher :example_group, <<~PATTERN
           (block
-            $(send #rspec? _example_group $(const ...) $...) ...
+            $(send #rspec? _example_group $_ $...) ...
           )
         PATTERN
 
+        # @!method routing_metadata?(node)
         def_node_search :routing_metadata?, '(pair (sym :type) (sym :routing))'
 
         def on_top_level_example_group(node)
           return unless top_level_groups.one?
 
-          const_described(node) do |send_node, described_class, arguments|
+          example_group(node) do |send_node, example_group, arguments|
             next if routing_spec?(arguments)
 
-            ensure_correct_file_path(send_node, described_class, arguments)
+            ensure_correct_file_path(send_node, example_group, arguments)
           end
         end
 
         private
 
-        def ensure_correct_file_path(send_node, described_class, arguments)
-          glob = glob_for(described_class, arguments.first)
-          return if filename_ends_with?(glob)
+        def ensure_correct_file_path(send_node, example_group, arguments)
+          pattern = pattern_for(example_group, arguments.first)
+          return if filename_ends_with?(pattern)
 
-          add_offense(send_node, message: format(MSG, suffix: glob))
+          # For the suffix shown in the offense message, modify the regular
+          # expression pattern to resemble a glob pattern for clearer error
+          # messages.
+          offense_suffix = pattern.gsub('.*', '*').sub('[^/]', '')
+            .sub('\.', '.')
+          add_offense(send_node, message: format(MSG, suffix: offense_suffix))
         end
 
         def routing_spec?(args)
           args.any?(&method(:routing_metadata?))
         end
 
-        def glob_for(described_class, method_name)
-          return glob_for_spec_suffix_only? if spec_suffix_only?
+        def pattern_for(example_group, method_name)
+          if spec_suffix_only? || !example_group.const_type?
+            return pattern_for_spec_suffix_only?
+          end
 
-          "#{expected_path(described_class)}#{name_glob(method_name)}*_spec.rb"
+          [
+            expected_path(example_group),
+            name_pattern(method_name),
+            '[^/]*_spec\.rb'
+          ].join
         end
 
-        def glob_for_spec_suffix_only?
-          '*_spec.rb'
+        def pattern_for_spec_suffix_only?
+          '.*_spec\.rb'
         end
 
-        def name_glob(method_name)
+        def name_pattern(method_name)
           return unless method_name&.str_type?
 
-          "*#{method_name.str_content.gsub(/\W/, '')}" unless ignore_methods?
+          ".*#{method_name.str_content.gsub(/\W/, '')}" unless ignore_methods?
         end
 
         def expected_path(constant)
@@ -131,11 +144,9 @@ module RuboCop
           cop_config['IgnoreMethods']
         end
 
-        def filename_ends_with?(glob)
-          filename =
-            RuboCop::PathUtil.relative_path(processed_source.buffer.name)
-              .gsub('../', '')
-          File.fnmatch?("*#{glob}", filename)
+        def filename_ends_with?(pattern)
+          filename = File.expand_path(processed_source.buffer.name)
+          filename.match?("#{pattern}$")
         end
 
         def relevant_rubocop_rspec_file?(_file)

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

@@ -20,8 +20,12 @@ module RuboCop
       #   describe MyClass do
       #   end
       class Focus < Base
+        extend AutoCorrector
+        include RangeHelp
+
         MSG = 'Focused spec found.'
 
+        # @!method focusable_selector?(node)
         def_node_matcher :focusable_selector?, <<-PATTERN
           {
             #ExampleGroups.regular
@@ -32,11 +36,13 @@ module RuboCop
           }
         PATTERN
 
+        # @!method metadata(node)
         def_node_matcher :metadata, <<-PATTERN
           {(send #rspec? #focusable_selector? <$(sym :focus) ...>)
            (send #rspec? #focusable_selector? ... (hash <$(pair (sym :focus) true) ...>))}
         PATTERN
 
+        # @!method focused_block?(node)
         def_node_matcher :focused_block?,
                          send_pattern(<<~PATTERN)
                            {#ExampleGroups.focused #Examples.focused}
@@ -44,7 +50,13 @@ module RuboCop
 
         def on_send(node)
           focus_metadata(node) do |focus|
-            add_offense(focus)
+            add_offense(focus) do |corrector|
+              if focus.pair_type? || focus.str_type? || focus.sym_type?
+                corrector.remove(with_surrounding(focus))
+              elsif focus.send_type?
+                correct_send(corrector, focus)
+              end
+            end
           end
         end
 
@@ -55,6 +67,26 @@ module RuboCop
 
           metadata(node, &block)
         end
+
+        def with_surrounding(focus)
+          range_with_space = range_with_surrounding_space(
+            range: focus.loc.expression,
+            side: :left
+          )
+
+          range_with_surrounding_comma(range_with_space, :left)
+        end
+
+        def correct_send(corrector, focus)
+          range = focus.loc.selector
+          unfocused = focus.method_name.to_s.sub(/^f/, '')
+          unless Examples.regular(unfocused) || ExampleGroups.regular(unfocused)
+            return
+          end
+
+          corrector.replace(range,
+                            range.source.sub(focus.method_name.to_s, unfocused))
+        end
       end
     end
   end

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

@@ -64,10 +64,12 @@ module RuboCop
         IMPLICIT_MSG = 'Omit the default `%<scope>p` argument for RSpec hooks.'
         EXPLICIT_MSG = 'Use `%<scope>p` for RSpec hooks.'
 
+        # @!method scoped_hook(node)
         def_node_matcher :scoped_hook, <<-PATTERN
           (block $(send _ #Hooks.all (sym ${:each :example})) ...)
         PATTERN
 
+        # @!method unscoped_hook(node)
         def_node_matcher :unscoped_hook, '(block $(send _ #Hooks.all) ...)'
 
         def on_block(node)

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

@@ -28,6 +28,7 @@ module RuboCop
 
         MSG = 'Move `%<hook>s` above the examples in the group.'
 
+        # @!method example_or_group?(node)
         def_node_matcher :example_or_group?, <<-PATTERN
           {
             #{block_pattern('{#ExampleGroups.all #Examples.all}')}

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

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RSpec
+      # Checks for equality assertions with identical expressions on both sides.
+      #
+      # @example
+      #
+      #   # bad
+      #   expect(foo.bar).to eq(foo.bar)
+      #   expect(foo.bar).to eql(foo.bar)
+      #
+      #   # good
+      #   expect(foo.bar).to eq(2)
+      #   expect(foo.bar).to eql(2)
+      #
+      class IdenticalEqualityAssertion < Base
+        MSG = 'Identical expressions on both sides of the equality ' \
+              'may indicate a flawed test.'
+        RESTRICT_ON_SEND = %i[to].freeze
+
+        # @!method equality_check?(node)
+        def_node_matcher :equality_check?, <<~PATTERN
+          (send (send nil? :expect $_) :to
+            {(send nil? {:eql :eq :be} $_)
+             (send (send nil? :be) :== $_)})
+        PATTERN
+
+        def on_send(node)
+          equality_check?(node) do |left, right|
+            add_offense(node) if left == right
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -18,7 +18,9 @@ module RuboCop
       #   end
       class ImplicitBlockExpectation < Base
         MSG = 'Avoid implicit block expectations.'
+        RESTRICT_ON_SEND = %i[is_expected should should_not].freeze
 
+        # @!method lambda?(node)
         def_node_matcher :lambda?, <<-PATTERN
           {
             (send (const nil? :Proc) :new)
@@ -26,8 +28,10 @@ module RuboCop
           }
         PATTERN
 
+        # @!method lambda_subject?(node)
         def_node_matcher :lambda_subject?, '(block #lambda? ...)'
 
+        # @!method implicit_expect(node)
         def_node_matcher :implicit_expect, <<-PATTERN
           $(send nil? {:is_expected :should :should_not} ...)
         PATTERN

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

@@ -30,6 +30,7 @@ module RuboCop
 
         MSG = 'Prefer `%<good>s` over `%<bad>s`.'
 
+        # @!method implicit_expect(node)
         def_node_matcher :implicit_expect, <<-PATTERN
           {
             (send nil? ${:should :should_not} ...)

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

@@ -7,7 +7,7 @@ module RuboCop
       #
       # This cop can be configured using the `EnforcedStyle` option
       #
-      # @example `EnforcedStyle: single_line_only`
+      # @example `EnforcedStyle: single_line_only` (default)
       #   # bad
       #   it do
       #     is_expected.to be_truthy
@@ -19,6 +19,22 @@ module RuboCop
       #     expect(subject).to be_truthy
       #   end
       #
+      # @example `EnforcedStyle: single_statement_only`
+      #   # bad
+      #   it do
+      #     foo = 1
+      #     is_expected.to be_truthy
+      #   end
+      #
+      #   # good
+      #   it do
+      #     foo = 1
+      #     expect(subject).to be_truthy
+      #   end
+      #   it do
+      #     is_expected.to be_truthy
+      #   end
+      #
       # @example `EnforcedStyle: disallow`
       #   # bad
       #   it { is_expected.to be_truthy }
@@ -31,7 +47,9 @@ module RuboCop
         include ConfigurableEnforcedStyle
 
         MSG = "Don't use implicit subject."
+        RESTRICT_ON_SEND = %i[is_expected should should_not].freeze
 
+        # @!method implicit_subject?(node)
         def_node_matcher :implicit_subject?, <<-PATTERN
           (send nil? {:should :should_not :is_expected} ...)
         PATTERN

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

@@ -21,9 +21,10 @@ module RuboCop
       class InstanceSpy < Base
         extend AutoCorrector
 
-        MSG = 'Use `instance_spy` when you check your double '\
+        MSG = 'Use `instance_spy` when you check your double ' \
               'with `have_received`.'
 
+        # @!method null_double(node)
         def_node_search :null_double, <<-PATTERN
           (lvasgn $_
             (send
@@ -31,6 +32,7 @@ module RuboCop
                 ...) :as_null_object))
         PATTERN
 
+        # @!method have_received_usage(node)
         def_node_search :have_received_usage, <<-PATTERN
           (send
             (send nil? :expect

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

@@ -52,10 +52,12 @@ module RuboCop
         MSG = 'Avoid instance variables – use let, ' \
               'a method call, or a local variable (if possible).'
 
+        # @!method dynamic_class?(node)
         def_node_matcher :dynamic_class?, <<-PATTERN
           (block (send (const nil? :Class) :new ...) ...)
         PATTERN
 
+        # @!method custom_matcher?(node)
         def_node_matcher :custom_matcher?, <<-PATTERN
           (block {
             (send nil? :matcher sym)
@@ -63,8 +65,10 @@ module RuboCop
           } ...)
         PATTERN
 
+        # @!method ivar_usage(node)
         def_node_search :ivar_usage, '$(ivar $_)'
 
+        # @!method ivar_assigned?(node)
         def_node_search :ivar_assigned?, '(ivasgn % ...)'
 
         def on_top_level_group(node)

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

@@ -22,9 +22,11 @@ module RuboCop
         extend AutoCorrector
         include ConfigurableEnforcedStyle
 
-        MSG = 'Prefer `%<replacement>s` over `%<original>s` when including '\
+        MSG = 'Prefer `%<replacement>s` over `%<original>s` when including ' \
               'examples in a nested context.'
+        RESTRICT_ON_SEND = %i[it_behaves_like it_should_behave_like].freeze
 
+        # @!method example_inclusion_offense(node)
         def_node_matcher :example_inclusion_offense, '(send _ % ...)'
 
         def on_send(node)

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

@@ -17,8 +17,9 @@ module RuboCop
       #   end
       class IteratedExpectation < Base
         MSG = 'Prefer using the `all` matcher instead ' \
-                  'of iterating over an array.'
+              'of iterating over an array.'
 
+        # @!method each?(node)
         def_node_matcher :each?, <<-PATTERN
           (block
             (send ... :each)
@@ -27,6 +28,7 @@ module RuboCop
           )
         PATTERN
 
+        # @!method expectation?(node)
         def_node_matcher :expectation?, <<-PATTERN
           (send (send nil? :expect (lvar %)) :to ...)
         PATTERN

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

@@ -35,6 +35,7 @@ module RuboCop
 
         MSG = 'Move `let` before the examples in the group.'
 
+        # @!method example_or_group?(node)
         def_node_matcher :example_or_group?, <<-PATTERN
           {
             #{block_pattern('{#ExampleGroups.all #Examples.all}')}

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

@@ -28,6 +28,7 @@ module RuboCop
       class LetSetup < Base
         MSG = 'Do not use `let!` to setup objects not referenced in tests.'
 
+        # @!method example_or_shared_group_or_including?(node)
         def_node_matcher :example_or_shared_group_or_including?,
                          block_pattern(<<~PATTERN)
                            {
@@ -37,6 +38,7 @@ module RuboCop
                            }
                          PATTERN
 
+        # @!method let_bang(node)
         def_node_matcher :let_bang, <<-PATTERN
           {
             (block $(send nil? :let! {(sym $_) (str $_)}) ...)
@@ -44,6 +46,7 @@ module RuboCop
           }
         PATTERN
 
+        # @!method method_called?(node)
         def_node_search :method_called?, '(send nil? %)'
 
         def on_block(node)