rubocop-rspec 1.44.1 → 2.2.0

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

@@ -3,32 +3,15 @@
 module RuboCop
   module RSpec
     module Language
-      # Common node matchers used for matching against the rspec DSL
+      # Helper methods to detect RSpec DSL used with send and block
       module NodePattern
-        extend RuboCop::NodePattern::Macros
+        def send_pattern(string)
+          "(send #rspec? #{string} ...)"
+        end
 
-        def_node_matcher :rspec?, '{(const {nil? cbase} :RSpec) nil?}'
-
-        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?)
-        PATTERN
-
-        def_node_matcher :example?, Examples::ALL.block_pattern
-
-        def_node_matcher :hook?, Hooks::ALL.block_pattern
-
-        def_node_matcher :let?, Helpers::ALL.block_or_block_pass_pattern
-
-        def_node_matcher :include?,
-                         Includes::ALL.send_or_block_or_block_pass_pattern
-
-        def_node_matcher :subject?, Subject::ALL.block_pattern
+        def block_pattern(string)
+          "(block #{send_pattern(string)} ...)"
+        end
       end
     end
   end

data/lib/rubocop/rspec/node.rb

@@ -2,7 +2,7 @@
 
 module RuboCop
   module RSpec
-    # RuboCop-RSpec specific extensions of RuboCop::AST::Node
+    # 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.

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.44.1'
+      STRING = '2.2.0'
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-rspec
 version: !ruby/object:Gem::Version
-  version: 1.44.1
+  version: 2.2.0
 platform: ruby
 authors:
 - John Backus
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-10-20 00:00:00.000000000 Z
+date: 2021-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -18,28 +18,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.87'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.87'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rubocop-ast
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.7.1
+        version: 1.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.7.1
+        version: 1.1.0
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
@@ -156,7 +156,6 @@ files:
 - 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
 - lib/rubocop/cop/rspec/describe_class.rb
 - lib/rubocop/cop/rspec/describe_method.rb
 - lib/rubocop/cop/rspec/describe_symbol.rb
@@ -189,7 +188,6 @@ files:
 - lib/rubocop/cop/rspec/implicit_subject.rb
 - lib/rubocop/cop/rspec/instance_spy.rb
 - lib/rubocop/cop/rspec/instance_variable.rb
-- lib/rubocop/cop/rspec/invalid_predicate_matcher.rb
 - lib/rubocop/cop/rspec/it_behaves_like.rb
 - lib/rubocop/cop/rspec/iterated_expectation.rb
 - lib/rubocop/cop/rspec/leading_subject.rb
@@ -200,6 +198,11 @@ 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/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/top_level_group.rb
+- lib/rubocop/cop/rspec/mixin/variable.rb
 - lib/rubocop/cop/rspec/multiple_describes.rb
 - lib/rubocop/cop/rspec/multiple_expectations.rb
 - lib/rubocop/cop/rspec/multiple_memoized_helpers.rb
@@ -233,25 +236,19 @@ files:
 - lib/rubocop/cop/rspec/void_expect.rb
 - lib/rubocop/cop/rspec/yield.rb
 - lib/rubocop/cop/rspec_cops.rb
-- lib/rubocop/rspec.rb
 - lib/rubocop/rspec/align_let_brace.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/empty_line_separation.rb
 - lib/rubocop/rspec/example.rb
 - lib/rubocop/rspec/example_group.rb
 - lib/rubocop/rspec/factory_bot.rb
-- lib/rubocop/rspec/final_end_location.rb
 - lib/rubocop/rspec/hook.rb
 - lib/rubocop/rspec/inject.rb
 - lib/rubocop/rspec/language.rb
 - lib/rubocop/rspec/language/node_pattern.rb
 - lib/rubocop/rspec/node.rb
-- lib/rubocop/rspec/top_level_describe.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
@@ -275,7 +272,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.2.2
 signing_key:
 specification_version: 4
 summary: Code style checking for RSpec files

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

@@ -1,10 +0,0 @@
-# frozen_string_literal: true
-
-module RuboCop
-  module Cop
-    module RSpec
-      # @deprecated Use ::RuboCop::Cop::RSpec::Base instead
-      Cop = Base
-    end
-  end
-end

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

@@ -1,41 +0,0 @@
-# frozen_string_literal: true
-
-module RuboCop
-  module Cop
-    module RSpec
-      # Checks invalid usage for predicate matcher.
-      #
-      # Predicate matcher does not need a question.
-      # This cop checks an unnecessary question in predicate matcher.
-      #
-      # @example
-      #
-      #   # bad
-      #   expect(foo).to be_something?
-      #
-      #   # good
-      #   expect(foo).to be_something
-      class InvalidPredicateMatcher < Base
-        MSG = 'Omit `?` from `%<matcher>s`.'
-
-        def_node_matcher :invalid_predicate_matcher?, <<-PATTERN
-          (send (send nil? :expect ...) #{Runners::ALL.node_pattern_union} $(send nil? #predicate?))
-        PATTERN
-
-        def on_send(node)
-          invalid_predicate_matcher?(node) do |predicate|
-            add_offense(predicate,
-                        message: format(MSG, matcher: predicate.method_name))
-          end
-        end
-
-        private
-
-        def predicate?(name)
-          name = name.to_s
-          name.start_with?('be_', 'have_') && name.end_with?('?')
-        end
-      end
-    end
-  end
-end

data/lib/rubocop/rspec.rb

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-module RuboCop
-  # RuboCop RSpec project namespace
-  module RSpec
-    PROJECT_ROOT   = Pathname.new(__dir__).parent.parent.expand_path.freeze
-    CONFIG_DEFAULT = PROJECT_ROOT.join('config', 'default.yml').freeze
-    CONFIG         = YAML.safe_load(CONFIG_DEFAULT.read).freeze
-
-    private_constant(:CONFIG_DEFAULT, :PROJECT_ROOT)
-  end
-end

data/lib/rubocop/rspec/empty_line_separation.rb

@@ -1,48 +0,0 @@
-# frozen_string_literal: true
-
-module RuboCop
-  module RSpec
-    # Helps determine the offending location if there is not an empty line
-    # following the node. Allows comments to follow directly after.
-    module EmptyLineSeparation
-      include FinalEndLocation
-      include RuboCop::Cop::RangeHelp
-
-      def missing_separating_line_offense(node)
-        return if last_child?(node)
-
-        missing_separating_line(node) do |location|
-          msg = yield(node.method_name)
-          add_offense(location, message: msg) do |corrector|
-            corrector.insert_after(location.end, "\n")
-          end
-        end
-      end
-
-      def missing_separating_line(node)
-        line = final_end_location(node).line
-
-        line += 1 while comment_line?(processed_source[line])
-
-        return if processed_source[line].blank?
-
-        yield offending_loc(line)
-      end
-
-      def offending_loc(last_line)
-        offending_line = processed_source[last_line - 1]
-
-        content_length = offending_line.lstrip.length
-        start          = offending_line.length - content_length
-
-        source_range(processed_source.buffer, last_line, start, content_length)
-      end
-
-      def last_child?(node)
-        return true unless node.parent&.begin_type?
-
-        node.equal?(node.parent.children.last)
-      end
-    end
-  end
-end

data/lib/rubocop/rspec/final_end_location.rb

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-module RuboCop
-  module RSpec
-    # Helps find the true end location of nodes which might contain heredocs.
-    module FinalEndLocation
-      def final_end_location(start_node)
-        heredoc_endings =
-          start_node.each_node(:str, :dstr, :xstr)
-            .select(&:heredoc?)
-            .map { |node| node.loc.heredoc_end }
-
-        [start_node.loc.end, *heredoc_endings].max_by(&:line)
-      end
-    end
-  end
-end

data/lib/rubocop/rspec/top_level_describe.rb

@@ -1,52 +0,0 @@
-# frozen_string_literal: true
-
-module RuboCop
-  module RSpec
-    # Helper methods for top level describe cops
-    module TopLevelDescribe
-      extend NodePattern::Macros
-
-      def on_send(node)
-        return unless respond_to?(:on_top_level_describe)
-        return unless top_level_describe?(node)
-
-        on_top_level_describe(node, node.arguments)
-      end
-
-      private
-
-      def top_level_describe?(node)
-        return false unless node.method?(:describe)
-
-        top_level_nodes.include?(node)
-      end
-
-      def top_level_nodes
-        nodes = describe_statement_children(root_node)
-        # If we have no top level describe statements, we need to check any
-        # blocks on the top level (e.g. after a require).
-        if nodes.empty?
-          nodes = root_node.each_child_node(:block).flat_map do |child|
-            describe_statement_children(child)
-          end
-        end
-
-        nodes
-      end
-
-      def root_node
-        processed_source.ast
-      end
-
-      def single_top_level_describe?
-        top_level_nodes.one?
-      end
-
-      def describe_statement_children(node)
-        node.each_child_node(:send).select do |element|
-          element.method?(:describe)
-        end
-      end
-    end
-  end
-end

data/lib/rubocop/rspec/top_level_group.rb

@@ -1,57 +0,0 @@
-# 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_new_investigation
-        super
-
-        return unless root_node
-
-        top_level_groups.each do |node|
-          on_top_level_example_group(node) if example_group?(node)
-          on_top_level_group(node)
-        end
-      end
-
-      def top_level_groups
-        @top_level_groups ||=
-          top_level_nodes(root_node).select { |n| example_or_shared_group?(n) }
-      end
-
-      private
-
-      # Dummy methods to be overridden in the consumer
-      def on_top_level_example_group(_node); end
-
-      def on_top_level_group(_node); end
-
-      def top_level_group?(node)
-        top_level_groups.include?(node)
-      end
-
-      def top_level_nodes(node)
-        if node.nil?
-          []
-        elsif node.begin_type?
-          node.children
-        elsif node.module_type? || node.class_type?
-          top_level_nodes(node.body)
-        else
-          [node]
-        end
-      end
-
-      def root_node
-        processed_source.ast
-      end
-    end
-  end
-end

data/lib/rubocop/rspec/variable.rb

@@ -1,16 +0,0 @@
-# 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 nil? #{(Helpers::ALL + Subject::ALL).node_pattern_union}
-          $({sym str dsym dstr} ...) ...)
-      PATTERN
-    end
-  end
-end