Module: R10K::Module

Defined in:

lib/r10k/module.rb

Defined Under Namespace

Classes: Base, Forge, Git, Local, MetadataFile, SVN

Class Method Summary

• .new(name, basedir, args, environment = nil) ⇒ Object < R10K::Module] A member of the implementing subclass

  Look up the implementing class and instantiate an object.

• .register(klass) ⇒ Object

  Register an module implementation for later generation.

Class Method Details

.new(name, basedir, args, environment = nil) ⇒ Object < R10K::Module] A member of the implementing subclass

Look up the implementing class and instantiate an object

This method takes the arguments for normal object generation and checks all inheriting classes to see if they implement the behavior needed to create the requested object. It selects the first class that can implement an object with ‘name, args`, and generates an object of that class.

Parameters:

• name (String) —

  The unique name of the module

• basedir (String) —

  The root to install the module in

• args (Object) —

  An arbitary value or set of values that specifies the implementation

• environment (R10K::Environment) (defaults to: nil) —

  Optional environment that this module is a part of

Returns:

• (Object < R10K::Module] A member of the implementing subclass) —

  Object < R10K::Module] A member of the implementing subclass

# File 'lib/r10k/module.rb', line 24

def self.new(name, basedir, args, environment=nil)
  if implementation = @klasses.find { |klass| klass.implement?(name, args) }
    obj = implementation.new(name, basedir, args, environment)
    obj
  else
    raise _("Module %{name} with args %{args} doesn't have an implementation. (Are you using the right arguments?)") % {name: name, args: args.inspect}
  end
end

.register(klass) ⇒ Object

Register an module implementation for later generation

# File 'lib/r10k/module.rb', line 6

def self.register(klass)
  @klasses ||= []
  @klasses << klass
end