rubocop-rspec 3.9.0 → 3.10.2

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

@@ -8,6 +8,9 @@ module RuboCop
       # If there are no examples defined, use shared_context.
       # If there is no setup defined, use shared_examples.
       #
+      # With `Strict: true`, `shared_context` is flagged whenever it contains
+      # any examples, even if it also contains setup code.
+      #
       # @example
       #   # bad
       #   RSpec.shared_context 'only examples here' do
@@ -50,11 +53,31 @@ module RuboCop
       #     end
       #   end
       #
+      # @example Strict: true
+      #   # bad - shared_context with examples is flagged
+      #   RSpec.shared_context 'setup and examples' do
+      #     let(:foo) { :bar }
+      #
+      #     it 'does x' do
+      #     end
+      #   end
+      #
+      #   # good - split into separate shared_context and shared_examples
+      #   RSpec.shared_context 'setup' do
+      #     let(:foo) { :bar }
+      #   end
+      #
+      #   RSpec.shared_examples 'examples' do
+      #     it 'does x' do
+      #     end
+      #   end
+      #
       class SharedContext < Base
         extend AutoCorrector
 
         MSG_EXAMPLES = "Use `shared_examples` when you don't define context."
-        MSG_CONTEXT  = "Use `shared_context` when you don't define examples."
+        MSG_EXAMPLES_STRICT = 'Use `shared_examples` when you define examples.'
+        MSG_CONTEXT = "Use `shared_context` when you don't define examples."
 
         # @!method examples?(node)
         def_node_search :examples?, <<~PATTERN
@@ -78,10 +101,13 @@ module RuboCop
           (block (send #rspec? #SharedGroups.examples ...) ...)
         PATTERN
 
-        def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler
-          context_with_only_examples(node) do
-            add_offense(node.send_node, message: MSG_EXAMPLES) do |corrector|
-              corrector.replace(node.send_node.loc.selector, 'shared_examples')
+        def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler, InternalAffairs/ItblockHandler
+          offending_node(node) do
+            add_offense(node.send_node, message: message) do |corrector|
+              if can_correct?(node)
+                corrector.replace(node.send_node.loc.selector,
+                                  'shared_examples')
+              end
             end
           end
 
@@ -94,8 +120,22 @@ module RuboCop
 
         private
 
-        def context_with_only_examples(node)
-          shared_context(node) { yield if examples?(node) && !context?(node) }
+        def strict?
+          cop_config.fetch('Strict', false)
+        end
+
+        def message
+          strict? ? MSG_EXAMPLES_STRICT : MSG_EXAMPLES
+        end
+
+        def can_correct?(node)
+          !strict? || !context?(node)
+        end
+
+        def offending_node(node)
+          shared_context(node) do
+            yield if examples?(node) && (strict? || !context?(node))
+          end
         end
 
         def examples_with_only_context(node)

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

@@ -24,6 +24,8 @@ module RuboCop
       #   end
       #
       class SkipBlockInsideExample < Base
+        include InsideExample
+
         MSG = "Don't pass a block to `skip` inside examples."
 
         def on_block(node)
@@ -34,12 +36,7 @@ module RuboCop
         end
 
         alias on_numblock on_block
-
-        private
-
-        def inside_example?(node)
-          node.each_ancestor(:block).any? { |ancestor| example?(ancestor) }
-        end
+        alias on_itblock on_block
       end
     end
   end

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

@@ -44,6 +44,7 @@ module RuboCop
         include FileHelp
 
         MSG = 'Spec path should end with `%<suffix>s`.'
+        PATH_NAME_BOUNDARY = '(?![[:alnum:]])'
 
         # @!method example_group_arguments(node)
         def_node_matcher :example_group_arguments, <<~PATTERN
@@ -119,7 +120,11 @@ module RuboCop
           # For the suffix shown in the offense message, modify the regular
           # expression pattern to resemble a glob pattern for clearer error
           # messages.
-          suffix = pattern.sub('.*', '*').sub('[^/]*', '*').sub('\.', '.')
+          suffix = pattern
+            .sub(PATH_NAME_BOUNDARY, '')
+            .sub('.*', '*')
+            .sub('[^/]*', '*')
+            .sub('\.', '.')
           add_offense(send_node, message: format(MSG, suffix: suffix))
         end
 
@@ -132,19 +137,21 @@ module RuboCop
         end
 
         def correct_path_pattern(class_name, arguments)
-          path = [expected_path(class_name)]
-          path << '.*' unless ignore?(arguments.first)
-          path << [name_pattern(arguments.first), '[^/]*_spec\.rb']
-          path.join
+          [
+            expected_path(class_name),
+            PATH_NAME_BOUNDARY,
+            method_name_pattern(arguments.first),
+            '[^/]*_spec\.rb'
+          ].join
         end
 
-        def name_pattern(method_name)
-          return if ignore?(method_name)
+        def method_name_pattern(method_name)
+          return if ignore_method_name?(method_name)
 
-          method_name.str_content.gsub(/\s/, '_').gsub(/\W/, '')
+          ".*#{method_name.str_content.gsub(/\s/, '_').gsub(/\W/, '')}"
         end
 
-        def ignore?(method_name)
+        def ignore_method_name?(method_name)
           !method_name&.str_type? || ignore_methods?
         end
 
@@ -152,8 +159,9 @@ module RuboCop
           constants = namespace(constant) + constant.const_name.split('::')
 
           File.join(
-            constants.map do |name|
-              custom_transform.fetch(name) { camel_to_snake_case(name) }
+            constants.filter_map do |name|
+              path = custom_transform.fetch(name) { camel_to_snake_case(name) }
+              path unless path.empty?
             end
           )
         end
@@ -175,7 +183,7 @@ module RuboCop
         end
 
         def filename_ends_with?(pattern)
-          expanded_file_path.match?("#{pattern}$")
+          expanded_file_path.match?(%r{(?:\A|/)#{pattern}$})
         end
       end
     end

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

@@ -20,6 +20,8 @@ module RuboCop
       #   subject(:test_subject) { foo }
       #
       class SubjectDeclaration < Base
+        extend AutoCorrector
+
         MSG_LET = 'Use subject explicitly rather than using let'
         MSG_REDUNDANT = 'Ambiguous declaration of subject'
 
@@ -32,7 +34,11 @@ module RuboCop
           offense = offensive_subject_declaration?(node)
           return unless offense
 
-          add_offense(node, message: message_for(offense))
+          add_offense(node, message: message_for(offense)) do |corrector|
+            corrector.replace(node.loc.selector,
+                              node.method_name.to_s.sub('let', 'subject'))
+            corrector.remove(first_argument_range(node))
+          end
         end
 
         private
@@ -40,6 +46,16 @@ module RuboCop
         def message_for(offense)
           Helpers.all(offense) ? MSG_LET : MSG_REDUNDANT
         end
+
+        def first_argument_range(node)
+          if node.arguments.one?
+            node.loc.begin.join(node.loc.end)
+          else
+            node.first_argument.source_range.with(
+              end_pos: node.arguments[1].source_range.begin_pos
+            )
+          end
+        end
       end
     end
   end

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

@@ -52,7 +52,7 @@ module RuboCop
           (block (send #rspec? {#ExampleGroups.all #Examples.all} $_) ...)
         PATTERN
 
-        def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler
+        def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler, InternalAffairs/ItblockHandler
           example_groups_or_example?(node) do |arg|
             add_offense(arg) if offense?(arg)
           end

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

@@ -13,6 +13,8 @@ module RuboCop
       #   expect(something).to be(1)
       #
       class VoidExpect < Base
+        include InsideExample
+
         MSG = 'Do not use `expect()` without `.to` or `.not_to`. ' \
               'Chain the methods or remove it.'
         RESTRICT_ON_SEND = %i[expect].freeze
@@ -34,7 +36,7 @@ module RuboCop
           check_expect(node)
         end
 
-        def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler
+        def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler, InternalAffairs/ItblockHandler
           return unless expect_block?(node)
           return unless inside_example?(node)
 
@@ -55,10 +57,6 @@ module RuboCop
 
           parent.block_type? && parent.body == expect
         end
-
-        def inside_example?(node)
-          node.each_ancestor(:block).any? { |ancestor| example?(ancestor) }
-        end
       end
     end
   end

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

@@ -27,7 +27,7 @@ module RuboCop
         # @!method block_call?(node)
         def_node_matcher :block_call?, '(send (lvar %) :call ...)'
 
-        def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler
+        def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler, InternalAffairs/ItblockHandler
           return unless method_on_stub?(node.send_node)
 
           block_arg(node.arguments) do |block|

data/lib/rubocop/cop/rspec_cops.rb

@@ -21,6 +21,7 @@ require_relative 'rspec/describe_symbol'
 require_relative 'rspec/described_class'
 require_relative 'rspec/described_class_module_wrapping'
 require_relative 'rspec/dialect'
+require_relative 'rspec/discarded_matcher'
 require_relative 'rspec/duplicated_metadata'
 require_relative 'rspec/empty_example_group'
 require_relative 'rspec/empty_hook'
@@ -61,6 +62,7 @@ require_relative 'rspec/leaky_local_variable'
 require_relative 'rspec/let_before_examples'
 require_relative 'rspec/let_setup'
 require_relative 'rspec/match_array'
+require_relative 'rspec/match_with_simple_regex'
 require_relative 'rspec/message_chain'
 require_relative 'rspec/message_expectation'
 require_relative 'rspec/message_spies'

data/lib/rubocop/rspec/description_extractor.rb

@@ -50,7 +50,7 @@ module RuboCop
         end
 
         def description
-          yardoc.docstring.split("\n\n").first.to_s
+          yardoc.docstring.split("\n\n").first.to_s.tr("\n", ' ')
         end
 
         def rspec_cop_namespace?

data/lib/rubocop/rspec/version.rb

@@ -4,7 +4,7 @@ module RuboCop
   module RSpec
     # Version information for the RSpec RuboCop plugin.
     module Version
-      STRING = '3.9.0'
+      STRING = '3.10.2'
     end
   end
 end

data/lib/rubocop-rspec.rb

@@ -14,10 +14,12 @@ require_relative 'rubocop/rspec/wording'
 
 require_relative 'rubocop/cop/rspec/mixin/file_help'
 require_relative 'rubocop/cop/rspec/mixin/final_end_location'
+require_relative 'rubocop/cop/rspec/mixin/inside_example'
 require_relative 'rubocop/cop/rspec/mixin/inside_example_group'
 require_relative 'rubocop/cop/rspec/mixin/location_help'
 require_relative 'rubocop/cop/rspec/mixin/metadata'
 require_relative 'rubocop/cop/rspec/mixin/namespace'
+require_relative 'rubocop/cop/rspec/mixin/repeated_items'
 require_relative 'rubocop/cop/rspec/mixin/skip_or_pending'
 require_relative 'rubocop/cop/rspec/mixin/top_level_group'
 require_relative 'rubocop/cop/rspec/mixin/variable'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-rspec
 version: !ruby/object:Gem::Version
-  version: 3.9.0
+  version: 3.10.2
 platform: ruby
 authors:
 - John Backus
@@ -25,20 +25,40 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: regexp_parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.81'
+        version: '1.86'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.86.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.81'
+        version: '1.86'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.86.2
 description: |
   Code style checking for RSpec files.
   A plugin for the RuboCop code style enforcing & linting tool.
@@ -81,6 +101,7 @@ files:
 - lib/rubocop/cop/rspec/described_class.rb
 - lib/rubocop/cop/rspec/described_class_module_wrapping.rb
 - lib/rubocop/cop/rspec/dialect.rb
+- lib/rubocop/cop/rspec/discarded_matcher.rb
 - lib/rubocop/cop/rspec/duplicated_metadata.rb
 - lib/rubocop/cop/rspec/empty_example_group.rb
 - lib/rubocop/cop/rspec/empty_hook.rb
@@ -121,6 +142,7 @@ files:
 - lib/rubocop/cop/rspec/let_before_examples.rb
 - lib/rubocop/cop/rspec/let_setup.rb
 - lib/rubocop/cop/rspec/match_array.rb
+- lib/rubocop/cop/rspec/match_with_simple_regex.rb
 - lib/rubocop/cop/rspec/message_chain.rb
 - lib/rubocop/cop/rspec/message_expectation.rb
 - lib/rubocop/cop/rspec/message_spies.rb
@@ -131,10 +153,12 @@ files:
 - lib/rubocop/cop/rspec/mixin/empty_line_separation.rb
 - lib/rubocop/cop/rspec/mixin/file_help.rb
 - lib/rubocop/cop/rspec/mixin/final_end_location.rb
+- lib/rubocop/cop/rspec/mixin/inside_example.rb
 - lib/rubocop/cop/rspec/mixin/inside_example_group.rb
 - lib/rubocop/cop/rspec/mixin/location_help.rb
 - lib/rubocop/cop/rspec/mixin/metadata.rb
 - lib/rubocop/cop/rspec/mixin/namespace.rb
+- lib/rubocop/cop/rspec/mixin/repeated_items.rb
 - lib/rubocop/cop/rspec/mixin/skip_or_pending.rb
 - lib/rubocop/cop/rspec/mixin/top_level_group.rb
 - lib/rubocop/cop/rspec/mixin/variable.rb
@@ -223,7 +247,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.3
+rubygems_version: 4.0.10
 specification_version: 4
 summary: Code style checking for RSpec files
 test_files: []