factory_bot 4.8.2 → 5.2.0

data/lib/factory_bot/configuration.rb

@@ -1,37 +1,33 @@
 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
 
     delegate :to_create, :skip_create, :constructor, :before, :after,
-      :callback, :callbacks, to: :@definition
+             :callback, :callbacks, to: :@definition
 
     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

@@ -10,19 +10,32 @@ module FactoryBot
       end
 
       def ==(other)
-        name == other.name &&
+        self.class == other.class &&
+          name == other.name &&
           options == other.options
       end
 
       protected
+
       attr_reader :options
 
       private
 
       def build
+        ensure_factory_is_not_a_declaration!
+
         factory_name = @overrides[:factory] || name
         [Attribute::Association.new(name, factory_name, [@traits, @overrides.except(:factory)].flatten)]
       end
+
+      def ensure_factory_is_not_a_declaration!
+        if @overrides[:factory].is_a?(Declaration)
+          raise ArgumentError.new(<<~MSG)
+            Association '#{name}' received an invalid factory argument.
+            Did you mean? 'factory: :#{@overrides[:factory].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
@@ -18,6 +17,7 @@ module FactoryBot
     end
 
     protected
+
     attr_reader :ignored
   end
 end

data/lib/factory_bot/declaration_list.rb

@@ -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,7 +6,7 @@ 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

data/lib/factory_bot/decorator.rb

@@ -6,10 +6,14 @@ module FactoryBot
       @component = component
     end
 
-    def method_missing(name, *args, &block)
+    def method_missing(name, *args, &block) # rubocop:disable Style/MethodMissingSuper
       @component.send(name, *args, &block)
     end
 
+    def respond_to_missing?(name, include_private = false)
+      @component.respond_to?(name, true) || super
+    end
+
     def send(symbol, *args, &block)
       __send__(symbol, *args, &block)
     end

data/lib/factory_bot/definition.rb

@@ -1,9 +1,10 @@
 module FactoryBot
   # @api private
   class Definition
-    attr_reader :defined_traits, :declarations
+    attr_reader :defined_traits, :declarations, :name
 
-    def initialize(name = nil, base_traits = [])
+    def initialize(name, base_traits = [])
+      @name              = name
       @declarations      = DeclarationList.new(name)
       @callbacks         = []
       @defined_traits    = Set.new
@@ -48,7 +49,7 @@ module FactoryBot
 
         defined_traits.each do |defined_trait|
           base_traits.each       { |bt| bt.define_trait defined_trait }
-          additional_traits.each { |bt| bt.define_trait defined_trait }
+          additional_traits.each { |at| at.define_trait defined_trait }
         end
 
         @compiled = true
@@ -73,7 +74,7 @@ module FactoryBot
     end
 
     def skip_create
-      @to_create = ->(instance) { }
+      @to_create = ->(instance) {}
     end
 
     def define_trait(trait)
@@ -94,7 +95,7 @@ module FactoryBot
 
     def callback(*names, &block)
       names.each do |name|
-        FactoryBot.register_callback(name)
+        FactoryBot::Internal.register_callback(name)
         add_callback(Callback.new(name, block))
       end
     end
@@ -110,17 +111,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
+      @defined_traits_by_name = nil
     end
 
     def aggregate_from_traits_and_self(method_name, &block)

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)

data/lib/factory_bot/definition_proxy.rb

@@ -1,6 +1,19 @@
 module FactoryBot
   class DefinitionProxy
-    UNPROXIED_METHODS = %w(__send__ __id__ nil? send object_id extend instance_eval initialize block_given? raise caller method)
+    UNPROXIED_METHODS = %w(
+      __send__
+      __id__
+      nil?
+      send
+      object_id
+      extend
+      instance_eval
+      initialize
+      block_given?
+      raise
+      caller
+      method
+    ).freeze
 
     (instance_methods + private_instance_methods).each do |method|
       undef_method(method) unless UNPROXIED_METHODS.include?(method.to_s)
@@ -21,42 +34,21 @@ module FactoryBot
       raise FactoryBot::MethodDefinitionError, message
     end
 
-    # Adds an attribute that should be assigned on generated instances for this
-    # factory.
-    #
-    # This method should be called with either a value or block, but not both. If
-    # called with a block, the attribute will be generated "lazily," whenever an
-    # instance is generated. Lazy attribute blocks will not be called if that
+    # Adds an attribute to the factory.
+    # The attribute value will be generated "lazily"
+    # by calling the block whenever an instance is generated.
+    # The block will not be called if the
     # attribute is overridden for a specific instance.
     #
-    # When defining lazy attributes, an instance of FactoryBot::Strategy will
-    # be yielded, allowing associations to be built using the correct build
-    # strategy.
-    #
     # Arguments:
     # * name: +Symbol+ or +String+
     #   The name of this attribute. This will be assigned using "name=" for
     #   generated instances.
-    # * value: +Object+
-    #   If no block is given, this value will be used for this attribute.
-    def add_attribute(name, value = nil, &block)
-      raise AttributeDefinitionError, 'Both value and block given' if value && block_given?
-
-      declaration = if block_given?
-        Declaration::Dynamic.new(name, @ignore, block)
-      else
-        Declaration::Static.new(name, value, @ignore)
-      end
-
+    def add_attribute(name, &block)
+      declaration = Declaration::Dynamic.new(name, @ignore, block)
       @definition.declare_attribute(declaration)
     end
 
-    def ignore(&block)
-      ActiveSupport::Deprecation.warn "`#ignore` is deprecated and will be "\
-        "removed in 5.0. Please use `#transient` instead."
-      transient(&block)
-    end
-
     def transient(&block)
       proxy = DefinitionProxy.new(@definition, true)
       proxy.instance_eval(&block)
@@ -66,40 +58,48 @@ module FactoryBot
     # attribute, so that:
     #
     #   factory :user do
-    #     name 'Billy Idol'
+    #     name { 'Billy Idol' }
     #   end
     #
     # and:
     #
     #   factory :user do
-    #     add_attribute :name, 'Billy Idol'
+    #     add_attribute(:name) { 'Billy Idol' }
     #   end
     #
     # are equivalent.
     #
-    # If no argument or block is given, factory_bot will look for a sequence
-    # or association with the same name. This means that:
+    # If no argument or block is given, factory_bot will first look for an
+    # association, then for a sequence, and finally for a trait with the same
+    # name. This means that given an "admin" trait, an "email" sequence, and an
+    # "account" factory:
     #
-    #   factory :user do
-    #     email { create(:email) }
+    #   factory :user, traits: [:admin] do
+    #     email { generate(:email) }
     #     association :account
     #   end
     #
     # and:
     #
     #   factory :user do
+    #     admin
     #     email
     #     account
     #   end
     #
     # are equivalent.
-    def method_missing(name, *args, &block)
-      if args.empty? && block.nil?
-        @definition.declare_attribute(Declaration::Implicit.new(name, @definition, @ignore))
-      elsif args.first.respond_to?(:has_key?) && args.first.has_key?(:factory)
-        association(name, *args)
+    def method_missing(name, *args, &block) # rubocop:disable Style/MissingRespondToMissing, Style/MethodMissingSuper
+      association_options = args.first
+
+      if association_options.nil?
+        __declare_attribute__(name, block)
+      elsif __valid_association_options?(association_options)
+        association(name, association_options)
       else
-        add_attribute(name, *args, &block)
+        raise NoMethodError.new(<<~MSG)
+          undefined method '#{name}' in '#{@definition.name}' factory
+          Did you mean? '#{name} { #{association_options.inspect} }'
+        MSG
       end
     end
 
@@ -121,6 +121,7 @@ module FactoryBot
     # Except that no globally available sequence will be defined.
     def sequence(name, *args, &block)
       sequence = Sequence.new(name, *args, &block)
+      FactoryBot::Internal.register_inline_sequence(sequence)
       add_attribute(name) { increment_sequence(sequence) }
     end
 
@@ -148,7 +149,15 @@ module FactoryBot
     #    name of the factory. For example, a "user" association will by
     #    default use the "user" factory.
     def association(name, *options)
-      @definition.declare_attribute(Declaration::Association.new(name, *options))
+      if block_given?
+        raise AssociationDefinitionError.new(
+          "Unexpected block passed to '#{name}' association "\
+          "in '#{@definition.name}' factory",
+        )
+      else
+        declaration = Declaration::Association.new(name, *options)
+        @definition.declare_attribute(declaration)
+      end
     end
 
     def to_create(&block)
@@ -170,5 +179,20 @@ module FactoryBot
     def initialize_with(&block)
       @definition.define_constructor(&block)
     end
+
+    private
+
+    def __declare_attribute__(name, block)
+      if block.nil?
+        declaration = Declaration::Implicit.new(name, @definition, @ignore)
+        @definition.declare_attribute(declaration)
+      else
+        add_attribute(name, &block)
+      end
+    end
+
+    def __valid_association_options?(options)
+      options.respond_to?(:has_key?) && options.has_key?(:factory)
+    end
   end
 end

data/lib/factory_bot/errors.rb

@@ -2,6 +2,9 @@ module FactoryBot
   # Raised when a factory is defined that attempts to instantiate itself.
   class AssociationDefinitionError < RuntimeError; end
 
+  # Raised when a trait is defined that references itself.
+  class TraitDefinitionError < RuntimeError; end
+
   # Raised when a callback is defined that has an invalid name
   class InvalidCallbackNameError < RuntimeError; end
 
@@ -11,12 +14,12 @@ module FactoryBot
   # Raised when attempting to register a sequence from a dynamic attribute block
   class SequenceAbuseError < RuntimeError; end
 
-  # Raised when defining an invalid attribute:
-  # * Defining an attribute which has a name ending in "="
-  # * Defining an attribute with both a static and lazy value
-  # * Defining an attribute twice in the same factory
+  # Raised when defining an attribute twice in the same factory
   class AttributeDefinitionError < RuntimeError; end
 
+  # Raised when attempting to pass a block to an association definition
+  class AssociationDefinitionError < RuntimeError; end
+
   # Raised when a method is defined in a factory or trait with arguments
   class MethodDefinitionError < RuntimeError; end
 

data/lib/factory_bot/evaluation.rb

@@ -1,4 +1,4 @@
-require 'observer'
+require "observer"
 
 module FactoryBot
   class Evaluation

data/lib/factory_bot/evaluator.rb

@@ -1,5 +1,5 @@
-require 'active_support/core_ext/hash/except'
-require 'active_support/core_ext/class/attribute'
+require "active_support/core_ext/hash/except"
+require "active_support/core_ext/class/attribute"
 
 module FactoryBot
   # @api private
@@ -37,7 +37,7 @@ module FactoryBot
       @instance = object_instance
     end
 
-    def method_missing(method_name, *args, &block)
+    def method_missing(method_name, *args, &block) # rubocop:disable Style/MethodMissingSuper
       if @instance.respond_to?(method_name)
         @instance.send(method_name, *args, &block)
       else
@@ -45,7 +45,7 @@ module FactoryBot
       end
     end
 
-    def respond_to_missing?(method_name, include_private = false)
+    def respond_to_missing?(method_name, _include_private = false)
       @instance.respond_to?(method_name) || SyntaxRunner.new.respond_to?(method_name)
     end
 
@@ -66,7 +66,7 @@ module FactoryBot
     end
 
     def self.define_attribute(name, &block)
-      if method_defined?(name) || private_method_defined?(name)
+      if instance_methods(false).include?(name) || private_instance_methods(false).include?(name)
         undef_method(name)
       end
 

data/lib/factory_bot/factory.rb

@@ -1,5 +1,5 @@
-require 'active_support/core_ext/hash/keys'
-require 'active_support/inflector'
+require "active_support/core_ext/hash/keys"
+require "active_support/inflector"
 
 module FactoryBot
   # @api private
@@ -21,10 +21,10 @@ module FactoryBot
 
     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)
@@ -91,7 +91,7 @@ module FactoryBot
     end
 
     def with_traits(traits)
-      self.clone.tap do |factory_with_traits|
+      clone.tap do |factory_with_traits|
         factory_with_traits.append_traits traits
       end
     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

@@ -9,7 +9,7 @@ module FactoryBot
     end
 
     def run(runner_strategy = @strategy, &block)
-      factory = FactoryBot.factory_by_name(@name)
+      factory = FactoryBot::Internal.factory_by_name(@name)
 
       factory.compile
 
@@ -22,10 +22,10 @@ module FactoryBot
         strategy: runner_strategy,
         traits: @traits,
         overrides: @overrides,
-        factory: factory
+        factory: factory,
       }
 
-      ActiveSupport::Notifications.instrument('factory_bot.run_factory', instrumentation_payload) do
+      ActiveSupport::Notifications.instrument("factory_bot.run_factory", instrumentation_payload) do
         factory.run(runner_strategy, @overrides, &block)
       end
     end

data/lib/factory_bot/find_definitions.rb

@@ -16,7 +16,7 @@ module FactoryBot
       load("#{path}.rb") if File.exist?("#{path}.rb")
 
       if File.directory? path
-        Dir[File.join(path, '**', '*.rb')].sort.each do |file|
+        Dir[File.join(path, "**", "*.rb")].sort.each do |file|
           load file
         end
       end