Class: Vedeu::Plugin

Inherits:
Object
  • Object
show all
Defined in:
lib/vedeu/plugins/plugin.rb

Overview

A class responsible for plugin loading.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, gem) ⇒ Vedeu::Plugin

Returns a new instance of Vedeu::Plugin.

Parameters:

  • name (String) —

    The plugin name.

  • gem (Gem::Specification) —

    The RubyGems gem.



29
30
31
32
33
34
 
# File 'lib/vedeu/plugins/plugin.rb', line 29

def initialize(name, gem)
  @name     = name
  @gem      = gem
  @gem_name = "vedeu_#{name}".freeze
  @enabled  = false
end

Instance Attribute Details

#enabled ⇒ Boolean Also known as: enabled?

Returns:

  • (Boolean) 


21
22
23
 
# File 'lib/vedeu/plugins/plugin.rb', line 21

def enabled
  @enabled
end

#gem ⇒ String (readonly)

Returns:

  • (String) 


13
14
15
 
# File 'lib/vedeu/plugins/plugin.rb', line 13

def gem
  @gem
end

#gem_name ⇒ String (readonly)

Returns:

  • (String) 


17
18
19
 
# File 'lib/vedeu/plugins/plugin.rb', line 17

def gem_name
  @gem_name
end

#name ⇒ String (readonly)

Returns:

  • (String) 


9
10
11
 
# File 'lib/vedeu/plugins/plugin.rb', line 9

def name
  @name
end

Instance Method Details

#load! ⇒ void

This method returns an undefined value.

Load the plugin (require the gem).



39
40
41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/vedeu/plugins/plugin.rb', line 39

def load!
  begin
    require gem_name unless enabled?
  rescue LoadError => error
    raise Vedeu::Error::Fatal,
          "Unable to load plugin #{gem_name} due to #{error}.".freeze
  rescue => error
    raise Vedeu::Error::Fatal,
          "require '#{gem_name}' failed with #{error}.".freeze
  end

  @enabled = true
end