Class: FactoryGirl::DefinitionProxy

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

Constant Summary collapse

UNPROXIED_METHODS = 
%w(__send__ __id__ nil? send object_id extend instance_eval initialize block_given? raise)

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(factory) ⇒ DefinitionProxy

Returns a new instance of DefinitionProxy.



11
12
13
14
 
# File 'lib/factory_girl/definition_proxy.rb', line 11

def initialize(factory)
  @factory = factory
  @child_factories = []
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(name, *args, &block) ⇒ Object

Calls add_attribute using the missing method name as the name of the attribute, so that:

factory :user do
  name 'Billy Idol'
end

and:

factory :user do
  add_attribute :name, 'Billy Idol'
end

are equivalent.

If no argument or block is given, factory_girl will look for a sequence or association with the same name. This means that:

factory :user do
  email { create(:email) }
  association :account
end

and:

factory :user do
  email
  
end

are equivalent.



79
80
81
82
83
84
85
86
87
 
# File 'lib/factory_girl/definition_proxy.rb', line 79

def method_missing(name, *args, &block)
  if args.empty? && block.nil?
    @factory.define_attribute(Attribute::Implicit.new(name, @factory))
  elsif args.first.is_a?(Hash) && args.first.has_key?(:factory)
    association(name, *args)
  else
    add_attribute(name, *args, &block)
  end
end

Instance Attribute Details

#child_factories ⇒ Object (readonly)

Returns the value of attribute child_factories.



9
10
11
 
# File 'lib/factory_girl/definition_proxy.rb', line 9

def child_factories
  @child_factories
end

Instance Method Details

#add_attribute(name, value = nil, &block) ⇒ Object

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 attribute is overridden for a specific instance.

When defining lazy attributes, an instance of FactoryGirl::Proxy 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.



34
35
36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/factory_girl/definition_proxy.rb', line 34

def add_attribute(name, value = nil, &block)
  if block_given?
    if value
      raise AttributeDefinitionError, "Both value and block given"
    else
      attribute = Attribute::Dynamic.new(name, block)
    end
  else
    attribute = Attribute::Static.new(name, value)
  end

  @factory.define_attribute(attribute)
end

#after_build(&block) ⇒ Object 



138
139
140
 
# File 'lib/factory_girl/definition_proxy.rb', line 138

def after_build(&block)
  @factory.add_callback(:after_build, &block)
end

#after_create(&block) ⇒ Object 



142
143
144
 
# File 'lib/factory_girl/definition_proxy.rb', line 142

def after_create(&block)
  @factory.add_callback(:after_create, &block)
end

#after_stub(&block) ⇒ Object 



146
147
148
 
# File 'lib/factory_girl/definition_proxy.rb', line 146

def after_stub(&block)
  @factory.add_callback(:after_stub, &block)
end

#association(name, options = {}) ⇒ Object

Adds an attribute that builds an association. The associated instance will be built using the same build strategy as the parent instance.

Example:

factory :user do
  name 'Joey'
end

factory :post do
  association :author, :factory => :user
end

Arguments:

  • name: Symbol The name of this attribute.

  • options: Hash

Options:

  • factory: Symbol or String

    The name of the factory to use when building the associated instance.
If no name is given, the name of the attribute is assumed to be the
name of the factory. For example, a "user" association will by
default use the "user" factory.



133
134
135
136
 
# File 'lib/factory_girl/definition_proxy.rb', line 133

def association(name, options = {})
  factory_name = options.delete(:factory) || name
  @factory.define_attribute(Attribute::Association.new(name, factory_name, options))
end

#factory(name, options = {}, &block) ⇒ Object 



154
155
156
 
# File 'lib/factory_girl/definition_proxy.rb', line 154

def factory(name, options = {}, &block)
  @child_factories << [name, options, block]
end

#sequence(name, start_value = 1, &block) ⇒ Object

Adds an attribute that will have unique values generated by a sequence with a specified format.

The result of:

factory :user do
  sequence(:email) { |n| "person#{n}@example.com" }
end

Is equal to:

sequence(:email) { |n| "person#{n}@example.com" }

factory :user do
  email { FactoryGirl.create(:email) }
end

Except that no globally available sequence will be defined.



105
106
107
108
 
# File 'lib/factory_girl/definition_proxy.rb', line 105

def sequence(name, start_value = 1, &block)
  sequence = Sequence.new(name, start_value, &block)
  add_attribute(name) { sequence.next }
end

#to_create(&block) ⇒ Object 



150
151
152
 
# File 'lib/factory_girl/definition_proxy.rb', line 150

def to_create(&block)
  @factory.to_create(&block)
end

#trait(name, &block) ⇒ Object 



158
159
160
 
# File 'lib/factory_girl/definition_proxy.rb', line 158

def trait(name, &block)
  @factory.define_trait(Trait.new(name, &block))
end