rubocop-rspec 1.42.0 → 1.44.1

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

@@ -14,20 +14,17 @@ module RuboCop
       #   subject(:obj) { described_class }
       #
       #   let(:foo) { bar }
-      class EmptyLineAfterSubject < Cop
+      class EmptyLineAfterSubject < Base
         extend AutoCorrector
-        include RuboCop::RSpec::BlankLineSeparation
+        include RuboCop::RSpec::EmptyLineSeparation
 
-        MSG = 'Add empty line after `subject`.'
+        MSG = 'Add an empty line after `%<subject>s`.'
 
         def on_block(node)
           return unless subject?(node) && !in_spec_block?(node)
-          return if last_child?(node)
 
-          missing_separating_line(node) do |location|
-            add_offense(location) do |corrector|
-              corrector.insert_after(location.end, "\n")
-            end
+          missing_separating_line_offense(node) do |method|
+            format(MSG, subject: method)
           end
         end
 

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

@@ -25,7 +25,7 @@ module RuboCop
       #     result = service.call
       #     expect(result).to be(true)
       #   end
-      class ExampleLength < Cop
+      class ExampleLength < Base
         include CodeLength
 
         MSG = 'Example has too many lines [%<total>d/%<max>d].'

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

@@ -47,7 +47,7 @@ module RuboCop
       #     result = service.call
       #     expect(result).to be(true)
       #   end
-      class ExampleWithoutDescription < Cop
+      class ExampleWithoutDescription < Base
         include ConfigurableEnforcedStyle
 
         MSG_DEFAULT_ARGUMENT = 'Omit the argument when you want to ' \

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

@@ -29,7 +29,7 @@ module RuboCop
       #   # good
       #   it 'does things' do
       #   end
-      class ExampleWording < Cop
+      class ExampleWording < Base
         extend AutoCorrector
 
         MSG_SHOULD = 'Do not use should when describing your tests.'
@@ -47,9 +47,9 @@ module RuboCop
 
         def on_block(node)
           it_description(node) do |description_node, message|
-            if message =~ SHOULD_PREFIX
+            if message.match?(SHOULD_PREFIX)
               add_wording_offense(description_node, MSG_SHOULD)
-            elsif message =~ IT_PREFIX
+            elsif message.match?(IT_PREFIX)
               add_wording_offense(description_node, MSG_IT)
             end
           end
@@ -77,7 +77,7 @@ module RuboCop
         def replacement_text(node)
           text = text(node)
 
-          if text =~ SHOULD_PREFIX
+          if text.match?(SHOULD_PREFIX)
             RuboCop::RSpec::Wording.new(
               text,
               ignore:  ignored_words,

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

@@ -16,7 +16,7 @@ module RuboCop
       #   expect(pattern).to eq(/foo/)
       #   expect(name).to eq("John")
       #
-      class ExpectActual < Cop
+      class ExpectActual < Base
         extend AutoCorrector
 
         MSG = 'Provide the actual you are testing to `expect(...)`.'

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

@@ -29,7 +29,7 @@ module RuboCop
       #   expect { run }.to change { Foo.bar(:count) }
       #   expect { run }.to change { user.reload.name }
       #
-      class ExpectChange < Cop
+      class ExpectChange < Base
         extend AutoCorrector
         include ConfigurableEnforcedStyle
 

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

@@ -20,7 +20,7 @@ module RuboCop
       #   it do
       #     expect(something).to eq 'foo'
       #   end
-      class ExpectInHook < Cop
+      class ExpectInHook < Base
         MSG = 'Do not use `%<expect>s` in `%<hook>s` hook'
 
         def_node_search :expectation, Expectations::ALL.send_pattern

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

@@ -14,7 +14,7 @@ module RuboCop
       #
       #   # good
       #   expect { my_app.print_report }.to output('Hello World').to_stdout
-      class ExpectOutput < Cop
+      class ExpectOutput < Base
         MSG = 'Use `expect { ... }.to output(...).to_%<name>s` '\
               'instead of mutating $%<name>s.'
 

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

@@ -24,7 +24,7 @@ module RuboCop
         #
         #   # good
         #   count { 1 }
-        class AttributeDefinedStatically < Cop
+        class AttributeDefinedStatically < Base
           extend AutoCorrector
 
           MSG = 'Use a block to declare attribute values.'
@@ -39,7 +39,7 @@ module RuboCop
 
           def on_block(node)
             attributes = factory_attributes(node) || []
-            attributes = [attributes] unless attributes.is_a?(Array)
+            attributes = [attributes] unless attributes.is_a?(Array) # rubocop:disable Style/ArrayCoercion, Lint/RedundantCopDisableDirective
 
             attributes.each do |attribute|
               next unless offensive_receiver?(attribute.receiver, node)
@@ -84,7 +84,7 @@ module RuboCop
           def autocorrect_replacing_parens(corrector, node)
             left_braces, right_braces = braces(node)
 
-            corrector.replace(node.location.begin, ' ' + left_braces)
+            corrector.replace(node.location.begin, " #{left_braces}")
             corrector.replace(node.location.end, right_braces)
           end
 

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

@@ -24,7 +24,7 @@ module RuboCop
         #
         #   # good
         #   3.times { create :user }
-        class CreateList < Cop
+        class CreateList < Base
           extend AutoCorrector
           include ConfigurableEnforcedStyle
 
@@ -44,7 +44,7 @@ module RuboCop
           PATTERN
 
           def_node_matcher :factory_list_call, <<-PATTERN
-            (send ${(const nil? {:FactoryGirl :FactoryBot}) nil?} :create_list (sym $_) (int $_) $...)
+            (send {(const nil? {:FactoryGirl :FactoryBot}) nil?} :create_list (sym _) (int $_) ...)
           PATTERN
 
           def on_block(node)
@@ -60,7 +60,7 @@ module RuboCop
           def on_send(node)
             return unless style == :n_times
 
-            factory_list_call(node) do |_receiver, _factory, count, _|
+            factory_list_call(node) do |count|
               message = format(MSG_N_TIMES, number: count)
               add_offense(node.loc.selector, message: message) do |corrector|
                 TimesCorrector.new(node).call(corrector)
@@ -79,7 +79,7 @@ module RuboCop
           end
 
           # :nodoc
-          class Corrector
+          module Corrector
             private
 
             def build_options_string(options)
@@ -102,7 +102,9 @@ module RuboCop
           end
 
           # :nodoc
-          class TimesCorrector < Corrector
+          class TimesCorrector
+            include Corrector
+
             def initialize(node)
               @node = node
             end
@@ -130,7 +132,9 @@ module RuboCop
           end
 
           # :nodoc:
-          class CreateListCorrector < Corrector
+          class CreateListCorrector
+            include Corrector
+
             def initialize(node)
               @node = node.parent
             end

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

@@ -19,7 +19,7 @@ module RuboCop
         #   # good
         #   factory :foo, class: 'Foo' do
         #   end
-        class FactoryClassName < Cop
+        class FactoryClassName < Base
           extend AutoCorrector
 
           MSG = "Pass '%<class_name>s' string instead of `%<class_name>s` " \

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

@@ -56,35 +56,43 @@ module RuboCop
       #   # good
       #   my_class_spec.rb         # describe MyClass, '#method'
       #
-      class FilePath < Cop
-        include RuboCop::RSpec::TopLevelDescribe
+      class FilePath < Base
+        include RuboCop::RSpec::TopLevelGroup
 
         MSG = 'Spec path should end with `%<suffix>s`.'
 
-        def_node_search :const_described?,  '(send _ :describe (const ...) ...)'
+        def_node_matcher :const_described, <<~PATTERN
+          (block
+            $(send #rspec? _example_group $(const ...) $...) ...
+          )
+        PATTERN
+
         def_node_search :routing_metadata?, '(pair (sym :type) (sym :routing))'
 
-        def on_top_level_describe(node, args)
-          return unless const_described?(node) && single_top_level_describe?
-          return if routing_spec?(args)
+        def on_top_level_example_group(node)
+          return unless top_level_groups.one?
 
-          glob = glob_for(args)
+          const_described(node) do |send_node, described_class, arguments|
+            next if routing_spec?(arguments)
 
-          return if filename_ends_with?(glob)
-
-          add_offense(
-            node,
-            message: format(MSG, suffix: glob)
-          )
+            ensure_correct_file_path(send_node, described_class, 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)
+
+          add_offense(send_node, message: format(MSG, suffix: glob))
+        end
+
         def routing_spec?(args)
           args.any?(&method(:routing_metadata?))
         end
 
-        def glob_for((described_class, method_name))
+        def glob_for(described_class, method_name)
           return glob_for_spec_suffix_only? if spec_suffix_only?
 
           "#{expected_path(described_class)}#{name_glob(method_name)}*_spec.rb"
@@ -94,10 +102,10 @@ module RuboCop
           '*_spec.rb'
         end
 
-        def name_glob(name)
-          return unless name&.str_type?
+        def name_glob(method_name)
+          return unless method_name&.str_type?
 
-          "*#{name.str_content.gsub(/\W/, '')}" unless ignore_methods?
+          "*#{method_name.str_content.gsub(/\W/, '')}" unless ignore_methods?
         end
 
         def expected_path(constant)

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

@@ -19,23 +19,19 @@ module RuboCop
       #   # good
       #   describe MyClass do
       #   end
-      class Focus < Cop
+      class Focus < Base
         MSG = 'Focused spec found.'
 
-        focusable =
-          ExampleGroups::GROUPS  +
-          ExampleGroups::SKIPPED +
-          Examples::EXAMPLES     +
-          Examples::SKIPPED      +
-          Examples::PENDING
-
         focused = ExampleGroups::FOCUSED + Examples::FOCUSED
 
-        FOCUSABLE_SELECTORS = focusable.node_pattern_union
+        def_node_matcher :focusable_selector?,
+                         (ExampleGroups::GROUPS + ExampleGroups::SKIPPED +
+                          Examples::EXAMPLES + Examples::SKIPPED +
+                          Examples::PENDING).node_pattern_union
 
         def_node_matcher :metadata, <<-PATTERN
-          {(send #{RSPEC} #{FOCUSABLE_SELECTORS} <$(sym :focus) ...>)
-           (send #{RSPEC} #{FOCUSABLE_SELECTORS} ... (hash <$(pair (sym :focus) true) ...>))}
+          {(send #rspec? #focusable_selector? <$(sym :focus) ...>)
+           (send #rspec? #focusable_selector? ... (hash <$(pair (sym :focus) true) ...>))}
         PATTERN
 
         def_node_matcher :focused_block?, focused.send_pattern

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

@@ -57,21 +57,20 @@ module RuboCop
       #   before(:example) do
       #     # ...
       #   end
-      class HookArgument < Cop
+      class HookArgument < Base
         extend AutoCorrector
         include ConfigurableEnforcedStyle
 
-        IMPLICIT_MSG = 'Omit the default `%<scope>p` ' \
-                       'argument for RSpec hooks.'
+        IMPLICIT_MSG = 'Omit the default `%<scope>p` argument for RSpec hooks.'
         EXPLICIT_MSG = 'Use `%<scope>p` for RSpec hooks.'
 
-        HOOKS = Hooks::ALL.node_pattern_union.freeze
+        def_node_matcher :hook?, Hooks::ALL.node_pattern_union
 
         def_node_matcher :scoped_hook, <<-PATTERN
-          (block $(send _ #{HOOKS} (sym ${:each :example})) ...)
+          (block $(send _ #hook? (sym ${:each :example})) ...)
         PATTERN
 
-        def_node_matcher :unscoped_hook, "(block $(send _ #{HOOKS}) ...)"
+        def_node_matcher :unscoped_hook, '(block $(send _ #hook?) ...)'
 
         def on_block(node)
           hook(node) do |method_send, scope_name|

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

@@ -23,7 +23,7 @@ module RuboCop
       #     expect(foo).to be
       #   end
       #
-      class HooksBeforeExamples < Cop
+      class HooksBeforeExamples < Base
         extend AutoCorrector
 
         MSG = 'Move `%<hook>s` above the examples in the group.'

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

@@ -16,14 +16,13 @@ module RuboCop
       #   it 'changes something to a new value' do
       #     expect { do_something }.to change(something).to(new_value)
       #   end
-      class ImplicitBlockExpectation < Cop
+      class ImplicitBlockExpectation < Base
         MSG = 'Avoid implicit block expectations.'
 
         def_node_matcher :lambda?, <<-PATTERN
           {
             (send (const nil? :Proc) :new)
-            (send nil? :proc)
-            (send nil? :lambda)
+            (send nil? {:proc :lambda})
           }
         PATTERN
 

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

@@ -24,7 +24,7 @@ module RuboCop
       #   # good
       #   it { should be_truthy }
       #
-      class ImplicitExpect < Cop
+      class ImplicitExpect < Base
         extend AutoCorrector
         include ConfigurableEnforcedStyle
 

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

@@ -26,7 +26,7 @@ module RuboCop
       #   # good
       #   it { expect(subject).to be_truthy }
       #
-      class ImplicitSubject < Cop
+      class ImplicitSubject < Base
         extend AutoCorrector
         include ConfigurableEnforcedStyle
 
@@ -49,9 +49,10 @@ module RuboCop
 
         def autocorrect(corrector, node)
           replacement = 'expect(subject)'
-          if node.method_name == :should
+          case node.method_name
+          when :should
             replacement += '.to'
-          elsif node.method_name == :should_not
+          when :should_not
             replacement += '.not_to'
           end
 
@@ -62,13 +63,14 @@ module RuboCop
           example = node.ancestors.find { |parent| example?(parent) }
           return false if example.nil?
 
-          example.method_name == :its || allowed_by_style?(example)
+          example.method?(:its) || allowed_by_style?(example)
         end
 
         def allowed_by_style?(example)
-          if style == :single_line_only
+          case style
+          when :single_line_only
             example.single_line?
-          elsif style == :single_statement_only
+          when :single_statement_only
             !example.body.begin_type?
           else
             false

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

@@ -18,7 +18,7 @@ module RuboCop
       #     expect(foo).to have_received(:bar)
       #   end
       #
-      class InstanceSpy < Cop
+      class InstanceSpy < Base
         extend AutoCorrector
 
         MSG = 'Use `instance_spy` when you check your double '\

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

@@ -46,7 +46,7 @@ module RuboCop
       #     it { expect(foo).to be_empty }
       #   end
       #
-      class InstanceVariable < Cop
+      class InstanceVariable < Base
         include RuboCop::RSpec::TopLevelGroup
 
         MSG = 'Avoid instance variables – use let, ' \

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

@@ -15,7 +15,7 @@ module RuboCop
       #
       #   # good
       #   expect(foo).to be_something
-      class InvalidPredicateMatcher < Cop
+      class InvalidPredicateMatcher < Base
         MSG = 'Omit `?` from `%<matcher>s`.'
 
         def_node_matcher :invalid_predicate_matcher?, <<-PATTERN

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

@@ -18,7 +18,7 @@ module RuboCop
       #
       #   # good
       #   it_should_behave_like 'a foo'
-      class ItBehavesLike < Cop
+      class ItBehavesLike < Base
         extend AutoCorrector
         include ConfigurableEnforcedStyle