Class: Vagrant::Plugin::V2::Plugin

Inherits:
Object
  • Object
show all
Defined in:
lib/vagrant/plugin/v2/plugin.rb

Overview

This is the superclass for all V2 plugins.

Constant Summary collapse

ALL_ACTIONS =

Special marker that can be used for action hooks that matches all action sequences.

:__all_actions__
LOGGER =

The logger for this class.

Log4r::Logger.new("vagrant::plugin::v2::plugin")
ROOT_CLASS =

Set the root class up to be ourself, so that we can reference this from within methods which are probably in subclasses.

self

Class Method Summary collapse

Class Method Details

.action_hook(name, hook_name = nil, &block) ⇒ Array

Registers a callback to be called when a specific action sequence is run. This allows plugin authors to hook into things like VM bootup, VM provisioning, etc.

Parameters:

  • name (String) —

    Name of the action.

  • hook_name (Symbol) (defaults to: nil) —

    The location to hook. If this isn’t set, every middleware action is hooked.

Returns:

  • (Array) —

    List of the hooks for the given action.



72
73
74
75
76
77
 
# File 'lib/vagrant/plugin/v2/plugin.rb', line 72

def self.action_hook(name, hook_name=nil, &block)
  # The name is currently not used but we want it for the future.

  hook_name ||= ALL_ACTIONS
  components.action_hooks[hook_name] << block
end

.command(name = UNSET_VALUE, &block) ⇒ Object

Defines additional command line commands available by key. The key becomes the subcommand, so if you register a command “foo” then “vagrant foo” becomes available.

Parameters:

  • name (String) (defaults to: UNSET_VALUE) —

    Subcommand key.



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/vagrant/plugin/v2/plugin.rb', line 84

def self.command(name=UNSET_VALUE, &block)
  data[:command] ||= Registry.new

  if name != UNSET_VALUE
    # Validate the name of the command
    if name.to_s !~ /^[-a-z0-9]+$/i
      raise InvalidCommandName, "Commands can only contain letters, numbers, and hyphens"
    end

    # Register a new command class only if a name was given.
    data[:command].register(name.to_sym, &block)
  end

  # Return the registry
  data[:command]
end

.communicator(name = UNSET_VALUE, &block) ⇒ Object

Defines additional communicators to be available. Communicators should be returned by a block passed to this method. This is done to ensure that the class is lazy loaded, so if your class inherits from or uses any Vagrant internals specific to Vagrant 1.0, then the plugin can still be defined without breaking anything in future versions of Vagrant.

Parameters:

  • name (String) (defaults to: UNSET_VALUE) —

    Communicator name.



109
110
111
112
113
114
115
116
117
 
# File 'lib/vagrant/plugin/v2/plugin.rb', line 109

def self.communicator(name=UNSET_VALUE, &block)
  data[:communicator] ||= Registry.new

  # Register a new communicator class only if a name was given.
  data[:communicator].register(name.to_sym, &block) if name != UNSET_VALUE

  # Return the registry
  data[:communicator]
end

.components ⇒ Components

Returns the Components for this plugin.

Returns:



33
34
35
 
# File 'lib/vagrant/plugin/v2/plugin.rb', line 33

def self.components
  @components ||= Components.new
end

.config(name, scope = nil, &block) ⇒ Object

Defines additional configuration keys to be available in the Vagrantfile. The configuration class should be returned by a block passed to this method. This is done to ensure that the class is lazy loaded, so if your class inherits from any classes that are specific to Vagrant 1.0, then the plugin can still be defined without breaking anything in future versions of Vagrant.

XXX: Document options hash

Parameters:

  • name (String) —

    Configuration key.



128
129
130
131
132
 
# File 'lib/vagrant/plugin/v2/plugin.rb', line 128

def self.config(name, scope=nil, &block)
  scope ||= :top
  components.configs[scope].register(name.to_sym, &block)
  nil
end

.data ⇒ Hash

Returns the internal data associated with this plugin. This should NOT be called by the general public.

Returns:

  • (Hash) 


192
193
194
 
# File 'lib/vagrant/plugin/v2/plugin.rb', line 192

def self.data
  @data ||= {}
end

.description(value = UNSET_VALUE) ⇒ String

Sets a human-friendly descrition of the plugin.

Parameters:

  • value (String) (defaults to: UNSET_VALUE) —

    Description of the plugin.

Returns:

  • (String) —

    Description of the plugin.



60
61
62
 
# File 'lib/vagrant/plugin/v2/plugin.rb', line 60

def self.description(value=UNSET_VALUE)
  get_or_set(:description, value)
end

.guest(name = UNSET_VALUE, &block) ⇒ Object

Defines an additionally available guest implementation with the given key.

Parameters:

  • name (String) (defaults to: UNSET_VALUE) —

    Name of the guest.



138
139
140
141
142
143
144
145
146
 
# File 'lib/vagrant/plugin/v2/plugin.rb', line 138

def self.guest(name=UNSET_VALUE, &block)
  data[:guests] ||= Registry.new

  # Register a new guest class only if a name was given
  data[:guests].register(name.to_sym, &block) if name != UNSET_VALUE

  # Return the registry
  data[:guests]
end

.host(name = UNSET_VALUE, &block) ⇒ Object

Defines an additionally available host implementation with the given key.

Parameters:

  • name (String) (defaults to: UNSET_VALUE) —

    Name of the host.



152
153
154
155
156
157
158
159
160
 
# File 'lib/vagrant/plugin/v2/plugin.rb', line 152

def self.host(name=UNSET_VALUE, &block)
  data[:hosts] ||= Registry.new

  # Register a new host class only if a name was given
  data[:hosts].register(name.to_sym, &block) if name != UNSET_VALUE

  # Return the registry
  data[:hosts]
end

.manager ⇒ V2::Manager

This returns the manager for all V2 plugins.

Returns:



26
27
28
 
# File 'lib/vagrant/plugin/v2/plugin.rb', line 26

def self.manager
  @manager ||= Manager.new
end

.name(name = UNSET_VALUE) ⇒ String

Set the name of the plugin. The moment that this is called, the plugin will be registered and available. Before this is called, a plugin does not exist. The name must be unique among all installed plugins.

Parameters:

  • name (String) (defaults to: UNSET_VALUE) —

    Name of the plugin.

Returns:

  • (String) —

    The name of the plugin.



44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/vagrant/plugin/v2/plugin.rb', line 44

def self.name(name=UNSET_VALUE)
  # Get or set the value first, so we have a name for logging when
  # we register.
  result = get_or_set(:name, name)

  # The plugin should be registered if we're setting a real name on it
  Plugin.manager.register(self) if name != UNSET_VALUE

  # Return the result
  result
end

.provider(name = UNSET_VALUE, &block) ⇒ Object

Registers additional providers to be available.

Parameters:

  • name (Symbol) (defaults to: UNSET_VALUE) —

    Name of the provider.



165
166
167
168
169
170
171
172
173
 
# File 'lib/vagrant/plugin/v2/plugin.rb', line 165

def self.provider(name=UNSET_VALUE, &block)
  data[:providers] ||= Registry.new

  # Register a new provider class only if a name was given
  data[:providers].register(name.to_sym, &block) if name != UNSET_VALUE

  # Return the registry
  data[:providers]
end

.provisioner(name = UNSET_VALUE, &block) ⇒ Object

Registers additional provisioners to be available.

Parameters:

  • name (String) (defaults to: UNSET_VALUE) —

    Name of the provisioner.



178
179
180
181
182
183
184
185
186
 
# File 'lib/vagrant/plugin/v2/plugin.rb', line 178

def self.provisioner(name=UNSET_VALUE, &block)
  data[:provisioners] ||= Registry.new

  # Register a new provisioner class only if a name was given
  data[:provisioners].register(name.to_sym, &block) if name != UNSET_VALUE

  # Return the registry
  data[:provisioners]
end