class FactoryBot::Factory

@api private

Attributes

Public Class Methods

Source

# File lib/factory_bot/factory.rb, line 9
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]
  @uri_manager = FactoryBot::UriManager.new(names)
  @definition = Definition.new(@name, options[:traits] || [], uri_manager: @uri_manager)
  @compiled = false
end

Public Instance Methods

associations ()

Source

# File lib/factory_bot/factory.rb, line 58
def associations
  evaluator_class.attribute_list.associations
end

build_class ()

Source

# File lib/factory_bot/factory.rb, line 24
def build_class
  @build_class ||= if class_name.is_a? Class
    class_name
  elsif class_name.to_s.safe_constantize
    class_name.to_s.safe_constantize
  else
    class_name.to_s.camelize.constantize
  end
end

compile ()

Source

# File lib/factory_bot/factory.rb, line 91
def compile
  unless @compiled
    parent.compile
    inherit_parent_traits
    @definition.compile(build_class)
    build_hierarchy
    @compiled = true
  end
end

human_names ()

Source

# File lib/factory_bot/factory.rb, line 54
def human_names
  names.map { |name| name.to_s.humanize.downcase }
end

names ()

Source

# File lib/factory_bot/factory.rb, line 87
def names
  [name] + @aliases
end

Names for this factory, including aliases.

Example:

factory :user, aliases: [:author] do
  # ...
end

FactoryBot.create(:author).class
# => User

Because an attribute defined without a value or block will build an association with the same name, this allows associations to be defined without factories, such as:

factory :user, aliases: [:author] do
  # ...
end

factory :post do
  author
end

FactoryBot.create(:post).author.class
# => User

run (build_strategy, overrides, &block)

Source

# File lib/factory_bot/factory.rb, line 34
def run(build_strategy, overrides, &block)
  block ||= ->(result) { result }

  compile

  strategy = Strategy.lookup_strategy(build_strategy).new

  evaluator = evaluator_class.new(strategy, overrides.symbolize_keys)
  attribute_assigner = AttributeAssigner.new(evaluator, build_class, &compiled_constructor)

  observer = CallbacksObserver.new(callbacks, evaluator)
  evaluation = Evaluation.new(evaluator, attribute_assigner, compiled_to_create, observer)

  evaluation.notify(:before_all, nil)
  instance = strategy.result(evaluation).tap(&block)
  evaluation.notify(:after_all, instance)

  instance
end

with_traits (traits)

Source

# File lib/factory_bot/factory.rb, line 101
def with_traits(traits)
  clone.tap do |factory_with_traits|
    factory_with_traits.append_traits traits
  end
end

Protected Instance Methods

attributes ()

Source

# File lib/factory_bot/factory.rb, line 117
def attributes
  compile
  AttributeList.new(@name).tap do |list|
    list.apply_attributes definition.attributes
  end
end

build_hierarchy ()

Source

# File lib/factory_bot/factory.rb, line 132
def build_hierarchy
  hierarchy_class.build_from_definition definition
end

callbacks ()

Source

# File lib/factory_bot/factory.rb, line 136
def callbacks
  hierarchy_instance.callbacks
end

class_name ()

Source

# File lib/factory_bot/factory.rb, line 109
def class_name
  @class_name || parent.class_name || name
end

compiled_constructor ()

Source

# File lib/factory_bot/factory.rb, line 144
def compiled_constructor
  hierarchy_instance.constructor
end

compiled_to_create ()

Source

# File lib/factory_bot/factory.rb, line 140
def compiled_to_create
  hierarchy_instance.to_create
end

evaluator_class ()

Source

# File lib/factory_bot/factory.rb, line 113
def evaluator_class
  @evaluator_class ||= EvaluatorClassDefiner.new(attributes, parent.evaluator_class).evaluator_class
end

hierarchy_class ()

Source

# File lib/factory_bot/factory.rb, line 124
def hierarchy_class
  @hierarchy_class ||= Class.new(parent.hierarchy_class)
end

hierarchy_instance ()

Source

# File lib/factory_bot/factory.rb, line 128
def hierarchy_instance
  @hierarchy_instance ||= hierarchy_class.new
end

Private Instance Methods

assert_valid_options (options)

Source

# File lib/factory_bot/factory.rb, line 150
def assert_valid_options(options)
  options.assert_valid_keys(:class, :parent, :aliases, :traits)
end

inherit_parent_traits ()

Source

# File lib/factory_bot/factory.rb, line 162
def inherit_parent_traits
  parent.defined_traits.each do |trait|
    next if defined_traits_names.include?(trait.name)
    define_trait(trait.clone)
  end
end

initialize_copy (source)

Source

# File lib/factory_bot/factory.rb, line 169
def initialize_copy(source)
  super
  @definition = @definition.clone
  @evaluator_class = nil
  @hierarchy_class = nil
  @hierarchy_instance = nil
  @compiled = false
end

Calls superclass method

parent ()

Source

# File lib/factory_bot/factory.rb, line 154
def parent
  if @parent
    FactoryBot::Internal.factory_by_name(@parent)
  else
    NullFactory.new
  end
end