factory_bot 5.0.2 → 6.1.0

data/lib/factory_bot/evaluator_class_definer.rb

@@ -3,7 +3,7 @@ module FactoryBot
   class EvaluatorClassDefiner
     def initialize(attributes, parent_class)
       @parent_class = parent_class
-      @attributes   = attributes
+      @attributes = attributes
 
       attributes.each do |attribute|
         evaluator_class.define_attribute(attribute.name, &attribute.to_proc)

data/lib/factory_bot/factory.rb

@@ -8,23 +8,23 @@ module FactoryBot
 
     def initialize(name, options = {})
       assert_valid_options(options)
-      @name             = name.respond_to?(:to_sym) ? name.to_sym : name.to_s.underscore.to_sym
-      @parent           = options[:parent]
-      @aliases          = options[:aliases] || []
-      @class_name       = options[:class]
-      @definition       = Definition.new(@name, options[:traits] || [])
-      @compiled         = false
+      @name = name.respond_to?(:to_sym) ? name.to_sym : name.to_s.underscore.to_sym
+      @parent = options[:parent]
+      @aliases = options[:aliases] || []
+      @class_name = options[:class]
+      @definition = Definition.new(@name, options[:traits] || [])
+      @compiled = false
     end
 
     delegate :add_callback, :declare_attribute, :to_create, :define_trait, :constructor,
-             :defined_traits, :inherit_traits, :append_traits, to: :@definition
+      :defined_traits, :inherit_traits, :append_traits, to: :@definition
 
     def build_class
       @build_class ||= if class_name.is_a? Class
-                         class_name
-                       else
-                         class_name.to_s.camelize.constantize
-                       end
+        class_name
+      else
+        class_name.to_s.camelize.constantize
+      end
     end
 
     def run(build_strategy, overrides, &block)
@@ -84,7 +84,7 @@ module FactoryBot
       unless @compiled
         parent.compile
         parent.defined_traits.each { |trait| define_trait(trait) }
-        @definition.compile
+        @definition.compile(build_class)
         build_hierarchy
         @compiled = true
       end
@@ -145,7 +145,7 @@ module FactoryBot
 
     def parent
       if @parent
-        FactoryBot.factory_by_name(@parent)
+        FactoryBot::Internal.factory_by_name(@parent)
       else
         NullFactory.new
       end

data/lib/factory_bot/factory_runner.rb

@@ -1,15 +1,15 @@
 module FactoryBot
   class FactoryRunner
     def initialize(name, strategy, traits_and_overrides)
-      @name     = name
+      @name = name
       @strategy = strategy
 
       @overrides = traits_and_overrides.extract_options!
-      @traits    = traits_and_overrides
+      @traits = traits_and_overrides
     end
 
     def run(runner_strategy = @strategy, &block)
-      factory = FactoryBot.factory_by_name(@name)
+      factory = FactoryBot::Internal.factory_by_name(@name)
 
       factory.compile
 
@@ -22,7 +22,7 @@ module FactoryBot
         strategy: runner_strategy,
         traits: @traits,
         overrides: @overrides,
-        factory: factory,
+        factory: factory
       }
 
       ActiveSupport::Notifications.instrument("factory_bot.run_factory", instrumentation_payload) do

data/lib/factory_bot/find_definitions.rb

@@ -7,7 +7,7 @@ module FactoryBot
     attr_accessor :definition_file_paths
   end
 
-  self.definition_file_paths = %w(factories test/factories spec/factories)
+  self.definition_file_paths = %w[factories test/factories spec/factories]
 
   def self.find_definitions
     absolute_definition_file_paths = definition_file_paths.map { |path| File.expand_path(path) }

data/lib/factory_bot/internal.rb

@@ -2,7 +2,19 @@ module FactoryBot
   # @api private
   module Internal
     class << self
-      delegate :inline_sequences, to: :configuration
+      delegate :after,
+        :before,
+        :callbacks,
+        :constructor,
+        :factories,
+        :initialize_with,
+        :inline_sequences,
+        :sequences,
+        :skip_create,
+        :strategies,
+        :to_create,
+        :traits,
+        to: :configuration
 
       def configuration
         @configuration ||= Configuration.new
@@ -19,6 +31,61 @@ module FactoryBot
       def rewind_inline_sequences
         inline_sequences.each(&:rewind)
       end
+
+      def register_trait(trait)
+        trait.names.each do |name|
+          traits.register(name, trait)
+        end
+        trait
+      end
+
+      def trait_by_name(name)
+        traits.find(name)
+      end
+
+      def register_sequence(sequence)
+        sequence.names.each do |name|
+          sequences.register(name, sequence)
+        end
+        sequence
+      end
+
+      def sequence_by_name(name)
+        sequences.find(name)
+      end
+
+      def rewind_sequences
+        sequences.each(&:rewind)
+        rewind_inline_sequences
+      end
+
+      def register_factory(factory)
+        factory.names.each do |name|
+          factories.register(name, factory)
+        end
+        factory
+      end
+
+      def factory_by_name(name)
+        factories.find(name)
+      end
+
+      def register_strategy(strategy_name, strategy_class)
+        strategies.register(strategy_name, strategy_class)
+        StrategySyntaxMethodRegistrar.new(strategy_name).define_strategy_methods
+      end
+
+      def strategy_by_name(name)
+        strategies.find(name)
+      end
+
+      def register_default_strategies
+        register_strategy(:build, FactoryBot::Strategy::Build)
+        register_strategy(:create, FactoryBot::Strategy::Create)
+        register_strategy(:attributes_for, FactoryBot::Strategy::AttributesFor)
+        register_strategy(:build_stubbed, FactoryBot::Strategy::Stub)
+        register_strategy(:null, FactoryBot::Strategy::Null)
+      end
     end
   end
 end

data/lib/factory_bot/linter.rb

@@ -19,17 +19,16 @@ module FactoryBot
     attr_reader :factories_to_lint, :invalid_factories, :factory_strategy
 
     def calculate_invalid_factories
-      factories_to_lint.reduce(Hash.new([])) do |result, factory|
+      factories_to_lint.each_with_object(Hash.new([])) do |factory, result|
         errors = lint(factory)
         result[factory] |= errors unless errors.empty?
-        result
       end
     end
 
     class FactoryError
       def initialize(wrapped_error, factory)
         @wrapped_error = wrapped_error
-        @factory       = factory
+        @factory = factory
       end
 
       def message
@@ -72,8 +71,8 @@ module FactoryBot
       result = []
       begin
         FactoryBot.public_send(factory_strategy, factory.name)
-      rescue StandardError => error
-        result |= [FactoryError.new(error, factory)]
+      rescue => e
+        result |= [FactoryError.new(e, factory)]
       end
       result
     end
@@ -81,20 +80,17 @@ module FactoryBot
     def lint_traits(factory)
       result = []
       factory.definition.defined_traits.map(&:name).each do |trait_name|
-        begin
-          FactoryBot.public_send(factory_strategy, factory.name, trait_name)
-        rescue StandardError => error
-          result |=
-            [FactoryTraitError.new(error, factory, trait_name)]
-        end
+        FactoryBot.public_send(factory_strategy, factory.name, trait_name)
+      rescue => e
+        result |= [FactoryTraitError.new(e, factory, trait_name)]
       end
       result
     end
 
     def error_message
-      lines = invalid_factories.map do |_factory, exceptions|
+      lines = invalid_factories.map { |_factory, exceptions|
         exceptions.map(&error_message_type)
-      end.flatten
+      }.flatten
 
       <<~ERROR_MESSAGE.strip
         The following factories are invalid:

data/lib/factory_bot/null_factory.rb

@@ -10,12 +10,18 @@ module FactoryBot
     delegate :defined_traits, :callbacks, :attributes, :constructor,
       :to_create, to: :definition
 
-    def compile; end
+    def compile
+    end
 
-    def class_name; end
+    def class_name
+    end
 
-    def evaluator_class; FactoryBot::Evaluator; end
+    def evaluator_class
+      FactoryBot::Evaluator
+    end
 
-    def hierarchy_class; FactoryBot::DefinitionHierarchy; end
+    def hierarchy_class
+      FactoryBot::DefinitionHierarchy
+    end
   end
 end

data/lib/factory_bot/null_object.rb

@@ -5,7 +5,7 @@ module FactoryBot
       @methods_to_respond_to = methods_to_respond_to.map(&:to_s)
     end
 
-    def method_missing(name, *args, &block)
+    def method_missing(name, *args, &block) # rubocop:disable Style/MissingRespondToMissing
       if respond_to?(name)
         nil
       else
@@ -13,12 +13,8 @@ module FactoryBot
       end
     end
 
-    def respond_to?(method, _include_private = false)
+    def respond_to?(method)
       @methods_to_respond_to.include? method.to_s
     end
-
-    def respond_to_missing?(*)
-      false
-    end
   end
 end

data/lib/factory_bot/registry.rb

@@ -7,7 +7,7 @@ module FactoryBot
     attr_reader :name
 
     def initialize(name)
-      @name  = name
+      @name = name
       @items = ActiveSupport::HashWithIndifferentAccess.new
     end
 
@@ -21,11 +21,11 @@ module FactoryBot
 
     def find(name)
       @items.fetch(name)
-    rescue KeyError => key_error
-      raise key_error_with_custom_message(key_error)
+    rescue KeyError => e
+      raise key_error_with_custom_message(e)
     end
 
-    alias :[] :find
+    alias [] find
 
     def register(name, item)
       @items[name] = item

data/lib/factory_bot/reload.rb

@@ -1,8 +1,7 @@
 module FactoryBot
   def self.reload
     Internal.reset_configuration
-    register_default_strategies
-    register_default_callbacks
+    Internal.register_default_strategies
     find_definitions
   end
 end

data/lib/factory_bot/sequence.rb

@@ -6,14 +6,14 @@ module FactoryBot
     attr_reader :name
 
     def initialize(name, *args, &proc)
-      @name    = name
-      @proc    = proc
+      @name = name
+      @proc = proc
 
-      options  = args.extract_options!
-      @value   = args.first || 1
+      options = args.extract_options!
+      @value = args.first || 1
       @aliases = options.fetch(:aliases) { [] }
 
-      if !@value.respond_to?(:peek)
+      unless @value.respond_to?(:peek)
         @value = EnumeratorAdapter.new(@value)
       end
     end

data/lib/factory_bot/strategy/null.rb

@@ -1,9 +1,11 @@
 module FactoryBot
   module Strategy
     class Null
-      def association(runner); end
+      def association(runner)
+      end
 
-      def result(evaluation); end
+      def result(evaluation)
+      end
     end
   end
 end

data/lib/factory_bot/strategy/stub.rb

@@ -21,9 +21,13 @@ module FactoryBot
         :update_attributes!,
         :update_attributes,
         :update_column,
-        :update_columns,
+        :update_columns
       ].freeze
 
+      def self.next_id=(id)
+        @@next_id = id
+      end
+
       def association(runner)
         runner.run(:build_stubbed)
       end
@@ -44,15 +48,17 @@ module FactoryBot
       end
 
       def stub_database_interaction_on_result(result_instance)
-        result_instance.id ||= next_id
+        if has_settable_id?(result_instance)
+          result_instance.id ||= next_id
+        end
 
         result_instance.instance_eval do
           def persisted?
-            !new_record?
+            true
           end
 
           def new_record?
-            id.nil?
+            false
           end
 
           def destroyed?
@@ -62,12 +68,17 @@ module FactoryBot
           DISABLED_PERSISTENCE_METHODS.each do |write_method|
             define_singleton_method(write_method) do |*args|
               raise "stubbed models are not allowed to access the database - "\
-                    "#{self.class}##{write_method}(#{args.join(',')})"
+                    "#{self.class}##{write_method}(#{args.join(",")})"
             end
           end
         end
       end
 
+      def has_settable_id?(result_instance)
+        !result_instance.class.respond_to?(:primary_key) ||
+          result_instance.class.primary_key
+      end
+
       def clear_changes_information(result_instance)
         if result_instance.respond_to?(:clear_changes_information)
           result_instance.clear_changes_information

data/lib/factory_bot/strategy_calculator.rb

@@ -20,7 +20,7 @@ module FactoryBot
     end
 
     def strategy_name_to_object
-      FactoryBot.strategy_by_name(@name_or_object)
+      FactoryBot::Internal.strategy_by_name(@name_or_object)
     end
   end
 end

data/lib/factory_bot/strategy_syntax_method_registrar.rb

@@ -11,6 +11,14 @@ module FactoryBot
       define_pair_strategy_method
     end
 
+    def self.with_index(block, index)
+      if block&.arity == 2
+        ->(instance) { block.call(instance, index) }
+      else
+        block
+      end
+    end
+
     private
 
     def define_singular_strategy_method
@@ -29,7 +37,10 @@ module FactoryBot
           raise ArgumentError, "count missing for #{strategy_name}_list"
         end
 
-        Array.new(amount) { send(strategy_name, name, *traits_and_overrides, &block) }
+        Array.new(amount) do |i|
+          block_with_index = StrategySyntaxMethodRegistrar.with_index(block, i)
+          send(strategy_name, name, *traits_and_overrides, &block_with_index)
+        end
       end
     end