Module: Factory

Defined in:
lib/factory_girl/syntax/vintage.rb

Class Method Summary collapse

Class Method Details

.alias(pattern, replace) ⇒ Object

Defines a new alias for attributes.

Arguments:

  • pattern: Regexp A pattern that will be matched against attributes when looking for aliases. Contents captured in the pattern can be used in the alias.

  • replace: String The alias that results from the matched pattern. Captured strings can be substituted like with String#sub.

Example:

Factory.alias /(.*)_confirmation/, '\1'

factory_girl starts with aliases for foreign keys, so that a :user association can be overridden by a :user_id parameter:

Factory.define :post do |p|
  p.association :user
end

# The user association will not be built in this example. The user_id
# will be used instead.
Factory(:post, user_id: 1)



88
89
90
91
 
# File 'lib/factory_girl/syntax/vintage.rb', line 88

def self.alias(pattern, replace)
  ActiveSupport::Deprecation.warn 'Factory.alias is deprecated; use FactoryGirl.aliases << [pattern, replace] instead.', caller
  FactoryGirl.aliases << [pattern, replace]
end

.attributes_for(name, overrides = {}) ⇒ Object

Alias for FactoryGirl.attributes_for



94
95
96
97
 
# File 'lib/factory_girl/syntax/vintage.rb', line 94

def self.attributes_for(name, overrides = {})
  ActiveSupport::Deprecation.warn 'Factory.attributes_for is deprecated; use FactoryGirl.attributes_for instead.', caller
  FactoryGirl.attributes_for(name, overrides)
end

.build(name, overrides = {}) ⇒ Object

Alias for FactoryGirl.build



100
101
102
103
 
# File 'lib/factory_girl/syntax/vintage.rb', line 100

def self.build(name, overrides = {})
  ActiveSupport::Deprecation.warn 'Factory.build is deprecated; use FactoryGirl.build instead.', caller
  FactoryGirl.build(name, overrides)
end

.create(name, overrides = {}) ⇒ Object

Alias for FactoryGirl.create



106
107
108
109
 
# File 'lib/factory_girl/syntax/vintage.rb', line 106

def self.create(name, overrides = {})
  ActiveSupport::Deprecation.warn 'Factory.create is deprecated; use FactoryGirl.create instead.', caller
  FactoryGirl.create(name, overrides)
end

.define(name, options = {}) {|proxy| ... } ⇒ Object

Defines a new factory that can be used by the build strategies (create and build) to build new objects.

Arguments:

  • name: Symbol or String A unique name used to identify this factory.

  • options: Hash

Options:

  • class: Symbol, Class, or String The class that will be used when generating instances for this factory. If not specified, the class will be guessed from the factory name.

  • parent: Symbol The parent factory. If specified, the attributes from the parent factory will be copied to the current one with an ability to override them.

Yields: Factory The newly created factory.

Yields:

  • (proxy) 


23
24
25
26
27
28
29
 
# File 'lib/factory_girl/syntax/vintage.rb', line 23

def self.define(name, options = {})
  ActiveSupport::Deprecation.warn 'Factory.define is deprecated; use the FactoryGirl.define block syntax to declare your factory.', caller
  factory = FactoryGirl::Factory.new(name, options)
  proxy = FactoryGirl::DefinitionProxy.new(factory)
  yield(proxy)
  FactoryGirl.register_factory(factory)
end

.next(name) ⇒ Object

Generates and returns the next value in a sequence.

Arguments:

name: (Symbol)
  The name of the sequence that a value should be generated for.

Returns:

The next value in the sequence. (Object)



59
60
61
62
 
# File 'lib/factory_girl/syntax/vintage.rb', line 59

def self.next(name)
  ActiveSupport::Deprecation.warn 'Factory.next is deprecated; use FactoryGirl.generate instead.', caller
  FactoryGirl.generate(name)
end

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

Defines a new sequence that can be used to generate unique values in a specific format.

Arguments:

name: (Symbol)
  A unique name for this sequence. This name will be referenced when
  calling next to generate new values from this sequence.
block: (Proc)
  The code to generate each value in the sequence. This block will be
  called with a unique number each time a value in the sequence is to be
  generated. The block should return the generated value for the
  sequence.

Example:

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



46
47
48
49
 
# File 'lib/factory_girl/syntax/vintage.rb', line 46

def self.sequence(name, start_value = 1, &block)
  ActiveSupport::Deprecation.warn 'Factory.sequence is deprecated; use the FactoryGirl.define block syntax to declare your sequence.', caller
  FactoryGirl.register_sequence(Sequence.new(name, start_value, &block))
end

.stub(name, overrides = {}) ⇒ Object

Alias for FactoryGirl.build_stubbed.



112
113
114
115
 
# File 'lib/factory_girl/syntax/vintage.rb', line 112

def self.stub(name, overrides = {})
  ActiveSupport::Deprecation.warn 'Factory.stub is deprecated; use FactoryGirl.build_stubbed instead.', caller
  FactoryGirl.build_stubbed(name, overrides)
end