Class: Sensu::Extensions::Loader

Inherits:
Object
  • Object
show all
Defined in:
lib/sensu/extensions/loader.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Loader

Returns a new instance of Loader.



34
35
36
37
38
39
40
41
42
43
 
# File 'lib/sensu/extensions/loader.rb', line 34

def initialize
  @warnings = []
  @loaded_files = []
  @loaded_gems = []
  @extensions = {}
  Extension::CATEGORIES.each do |category|
    @extensions[category] = {}
  end
  self.class.create_category_methods
end

Instance Attribute Details

#loaded_files ⇒ Object (readonly)

Returns the value of attribute loaded_files.



28
29
30
 
# File 'lib/sensu/extensions/loader.rb', line 28

def loaded_files
  @loaded_files
end

#loaded_gems ⇒ Object (readonly)

Returns the value of attribute loaded_gems.



32
33
34
 
# File 'lib/sensu/extensions/loader.rb', line 32

def loaded_gems
  @loaded_gems
end

#warnings ⇒ Object (readonly)

Returns the value of attribute warnings.



24
25
26
 
# File 'lib/sensu/extensions/loader.rb', line 24

def warnings
  @warnings
end

Class Method Details

.create_category_methods ⇒ Object

Create extension category accessors and methods to test the existence of extensions. Called in initialize().



47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/sensu/extensions/loader.rb', line 47

def self.create_category_methods
  Extension::CATEGORIES.each do |category|
    define_method(category) do
      extension_category(category)
    end
    method_name = category.to_s.chop + "_exists?"
    define_method(method_name.to_sym) do |name|
      extension_exists?(category, name)
    end
  end
end

Instance Method Details

#[](key) ⇒ Object

Retrieve the extension object corresponding to a key, acting like a Hash object.

Parameters:

  • key (Symbol)

Returns:

  • (Object) —

    value for key.



64
65
66
 
# File 'lib/sensu/extensions/loader.rb', line 64

def [](key)
  @extensions[key]
end

#all ⇒ Array<object>

Retrieve all extension instances.

Returns:

  • (Array<object>) —

    extensions.



71
72
73
74
75
76
77
 
# File 'lib/sensu/extensions/loader.rb', line 71

def all
  @extensions.map { |category, extensions|
    extensions.map { |name, extension|
      extension
    }.uniq
  }.flatten
end

#load_directory(directory) ⇒ Object

Load extensions from files in a directory. Files may be in nested directories.

Parameters:

  • directory (String) —

    path.



97
98
99
100
101
102
103
 
# File 'lib/sensu/extensions/loader.rb', line 97

def load_directory(directory)
  warning("loading extension files from directory", :directory => directory)
  path = directory.gsub(/\\(?=\S)/, "/")
  Dir.glob(File.join(path, "**{,/*/**}/*.rb")).each do |file|
    load_file(file)
  end
end

#load_file(file) ⇒ Object

Load an extension from a file.

Parameters:

  • file (String) —

    path.



82
83
84
85
86
87
88
89
90
91
 
# File 'lib/sensu/extensions/loader.rb', line 82

def load_file(file)
  warning("loading extension file", :file => file)
  begin
    require File.expand_path(file)
    @loaded_files << file
  rescue ScriptError, StandardError => error
    warning("failed to require extension", :file => file, :error => error)
    warning("ignoring extension", :file => file)
  end
end

#load_gem(raw_gem, version = nil) ⇒ Object

Load an extension from a Rubygem.

Parameters:

  • gem (String) —

    name.



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/sensu/extensions/loader.rb', line 108

def load_gem(raw_gem, version=nil)
  warning("loading extension gem", :gem => raw_gem, :version => version)
  begin
    gem(raw_gem, version) if version
    if raw_gem.start_with?(GEM_PREFIX)
      lib = raw_gem.sub(/^#{GEM_PREFIX}/, "")
      require_path = "sensu/extensions/#{lib}"
    else
      require_path = raw_gem
    end
    warning("requiring extension gem", :require => require_path)
    require require_path
    @loaded_gems << raw_gem
  rescue ScriptError, StandardError => error
    warning("failed to require extension", {
      :gem => raw_gem,
      :version => version,
      :error => error
    })
    warning("ignoring extension", :gem => raw_gem)
  end
end

#load_instances(service = nil) ⇒ Object

Load instances of the loaded extensions.

Parameters:

  • sensu (String) —

    service to load extensions for.



134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/sensu/extensions/loader.rb', line 134

def load_instances(service=nil)
  service ||= sensu_service_name
  categories_to_load(service).each do |category|
    extension_type = category.to_s.chop
    Extension.const_get(extension_type.capitalize).descendants.each do |klass|
      extension = klass.new
      @extensions[category][extension.name] = extension
      if extension.name_alias
        @extensions[category][extension.name_alias] = extension
      end
      warning("loaded extension", {
        :type => extension_type,
        :name => extension.name,
        :description => extension.description
      })
    end
  end
end