rubocop-factory_bot 2.22.0

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

@@ -0,0 +1,258 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    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::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
+    end
+  end
+end

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

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    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
+    end
+  end
+end

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

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    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::FactoryBot::Language
+
+        MSG = 'Use %<prefer>s to refer to a factory.'
+        FACTORY_CALLS = RuboCop::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
+    end
+  end
+end

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

@@ -0,0 +1,119 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    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 < ::RuboCop::Cop::Base
+        extend AutoCorrector
+        include RangeHelp
+        include RuboCop::FactoryBot::Language
+
+        MSG = 'Use `%<method>s` from `FactoryBot::Syntax::Methods`.'
+
+        RESTRICT_ON_SEND = RuboCop::FactoryBot::Language::METHODS
+
+        # @!method spec_group?(node)
+        def_node_matcher :spec_group?, <<~PATTERN
+          (block
+            (send
+              {(const {nil? cbase} :RSpec) nil?}
+              {
+                :describe :context :feature :example_group
+                :xdescribe :xcontext :xfeature
+                :fdescribe :fcontext :ffeature
+                :shared_examples :shared_examples_for
+                :shared_context
+              }
+            ...)
+          ...)
+        PATTERN
+
+        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
+
+        def inside_example_group?(node)
+          return spec_group?(node) if example_group_root?(node)
+
+          root = node.ancestors.find { |parent| example_group_root?(parent) }
+
+          spec_group?(root)
+        end
+
+        def example_group_root?(node)
+          node.parent.nil? || example_group_root_with_siblings?(node.parent)
+        end
+
+        def example_group_root_with_siblings?(node)
+          node.begin_type? && node.parent.nil?
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/factory_bot_cops.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require_relative 'factory_bot/attribute_defined_statically'
+require_relative 'factory_bot/consistent_parentheses_style'
+require_relative 'factory_bot/create_list'
+require_relative 'factory_bot/factory_class_name'
+require_relative 'factory_bot/factory_name_style'
+require_relative 'factory_bot/syntax_methods'

data/lib/rubocop/factory_bot/config_formatter.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require 'yaml'
+
+module RuboCop
+  module FactoryBot
+    # Builds a YAML config file from two config hashes
+    class ConfigFormatter
+      EXTENSION_ROOT_DEPARTMENT = %r{^(FactoryBot/)}.freeze
+      SUBDEPARTMENTS = [].freeze
+      AMENDMENTS = [].freeze
+      COP_DOC_BASE_URL = 'https://www.rubydoc.info/gems/rubocop-factory_bot/RuboCop/Cop/'
+
+      def initialize(config, descriptions)
+        @config       = config
+        @descriptions = descriptions
+      end
+
+      def dump
+        YAML.dump(unified_config)
+          .gsub(EXTENSION_ROOT_DEPARTMENT, "\n\\1")
+          .gsub(/^(\s+)- /, '\1  - ')
+          .gsub('"~"', '~')
+      end
+
+      private
+
+      def unified_config
+        cops.each_with_object(config.dup) do |cop, unified|
+          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).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
+    end
+  end
+end

data/lib/rubocop/factory_bot/description_extractor.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module FactoryBot
+    # Extracts cop descriptions from YARD docstrings
+    class DescriptionExtractor
+      def initialize(yardocs)
+        @code_objects = yardocs.map(&CodeObject.public_method(:new))
+      end
+
+      def to_h
+        code_objects
+          .select(&:cop?)
+          .map(&:configuration)
+          .reduce(:merge)
+      end
+
+      private
+
+      attr_reader :code_objects
+
+      # Decorator of a YARD code object for working with documented cops
+      class CodeObject
+        RUBOCOP_COP_CLASS_NAME = 'RuboCop::Cop::Base'
+
+        def initialize(yardoc)
+          @yardoc = yardoc
+        end
+
+        # Test if the YARD code object documents a concrete cop class
+        #
+        # @return [Boolean]
+        def cop?
+          cop_subclass? && !abstract?
+        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 documented_constant
+          yardoc.to_s
+        end
+
+        def cop_subclass?
+          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/factory_bot/factory_bot.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module RuboCop
+  # RuboCop FactoryBot project namespace
+  module FactoryBot
+    ATTRIBUTE_DEFINING_METHODS = %i[
+      factory
+      ignore
+      trait
+      traits_for_enum
+      transient
+    ].freeze
+
+    UNPROXIED_METHODS = %i[
+      __send__
+      __id__
+      nil?
+      send
+      object_id
+      extend
+      instance_eval
+      initialize
+      block_given?
+      raise
+      caller
+      method
+    ].freeze
+
+    DEFINITION_PROXY_METHODS = %i[
+      add_attribute
+      after
+      association
+      before
+      callback
+      ignore
+      initialize_with
+      sequence
+      skip_create
+      to_create
+    ].freeze
+
+    RESERVED_METHODS =
+      DEFINITION_PROXY_METHODS +
+      UNPROXIED_METHODS +
+      ATTRIBUTE_DEFINING_METHODS
+
+    private_constant(
+      :ATTRIBUTE_DEFINING_METHODS,
+      :UNPROXIED_METHODS,
+      :DEFINITION_PROXY_METHODS,
+      :RESERVED_METHODS
+    )
+
+    def self.attribute_defining_methods
+      ATTRIBUTE_DEFINING_METHODS
+    end
+
+    def self.reserved_methods
+      RESERVED_METHODS
+    end
+  end
+end