Class: FactoryGirl::Factory Private

Inherits:
Object
  • Object
show all
Defined in:
lib/factory_girl/factory.rb

This class is part of a private API. You should avoid using this class if possible, as it may be removed or be changed in the future.

Instance Attribute Summary (collapse)

Instance Method Summary (collapse)

Constructor Details

- (Factory) initialize(name, options = {})

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of Factory



9
10
11
12
13
14
15
16
17
# File 'lib/factory_girl/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]
  @definition       = Definition.new(@name, options[:traits] || [])
  @compiled         = false
end

Instance Attribute Details

- (Object) definition (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



7
8
9
# File 'lib/factory_girl/factory.rb', line 7

def definition
  @definition
end

- (Object) name (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



7
8
9
# File 'lib/factory_girl/factory.rb', line 7

def name
  @name
end

Instance Method Details

- (Object) associations

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



49
50
51
# File 'lib/factory_girl/factory.rb', line 49

def associations
  evaluator_class.attribute_list.associations
end

- (Object) build_class

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



22
23
24
25
26
27
28
# File 'lib/factory_girl/factory.rb', line 22

def build_class
  @build_class ||= if class_name.is_a? Class
    class_name
  else
    class_name.to_s.camelize.constantize
  end
end

- (Object) compile

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



82
83
84
85
86
87
88
89
90
# File 'lib/factory_girl/factory.rb', line 82

def compile
  unless @compiled
    parent.compile
    parent.defined_traits.each { |trait| define_trait(trait) }
    @definition.compile
    build_hierarchy
    @compiled = true
  end
end

- (Object) human_names

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



45
46
47
# File 'lib/factory_girl/factory.rb', line 45

def human_names
  names.map { |name| name.to_s.humanize.downcase }
end

- (Object) names

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Names for this factory, including aliases.

Example:

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

FactoryGirl.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

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


78
79
80
# File 'lib/factory_girl/factory.rb', line 78

def names
  [name] + @aliases
end

- (Object) run(build_strategy, overrides, &block)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



30
31
32
33
34
35
36
37
38
39
40
41
42
43
# File 'lib/factory_girl/factory.rb', line 30

def run(build_strategy, overrides, &block)
  block ||= ->(result) { result }
  compile

  strategy = StrategyCalculator.new(build_strategy).strategy.new

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

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

  strategy.result(evaluation).tap(&block)
end

- (Object) with_traits(traits)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



92
93
94
95
96
# File 'lib/factory_girl/factory.rb', line 92

def with_traits(traits)
  self.clone.tap do |factory_with_traits|
    factory_with_traits.append_traits traits
  end
end