rubocop-rspec 1.7.0 → 3.0.2

data/lib/rubocop/cop/rspec_cops.rb

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+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_empty'
+require_relative 'rspec/be_eq'
+require_relative 'rspec/be_eql'
+require_relative 'rspec/be_nil'
+require_relative 'rspec/before_after_all'
+require_relative 'rspec/change_by_zero'
+require_relative 'rspec/class_check'
+require_relative 'rspec/contain_exactly'
+require_relative 'rspec/context_method'
+require_relative 'rspec/context_wording'
+require_relative 'rspec/describe_class'
+require_relative 'rspec/describe_method'
+require_relative 'rspec/describe_symbol'
+require_relative 'rspec/described_class'
+require_relative 'rspec/described_class_module_wrapping'
+require_relative 'rspec/dialect'
+require_relative 'rspec/duplicated_metadata'
+require_relative 'rspec/empty_example_group'
+require_relative 'rspec/empty_hook'
+require_relative 'rspec/empty_line_after_example'
+require_relative 'rspec/empty_line_after_example_group'
+require_relative 'rspec/empty_line_after_final_let'
+require_relative 'rspec/empty_line_after_hook'
+require_relative 'rspec/empty_line_after_subject'
+require_relative 'rspec/empty_metadata'
+require_relative 'rspec/empty_output'
+require_relative 'rspec/eq'
+require_relative 'rspec/example_length'
+require_relative 'rspec/example_without_description'
+require_relative 'rspec/example_wording'
+require_relative 'rspec/excessive_docstring_spacing'
+require_relative 'rspec/expect_actual'
+require_relative 'rspec/expect_change'
+require_relative 'rspec/expect_in_hook'
+require_relative 'rspec/expect_in_let'
+require_relative 'rspec/expect_output'
+require_relative 'rspec/focus'
+require_relative 'rspec/hook_argument'
+require_relative 'rspec/hooks_before_examples'
+require_relative 'rspec/identical_equality_assertion'
+require_relative 'rspec/implicit_block_expectation'
+require_relative 'rspec/implicit_expect'
+require_relative 'rspec/implicit_subject'
+require_relative 'rspec/indexed_let'
+require_relative 'rspec/instance_spy'
+require_relative 'rspec/instance_variable'
+require_relative 'rspec/is_expected_specify'
+require_relative 'rspec/it_behaves_like'
+require_relative 'rspec/iterated_expectation'
+require_relative 'rspec/leading_subject'
+require_relative 'rspec/leaky_constant_declaration'
+require_relative 'rspec/let_before_examples'
+require_relative 'rspec/let_setup'
+require_relative 'rspec/match_array'
+require_relative 'rspec/message_chain'
+require_relative 'rspec/message_expectation'
+require_relative 'rspec/message_spies'
+require_relative 'rspec/metadata_style'
+require_relative 'rspec/missing_example_group_argument'
+require_relative 'rspec/missing_expectation_target_method'
+require_relative 'rspec/multiple_describes'
+require_relative 'rspec/multiple_expectations'
+require_relative 'rspec/multiple_memoized_helpers'
+require_relative 'rspec/multiple_subjects'
+require_relative 'rspec/named_subject'
+require_relative 'rspec/nested_groups'
+require_relative 'rspec/no_expectation_example'
+require_relative 'rspec/not_to_not'
+require_relative 'rspec/overwriting_setup'
+require_relative 'rspec/pending'
+require_relative 'rspec/pending_without_reason'
+require_relative 'rspec/predicate_matcher'
+require_relative 'rspec/receive_counts'
+require_relative 'rspec/receive_messages'
+require_relative 'rspec/receive_never'
+require_relative 'rspec/redundant_around'
+require_relative 'rspec/redundant_predicate_matcher'
+require_relative 'rspec/remove_const'
+require_relative 'rspec/repeated_description'
+require_relative 'rspec/repeated_example'
+require_relative 'rspec/repeated_example_group_body'
+require_relative 'rspec/repeated_example_group_description'
+require_relative 'rspec/repeated_include_example'
+require_relative 'rspec/repeated_subject_call'
+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/skip_block_inside_example'
+require_relative 'rspec/sort_metadata'
+require_relative 'rspec/spec_file_path_format'
+require_relative 'rspec/spec_file_path_suffix'
+require_relative 'rspec/stubbed_mock'
+require_relative 'rspec/subject_declaration'
+require_relative 'rspec/subject_stub'
+require_relative 'rspec/undescriptive_literals_description'
+require_relative 'rspec/unspecified_exception'
+require_relative 'rspec/variable_definition'
+require_relative 'rspec/variable_name'
+require_relative 'rspec/verified_double_reference'
+require_relative 'rspec/verified_doubles'
+require_relative 'rspec/void_expect'
+require_relative 'rspec/yield'

data/lib/rubocop/rspec/align_let_brace.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module RSpec
+    # Shared behavior for aligning braces for single line lets
+    class AlignLetBrace
+      include RuboCop::RSpec::Language
+      include RuboCop::Cop::Util
+
+      def initialize(root, token)
+        @root  = root
+        @token = token
+      end
+
+      def offending_tokens
+        single_line_lets.reject do |let|
+          target_column_for(let) == let_token(let).column
+        end
+      end
+
+      def indent_for(node)
+        ' ' * (target_column_for(node) - let_token(node).column)
+      end
+
+      private
+
+      def let_token(node)
+        node.loc.public_send(token)
+      end
+
+      def target_column_for(let)
+        let_group_for(let).map { |member| let_token(member).column }.max
+      end
+
+      def let_group_for(let)
+        adjacent_let_chunks.detect do |chunk|
+          chunk.any? do |member|
+            member == let && same_line?(member, let)
+          end
+        end
+      end
+
+      def adjacent_let_chunks
+        last_line = nil
+
+        single_line_lets.chunk do |node|
+          line      = node.loc.line
+          last_line = (line if last_line.nil? || last_line + 1 == line)
+          last_line.nil?
+        end.map(&:last)
+      end
+
+      def single_line_lets
+        @single_line_lets ||=
+          root.each_node(:block).select do |node|
+            let?(node) && node.single_line?
+          end
+      end
+
+      attr_reader :root, :token
+    end
+  end
+end

data/lib/rubocop/rspec/concept.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module RSpec
+    # Wrapper for RSpec DSL methods
+    class Concept
+      extend RuboCop::NodePattern::Macros
+      include Language
+
+      def initialize(node)
+        @node = node
+      end
+
+      def eql?(other)
+        node == other.node
+      end
+
+      alias == eql?
+
+      def hash
+        [self.class, node].hash
+      end
+
+      def to_node
+        node
+      end
+
+      protected
+
+      attr_reader :node
+    end
+  end
+end

data/lib/rubocop/rspec/config_formatter.rb

@@ -1,10 +1,15 @@
+# frozen_string_literal: true
+
 require 'yaml'
 
 module RuboCop
   module RSpec
     # Builds a YAML config file from two config hashes
     class ConfigFormatter
-      NAMESPACE = 'RSpec'.freeze
+      EXTENSION_ROOT_DEPARTMENT = %r{^(RSpec/)}.freeze
+      SUBDEPARTMENTS = [].freeze
+      AMENDMENTS = %(Metrics/BlockLength)
+      COP_DOC_BASE_URL = 'https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/'
 
       def initialize(config, descriptions)
         @config       = config
@@ -12,19 +17,37 @@ module RuboCop
       end
 
       def dump
-        YAML.dump(unified_config).gsub(/^#{NAMESPACE}/, "\n#{NAMESPACE}")
+        YAML.dump(unified_config)
+          .gsub(EXTENSION_ROOT_DEPARTMENT, "\n\\1")
+          .gsub(*AMENDMENTS, "\n\\0")
+          .gsub(/^(\s+)- /, '\1  - ')
+          .gsub('"~"', '~')
       end
 
       private
 
       def unified_config
         cops.each_with_object(config.dup) do |cop, unified|
-          unified[cop] = config.fetch(cop).merge(descriptions.fetch(cop))
+          next if SUBDEPARTMENTS.include?(cop) || AMENDMENTS.include?(cop)
+
+          replace_nil(unified[cop])
+          unified[cop].merge!(descriptions.fetch(cop))
+          unified[cop]['Reference'] = reference(cop)
         end
       end
 
       def cops
-        (descriptions.keys + config.keys).uniq.grep(/\A#{NAMESPACE}/)
+        (descriptions.keys | config.keys).grep(EXTENSION_ROOT_DEPARTMENT)
+      end
+
+      def replace_nil(config)
+        config.each do |key, value|
+          config[key] = '~' if value.nil?
+        end
+      end
+
+      def reference(cop)
+        COP_DOC_BASE_URL + cop
       end
 
       attr_reader :config, :descriptions

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module RSpec
+    module Cop
+      # Source and spec generator for new cops
+      #
+      # This generator will take a cop name and generate a source file
+      # and spec file when given a valid qualified cop name.
+      # @api private
+      class Generator < RuboCop::Cop::Generator
+        def todo
+          <<~TODO
+            Do 4 steps:
+              1. Modify the description of #{badge} in config/default.yml
+              2. Implement your new cop in the generated file!
+              3. Add an entry about new cop to CHANGELOG.md
+              4. Commit your new cop with a message such as
+                 e.g. "Add new `#{badge}` cop"
+          TODO
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/rspec/corrector/move_node.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module RSpec
+    module Corrector
+      # Helper methods to move a node
+      class MoveNode
+        include RuboCop::Cop::RangeHelp
+        include RuboCop::Cop::RSpec::CommentsHelp
+        include RuboCop::Cop::RSpec::FinalEndLocation
+
+        attr_reader :original, :corrector, :processed_source
+
+        def initialize(node, corrector, processed_source)
+          @original = node
+          @corrector = corrector
+          @processed_source = processed_source # used by RangeHelp
+        end
+
+        def move_before(other)
+          position = start_line_position(other)
+
+          corrector.insert_before(position, "#{source(original)}\n")
+          corrector.remove(node_range_with_surrounding_space(original))
+        end
+
+        def move_after(other)
+          position = end_line_position(other)
+
+          corrector.insert_after(position, "\n#{source(original)}")
+          corrector.remove(node_range_with_surrounding_space(original))
+        end
+
+        private
+
+        def source(node)
+          node_range(node).source
+        end
+
+        def node_range(node)
+          source_range_with_comment(node)
+        end
+
+        def node_range_with_surrounding_space(node)
+          range = node_range(node)
+          range_by_whole_lines(range, include_final_newline: true)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/rspec/description_extractor.rb

@@ -1,35 +1,77 @@
+# frozen_string_literal: true
+
 module RuboCop
   module RSpec
     # Extracts cop descriptions from YARD docstrings
     class DescriptionExtractor
-      COP_NAMESPACE = 'RuboCop::Cop::RSpec'.freeze
-      COP_FORMAT    = 'RSpec/%s'.freeze
-
       def initialize(yardocs)
-        @yardocs = yardocs
+        @code_objects = yardocs.map(&CodeObject.public_method(:new))
       end
 
       def to_h
-        cop_documentation.each_with_object({}) do |(name, docstring), config|
-          config[format(COP_FORMAT, name)] = {
-            'Description' => docstring.split("\n\n").first.to_s
-          }
-        end
+        code_objects
+          .select(&:rspec_cop?)
+          .map(&:configuration)
+          .reduce(:merge)
       end
 
       private
 
-      def cop_documentation
-        yardocs
-          .select(&method(:cop?))
-          .map { |doc| [doc.name, doc.docstring] }
-      end
+      attr_reader :code_objects
 
-      def cop?(doc)
-        doc.type.equal?(:class) && doc.to_s.start_with?(COP_NAMESPACE)
-      end
+      # Decorator of a YARD code object for working with documented rspec cops
+      class CodeObject
+        RSPEC_COP_CLASS_NAME = 'RuboCop::Cop::RSpec::Base'
+        RUBOCOP_COP_CLASS_NAME = 'RuboCop::Cop::Base'
+        RSPEC_NAMESPACE = 'RuboCop::Cop::RSpec'
+
+        def initialize(yardoc)
+          @yardoc = yardoc
+        end
 
-      attr_reader :yardocs
+        # Test if the YARD code object documents a concrete rspec cop class
+        #
+        # @return [Boolean]
+        def rspec_cop?
+          cop_subclass? && !abstract? && rspec_cop_namespace?
+        end
+
+        # Configuration for the documented cop that would live in default.yml
+        #
+        # @return [Hash]
+        def configuration
+          { cop_name => { 'Description' => description } }
+        end
+
+        private
+
+        def cop_name
+          Object.const_get(documented_constant).cop_name
+        end
+
+        def description
+          yardoc.docstring.split("\n\n").first.to_s
+        end
+
+        def rspec_cop_namespace?
+          documented_constant.start_with?(RSPEC_NAMESPACE)
+        end
+
+        def documented_constant
+          yardoc.to_s
+        end
+
+        def cop_subclass?
+          yardoc.superclass.path == RSPEC_COP_CLASS_NAME ||
+            yardoc.superclass.path == RUBOCOP_COP_CLASS_NAME
+        end
+
+        def abstract?
+          yardoc.tags.any? { |tag| tag.tag_name.eql?('abstract') }
+        end
+
+        attr_reader :yardoc
+      end
     end
   end
 end

data/lib/rubocop/rspec/example.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module RSpec
+    # Wrapper for RSpec examples
+    class Example < Concept
+      # @!method extract_doc_string(node)
+      def_node_matcher :extract_doc_string,     '(send _ _ $_ ...)'
+
+      # @!method extract_metadata(node)
+      def_node_matcher :extract_metadata,       '(send _ _ _ $...)'
+
+      # @!method extract_implementation(node)
+      def_node_matcher :extract_implementation, '(block send args $_)'
+
+      def doc_string
+        extract_doc_string(definition)
+      end
+
+      def metadata
+        extract_metadata(definition)
+      end
+
+      def implementation
+        extract_implementation(node)
+      end
+
+      def definition
+        if node.send_type?
+          node
+        else
+          node.send_node
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/rspec/example_group.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module RSpec
+    # Wrapper for RSpec example groups
+    class ExampleGroup < Concept
+      # @!method scope_change?(node)
+      #
+      #   Detect if the node is an example group or shared example
+      #
+      #   Selectors which indicate that we should stop searching
+      #
+      def_node_matcher :scope_change?, <<~PATTERN
+        (block {
+          (send #rspec? {#SharedGroups.all #ExampleGroups.all} ...)
+          (send nil? #Includes.all ...)
+        } ...)
+      PATTERN
+
+      def lets
+        find_all_in_scope(node, :let?)
+      end
+
+      def subjects
+        find_all_in_scope(node, :subject?)
+      end
+
+      def examples
+        find_all_in_scope(node, :example?).map do |node|
+          Example.new(node)
+        end
+      end
+
+      def hooks
+        find_all_in_scope(node, :hook?).map do |node|
+          Hook.new(node)
+        end
+      end
+
+      private
+
+      # Recursively search for predicate within the current scope
+      #
+      # Searches node and halts when a scope change is detected
+      #
+      # @param node [RuboCop::AST::Node] node to recursively search
+      # @param predicate [Symbol] method to call with node as argument
+      #
+      # @return [Array<RuboCop::AST::Node>] discovered nodes
+      def find_all_in_scope(node, predicate)
+        node.each_child_node.flat_map do |child|
+          find_all(child, predicate)
+        end
+      end
+
+      def find_all(node, predicate)
+        if public_send(predicate, node)
+          [node]
+        elsif scope_change?(node) || example?(node)
+          []
+        else
+          find_all_in_scope(node, predicate)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/rspec/hook.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module RSpec
+    # Wrapper for RSpec hook
+    class Hook < Concept
+      # @!method extract_metadata(node)
+      def_node_matcher :extract_metadata, <<~PATTERN
+        (block
+          (send _ _ #valid_scope? ? $...) ...
+        )
+      PATTERN
+
+      def name
+        node.method_name
+      end
+
+      def knowable_scope?
+        scope_argument.nil? ||
+          scope_argument.sym_type? ||
+          scope_argument.hash_type?
+      end
+
+      def example?
+        scope.equal?(:each)
+      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
+        end
+      end
+
+      def metadata
+        (extract_metadata(node) || [])
+          .map { |meta| transform_metadata(meta) }
+          .flatten
+          .inject(&:merge)
+      end
+
+      private
+
+      def valid_scope?(node)
+        node&.sym_type? && Language::HookScopes.all(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
+
+      def scope_argument
+        node.send_node.first_argument
+      end
+    end
+  end
+end

data/lib/rubocop/rspec/inject.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RuboCop
   module RSpec
     # Because RuboCop doesn't yet support plugins, we have to monkey patch in a
@@ -6,7 +8,7 @@ module RuboCop
       def self.defaults!
         path = CONFIG_DEFAULT.to_s
         hash = ConfigLoader.send(:load_yaml_configuration, path)
-        config = Config.new(hash, path)
+        config = RuboCop::Config.new(hash, path)
         puts "configuration from #{path}" if ConfigLoader.debug?
         config = ConfigLoader.merge_with_default(config, path)
         ConfigLoader.instance_variable_set(:@default_configuration, config)