Class: Serverkit::Resources::Base

Inherits:
Object
  • Object
show all
Includes:
ActiveModel::Validations
Defined in:
lib/serverkit/resources/base.rb

Class Attribute Summary collapse

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(recipe, attributes) ⇒ Base

Returns a new instance of Base.

Parameters:



54
55
56
57
 
# File 'lib/serverkit/resources/base.rb', line 54

def initialize(recipe, attributes)
  @attributes = attributes
  @recipe = recipe
end

Class Attribute Details

.abstract_class=(value) ⇒ Object (writeonly)

Sets the attribute abstract_class

Parameters:

  • value —

    the value to set the attribute abstract_class to.



15
16
17
 
# File 'lib/serverkit/resources/base.rb', line 15

def abstract_class=(value)
  @abstract_class = value
end

Instance Attribute Details

#attributes ⇒ Object (readonly)

Returns the value of attribute attributes.



35
36
37
 
# File 'lib/serverkit/resources/base.rb', line 35

def attributes
  @attributes
end

#backend ⇒ Object

Returns the value of attribute backend.



33
34
35
 
# File 'lib/serverkit/resources/base.rb', line 33

def backend
  @backend
end

#check_result ⇒ Object (readonly)

Returns the value of attribute check_result.



35
36
37
 
# File 'lib/serverkit/resources/base.rb', line 35

def check_result
  @check_result
end

#recheck_result ⇒ Object (readonly)

Returns the value of attribute recheck_result.



35
36
37
 
# File 'lib/serverkit/resources/base.rb', line 35

def recheck_result
  @recheck_result
end

#recipe ⇒ Object (readonly)

Returns the value of attribute recipe.



35
36
37
 
# File 'lib/serverkit/resources/base.rb', line 35

def recipe
  @recipe
end

Class Method Details

.abstract_class? ⇒ Boolean

Returns:

  • (Boolean) 


17
18
19
 
# File 'lib/serverkit/resources/base.rb', line 17

def abstract_class?
  !!@abstract_class
end

.attribute(name, options = {}) ⇒ Object

Note:

DSL method to define attribute with its validations



22
23
24
25
26
27
28
 
# File 'lib/serverkit/resources/base.rb', line 22

def attribute(name, options = {})
  default = options.delete(:default)
  define_method(name) do
    @attributes[name.to_s] || default
  end
  validates name, options unless options.empty?
end

Instance Method Details

#all_errors ⇒ Array<Serverkit::Errors::Base>

Note:

For override

Returns:



61
62
63
 
# File 'lib/serverkit/resources/base.rb', line 61

def all_errors
  attribute_validation_errors
end

#check_command(*args) ⇒ true, false

Returns:

  • (true, false) 


66
67
68
 
# File 'lib/serverkit/resources/base.rb', line 66

def check_command(*args)
  run_command(*args).success?
end

#check_command_from_identifier(*args) ⇒ true, false

Returns:

  • (true, false) 


71
72
73
 
# File 'lib/serverkit/resources/base.rb', line 71

def check_command_from_identifier(*args)
  run_command_from_identifier(*args).success?
end

#get_command_from_identifier(*args) ⇒ String

Returns:

  • (String) 


76
77
78
 
# File 'lib/serverkit/resources/base.rb', line 76

def get_command_from_identifier(*args)
  backend.command.get(*args)
end

#handlers ⇒ Array<Serverkit::Resource>

Returns:

  • (Array<Serverkit::Resource>) 


81
82
83
84
85
86
87
 
# File 'lib/serverkit/resources/base.rb', line 81

def handlers
  @handlers ||= Array(notify).map do |id|
    recipe.handlers.find do |handler|
      handler.id == id
    end
  end.compact
end

#id ⇒ String

Note:

For logging and notifying

Returns:

  • (String) 


91
92
93
 
# File 'lib/serverkit/resources/base.rb', line 91

def id
  @attributes["id"] || default_id
end

#notifiable? ⇒ true, false

Returns True if this resource should call any handler.

Returns:

  • (true, false) —

    True if this resource should call any handler



96
97
98
 
# File 'lib/serverkit/resources/base.rb', line 96

def notifiable?
  @recheck_result == true && !handlers.nil?
end

#run_apply ⇒ Object

Note:

#check and #apply wrapper



101
102
103
104
105
106
 
# File 'lib/serverkit/resources/base.rb', line 101

def run_apply
  unless run_check
    apply
    @recheck_result = !!recheck_with_script
  end
end

#run_check ⇒ true, false

Note:

#check wrapper

Returns:

  • (true, false) 


110
111
112
 
# File 'lib/serverkit/resources/base.rb', line 110

def run_check
  @check_result = !!check_with_script
end

#successful? ⇒ Boolean

Returns:

  • (Boolean) 


114
115
116
 
# File 'lib/serverkit/resources/base.rb', line 114

def successful?
  successful_on_check? || successful_on_recheck?
end

#successful_on_check? ⇒ Boolean

Returns:

  • (Boolean) 


118
119
120
 
# File 'lib/serverkit/resources/base.rb', line 118

def successful_on_check?
  @check_result == true
end

#successful_on_recheck? ⇒ Boolean

Returns:

  • (Boolean) 


122
123
124
 
# File 'lib/serverkit/resources/base.rb', line 122

def successful_on_recheck?
  @recheck_result == true
end

#to_a ⇒ Array<Serverkit::Resources::Base>

Note:

recipe resource will override to replace itself with multiple resources

Returns:



128
129
130
 
# File 'lib/serverkit/resources/base.rb', line 128

def to_a
  [self]
end