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, ignore = false) ⇒ DefinitionProxy

Returns a new instance of DefinitionProxy.



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

def initialize(factory, ignore = false)
  @factory         = factory
  @ignore          = ignore
  @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.



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

def method_missing(name, *args, &block)
  if args.empty? && block.nil?
    @factory.declare_attribute(Declaration::Implicit.new(name, @factory, @ignore))
  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.

Raises:



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

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
    Declaration::Static.new(name, value, @ignore)
  end

  @factory.declare_attribute(declaration)
end

#after_build(&block) ⇒ Object 



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

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

#after_create(&block) ⇒ Object 



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

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

#after_stub(&block) ⇒ Object 



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

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.



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

def association(name, options = {})
  @factory.declare_attribute(Declaration::Association.new(name, options))
end

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



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

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

#ignore(&block) ⇒ Object 



47
48
49
50
 
# File 'lib/factory_girl/definition_proxy.rb', line 47

def ignore(&block)
  proxy = DefinitionProxy.new(@factory, true)
  proxy.instance_eval(&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.



109
110
111
112
 
# File 'lib/factory_girl/definition_proxy.rb', line 109

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

#to_create(&block) ⇒ Object 



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

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

#trait(name, &block) ⇒ Object 



161
162
163
 
# File 'lib/factory_girl/definition_proxy.rb', line 161

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