Class: FactoryGirl::DefinitionProxy

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

Constant Summary

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

Instance Attribute Summary (collapse)

Instance Method Summary (collapse)

Constructor Details

- (DefinitionProxy) initialize(definition, ignore = false)

Returns a new instance of DefinitionProxy



13
14
15
16
17
# File 'lib/factory_girl/definition_proxy.rb', line 13

def initialize(definition, ignore = false)
  @definition      = definition
  @ignore          = ignore
  @child_factories = []
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

- (Object) method_missing(name, *args, &block)

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.



90
91
92
93
94
95
96
97
98
# File 'lib/factory_girl/definition_proxy.rb', line 90

def method_missing(name, *args, &block)
  if args.empty? && block.nil?
    @definition.declare_attribute(Declaration::Implicit.new(name, @definition, @ignore))
  elsif args.first.respond_to?(:has_key?) && args.first.has_key?(:factory)
    association(name, *args)
  else
    add_attribute(name, *args, &block)
  end
end

Instance Attribute Details

- (Object) child_factories (readonly)

Returns the value of attribute child_factories



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

def child_factories
  @child_factories
end

Instance Method Details

- (Object) add_attribute(name, value = nil, &block)

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::Strategy 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.



42
43
44
45
46
47
48
49
50
51
52
# File 'lib/factory_girl/definition_proxy.rb', line 42

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

  @definition.declare_attribute(declaration)
end

- (Object) association(name, *options)

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.


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

def association(name, *options)
  @definition.declare_attribute(Declaration::Association.new(name, *options))
end

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



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

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

- (Object) ignore(&block)



54
55
56
57
# File 'lib/factory_girl/definition_proxy.rb', line 54

def ignore(&block)
  proxy = DefinitionProxy.new(@definition, true)
  proxy.instance_eval(&block)
end

- (Object) initialize_with(&block)



164
165
166
# File 'lib/factory_girl/definition_proxy.rb', line 164

def initialize_with(&block)
  @definition.define_constructor(&block)
end

- (Object) sequence(name, *args, &block)

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.



116
117
118
119
# File 'lib/factory_girl/definition_proxy.rb', line 116

def sequence(name, *args, &block)
  sequence = Sequence.new(name, *args, &block)
  add_attribute(name) { increment_sequence(sequence) }
end

- (Object) singleton_method_added(name)



19
20
21
22
# File 'lib/factory_girl/definition_proxy.rb', line 19

def singleton_method_added(name)
  message = "Defining methods in blocks (trait or factory) is not supported (#{name})"
  raise FactoryGirl::MethodDefinitionError, message
end

- (Object) skip_create



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

def skip_create
  @definition.skip_create
end

- (Object) to_create(&block)



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

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

- (Object) trait(name, &block)



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

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