rubocop-rspec 2.2.0 → 2.6.0

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

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RSpec
+      # Checks for excessive whitespace in example descriptions.
+      #
+      # @example
+      #   # bad
+      #   it '  has  excessive   spacing  ' do
+      #   end
+      #
+      #   # good
+      #   it 'has excessive spacing' do
+      #   end
+      #
+      # @example
+      #   # bad
+      #   context '  when a condition   is met  ' do
+      #   end
+      #
+      #   # good
+      #   context 'when a condition is met' do
+      #   end
+      class ExcessiveDocstringSpacing < Base
+        extend AutoCorrector
+
+        MSG = 'Excessive whitespace.'
+
+        # @!method example_description(node)
+        def_node_matcher :example_description, <<-PATTERN
+          (send _ {#Examples.all #ExampleGroups.all} ${
+            $str
+            $(dstr ({str dstr `sym} ...) ...)
+          } ...)
+        PATTERN
+
+        def on_send(node)
+          example_description(node) do |description_node, message|
+            return if description_node.heredoc?
+
+            text = text(message)
+
+            return unless excessive_whitespace?(text)
+
+            add_whitespace_offense(description_node, text)
+          end
+        end
+
+        private
+
+        # @param text [String]
+        def excessive_whitespace?(text)
+          return true if text.start_with?(' ') || text.end_with?(' ')
+
+          text.match?(/[^\n ]  +[^ ]/)
+        end
+
+        # @param text [String]
+        def strip_excessive_whitespace(text)
+          text.strip.gsub(/  +/, ' ')
+        end
+
+        # @param node [RuboCop::AST::Node]
+        # @param text [String]
+        def add_whitespace_offense(node, text)
+          docstring = docstring(node)
+          corrected = strip_excessive_whitespace(text)
+
+          add_offense(docstring) do |corrector|
+            corrector.replace(docstring, corrected)
+          end
+        end
+
+        def docstring(node)
+          expr = node.loc.expression
+
+          Parser::Source::Range.new(
+            expr.source_buffer,
+            expr.begin_pos + 1,
+            expr.end_pos - 1
+          )
+        end
+
+        # Recursive processing is required to process nested dstr nodes
+        # that is the case for \-separated multiline strings with interpolation.
+        def text(node)
+          case node.type
+          when :dstr
+            node.node_parts.map { |child_node| text(child_node) }.join
+          when :str, :sym
+            node.value
+          when :begin
+            node.source
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -45,6 +45,7 @@ module RuboCop
 
         SUPPORTED_MATCHERS = %i[eq eql equal be].freeze
 
+        # @!method expect_literal(node)
         def_node_matcher :expect_literal, <<~PATTERN
           (send
             (send nil? :expect $#literal?)

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

@@ -37,10 +37,12 @@ module RuboCop
         MSG_CALL = 'Prefer `change { %<obj>s.%<attr>s }`.'
         RESTRICT_ON_SEND = %i[change].freeze
 
+        # @!method expect_change_with_arguments(node)
         def_node_matcher :expect_change_with_arguments, <<-PATTERN
-          (send nil? :change ({const send} nil? $_) (sym $_))
+          (send nil? :change $_ (sym $_))
         PATTERN
 
+        # @!method expect_change_with_block(node)
         def_node_matcher :expect_change_with_block, <<-PATTERN
           (block
             (send nil? :change)
@@ -53,9 +55,9 @@ module RuboCop
           return unless style == :block
 
           expect_change_with_arguments(node) do |receiver, message|
-            msg = format(MSG_CALL, obj: receiver, attr: message)
+            msg = format(MSG_CALL, obj: receiver.source, attr: message)
             add_offense(node, message: msg) do |corrector|
-              replacement = "change { #{receiver}.#{message} }"
+              replacement = "change { #{receiver.source}.#{message} }"
               corrector.replace(node, replacement)
             end
           end

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

@@ -23,6 +23,7 @@ module RuboCop
       class ExpectInHook < Base
         MSG = 'Do not use `%<expect>s` in `%<hook>s` hook'
 
+        # @!method expectation(node)
         def_node_search :expectation, send_pattern('#Expectations.all')
 
         def on_block(node)

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

@@ -32,6 +32,7 @@ module RuboCop
           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)
@@ -40,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

@@ -27,6 +27,7 @@ module RuboCop
           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,28 +61,30 @@ 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)
-          pattern = pattern_for(described_class, arguments.first)
+        def ensure_correct_file_path(send_node, example_group, arguments)
+          pattern = pattern_for(example_group, arguments.first)
           return if filename_ends_with?(pattern)
 
           # For the suffix shown in the offense message, modify the regular
@@ -97,11 +99,13 @@ module RuboCop
           args.any?(&method(:routing_metadata?))
         end
 
-        def pattern_for(described_class, method_name)
-          return pattern_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),
+            expected_path(example_group),
             name_pattern(method_name),
             '[^/]*_spec\.rb'
           ].join

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

@@ -25,6 +25,7 @@ module RuboCop
 
         MSG = 'Focused spec found.'
 
+        # @!method focusable_selector?(node)
         def_node_matcher :focusable_selector?, <<-PATTERN
           {
             #ExampleGroups.regular
@@ -35,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}

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

@@ -32,7 +32,7 @@ module RuboCop
       #     # ...
       #   end
       #
-      #   # good
+      #   # bad
       #   before do
       #     # ...
       #   end
@@ -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

@@ -20,6 +20,7 @@ module RuboCop
         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)
@@ -27,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 }
@@ -33,6 +49,7 @@ module RuboCop
         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

@@ -24,6 +24,7 @@ module RuboCop
         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

@@ -26,6 +26,7 @@ module RuboCop
               '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

@@ -19,6 +19,7 @@ module RuboCop
         MSG = 'Prefer using the `all` matcher instead ' \
               '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
@@ -46,6 +48,8 @@ module RuboCop
         end
 
         def only_expectations?(body, arg)
+          return false unless body.each_child_node.any?
+
           body.each_child_node.all? { |child| expectation?(child, arg) }
         end
       end

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)

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

@@ -32,10 +32,12 @@ module RuboCop
         SUPPORTED_STYLES = %w[allow expect].freeze
         RESTRICT_ON_SEND = %i[to].freeze
 
+        # @!method message_expectation(node)
         def_node_matcher :message_expectation, <<-PATTERN
           (send $(send nil? {:expect :allow} ...) :to #receive_message?)
         PATTERN
 
+        # @!method receive_message?(node)
         def_node_search :receive_message?, '(send nil? :receive ...)'
 
         def on_send(node)

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

@@ -35,10 +35,12 @@ module RuboCop
 
         SUPPORTED_STYLES = %w[have_received receive].freeze
 
+        # @!method message_expectation(node)
         def_node_matcher :message_expectation, %(
           (send (send nil? :expect $_) #Runners.all ...)
         )
 
+        # @!method receive_message(node)
         def_node_search :receive_message, %(
           $(send nil? {:receive :have_received} ...)
         )

data/lib/rubocop/cop/rspec/mixin/variable.rb

@@ -10,6 +10,7 @@ module RuboCop
         Subjects = RuboCop::RSpec::Language::Subjects
         Helpers = RuboCop::RSpec::Language::Helpers
 
+        # @!method variable_definition?(node)
         def_node_matcher :variable_definition?, <<~PATTERN
           (send nil? {#Subjects.all #Helpers.all}
             $({sym str dsym dstr} ...) ...)

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

@@ -53,6 +53,7 @@ module RuboCop
         ANYTHING = ->(_node) { true }
         TRUE = ->(node) { node.true_type? }
 
+        # @!method aggregate_failures?(node)
         def_node_matcher :aggregate_failures?, <<-PATTERN
           (block {
               (send _ _ <(sym :aggregate_failures) ...>)
@@ -60,7 +61,9 @@ module RuboCop
             } ...)
         PATTERN
 
+        # @!method expect?(node)
         def_node_matcher :expect?, send_pattern('#Expectations.all')
+        # @!method aggregate_failures_block?(node)
         def_node_matcher :aggregate_failures_block?, <<-PATTERN
           (block (send nil? :aggregate_failures ...) ...)
         PATTERN

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

@@ -44,12 +44,15 @@ module RuboCop
       class NamedSubject < Base
         MSG = 'Name your test subject if you need to reference it explicitly.'
 
+        # @!method example_or_hook_block?(node)
         def_node_matcher :example_or_hook_block?,
                          block_pattern('{#Examples.all #Hooks.all}')
 
+        # @!method shared_example?(node)
         def_node_matcher :shared_example?,
                          block_pattern('#SharedGroups.examples')
 
+        # @!method subject_usage(node)
         def_node_search :subject_usage, '$(send nil? :subject)'
 
         def on_block(node)

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

@@ -6,7 +6,7 @@ module RuboCop
       # Checks for nested example groups.
       #
       # This cop is configurable using the `Max` option
-      # and supports `--auto-gen-config
+      # and supports `--auto-gen-config`.
       #
       # @example
       #   # bad

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

@@ -22,6 +22,7 @@ module RuboCop
         MSG = 'Prefer `%<replacement>s` over `%<original>s`.'
         RESTRICT_ON_SEND = %i[not_to to_not].freeze
 
+        # @!method not_to_not_offense(node)
         def_node_matcher :not_to_not_offense, '(send _ % ...)'
 
         def on_send(node)

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

@@ -24,8 +24,10 @@ module RuboCop
       class OverwritingSetup < Base
         MSG = '`%<name>s` is already defined.'
 
+        # @!method setup?(node)
         def_node_matcher :setup?, block_pattern('{#Helpers.all #Subjects.all}')
 
+        # @!method first_argument_name(node)
         def_node_matcher :first_argument_name, '(send _ _ ({str sym} $_))'
 
         def on_block(node)

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

@@ -34,11 +34,13 @@ module RuboCop
       class Pending < Base
         MSG = 'Pending spec found.'
 
+        # @!method skippable?(node)
         def_node_matcher :skippable?,
                          send_pattern(<<~PATTERN)
                            {#ExampleGroups.regular #Examples.regular}
                          PATTERN
 
+        # @!method skipped_in_metadata?(node)
         def_node_matcher :skipped_in_metadata?, <<-PATTERN
           {
             (send _ _ <#skip_or_pending? ...>)
@@ -46,8 +48,10 @@ module RuboCop
           }
         PATTERN
 
+        # @!method skip_or_pending?(node)
         def_node_matcher :skip_or_pending?, '{(sym :skip) (sym :pending)}'
 
+        # @!method pending_block?(node)
         def_node_matcher :pending_block?,
                          send_pattern(<<~PATTERN)
                            {