rubocop-rspec 1.24.0 → 1.25.0

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

@@ -56,9 +56,7 @@ module RuboCop
           private
 
           def static?(attribute)
-            value_matcher(attribute).to_a.all? do |node|
-              node.recursive_literal? || node.const_type?
-            end
+            value_matcher(attribute).to_a.all?(&:recursive_literal_or_const?)
           end
 
           def value_hash_without_braces?(node)

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

@@ -41,7 +41,7 @@ module RuboCop
           def on_block(node)
             factory_attributes(node).to_a.flatten.each do |attribute|
               values = block_value_matcher(attribute)
-              next if values.to_a.none? { |v| static?(v) }
+              next if values.to_a.all? { |v| dynamic?(v) }
               add_offense(attribute, location: :expression)
             end
           end
@@ -57,8 +57,8 @@ module RuboCop
 
           private
 
-          def static?(node)
-            node.nil? || node.recursive_literal? || node.const_type?
+          def dynamic?(node)
+            node && !node.recursive_literal_or_const?
           end
 
           def autocorrected_source(node)

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

@@ -26,8 +26,8 @@ module RuboCop
       # @example with AssignmentOnly configuration
       #
       #   # rubocop.yml
-      #   RSpec/InstanceVariable:
-      #     AssignmentOnly: false
+      #   # RSpec/InstanceVariable:
+      #   #   AssignmentOnly: false
       #
       #   # bad
       #   describe MyClass do

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

@@ -34,8 +34,8 @@ module RuboCop
       # @example configuration
       #
       #   # .rubocop.yml
-      #   RSpec/MultipleExpectations:
-      #     Max: 2
+      #   # RSpec/MultipleExpectations:
+      #   #   Max: 2
       #
       #   # not flagged by rubocop
       #   describe UserCreator do

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

@@ -6,6 +6,7 @@ module RuboCop
       # Checks for nested example groups.
       #
       # This cop is configurable using the `Max` option
+      # and supports `--auto-gen-config
       #
       # @example
       #   # bad
@@ -55,8 +56,8 @@ module RuboCop
       # @example configuration
       #
       #   # .rubocop.yml
-      #   RSpec/NestedGroups:
-      #     Max: 2
+      #   # RSpec/NestedGroups:
+      #   #   Max: 2
       #
       #   context 'when using some feature' do
       #     let(:some)    { :various }
@@ -70,7 +71,7 @@ module RuboCop
       #       let(:user_attributes) do
       #         {
       #           name: 'John',
-      #           age:  22
+      #           age:  22,
       #           role: role
       #         }
       #       end
@@ -85,6 +86,7 @@ module RuboCop
       #   end
       #
       class NestedGroups < Cop
+        include ConfigurableMax
         include RuboCop::RSpec::TopLevelDescribe
 
         MSG = 'Maximum example group nesting exceeded ' \
@@ -100,6 +102,7 @@ module RuboCop
 
         def on_top_level_describe(node, _args)
           find_nested_contexts(node.parent) do |context, nesting|
+            self.max = nesting
             add_offense(
               context.children.first,
               location: :expression,

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

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RSpec
+      # Checks for any pending or skipped examples.
+      #
+      # @example
+      #   # bad
+      #   describe MyClass do
+      #     it "should be true"
+      #   end
+      #
+      #   describe MyClass do
+      #     it "should be true" do
+      #       pending
+      #     end
+      #   end
+      #
+      #   describe MyClass do
+      #     xit "should be true" do
+      #     end
+      #   end
+      #
+      #   # good
+      #   describe MyClass do
+      #   end
+      class Pending < Cop
+        MSG = 'Pending spec found.'.freeze
+
+        PENDING_EXAMPLES    = Examples::PENDING + Examples::SKIPPED \
+                                + ExampleGroups::SKIPPED
+        SKIPPABLE_EXAMPLES  = ExampleGroups::GROUPS + Examples::EXAMPLES
+        SKIPPABLE_SELECTORS = SKIPPABLE_EXAMPLES.node_pattern_union
+
+        SKIP_SYMBOL    = s(:sym, :skip)
+        PENDING_SYMBOL = s(:sym, :pending)
+
+        def_node_matcher :metadata, <<-PATTERN
+          {(send nil? #{SKIPPABLE_SELECTORS} ... (hash $...))
+           (send nil? #{SKIPPABLE_SELECTORS} $...)}
+        PATTERN
+
+        def_node_matcher :pending_block?, PENDING_EXAMPLES.send_pattern
+
+        def on_send(node)
+          return unless pending_block?(node) || skipped_from_metadata?(node)
+          add_offense(node, location: :expression)
+        end
+
+        private
+
+        def skipped_from_metadata?(node)
+          (metadata(node) || []).any? { |n| skip_node?(n) }
+        end
+
+        def skip_node?(node)
+          if node.respond_to?(:key)
+            skip_symbol?(node.key) && node.value.truthy_literal?
+          else
+            skip_symbol?(node)
+          end
+        end
+
+        def skip_symbol?(symbol_node)
+          symbol_node == SKIP_SYMBOL || symbol_node == PENDING_SYMBOL
+        end
+      end
+    end
+  end
+end

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

@@ -50,10 +50,9 @@ module RuboCop
         end
 
         def message_inflected(predicate)
-          _recv, predicate_name, = *predicate
           format(MSG_INFLECTED,
-                 predicate_name: predicate_name,
-                 matcher_name: to_predicate_matcher(predicate_name))
+                 predicate_name: predicate.method_name,
+                 matcher_name: to_predicate_matcher(predicate.method_name))
         end
 
         # rubocop:disable Metrics/MethodLength
@@ -99,17 +98,17 @@ module RuboCop
           args = args_loc(predicate).source
           block_loc = block_loc(predicate)
           block = block_loc ? block_loc.source : ''
-          _recv, name, = *predicate
 
-          corrector.replace(matcher.loc.expression,
-                            to_predicate_matcher(name) + args + block)
+          corrector.replace(
+            matcher.loc.expression,
+            to_predicate_matcher(predicate.method_name) + args + block
+          )
         end
 
         def true?(to_symbol, matcher)
-          _recv, name, arg = *matcher
-          result = case name
+          result = case matcher.method_name
                    when :be, :eq
-                     arg.true_type?
+                     matcher.first_argument.true_type?
                    when :be_truthy, :a_truthy_value
                      true
                    when :be_falsey, :be_falsy, :a_falsey_value, :a_falsy_value
@@ -180,10 +179,9 @@ module RuboCop
         end
 
         def message_explicit(matcher)
-          _recv, name, = *matcher
           format(MSG_EXPLICIT,
-                 predicate_name: to_predicate_method(name),
-                 matcher_name: name)
+                 predicate_name: to_predicate_method(matcher.method_name),
+                 matcher_name: matcher.method_name)
         end
 
         def autocorrect_explicit(node)
@@ -199,7 +197,7 @@ module RuboCop
 
         def autocorrect_explicit_block(node)
           predicate_matcher_block?(node) do |actual, matcher|
-            to_node, = *node
+            to_node = node.send_node
             corrector_explicit(to_node, actual, matcher, to_node)
           end
         end

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

@@ -82,7 +82,7 @@ module RuboCop
 
         def check_block_body(block)
           body = block.body
-          unless body && dynamic?(body) # rubocop:disable Style/GuardClause
+          unless dynamic?(body) # rubocop:disable Style/GuardClause
             add_offense(
               block,
               location: :begin,
@@ -92,14 +92,15 @@ module RuboCop
         end
 
         def dynamic?(node)
-          !node.recursive_literal? && !node.const_type?
+          node && !node.recursive_literal_or_const?
         end
 
         # :nodoc:
         class AndReturnCallCorrector
           def initialize(node)
             @node = node
-            @receiver, _method_name, @args = *node
+            @receiver = node.receiver
+            @arg = node.first_argument
           end
 
           def call(corrector)
@@ -111,10 +112,10 @@ module RuboCop
 
           private
 
-          attr_reader :node, :receiver, :args
+          attr_reader :node, :receiver, :arg
 
           def heredoc?
-            args.loc.is_a?(Parser::Source::Map::Heredoc)
+            arg.loc.is_a?(Parser::Source::Map::Heredoc)
           end
 
           def range
@@ -127,14 +128,14 @@ module RuboCop
 
           def replacement
             if hash_without_braces?
-              "{ #{args.source} }"
+              "{ #{arg.source} }"
             else
-              args.source
+              arg.source
             end
           end
 
           def hash_without_braces?
-            args.hash_type? && !args.braces?
+            arg.hash_type? && !arg.braces?
           end
         end
 
@@ -160,14 +161,6 @@ module RuboCop
 
           attr_reader :node, :block, :body
 
-          def range
-            Parser::Source::Range.new(
-              block.source_range.source_buffer,
-              node.source_range.end_pos,
-              block.source_range.end_pos
-            )
-          end
-
           def heredoc?
             body.loc.is_a?(Parser::Source::Map::Heredoc)
           end

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

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RSpec
+      # Enforces use of string to titleize shared examples.
+      #
+      # @example
+      #   # bad
+      #   it_behaves_like :foo_bar_baz
+      #   it_should_behave_like :foo_bar_baz
+      #   shared_examples :foo_bar_baz
+      #   shared_examples_for :foo_bar_baz
+      #   include_examples :foo_bar_baz
+      #
+      #   # good
+      #   it_behaves_like 'foo bar baz'
+      #   it_should_behave_like 'foo bar baz'
+      #   shared_examples 'foo bar baz'
+      #   shared_examples_for 'foo bar baz'
+      #   include_examples 'foo bar baz'
+      #
+      class SharedExamples < Cop
+        def_node_matcher :shared_examples, <<-PATTERN
+          (send
+            {(const nil? :RSpec) nil?}
+            {#{(SharedGroups::ALL + Includes::ALL).node_pattern}} $sym ...)
+        PATTERN
+
+        def on_send(node)
+          shared_examples(node) do |ast_node|
+            checker = Checker.new(ast_node)
+            add_offense(checker.node, message: checker.message)
+          end
+        end
+
+        def autocorrect(node)
+          lambda do |corrector|
+            checker = Checker.new(node)
+            corrector.replace(node.loc.expression, checker.preferred_style)
+          end
+        end
+
+        # :nodoc:
+        class Checker
+          MSG = 'Prefer %<prefer>s over `%<current>s` ' \
+                'to titleize shared examples.'.freeze
+
+          attr_reader :node
+          def initialize(node)
+            @node = node
+          end
+
+          def message
+            format(MSG, prefer: preferred_style, current: symbol.inspect)
+          end
+
+          def preferred_style
+            string = symbol.to_s.tr('_', ' ')
+            wrap_with_single_quotes(string)
+          end
+
+          private
+
+          def symbol
+            node.value
+          end
+
+          def wrap_with_single_quotes(string)
+            "'#{string}'"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/rspec_cops.rb

@@ -1,6 +1,7 @@
 require_relative 'rspec/capybara/current_path_expectation'
 require_relative 'rspec/capybara/feature_methods'
 
+require_relative 'rspec/factory_bot/create_list'
 require_relative 'rspec/factory_bot/dynamic_attribute_defined_statically'
 require_relative 'rspec/factory_bot/static_attribute_defined_dynamically'
 
@@ -14,6 +15,7 @@ require_relative 'rspec/align_left_let_brace'
 require_relative 'rspec/align_right_let_brace'
 require_relative 'rspec/any_instance'
 require_relative 'rspec/around_block'
+require_relative 'rspec/be'
 require_relative 'rspec/be_eql'
 require_relative 'rspec/before_after_all'
 require_relative 'rspec/context_wording'
@@ -53,6 +55,7 @@ require_relative 'rspec/named_subject'
 require_relative 'rspec/nested_groups'
 require_relative 'rspec/not_to_not'
 require_relative 'rspec/overwriting_setup'
+require_relative 'rspec/pending'
 require_relative 'rspec/predicate_matcher'
 require_relative 'rspec/repeated_description'
 require_relative 'rspec/repeated_example'
@@ -60,6 +63,7 @@ require_relative 'rspec/return_from_stub'
 require_relative 'rspec/scattered_let'
 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/subject_stub'
 require_relative 'rspec/verified_doubles'

data/lib/rubocop/rspec/example.rb

@@ -24,7 +24,7 @@ module RuboCop
         if node.send_type?
           node
         else
-          node.children.first
+          node.send_node
         end
       end
     end

data/lib/rubocop/rspec/node.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module RSpec
+    # RuboCop-RSpec specific extensions of RuboCop::AST::Node
+    module Node
+      # In various cops we want to regard const as literal althought it's not
+      # strictly literal.
+      def recursive_literal_or_const?
+        case type
+        when :begin, :pair, *AST::Node::COMPOSITE_LITERALS
+          children.all?(&:recursive_literal_or_const?)
+        else
+          literal? || const_type?
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/rspec/top_level_describe.rb

@@ -12,16 +12,13 @@ module RuboCop
         return unless respond_to?(:on_top_level_describe)
         return unless top_level_describe?(node)
 
-        _receiver, _method_name, *args = *node
-
-        on_top_level_describe(node, args)
+        on_top_level_describe(node, node.arguments)
       end
 
       private
 
       def top_level_describe?(node)
-        _receiver, method_name, *_args = *node
-        return false unless method_name == :describe
+        return false unless node.method_name == :describe
 
         top_level_nodes.include?(node)
       end
@@ -49,7 +46,7 @@ module RuboCop
 
       def describe_statement_children(node)
         node.each_child_node(:send).select do |element|
-          element.children[1] == :describe
+          element.method_name == :describe
         end
       end
     end