Module: OpenBEL::ConfigurePlugins

Included in:
PluginManager
Defined in:
lib/openbel/api/plugin/configure_plugins.rb

Instance Method Summary collapse

Instance Method Details

#check_configuration(plugins, config) ⇒ Object 



6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/openbel/api/plugin/configure_plugins.rb', line 6

def check_configuration(plugins, config)
  sorted_plugin_config_ids = build_dependency_graph(config)

  all_errors = []
  valid_plugins = {}
  sorted_plugin_config_ids.each do |plugin_config_id|
    # validate plugin configuration...
    plugin_config = config[plugin_config_id.to_s]

    # ...check plugin defines required properties
    ['type', 'plugin'].each do |p|
      errors << %Q{The "#{p}" property (defined in "#{plugin_config_id}") does not define a type.} unless plugin_config.has_key?(p)
      next
    end
    type = plugin_config['type']
    plugin_id = plugin_config['plugin']

    # ...check if any plugin(s) are loaded for specified type
    if plugins.none? { |p| p.type.to_s.to_sym == type.to_s.to_sym }
      errors << %Q{The "#{type}" type (defined in "#{plugin_config_id}") does not have any registered plugins.}
    end

    # ...check if plugin exists
    plugin = plugins.find { |p| p.id == plugin_id }
    unless plugin
      errors << %Q{The "#{plugin_id}" plugin (defined in "#{plugin_config_id}") does not have any registered plugins.}
    end

    # ...check plugin extensions
    extensions = plugin_config['extensions'] || {}
    extensions.values.find_all { |ext|
      not valid_plugins.has_key? ext.to_s
    }.each do |ext|
      all_errors << %Q{The "#{ext}" extension (defined in "#{plugin_config_id}") is not valid.}
    end

    # ...prepare extensions/options for plugin validation
    extensions = Hash[extensions.map { |ext_type, ext_id|
      [ext_type.to_s.to_sym, valid_plugins[ext_id.to_s]]
    }]
    options = Hash[(plugin_config['options'] || {}).map { |k, v|
      [k.to_s.to_sym, v]
    }]

    # ...call plugin-specific validation
    plugin_errors = [plugin.validate(extensions.dup, options.dup)].flatten.map(&:to_s)
    if plugin_errors.empty?
      valid_plugins[plugin_config_id.to_s] = plugin
    else
      all_errors.concat(plugin_errors)
    end
    # TODO Log successful plugin check if verbose.
  end
  all_errors
end

#configure_plugins(plugins, config) ⇒ Object 



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/openbel/api/plugin/configure_plugins.rb', line 62

def configure_plugins(plugins, config)
  sorted_plugin_config_ids = build_dependency_graph(config)
  sorted_plugin_config_ids.inject({}) { |plugins_by_id, plugin_config_id|
    plugin_config = config[plugin_config_id.to_s]

    plugin_id = plugin_config['plugin']

    plugin = plugins.find { |p| p.id == plugin_id }
    extensions = Hash[(plugin_config['extensions'] || {}).map { |type, id|
      [type.to_s.to_sym, plugins_by_id[id.to_s]]
    }]
    options = Hash[(plugin_config['options'] || {}).map { |k, v|
      [k.to_s.to_sym, v]
    }]

    plugin.configure(extensions.dup, options.dup)
    plugin.on_load

    plugins_by_id[plugin_config_id.to_s] = plugin
    plugins_by_id
  }
end