rubocop-rspec 2.4.0 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 35d3cf723ee0c50db00cbc5e63f5d9bf142186843fd56a86248dfb284c65180c
-  data.tar.gz: 8d0c0e01c405332eac2075b60d518a71e82a7d54f4b41ef111f5ef2b869e1f88
+  metadata.gz: 22b3b217241494fa4c167f2e15e07a19d360d5807d0278d58b0a5504c9268b8d
+  data.tar.gz: 9111683fcaefd7c78675ce0549fa7e2a6a0c06a1b41e99b98472bd92b7459d03
 SHA512:
-  metadata.gz: 2e28be09b6cc11154b903ef574ef44487c44ade441f79b1172569d66cecd2c027d525dbcefbe755d7a0f2c872491a018fb24cd026453dc13ac764bcae7312abc
-  data.tar.gz: 3062cea8205acc5e020c404034c8c2590c6c5c089649c62280887b0bc20ca3b4b38048a983b2947f9ed10bc1824992955c6a58736db53f071c72a3fdde9363f8
+  metadata.gz: 4276ab19bc2cbaad8649d0380b77be083d3afb21397ea63614b1a6275fc47b615c1f418d3ebbdf44e4bd674d3d663c896d74863798a1c2b208d06d5ac248e777
+  data.tar.gz: 0b95a2233468bd4cd06596fe0a7c37d1f36e9481815cda16aa287eb8d479274e0aac813ceb2eede688853506fb023e7e469292713e4288271049573536ccbe94

data/CHANGELOG.md

@@ -2,6 +2,17 @@
 
 ## Master (Unreleased)
 
+## 2.5.0 (2021-09-21)
+
+* Declare autocorrect as unsafe for `ExpectChange`. ([@francois-ferrandis][])
+* Fix each example for `RSpec/HookArgument`. ([@lokhi][])
+* Exclude unrelated Rails directories from `RSpec/DescribeClass`. ([@MothOnMars][])
+* Add `RSpec/ExcessiveDocstringSpacing` cop. ([@G-Rath][])
+* Add `RSpec/SubjectDeclaration` cop. ([@dswij][])
+* Fix excessive whitespace removal in `RSpec/EmptyHook` autocorrection. ([@pirj][])
+* Bump RuboCop requirement to v1.19.0. ([@pirj][])
+* Fix false positive in `RSpec/IteratedExpectation` when there is single, non-expectation statement in the block body. ([@Darhazer][])
+
 ## 2.4.0 (2021-06-09)
 
 * Update `RSpec/FilePath` to check suffix when given a non-constant top-level node (e.g. features). ([@topalovic][])
@@ -625,3 +636,8 @@ Compatibility release so users can upgrade RuboCop to 0.51.0. No new features.
 [@rrosenblum]: https://github.com/rrosenblum
 [@paydaylight]: https://github.com/paydaylight
 [@topalovic]: https://github.com/topalovic
+[@lokhi]: https://github.com/lokhi
+[@MothOnMars]: https://github.com/MothOnMars
+[@G-Rath]: https://github.com/G-Rath
+[@dswij]: https://github.com/dswij
+[@francois-ferrandis]: https://github.com/francois-ferrandis

data/config/default.yml

@@ -148,6 +148,12 @@ RSpec/ContextWording:
 RSpec/DescribeClass:
   Description: Check that the first argument to the top-level describe is a constant.
   Enabled: true
+  Exclude:
+    - "**/spec/features/**/*"
+    - "**/spec/requests/**/*"
+    - "**/spec/routing/**/*"
+    - "**/spec/system/**/*"
+    - "**/spec/views/**/*"
   IgnoredMetadata:
     type:
       - channel
@@ -164,7 +170,7 @@ RSpec/DescribeClass:
       - mailbox
       - aruba
   VersionAdded: '1.0'
-  VersionChanged: '1.44'
+  VersionChanged: '2.5'
   StyleGuide: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/DescribeClass
 
 RSpec/DescribeMethod:
@@ -269,6 +275,12 @@ RSpec/ExampleWithoutDescription:
   VersionAdded: '1.22'
   StyleGuide: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/ExampleWithoutDescription
 
+RSpec/ExcessiveDocstringSpacing:
+  Description: Checks for excessive whitespace in example descriptions.
+  Enabled: pending
+  VersionAdded: '2.5'
+  StyleGuide: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/ExcessiveDocstringSpacing
+
 RSpec/ExampleWording:
   Description: Checks for common mistakes in example descriptions.
   Enabled: true
@@ -297,7 +309,9 @@ RSpec/ExpectChange:
   SupportedStyles:
     - method_call
     - block
+  SafeAutoCorrect: false
   VersionAdded: '1.22'
+  VersionChanged: '2.5'
   StyleGuide: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/ExpectChange
 
 RSpec/ExpectInHook:
@@ -643,6 +657,12 @@ RSpec/StubbedMock:
   VersionAdded: '1.44'
   StyleGuide: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/StubbedMock
 
+RSpec/SubjectDeclaration:
+  Description: Ensure that subject is defined using subject helper.
+  Enabled: pending
+  VersionAdded: '2.5'
+  StyleGuide: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/SubjectDeclaration
+
 RSpec/SubjectStub:
   Description: Checks for stubbed test subjects.
   Enabled: true

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

@@ -36,7 +36,10 @@ module RuboCop
         def on_block(node)
           empty_hook?(node) do |hook|
             add_offense(hook) do |corrector|
-              range = range_with_surrounding_space(range: node.loc.expression)
+              range = range_with_surrounding_space(
+                range: node.loc.expression,
+                side: :left
+              )
               corrector.remove(range)
             end
           end

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

@@ -0,0 +1,96 @@
+# 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|
+            text = text(message)
+
+            return unless excessive_whitespace?(text)
+
+            add_whitespace_offense(description_node, text)
+          end
+        end
+
+        private
+
+        # @param text [String]
+        def excessive_whitespace?(text)
+          text.start_with?(' ') || text.include?('  ') || text.end_with?(' ')
+        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/hook_argument.rb

@@ -32,7 +32,7 @@ module RuboCop
       #     # ...
       #   end
       #
-      #   # good
+      #   # bad
       #   before do
       #     # ...
       #   end

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

@@ -48,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/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/subject_declaration.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RSpec
+      # Ensure that subject is defined using subject helper.
+      #
+      # @example
+      #
+      #   # bad
+      #   let(:subject) { foo }
+      #   let!(:subject) { foo }
+      #   subject(:subject) { foo }
+      #   subject!(:subject) { foo }
+      #
+      #   # bad
+      #   block = -> {}
+      #   let(:subject, &block)
+      #
+      #   # good
+      #   subject(:test_subject) { foo }
+      #
+      class SubjectDeclaration < Base
+        MSG_LET = 'Use subject explicitly rather than using let'
+        MSG_REDUNDANT = 'Ambiguous declaration of subject'
+
+        # @!method offensive_subject_declaration?(node)
+        def_node_matcher :offensive_subject_declaration?, <<~PATTERN
+          (send nil? ${#Subjects.all #Helpers.all} {(sym :subject) (str "subject")} ...)
+        PATTERN
+
+        def on_send(node)
+          offense = offensive_subject_declaration?(node)
+          return unless offense
+
+          add_offense(node, message: message_for(offense))
+        end
+
+        private
+
+        def message_for(offense)
+          Helpers.all(offense) ? MSG_LET : MSG_REDUNDANT
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/rspec_cops.rb

@@ -40,6 +40,7 @@ require_relative 'rspec/empty_line_after_subject'
 require_relative 'rspec/example_length'
 require_relative 'rspec/example_without_description'
 require_relative 'rspec/example_wording'
+require_relative 'rspec/excessive_docstring_spacing'
 require_relative 'rspec/expect_actual'
 require_relative 'rspec/expect_change'
 require_relative 'rspec/expect_in_hook'
@@ -88,6 +89,7 @@ require_relative 'rspec/shared_context'
 require_relative 'rspec/shared_examples'
 require_relative 'rspec/single_argument_message_chain'
 require_relative 'rspec/stubbed_mock'
+require_relative 'rspec/subject_declaration'
 require_relative 'rspec/subject_stub'
 require_relative 'rspec/unspecified_exception'
 require_relative 'rspec/variable_definition'

data/lib/rubocop/rspec/version.rb

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

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-rspec
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 2.5.0
 platform: ruby
 authors:
 - John Backus
 - Ian MacLeod
 - Nils Gemeinhardt
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-09 00:00:00.000000000 Z
+date: 2021-09-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -18,28 +18,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.19'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: rubocop-ast
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.1.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: '1.19'
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
@@ -96,6 +82,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -172,6 +172,7 @@ files:
 - lib/rubocop/cop/rspec/example_length.rb
 - lib/rubocop/cop/rspec/example_without_description.rb
 - lib/rubocop/cop/rspec/example_wording.rb
+- lib/rubocop/cop/rspec/excessive_docstring_spacing.rb
 - lib/rubocop/cop/rspec/expect_actual.rb
 - lib/rubocop/cop/rspec/expect_change.rb
 - lib/rubocop/cop/rspec/expect_in_hook.rb
@@ -230,6 +231,7 @@ files:
 - lib/rubocop/cop/rspec/shared_examples.rb
 - lib/rubocop/cop/rspec/single_argument_message_chain.rb
 - lib/rubocop/cop/rspec/stubbed_mock.rb
+- lib/rubocop/cop/rspec/subject_declaration.rb
 - lib/rubocop/cop/rspec/subject_stub.rb
 - lib/rubocop/cop/rspec/unspecified_exception.rb
 - lib/rubocop/cop/rspec/variable_definition.rb
@@ -259,7 +261,7 @@ licenses:
 metadata:
   changelog_uri: https://github.com/rubocop/rubocop-rspec/blob/master/CHANGELOG.md
   documentation_uri: https://docs.rubocop.org/rubocop-rspec/
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -274,8 +276,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.16
-signing_key:
+rubygems_version: 3.1.2
+signing_key: 
 specification_version: 4
 summary: Code style checking for RSpec files
 test_files: []