factory_bot 4.11.1 → 6.2.1

data/lib/factory_bot/attribute_list.rb

@@ -4,7 +4,7 @@ module FactoryBot
     include Enumerable
 
     def initialize(name = nil, attributes = [])
-      @name       = name
+      @name = name
       @attributes = attributes
     end
 
@@ -54,7 +54,8 @@ module FactoryBot
 
     def ensure_attribute_not_self_referencing!(attribute)
       if attribute.respond_to?(:factory) && attribute.factory == @name
-        raise AssociationDefinitionError, "Self-referencing association '#{attribute.name}' in '#{attribute.factory}'"
+        message = "Self-referencing association '#{attribute.name}' in '#{attribute.factory}'"
+        raise AssociationDefinitionError, message
       end
     end
 

data/lib/factory_bot/callback.rb

@@ -3,16 +3,15 @@ module FactoryBot
     attr_reader :name
 
     def initialize(name, block)
-      @name  = name.to_sym
+      @name = name.to_sym
       @block = block
-      ensure_valid_callback_name!
     end
 
     def run(instance, evaluator)
       case block.arity
-      when 1, -1 then syntax_runner.instance_exec(instance, &block)
+      when 1, -1, -2 then syntax_runner.instance_exec(instance, &block)
       when 2 then syntax_runner.instance_exec(instance, evaluator, &block)
-      else        syntax_runner.instance_exec(&block)
+      else syntax_runner.instance_exec(&block)
       end
     end
 
@@ -22,17 +21,11 @@ module FactoryBot
     end
 
     protected
+
     attr_reader :block
 
     private
 
-    def ensure_valid_callback_name!
-      unless FactoryBot.callback_names.include?(name)
-        raise InvalidCallbackNameError, "#{name} is not a valid callback name. " +
-          "Valid callback names are #{FactoryBot.callback_names.inspect}"
-      end
-    end
-
     def syntax_runner
       @syntax_runner ||= SyntaxRunner.new
     end

data/lib/factory_bot/configuration.rb

@@ -1,21 +1,25 @@
 module FactoryBot
   # @api private
   class Configuration
-    attr_reader :factories, :sequences, :traits, :strategies, :callback_names
-
-    attr_accessor :allow_class_lookup, :use_parent_strategy
+    attr_reader(
+      :callback_names,
+      :factories,
+      :inline_sequences,
+      :sequences,
+      :strategies,
+      :traits
+    )
 
     def initialize
-      @factories      = Decorator::DisallowsDuplicatesRegistry.new(Registry.new('Factory'))
-      @sequences      = Decorator::DisallowsDuplicatesRegistry.new(Registry.new('Sequence'))
-      @traits         = Decorator::DisallowsDuplicatesRegistry.new(Registry.new('Trait'))
-      @strategies     = Registry.new('Strategy')
+      @factories = Decorator::DisallowsDuplicatesRegistry.new(Registry.new("Factory"))
+      @sequences = Decorator::DisallowsDuplicatesRegistry.new(Registry.new("Sequence"))
+      @traits = Decorator::DisallowsDuplicatesRegistry.new(Registry.new("Trait"))
+      @strategies = Registry.new("Strategy")
       @callback_names = Set.new
-      @definition     = Definition.new
-
-      @allow_class_lookup = true
+      @definition = Definition.new(:configuration)
+      @inline_sequences = []
 
-      to_create { |instance| instance.save! }
+      to_create(&:save!)
       initialize_with { new }
     end
 
@@ -25,13 +29,5 @@ module FactoryBot
     def initialize_with(&block)
       @definition.define_constructor(&block)
     end
-
-    def duplicate_attribute_assignment_from_initialize_with
-      false
-    end
-
-    def duplicate_attribute_assignment_from_initialize_with=(value)
-      ActiveSupport::Deprecation.warn 'Assignment of duplicate_attribute_assignment_from_initialize_with is unnecessary as this is now default behavior in FactoryBot 4.0; this line can be removed', caller
-    end
   end
 end

data/lib/factory_bot/declaration/association.rb

@@ -6,22 +6,52 @@ module FactoryBot
         super(name, false)
         @options = options.dup
         @overrides = options.extract_options!
+        @factory_name = @overrides.delete(:factory) || name
         @traits = options
       end
 
       def ==(other)
-        name == other.name &&
+        self.class == other.class &&
+          name == other.name &&
           options == other.options
       end
 
       protected
+
       attr_reader :options
 
       private
 
+      attr_reader :factory_name, :overrides, :traits
+
       def build
-        factory_name = @overrides[:factory] || name
-        [Attribute::Association.new(name, factory_name, [@traits, @overrides.except(:factory)].flatten)]
+        raise_if_arguments_are_declarations!
+
+        [
+          Attribute::Association.new(
+            name,
+            factory_name,
+            [traits, overrides].flatten
+          )
+        ]
+      end
+
+      def raise_if_arguments_are_declarations!
+        if factory_name.is_a?(Declaration)
+          raise ArgumentError.new(<<~MSG)
+            Association '#{name}' received an invalid factory argument.
+            Did you mean? 'factory: :#{factory_name.name}'
+          MSG
+        end
+
+        overrides.each do |attribute, value|
+          if value.is_a?(Declaration)
+            raise ArgumentError.new(<<~MSG)
+              Association '#{name}' received an invalid attribute override.
+              Did you mean? '#{attribute}: :#{value.name}'
+            MSG
+          end
+        end
       end
     end
   end

data/lib/factory_bot/declaration/dynamic.rb

@@ -8,12 +8,14 @@ module FactoryBot
       end
 
       def ==(other)
-        name == other.name &&
+        self.class == other.class &&
+          name == other.name &&
           ignored == other.ignored &&
           block == other.block
       end
 
       protected
+
       attr_reader :block
 
       private

data/lib/factory_bot/declaration/implicit.rb

@@ -8,12 +8,14 @@ module FactoryBot
       end
 
       def ==(other)
-        name == other.name &&
+        self.class == other.class &&
+          name == other.name &&
           factory == other.factory &&
           ignored == other.ignored
       end
 
       protected
+
       attr_reader :factory
 
       private
@@ -21,8 +23,11 @@ module FactoryBot
       def build
         if FactoryBot.factories.registered?(name)
           [Attribute::Association.new(name, name, {})]
-        elsif FactoryBot.sequences.registered?(name)
+        elsif FactoryBot::Internal.sequences.registered?(name)
           [Attribute::Sequence.new(name, name, @ignored)]
+        elsif @factory.name.to_s == name.to_s
+          message = "Self-referencing trait '#{@name}'"
+          raise TraitDefinitionError, message
         else
           @factory.inherit_traits([name])
           []

data/lib/factory_bot/declaration.rb

@@ -1,7 +1,6 @@
-require 'factory_bot/declaration/static'
-require 'factory_bot/declaration/dynamic'
-require 'factory_bot/declaration/association'
-require 'factory_bot/declaration/implicit'
+require "factory_bot/declaration/dynamic"
+require "factory_bot/declaration/association"
+require "factory_bot/declaration/implicit"
 
 module FactoryBot
   # @api private
@@ -9,7 +8,7 @@ module FactoryBot
     attr_reader :name
 
     def initialize(name, ignored = false)
-      @name    = name
+      @name = name
       @ignored = ignored
     end
 
@@ -18,6 +17,7 @@ module FactoryBot
     end
 
     protected
+
     attr_reader :ignored
   end
 end

data/lib/factory_bot/declaration_list.rb

@@ -5,8 +5,8 @@ module FactoryBot
 
     def initialize(name = nil)
       @declarations = []
-      @name         = name
-      @overridable  = false
+      @name = name
+      @overridable = false
     end
 
     def declare_attribute(declaration)
@@ -39,7 +39,7 @@ module FactoryBot
     end
 
     def to_attributes
-      @declarations.inject([]) { |result, declaration| result += declaration.to_attributes }
+      @declarations.reduce([]) { |result, declaration| result + declaration.to_attributes }
     end
 
     def overridable?

data/lib/factory_bot/decorator/attribute_hash.rb

@@ -8,7 +8,7 @@ module FactoryBot
 
       def attributes
         @attributes.each_with_object({}) do |attribute_name, result|
-          result[attribute_name] = send(attribute_name)
+          result[attribute_name] = @component.send(attribute_name)
         end
       end
     end

data/lib/factory_bot/decorator/invocation_tracker.rb

@@ -6,10 +6,11 @@ module FactoryBot
         @invoked_methods = []
       end
 
-      def method_missing(name, *args, &block)
+      def method_missing(name, *args, &block) # rubocop:disable Style/MissingRespondToMissing
         @invoked_methods << name
         super
       end
+      ruby2_keywords :method_missing if respond_to?(:ruby2_keywords, true)
 
       def __invoked_methods__
         @invoked_methods.uniq

data/lib/factory_bot/decorator.rb

@@ -6,12 +6,28 @@ module FactoryBot
       @component = component
     end
 
-    def method_missing(name, *args, &block)
-      @component.send(name, *args, &block)
+    if ::Gem::Version.new(::RUBY_VERSION) >= ::Gem::Version.new("2.7")
+      class_eval(<<~RUBY, __FILE__, __LINE__ + 1)
+          def method_missing(...) # rubocop:disable Style/MethodMissingSuper, Style/MissingRespondToMissing
+          @component.send(...)
+        end
+
+        def send(...)
+          __send__(...)
+        end
+      RUBY
+    else
+      def method_missing(name, *args, &block) # rubocop:disable Style/MissingRespondToMissing
+        @component.send(name, *args, &block)
+      end
+
+      def send(symbol, *args, &block)
+        __send__(symbol, *args, &block)
+      end
     end
 
-    def send(symbol, *args, &block)
-      __send__(symbol, *args, &block)
+    def respond_to_missing?(name, include_private = false)
+      @component.respond_to?(name, true) || super
     end
 
     def self.const_missing(name)

data/lib/factory_bot/definition.rb

@@ -1,18 +1,21 @@
 module FactoryBot
   # @api private
   class Definition
-    attr_reader :defined_traits, :declarations
-
-    def initialize(name = nil, base_traits = [])
-      @declarations      = DeclarationList.new(name)
-      @callbacks         = []
-      @defined_traits    = Set.new
-      @to_create         = nil
-      @base_traits       = base_traits
+    attr_reader :defined_traits, :declarations, :name, :registered_enums
+
+    def initialize(name, base_traits = [])
+      @name = name
+      @declarations = DeclarationList.new(name)
+      @callbacks = []
+      @defined_traits = Set.new
+      @registered_enums = []
+      @to_create = nil
+      @base_traits = base_traits
       @additional_traits = []
-      @constructor       = nil
-      @attributes        = nil
-      @compiled          = false
+      @constructor = nil
+      @attributes = nil
+      @compiled = false
+      @expanded_enum_traits = false
     end
 
     delegate :declare_attribute, to: :declarations
@@ -27,7 +30,7 @@ module FactoryBot
     end
 
     def to_create(&block)
-      if block_given?
+      if block
         @to_create = block
       else
         aggregate_from_traits_and_self(:to_create) { @to_create }.last
@@ -42,13 +45,15 @@ module FactoryBot
       aggregate_from_traits_and_self(:callbacks) { @callbacks }
     end
 
-    def compile
+    def compile(klass = nil)
       unless @compiled
+        expand_enum_traits(klass) unless klass.nil?
+
         declarations.attributes
 
         defined_traits.each do |defined_trait|
-          base_traits.each       { |bt| bt.define_trait defined_trait }
-          additional_traits.each { |bt| bt.define_trait defined_trait }
+          base_traits.each { |bt| bt.define_trait defined_trait }
+          additional_traits.each { |at| at.define_trait defined_trait }
         end
 
         @compiled = true
@@ -73,13 +78,17 @@ module FactoryBot
     end
 
     def skip_create
-      @to_create = ->(instance) { }
+      @to_create = ->(instance) {}
     end
 
     def define_trait(trait)
       @defined_traits.add(trait)
     end
 
+    def register_enum(enum)
+      @registered_enums << enum
+    end
+
     def define_constructor(&block)
       @constructor = block
     end
@@ -94,7 +103,6 @@ module FactoryBot
 
     def callback(*names, &block)
       names.each do |name|
-        FactoryBot.register_callback(name)
         add_callback(Callback.new(name, block))
       end
     end
@@ -103,6 +111,20 @@ module FactoryBot
 
     def base_traits
       @base_traits.map { |name| trait_by_name(name) }
+    rescue KeyError => error
+      raise error_with_definition_name(error)
+    end
+
+    def error_with_definition_name(error)
+      message = error.message
+      message.insert(
+        message.index("\nDid you mean?") || message.length,
+        " referenced within \"#{name}\" definition"
+      )
+
+      error.class.new(message).tap do |new_error|
+        new_error.set_backtrace(error.backtrace)
+      end
     end
 
     def additional_traits
@@ -110,17 +132,19 @@ module FactoryBot
     end
 
     def trait_by_name(name)
-      trait_for(name) || FactoryBot.trait_by_name(name)
+      trait_for(name) || Internal.trait_by_name(name)
     end
 
     def trait_for(name)
-      defined_traits.detect { |trait| trait.name == name }
+      @defined_traits_by_name ||= defined_traits.each_with_object({}) { |t, memo| memo[t.name] ||= t }
+      @defined_traits_by_name[name.to_s]
     end
 
     def initialize_copy(source)
       super
       @attributes = nil
-      @compiled   = false
+      @compiled = false
+      @defined_traits_by_name = nil
     end
 
     def aggregate_from_traits_and_self(method_name, &block)
@@ -129,8 +153,32 @@ module FactoryBot
       [
         base_traits.map(&method_name),
         instance_exec(&block),
-        additional_traits.map(&method_name),
+        additional_traits.map(&method_name)
       ].flatten.compact
     end
+
+    def expand_enum_traits(klass)
+      return if @expanded_enum_traits
+
+      if automatically_register_defined_enums?(klass)
+        automatically_register_defined_enums(klass)
+      end
+
+      registered_enums.each do |enum|
+        traits = enum.build_traits(klass)
+        traits.each { |trait| define_trait(trait) }
+      end
+
+      @expanded_enum_traits = true
+    end
+
+    def automatically_register_defined_enums(klass)
+      klass.defined_enums.each_key { |name| register_enum(Enum.new(name)) }
+    end
+
+    def automatically_register_defined_enums?(klass)
+      FactoryBot.automatically_define_enum_traits &&
+        klass.respond_to?(:defined_enums)
+    end
   end
 end

data/lib/factory_bot/definition_hierarchy.rb

@@ -1,16 +1,6 @@
 module FactoryBot
   class DefinitionHierarchy
-    def callbacks
-      FactoryBot.callbacks
-    end
-
-    def constructor
-      FactoryBot.constructor
-    end
-
-    def to_create
-      FactoryBot.to_create
-    end
+    delegate :callbacks, :constructor, :to_create, to: Internal
 
     def self.build_from_definition(definition)
       build_to_create(&definition.to_create)