factory_bot 4.11.1 → 5.2.0

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,43 +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
-        warn_static_attribute_deprecation(name, value)
-        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)
@@ -67,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
 
@@ -122,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
 
@@ -149,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)
@@ -174,28 +182,17 @@ module FactoryBot
 
     private
 
-    def warn_static_attribute_deprecation(name, value)
-      attribute_caller = caller(2)
-
-      if attribute_caller[0].include?("method_missing")
-        attribute_caller = caller(3)
+    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
 
-      ActiveSupport::Deprecation.warn(<<-MSG, attribute_caller)
-Static attributes will be removed in FactoryBot 5.0. Please use dynamic
-attributes instead by wrapping the attribute value in a block:
-
-#{name} { #{value.inspect} }
-
-To automatically update from static attributes to dynamic ones,
-install rubocop-rspec and run:
-
-rubocop \\
-  --require rubocop-rspec \\
-  --only FactoryBot/AttributeDefinedStatically \\
-  --auto-correct
-
-      MSG
+    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

data/lib/factory_bot/internal.rb

@@ -0,0 +1,104 @@
+module FactoryBot
+  # @api private
+  module Internal
+    class << self
+      delegate :after,
+               :before,
+               :callback_names,
+               :callbacks,
+               :constructor,
+               :factories,
+               :initialize_with,
+               :inline_sequences,
+               :sequences,
+               :skip_create,
+               :strategies,
+               :to_create,
+               :traits,
+               to: :configuration
+
+      def configuration
+        @configuration ||= Configuration.new
+      end
+
+      def reset_configuration
+        @configuration = nil
+      end
+
+      def register_inline_sequence(sequence)
+        inline_sequences.push(sequence)
+      end
+
+      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
+
+      def register_default_callbacks
+        register_callback(:after_create)
+        register_callback(:after_build)
+        register_callback(:after_stub)
+        register_callback(:before_create)
+      end
+
+      def register_callback(name)
+        name = name.to_sym
+        callback_names << name
+      end
+    end
+  end
+end

data/lib/factory_bot/linter.rb

@@ -1,10 +1,10 @@
 module FactoryBot
   class Linter
-
-    def initialize(factories, linting_strategy, factory_strategy = :create)
+    def initialize(factories, strategy: :create, traits: false, verbose: false)
       @factories_to_lint = factories
-      @linting_method = "lint_#{linting_strategy}"
-      @factory_strategy = factory_strategy
+      @factory_strategy = strategy
+      @traits = traits
+      @verbose = verbose
       @invalid_factories = calculate_invalid_factories
     end
 
@@ -20,7 +20,7 @@ module FactoryBot
 
     def calculate_invalid_factories
       factories_to_lint.reduce(Hash.new([])) do |result, factory|
-        errors = send(@linting_method, factory)
+        errors = lint(factory)
         result[factory] |= errors unless errors.empty?
         result
       end
@@ -37,6 +37,13 @@ module FactoryBot
         "* #{location} - #{message} (#{@wrapped_error.class.name})"
       end
 
+      def verbose_message
+        <<~MESSAGE
+          #{message}
+            #{@wrapped_error.backtrace.join("\n  ")}
+        MESSAGE
+      end
+
       def location
         @factory.name
       end
@@ -53,12 +60,20 @@ module FactoryBot
       end
     end
 
+    def lint(factory)
+      if @traits
+        lint_factory(factory) + lint_traits(factory)
+      else
+        lint_factory(factory)
+      end
+    end
+
     def lint_factory(factory)
       result = []
       begin
         FactoryBot.public_send(factory_strategy, factory.name)
-      rescue => error
-        result |= [FactoryError.new(error, factory)]
+      rescue StandardError => e
+        result |= [FactoryError.new(e, factory)]
       end
       result
     end
@@ -68,30 +83,32 @@ module FactoryBot
       factory.definition.defined_traits.map(&:name).each do |trait_name|
         begin
           FactoryBot.public_send(factory_strategy, factory.name, trait_name)
-        rescue => error
+        rescue StandardError => e
           result |=
-              [FactoryTraitError.new(error, factory, trait_name)]
+            [FactoryTraitError.new(e, factory, trait_name)]
         end
       end
       result
     end
 
-    def lint_factory_and_traits(factory)
-      errors = lint_factory(factory)
-      errors |= lint_traits(factory)
-      errors
-    end
-
     def error_message
       lines = invalid_factories.map do |_factory, exceptions|
-        exceptions.map(&:message)
+        exceptions.map(&error_message_type)
       end.flatten
 
-      <<-ERROR_MESSAGE.strip
-The following factories are invalid:
+      <<~ERROR_MESSAGE.strip
+        The following factories are invalid:
 
-#{lines.join("\n")}
+        #{lines.join("\n")}
       ERROR_MESSAGE
     end
+
+    def error_message_type
+      if @verbose
+        :verbose_message
+      else
+        :message
+      end
+    end
   end
 end

data/lib/factory_bot/null_factory.rb

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

data/lib/factory_bot/null_object.rb

@@ -13,11 +13,11 @@ module FactoryBot
       end
     end
 
-    def respond_to?(method, include_private=false)
+    def respond_to?(method, _include_private = false)
       @methods_to_respond_to.include? method.to_s
     end
 
-    def respond_to_missing?(*args)
+    def respond_to_missing?(*)
       false
     end
   end

data/lib/factory_bot/registry.rb

@@ -1,3 +1,5 @@
+require "active_support/core_ext/hash/indifferent_access"
+
 module FactoryBot
   class Registry
     include Enumerable
@@ -6,7 +8,7 @@ module FactoryBot
 
     def initialize(name)
       @name  = name
-      @items = Decorator::ClassKeyHash.new({})
+      @items = ActiveSupport::HashWithIndifferentAccess.new
     end
 
     def clear
@@ -18,11 +20,9 @@ module FactoryBot
     end
 
     def find(name)
-      if registered?(name)
-        @items[name]
-      else
-        raise ArgumentError, "#{@name} not registered: #{name}"
-      end
+      @items.fetch(name)
+    rescue KeyError => e
+      raise key_error_with_custom_message(e)
     end
 
     alias :[] :find
@@ -34,5 +34,14 @@ module FactoryBot
     def registered?(name)
       @items.key?(name)
     end
+
+    private
+
+    def key_error_with_custom_message(key_error)
+      message = key_error.message.sub("key not found", "#{@name} not registered")
+      error = KeyError.new(message)
+      error.set_backtrace(key_error.backtrace)
+      error
+    end
   end
 end

data/lib/factory_bot/reload.rb

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

data/lib/factory_bot/sequence.rb

@@ -1,5 +1,4 @@
 module FactoryBot
-
   # Sequences are defined using sequence within a FactoryBot.define block.
   # Sequence values are generated using next.
   # @api private

data/lib/factory_bot/strategy/null.rb

@@ -1,11 +1,9 @@
 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