rubocop-rspec 2.0.0.pre → 2.3.0

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

@@ -18,12 +18,12 @@ module RuboCop
       #     # ...
       #   end
       #
-      # @see https://github.com/rubocop-hq/rubocop-rspec/issues/735
+      # @see https://github.com/rubocop/rubocop-rspec/issues/735
       class DescribedClassModuleWrapping < Base
         MSG = 'Avoid opening modules and defining specs within them.'
 
-        def_node_search :find_rspec_blocks,
-                        ExampleGroups::ALL.block_pattern
+        # @!method find_rspec_blocks(node)
+        def_node_search :find_rspec_blocks, block_pattern('#ExampleGroups.all')
 
         def on_module(node)
           find_rspec_blocks(node) do

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

@@ -47,7 +47,8 @@ module RuboCop
 
         MSG = 'Prefer `%<prefer>s` over `%<current>s`.'
 
-        def_node_matcher :rspec_method?, ALL.send_pattern
+        # @!method rspec_method?(node)
+        def_node_matcher :rspec_method?, send_pattern('#ALL.all')
 
         def on_send(node)
           return unless rspec_method?(node)

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

@@ -5,8 +5,6 @@ module RuboCop
     module RSpec
       # Checks if an example group does not include any tests.
       #
-      # This cop is configurable using the `CustomIncludeMethods` option
-      #
       # @example usage
       #
       #   # bad
@@ -37,31 +35,6 @@ module RuboCop
       #   describe Bacon do
       #     pending 'will add tests later'
       #   end
-      #
-      # @example configuration
-      #
-      #   # .rubocop.yml
-      #   # RSpec/EmptyExampleGroup:
-      #   #   CustomIncludeMethods:
-      #   #   - include_tests
-      #
-      #   # spec_helper.rb
-      #   RSpec.configure do |config|
-      #     config.alias_it_behaves_like_to(:include_tests)
-      #   end
-      #
-      #   # bacon_spec.rb
-      #   describe Bacon do
-      #     let(:bacon)      { Bacon.new(chunkiness) }
-      #     let(:chunkiness) { false                 }
-      #
-      #     context 'extra chunky' do   # not flagged by rubocop
-      #       let(:chunkiness) { true }
-      #
-      #       include_tests 'shared tests'
-      #     end
-      #   end
-      #
       class EmptyExampleGroup < Base
         MSG = 'Empty example group detected.'
 
@@ -76,7 +49,7 @@ module RuboCop
         #   @param node [RuboCop::AST::Node]
         #   @yield [RuboCop::AST::Node] example group body
         def_node_matcher :example_group_body, <<~PATTERN
-          (block #{ExampleGroups::ALL.send_pattern} args $_)
+          (block #{send_pattern('#ExampleGroups.all')} args $_)
         PATTERN
 
         # @!method example_or_group_or_include?(node)
@@ -95,12 +68,10 @@ module RuboCop
         #   @return [Array<RuboCop::AST::Node>] matching nodes
         def_node_matcher :example_or_group_or_include?, <<~PATTERN
           {
-            #{Examples::ALL.send_pattern}
-            #{Examples::ALL.block_pattern}
-            #{ExampleGroups::ALL.block_pattern}
-            #{Includes::ALL.send_pattern}
-            #{Includes::ALL.block_pattern}
-            (send nil? #custom_include? ...)
+            #{block_pattern(
+              '{#Examples.all #ExampleGroups.all #Includes.all}'
+            )}
+            #{send_pattern('{#Examples.all #Includes.all}')}
           }
         PATTERN
 
@@ -120,7 +91,7 @@ module RuboCop
         #   @param node [RuboCop::AST::Node]
         #   @return [Array<RuboCop::AST::Node>] matching nodes
         def_node_matcher :examples_inside_block?, <<~PATTERN
-          (block !#{Hooks::ALL.send_pattern} _ #examples?)
+          (block !#{send_pattern('#Hooks.all')} _ #examples?)
         PATTERN
 
         # @!method examples_directly_or_in_block?(node)
@@ -192,16 +163,6 @@ module RuboCop
         def examples_in_branches?(if_node)
           if_node.branches.any? { |branch| examples?(branch) }
         end
-
-        def custom_include?(method_name)
-          custom_include_methods.include?(method_name)
-        end
-
-        def custom_include_methods
-          cop_config
-            .fetch('CustomIncludeMethods', [])
-            .map(&:to_sym)
-        end
       end
     end
   end

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

@@ -28,8 +28,9 @@ module RuboCop
 
         MSG = 'Empty hook detected.'
 
+        # @!method empty_hook?(node)
         def_node_matcher :empty_hook?, <<~PATTERN
-          (block $#{Hooks::ALL.send_pattern} _ nil?)
+          (block $#{send_pattern('#Hooks.all')} _ nil?)
         PATTERN
 
         def on_block(node)

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

@@ -43,7 +43,7 @@ module RuboCop
       #
       class EmptyLineAfterExample < Base
         extend AutoCorrector
-        include RuboCop::RSpec::EmptyLineSeparation
+        include EmptyLineSeparation
 
         MSG = 'Add an empty line after `%<example>s`.'
 

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

@@ -25,7 +25,7 @@ module RuboCop
       #
       class EmptyLineAfterExampleGroup < Base
         extend AutoCorrector
-        include RuboCop::RSpec::EmptyLineSeparation
+        include EmptyLineSeparation
 
         MSG = 'Add an empty line after `%<example_group>s`.'
 

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

@@ -18,7 +18,7 @@ module RuboCop
       #   it { does_something }
       class EmptyLineAfterFinalLet < Base
         extend AutoCorrector
-        include RuboCop::RSpec::EmptyLineSeparation
+        include EmptyLineSeparation
 
         MSG = 'Add an empty line after the last `%<let>s`.'
 

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

@@ -35,7 +35,7 @@ module RuboCop
       #
       class EmptyLineAfterHook < Base
         extend AutoCorrector
-        include RuboCop::RSpec::EmptyLineSeparation
+        include EmptyLineSeparation
 
         MSG = 'Add an empty line after `%<hook>s`.'
 

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

@@ -16,7 +16,7 @@ module RuboCop
       #   let(:foo) { bar }
       class EmptyLineAfterSubject < Base
         extend AutoCorrector
-        include RuboCop::RSpec::EmptyLineSeparation
+        include EmptyLineSeparation
 
         MSG = 'Add an empty line after `%<subject>s`.'
 
@@ -32,7 +32,7 @@ module RuboCop
 
         def in_spec_block?(node)
           node.each_ancestor(:block).any? do |ancestor|
-            Examples::ALL.include?(ancestor.method_name)
+            Examples.all(ancestor.method_name)
           end
         end
       end

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

@@ -25,29 +25,43 @@ module RuboCop
       #     result = service.call
       #     expect(result).to be(true)
       #   end
+      #
+      # You can set literals you want to fold with `CountAsOne`.
+      # Available are: 'array', 'hash', and 'heredoc'. Each literal
+      # will be counted as one line regardless of its actual size.
+      #
+      # @example CountAsOne: ['array', 'heredoc']
+      #
+      #   it do
+      #     array = [         # +1
+      #       1,
+      #       2
+      #     ]
+      #
+      #     hash = {          # +3
+      #       key: 'value'
+      #     }
+      #
+      #     msg = <<~HEREDOC  # +1
+      #       Heredoc
+      #       content.
+      #     HEREDOC
+      #   end                 # 5 points
       class ExampleLength < Base
         include CodeLength
 
-        MSG = 'Example has too many lines [%<total>d/%<max>d].'
+        LABEL = 'Example'
 
         def on_block(node)
           return unless example?(node)
 
-          length = code_length(node)
-
-          return unless length > max_length
-
-          add_offense(node, message: message(length))
+          check_code_length(node)
         end
 
         private
 
-        def code_length(node)
-          node.source.lines[1..-2].count { |line| !irrelevant_line(line) }
-        end
-
-        def message(length)
-          format(MSG, total: length, max: max_length)
+        def cop_label
+          LABEL
         end
       end
     end

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

@@ -54,6 +54,7 @@ module RuboCop
                                'have auto-generated description.'
         MSG_ADD_DESCRIPTION  = 'Add a description.'
 
+        # @!method example_description(node)
         def_node_matcher :example_description, '(send nil? _ $(str $_))'
 
         def on_block(node)

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

@@ -38,6 +38,7 @@ module RuboCop
         SHOULD_PREFIX = /\Ashould(?:n't)?\b/i.freeze
         IT_PREFIX     = /\Ait /i.freeze
 
+        # @!method it_description(node)
         def_node_matcher :it_description, <<-PATTERN
           (block (send _ :it ${
             (str $_)

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

@@ -45,10 +45,11 @@ module RuboCop
 
         SUPPORTED_MATCHERS = %i[eq eql equal be].freeze
 
+        # @!method expect_literal(node)
         def_node_matcher :expect_literal, <<~PATTERN
           (send
             (send nil? :expect $#literal?)
-            #{Runners::ALL.node_pattern_union}
+            #Runners.all
             {
               (send (send nil? $:be) :== $_)
               (send nil? $_ $_ ...)
@@ -60,6 +61,7 @@ module RuboCop
           expect_literal(node) do |actual, matcher, expected|
             add_offense(actual.source_range) do |corrector|
               next unless SUPPORTED_MATCHERS.include?(matcher)
+              next if literal?(expected)
 
               swap(corrector, actual, expected)
             end

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

@@ -35,11 +35,14 @@ module RuboCop
 
         MSG_BLOCK = 'Prefer `change(%<obj>s, :%<attr>s)`.'
         MSG_CALL = 'Prefer `change { %<obj>s.%<attr>s }`.'
+        RESTRICT_ON_SEND = %i[change].freeze
 
+        # @!method expect_change_with_arguments(node)
         def_node_matcher :expect_change_with_arguments, <<-PATTERN
           (send nil? :change ({const send} nil? $_) (sym $_))
         PATTERN
 
+        # @!method expect_change_with_block(node)
         def_node_matcher :expect_change_with_block, <<-PATTERN
           (block
             (send nil? :change)

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

@@ -23,7 +23,8 @@ module RuboCop
       class ExpectInHook < Base
         MSG = 'Do not use `%<expect>s` in `%<hook>s` hook'
 
-        def_node_search :expectation, Expectations::ALL.send_pattern
+        # @!method expectation(node)
+        def_node_search :expectation, send_pattern('#Expectations.all')
 
         def on_block(node)
           return unless hook?(node)

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

@@ -15,7 +15,7 @@ module RuboCop
       #   # good
       #   expect { my_app.print_report }.to output('Hello World').to_stdout
       class ExpectOutput < Base
-        MSG = 'Use `expect { ... }.to output(...).to_%<name>s` '\
+        MSG = 'Use `expect { ... }.to output(...).to_%<name>s` ' \
               'instead of mutating $%<name>s.'
 
         def on_gvasgn(node)

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

@@ -29,10 +29,12 @@ module RuboCop
 
           MSG = 'Use a block to declare attribute values.'
 
+          # @!method value_matcher(node)
           def_node_matcher :value_matcher, <<-PATTERN
             (send _ !#reserved_method? $...)
           PATTERN
 
+          # @!method factory_attributes(node)
           def_node_matcher :factory_attributes, <<-PATTERN
             (block (send _ #attribute_defining_method? ...) _ { (begin $...) $(send ...) } )
           PATTERN
@@ -79,6 +81,7 @@ module RuboCop
             value_matcher(attribute).to_a.all?(&:block_pass_type?)
           end
 
+          # @!method association?(node)
           def_node_matcher :association?, '(hash <(pair (sym :factory) _) ...>)'
 
           def autocorrect_replacing_parens(corrector, node)

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

@@ -30,7 +30,9 @@ module RuboCop
 
           MSG_CREATE_LIST = 'Prefer create_list.'
           MSG_N_TIMES = 'Prefer %<number>s.times.'
+          RESTRICT_ON_SEND = %i[create_list].freeze
 
+          # @!method n_times_block_without_arg?(node)
           def_node_matcher :n_times_block_without_arg?, <<-PATTERN
             (block
               (send (int _) :times)
@@ -39,10 +41,12 @@ module RuboCop
             )
           PATTERN
 
+          # @!method factory_call(node)
           def_node_matcher :factory_call, <<-PATTERN
             (send ${(const nil? {:FactoryGirl :FactoryBot}) nil?} :create (sym $_) $...)
           PATTERN
 
+          # @!method factory_list_call(node)
           def_node_matcher :factory_list_call, <<-PATTERN
             (send {(const nil? {:FactoryGirl :FactoryBot}) nil?} :create_list (sym _) (int $_) ...)
           PATTERN

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

@@ -25,7 +25,9 @@ module RuboCop
           MSG = "Pass '%<class_name>s' string instead of `%<class_name>s` " \
                 'constant.'
           ALLOWED_CONSTANTS = %w[Hash OpenStruct].freeze
+          RESTRICT_ON_SEND = %i[factory].freeze
 
+          # @!method class_name(node)
           def_node_matcher :class_name, <<~PATTERN
             (send _ :factory _ (hash <(pair (sym :class) $(const ...)) ...>))
           PATTERN

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

@@ -57,16 +57,18 @@ module RuboCop
       #   my_class_spec.rb         # describe MyClass, '#method'
       #
       class FilePath < Base
-        include RuboCop::RSpec::TopLevelGroup
+        include TopLevelGroup
 
         MSG = 'Spec path should end with `%<suffix>s`.'
 
+        # @!method const_described(node)
         def_node_matcher :const_described, <<~PATTERN
           (block
             $(send #rspec? _example_group $(const ...) $...) ...
           )
         PATTERN
 
+        # @!method routing_metadata?(node)
         def_node_search :routing_metadata?, '(pair (sym :type) (sym :routing))'
 
         def on_top_level_example_group(node)
@@ -82,30 +84,39 @@ module RuboCop
         private
 
         def ensure_correct_file_path(send_node, described_class, arguments)
-          glob = glob_for(described_class, arguments.first)
-          return if filename_ends_with?(glob)
-
-          add_offense(send_node, message: format(MSG, suffix: glob))
+          pattern = pattern_for(described_class, arguments.first)
+          return if filename_ends_with?(pattern)
+
+          # For the suffix shown in the offense message, modify the regular
+          # expression pattern to resemble a glob pattern for clearer error
+          # messages.
+          offense_suffix = pattern.gsub('.*', '*').sub('[^/]', '')
+            .sub('\.', '.')
+          add_offense(send_node, message: format(MSG, suffix: offense_suffix))
         end
 
         def routing_spec?(args)
           args.any?(&method(:routing_metadata?))
         end
 
-        def glob_for(described_class, method_name)
-          return glob_for_spec_suffix_only? if spec_suffix_only?
+        def pattern_for(described_class, method_name)
+          return pattern_for_spec_suffix_only? if spec_suffix_only?
 
-          "#{expected_path(described_class)}#{name_glob(method_name)}*_spec.rb"
+          [
+            expected_path(described_class),
+            name_pattern(method_name),
+            '[^/]*_spec\.rb'
+          ].join
         end
 
-        def glob_for_spec_suffix_only?
-          '*_spec.rb'
+        def pattern_for_spec_suffix_only?
+          '.*_spec\.rb'
         end
 
-        def name_glob(method_name)
+        def name_pattern(method_name)
           return unless method_name&.str_type?
 
-          "*#{method_name.str_content.gsub(/\W/, '')}" unless ignore_methods?
+          ".*#{method_name.str_content.gsub(/\W/, '')}" unless ignore_methods?
         end
 
         def expected_path(constant)
@@ -131,11 +142,9 @@ module RuboCop
           cop_config['IgnoreMethods']
         end
 
-        def filename_ends_with?(glob)
-          filename =
-            RuboCop::PathUtil.relative_path(processed_source.buffer.name)
-              .gsub('../', '')
-          File.fnmatch?("*#{glob}", filename)
+        def filename_ends_with?(pattern)
+          filename = File.expand_path(processed_source.buffer.name)
+          filename.match?("#{pattern}$")
         end
 
         def relevant_rubocop_rspec_file?(_file)