rubocop-rspec 2.5.0 → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 22b3b217241494fa4c167f2e15e07a19d360d5807d0278d58b0a5504c9268b8d
-  data.tar.gz: 9111683fcaefd7c78675ce0549fa7e2a6a0c06a1b41e99b98472bd92b7459d03
+  metadata.gz: ec6f02aa20957826bdff135547211062ac19bdac9b260d2a008c45973944ff16
+  data.tar.gz: 57454e8f60b40062ad5da0ef9e4ce83c8539aea78d13d8412af24f43c01c2e1d
 SHA512:
-  metadata.gz: 4276ab19bc2cbaad8649d0380b77be083d3afb21397ea63614b1a6275fc47b615c1f418d3ebbdf44e4bd674d3d663c896d74863798a1c2b208d06d5ac248e777
-  data.tar.gz: 0b95a2233468bd4cd06596fe0a7c37d1f36e9481815cda16aa287eb8d479274e0aac813ceb2eede688853506fb023e7e469292713e4288271049573536ccbe94
+  metadata.gz: 51333677ad7c458afd2446b21c6e900c5f4ba597d2659cc2e389e5c9e223fe1885e54c8d427a8213519bd9176c0bfbc146910d6cd3c5dea7c9a69450ac34ce97
+  data.tar.gz: 5f6cffcb89273ddca1615907f8de6e619697c63c1255b630320b3852a9266aef4d260d295a6ee57ea1c91e862ad584750fac2784a2a536aea37887f829a14bd5

data/CHANGELOG.md

@@ -2,6 +2,15 @@
 
 ## Master (Unreleased)
 
+## 2.6.0 (2021-11-08)
+
+* Fix merging RSpec DSL configuration from third-party gems. ([@pirj][])
+* Fix `RSpec/ExcessiveDocstringSpacing` false positive for multi-line indented strings. ([@G-Rath][])
+* Fix `Include` configuration for sub-departments. ([@pirj][])
+* Ignore heredocs in `RSpec/ExcessiveDocstringSpacing`. ([@G-Rath][])
+* Stop `RSpec/ExampleWording` from trying to correct heredocs. ([@G-Rath][])
+* Add autocorrect support for `RSpec/VariableDefinition`. ([@r7kamura][])
+
 ## 2.5.0 (2021-09-21)
 
 * Declare autocorrect as unsafe for `ExpectChange`. ([@francois-ferrandis][])
@@ -641,3 +650,4 @@ Compatibility release so users can upgrade RuboCop to 0.51.0. No new features.
 [@G-Rath]: https://github.com/G-Rath
 [@dswij]: https://github.com/dswij
 [@francois-ferrandis]: https://github.com/francois-ferrandis
+[@r7kamura]: https://github.com/r7kamura

data/README.md

@@ -2,9 +2,7 @@
 
 [![Join the chat at https://gitter.im/rubocop-rspec/Lobby](https://badges.gitter.im/rubocop-rspec/Lobby.svg)](https://gitter.im/rubocop-rspec/Lobby)
 [![Gem Version](https://badge.fury.io/rb/rubocop-rspec.svg)](https://rubygems.org/gems/rubocop-rspec)
-[![CircleCI](https://circleci.com/gh/rubocop/rubocop-rspec.svg?style=svg)](https://circleci.com/gh/rubocop/rubocop-rspec)
-[![Test Coverage](https://api.codeclimate.com/v1/badges/8ffaabf633c968c22bdd/test_coverage)](https://codeclimate.com/github/rubocop-hq/rubocop-rspec/test_coverage)
-[![Maintainability](https://api.codeclimate.com/v1/badges/8ffaabf633c968c22bdd/maintainability)](https://codeclimate.com/github/rubocop-hq/rubocop-rspec/maintainability)
+![CI](https://github.com/rubocop-hq/rubocop-rspec/workflows/CI/badge.svg)
 
 RSpec-specific analysis for your projects, as an extension to
 [RuboCop](https://github.com/rubocop/rubocop).
@@ -67,7 +65,7 @@ end
 
 ### Code Climate
 
-rubocop-rspec is available on Code Climate as part of the rubocop engine. [Learn More](https://codeclimate.com/changelog/55a433bbe30ba00852000fac).
+rubocop-rspec is available on Code Climate as part of the rubocop engine. [Learn More](https://marketing.codeclimate.com/changelog/55a433bbe30ba00852000fac/).
 
 ## Documentation
 

data/config/default.yml

@@ -1,11 +1,24 @@
 ---
 RSpec:
   Enabled: true
-  Include:
+  Include: &1
     - "**/*_spec.rb"
     - "**/spec/**/*"
-  Language:
+  Language: &2
+    inherit_mode:
+      merge:
+        - Expectations
+        - Helpers
+        - Hooks
+        - HookScopes
+        - Runners
+        - Subjects
     ExampleGroups:
+      inherit_mode:
+        merge:
+          - Regular
+          - Skipped
+          - Focused
       Regular:
         - describe
         - context
@@ -20,6 +33,12 @@ RSpec:
         - fcontext
         - ffeature
     Examples:
+      inherit_mode:
+        merge:
+          - Regular
+          - Skipped
+          - Focused
+          - Pending
       Regular:
         - it
         - specify
@@ -62,6 +81,10 @@ RSpec:
       - all
       - suite
     Includes:
+      inherit_mode:
+        merge:
+          - Examples
+          - Context
       Examples:
         - it_behaves_like
         - it_should_behave_like
@@ -73,6 +96,10 @@ RSpec:
       - to_not
       - not_to
     SharedGroups:
+      inherit_mode:
+        merge:
+          - Examples
+          - Context
       Examples:
         - shared_examples
         - shared_examples_for
@@ -718,6 +745,11 @@ RSpec/Yield:
   VersionAdded: '1.32'
   StyleGuide: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/Yield
 
+RSpec/Capybara:
+  Enabled: true
+  Include: *1
+  Language: *2
+
 RSpec/Capybara/CurrentPathExpectation:
   Description: Checks that no expectations are set on Capybara's `current_path`.
   Enabled: true
@@ -740,6 +772,11 @@ RSpec/Capybara/VisibilityMatcher:
   VersionChanged: '2.0'
   StyleGuide: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/Capybara/VisibilityMatcher
 
+RSpec/FactoryBot:
+  Enabled: true
+  Include: *1
+  Language: *2
+
 RSpec/FactoryBot/AttributeDefinedStatically:
   Description: Always declare attribute values as blocks.
   Enabled: true
@@ -779,6 +816,11 @@ RSpec/FactoryBot/FactoryClassName:
   VersionChanged: '2.0'
   StyleGuide: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/FactoryBot/FactoryClassName
 
+RSpec/Rails:
+  Enabled: true
+  Include: *1
+  Language: *2
+
 RSpec/Rails/AvoidSetupHook:
   Description: Checks that tests use RSpec `before` hook over Rails `setup` method.
   Enabled: pending

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

@@ -60,7 +60,10 @@ module RuboCop
 
         def add_wording_offense(node, message)
           docstring = docstring(node)
+
           add_offense(docstring, message: message) do |corrector|
+            next if node.heredoc?
+
             corrector.replace(docstring, replacement_text(node))
           end
         end

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

@@ -37,6 +37,8 @@ module RuboCop
 
         def on_send(node)
           example_description(node) do |description_node, message|
+            return if description_node.heredoc?
+
             text = text(message)
 
             return unless excessive_whitespace?(text)
@@ -49,7 +51,9 @@ module RuboCop
 
         # @param text [String]
         def excessive_whitespace?(text)
-          text.start_with?(' ') || text.include?('  ') || text.end_with?(' ')
+          return true if text.start_with?(' ') || text.end_with?(' ')
+
+          text.match?(/[^\n ]  +[^ ]/)
         end
 
         # @param text [String]

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

@@ -23,6 +23,7 @@ module RuboCop
       #   subject('user') { create_user }
       #   let('user_name') { 'Adam' }
       class VariableDefinition < Base
+        extend AutoCorrector
         include ConfigurableEnforcedStyle
         include Variable
 
@@ -30,14 +31,30 @@ module RuboCop
 
         def on_send(node)
           variable_definition?(node) do |variable|
-            if style_violation?(variable)
-              add_offense(variable, message: format(MSG, style: style))
+            next unless style_violation?(variable)
+
+            add_offense(
+              variable,
+              message: format(MSG, style: style)
+            ) do |corrector|
+              corrector.replace(variable, correct_variable(variable))
             end
           end
         end
 
         private
 
+        def correct_variable(variable)
+          case variable.type
+          when :dsym
+            variable.source[1..-1]
+          when :sym
+            variable.value.to_s.inspect
+          else
+            variable.value.to_sym.inspect
+          end
+        end
+
         def style_violation?(variable)
           style == :symbols && string?(variable) ||
             style == :strings && symbol?(variable)

data/lib/rubocop/rspec/align_let_brace.rb

@@ -5,6 +5,7 @@ module RuboCop
     # Shared behavior for aligning braces for single line lets
     class AlignLetBrace
       include RuboCop::RSpec::Language
+      include RuboCop::Cop::Util
 
       def initialize(root, token)
         @root  = root
@@ -34,7 +35,7 @@ module RuboCop
       def let_group_for(let)
         adjacent_let_chunks.detect do |chunk|
           chunk.any? do |member|
-            member == let && member.loc.line == let.loc.line
+            member == let && same_line?(member, let)
           end
         end
       end

data/lib/rubocop/rspec/config_formatter.rb

@@ -7,6 +7,7 @@ module RuboCop
     # Builds a YAML config file from two config hashes
     class ConfigFormatter
       EXTENSION_ROOT_DEPARTMENT = %r{^(RSpec/)}.freeze
+      SUBDEPARTMENTS = %(RSpec/Capybara RSpec/FactoryBot RSpec/Rails)
       STYLE_GUIDE_BASE_URL = 'https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/'
 
       def initialize(config, descriptions)
@@ -24,6 +25,8 @@ module RuboCop
 
       def unified_config
         cops.each_with_object(config.dup) do |cop, unified|
+          next if SUBDEPARTMENTS.include?(cop)
+
           unified[cop] = config.fetch(cop)
             .merge(descriptions.fetch(cop))
             .merge('StyleGuide' => STYLE_GUIDE_BASE_URL + cop.sub('RSpec/', ''))

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.5.0'
+      STRING = '2.6.0'
     end
   end
 end

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-rspec
 version: !ruby/object:Gem::Version
-  version: 2.5.0
+  version: 2.6.0
 platform: ruby
 authors:
 - John Backus
 - Ian MacLeod
 - Nils Gemeinhardt
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-21 00:00:00.000000000 Z
+date: 2021-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -96,20 +96,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.6'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '0.18'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '0.18'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -261,7 +247,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
@@ -276,8 +262,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.2.29
+signing_key:
 specification_version: 4
 summary: Code style checking for RSpec files
 test_files: []