agibralter-factory_girl 1.2.1
Sign up to get free protection for your applications and to get access to all the features.
- data/CONTRIBUTION_GUIDELINES.rdoc +10 -0
- data/Changelog +29 -0
- data/LICENSE +19 -0
- data/README.rdoc +228 -0
- data/Rakefile +74 -0
- data/lib/factory_girl.rb +35 -0
- data/lib/factory_girl/aliases.rb +50 -0
- data/lib/factory_girl/attribute.rb +29 -0
- data/lib/factory_girl/attribute/association.rb +18 -0
- data/lib/factory_girl/attribute/dynamic.rb +20 -0
- data/lib/factory_girl/attribute/static.rb +17 -0
- data/lib/factory_girl/callback.rb +25 -0
- data/lib/factory_girl/factory.rb +393 -0
- data/lib/factory_girl/proxy.rb +66 -0
- data/lib/factory_girl/proxy/attributes_for.rb +21 -0
- data/lib/factory_girl/proxy/build.rb +29 -0
- data/lib/factory_girl/proxy/create.rb +24 -0
- data/lib/factory_girl/proxy/stub.rb +49 -0
- data/lib/factory_girl/sequence.rb +63 -0
- data/lib/factory_girl/syntax.rb +12 -0
- data/lib/factory_girl/syntax/blueprint.rb +42 -0
- data/lib/factory_girl/syntax/generate.rb +68 -0
- data/lib/factory_girl/syntax/make.rb +39 -0
- data/lib/factory_girl/syntax/sham.rb +42 -0
- data/spec/factory_girl/aliases_spec.rb +29 -0
- data/spec/factory_girl/attribute/association_spec.rb +25 -0
- data/spec/factory_girl/attribute/dynamic_spec.rb +49 -0
- data/spec/factory_girl/attribute/static_spec.rb +29 -0
- data/spec/factory_girl/attribute_spec.rb +30 -0
- data/spec/factory_girl/callback_spec.rb +43 -0
- data/spec/factory_girl/factory_spec.rb +519 -0
- data/spec/factory_girl/proxy/attributes_for_spec.rb +52 -0
- data/spec/factory_girl/proxy/build_spec.rb +73 -0
- data/spec/factory_girl/proxy/create_spec.rb +83 -0
- data/spec/factory_girl/proxy/stub_spec.rb +69 -0
- data/spec/factory_girl/proxy_spec.rb +28 -0
- data/spec/factory_girl/sequence_spec.rb +66 -0
- data/spec/factory_girl/syntax/blueprint_spec.rb +34 -0
- data/spec/factory_girl/syntax/generate_spec.rb +57 -0
- data/spec/factory_girl/syntax/make_spec.rb +35 -0
- data/spec/factory_girl/syntax/sham_spec.rb +35 -0
- data/spec/integration_spec.rb +314 -0
- data/spec/models.rb +43 -0
- data/spec/spec_helper.rb +18 -0
- metadata +116 -0
@@ -0,0 +1,66 @@
|
|
1
|
+
class Factory
|
2
|
+
|
3
|
+
class Proxy #:nodoc:
|
4
|
+
def initialize(klass)
|
5
|
+
end
|
6
|
+
|
7
|
+
def get(attribute)
|
8
|
+
nil
|
9
|
+
end
|
10
|
+
|
11
|
+
def set(attribute, value)
|
12
|
+
end
|
13
|
+
|
14
|
+
def add_callback(name, callback)
|
15
|
+
nil
|
16
|
+
end
|
17
|
+
|
18
|
+
def associate(name, factory, attributes)
|
19
|
+
end
|
20
|
+
|
21
|
+
# Generates an association using the current build strategy.
|
22
|
+
#
|
23
|
+
# Arguments:
|
24
|
+
# name: (Symbol)
|
25
|
+
# The name of the factory that should be used to generate this
|
26
|
+
# association.
|
27
|
+
# attributes: (Hash)
|
28
|
+
# A hash of attributes that should be overridden for this association.
|
29
|
+
#
|
30
|
+
# Returns:
|
31
|
+
# The generated association for the current build strategy. Note that
|
32
|
+
# assocaitions are not generated for the attributes_for strategy. Returns
|
33
|
+
# nil in this case.
|
34
|
+
#
|
35
|
+
# Example:
|
36
|
+
#
|
37
|
+
# Factory.define :user do |f|
|
38
|
+
# # ...
|
39
|
+
# end
|
40
|
+
#
|
41
|
+
# Factory.define :post do |f|
|
42
|
+
# # ...
|
43
|
+
# f.author {|a| a.association :user, :name => 'Joe' }
|
44
|
+
# end
|
45
|
+
#
|
46
|
+
# # Builds (but doesn't save) a Post and a User
|
47
|
+
# Factory.build(:post)
|
48
|
+
#
|
49
|
+
# # Builds and saves a User, builds a Post, assigns the User to the
|
50
|
+
# # author association, and saves the User.
|
51
|
+
# Factory.create(:post)
|
52
|
+
#
|
53
|
+
def association(name, overrides = {})
|
54
|
+
nil
|
55
|
+
end
|
56
|
+
|
57
|
+
def method_missing(method, *args, &block)
|
58
|
+
get(method)
|
59
|
+
end
|
60
|
+
|
61
|
+
def result
|
62
|
+
raise NotImplementedError, "Strategies must return a result"
|
63
|
+
end
|
64
|
+
end
|
65
|
+
|
66
|
+
end
|
@@ -0,0 +1,21 @@
|
|
1
|
+
class Factory
|
2
|
+
class Proxy #:nodoc:
|
3
|
+
class AttributesFor < Proxy #:nodoc:
|
4
|
+
def initialize(klass)
|
5
|
+
@hash = {}
|
6
|
+
end
|
7
|
+
|
8
|
+
def get(attribute)
|
9
|
+
@hash[attribute]
|
10
|
+
end
|
11
|
+
|
12
|
+
def set(attribute, value)
|
13
|
+
@hash[attribute] = value
|
14
|
+
end
|
15
|
+
|
16
|
+
def result
|
17
|
+
@hash
|
18
|
+
end
|
19
|
+
end
|
20
|
+
end
|
21
|
+
end
|
@@ -0,0 +1,29 @@
|
|
1
|
+
class Factory
|
2
|
+
class Proxy #:nodoc:
|
3
|
+
class Build < Proxy #:nodoc:
|
4
|
+
def initialize(klass)
|
5
|
+
@instance = klass.new
|
6
|
+
end
|
7
|
+
|
8
|
+
def get(attribute)
|
9
|
+
@instance.send(attribute)
|
10
|
+
end
|
11
|
+
|
12
|
+
def set(attribute, value)
|
13
|
+
@instance.send(:"#{attribute}=", value)
|
14
|
+
end
|
15
|
+
|
16
|
+
def associate(name, factory, attributes)
|
17
|
+
set(name, Factory.create(factory, attributes))
|
18
|
+
end
|
19
|
+
|
20
|
+
def association(factory, overrides = {})
|
21
|
+
Factory.create(factory, overrides)
|
22
|
+
end
|
23
|
+
|
24
|
+
def result
|
25
|
+
@instance
|
26
|
+
end
|
27
|
+
end
|
28
|
+
end
|
29
|
+
end
|
@@ -0,0 +1,24 @@
|
|
1
|
+
class Factory
|
2
|
+
class Proxy #:nodoc:
|
3
|
+
class Create < Build #:nodoc:
|
4
|
+
def initialize(klass)
|
5
|
+
@instance = klass.new
|
6
|
+
@callbacks = {
|
7
|
+
:before_save => [],
|
8
|
+
:after_save => []
|
9
|
+
}
|
10
|
+
end
|
11
|
+
|
12
|
+
def result
|
13
|
+
@callbacks[:before_save].each { |c| c.execute(@instance) }
|
14
|
+
@instance.save!
|
15
|
+
@callbacks[:after_save].each { |c| c.execute(@instance) }
|
16
|
+
@instance
|
17
|
+
end
|
18
|
+
|
19
|
+
def add_callback(name, callback)
|
20
|
+
@callbacks[name] << callback
|
21
|
+
end
|
22
|
+
end
|
23
|
+
end
|
24
|
+
end
|
@@ -0,0 +1,49 @@
|
|
1
|
+
class Factory
|
2
|
+
class Proxy
|
3
|
+
class Stub < Proxy #:nodoc:
|
4
|
+
@@next_id = 1000
|
5
|
+
|
6
|
+
def initialize(klass)
|
7
|
+
@stub = klass.new
|
8
|
+
@stub.id = next_id
|
9
|
+
@stub.instance_eval do
|
10
|
+
def new_record?
|
11
|
+
id.nil?
|
12
|
+
end
|
13
|
+
|
14
|
+
def connection
|
15
|
+
raise "stubbed models are not allowed to access the database"
|
16
|
+
end
|
17
|
+
|
18
|
+
def reload
|
19
|
+
raise "stubbed models are not allowed to access the database"
|
20
|
+
end
|
21
|
+
end
|
22
|
+
end
|
23
|
+
|
24
|
+
def next_id
|
25
|
+
@@next_id += 1
|
26
|
+
end
|
27
|
+
|
28
|
+
def get(attribute)
|
29
|
+
@stub.send(attribute)
|
30
|
+
end
|
31
|
+
|
32
|
+
def set(attribute, value)
|
33
|
+
@stub.send(:"#{attribute}=", value)
|
34
|
+
end
|
35
|
+
|
36
|
+
def associate(name, factory, attributes)
|
37
|
+
set(name, Factory.stub(factory, attributes))
|
38
|
+
end
|
39
|
+
|
40
|
+
def association(factory, overrides = {})
|
41
|
+
Factory.stub(factory, overrides)
|
42
|
+
end
|
43
|
+
|
44
|
+
def result
|
45
|
+
@stub
|
46
|
+
end
|
47
|
+
end
|
48
|
+
end
|
49
|
+
end
|
@@ -0,0 +1,63 @@
|
|
1
|
+
class Factory
|
2
|
+
|
3
|
+
# Raised when calling Factory.sequence from a dynamic attribute block
|
4
|
+
class SequenceAbuseError < StandardError; end
|
5
|
+
|
6
|
+
# Sequences are defined using Factory.sequence. Sequence values are generated
|
7
|
+
# using next.
|
8
|
+
class Sequence
|
9
|
+
|
10
|
+
def initialize (&proc) #:nodoc:
|
11
|
+
@proc = proc
|
12
|
+
@value = 0
|
13
|
+
end
|
14
|
+
|
15
|
+
# Returns the next value for this sequence
|
16
|
+
def next
|
17
|
+
@value += 1
|
18
|
+
@proc.call(@value)
|
19
|
+
end
|
20
|
+
|
21
|
+
end
|
22
|
+
|
23
|
+
class << self
|
24
|
+
attr_accessor :sequences #:nodoc:
|
25
|
+
end
|
26
|
+
self.sequences = {}
|
27
|
+
|
28
|
+
# Defines a new sequence that can be used to generate unique values in a specific format.
|
29
|
+
#
|
30
|
+
# Arguments:
|
31
|
+
# name: (Symbol)
|
32
|
+
# A unique name for this sequence. This name will be referenced when
|
33
|
+
# calling next to generate new values from this sequence.
|
34
|
+
# block: (Proc)
|
35
|
+
# The code to generate each value in the sequence. This block will be
|
36
|
+
# called with a unique number each time a value in the sequence is to be
|
37
|
+
# generated. The block should return the generated value for the
|
38
|
+
# sequence.
|
39
|
+
#
|
40
|
+
# Example:
|
41
|
+
#
|
42
|
+
# Factory.sequence(:email) {|n| "somebody_#{n}@example.com" }
|
43
|
+
def self.sequence (name, &block)
|
44
|
+
self.sequences[name] = Sequence.new(&block)
|
45
|
+
end
|
46
|
+
|
47
|
+
# Generates and returns the next value in a sequence.
|
48
|
+
#
|
49
|
+
# Arguments:
|
50
|
+
# name: (Symbol)
|
51
|
+
# The name of the sequence that a value should be generated for.
|
52
|
+
#
|
53
|
+
# Returns:
|
54
|
+
# The next value in the sequence. (Object)
|
55
|
+
def self.next (sequence)
|
56
|
+
unless self.sequences.key?(sequence)
|
57
|
+
raise "No such sequence: #{sequence}"
|
58
|
+
end
|
59
|
+
|
60
|
+
self.sequences[sequence].next
|
61
|
+
end
|
62
|
+
|
63
|
+
end
|
@@ -0,0 +1,12 @@
|
|
1
|
+
class Factory
|
2
|
+
# Provides alternate syntaxes for factory_girl. If you don't like the default
|
3
|
+
# syntax for defining or using factories, look at one of the Factory::Syntax
|
4
|
+
# modules:
|
5
|
+
#
|
6
|
+
# * Factory::Syntax::Blueprint: definition syntax similar to Machinist
|
7
|
+
# * Factory::Syntax::Generate: usage syntax similar to Object Daddy
|
8
|
+
# * Factory::Syntax::Make: usage syntax similar to Machinist
|
9
|
+
# * Factory::Syntax::Sham: sequence syntax similar to Machinist
|
10
|
+
module Syntax
|
11
|
+
end
|
12
|
+
end
|
@@ -0,0 +1,42 @@
|
|
1
|
+
class Factory
|
2
|
+
module Syntax
|
3
|
+
|
4
|
+
# Extends ActiveRecord::Base to provide a make class method, which is an
|
5
|
+
# alternate syntax for defining factories.
|
6
|
+
#
|
7
|
+
# Usage:
|
8
|
+
#
|
9
|
+
# require 'factory_girl/syntax/blueprint'
|
10
|
+
#
|
11
|
+
# User.blueprint do
|
12
|
+
# name { 'Billy Bob' }
|
13
|
+
# email { 'billy@bob.example.com' }
|
14
|
+
# end
|
15
|
+
#
|
16
|
+
# Factory(:user, :name => 'Johnny')
|
17
|
+
#
|
18
|
+
# This syntax was derived from Pete Yandell's machinist.
|
19
|
+
module Blueprint
|
20
|
+
module ActiveRecord #:nodoc:
|
21
|
+
|
22
|
+
def self.included(base) # :nodoc:
|
23
|
+
base.extend ClassMethods
|
24
|
+
end
|
25
|
+
|
26
|
+
module ClassMethods #:nodoc:
|
27
|
+
|
28
|
+
def blueprint(&block)
|
29
|
+
instance = Factory.new(name.underscore, :class => self)
|
30
|
+
instance.instance_eval(&block)
|
31
|
+
Factory.factories[instance.factory_name] = instance
|
32
|
+
end
|
33
|
+
|
34
|
+
end
|
35
|
+
|
36
|
+
end
|
37
|
+
end
|
38
|
+
end
|
39
|
+
end
|
40
|
+
|
41
|
+
ActiveRecord::Base.send(:include, Factory::Syntax::Blueprint::ActiveRecord)
|
42
|
+
|
@@ -0,0 +1,68 @@
|
|
1
|
+
class Factory
|
2
|
+
module Syntax
|
3
|
+
|
4
|
+
# Extends ActiveRecord::Base to provide generation methods for factories.
|
5
|
+
#
|
6
|
+
# Usage:
|
7
|
+
#
|
8
|
+
# require 'factory_girl/syntax/generate'
|
9
|
+
#
|
10
|
+
# Factory.define :user do |factory|
|
11
|
+
# factory.name 'Billy Bob'
|
12
|
+
# factory.email 'billy@bob.example.com'
|
13
|
+
# end
|
14
|
+
#
|
15
|
+
# # Creates a saved instance without raising (same as saving the result
|
16
|
+
# # of Factory.build)
|
17
|
+
# User.generate(:name => 'Johnny')
|
18
|
+
#
|
19
|
+
# # Creates a saved instance and raises when invalid (same as
|
20
|
+
# # Factory.create)
|
21
|
+
# User.generate!
|
22
|
+
#
|
23
|
+
# # Creates an unsaved instance (same as Factory.build)
|
24
|
+
# User.spawn
|
25
|
+
#
|
26
|
+
# # Creates an instance and yields it to the passed block
|
27
|
+
# User.generate do |user|
|
28
|
+
# # ...do something with user...
|
29
|
+
# end
|
30
|
+
#
|
31
|
+
# This syntax was derived from Rick Bradley and Yossef Mendelssohn's
|
32
|
+
# object_daddy.
|
33
|
+
module Generate
|
34
|
+
module ActiveRecord #:nodoc:
|
35
|
+
|
36
|
+
def self.included(base) # :nodoc:
|
37
|
+
base.extend ClassMethods
|
38
|
+
end
|
39
|
+
|
40
|
+
module ClassMethods #:nodoc:
|
41
|
+
|
42
|
+
def generate(overrides = {}, &block)
|
43
|
+
instance = Factory.build(name.underscore, overrides)
|
44
|
+
instance.save
|
45
|
+
yield(instance) if block_given?
|
46
|
+
instance
|
47
|
+
end
|
48
|
+
|
49
|
+
def generate!(overrides = {}, &block)
|
50
|
+
instance = Factory.create(name.underscore, overrides)
|
51
|
+
yield(instance) if block_given?
|
52
|
+
instance
|
53
|
+
end
|
54
|
+
|
55
|
+
def spawn(overrides = {}, &block)
|
56
|
+
instance = Factory.build(name.underscore, overrides)
|
57
|
+
yield(instance) if block_given?
|
58
|
+
instance
|
59
|
+
end
|
60
|
+
|
61
|
+
end
|
62
|
+
|
63
|
+
end
|
64
|
+
end
|
65
|
+
end
|
66
|
+
end
|
67
|
+
|
68
|
+
ActiveRecord::Base.send(:include, Factory::Syntax::Generate::ActiveRecord)
|
@@ -0,0 +1,39 @@
|
|
1
|
+
class Factory
|
2
|
+
module Syntax
|
3
|
+
|
4
|
+
# Extends ActiveRecord::Base to provide a make class method, which is a
|
5
|
+
# shortcut for Factory.create.
|
6
|
+
#
|
7
|
+
# Usage:
|
8
|
+
#
|
9
|
+
# require 'factory_girl/syntax/make'
|
10
|
+
#
|
11
|
+
# Factory.define :user do |factory|
|
12
|
+
# factory.name 'Billy Bob'
|
13
|
+
# factory.email 'billy@bob.example.com'
|
14
|
+
# end
|
15
|
+
#
|
16
|
+
# User.make(:name => 'Johnny')
|
17
|
+
#
|
18
|
+
# This syntax was derived from Pete Yandell's machinist.
|
19
|
+
module Make
|
20
|
+
module ActiveRecord #:nodoc:
|
21
|
+
|
22
|
+
def self.included(base) # :nodoc:
|
23
|
+
base.extend ClassMethods
|
24
|
+
end
|
25
|
+
|
26
|
+
module ClassMethods #:nodoc:
|
27
|
+
|
28
|
+
def make(overrides = {})
|
29
|
+
Factory.create(name.underscore, overrides)
|
30
|
+
end
|
31
|
+
|
32
|
+
end
|
33
|
+
|
34
|
+
end
|
35
|
+
end
|
36
|
+
end
|
37
|
+
end
|
38
|
+
|
39
|
+
ActiveRecord::Base.send(:include, Factory::Syntax::Make::ActiveRecord)
|
@@ -0,0 +1,42 @@
|
|
1
|
+
class Factory
|
2
|
+
module Syntax
|
3
|
+
|
4
|
+
# Adds a Sham module, which provides an alternate interface to
|
5
|
+
# Factory::Sequence.
|
6
|
+
#
|
7
|
+
# Usage:
|
8
|
+
#
|
9
|
+
# require 'factory_girl/syntax/sham'
|
10
|
+
#
|
11
|
+
# Sham.email {|n| "somebody#{n}@example.com" }
|
12
|
+
#
|
13
|
+
# Factory.define :user do |factory|
|
14
|
+
# factory.email { Sham.email }
|
15
|
+
# end
|
16
|
+
#
|
17
|
+
# Note that you can also use Faker, but it is recommended that you simply
|
18
|
+
# use a sequence as in the above example, as factory_girl does not provide
|
19
|
+
# protection against duplication in randomized sequences, and a randomized
|
20
|
+
# value does not provide any tangible benefits over an ascending sequence.
|
21
|
+
#
|
22
|
+
# This syntax was derived from Pete Yandell's machinist.
|
23
|
+
module Sham
|
24
|
+
module Sham #:nodoc:
|
25
|
+
def self.method_missing(name, &block)
|
26
|
+
if block_given?
|
27
|
+
Factory.sequence(name, &block)
|
28
|
+
else
|
29
|
+
Factory.next(name)
|
30
|
+
end
|
31
|
+
end
|
32
|
+
|
33
|
+
# overrides name on Module
|
34
|
+
def self.name(&block)
|
35
|
+
method_missing('name', &block)
|
36
|
+
end
|
37
|
+
end
|
38
|
+
end
|
39
|
+
end
|
40
|
+
end
|
41
|
+
|
42
|
+
include Factory::Syntax::Sham
|