rubocop-rspec 2.21.0 → 3.0.1

data/config/obsoletion.yml

@@ -21,3 +21,27 @@ renamed:
   RSpec/Capybara/SpecificFinders: Capybara/SpecificFinders
   RSpec/Capybara/SpecificMatcher: Capybara/SpecificMatcher
   RSpec/Capybara/VisibilityMatcher: Capybara/VisibilityMatcher
+  RSpec/FactoryBot/AttributeDefinedStatically: FactoryBot/AttributeDefinedStatically
+  RSpec/FactoryBot/ConsistentParenthesesStyle: FactoryBot/ConsistentParenthesesStyle
+  RSpec/FactoryBot/CreateList: FactoryBot/CreateList
+  RSpec/FactoryBot/FactoryClassName: FactoryBot/FactoryClassName
+  RSpec/FactoryBot/FactoryNameStyle: FactoryBot/FactoryNameStyle
+  RSpec/FactoryBot/SyntaxMethods: FactoryBot/SyntaxMethods
+  RSpec/Rails/AvoidSetupHook: RSpecRails/AvoidSetupHook
+  RSpec/Rails/HaveHttpStatus: RSpecRails/HaveHttpStatus
+  RSpec/Rails/HttpStatus: RSpecRails/HttpStatus
+  RSpec/Rails/InferredSpecType: RSpecRails/InferredSpecType
+  RSpec/Rails/MinitestAssertions: RSpecRails/MinitestAssertions
+  RSpec/Rails/NegationBeValid: RSpecRails/NegationBeValid
+  RSpec/Rails/TravelAround: RSpecRails/TravelAround
+
+split:
+  RSpec/FilePath:
+    alternatives:
+      - RSpec/SpecFilePathFormat
+      - RSpec/SpecFilePathSuffix
+
+removed:
+  RSpec/Capybara/FeatureMethods:
+    reason: >
+      this cop has migrated to `RSpec/Dialect`. Please use `RSpec/Dialect` instead

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

@@ -32,17 +32,17 @@ module RuboCop
                          'or `%<arg>s.run`.'
 
         # @!method hook_block(node)
-        def_node_matcher :hook_block, <<-PATTERN
+        def_node_matcher :hook_block, <<~PATTERN
           (block (send nil? :around sym ?) (args $...) ...)
         PATTERN
 
         # @!method hook_numblock(node)
-        def_node_matcher :hook_numblock, <<-PATTERN
+        def_node_matcher :hook_numblock, <<~PATTERN
           (numblock (send nil? :around sym ?) ...)
         PATTERN
 
         # @!method find_arg_usage(node)
-        def_node_search :find_arg_usage, <<-PATTERN
+        def_node_search :find_arg_usage, <<~PATTERN
           {(send $... {:call :run}) (send _ _ $...) (yield $...) (block-pass $...)}
         PATTERN
 

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

@@ -6,7 +6,6 @@ module RuboCop
       # @abstract parent class to RSpec cops
       class Base < ::RuboCop::Cop::Base
         include RuboCop::RSpec::Language
-        extend RuboCop::RSpec::Language::NodePattern
 
         exclude_from_registry
 

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

@@ -24,7 +24,7 @@ module RuboCop
         RESTRICT_ON_SEND = Runners.all
 
         # @!method be_without_args(node)
-        def_node_matcher :be_without_args, <<-PATTERN
+        def_node_matcher :be_without_args, <<~PATTERN
           (send _ #Runners.all $(send nil? :be))
         PATTERN
 

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

@@ -28,6 +28,7 @@ module RuboCop
               (send nil? :match_array (array))
               (send nil? :contain_exactly)
             }
+            _?
           )
         PATTERN
 

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

@@ -30,7 +30,7 @@ module RuboCop
         RESTRICT_ON_SEND = %i[eq].freeze
 
         # @!method eq_type_with_identity?(node)
-        def_node_matcher :eq_type_with_identity?, <<-PATTERN
+        def_node_matcher :eq_type_with_identity?, <<~PATTERN
           (send nil? :eq {true false nil})
         PATTERN
 

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

@@ -44,7 +44,7 @@ module RuboCop
         RESTRICT_ON_SEND = %i[to].freeze
 
         # @!method eql_type_with_identity(node)
-        def_node_matcher :eql_type_with_identity, <<-PATTERN
+        def_node_matcher :eql_type_with_identity, <<~PATTERN
           (send _ :to $(send nil? :eql {true false int float sym nil}))
         PATTERN
 

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

@@ -33,12 +33,12 @@ module RuboCop
         RESTRICT_ON_SEND = %i[be be_nil].freeze
 
         # @!method be_nil_matcher?(node)
-        def_node_matcher :be_nil_matcher?, <<-PATTERN
+        def_node_matcher :be_nil_matcher?, <<~PATTERN
           (send nil? :be_nil)
         PATTERN
 
         # @!method nil_value_expectation?(node)
-        def_node_matcher :nil_value_expectation?, <<-PATTERN
+        def_node_matcher :nil_value_expectation?, <<~PATTERN
           (send nil? :be nil)
         PATTERN
 

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

@@ -3,22 +3,16 @@
 module RuboCop
   module Cop
     module RSpec
-      # Check that before/after(:all) isn't being used.
+      # Check that before/after(:all/:context) isn't being used.
       #
       # @example
-      #   # bad
-      #   #
-      #   # Faster but risk of state leaking between examples
-      #   #
+      #   # bad - Faster but risk of state leaking between examples
       #   describe MyClass do
       #     before(:all) { Widget.create }
-      #     after(:all) { Widget.delete_all }
+      #     after(:context) { Widget.delete_all }
       #   end
       #
-      #   # good
-      #   #
-      #   # Slower but examples are properly isolated
-      #   #
+      #   # good - Slower but examples are properly isolated
       #   describe MyClass do
       #     before(:each) { Widget.create }
       #     after(:each) { Widget.delete_all }
@@ -30,11 +24,11 @@ module RuboCop
               '`use_transactional_fixtures` is enabled, then records created ' \
               'in `%<hook>s` are not automatically rolled back.'
 
-        RESTRICT_ON_SEND = %i[before after].freeze
+        RESTRICT_ON_SEND = Set[:before, :after].freeze
 
         # @!method before_or_after_all(node)
-        def_node_matcher :before_or_after_all, <<-PATTERN
-          $(send _ {:before :after} (sym {:all :context}))
+        def_node_matcher :before_or_after_all, <<~PATTERN
+          $(send _ RESTRICT_ON_SEND (sym {:all :context}))
         PATTERN
 
         def on_send(node)

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

@@ -59,6 +59,8 @@ module RuboCop
       #
       class ChangeByZero < Base
         extend AutoCorrector
+        include RangeHelp
+
         MSG = 'Prefer `not_to change` over `to %<method>s.by(0)`.'
         MSG_COMPOUND = 'Prefer %<preferred>s with compound expectations ' \
                        'over `%<method>s.by(0)`.'
@@ -66,14 +68,14 @@ module RuboCop
         RESTRICT_ON_SEND = CHANGE_METHODS.freeze
 
         # @!method expect_change_with_arguments(node)
-        def_node_matcher :expect_change_with_arguments, <<-PATTERN
+        def_node_matcher :expect_change_with_arguments, <<~PATTERN
           (send
             $(send nil? CHANGE_METHODS ...) :by
             (int 0))
         PATTERN
 
         # @!method expect_change_with_block(node)
-        def_node_matcher :expect_change_with_block, <<-PATTERN
+        def_node_matcher :expect_change_with_block, <<~PATTERN
           (send
             (block
               $(send nil? CHANGE_METHODS)
@@ -83,7 +85,7 @@ module RuboCop
         PATTERN
 
         # @!method change_nodes(node)
-        def_node_search :change_nodes, <<-PATTERN
+        def_node_search :change_nodes, <<~PATTERN
           $(send nil? CHANGE_METHODS ...)
         PATTERN
 
@@ -140,8 +142,32 @@ module RuboCop
 
           change_nodes(node) do |change_node|
             corrector.replace(change_node.loc.selector, negated_matcher)
-            range = node.loc.dot.with(end_pos: node.source_range.end_pos)
+            insert_operator(corrector, node, change_node)
+            remove_by_zero(corrector, node, change_node)
+          end
+        end
+
+        def insert_operator(corrector, node, change_node)
+          operator = node.right_siblings.first
+          return unless %i[& |].include?(operator)
+
+          corrector.insert_after(
+            replace_node(node, change_node), " #{operator}"
+          )
+        end
+
+        def replace_node(node, change_node)
+          expect_change_with_arguments(node) ? change_node : change_node.parent
+        end
+
+        def remove_by_zero(corrector, node, change_node)
+          range = node.loc.dot.with(end_pos: node.source_range.end_pos)
+          if change_node.loc.line == range.line
             corrector.remove(range)
+          else
+            corrector.remove(
+              range_by_whole_lines(range, include_final_newline: true)
+            )
           end
         end
 

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

@@ -30,7 +30,7 @@ module RuboCop
         MSG = 'Use `describe` for testing methods.'
 
         # @!method context_method(node)
-        def_node_matcher :context_method, <<-PATTERN
+        def_node_matcher :context_method, <<~PATTERN
           (block
             (send #rspec? :context
               ${(str #method_name?) (dstr (str #method_name?) ...)}
@@ -38,7 +38,7 @@ module RuboCop
           ...)
         PATTERN
 
-        def on_block(node)  # rubocop:disable InternalAffairs/NumblockHandler
+        def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler
           context_method(node) do |context|
             add_offense(context) do |corrector|
               corrector.replace(node.send_node.loc.selector, 'describe')

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

@@ -61,7 +61,7 @@ module RuboCop
         MSG = 'Context description should match %<patterns>s.'
 
         # @!method context_wording(node)
-        def_node_matcher :context_wording, <<-PATTERN
+        def_node_matcher :context_wording, <<~PATTERN
           (block (send #rspec? { :context :shared_context } $({str dstr xstr} ...) ...) ...)
         PATTERN
 

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

@@ -22,7 +22,7 @@ module RuboCop
         RESTRICT_ON_SEND = %i[describe].freeze
 
         # @!method describe_symbol?(node)
-        def_node_matcher :describe_symbol?, <<-PATTERN
+        def_node_matcher :describe_symbol?, <<~PATTERN
           (send #rspec? :describe $sym ...)
         PATTERN
 

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

@@ -8,8 +8,10 @@ module RuboCop
       # If the first argument of describe is a class, the class is exposed to
       # each example via described_class.
       #
-      # This cop can be configured using the `EnforcedStyle` and `SkipBlocks`
-      # options.
+      # This cop can be configured using the `EnforcedStyle`, `SkipBlocks`
+      # and `OnlyStaticConstants` options.
+      # `OnlyStaticConstants` is only relevant when `EnforcedStyle` is
+      # `described_class`.
       #
       # @example `EnforcedStyle: described_class` (default)
       #   # bad
@@ -22,6 +24,18 @@ module RuboCop
       #     subject { described_class.do_something }
       #   end
       #
+      # @example `OnlyStaticConstants: true` (default)
+      #   # good
+      #   describe MyClass do
+      #     subject { MyClass::CONSTANT }
+      #   end
+      #
+      # @example `OnlyStaticConstants: false`
+      #   # bad
+      #   describe MyClass do
+      #     subject { MyClass::CONSTANT }
+      #   end
+      #
       # @example `EnforcedStyle: explicit`
       #   # bad
       #   describe MyClass do
@@ -54,7 +68,7 @@ module RuboCop
       #     end
       #   end
       #
-      class DescribedClass < Base
+      class DescribedClass < Base # rubocop:disable Metrics/ClassLength
         extend AutoCorrector
         include ConfigurableEnforcedStyle
         include Namespace
@@ -63,7 +77,7 @@ module RuboCop
         MSG             = 'Use `%<replacement>s` instead of `%<src>s`.'
 
         # @!method common_instance_exec_closure?(node)
-        def_node_matcher :common_instance_exec_closure?, <<-PATTERN
+        def_node_matcher :common_instance_exec_closure?, <<~PATTERN
           (block (send (const nil? {:Class :Module :Struct}) :new ...) ...)
         PATTERN
 
@@ -75,7 +89,7 @@ module RuboCop
         def_node_matcher :scope_changing_syntax?, '{def class module}'
 
         # @!method described_constant(node)
-        def_node_matcher :described_constant, <<-PATTERN
+        def_node_matcher :described_constant, <<~PATTERN
           (block (send _ :describe $(const ...) ...) (args) $_)
         PATTERN
 
@@ -112,14 +126,17 @@ module RuboCop
 
         def find_usage(node, &block)
           yield(node) if offensive?(node)
-
-          return if scope_change?(node) || node.const_type?
+          return if scope_change?(node) || allowed?(node)
 
           node.each_child_node do |child|
             find_usage(child, &block)
           end
         end
 
+        def allowed?(node)
+          node.const_type? && only_static_constants?
+        end
+
         def message(offense)
           if style == :described_class
             format(MSG, replacement: DESCRIBED_CLASS, src: offense)
@@ -139,6 +156,10 @@ module RuboCop
           node.block_type? && !rspec_block?(node) && cop_config['SkipBlocks']
         end
 
+        def only_static_constants?
+          cop_config.fetch('OnlyStaticConstants', true)
+        end
+
         def offensive?(node)
           if style == :described_class
             offensive_described_class?(node)
@@ -148,15 +169,15 @@ module RuboCop
         end
 
         def offensive_described_class?(node)
-          return unless node.const_type?
+          return false unless node.const_type?
 
           # E.g. `described_class::CONSTANT`
-          return if contains_described_class?(node)
+          return false if contains_described_class?(node)
 
           nearest_described_class, = node.each_ancestor(:block)
             .map { |ancestor| described_constant(ancestor) }.find(&:itself)
 
-          return if nearest_described_class.equal?(node)
+          return false if nearest_described_class.equal?(node)
 
           full_const_name(nearest_described_class) == full_const_name(node)
         end
@@ -194,7 +215,8 @@ module RuboCop
         #   const_name(s(:const, s(:const, nil, :M), :C)) # => [:M, :C]
         #   const_name(s(:const, s(:cbase), :C))          # => [nil, :C]
         def const_name(node)
-          namespace, name = *node # rubocop:disable InternalAffairs/NodeDestructuring
+          namespace = node.namespace
+          name = node.short_name
           if !namespace
             [name]
           elsif namespace.const_type?

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

@@ -29,6 +29,19 @@ module RuboCop
       #     PreferredMethods:
       #       context: describe
       #
+      # If you were previously using the `RSpec/Capybara/FeatureMethods` cop and
+      # want to keep disabling all Capybara-specific methods that have the same
+      # native RSpec method (e.g. are just aliases), use the following config:
+      #
+      #   RSpec/Dialect:
+      #     PreferredMethods:
+      #       background: :before
+      #       scenario:   :it
+      #       xscenario:  :xit
+      #       given:      :let
+      #       given!:     :let!
+      #       feature:    :describe
+      #
       # You can expect the following behavior:
       #
       # @example

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

@@ -19,7 +19,7 @@ module RuboCop
 
         MSG = 'Avoid duplicated metadata.'
 
-        def on_metadata(symbols, _pairs)
+        def on_metadata(symbols, _hash)
           symbols.each do |symbol|
             on_metadata_symbol(symbol)
           end

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

@@ -131,6 +131,7 @@ module RuboCop
           {
             #examples_directly_or_in_block?
             (begin <#examples_directly_or_in_block? ...>)
+            (begin <#examples_in_branches? ...>)
           }
         PATTERN
 
@@ -161,7 +162,7 @@ module RuboCop
         end
 
         def conditionals_with_examples?(body)
-          return unless body.begin_type? || body.case_type?
+          return false unless body.begin_type? || body.case_type?
 
           body.each_descendant(:if, :case).any? do |condition_node|
             examples_in_branches?(condition_node)
@@ -169,6 +170,8 @@ module RuboCop
         end
 
         def examples_in_branches?(condition_node)
+          return false if !condition_node.if_type? && !condition_node.case_type?
+
           condition_node.branches.any? { |branch| examples?(branch) }
         end
 

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module RSpec
-      #  Checks for empty before and after hooks.
+      # Checks for empty before and after hooks.
       #
       # @example
       #   # bad

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

@@ -71,8 +71,8 @@ module RuboCop
 
         def next_one_line_example?(node)
           next_sibling = node.right_sibling
-          return unless next_sibling
-          return unless example?(next_sibling)
+          return false unless next_sibling
+          return false unless example?(next_sibling)
 
           next_sibling.single_line?
         end

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

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RSpec
+      # Avoid empty metadata hash.
+      #
+      # @example EnforcedStyle: symbol (default)
+      #   # bad
+      #   describe 'Something', {}
+      #
+      #   # good
+      #   describe 'Something'
+      class EmptyMetadata < Base
+        extend AutoCorrector
+
+        include Metadata
+        include RangeHelp
+
+        MSG = 'Avoid empty metadata hash.'
+
+        def on_metadata(_symbols, hash)
+          return unless hash&.pairs&.empty?
+
+          add_offense(hash) do |corrector|
+            remove_empty_metadata(corrector, hash)
+          end
+        end
+
+        private
+
+        def remove_empty_metadata(corrector, node)
+          corrector.remove(
+            range_with_surrounding_comma(
+              range_with_surrounding_space(
+                node.source_range,
+                side: :left
+              ),
+              :left
+            )
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RSpec
+      # Check that the `output` matcher is not called with an empty string.
+      #
+      # @example
+      #   # bad
+      #   expect { foo }.to output('').to_stdout
+      #   expect { bar }.not_to output('').to_stderr
+      #
+      #   # good
+      #   expect { foo }.not_to output.to_stdout
+      #   expect { bar }.to output.to_stderr
+      #
+      class EmptyOutput < Base
+        extend AutoCorrector
+
+        MSG = 'Use `%<runner>s` instead of matching on an empty output.'
+        RESTRICT_ON_SEND = Runners.all
+
+        # @!method matching_empty_output(node)
+        def_node_matcher :matching_empty_output, <<~PATTERN
+          (send
+            (block
+              (send nil? :expect) ...
+            )
+            #Runners.all
+            (send $(send nil? :output (str empty?)) ...)
+          )
+        PATTERN
+
+        def on_send(send_node)
+          matching_empty_output(send_node) do |node|
+            runner = send_node.method?(:to) ? 'not_to' : 'to'
+            message = format(MSG, runner: runner)
+            add_offense(node, message: message) do |corrector|
+              corrector.replace(send_node.loc.selector, runner)
+              corrector.replace(node, 'output')
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RSpec
+      # Use `eq` instead of `be ==` to compare objects.
+      #
+      # @example
+      #   # bad
+      #   expect(foo).to be == 42
+      #
+      #   # good
+      #   expect(foo).to eq 42
+      #
+      class Eq < Base
+        extend AutoCorrector
+        include RangeHelp
+
+        MSG = 'Use `eq` instead of `be ==` to compare objects.'
+        RESTRICT_ON_SEND = Runners.all
+
+        # @!method be_equals(node)
+        def_node_matcher :be_equals, <<~PATTERN
+          (send _ #Runners.all $(send (send nil? :be) :== _))
+        PATTERN
+
+        def on_send(node)
+          be_equals(node) do |matcher|
+            range = offense_range(matcher)
+            add_offense(range) do |corrector|
+              corrector.replace(range, 'eq')
+            end
+          end
+        end
+
+        private
+
+        def offense_range(matcher)
+          range_between(
+            matcher.source_range.begin_pos,
+            matcher.loc.selector.end_pos
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -26,11 +26,12 @@ module RuboCop
       #     expect(result).to be(true)
       #   end
       #
-      # You can set literals you want to fold with `CountAsOne`.
-      # Available are: 'array', 'hash', and 'heredoc'. Each literal
-      # will be counted as one line regardless of its actual size.
+      # You can set constructs you want to fold with `CountAsOne`.
+      # Available are: 'array', 'hash', 'heredoc', and 'method_call'.
+      # Each construct will be counted as one line regardless of
+      # its actual size.
       #
-      # @example CountAsOne: ['array', 'heredoc']
+      # @example CountAsOne: ['array', 'heredoc', 'method_call']
       #
       #   it do
       #     array = [         # +1
@@ -46,7 +47,12 @@ module RuboCop
       #       Heredoc
       #       content.
       #     HEREDOC
-      #   end                 # 5 points
+      #
+      #     foo(            # +1
+      #       1,
+      #       2
+      #     )
+      #   end               # 6 points
       #
       class ExampleLength < Base
         include CodeLength

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

@@ -7,6 +7,7 @@ module RuboCop
       #
       # RSpec allows for auto-generated example descriptions when there is no
       # description provided or the description is an empty one.
+      # It is acceptable to use `specify` without a description
       #
       # This cop removes empty descriptions.
       # It also defines whether auto-generated description is allowed, based
@@ -14,17 +15,24 @@ module RuboCop
       #
       # This cop can be configured using the `EnforcedStyle` option
       #
+      # @example
+      #   # always good
+      #   specify do
+      #     result = service.call
+      #     expect(result).to be(true)
+      #   end
+      #
       # @example `EnforcedStyle: always_allow` (default)
       #   # bad
       #   it('') { is_expected.to be_good }
-      #   it '' do
+      #   specify '' do
       #     result = service.call
       #     expect(result).to be(true)
       #   end
       #
       #   # good
       #   it { is_expected.to be_good }
-      #   it do
+      #   specify do
       #     result = service.call
       #     expect(result).to be(true)
       #   end
@@ -75,6 +83,7 @@ module RuboCop
         def check_example_without_description(node)
           return if node.arguments?
           return unless disallow_empty_description?(node)
+          return if node.method?(:specify) && node.parent.multiline?
 
           add_offense(node, message: MSG_ADD_DESCRIPTION)
         end