rubocop-rspec 2.0.0 → 2.4.0

data/lib/rubocop-rspec.rb

@@ -15,6 +15,7 @@ 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'

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/be.rb

@@ -20,8 +20,9 @@ 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 $(send nil? :be))
         PATTERN

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,17 +30,22 @@ 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
               ${(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

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

@@ -55,16 +55,19 @@ module RuboCop
             feature:    :describe
           }.freeze
 
+          # @!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

@@ -37,17 +37,20 @@ module RuboCop
       class DescribeClass < Base
         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

@@ -19,9 +19,10 @@ module RuboCop
       class DescribeMethod < Base
         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,18 +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
 
+        # @!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
@@ -198,7 +203,7 @@ module RuboCop
             [name]
           elsif namespace.const_type?
             [*const_name(namespace), name]
-          elsif namespace.lvar_type? || namespace.cbase_type?
+          elsif %i[lvar cbase send].include?(namespace.type)
             [nil, name]
           end
         end

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

@@ -18,10 +18,11 @@ module RuboCop
       #     # ...
       #   end
       #
-      # @see https://github.com/rubocop-hq/rubocop-rspec/issues/735
+      # @see https://github.com/rubocop/rubocop-rspec/issues/735
       class DescribedClassModuleWrapping < Base
         MSG = 'Avoid opening modules and defining specs within them.'
 
+        # @!method find_rspec_blocks(node)
         def_node_search :find_rspec_blocks, block_pattern('#ExampleGroups.all')
 
         def on_module(node)

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

@@ -47,6 +47,7 @@ module RuboCop
 
         MSG = 'Prefer `%<prefer>s` over `%<current>s`.'
 
+        # @!method rspec_method?(node)
         def_node_matcher :rspec_method?, send_pattern('#ALL.all')
 
         def on_send(node)

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

@@ -28,6 +28,7 @@ module RuboCop
 
         MSG = 'Empty hook detected.'
 
+        # @!method empty_hook?(node)
         def_node_matcher :empty_hook?, <<~PATTERN
           (block $#{send_pattern('#Hooks.all')} _ nil?)
         PATTERN

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

@@ -25,29 +25,43 @@ module RuboCop
       #     result = service.call
       #     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.
+      #
+      # @example CountAsOne: ['array', 'heredoc']
+      #
+      #   it do
+      #     array = [         # +1
+      #       1,
+      #       2
+      #     ]
+      #
+      #     hash = {          # +3
+      #       key: 'value'
+      #     }
+      #
+      #     msg = <<~HEREDOC  # +1
+      #       Heredoc
+      #       content.
+      #     HEREDOC
+      #   end                 # 5 points
       class ExampleLength < Base
         include CodeLength
 
-        MSG = 'Example has too many lines [%<total>d/%<max>d].'
+        LABEL = 'Example'
 
         def on_block(node)
           return unless example?(node)
 
-          length = code_length(node)
-
-          return unless length > max_length
-
-          add_offense(node, message: message(length))
+          check_code_length(node)
         end
 
         private
 
-        def code_length(node)
-          node.source.lines[1..-2].count { |line| !irrelevant_line(line) }
-        end
-
-        def message(length)
-          format(MSG, total: length, max: max_length)
+        def cop_label
+          LABEL
         end
       end
     end

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

@@ -54,6 +54,7 @@ module RuboCop
                                'have auto-generated description.'
         MSG_ADD_DESCRIPTION  = 'Add a description.'
 
+        # @!method example_description(node)
         def_node_matcher :example_description, '(send nil? _ $(str $_))'
 
         def on_block(node)

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

@@ -38,6 +38,7 @@ module RuboCop
         SHOULD_PREFIX = /\Ashould(?:n't)?\b/i.freeze
         IT_PREFIX     = /\Ait /i.freeze
 
+        # @!method it_description(node)
         def_node_matcher :it_description, <<-PATTERN
           (block (send _ :it ${
             (str $_)

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?)
@@ -60,6 +61,7 @@ module RuboCop
           expect_literal(node) do |actual, matcher, expected|
             add_offense(actual.source_range) do |corrector|
               next unless SUPPORTED_MATCHERS.include?(matcher)
+              next if literal?(expected)
 
               swap(corrector, actual, expected)
             end

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

@@ -35,11 +35,14 @@ module RuboCop
 
         MSG_BLOCK = 'Prefer `change(%<obj>s, :%<attr>s)`.'
         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)
@@ -52,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/expect_output.rb

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