rubocop-rspec 2.6.0 → 2.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ec6f02aa20957826bdff135547211062ac19bdac9b260d2a008c45973944ff16
-  data.tar.gz: 57454e8f60b40062ad5da0ef9e4ce83c8539aea78d13d8412af24f43c01c2e1d
+  metadata.gz: f73bb98579faf4e173aa834c1a3aa5fc1c9b6aa7c8790d3fcef2451594fadc78
+  data.tar.gz: e66399f76cea55c1eed9b348f3015ab726fb5df49b2f1a391bbf043b45b18507
 SHA512:
-  metadata.gz: 51333677ad7c458afd2446b21c6e900c5f4ba597d2659cc2e389e5c9e223fe1885e54c8d427a8213519bd9176c0bfbc146910d6cd3c5dea7c9a69450ac34ce97
-  data.tar.gz: 5f6cffcb89273ddca1615907f8de6e619697c63c1255b630320b3852a9266aef4d260d295a6ee57ea1c91e862ad584750fac2784a2a536aea37887f829a14bd5
+  metadata.gz: 44ba849ca8fd9ad7cb65355c78046bd5702f9d5b1f5df305fda876c6d7feb5947ea15e6fdb3749e32c1ae18b089703abefc074991fc780d6147b2295f3202a05
+  data.tar.gz: 5281f8fa3c1cb64028dd54544fc2f26fe25f382a5f842fa0dfe5040dbb6ea3627e74a386a596806cd6a0f56d8353d749fbec713c48c19d45f55840f9983cf755

data/CHANGELOG.md

@@ -2,6 +2,11 @@
 
 ## Master (Unreleased)
 
+## 2.7.0 (2021-12-26)
+
+* Add new `RSpec/FactoryBot/SyntaxMethods` cop. ([@leoarnold][])
+* Exclude `task` type specs from `RSpec/DescribeClass` cop. ([@harry-graham][])
+
 ## 2.6.0 (2021-11-08)
 
 * Fix merging RSpec DSL configuration from third-party gems. ([@pirj][])
@@ -651,3 +656,5 @@ Compatibility release so users can upgrade RuboCop to 0.51.0. No new features.
 [@dswij]: https://github.com/dswij
 [@francois-ferrandis]: https://github.com/francois-ferrandis
 [@r7kamura]: https://github.com/r7kamura
+[@leoarnold]: https://github.com/leoarnold
+[@harry-graham]: https://github.com/harry-graham

data/config/default.yml

@@ -196,8 +196,9 @@ RSpec/DescribeClass:
       - system
       - mailbox
       - aruba
+      - task
   VersionAdded: '1.0'
-  VersionChanged: '2.5'
+  VersionChanged: '2.7'
   StyleGuide: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/DescribeClass
 
 RSpec/DescribeMethod:
@@ -816,6 +817,13 @@ RSpec/FactoryBot/FactoryClassName:
   VersionChanged: '2.0'
   StyleGuide: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/FactoryBot/FactoryClassName
 
+RSpec/FactoryBot/SyntaxMethods:
+  Description: Use shorthands from `FactoryBot::Syntax::Methods` in your specs.
+  Enabled: pending
+  SafeAutoCorrect: false
+  VersionAdded: '2.7'
+  StyleGuide: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/FactoryBot/SyntaxMethods
+
 RSpec/Rails:
   Enabled: true
   Include: *1

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

@@ -42,6 +42,7 @@ module RuboCop
         #   end
         class FeatureMethods < Base
           extend AutoCorrector
+          include InsideExampleGroup
 
           MSG = 'Use `%<replacement>s` instead of `%<method>s`.'
 
@@ -60,13 +61,6 @@ module RuboCop
             {#{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
@@ -75,7 +69,7 @@ module RuboCop
           PATTERN
 
           def on_block(node)
-            return unless inside_spec?(node)
+            return unless inside_example_group?(node)
 
             feature_method(node) do |send_node, match|
               next if enabled?(match)
@@ -93,21 +87,6 @@ module RuboCop
 
           private
 
-          def inside_spec?(node)
-            return spec?(node) if root_node?(node)
-
-            root = node.ancestors.find { |parent| root_node?(parent) }
-            spec?(root)
-          end
-
-          def root_node?(node)
-            node.parent.nil? || root_with_siblings?(node.parent)
-          end
-
-          def root_with_siblings?(node)
-            node.begin_type? && node.parent.nil?
-          end
-
           def enabled?(method_name)
             enabled_methods.include?(method_name)
           end

data/lib/rubocop/cop/rspec/factory_bot/create_list.rb

@@ -27,6 +27,7 @@ module RuboCop
         class CreateList < Base
           extend AutoCorrector
           include ConfigurableEnforcedStyle
+          include RuboCop::RSpec::FactoryBot::Language
 
           MSG_CREATE_LIST = 'Prefer create_list.'
           MSG_N_TIMES = 'Prefer %<number>s.times.'
@@ -43,12 +44,12 @@ module RuboCop
 
           # @!method factory_call(node)
           def_node_matcher :factory_call, <<-PATTERN
-            (send ${(const nil? {:FactoryGirl :FactoryBot}) nil?} :create (sym $_) $...)
+            (send ${nil? #factory_bot?} :create (sym $_) $...)
           PATTERN
 
           # @!method factory_list_call(node)
           def_node_matcher :factory_list_call, <<-PATTERN
-            (send {(const nil? {:FactoryGirl :FactoryBot}) nil?} :create_list (sym _) (int $_) ...)
+            (send {nil? #factory_bot?} :create_list (sym _) (int $_) ...)
           PATTERN
 
           def on_block(node)
@@ -160,7 +161,7 @@ module RuboCop
             def call_with_block_replacement(node)
               block = node.body
               arguments = build_arguments(block, node.receiver.source)
-              replacement = format_receiver(block.send_node.receiver)
+              replacement = format_receiver(block.receiver)
               replacement += format_method_call(block, 'create_list', arguments)
               replacement += format_block(block)
               replacement

data/lib/rubocop/cop/rspec/factory_bot/syntax_methods.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RSpec
+      module FactoryBot
+        # Use shorthands from `FactoryBot::Syntax::Methods` in your specs.
+        #
+        # @safety
+        #   The auto-correction is marked as unsafe because the cop
+        #   cannot verify whether you already include
+        #   `FactoryBot::Syntax::Methods` in your test suite.
+        #
+        #   If you're using Rails, add the following configuration to
+        #   `spec/support/factory_bot.rb` and be sure to require that file in
+        #   `rails_helper.rb`:
+        #
+        #   [source,ruby]
+        #   ----
+        #   RSpec.configure do |config|
+        #     config.include FactoryBot::Syntax::Methods
+        #   end
+        #   ----
+        #
+        #   If you're not using Rails:
+        #
+        #   [source,ruby]
+        #   ----
+        #   RSpec.configure do |config|
+        #     config.include FactoryBot::Syntax::Methods
+        #
+        #     config.before(:suite) do
+        #       FactoryBot.find_definitions
+        #     end
+        #   end
+        #   ----
+        #
+        # @example
+        #   # bad
+        #   FactoryBot.create(:bar)
+        #   FactoryBot.build(:bar)
+        #   FactoryBot.attributes_for(:bar)
+        #
+        #   # good
+        #   create(:bar)
+        #   build(:bar)
+        #   attributes_for(:bar)
+        #
+        class SyntaxMethods < Base
+          extend AutoCorrector
+          include InsideExampleGroup
+          include RangeHelp
+          include RuboCop::RSpec::FactoryBot::Language
+
+          MSG = 'Use `%<method>s` from `FactoryBot::Syntax::Methods`.'
+
+          RESTRICT_ON_SEND = %i[
+            attributes_for
+            attributes_for_list
+            attributes_for_pair
+            build
+            build_list
+            build_pair
+            build_stubbed
+            build_stubbed_list
+            build_stubbed_pair
+            create
+            create_list
+            create_pair
+            generate
+            generate_list
+            null
+            null_list
+            null_pair
+          ].to_set.freeze
+
+          def on_send(node)
+            return unless factory_bot?(node.receiver)
+            return unless inside_example_group?(node)
+
+            message = format(MSG, method: node.method_name)
+
+            add_offense(crime_scene(node), message: message) do |corrector|
+              corrector.remove(offense(node))
+            end
+          end
+
+          private
+
+          def crime_scene(node)
+            range_between(
+              node.loc.expression.begin_pos,
+              node.loc.selector.end_pos
+            )
+          end
+
+          def offense(node)
+            range_between(
+              node.loc.expression.begin_pos,
+              node.loc.selector.begin_pos
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/rspec/mixin/inside_example_group.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RSpec
+      # Helps you identify whether a given node
+      # is within an example group or not.
+      module InsideExampleGroup
+        private
+
+        def inside_example_group?(node)
+          return example_group?(node) if example_group_root?(node)
+
+          root = node.ancestors.find { |parent| example_group_root?(parent) }
+
+          example_group?(root)
+        end
+
+        def example_group_root?(node)
+          node.parent.nil? || example_group_root_with_siblings?(node.parent)
+        end
+
+        def example_group_root_with_siblings?(node)
+          node.begin_type? && node.parent.nil?
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/rspec_cops.rb

@@ -7,6 +7,7 @@ require_relative 'rspec/capybara/visibility_matcher'
 require_relative 'rspec/factory_bot/attribute_defined_statically'
 require_relative 'rspec/factory_bot/create_list'
 require_relative 'rspec/factory_bot/factory_class_name'
+require_relative 'rspec/factory_bot/syntax_methods'
 
 require_relative 'rspec/rails/avoid_setup_hook'
 begin

data/lib/rubocop/rspec/factory_bot/language.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module RSpec
+    module FactoryBot
+      # Contains node matchers for common FactoryBot DSL.
+      module Language
+        extend RuboCop::NodePattern::Macros
+
+        # @!method factory_bot?(node)
+        def_node_matcher :factory_bot?, <<~PATTERN
+          (const {nil? cbase} {:FactoryGirl :FactoryBot})
+        PATTERN
+      end
+    end
+  end
+end

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.6.0'
+      STRING = '2.7.0'
     end
   end
 end

data/lib/rubocop-rspec.rb

@@ -12,11 +12,14 @@ require_relative 'rubocop/rspec/wording'
 require_relative 'rubocop/rspec/language/node_pattern'
 require_relative 'rubocop/rspec/language'
 
+require_relative 'rubocop/rspec/factory_bot/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/cop/rspec/mixin/inside_example_group'
 
 require_relative 'rubocop/rspec/concept'
 require_relative 'rubocop/rspec/example_group'
@@ -31,8 +34,8 @@ RuboCop::RSpec::Inject.defaults!
 
 require_relative 'rubocop/cop/rspec_cops'
 
-# We have to register our autocorrect incompatibilies in RuboCop's cops as well
-# so we do not hit infinite loops
+# We have to register our autocorrect incompatibilities in RuboCop's cops
+# as well so we do not hit infinite loops
 
 module RuboCop
   module Cop

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-rspec
 version: !ruby/object:Gem::Version
-  version: 2.6.0
+  version: 2.7.0
 platform: ruby
 authors:
 - John Backus
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-11-08 00:00:00.000000000 Z
+date: 2021-12-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -166,6 +166,7 @@ files:
 - lib/rubocop/cop/rspec/factory_bot/attribute_defined_statically.rb
 - lib/rubocop/cop/rspec/factory_bot/create_list.rb
 - lib/rubocop/cop/rspec/factory_bot/factory_class_name.rb
+- lib/rubocop/cop/rspec/factory_bot/syntax_methods.rb
 - lib/rubocop/cop/rspec/file_path.rb
 - lib/rubocop/cop/rspec/focus.rb
 - lib/rubocop/cop/rspec/hook_argument.rb
@@ -189,6 +190,7 @@ files:
 - lib/rubocop/cop/rspec/mixin/comments_help.rb
 - lib/rubocop/cop/rspec/mixin/empty_line_separation.rb
 - lib/rubocop/cop/rspec/mixin/final_end_location.rb
+- lib/rubocop/cop/rspec/mixin/inside_example_group.rb
 - lib/rubocop/cop/rspec/mixin/top_level_group.rb
 - lib/rubocop/cop/rspec/mixin/variable.rb
 - lib/rubocop/cop/rspec/multiple_describes.rb
@@ -234,6 +236,7 @@ files:
 - lib/rubocop/rspec/example.rb
 - lib/rubocop/rspec/example_group.rb
 - lib/rubocop/rspec/factory_bot.rb
+- lib/rubocop/rspec/factory_bot/language.rb
 - lib/rubocop/rspec/hook.rb
 - lib/rubocop/rspec/inject.rb
 - lib/rubocop/rspec/language.rb
@@ -247,6 +250,7 @@ licenses:
 metadata:
   changelog_uri: https://github.com/rubocop/rubocop-rspec/blob/master/CHANGELOG.md
   documentation_uri: https://docs.rubocop.org/rubocop-rspec/
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -262,7 +266,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.29
+rubygems_version: 3.3.1
 signing_key:
 specification_version: 4
 summary: Code style checking for RSpec files