factory_bot 4.11.1 → 5.2.0

data/lib/factory_bot/strategy/stub.rb

@@ -31,7 +31,8 @@ module FactoryBot
       def result(evaluation)
         evaluation.object.tap do |instance|
           stub_database_interaction_on_result(instance)
-          clear_changed_attributes_on_result(instance)
+          set_timestamps(instance)
+          clear_changes_information(instance)
           evaluation.notify(:after_stub, instance)
         end
       end
@@ -43,15 +44,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?
@@ -60,46 +63,44 @@ 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(",")})"
+              raise "stubbed models are not allowed to access the database - "\
+                    "#{self.class}##{write_method}(#{args.join(',')})"
             end
           end
         end
+      end
 
-        created_at_missing_default = result_instance.respond_to?(:created_at) && !result_instance.created_at
+      def has_settable_id?(result_instance)
+        !result_instance.class.respond_to?(:primary_key) ||
+          result_instance.class.primary_key
+      end
 
-        if created_at_missing_default
-          result_instance.instance_eval do
-            def created_at
-              @created_at ||= Time.now.in_time_zone
-            end
-          end
+      def clear_changes_information(result_instance)
+        if result_instance.respond_to?(:clear_changes_information)
+          result_instance.clear_changes_information
         end
+      end
 
-        has_updated_at = result_instance.respond_to?(:updated_at)
-        updated_at_no_default = has_updated_at && !result_instance.updated_at
-
-        if updated_at_no_default
-          result_instance.instance_eval do
-            def updated_at
-              @updated_at ||= Time.current
-            end
-          end
+      def set_timestamps(result_instance)
+        if missing_created_at?(result_instance)
+          result_instance.created_at = Time.current
         end
-      end
 
-      def clear_changed_attributes_on_result(result_instance)
-        unless result_instance.respond_to?(:clear_changes_information)
-          result_instance.extend ActiveModelDirtyBackport
+        if missing_updated_at?(result_instance)
+          result_instance.updated_at = Time.current
         end
+      end
 
-        result_instance.clear_changes_information
+      def missing_created_at?(result_instance)
+        result_instance.respond_to?(:created_at) &&
+          result_instance.respond_to?(:created_at=) &&
+          result_instance.created_at.blank?
       end
-    end
 
-    module ActiveModelDirtyBackport
-      def clear_changes_information
-        @previously_changed = ActiveSupport::HashWithIndifferentAccess.new
-        @changed_attributes = ActiveSupport::HashWithIndifferentAccess.new
+      def missing_updated_at?(result_instance)
+        result_instance.respond_to?(:updated_at) &&
+          result_instance.respond_to?(:updated_at=) &&
+          result_instance.updated_at.blank?
       end
     end
   end

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
 
-        amount.times.map { 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
 
@@ -37,7 +48,7 @@ module FactoryBot
       strategy_name = @strategy_name
 
       define_syntax_method("#{strategy_name}_pair") do |name, *traits_and_overrides, &block|
-        2.times.map { send(strategy_name, name, *traits_and_overrides, &block) }
+        Array.new(2) { send(strategy_name, name, *traits_and_overrides, &block) }
       end
     end
 

data/lib/factory_bot/syntax/default.rb

@@ -17,7 +17,7 @@ module FactoryBot
           proxy = FactoryBot::DefinitionProxy.new(factory.definition)
           proxy.instance_eval(&block) if block_given?
 
-          FactoryBot.register_factory(factory)
+          Internal.register_factory(factory)
 
           proxy.child_factories.each do |(child_name, child_options, child_block)|
             parent_factory = child_options.delete(:parent) || name
@@ -26,41 +26,29 @@ module FactoryBot
         end
 
         def sequence(name, *args, &block)
-          FactoryBot.register_sequence(Sequence.new(name, *args, &block))
+          Internal.register_sequence(Sequence.new(name, *args, &block))
         end
 
         def trait(name, &block)
-          FactoryBot.register_trait(Trait.new(name, &block))
-        end
-
-        def to_create(&block)
-          FactoryBot.to_create(&block)
-        end
-
-        def skip_create
-          FactoryBot.skip_create
-        end
-
-        def initialize_with(&block)
-          FactoryBot.initialize_with(&block)
+          Internal.register_trait(Trait.new(name, &block))
         end
 
         def self.run(block)
           new.instance_eval(&block)
         end
 
-        delegate :before, :after, :callback, to: :configuration
-
-        private
-
-        def configuration
-          FactoryBot.configuration
-        end
+        delegate :after,
+                 :before,
+                 :callback,
+                 :initialize_with,
+                 :skip_create,
+                 :to_create,
+                 to: FactoryBot::Internal
       end
 
       class ModifyDSL
-        def factory(name, options = {}, &block)
-          factory = FactoryBot.factory_by_name(name)
+        def factory(name, _options = {}, &block)
+          factory = Internal.factory_by_name(name)
           proxy = FactoryBot::DefinitionProxy.new(factory.definition.overridable)
           proxy.instance_eval(&block)
         end

data/lib/factory_bot/syntax/methods.rb

@@ -2,8 +2,8 @@ module FactoryBot
   module Syntax
     ## This module is a container for all strategy methods provided by
     ## FactoryBot. This includes all the default strategies provided ({Methods#build},
-    ## {Methods#create}, {Methods#build_stubbed}, and {Methods#attributes_for}), as well as
-    ## the complementary *_list methods.
+    ## {Methods#create}, {Methods#build_stubbed}, and {Methods#attributes_for}), as
+    ## well as the complementary *_list and *_pair methods.
     ## @example singular factory execution
     ##   # basic use case
     ##   build(:completed_order)
@@ -30,7 +30,7 @@ module FactoryBot
     ##   # factory with traits and attribute override
     ##   build_stubbed_list(:user, 15, :admin, :male, name: "John Doe")
     module Methods
-      # @!parse FactoryBot.register_default_strategies
+      # @!parse FactoryBot::Internal.register_default_strategies
       # @!method build(name, *traits_and_overrides, &block)
       # (see #strategy_method)
       # Builds a registered factory by name.
@@ -51,22 +51,38 @@ module FactoryBot
       # Generates a hash of attributes for a registered factory by name.
       # @return [Hash] hash of attributes for the factory
 
-      # @!method build_list(name, amount, *traits_and_overrides)
+      # @!method build_list(name, amount, *traits_and_overrides, &block)
       # (see #strategy_method_list)
       # @return [Array] array of built objects defined by the factory
 
-      # @!method create_list(name, amount, *traits_and_overrides)
+      # @!method create_list(name, amount, *traits_and_overrides, &block)
       # (see #strategy_method_list)
       # @return [Array] array of created objects defined by the factory
 
-      # @!method build_stubbed_list(name, amount, *traits_and_overrides)
+      # @!method build_stubbed_list(name, amount, *traits_and_overrides, &block)
       # (see #strategy_method_list)
       # @return [Array] array of stubbed objects defined by the factory
 
-      # @!method attributes_for_list(name, amount, *traits_and_overrides)
+      # @!method attributes_for_list(name, amount, *traits_and_overrides, &block)
       # (see #strategy_method_list)
       # @return [Array<Hash>] array of attribute hashes for the factory
 
+      # @!method build_pair(name, *traits_and_overrides, &block)
+      # (see #strategy_method_pair)
+      # @return [Array] pair of built objects defined by the factory
+
+      # @!method create_pair(name, *traits_and_overrides, &block)
+      # (see #strategy_method_pair)
+      # @return [Array] pair of created objects defined by the factory
+
+      # @!method build_stubbed_pair(name, *traits_and_overrides, &block)
+      # (see #strategy_method_pair)
+      # @return [Array] pair of stubbed objects defined by the factory
+
+      # @!method attributes_for_pair(name, *traits_and_overrides, &block)
+      # (see #strategy_method_pair)
+      # @return [Array<Hash>] pair of attribute hashes for the factory
+
       # @!method strategy_method
       # @!visibility private
       # @param [Symbol] name the name of the factory to build
@@ -78,6 +94,13 @@ module FactoryBot
       # @param [Symbol] name the name of the factory to execute
       # @param [Integer] amount the number of instances to execute
       # @param [Array<Symbol, Symbol, Hash>] traits_and_overrides splat args traits and a hash of overrides
+      # @param [Proc] block block to be executed
+
+      # @!method strategy_method_pair
+      # @!visibility private
+      # @param [Symbol] name the name of the factory to execute
+      # @param [Array<Symbol, Symbol, Hash>] traits_and_overrides splat args traits and a hash of overrides
+      # @param [Proc] block block to be executed
 
       # Generates and returns the next value in a sequence.
       #
@@ -88,7 +111,7 @@ module FactoryBot
       # Returns:
       #   The next value in the sequence. (Object)
       def generate(name)
-        FactoryBot.sequence_by_name(name).next
+        Internal.sequence_by_name(name).next
       end
 
       # Generates and returns the list of values in a sequence.
@@ -103,7 +126,7 @@ module FactoryBot
       #   The next value in the sequence. (Object)
       def generate_list(name, count)
         (1..count).map do
-          FactoryBot.sequence_by_name(name).next
+          Internal.sequence_by_name(name).next
         end
       end
     end

data/lib/factory_bot/syntax.rb

@@ -1,5 +1,5 @@
-require 'factory_bot/syntax/methods'
-require 'factory_bot/syntax/default'
+require "factory_bot/syntax/methods"
+require "factory_bot/syntax/default"
 
 module FactoryBot
   module Syntax

data/lib/factory_bot/trait.rb

@@ -4,12 +4,14 @@ module FactoryBot
     attr_reader :name, :definition
 
     def initialize(name, &block)
-      @name = name
+      @name = name.to_s
       @block = block
       @definition = Definition.new(@name)
-
       proxy = FactoryBot::DefinitionProxy.new(@definition)
-      proxy.instance_eval(&@block) if block_given?
+
+      if block_given?
+        proxy.instance_eval(&@block)
+      end
     end
 
     delegate :add_callback, :declare_attribute, :to_create, :define_trait, :constructor,
@@ -25,6 +27,7 @@ module FactoryBot
     end
 
     protected
+
     attr_reader :block
   end
 end

data/lib/factory_bot/version.rb

@@ -1,3 +1,3 @@
 module FactoryBot
-  VERSION = "4.11.1".freeze
+  VERSION = "5.2.0".freeze
 end

data/lib/factory_bot.rb

@@ -1,59 +1,57 @@
-require 'set'
-require 'active_support/core_ext/module/delegation'
-require 'active_support/deprecation'
-require 'active_support/notifications'
-
-require 'factory_bot/definition_hierarchy'
-require 'factory_bot/configuration'
-require 'factory_bot/errors'
-require 'factory_bot/factory_runner'
-require 'factory_bot/strategy_syntax_method_registrar'
-require 'factory_bot/strategy_calculator'
-require 'factory_bot/strategy/build'
-require 'factory_bot/strategy/create'
-require 'factory_bot/strategy/attributes_for'
-require 'factory_bot/strategy/stub'
-require 'factory_bot/strategy/null'
-require 'factory_bot/registry'
-require 'factory_bot/null_factory'
-require 'factory_bot/null_object'
-require 'factory_bot/evaluation'
-require 'factory_bot/factory'
-require 'factory_bot/attribute_assigner'
-require 'factory_bot/evaluator'
-require 'factory_bot/evaluator_class_definer'
-require 'factory_bot/attribute'
-require 'factory_bot/callback'
-require 'factory_bot/callbacks_observer'
-require 'factory_bot/declaration_list'
-require 'factory_bot/declaration'
-require 'factory_bot/sequence'
-require 'factory_bot/attribute_list'
-require 'factory_bot/trait'
-require 'factory_bot/aliases'
-require 'factory_bot/definition'
-require 'factory_bot/definition_proxy'
-require 'factory_bot/syntax'
-require 'factory_bot/syntax_runner'
-require 'factory_bot/find_definitions'
-require 'factory_bot/reload'
-require 'factory_bot/decorator'
-require 'factory_bot/decorator/attribute_hash'
-require 'factory_bot/decorator/class_key_hash'
-require 'factory_bot/decorator/disallows_duplicates_registry'
-require 'factory_bot/decorator/invocation_tracker'
-require 'factory_bot/decorator/new_constructor'
-require 'factory_bot/linter'
-require 'factory_bot/version'
+require "set"
+require "active_support/core_ext/module/delegation"
+require "active_support/core_ext/module/attribute_accessors"
+require "active_support/deprecation"
+require "active_support/notifications"
+
+require "factory_bot/internal"
+require "factory_bot/definition_hierarchy"
+require "factory_bot/configuration"
+require "factory_bot/errors"
+require "factory_bot/factory_runner"
+require "factory_bot/strategy_syntax_method_registrar"
+require "factory_bot/strategy_calculator"
+require "factory_bot/strategy/build"
+require "factory_bot/strategy/create"
+require "factory_bot/strategy/attributes_for"
+require "factory_bot/strategy/stub"
+require "factory_bot/strategy/null"
+require "factory_bot/registry"
+require "factory_bot/null_factory"
+require "factory_bot/null_object"
+require "factory_bot/evaluation"
+require "factory_bot/factory"
+require "factory_bot/attribute_assigner"
+require "factory_bot/evaluator"
+require "factory_bot/evaluator_class_definer"
+require "factory_bot/attribute"
+require "factory_bot/callback"
+require "factory_bot/callbacks_observer"
+require "factory_bot/declaration_list"
+require "factory_bot/declaration"
+require "factory_bot/sequence"
+require "factory_bot/attribute_list"
+require "factory_bot/trait"
+require "factory_bot/aliases"
+require "factory_bot/definition"
+require "factory_bot/definition_proxy"
+require "factory_bot/syntax"
+require "factory_bot/syntax_runner"
+require "factory_bot/find_definitions"
+require "factory_bot/reload"
+require "factory_bot/decorator"
+require "factory_bot/decorator/attribute_hash"
+require "factory_bot/decorator/disallows_duplicates_registry"
+require "factory_bot/decorator/invocation_tracker"
+require "factory_bot/decorator/new_constructor"
+require "factory_bot/linter"
+require "factory_bot/version"
 
 module FactoryBot
-  def self.configuration
-    @configuration ||= Configuration.new
-  end
+  Deprecation = ActiveSupport::Deprecation.new("6.0", "factory_bot")
 
-  def self.reset_configuration
-    @configuration = nil
-  end
+  mattr_accessor :use_parent_strategy, instance_accessor: false
+  self.use_parent_strategy = true
 
   # Look for errors in factories and (optionally) their traits.
   # Parameters:
@@ -61,100 +59,67 @@ module FactoryBot
   # options:
   #   traits: true - to lint traits as well as factories
   #   strategy: :create - to specify the strategy for linting
+  #   verbose: true - to include full backtraces for each linting error
   def self.lint(*args)
     options = args.extract_options!
     factories_to_lint = args[0] || FactoryBot.factories
-    linting_strategy = options[:traits] ? :factory_and_traits : :factory
-    factory_strategy = options[:strategy] || :create
-    Linter.new(factories_to_lint, linting_strategy, factory_strategy).lint!
+    Linter.new(factories_to_lint, **options).lint!
   end
 
   class << self
-    delegate :factories,
-             :sequences,
-             :traits,
+    delegate :callback_names,
              :callbacks,
+             :configuration,
+             :constructor,
+             :factories,
+             :factory_by_name,
+             :initialize_with,
+             :register_callback,
+             :register_default_callbacks,
+             :register_default_strategies,
+             :register_factory,
+             :register_sequence,
+             :register_strategy,
+             :register_trait,
+             :reset_configuration,
+             :rewind_sequences,
+             :sequence_by_name,
+             :sequences,
+             :skip_create,
              :strategies,
-             :callback_names,
+             :strategy_by_name,
              :to_create,
-             :skip_create,
-             :initialize_with,
-             :constructor,
-             :duplicate_attribute_assignment_from_initialize_with,
-             :duplicate_attribute_assignment_from_initialize_with=,
-             :allow_class_lookup,
-             :allow_class_lookup=,
-             :use_parent_strategy,
-             :use_parent_strategy=,
-             to: :configuration
-  end
-
-  def self.register_factory(factory)
-    factory.names.each do |name|
-      factories.register(name, factory)
-    end
-    factory
-  end
-
-  def self.factory_by_name(name)
-    factories.find(name)
-  end
-
-  def self.register_sequence(sequence)
-    sequence.names.each do |name|
-      sequences.register(name, sequence)
-    end
-    sequence
-  end
-
-  def self.sequence_by_name(name)
-    sequences.find(name)
-  end
-
-  def self.rewind_sequences
-    sequences.each(&:rewind)
-  end
-
-  def self.register_trait(trait)
-    trait.names.each do |name|
-      traits.register(name, trait)
-    end
-    trait
-  end
-
-  def self.trait_by_name(name)
-    traits.find(name)
-  end
-
-  def self.register_strategy(strategy_name, strategy_class)
-    strategies.register(strategy_name, strategy_class)
-    StrategySyntaxMethodRegistrar.new(strategy_name).define_strategy_methods
-  end
-
-  def self.strategy_by_name(name)
-    strategies.find(name)
-  end
-
-  def self.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
-
-  def self.register_default_callbacks
-    register_callback(:after_build)
-    register_callback(:after_create)
-    register_callback(:after_stub)
-    register_callback(:before_create)
-  end
-
-  def self.register_callback(name)
-    name = name.to_sym
-    callback_names << name
+             :trait_by_name,
+             :traits,
+             to: Internal
+
+    attr_accessor :allow_class_lookup
+
+    deprecate :allow_class_lookup,
+              :allow_class_lookup=,
+              :callback_names,
+              :callbacks,
+              :configuration,
+              :constructor,
+              :factory_by_name,
+              :initialize_with,
+              :register_callback,
+              :register_default_callbacks,
+              :register_default_strategies,
+              :register_factory,
+              :register_sequence,
+              :register_trait,
+              :reset_configuration,
+              :sequence_by_name,
+              :sequences,
+              :skip_create,
+              :strategies,
+              :to_create,
+              :trait_by_name,
+              :traits,
+              deprecator: Deprecation
   end
 end
 
-FactoryBot.register_default_strategies
-FactoryBot.register_default_callbacks
+FactoryBot::Internal.register_default_strategies
+FactoryBot::Internal.register_default_callbacks