rubocop-rspec 2.13.2 → 2.14.0

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

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RSpec
+      # Sort RSpec metadata alphabetically.
+      #
+      # @example
+      #   # bad
+      #   describe 'Something', :b, :a
+      #   context 'Something', foo: 'bar', baz: true
+      #   it 'works', :b, :a, foo: 'bar', baz: true
+      #
+      #   # good
+      #   describe 'Something', :a, :b
+      #   context 'Something', baz: true, foo: 'bar'
+      #   it 'works', :a, :b, baz: true, foo: 'bar'
+      #
+      class SortMetadata < Base
+        extend AutoCorrector
+        include RangeHelp
+
+        MSG = 'Sort metadata alphabetically.'
+
+        # @!method rspec_metadata(node)
+        def_node_matcher :rspec_metadata, <<~PATTERN
+          (block
+            (send
+              #rspec? {#Examples.all #ExampleGroups.all #SharedGroups.all #Hooks.all #Includes.all}
+              _ ${send str sym}* (hash $...)?)
+            ...)
+        PATTERN
+
+        # @!method rspec_configure(node)
+        def_node_matcher :rspec_configure, <<~PATTERN
+          (block (send #rspec? :configure) (args (arg $_)) ...)
+        PATTERN
+
+        # @!method metadata_in_block(node)
+        def_node_search :metadata_in_block, <<~PATTERN
+          (send (lvar %) #Hooks.all _ ${send str sym}* (hash $...)?)
+        PATTERN
+
+        def on_block(node)
+          rspec_configure(node) do |block_var|
+            metadata_in_block(node, block_var) do |symbols, pairs|
+              investigate(symbols, pairs.flatten)
+            end
+          end
+
+          rspec_metadata(node) do |symbols, pairs|
+            investigate(symbols, pairs.flatten)
+          end
+        end
+
+        alias on_numblock on_block
+
+        private
+
+        def investigate(symbols, pairs)
+          return if sorted?(symbols, pairs)
+
+          crime_scene = crime_scene(symbols, pairs)
+          add_offense(crime_scene) do |corrector|
+            corrector.replace(crime_scene, replacement(symbols, pairs))
+          end
+        end
+
+        def crime_scene(symbols, pairs)
+          metadata = symbols + pairs
+
+          range_between(
+            metadata.first.loc.expression.begin_pos,
+            metadata.last.loc.expression.end_pos
+          )
+        end
+
+        def replacement(symbols, pairs)
+          (sort_symbols(symbols) + sort_pairs(pairs)).map(&:source).join(', ')
+        end
+
+        def sorted?(symbols, pairs)
+          symbols == sort_symbols(symbols) && pairs == sort_pairs(pairs)
+        end
+
+        def sort_pairs(pairs)
+          pairs.sort_by { |pair| pair.key.source.downcase }
+        end
+
+        def sort_symbols(symbols)
+          symbols.sort_by do |symbol|
+            if %i[str sym].include?(symbol.type)
+              symbol.value.to_s.downcase
+            else
+              symbol.source.downcase
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -25,7 +25,7 @@ module RuboCop
 
         # @!method offensive_subject_declaration?(node)
         def_node_matcher :offensive_subject_declaration?, <<~PATTERN
-          (send nil? ${#Subjects.all #Helpers.all} {(sym :subject) (str "subject")} ...)
+          (send nil? ${#Subjects.all #Helpers.all} ({sym str} #Subjects.all) ...)
         PATTERN
 
         def on_send(node)

data/lib/rubocop/cop/rspec_cops.rb

@@ -2,11 +2,14 @@
 
 require_relative 'rspec/capybara/current_path_expectation'
 require_relative 'rspec/capybara/feature_methods'
+require_relative 'rspec/capybara/negation_matcher'
+require_relative 'rspec/capybara/specific_actions'
 require_relative 'rspec/capybara/specific_finders'
 require_relative 'rspec/capybara/specific_matcher'
 require_relative 'rspec/capybara/visibility_matcher'
 
 require_relative 'rspec/factory_bot/attribute_defined_statically'
+require_relative 'rspec/factory_bot/consistent_parentheses_style'
 require_relative 'rspec/factory_bot/create_list'
 require_relative 'rspec/factory_bot/factory_class_name'
 require_relative 'rspec/factory_bot/syntax_methods'
@@ -18,6 +21,7 @@ begin
 rescue LoadError
   # Rails/HttpStatus cannot be loaded if rack/utils is unavailable.
 end
+require_relative 'rspec/rails/inferred_spec_type'
 
 require_relative 'rspec/align_left_let_brace'
 require_relative 'rspec/align_right_let_brace'
@@ -97,6 +101,7 @@ require_relative 'rspec/scattered_setup'
 require_relative 'rspec/shared_context'
 require_relative 'rspec/shared_examples'
 require_relative 'rspec/single_argument_message_chain'
+require_relative 'rspec/sort_metadata'
 require_relative 'rspec/stubbed_mock'
 require_relative 'rspec/subject_declaration'
 require_relative 'rspec/subject_stub'

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

@@ -7,6 +7,26 @@ module RuboCop
       module Language
         extend RuboCop::NodePattern::Macros
 
+        METHODS = %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
+
         # @!method factory_bot?(node)
         def_node_matcher :factory_bot?, <<~PATTERN
           (const {nil? cbase} {:FactoryGirl :FactoryBot})

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.13.2'
+      STRING = '2.14.0'
     end
   end
 end

data/lib/rubocop-rspec.rb

@@ -23,6 +23,8 @@ require_relative 'rubocop/cop/rspec/mixin/empty_line_separation'
 require_relative 'rubocop/cop/rspec/mixin/inside_example_group'
 require_relative 'rubocop/cop/rspec/mixin/namespace'
 require_relative 'rubocop/cop/rspec/mixin/css_selector'
+require_relative 'rubocop/cop/rspec/mixin/skip_or_pending'
+require_relative 'rubocop/cop/rspec/mixin/capybara_help'
 
 require_relative 'rubocop/rspec/concept'
 require_relative 'rubocop/rspec/example_group'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-rspec
 version: !ruby/object:Gem::Version
-  version: 2.13.2
+  version: 2.14.0
 platform: ruby
 authors:
 - John Backus
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-09-22 00:00:00.000000000 Z
+date: 2022-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -58,6 +58,8 @@ files:
 - lib/rubocop/cop/rspec/before_after_all.rb
 - lib/rubocop/cop/rspec/capybara/current_path_expectation.rb
 - lib/rubocop/cop/rspec/capybara/feature_methods.rb
+- lib/rubocop/cop/rspec/capybara/negation_matcher.rb
+- lib/rubocop/cop/rspec/capybara/specific_actions.rb
 - lib/rubocop/cop/rspec/capybara/specific_finders.rb
 - lib/rubocop/cop/rspec/capybara/specific_matcher.rb
 - lib/rubocop/cop/rspec/capybara/visibility_matcher.rb
@@ -87,6 +89,7 @@ files:
 - lib/rubocop/cop/rspec/expect_in_hook.rb
 - lib/rubocop/cop/rspec/expect_output.rb
 - lib/rubocop/cop/rspec/factory_bot/attribute_defined_statically.rb
+- lib/rubocop/cop/rspec/factory_bot/consistent_parentheses_style.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
@@ -110,12 +113,14 @@ files:
 - lib/rubocop/cop/rspec/message_expectation.rb
 - lib/rubocop/cop/rspec/message_spies.rb
 - lib/rubocop/cop/rspec/missing_example_group_argument.rb
+- lib/rubocop/cop/rspec/mixin/capybara_help.rb
 - lib/rubocop/cop/rspec/mixin/comments_help.rb
 - lib/rubocop/cop/rspec/mixin/css_selector.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/namespace.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
 - lib/rubocop/cop/rspec/multiple_describes.rb
@@ -132,6 +137,7 @@ files:
 - lib/rubocop/cop/rspec/rails/avoid_setup_hook.rb
 - lib/rubocop/cop/rspec/rails/have_http_status.rb
 - lib/rubocop/cop/rspec/rails/http_status.rb
+- lib/rubocop/cop/rspec/rails/inferred_spec_type.rb
 - lib/rubocop/cop/rspec/receive_counts.rb
 - lib/rubocop/cop/rspec/receive_never.rb
 - lib/rubocop/cop/rspec/repeated_description.rb
@@ -145,6 +151,7 @@ files:
 - lib/rubocop/cop/rspec/shared_context.rb
 - lib/rubocop/cop/rspec/shared_examples.rb
 - lib/rubocop/cop/rspec/single_argument_message_chain.rb
+- lib/rubocop/cop/rspec/sort_metadata.rb
 - lib/rubocop/cop/rspec/stubbed_mock.rb
 - lib/rubocop/cop/rspec/subject_declaration.rb
 - lib/rubocop/cop/rspec/subject_stub.rb