factory_bot 5.0.2 → 6.2.1

data/lib/factory_bot/definition_proxy.rb

@@ -1,6 +1,6 @@
 module FactoryBot
   class DefinitionProxy
-    UNPROXIED_METHODS = %w(
+    UNPROXIED_METHODS = %w[
       __send__
       __id__
       nil?
@@ -13,7 +13,7 @@ module FactoryBot
       raise
       caller
       method
-    ).freeze
+    ].freeze
 
     (instance_methods + private_instance_methods).each do |method|
       undef_method(method) unless UNPROXIED_METHODS.include?(method.to_s)
@@ -24,8 +24,8 @@ module FactoryBot
     attr_reader :child_factories
 
     def initialize(definition, ignore = false)
-      @definition      = definition
-      @ignore          = ignore
+      @definition = definition
+      @ignore = ignore
       @child_factories = []
     end
 
@@ -88,15 +88,18 @@ module FactoryBot
     #   end
     #
     # are equivalent.
-    def method_missing(name, *args, &block) # rubocop:disable Style/MethodMissing
-      if args.empty?
+    def method_missing(name, *args, &block) # rubocop:disable Style/MissingRespondToMissing
+      association_options = args.first
+
+      if association_options.nil?
         __declare_attribute__(name, block)
-      elsif args.first.respond_to?(:has_key?) && args.first.has_key?(:factory)
-        association(name, *args)
+      elsif __valid_association_options?(association_options)
+        association(name, association_options)
       else
-        raise NoMethodError.new(
-          "undefined method '#{name}' in '#{@definition.name}' factory",
-        )
+        raise NoMethodError.new(<<~MSG)
+          undefined method '#{name}' in '#{@definition.name}' factory
+          Did you mean? '#{name} { #{association_options.inspect} }'
+        MSG
       end
     end
 
@@ -149,7 +152,7 @@ module FactoryBot
       if block_given?
         raise AssociationDefinitionError.new(
           "Unexpected block passed to '#{name}' association "\
-          "in '#{@definition.name}' factory",
+          "in '#{@definition.name}' factory"
         )
       else
         declaration = Declaration::Association.new(name, *options)
@@ -173,6 +176,64 @@ module FactoryBot
       @definition.define_trait(Trait.new(name, &block))
     end
 
+    # Creates traits for enumerable values.
+    #
+    # Example:
+    #   factory :task do
+    #     traits_for_enum :status, [:started, :finished]
+    #   end
+    #
+    # Equivalent to:
+    #   factory :task do
+    #     trait :started do
+    #       status { :started }
+    #     end
+    #
+    #     trait :finished do
+    #       status { :finished }
+    #     end
+    #   end
+    #
+    # Example:
+    #   factory :task do
+    #     traits_for_enum :status, {started: 1, finished: 2}
+    #   end
+    #
+    # Example:
+    #   class Task
+    #     def statuses
+    #       {started: 1, finished: 2}
+    #     end
+    #   end
+    #
+    #   factory :task do
+    #     traits_for_enum :status
+    #   end
+    #
+    # Both equivalent to:
+    #   factory :task do
+    #     trait :started do
+    #       status { 1 }
+    #     end
+    #
+    #     trait :finished do
+    #       status { 2 }
+    #     end
+    #   end
+    #
+    #
+    # Arguments:
+    #   attribute_name: +Symbol+ or +String+
+    #     the name of the attribute these traits will set the value of
+    #   values: +Array+, +Hash+, or other +Enumerable+
+    #     An array of trait names, or a mapping of trait names to values for
+    #     those traits. When this argument is not provided, factory_bot will
+    #     attempt to get the values by calling the pluralized `attribute_name`
+    #     class method.
+    def traits_for_enum(attribute_name, values = nil)
+      @definition.register_enum(Enum.new(attribute_name, values))
+    end
+
     def initialize_with(&block)
       @definition.define_constructor(&block)
     end
@@ -187,5 +248,9 @@ module FactoryBot
         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/enum.rb

@@ -0,0 +1,27 @@
+module FactoryBot
+  # @api private
+  class Enum
+    def initialize(attribute_name, values = nil)
+      @attribute_name = attribute_name
+      @values = values
+    end
+
+    def build_traits(klass)
+      enum_values(klass).map do |trait_name, value|
+        build_trait(trait_name, @attribute_name, value || trait_name)
+      end
+    end
+
+    private
+
+    def enum_values(klass)
+      @values || klass.send(@attribute_name.to_s.pluralize)
+    end
+
+    def build_trait(trait_name, attribute_name, value)
+      Trait.new(trait_name) do
+        add_attribute(attribute_name) { value }
+      end
+    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
 

data/lib/factory_bot/evaluator.rb

@@ -7,7 +7,7 @@ module FactoryBot
     class_attribute :attribute_lists
 
     private_instance_methods.each do |method|
-      undef_method(method) unless method =~ /^__|initialize/
+      undef_method(method) unless method.match?(/^__|initialize/)
     end
 
     def initialize(build_strategy, overrides = {})
@@ -23,9 +23,9 @@ module FactoryBot
 
     def association(factory_name, *traits_and_overrides)
       overrides = traits_and_overrides.extract_options!
-      strategy_override = overrides.fetch(:strategy) do
-        FactoryBot.use_parent_strategy ? @build_strategy.class : :create
-      end
+      strategy_override = overrides.fetch(:strategy) {
+        FactoryBot.use_parent_strategy ? @build_strategy.to_sym : :create
+      }
 
       traits_and_overrides += [overrides.except(:strategy)]
 
@@ -33,17 +33,16 @@ module FactoryBot
       @build_strategy.association(runner)
     end
 
-    def instance=(object_instance)
-      @instance = object_instance
-    end
+    attr_accessor :instance
 
-    def method_missing(method_name, *args, &block) # rubocop:disable Style/MethodMissing
+    def method_missing(method_name, *args, &block)
       if @instance.respond_to?(method_name)
         @instance.send(method_name, *args, &block)
       else
         SyntaxRunner.new.send(method_name, *args, &block)
       end
     end
+    ruby2_keywords :method_missing if respond_to?(:ruby2_keywords, true)
 
     def respond_to_missing?(method_name, _include_private = false)
       @instance.respond_to?(method_name) || SyntaxRunner.new.respond_to?(method_name)
@@ -66,7 +65,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/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_method :[], :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/attributes_for.rb

@@ -8,6 +8,10 @@ module FactoryBot
       def result(evaluation)
         evaluation.hash
       end
+
+      def to_sym
+        :attributes_for
+      end
     end
   end
 end

data/lib/factory_bot/strategy/build.rb

@@ -10,6 +10,10 @@ module FactoryBot
           evaluation.notify(:after_build, instance)
         end
       end
+
+      def to_sym
+        :build
+      end
     end
   end
 end

data/lib/factory_bot/strategy/create.rb

@@ -13,6 +13,10 @@ module FactoryBot
           evaluation.notify(:after_create, instance)
         end
       end
+
+      def to_sym
+        :create
+      end
     end
   end
 end

data/lib/factory_bot/strategy/null.rb

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