Module: ForemanMaintain::Concerns::Metadata

Included in:
ForemanMaintain::Check, Feature, Procedure
Defined in:
lib/foreman_maintain/concerns/metadata.rb

Defined Under Namespace

Modules: ClassMethods Classes: DSL

Constant Summary collapse

MAX_PREPARATION_STEPS_DEPTH =

limit of steps dependent on each other, to avoid endless recursion

20

Class Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Class Attribute Details

.top_level_modules ⇒ Object

modules not to be included in autogenerated labels



9
10
11
 
# File 'lib/foreman_maintain/concerns/metadata.rb', line 9

def top_level_modules
  @top_level_modules
end

Class Method Details

.included(klass) ⇒ Object 



250
251
252
 
# File 'lib/foreman_maintain/concerns/metadata.rb', line 250

def self.included(klass)
  klass.extend(ClassMethods)
end

Instance Method Details

#advanced_run? ⇒ Boolean

Returns:

  • (Boolean) 


290
291
292
 
# File 'lib/foreman_maintain/concerns/metadata.rb', line 290

def advanced_run?
  self.class.advanced_run?
end

#description ⇒ Object 



266
267
268
 
# File 'lib/foreman_maintain/concerns/metadata.rb', line 266

def description
  self.class.description
end

#label ⇒ Object 



258
259
260
 
# File 'lib/foreman_maintain/concerns/metadata.rb', line 258

def label
  self.class.label
end

#label_dashed ⇒ Object 



262
263
264
 
# File 'lib/foreman_maintain/concerns/metadata.rb', line 262

def label_dashed
  label.to_s.tr('_', '-')
end

#metadata ⇒ Object 



254
255
256
 
# File 'lib/foreman_maintain/concerns/metadata.rb', line 254

def metadata
  self.class.metadata
end

#params ⇒ Object 



278
279
280
 
# File 'lib/foreman_maintain/concerns/metadata.rb', line 278

def params
  self.class.params
end

#preparation_steps(*args) ⇒ Object 



286
287
288
 
# File 'lib/foreman_maintain/concerns/metadata.rb', line 286

def preparation_steps(*args)
  self.class.preparation_steps(*args)
end

#run_once? ⇒ Boolean

Returns:

  • (Boolean) 


282
283
284
 
# File 'lib/foreman_maintain/concerns/metadata.rb', line 282

def run_once?
  self.class.run_once?
end

#runtime_message ⇒ Object 



270
271
272
 
# File 'lib/foreman_maintain/concerns/metadata.rb', line 270

def runtime_message
  description
end

#tags ⇒ Object 



274
275
276
 
# File 'lib/foreman_maintain/concerns/metadata.rb', line 274

def tags
  self.class.tags
end