Class: FactoryBot::Definition Private

Inherits:
Object
  • Object
show all
Defined in:
lib/factory_bot/definition.rb

This class is part of a private API. You should avoid using this class if possible, as it may be removed or be changed in the future.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, base_traits = []) ⇒ Definition

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of Definition.



6
7
8
9
10
11
12
13
14
15
16
17
 
# File 'lib/factory_bot/definition.rb', line 6

def initialize(name, base_traits = [])
  @name              = name
  @declarations      = DeclarationList.new(name)
  @callbacks         = []
  @defined_traits    = Set.new
  @to_create         = nil
  @base_traits       = base_traits
  @additional_traits = []
  @constructor       = nil
  @attributes        = nil
  @compiled          = false
end

Instance Attribute Details

#declarations ⇒ Object (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



4
5
6
 
# File 'lib/factory_bot/definition.rb', line 4

def declarations
  @declarations
end

#defined_traits ⇒ Object (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



4
5
6
 
# File 'lib/factory_bot/definition.rb', line 4

def defined_traits
  @defined_traits
end

#name ⇒ Object (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



4
5
6
 
# File 'lib/factory_bot/definition.rb', line 4

def name
  @name
end

Instance Method Details

#add_callback(callback) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



72
73
74
 
# File 'lib/factory_bot/definition.rb', line 72

def add_callback(callback)
  @callbacks << callback
end

#after(*names, &block) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



92
93
94
 
# File 'lib/factory_bot/definition.rb', line 92

def after(*names, &block)
  callback(*names.map { |name| "after_#{name}" }, &block)
end

#append_traits(new_traits) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



68
69
70
 
# File 'lib/factory_bot/definition.rb', line 68

def append_traits(new_traits)
  @additional_traits += new_traits
end

#attributes ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



21
22
23
24
25
26
27
28
 
# File 'lib/factory_bot/definition.rb', line 21

def attributes
  @attributes ||= AttributeList.new.tap do |attribute_list|
    attribute_lists = aggregate_from_traits_and_self(:attributes) { declarations.attributes }
    attribute_lists.each do |attributes|
      attribute_list.apply_attributes attributes
    end
  end
end

#before(*names, &block) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



88
89
90
 
# File 'lib/factory_bot/definition.rb', line 88

def before(*names, &block)
  callback(*names.map { |name| "before_#{name}" }, &block)
end

#callback(*names, &block) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



96
97
98
99
100
101
 
# File 'lib/factory_bot/definition.rb', line 96

def callback(*names, &block)
  names.each do |name|
    FactoryBot::Internal.register_callback(name)
    add_callback(Callback.new(name, block))
  end
end

#callbacks ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



42
43
44
 
# File 'lib/factory_bot/definition.rb', line 42

def callbacks
  aggregate_from_traits_and_self(:callbacks) { @callbacks }
end

#compile ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/factory_bot/definition.rb', line 46

def compile
  unless @compiled
    declarations.attributes

    defined_traits.each do |defined_trait|
      base_traits.each       { |bt| bt.define_trait defined_trait }
      additional_traits.each { |at| at.define_trait defined_trait }
    end

    @compiled = true
  end
end

#constructor ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



38
39
40
 
# File 'lib/factory_bot/definition.rb', line 38

def constructor
  aggregate_from_traits_and_self(:constructor) { @constructor }.last
end

#define_constructor(&block) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



84
85
86
 
# File 'lib/factory_bot/definition.rb', line 84

def define_constructor(&block)
  @constructor = block
end

#define_trait(trait) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



80
81
82
 
# File 'lib/factory_bot/definition.rb', line 80

def define_trait(trait)
  @defined_traits.add(trait)
end

#inherit_traits(new_traits) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



64
65
66
 
# File 'lib/factory_bot/definition.rb', line 64

def inherit_traits(new_traits)
  @base_traits += new_traits
end

#overridable ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



59
60
61
62
 
# File 'lib/factory_bot/definition.rb', line 59

def overridable
  declarations.overridable
  self
end

#skip_create ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



76
77
78
 
# File 'lib/factory_bot/definition.rb', line 76

def skip_create
  @to_create = ->(instance) {}
end

#to_create(&block) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



30
31
32
33
34
35
36
 
# File 'lib/factory_bot/definition.rb', line 30

def to_create(&block)
  if block_given?
    @to_create = block
  else
    aggregate_from_traits_and_self(:to_create) { @to_create }.last
  end
end