rubocop-rspec 2.21.0 → 2.23.0

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

@@ -4,256 +4,36 @@ module RuboCop
   module Cop
     module RSpec
       module FactoryBot
-        # Checks for create_list usage.
-        #
-        # This cop can be configured using the `EnforcedStyle` option
-        #
-        # @example `EnforcedStyle: create_list` (default)
-        #   # bad
-        #   3.times { create :user }
-        #
-        #   # good
-        #   create_list :user, 3
-        #
-        #   # bad
-        #   3.times { create :user, age: 18 }
-        #
-        #   # good - index is used to alter the created models attributes
-        #   3.times { |n| create :user, age: n }
-        #
-        #   # good - contains a method call, may return different values
-        #   3.times { create :user, age: rand }
-        #
-        # @example `EnforcedStyle: n_times`
-        #   # bad
-        #   create_list :user, 3
-        #
-        #   # good
-        #   3.times { create :user }
-        #
-        class CreateList < ::RuboCop::Cop::Base
-          extend AutoCorrector
-          include ConfigurableEnforcedStyle
-          include RuboCop::RSpec::FactoryBot::Language
-
-          MSG_CREATE_LIST = 'Prefer create_list.'
-          MSG_N_TIMES = 'Prefer %<number>s.times.'
-          RESTRICT_ON_SEND = %i[create_list].freeze
-
-          # @!method array_new_or_n_times_block?(node)
-          def_node_matcher :array_new_or_n_times_block?, <<-PATTERN
-            (block
-              {
-                (send (const {nil? | cbase} :Array) :new (int _)) |
-                (send (int _) :times)
-              }
-              ...
-            )
-          PATTERN
-
-          # @!method block_with_arg_and_used?(node)
-          def_node_matcher :block_with_arg_and_used?, <<-PATTERN
-            (block
-              _
-              (args (arg _value))
-              `_value
-            )
-          PATTERN
-
-          # @!method arguments_include_method_call?(node)
-          def_node_matcher :arguments_include_method_call?, <<-PATTERN
-            (send ${nil? #factory_bot?} :create (sym $_) `$(send ...))
-          PATTERN
-
-          # @!method factory_call(node)
-          def_node_matcher :factory_call, <<-PATTERN
-            (send ${nil? #factory_bot?} :create (sym $_) $...)
-          PATTERN
-
-          # @!method factory_list_call(node)
-          def_node_matcher :factory_list_call, <<-PATTERN
-            (send {nil? #factory_bot?} :create_list (sym _) (int $_) ...)
-          PATTERN
-
-          def on_block(node) # rubocop:todo InternalAffairs/NumblockHandler
-            return unless style == :create_list
-
-            return unless array_new_or_n_times_block?(node)
-            return if block_with_arg_and_used?(node)
-            return unless node.body
-            return if arguments_include_method_call?(node.body)
-            return unless contains_only_factory?(node.body)
-
-            add_offense(node.send_node, message: MSG_CREATE_LIST) do |corrector|
-              CreateListCorrector.new(node.send_node).call(corrector)
-            end
-          end
-
-          def on_send(node)
-            return unless style == :n_times
-
-            factory_list_call(node) do |count|
-              message = format(MSG_N_TIMES, number: count)
-              add_offense(node.loc.selector, message: message) do |corrector|
-                TimesCorrector.new(node).call(corrector)
-              end
-            end
-          end
-
-          private
-
-          def contains_only_factory?(node)
-            if node.block_type?
-              factory_call(node.send_node)
-            else
-              factory_call(node)
-            end
-          end
-
-          # :nodoc
-          module Corrector
-            private
-
-            def build_options_string(options)
-              options.map(&:source).join(', ')
-            end
-
-            def format_method_call(node, method, arguments)
-              if node.block_type? || node.parenthesized?
-                "#{method}(#{arguments})"
-              else
-                "#{method} #{arguments}"
-              end
-            end
-
-            def format_receiver(receiver)
-              return '' unless receiver
-
-              "#{receiver.source}."
-            end
-          end
-
-          # :nodoc
-          class TimesCorrector
-            include Corrector
-
-            def initialize(node)
-              @node = node
-            end
-
-            def call(corrector)
-              replacement = generate_n_times_block(node)
-              corrector.replace(node.block_node || node, replacement)
-            end
-
-            private
-
-            attr_reader :node
-
-            def generate_n_times_block(node)
-              factory, count, *options = node.arguments
-
-              arguments = factory.source
-              options = build_options_string(options)
-              arguments += ", #{options}" unless options.empty?
-
-              replacement = format_receiver(node.receiver)
-              replacement += format_method_call(node, 'create', arguments)
-              replacement += " #{factory_call_block_source}" if node.block_node
-              "#{count.source}.times { #{replacement} }"
-            end
-
-            def factory_call_block_source
-              node.block_node.location.begin.with(
-                end_pos: node.block_node.location.end.end_pos
-              ).source
-            end
-          end
-
-          # :nodoc:
-          class CreateListCorrector
-            include Corrector
-
-            def initialize(node)
-              @node = node.parent
-            end
-
-            def call(corrector)
-              replacement = if node.body.block_type?
-                              call_with_block_replacement(node)
-                            else
-                              call_replacement(node)
-                            end
-
-              corrector.replace(node, replacement)
-            end
-
-            private
-
-            attr_reader :node
-
-            def call_with_block_replacement(node)
-              block = node.body
-              arguments = build_arguments(block, count_from(node))
-              replacement = format_receiver(block.receiver)
-              replacement += format_method_call(block, 'create_list', arguments)
-              replacement += format_block(block)
-              replacement
-            end
-
-            def build_arguments(node, count)
-              factory, *options = *node.send_node.arguments
-
-              arguments = ":#{factory.value}, #{count}"
-              options = build_options_string(options)
-              arguments += ", #{options}" unless options.empty?
-              arguments
-            end
-
-            def call_replacement(node)
-              block = node.body
-              factory, *options = *block.arguments
-
-              arguments = "#{factory.source}, #{count_from(node)}"
-              options = build_options_string(options)
-              arguments += ", #{options}" unless options.empty?
-
-              replacement = format_receiver(block.receiver)
-              replacement += format_method_call(block, 'create_list', arguments)
-              replacement
-            end
-
-            def count_from(node)
-              count_node =
-                if node.receiver.int_type?
-                  node.receiver
-                else
-                  node.send_node.first_argument
-                end
-              count_node.source
-            end
-
-            def format_block(node)
-              if node.body.begin_type?
-                format_multiline_block(node)
-              else
-                format_singleline_block(node)
-              end
-            end
-
-            def format_multiline_block(node)
-              indent = ' ' * node.body.loc.column
-              indent_end = ' ' * node.parent.loc.column
-              " do #{node.arguments.source}\n" \
-                "#{indent}#{node.body.source}\n" \
-                "#{indent_end}end"
-            end
-
-            def format_singleline_block(node)
-              " { #{node.arguments.source} #{node.body.source} }"
-            end
-          end
-        end
+        # @!parse
+        #   # Checks for create_list usage.
+        #   #
+        #   # This cop can be configured using the `EnforcedStyle` option
+        #   #
+        #   # @example `EnforcedStyle: create_list` (default)
+        #   #   # bad
+        #   #   3.times { create :user }
+        #   #
+        #   #   # good
+        #   #   create_list :user, 3
+        #   #
+        #   #   # bad
+        #   #   3.times { create :user, age: 18 }
+        #   #
+        #   #   # good - index is used to alter the created models attributes
+        #   #   3.times { |n| create :user, age: n }
+        #   #
+        #   #   # good - contains a method call, may return different values
+        #   #   3.times { create :user, age: rand }
+        #   #
+        #   # @example `EnforcedStyle: n_times`
+        #   #   # bad
+        #   #   create_list :user, 3
+        #   #
+        #   #   # good
+        #   #   3.times { create :user }
+        #   #
+        #   class CreateList < ::RuboCop::Cop::Base; end
+        CreateList = ::RuboCop::Cop::FactoryBot::CreateList
       end
     end
   end

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

@@ -4,52 +4,25 @@ module RuboCop
   module Cop
     module RSpec
       module FactoryBot
-        # Use string value when setting the class attribute explicitly.
-        #
-        # This cop would promote faster tests by lazy-loading of
-        # application files. Also, this could help you suppress potential bugs
-        # in combination with external libraries by avoiding a preload of
-        # application files from the factory files.
-        #
-        # @example
-        #   # bad
-        #   factory :foo, class: Foo do
-        #   end
-        #
-        #   # good
-        #   factory :foo, class: 'Foo' do
-        #   end
-        #
-        class FactoryClassName < ::RuboCop::Cop::Base
-          extend AutoCorrector
-
-          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
-
-          def on_send(node)
-            class_name(node) do |cn|
-              next if allowed?(cn.const_name)
-
-              msg = format(MSG, class_name: cn.const_name)
-              add_offense(cn, message: msg) do |corrector|
-                corrector.replace(cn, "'#{cn.source}'")
-              end
-            end
-          end
-
-          private
-
-          def allowed?(const_name)
-            ALLOWED_CONSTANTS.include?(const_name)
-          end
-        end
+        # @!parse
+        #   # Use string value when setting the class attribute explicitly.
+        #   #
+        #   # This cop would promote faster tests by lazy-loading of
+        #   # application files. Also, this could help you suppress potential
+        #   # bugs in combination with external libraries by avoiding a preload
+        #   # of application files from the factory files.
+        #   #
+        #   # @example
+        #   #   # bad
+        #   #   factory :foo, class: Foo do
+        #   #   end
+        #   #
+        #   #   # good
+        #   #   factory :foo, class: 'Foo' do
+        #   #   end
+        #   #
+        #   class FactoryClassName < ::RuboCop::Cop::Base; end
+        FactoryClassName = ::RuboCop::Cop::FactoryBot::FactoryClassName
       end
     end
   end

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

@@ -4,70 +4,29 @@ module RuboCop
   module Cop
     module RSpec
       module FactoryBot
-        # Checks for name style for argument of FactoryBot::Syntax::Methods.
-        #
-        # @example EnforcedStyle: symbol (default)
-        #   # bad
-        #   create('user')
-        #   build "user", username: "NAME"
-        #
-        #   # good
-        #   create(:user)
-        #   build :user, username: "NAME"
-        #
-        # @example EnforcedStyle: string
-        #   # bad
-        #   create(:user)
-        #   build :user, username: "NAME"
-        #
-        #   # good
-        #   create('user')
-        #   build "user", username: "NAME"
-        #
-        class FactoryNameStyle < ::RuboCop::Cop::Base
-          extend AutoCorrector
-          include ConfigurableEnforcedStyle
-          include RuboCop::RSpec::FactoryBot::Language
-
-          MSG = 'Use %<prefer>s to refer to a factory.'
-          FACTORY_CALLS = RuboCop::RSpec::FactoryBot::Language::METHODS
-          RESTRICT_ON_SEND = FACTORY_CALLS
-
-          # @!method factory_call(node)
-          def_node_matcher :factory_call, <<-PATTERN
-          (send
-            {#factory_bot? nil?} %FACTORY_CALLS
-            ${str sym} ...
-          )
-          PATTERN
-
-          def on_send(node)
-            factory_call(node) do |name|
-              if offense_for_symbol_style?(name)
-                register_offense(name, name.value.to_sym.inspect)
-              elsif offense_for_string_style?(name)
-                register_offense(name, name.value.to_s.inspect)
-              end
-            end
-          end
-
-          private
-
-          def offense_for_symbol_style?(name)
-            name.str_type? && style == :symbol
-          end
-
-          def offense_for_string_style?(name)
-            name.sym_type? && style == :string
-          end
-
-          def register_offense(name, prefer)
-            add_offense(name,
-                        message: format(MSG, prefer: style.to_s)) do |corrector|
-              corrector.replace(name, prefer)
-            end
-          end
-        end
+        # @!parse
+        #   # Checks for name style for argument of FactoryBot::Syntax::Methods.
+        #   #
+        #   # @example EnforcedStyle: symbol (default)
+        #   #   # bad
+        #   #   create('user')
+        #   #   build "user", username: "NAME"
+        #   #
+        #   #   # good
+        #   #   create(:user)
+        #   #   build :user, username: "NAME"
+        #   #
+        #   # @example EnforcedStyle: string
+        #   #   # bad
+        #   #   create(:user)
+        #   #   build :user, username: "NAME"
+        #   #
+        #   #   # good
+        #   #   create('user')
+        #   #   build "user", username: "NAME"
+        #   #
+        #   class FactoryNameStyle < ::RuboCop::Cop::Base; end
+        FactoryNameStyle = ::RuboCop::Cop::FactoryBot::FactoryNameStyle
       end
     end
   end

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

@@ -4,85 +4,51 @@ module RuboCop
   module Cop
     module RSpec
       module FactoryBot
-        # Use shorthands from `FactoryBot::Syntax::Methods` in your specs.
-        #
-        # @safety
-        #   The autocorrection is marked as unsafe because the cop
-        #   cannot verify whether you already include
-        #   `FactoryBot::Syntax::Methods` in your test suite.
-        #
-        #   If you're using Rails, add the following configuration to
-        #   `spec/support/factory_bot.rb` and be sure to require that file in
-        #   `rails_helper.rb`:
-        #
-        #   [source,ruby]
-        #   ----
-        #   RSpec.configure do |config|
-        #     config.include FactoryBot::Syntax::Methods
-        #   end
-        #   ----
-        #
-        #   If you're not using Rails:
-        #
-        #   [source,ruby]
-        #   ----
-        #   RSpec.configure do |config|
-        #     config.include FactoryBot::Syntax::Methods
-        #
-        #     config.before(:suite) do
-        #       FactoryBot.find_definitions
-        #     end
-        #   end
-        #   ----
-        #
-        # @example
-        #   # bad
-        #   FactoryBot.create(:bar)
-        #   FactoryBot.build(:bar)
-        #   FactoryBot.attributes_for(:bar)
-        #
-        #   # good
-        #   create(:bar)
-        #   build(:bar)
-        #   attributes_for(:bar)
-        #
-        class SyntaxMethods < Base
-          extend AutoCorrector
-          include InsideExampleGroup
-          include RangeHelp
-          include RuboCop::RSpec::FactoryBot::Language
-
-          MSG = 'Use `%<method>s` from `FactoryBot::Syntax::Methods`.'
-
-          RESTRICT_ON_SEND = RuboCop::RSpec::FactoryBot::Language::METHODS
-
-          def on_send(node)
-            return unless factory_bot?(node.receiver)
-            return unless inside_example_group?(node)
-
-            message = format(MSG, method: node.method_name)
-
-            add_offense(crime_scene(node), message: message) do |corrector|
-              corrector.remove(offense(node))
-            end
-          end
-
-          private
-
-          def crime_scene(node)
-            range_between(
-              node.source_range.begin_pos,
-              node.loc.selector.end_pos
-            )
-          end
-
-          def offense(node)
-            range_between(
-              node.source_range.begin_pos,
-              node.loc.selector.begin_pos
-            )
-          end
-        end
+        # @!parse
+        #   # Use shorthands from `FactoryBot::Syntax::Methods` in your specs.
+        #   #
+        #   # @safety
+        #   #   The autocorrection is marked as unsafe because the cop
+        #   #   cannot verify whether you already include
+        #   #   `FactoryBot::Syntax::Methods` in your test suite.
+        #   #
+        #   #   If you're using Rails, add the following configuration to
+        #   #   `spec/support/factory_bot.rb` and be sure to require that file
+        #   #   in `rails_helper.rb`:
+        #   #
+        #   #   [source,ruby]
+        #   #   ----
+        #   #   RSpec.configure do |config|
+        #   #     config.include FactoryBot::Syntax::Methods
+        #   #   end
+        #   #   ----
+        #   #
+        #   #   If you're not using Rails:
+        #   #
+        #   #   [source,ruby]
+        #   #   ----
+        #   #   RSpec.configure do |config|
+        #   #     config.include FactoryBot::Syntax::Methods
+        #   #
+        #   #     config.before(:suite) do
+        #   #       FactoryBot.find_definitions
+        #   #     end
+        #   #   end
+        #   #   ----
+        #   #
+        #   # @example
+        #   #   # bad
+        #   #   FactoryBot.create(:bar)
+        #   #   FactoryBot.build(:bar)
+        #   #   FactoryBot.attributes_for(:bar)
+        #   #
+        #   #   # good
+        #   #   create(:bar)
+        #   #   build(:bar)
+        #   #   attributes_for(:bar)
+        #   #
+        #   class SyntaxMethods < ::RuboCop::Cop::Base; end
+        SyntaxMethods = ::RuboCop::Cop::FactoryBot::SyntaxMethods
       end
     end
   end

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

@@ -34,6 +34,18 @@ module RuboCop
       #   # good
       #   describe 'test' do; end
       #
+      #   # bad
+      #   shared_examples 'test', focus: true do; end
+      #
+      #   # good
+      #   shared_examples 'test' do; end
+      #
+      #   # bad
+      #   shared_context 'test', focus: true do; end
+      #
+      #   # good
+      #   shared_context 'test' do; end
+      #
       #   # bad (does not support autocorrection)
       #   focus 'test' do; end
       #
@@ -51,6 +63,7 @@ module RuboCop
             #Examples.regular
             #Examples.skipped
             #Examples.pending
+            #SharedGroups.all
           }
         PATTERN
 

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

@@ -8,6 +8,9 @@ module RuboCop
       # It makes reading the test harder because it's not clear what exactly
       # is tested by this particular example.
       #
+      # The configurable options `AllowedIdentifiers` and `AllowedPatterns`
+      # will also read those set in `Naming/VariableNumber`.
+      #
       # @example `Max: 1 (default)`
       #   # bad
       #   let(:item_1) { create(:item) }
@@ -31,7 +34,20 @@ module RuboCop
       #   let(:item_1) { create(:item) }
       #   let(:item_2) { create(:item) }
       #
+      # @example `AllowedIdentifiers: ['item_1', 'item_2']`
+      #   # good
+      #   let(:item_1) { create(:item) }
+      #   let(:item_2) { create(:item) }
+      #
+      # @example `AllowedPatterns: ['item']`
+      #   # good
+      #   let(:item_1) { create(:item) }
+      #   let(:item_2) { create(:item) }
+      #
       class IndexedLet < Base
+        include AllowedIdentifiers
+        include AllowedPattern
+
         MSG = 'This `let` statement uses index in its name. Please give it ' \
               'a meaningful name.'
 
@@ -69,12 +85,27 @@ module RuboCop
         end
 
         def indexed_let?(node)
-          let?(node) && SUFFIX_INDEX_REGEX.match?(let_name(node))
+          let?(node) &&
+            SUFFIX_INDEX_REGEX.match?(let_name(node)) &&
+            !allowed_identifier?(let_name(node).to_s) &&
+            !matches_allowed_pattern?(let_name(node).to_s)
         end
 
         def let_name_stripped_index(node)
           let_name(node).to_s.gsub(INDEX_REGEX, '')
         end
+
+        def cop_config_patterns_values
+          Array(config.for_cop('Naming/VariableNumber')
+            .fetch('AllowedPatterns', [])) +
+            Array(cop_config.fetch('AllowedPatterns', []))
+        end
+
+        def allowed_identifiers
+          Array(config.for_cop('Naming/VariableNumber')
+            .fetch('AllowedIdentifiers', [])) +
+            Array(cop_config.fetch('AllowedIdentifiers', []))
+        end
       end
     end
   end

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

@@ -48,7 +48,7 @@ module RuboCop
       class InstanceVariable < Base
         include TopLevelGroup
 
-        MSG = 'Avoid instance variables – use let, ' \
+        MSG = 'Avoid instance variables - use let, ' \
               'a method call, or a local variable (if possible).'
 
         # @!method dynamic_class?(node)