rubocop-rspec 1.37.1 → 1.41.0

data/lib/rubocop/rspec/example_group.rb

@@ -14,72 +14,44 @@ module RuboCop
         ExampleGroups::ALL + SharedGroups::ALL + Includes::ALL
       ).block_pattern
 
+      def lets
+        find_all_in_scope(node, :let?)
+      end
+
       def subjects
-        subjects_in_scope(node)
+        find_all_in_scope(node, :subject?)
       end
 
       def examples
-        examples_in_scope(node).map(&Example.public_method(:new))
+        find_all_in_scope(node, :example?).map(&Example.public_method(:new))
       end
 
       def hooks
-        hooks_in_scope(node).map(&Hook.public_method(:new))
+        find_all_in_scope(node, :hook?).map(&Hook.public_method(:new))
       end
 
       private
 
-      def subjects_in_scope(node)
-        node.each_child_node.flat_map do |child|
-          find_subjects(child)
-        end
-      end
-
-      def find_subjects(node)
-        return [] if scope_change?(node)
-
-        if subject?(node)
-          [node]
-        else
-          subjects_in_scope(node)
-        end
-      end
-
-      def hooks_in_scope(node)
-        node.each_child_node.flat_map do |child|
-          find_hooks(child)
-        end
-      end
-
-      def find_hooks(node)
-        return [] if scope_change?(node) || example?(node)
-
-        if hook?(node)
-          [node]
-        else
-          hooks_in_scope(node)
-        end
-      end
-
-      def examples_in_scope(node, &blk)
-        node.each_child_node.flat_map do |child|
-          find_examples(child, &blk)
-        end
-      end
-
-      # Recursively search for examples within the current scope
+      # Recursively search for predicate within the current scope
       #
-      # Searches node for examples and halts when a scope change is detected
+      # Searches node and halts when a scope change is detected
       #
-      # @param node [RuboCop::Node] node to recursively search for examples
+      # @param node [RuboCop::Node] node to recursively search
       #
-      # @return [Array<RuboCop::Node>] discovered example nodes
-      def find_examples(node)
-        return [] if scope_change?(node)
+      # @return [Array<RuboCop::Node>] discovered nodes
+      def find_all_in_scope(node, predicate)
+        node.each_child_node.flat_map do |child|
+          find_all(child, predicate)
+        end
+      end
 
-        if example?(node)
+      def find_all(node, predicate)
+        if public_send(predicate, node)
           [node]
+        elsif scope_change?(node) || example?(node)
+          []
         else
-          examples_in_scope(node)
+          find_all_in_scope(node, predicate)
         end
       end
     end

data/lib/rubocop/rspec/factory_bot.rb

@@ -4,7 +4,13 @@ module RuboCop
   module RSpec
     # RuboCop FactoryBot project namespace
     module FactoryBot
-      ATTRIBUTE_DEFINING_METHODS = %i[factory trait transient ignore].freeze
+      ATTRIBUTE_DEFINING_METHODS = %i[
+        factory
+        ignore
+        trait
+        traits_for_enum
+        transient
+      ].freeze
 
       UNPROXIED_METHODS = %i[
         __send__

data/lib/rubocop/rspec/hook.rb

@@ -4,21 +4,24 @@ module RuboCop
   module RSpec
     # Wrapper for RSpec hook
     class Hook < Concept
-      STANDARDIZED_SCOPES = %i[each context suite].freeze
-      private_constant(:STANDARDIZED_SCOPES)
+      def_node_matcher :extract_metadata, <<~PATTERN
+        (block
+          {
+            (send _ _ #valid_scope? $...)
+            (send _ _ $...)
+          }
+          ...
+        )
+      PATTERN
 
       def name
         node.method_name
       end
 
       def knowable_scope?
-        return true unless scope_argument
-
-        scope_argument.sym_type?
-      end
-
-      def valid_scope?
-        STANDARDIZED_SCOPES.include?(scope)
+        scope_argument.nil? ||
+          scope_argument.sym_type? ||
+          scope_argument.hash_type?
       end
 
       def example?
@@ -26,17 +29,47 @@ module RuboCop
       end
 
       def scope
+        return :each if scope_argument&.hash_type?
+
         case scope_name
         when nil, :each, :example then :each
         when :context, :all       then :context
         when :suite               then :suite
-        else
-          scope_name
         end
       end
 
+      def metadata
+        (extract_metadata(node) || [])
+          .map { |meta| transform_metadata(meta) }
+          .flatten
+          .inject(&:merge)
+      end
+
       private
 
+      def valid_scope?(node)
+        node&.sym_type? && Hooks::Scopes::ALL.include?(node.value)
+      end
+
+      def transform_metadata(meta)
+        if meta.sym_type?
+          { meta => true }
+        else
+          # This check is to be able to compare those two hooks:
+          #
+          #   before(:example, :special) { ... }
+          #   before(:example, special: true) { ... }
+          #
+          # In the second case it's a node with a pair that has a value
+          # of a `true_type?`.
+          meta.pairs.map { |pair| { pair.key => transform_true(pair.value) } }
+        end
+      end
+
+      def transform_true(node)
+        node.true_type? ? true : node
+      end
+
       def scope_name
         scope_argument.to_a.first
       end

data/lib/rubocop/rspec/language.rb

@@ -28,6 +28,14 @@ module RuboCop
           "(block #{send_pattern} ...)"
         end
 
+        def block_pass_pattern
+          "(send #{RSPEC} #{node_pattern_union} _ block_pass)"
+        end
+
+        def block_or_block_pass_pattern
+          "{#{block_pattern} #{block_pass_pattern}}"
+        end
+
         def send_pattern
           "(send #{RSPEC} #{node_pattern_union} ...)"
         end
@@ -94,6 +102,18 @@ module RuboCop
             append_after
           ]
         )
+
+        module Scopes
+          ALL = SelectorSet.new(
+            %i[
+              each
+              example
+              context
+              all
+              suite
+            ]
+          )
+        end
       end
 
       module Helpers

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

@@ -8,6 +8,10 @@ module RuboCop
         extend RuboCop::NodePattern::Macros
 
         def_node_matcher :example_group?, ExampleGroups::ALL.block_pattern
+        def_node_matcher :shared_group?, SharedGroups::ALL.block_pattern
+
+        spec_groups = ExampleGroups::ALL + SharedGroups::ALL
+        def_node_matcher :spec_group?, spec_groups.block_pattern
 
         def_node_matcher :example_group_with_body?, <<-PATTERN
           (block #{ExampleGroups::ALL.send_pattern} args [!nil?])
@@ -17,7 +21,7 @@ module RuboCop
 
         def_node_matcher :hook?, Hooks::ALL.block_pattern
 
-        def_node_matcher :let?, Helpers::ALL.block_pattern
+        def_node_matcher :let?, Helpers::ALL.block_or_block_pass_pattern
 
         def_node_matcher :subject?, Subject::ALL.block_pattern
       end

data/lib/rubocop/rspec/top_level_group.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module RSpec
+    # Helper methods for top level example group cops
+    module TopLevelGroup
+      extend RuboCop::NodePattern::Macros
+      include RuboCop::RSpec::Language
+
+      def_node_matcher :example_or_shared_group?,
+                       (ExampleGroups::ALL + SharedGroups::ALL).block_pattern
+
+      def on_block(node)
+        return unless respond_to?(:on_top_level_group)
+        return unless top_level_group?(node)
+
+        on_top_level_group(node)
+      end
+
+      private
+
+      def top_level_group?(node)
+        top_level_groups.include?(node)
+      end
+
+      def top_level_groups
+        @top_level_groups ||=
+          top_level_nodes.select { |n| example_or_shared_group?(n) }
+      end
+
+      def top_level_nodes
+        if root_node.begin_type?
+          root_node.children
+        else
+          [root_node]
+        end
+      end
+
+      def root_node
+        processed_source.ast
+      end
+    end
+  end
+end

data/lib/rubocop/rspec/variable.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module RSpec
+    # Helps check offenses with variable definitions
+    module Variable
+      include Language
+      extend RuboCop::NodePattern::Macros
+
+      def_node_matcher :variable_definition?, <<~PATTERN
+        (send #{RSPEC} #{(Helpers::ALL + Subject::ALL).node_pattern_union}
+          $({sym str dsym dstr} ...) ...)
+      PATTERN
+    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 = '1.37.1'
+      STRING = '1.41.0'
     end
   end
 end

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-rspec
 version: !ruby/object:Gem::Version
-  version: 1.37.1
+  version: 1.41.0
 platform: ruby
 authors:
 - John Backus
 - Ian MacLeod
 - Nils Gemeinhardt
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-12-16 00:00:00.000000000 Z
+date: 2020-07-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -72,16 +72,16 @@ dependencies:
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.18'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.18'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -110,6 +110,7 @@ extra_rdoc_files:
 - README.md
 files:
 - CHANGELOG.md
+- CODE_OF_CONDUCT.md
 - MIT-LICENSE.md
 - README.md
 - config/default.yml
@@ -123,6 +124,7 @@ 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/visibility_matcher.rb
 - lib/rubocop/cop/rspec/context_method.rb
 - lib/rubocop/cop/rspec/context_wording.rb
 - lib/rubocop/cop/rspec/cop.rb
@@ -133,6 +135,7 @@ files:
 - lib/rubocop/cop/rspec/described_class_module_wrapping.rb
 - lib/rubocop/cop/rspec/dialect.rb
 - lib/rubocop/cop/rspec/empty_example_group.rb
+- lib/rubocop/cop/rspec/empty_hook.rb
 - lib/rubocop/cop/rspec/empty_line_after_example.rb
 - lib/rubocop/cop/rspec/empty_line_after_example_group.rb
 - lib/rubocop/cop/rspec/empty_line_after_final_let.rb
@@ -182,6 +185,8 @@ files:
 - lib/rubocop/cop/rspec/receive_never.rb
 - lib/rubocop/cop/rspec/repeated_description.rb
 - lib/rubocop/cop/rspec/repeated_example.rb
+- lib/rubocop/cop/rspec/repeated_example_group_body.rb
+- lib/rubocop/cop/rspec/repeated_example_group_description.rb
 - lib/rubocop/cop/rspec/return_from_stub.rb
 - lib/rubocop/cop/rspec/scattered_let.rb
 - lib/rubocop/cop/rspec/scattered_setup.rb
@@ -190,6 +195,8 @@ files:
 - lib/rubocop/cop/rspec/single_argument_message_chain.rb
 - lib/rubocop/cop/rspec/subject_stub.rb
 - lib/rubocop/cop/rspec/unspecified_exception.rb
+- lib/rubocop/cop/rspec/variable_definition.rb
+- lib/rubocop/cop/rspec/variable_name.rb
 - lib/rubocop/cop/rspec/verified_doubles.rb
 - lib/rubocop/cop/rspec/void_expect.rb
 - lib/rubocop/cop/rspec/yield.rb
@@ -199,6 +206,7 @@ files:
 - lib/rubocop/rspec/blank_line_separation.rb
 - lib/rubocop/rspec/concept.rb
 - lib/rubocop/rspec/config_formatter.rb
+- lib/rubocop/rspec/corrector/move_node.rb
 - lib/rubocop/rspec/description_extractor.rb
 - lib/rubocop/rspec/example.rb
 - lib/rubocop/rspec/example_group.rb
@@ -210,7 +218,8 @@ files:
 - lib/rubocop/rspec/language/node_pattern.rb
 - lib/rubocop/rspec/node.rb
 - lib/rubocop/rspec/top_level_describe.rb
-- lib/rubocop/rspec/util.rb
+- lib/rubocop/rspec/top_level_group.rb
+- lib/rubocop/rspec/variable.rb
 - lib/rubocop/rspec/version.rb
 - lib/rubocop/rspec/wording.rb
 homepage: https://github.com/rubocop-hq/rubocop-rspec
@@ -219,7 +228,7 @@ licenses:
 metadata:
   changelog_uri: https://github.com/rubocop-hq/rubocop-rspec/blob/master/CHANGELOG.md
   documentation_uri: https://rubocop-rspec.readthedocs.io/
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -227,7 +236,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -235,7 +244,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.0.3
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Code style checking for RSpec files
 test_files: []

data/lib/rubocop/rspec/util.rb

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-module RuboCop
-  module RSpec
-    # Utility methods
-    module Util
-      # Error raised by `Util.one` if size is less than zero or greater than one
-      SizeError = Class.new(IndexError)
-
-      # Return only element in array if it contains exactly one member
-      def one(array)
-        return array.first if array.one?
-
-        raise SizeError,
-              "expected size to be exactly 1 but size was #{array.size}"
-      end
-    end
-  end
-end