Class: Inspec::PluginCtl

Inherits:
Object
  • Object
show all
Extended by:
Forwardable
Defined in:
lib/inspec/plugin/v1/plugins.rb

Overview

PLEASE NOTE: The Plugin system is an internal mechanism for connecting inspec components. Its API is currently considered in an alpha state and may change between minor version revisions. A stable plugin API will be released in the future.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(home = nil) ⇒ PluginCtl

Returns a new instance of PluginCtl.



29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/inspec/plugin/v1/plugins.rb', line 29

def initialize(home = nil)
  @paths = []

  # load plugins in the same gem installation
  lib_home = File.expand_path(File.join(__FILE__, '..', '..', '..', '..'))
  @paths += Dir[lib_home+'/inspec-*-*/lib/inspec-*rb']

  # traverse out of inspec-vX.Y.Z/lib/inspec/plugins.rb
  @home = home || File.join(Inspec.config_dir, 'plugins')
  @paths += Dir[File.join(@home, '**{,/*/**}', '*.gemspec')]
            .map { |x| File.dirname(x) }
            .map { |x| Dir[File.join(x, 'lib', 'inspec-*.rb')] }
            .flatten

  # load bundled plugins
  bundled_dir = File.expand_path(File.dirname(__FILE__))
  @paths += Dir[File.join(bundled_dir, '..', 'bundles', 'inspec-*.rb')].flatten

  # map paths to names
  @registry = Hash[@paths.map { |x|
    [File.basename(x, '.rb'), x]
  }]
end

Instance Attribute Details

#registry ⇒ Object (readonly)

Returns the value of attribute registry.



26
27
28
 
# File 'lib/inspec/plugin/v1/plugins.rb', line 26

def registry
  @registry
end

Instance Method Details

#load(name) ⇒ Object 



53
54
55
56
57
58
59
60
 
# File 'lib/inspec/plugin/v1/plugins.rb', line 53

def load(name)
  path = @registry[name]
  if path.nil?
    raise "Couldn't find plugin #{name}. Searching in #{@home}"
  end
  # puts "Loading plugin #{name} from #{path}"
  require path
end