Class: PluginRegistry::Plugin

Inherits:
Object
  • Object
show all
Defined in:
lib/inspec/plugin/v1/registry.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#parent ⇒ Object

Returns the value of attribute parent.



92
93
94
 
# File 'lib/inspec/plugin/v1/registry.rb', line 92

def parent
  @parent
end

#target ⇒ Object (readonly)

Returns the value of attribute target.



91
92
93
 
# File 'lib/inspec/plugin/v1/registry.rb', line 91

def target
  @target
end

Class Method Details

.name(name) ⇒ nil

Register a new plugin by name

Parameters:

  • the (String) —

    unique name of this plugin

Returns:

  • (nil) —

    disregard



49
50
51
52
53
54
 
# File 'lib/inspec/plugin/v1/registry.rb', line 49

def self.name(name)
  raise "Trying to register #{self} with name == nil" if name.nil?

  @name = name
  plugin_registry.registry[name] = self
end

.plugin_registry ⇒ PluginRegistry

Retrieve the plugin registry associated with this plugin

Returns:



41
42
43
 
# File 'lib/inspec/plugin/v1/registry.rb', line 41

def self.plugin_registry
  raise "Plugin #{self} does not implement `self.plugin_registry()`. This method is required"
end

.priority(x = nil) ⇒ Numeric

This plugin’s priority. Set it by providing the priority as an argument. Higher numbers ensure that the plugin is called early to check if a target belongs to it. When called without an argument, it retrieves this plugin’s priority. Defaults to 0.

Parameters:

  • Priority (Numeric) —

    as a number. Will only be set if != nil

Returns:

  • (Numeric) —

    This plugin’s priority



63
64
65
66
 
# File 'lib/inspec/plugin/v1/registry.rb', line 63

def self.priority(x = nil)
  @priority = x unless x.nil?
  @priority || 0
end

.resolve(_target) ⇒ Plugin

Try to resolve the target. If this plugin cannot handle it, the result will be nil. If, however, the plugin can resolve it, the resulting object will be an instance of this plugin. This means, that the interface that this base class provides, is the basis for the returned type.

Parameters:

  • target (String) —

    to try to resolve

Returns:

  • (Plugin) —

    instance if it can be resolved, nil otherwise



75
76
77
 
# File 'lib/inspec/plugin/v1/registry.rb', line 75

def self.resolve(_target)
  raise "Plugin #{self} does not implement `self.resolve(target)`. This method is required"
end

.resolve_next(target, parent) ⇒ Plugin

When a plugin’s resolve doesn’t lead to the final state, it can use this method to hand it back for another resolver to handle.

Parameters:

  • the (Any) —

    current target that needs resolving

  • an (Plugin) —

    instance of the calling resolver

Returns:

  • (Plugin) —

    instance if it can be resolved, nil otherwise



85
86
87
88
89
 
# File 'lib/inspec/plugin/v1/registry.rb', line 85

def self.resolve_next(target, parent)
  res = plugin_registry.resolve(target)
  res.parent = parent
  res
end