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.



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

def initialize(name, base_traits = [])
  @name = name
  @declarations = DeclarationList.new(name)
  @callbacks = []
  @defined_traits = Set.new
  @registered_enums = []
  @to_create = nil
  @base_traits = base_traits
  @additional_traits = []
  @constructor = nil
  @attributes = nil
  @compiled = false
  @expanded_enum_traits = 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

#klass ⇒ 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. 



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

def klass
  @klass
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

#registered_enums ⇒ 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 registered_enums
  @registered_enums
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. 



86
87
88
 
# File 'lib/factory_bot/definition.rb', line 86

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. 



110
111
112
 
# File 'lib/factory_bot/definition.rb', line 110

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. 



82
83
84
 
# File 'lib/factory_bot/definition.rb', line 82

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. 



24
25
26
27
28
29
30
31
 
# File 'lib/factory_bot/definition.rb', line 24

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. 



106
107
108
 
# File 'lib/factory_bot/definition.rb', line 106

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. 



114
115
116
117
118
 
# File 'lib/factory_bot/definition.rb', line 114

def callback(*names, &block)
  names.each do |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. 



45
46
47
 
# File 'lib/factory_bot/definition.rb', line 45

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

#compile(klass = nil) ⇒ 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. 



49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/factory_bot/definition.rb', line 49

def compile(klass = nil)
  unless @compiled
    expand_enum_traits(klass) unless klass.nil?

    declarations.attributes

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

    @compiled = true

    ActiveSupport::Notifications.instrument "factory_bot.compile_factory", {
      name: name,
      attributes: declarations.attributes,
      traits: defined_traits,
      class: klass || self.klass
    }
  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. 



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

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. 



102
103
104
 
# File 'lib/factory_bot/definition.rb', line 102

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. 



94
95
96
 
# File 'lib/factory_bot/definition.rb', line 94

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. 



78
79
80
 
# File 'lib/factory_bot/definition.rb', line 78

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. 



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

def overridable
  declarations.overridable
  self
end

#register_enum(enum) ⇒ 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. 



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

def register_enum(enum)
  @registered_enums << enum
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. 



90
91
92
 
# File 'lib/factory_bot/definition.rb', line 90

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. 



33
34
35
36
37
38
39
 
# File 'lib/factory_bot/definition.rb', line 33

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