Module: Nucleon::Mixin::Macro::PluginInterface

Includes:
ObjectInterface
Defined in:
lib/core/mixin/macro/plugin_interface.rb

Instance Method Summary collapse

Methods included from ObjectInterface

#object_collection, #object_utilities

Instance Method Details

#plugin_collection(_namespace, _type, _method_options = {}) ⇒ Object

Plugin collections



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
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
 
# File 'lib/core/mixin/macro/plugin_interface.rb', line 15

def plugin_collection(_namespace, _type, _method_options = {})
  _method_config = Config.ensure(_method_options)
  _method_config.set(:plugin, true)

  _plural          = _method_config.init(:plural, "#{_type}s").get(:plural)
  _search_proc     = _method_config.get(:search_proc)
  _single_instance = _method_config.get(:single_instance, false)
  _plugin_type     = _method_config.get(:plugin_type, _type)

  @@object_types[_type] = _method_config

  logger.debug("Creating new plugin collection #{_namespace} #{_type}")

  #---------------------------------------------------------------------------

  object_utilities

  #---

  unless respond_to? :each_plugin
    logger.debug("Defining plugin interface method: each_plugin")

    define_method :each_plugin do |plugin_types = nil, providers = nil, &code|
      providers = [ providers ] if providers && ! providers.is_a?(Array)

      filter_proc = Proc.new {|type, config| config[:plugin] }
      each_object_type(plugin_types, filter_proc) do |type, plural, options|
        logger.debug("Processing plugin type #{type}/#{plural} with: #{options.inspect}")

        send(plural).each do |provider, plugins|
          logger.debug("Processing plugin provider: #{provider}")

          unless providers && ! providers.include?(provider)
            if plugins.is_a?(Hash)
              plugins.each do |name, plugin|
                logger.debug("Processing plugin: #{name}")
                code.call(type, provider, name, plugin)
              end
            else
              logger.debug("Processing plugin: #{plugin.plugin_name}")
              code.call(type, provider, plugin.plugin_name, plugin)
            end
          end
        end
      end
    end
  end

  #---

  logger.debug("Defining plugin interface method: each_#{_type}")

  define_method "each_#{_type}" do |providers = nil, &code|
    each_plugin(_type, providers) do |type, provider, name, plugin|
      code.call(provider, name, plugin)
    end
  end

  #---------------------------------------------------------------------------

  logger.debug("Defining plugin interface method: #{_plural}")

  define_method "#{_plural}" do |provider = nil, reset = false|
    keys = ( provider ? [ _plural, provider ] : _plural )
    send("init_#{_plural}", provider) if reset || _get(keys, {}).empty?
    _get(keys, {})
  end

  #---

  logger.debug("Defining plugin interface method: init_#{_plural}")

  define_method "init_#{_plural}" do |providers = nil|
    data = hash(_search_proc.call) if _search_proc
    data = get_hash(_plural) unless data

    providers = [ providers ] if providers && ! providers.is_a?(Array)
    providers.collect! { |elem| elem.to_sym } if providers

    logger.debug("Initializing #{_plugin_type} plugin data: #{data.inspect}")
    logger.debug("Providers: #{providers.inspect}")

    symbol_map(data).each do |provider, instance_settings|
      if ! providers || providers.include?(provider)
        if _single_instance
          logger.debug("Initializing single instance plugin: #{instance_settings.inspect}")

          plugin = Nucleon.plugin(_namespace, _plugin_type, provider, Config.ensure(instance_settings).import({ :meta => { :parent => myself }, :new => true }))

          _set([ _plural, provider ], plugin)
        else
          instance_settings.each do |name, options|
            if name != :settings
              logger.debug("Initializing plugin #{_plugin_type} #{name}: #{options.inspect}")

              plugin = Nucleon.plugin(_namespace, _plugin_type, provider, Config.ensure(options).import({ :name => name, :meta => { :parent => myself }, :new => true }))

              _set([ _plural, provider, name ], plugin)
            end
          end
        end
      end
    end
  end

  #---

  logger.debug("Defining plugin interface method: set_#{_plural}")

  define_method "set_#{_plural}" do |data = {}|
    data = Config.ensure(data).export

    send("clear_#{_plural}")
    set(_plural, data)

    logger.debug("Setting #{_plural}")

    data.each do |provider, instance_settings|
      if _single_instance
        logger.debug("Setting single #{_plugin_type} #{provider}: #{instance_settings.inspect}")

        plugin = Nucleon.plugin(_namespace, _plugin_type, provider, Config.ensure(instance_settings).import({ :meta => { :parent => myself }, :new => true }))

        _set([ _plural, provider ], plugin)
      else
        instance_settings.each do |name, options|
          logger.debug("Setting #{_plugin_type} #{provider} #{name}: #{options.inspect}")

          plugin = Nucleon.plugin(_namespace, _plugin_type, provider, Config.ensure(options).import({ :name => name, :meta => { :parent => myself }, :new => true }))

          _set([ _plural, provider, name ], plugin)
        end
      end
    end
  end

  #---

  logger.debug("Defining plugin interface method: clear_#{_plural}")

  define_method "clear_#{_plural}" do
    get(_plural).keys.each do |provider|
      logger.debug("Clearing #{_type} #{provider}")

      if _single_instance
        send("delete_#{_type}", provider)
      else
        get_hash([ _plural, provider ]).keys.each do |name|
          send("delete_#{_type}", provider, name)
        end
      end
    end
  end

  #---------------------------------------------------------------------------

  if _single_instance
    logger.debug("Defining single instance plugin interface method: #{_type}_config")

    define_method "#{_type}_config" do |provider = nil|
      keys = [ _plural ]
      keys << provider unless provider.nil?
      Config.new(get(keys, {}), {}, true, false)
    end

    #---

    logger.debug("Defining single instance plugin interface method: #{_type}_setting")

    define_method "#{_type}_setting" do |provider, property, default = nil, format = false|
      get([ _plural, provider, property ], default, format)
    end

    #---

    logger.debug("Defining single instance plugin interface method: #{_type}")

    define_method "#{_type}" do |provider, reset = false|
      if reset || _get([ _plural, provider ], nil).nil?
        options = get([ _plural, provider ], nil)

        unless options.nil?
          plugin = Nucleon.plugin(_namespace, _plugin_type, provider, Config.ensure(options).import({ :meta => { :parent => myself }, :new => true }))

          logger.debug("Initializing plugin #{_plugin_type} #{provider}: #{options.inspect}")

          _set([ _plural, provider ], plugin)
        end
      end
      _get([ _plural, provider ])
    end

    #---

    logger.debug("Defining single instance plugin interface method: set_#{_type}")

    define_method "set_#{_type}" do |provider, options = {}|
      options = Config.ensure(options).export

      set([ _plural, provider ], options)

      plugin = Nucleon.plugin(_namespace, _plugin_type, provider, Config.ensure(options).import({ :meta => { :parent => myself }, :new => true }))

      logger.debug("Setting single #{_plugin_type} #{provider}: #{options.inspect}")

      _set([ _plural, provider ], plugin)
      plugin
    end

    #---

    logger.debug("Defining single instance plugin interface method: set_#{_type}_setting")

    define_method "set_#{_type}_setting" do |provider, property, value = nil|
      logger.debug("Setting single #{provider} property #{property} to #{value.inspect}")
      set([ _plural, provider, property ], value)
    end

    #---

    logger.debug("Defining single instance plugin interface method: delete_#{_type}")

    define_method "delete_#{_type}" do |provider, remove_plugin = true|
      plugin = send(_type, provider)

      logger.debug("Deleting single #{_type} #{provider}")

      delete([ _plural, provider ])
      _delete([ _plural, provider ])

      Nucleon.remove_plugin(plugin) if remove_plugin && ! plugin.nil?
    end

    #---

    logger.debug("Defining single instance plugin interface method: delete_#{_type}_setting")

    define_method "delete_#{_type}_setting" do |provider, property|
      logger.debug("Deleting single #{provider} property: #{property}")
      delete([ _plural, provider, property ])
    end

    #---

    logger.debug("Defining single instance plugin interface method: search_#{_type}")

    define_method "search_#{_type}" do |provider, keys, default = '', format = false, extra_groups = []|
      plugin_config = send("#{_type}_config", provider)
      logger.debug("Searching single #{_type} #{provider}: #{plugin_config.inspect}")

      search_object(plugin_config, keys, default, format, extra_groups)
    end

  #---------------------------------------------------------------------------
  else
    logger.debug("Defining multi instance plugin interface method: #{_type}_config")

    define_method "#{_type}_config" do |provider = nil, name = nil|
      keys = [ _plural ]
      keys << provider unless provider.nil?
      keys << name unless name.nil?
      Config.new(get(keys, {}), {}, true, false)
    end

    #---

    logger.debug("Defining multi instance plugin interface method: #{_type}_setting")

    define_method "#{_type}_setting" do |provider, name, property, default = nil, format = false|
      get([ _plural, provider, name, property ], default, format)
    end

    #---

    logger.debug("Defining multi instance plugin interface method: #{_type}")

    define_method "#{_type}" do |provider, name, reset = false|
      if reset || _get([ _plural, provider, name ], nil).nil?
        options = get([ _plural, provider, name ], nil)

        unless options.nil?
          plugin = Nucleon.plugin(_namespace, _plugin_type, provider, Config.ensure(options).import({ :name => name, :meta => { :parent => myself }, :new => true }))

          logger.debug("Initializing plugin #{_plugin_type} #{provider}: #{options.inspect}")

          _set([ _plural, provider, name ], plugin)
        end
      end
      _get([ _plural, provider, name ])
    end

    #---

    logger.debug("Defining multi instance plugin interface method: set_#{_type}")

    define_method "set_#{_type}" do |provider, name, options = {}|
      options = Config.ensure(options).export

      set([ _plural, provider, name ], options)
      plugin = Nucleon.plugin(_namespace, _plugin_type, provider, Config.ensure(options).import({ :name => name, :meta => { :parent => myself }, :new => true }))

      logger.debug("Setting #{_plugin_type} #{provider} #{name}: #{options.inspect}")

      _set([ _plural, provider, name ], plugin)
      plugin
    end

    #---

    logger.debug("Defining multi instance plugin interface method: set_#{_type}_setting")

    define_method "set_#{_type}_setting" do |provider, name, property, value = nil|
      logger.debug("Setting #{provider} #{name} property #{property} to #{value.inspect}")
      set([ _plural, provider, name, property ], value)
    end

    #---

    logger.debug("Defining multi instance plugin interface method: delete_#{_type}")

    define_method "delete_#{_type}" do |provider, name, remove_plugin = true|
      plugin = send(_type, provider, name)

      logger.debug("Deleting #{_type} #{provider} #{name}")

      delete([ _plural, provider, name ])
      _delete([ _plural, provider, name ])

      Nucleon.remove_plugin(plugin) if remove_plugin && ! plugin.nil?
    end

    #---

    logger.debug("Defining multi instance plugin interface method: delete_#{_type}_setting")

    define_method "delete_#{_type}_setting" do |provider, name, property|
      logger.debug("Deleting #{provider} #{name} property: #{property}")
      delete([ _plural, provider, name, property ])
    end

    #---

    logger.debug("Defining multi instance plugin interface method: search_#{_type}")

    define_method "search_#{_type}" do |provider, name, keys, default = '', format = false, extra_groups = []|
      plugin_config = send("#{_type}_config", provider, name)
      logger.debug("Searching #{_type} #{provider} #{name}: #{plugin_config.inspect}")

      search_object(plugin_config, keys, default, format, extra_groups)
    end
  end
end