rubocop-rspec 1.7.0 → 3.0.2

data/lib/rubocop/rspec/language.rb

@@ -2,72 +2,215 @@
 
 module RuboCop
   module RSpec
-    # RSpec public API methods that are commonly used in cops
+    # Contains node matchers for common RSpec DSL.
+    #
+    # RSpec allows for configuring aliases for commonly used DSL elements, e.g.
+    # example groups and hooks. It is possible to configure RuboCop RSpec to
+    # be able to properly detect these elements in the `RSpec/Language` section
+    # of the RuboCop YAML configuration file.
+    #
+    # In addition to providing useful matchers, this class is responsible for
+    # using the configured aliases.
     module Language
-      # Set of method selectors
-      class SelectorSet
-        def initialize(selectors)
-          @selectors = selectors
-        end
+      extend RuboCop::NodePattern::Macros
+
+      class << self
+        attr_accessor :config
+      end
+
+      # @!method rspec?(node)
+      def_node_matcher :rspec?, '{#explicit_rspec? nil?}'
+
+      # @!method explicit_rspec?(node)
+      def_node_matcher :explicit_rspec?, '(const {nil? cbase} :RSpec)'
+
+      # @!method example_group?(node)
+      def_node_matcher :example_group?, <<~PATTERN
+        ({block numblock} (send #rspec? #ExampleGroups.all ...) ...)
+      PATTERN
+
+      # @!method shared_group?(node)
+      def_node_matcher :shared_group?,
+                       '(block (send #rspec? #SharedGroups.all ...) ...)'
+
+      # @!method spec_group?(node)
+      def_node_matcher :spec_group?, <<~PATTERN
+        ({block numblock} (send #rspec?
+             {#SharedGroups.all #ExampleGroups.all}
+          ...) ...)
+      PATTERN
+
+      # @!method example_group_with_body?(node)
+      def_node_matcher :example_group_with_body?, <<~PATTERN
+        (block (send #rspec? #ExampleGroups.all ...) args !nil?)
+      PATTERN
 
-        def ==(other)
-          selectors.eql?(other.selectors)
+      # @!method example?(node)
+      def_node_matcher :example?, '(block (send nil? #Examples.all ...) ...)'
+
+      # @!method hook?(node)
+      def_node_matcher :hook?, <<~PATTERN
+        {
+          (numblock (send nil? #Hooks.all ...) ...)
+          (block (send nil? #Hooks.all ...) ...)
+        }
+      PATTERN
+
+      # @!method let?(node)
+      def_node_matcher :let?, <<~PATTERN
+        {
+          (block (send nil? #Helpers.all ...) ...)
+          (send nil? #Helpers.all _ block_pass)
+        }
+      PATTERN
+
+      # @!method include?(node)
+      def_node_matcher :include?, <<~PATTERN
+        {
+          (block (send nil? #Includes.all ...) ...)
+          (send nil? #Includes.all ...)
+        }
+      PATTERN
+
+      # @!method subject?(node)
+      def_node_matcher :subject?, '(block (send nil? #Subjects.all ...) ...)'
+
+      module ExampleGroups # :nodoc:
+        class << self
+          def all(element)
+            regular(element) ||
+              skipped(element) ||
+              focused(element)
+          end
+
+          def regular(element)
+            Language.config['ExampleGroups']['Regular'].include?(element.to_s)
+          end
+
+          def focused(element)
+            Language.config['ExampleGroups']['Focused'].include?(element.to_s)
+          end
+
+          def skipped(element)
+            Language.config['ExampleGroups']['Skipped'].include?(element.to_s)
+          end
         end
+      end
 
-        def +(other)
-          self.class.new(selectors + other.selectors)
+      module Examples # :nodoc:
+        class << self
+          def all(element)
+            regular(element) ||
+              focused(element) ||
+              skipped(element) ||
+              pending(element)
+          end
+
+          def regular(element)
+            Language.config['Examples']['Regular'].include?(element.to_s)
+          end
+
+          def focused(element)
+            Language.config['Examples']['Focused'].include?(element.to_s)
+          end
+
+          def skipped(element)
+            Language.config['Examples']['Skipped'].include?(element.to_s)
+          end
+
+          def pending(element)
+            Language.config['Examples']['Pending'].include?(element.to_s)
+          end
         end
+      end
 
-        def include?(selector)
-          selectors.include?(selector)
+      module Expectations # :nodoc:
+        def self.all(element)
+          Language.config['Expectations'].include?(element.to_s)
         end
+      end
 
-        def to_node_pattern
-          selectors.map(&:inspect).join(' ')
+      module Helpers # :nodoc:
+        def self.all(element)
+          Language.config['Helpers'].include?(element.to_s)
         end
+      end
 
-        protected
+      module Hooks # :nodoc:
+        def self.all(element)
+          Language.config['Hooks'].include?(element.to_s)
+        end
+      end
 
-        attr_reader :selectors
+      module HookScopes # :nodoc:
+        ALL = %i[each example context all suite].freeze
+        def self.all(element)
+          ALL.include?(element)
+        end
       end
 
-      module ExampleGroups
-        GROUPS  = SelectorSet.new(%i(describe context feature example_group))
-        SKIPPED = SelectorSet.new(%i(xdescribe xcontext xfeature))
-        FOCUSED = SelectorSet.new(%i(fdescribe fcontext ffeature))
+      module Includes # :nodoc:
+        class << self
+          def all(element)
+            examples(element) ||
+              context(element)
+          end
+
+          def examples(element)
+            Language.config['Includes']['Examples'].include?(element.to_s)
+          end
 
-        ALL = GROUPS + SKIPPED + FOCUSED
+          def context(element)
+            Language.config['Includes']['Context'].include?(element.to_s)
+          end
+        end
       end
 
-      module SharedGroups
-        ALL = SelectorSet.new(
-          %i(shared_examples shared_context shared_examples_for)
-        )
+      module Runners # :nodoc:
+        ALL = %i[to to_not not_to].freeze
+        class << self
+          def all(element = nil)
+            return ALL if element.nil?
+
+            ALL.include?(element)
+          end
+        end
       end
 
-      module Examples
-        EXAMPLES = SelectorSet.new(%i(it specify example scenario its))
-        FOCUSED  = SelectorSet.new(%i(fit fspecify fexample fscenario focus))
-        SKIPPED  = SelectorSet.new(%i(xit xspecify xexample xscenario skip))
-        PENDING  = SelectorSet.new(%i(pending))
+      module SharedGroups # :nodoc:
+        class << self
+          def all(element)
+            examples(element) ||
+              context(element)
+          end
 
-        ALL = EXAMPLES + FOCUSED + SKIPPED + PENDING
+          def examples(element)
+            Language.config['SharedGroups']['Examples'].include?(element.to_s)
+          end
+
+          def context(element)
+            Language.config['SharedGroups']['Context'].include?(element.to_s)
+          end
+        end
       end
 
-      module Hooks
-        ALL = SelectorSet.new(%i(after around before))
+      module Subjects # :nodoc:
+        def self.all(element)
+          Language.config['Subjects'].include?(element.to_s)
+        end
       end
 
-      module Helpers
-        ALL = SelectorSet.new(%i(let let!))
+      # This is used in Dialect and DescribeClass cops to detect RSpec blocks.
+      module ALL # :nodoc:
+        def self.all(element)
+          [ExampleGroups, Examples, Expectations, Helpers, Hooks, Includes,
+           Runners, SharedGroups, Subjects]
+            .find { |concept| concept.all(element) }
+        end
       end
 
-      ALL =
-        ExampleGroups::ALL +
-        SharedGroups::ALL  +
-        Examples::ALL      +
-        Hooks::ALL         +
-        Helpers::ALL
+      private_constant :ExampleGroups, :Examples, :Expectations, :Hooks,
+                       :Includes, :Runners, :SharedGroups, :ALL
     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 although it's not
+      # strictly literal.
+      def recursive_literal_or_const?
+        case type
+        when :begin, :pair, *AST::Node::COMPOSITE_LITERALS
+          children.compact.all?(&:recursive_literal_or_const?)
+        else
+          literal? || const_type?
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/rspec/shared_contexts/default_rspec_language_config_context.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+RSpec.shared_context 'with default RSpec/Language config' do
+  include_context 'config'
+
+  # Deep duplication is needed to prevent config leakage between examples
+  let(:other_cops) do
+    default_language = RuboCop::ConfigLoader
+      .default_configuration['RSpec']['Language']
+    default_include = RuboCop::ConfigLoader
+      .default_configuration['RSpec']['Include']
+    { 'RSpec' =>
+      {
+        'Include' => default_include,
+        'Language' => deep_dup(default_language)
+      } }
+  end
+
+  def deep_dup(object)
+    case object
+    when Array
+      object.map { |item| deep_dup(item) }
+    when Hash
+      object.transform_values { |value| deep_dup(value) }
+    else
+      object # only collections undergo modifications and need duping
+    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.7.0'.freeze
+      STRING = '3.0.2'
     end
   end
 end

data/lib/rubocop/rspec/wording.rb

@@ -4,44 +4,86 @@ module RuboCop
   module RSpec
     # RSpec example wording rewriter
     class Wording
+      SHOULDNT_PREFIX    = /\Ashould(?:n't| not)\b/i.freeze
+      SHOULDNT_BE_PREFIX = /#{SHOULDNT_PREFIX} be\b/i.freeze
+      WILL_NOT_PREFIX    = /\Awill not\b/i.freeze
+      WONT_PREFIX        = /\Awon't\b/i.freeze
+      ES_SUFFIX_PATTERN  = /(?:o|s|x|ch|sh|z)\z/i.freeze
+      IES_SUFFIX_PATTERN = /[^aeou]y\z/i.freeze
+
       def initialize(text, ignore:, replace:)
         @text         = text
         @ignores      = ignore
         @replacements = replace
       end
 
+      # rubocop:disable Metrics/MethodLength
       def rewrite
-        text.split.tap do |words|
-          first_word = words.shift
-          words.unshift('not') if first_word.eql?("shouldn't")
-
-          words.each_with_index do |value, key|
-            next if ignores.include?(value)
-            words[key] = simple_present(words.fetch(key))
-            break
-          end
-        end.join(' ')
+        case text
+        when SHOULDNT_BE_PREFIX
+          replace_prefix(SHOULDNT_BE_PREFIX, 'is not')
+        when SHOULDNT_PREFIX
+          replace_prefix(SHOULDNT_PREFIX, 'does not')
+        when WILL_NOT_PREFIX
+          replace_prefix(WILL_NOT_PREFIX, 'does not')
+        when WONT_PREFIX
+          replace_prefix(WONT_PREFIX, 'does not')
+        else
+          remove_should_and_pluralize
+        end
       end
+      # rubocop:enable Metrics/MethodLength
 
       private
 
       attr_reader :text, :ignores, :replacements
 
-      def simple_present(word)
-        return replacements.fetch(word) if replacements.key?(word)
+      def replace_prefix(pattern, replacement)
+        text.sub(pattern) do |matched|
+          uppercase?(matched) ? replacement.upcase : replacement
+        end
+      end
+
+      def uppercase?(word)
+        word.upcase.eql?(word)
+      end
+
+      def remove_should_and_pluralize
+        _should, *words = text.split
+
+        words.each_with_index do |word, index|
+          next if ignored_word?(word)
 
-        # ends with o s x ch sh or ss
-        if %w(o s x ch sh).any?(&word.public_method(:end_with?))
-          return "#{word}es"
+          words[index] = substitute(word)
+
+          break
         end
 
-        # ends with y
-        if word.end_with?('y') && !%w(a u o e).include?(word[-2])
-          return "#{word[0..-2]}ies"
+        words.join(' ')
+      end
+
+      def ignored_word?(word)
+        ignores.any? { |ignore| ignore.casecmp(word).zero? }
+      end
+
+      def substitute(word)
+        # NOTE: Custom replacements are case sensitive.
+        return replacements.fetch(word) if replacements.key?(word)
+
+        case word
+        when ES_SUFFIX_PATTERN  then append_suffix(word, 'es')
+        when IES_SUFFIX_PATTERN then append_suffix(word[0..-2], 'ies')
+        else append_suffix(word, 's')
         end
+      end
 
-        "#{word}s"
+      def append_suffix(word, suffix)
+        suffix = suffix.upcase if uppercase?(word)
+
+        "#{word}#{suffix}"
       end
+
+      private_constant(*constants(false))
     end
   end
 end

data/lib/rubocop/rspec.rb

@@ -1,10 +1,14 @@
+# 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.load(CONFIG_DEFAULT.read).freeze
 
-    private_constant(*constants(false))
+    private_constant(:CONFIG_DEFAULT, :PROJECT_ROOT)
+
+    ::RuboCop::ConfigObsoletion.files << PROJECT_ROOT.join('config',
+                                                           'obsoletion.yml')
   end
 end

data/lib/rubocop-rspec.rb

@@ -1,42 +1,53 @@
+# frozen_string_literal: true
+
 require 'pathname'
 require 'yaml'
 
 require 'rubocop'
 
-require 'rubocop/rspec'
-require 'rubocop/rspec/version'
-require 'rubocop/rspec/inject'
-require 'rubocop/rspec/top_level_describe'
-require 'rubocop/rspec/wording'
-require 'rubocop/rspec/util'
-require 'rubocop/rspec/language'
-require 'rubocop/rspec/language/node_pattern'
-require 'rubocop/rspec/spec_only'
+require_relative 'rubocop/rspec'
+require_relative 'rubocop/rspec/inject'
+require_relative 'rubocop/rspec/language'
+require_relative 'rubocop/rspec/node'
+require_relative 'rubocop/rspec/version'
+require_relative 'rubocop/rspec/wording'
+
+require_relative 'rubocop/cop/rspec/mixin/file_help'
+require_relative 'rubocop/cop/rspec/mixin/final_end_location'
+require_relative 'rubocop/cop/rspec/mixin/inside_example_group'
+require_relative 'rubocop/cop/rspec/mixin/location_help'
+require_relative 'rubocop/cop/rspec/mixin/metadata'
+require_relative 'rubocop/cop/rspec/mixin/namespace'
+require_relative 'rubocop/cop/rspec/mixin/skip_or_pending'
+require_relative 'rubocop/cop/rspec/mixin/top_level_group'
+require_relative 'rubocop/cop/rspec/mixin/variable'
+
+# Dependent on `RuboCop::Cop::RSpec::FinalEndLocation`.
+require_relative 'rubocop/cop/rspec/mixin/comments_help'
+require_relative 'rubocop/cop/rspec/mixin/empty_line_separation'
+
+require_relative 'rubocop/cop/rspec/base'
+require_relative 'rubocop/rspec/align_let_brace'
+require_relative 'rubocop/rspec/concept'
+require_relative 'rubocop/rspec/corrector/move_node'
+require_relative 'rubocop/rspec/example'
+require_relative 'rubocop/rspec/example_group'
+require_relative 'rubocop/rspec/hook'
 
 RuboCop::RSpec::Inject.defaults!
 
-# cops
-require 'rubocop/cop/rspec/any_instance'
-require 'rubocop/cop/rspec/be_eql'
-require 'rubocop/cop/rspec/describe_class'
-require 'rubocop/cop/rspec/describe_method'
-require 'rubocop/cop/rspec/described_class'
-require 'rubocop/cop/rspec/empty_example_group'
-require 'rubocop/cop/rspec/example_length'
-require 'rubocop/cop/rspec/example_wording'
-require 'rubocop/cop/rspec/expect_actual'
-require 'rubocop/cop/rspec/file_path'
-require 'rubocop/cop/rspec/focus'
-require 'rubocop/cop/rspec/hook_argument'
-require 'rubocop/cop/rspec/instance_variable'
-require 'rubocop/cop/rspec/leading_subject'
-require 'rubocop/cop/rspec/let_setup'
-require 'rubocop/cop/rspec/message_chain'
-require 'rubocop/cop/rspec/message_expectation'
-require 'rubocop/cop/rspec/multiple_describes'
-require 'rubocop/cop/rspec/multiple_expectations'
-require 'rubocop/cop/rspec/named_subject'
-require 'rubocop/cop/rspec/nested_groups'
-require 'rubocop/cop/rspec/not_to_not'
-require 'rubocop/cop/rspec/subject_stub'
-require 'rubocop/cop/rspec/verified_doubles'
+require_relative 'rubocop/cop/rspec_cops'
+
+# We have to register our autocorrect incompatibilities in RuboCop's cops
+# as well so we do not hit infinite loops
+
+RuboCop::Cop::Layout::ExtraSpacing.singleton_class.prepend(
+  Module.new do
+    def autocorrect_incompatible_with
+      super.push(RuboCop::Cop::RSpec::AlignLeftLetBrace)
+      .push(RuboCop::Cop::RSpec::AlignRightLetBrace)
+    end
+  end
+)
+
+RuboCop::AST::Node.include(RuboCop::RSpec::Node)