module R10K::Module

Public Class Methods

from_metadata(name, basedir, args, environment=nil) click to toggle source

Takes the same signature as Module.new but returns an metadata module

# File lib/r10k/module.rb, line 31
def self.from_metadata(name, basedir, args, environment=nil)
  with_implementation(name, args) do |implementation|
    R10K::Module::Definition.new(name,
                                 dirname: basedir,
                                 args: args,
                                 implementation: implementation,
                                 environment: environment)
  end
end
new(name, basedir, args, environment=nil) click to toggle source

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.

@param [String] name The unique name of the module @param [String] basedir The root to install the module in @param [Hash] args An arbitary Hash that specifies the implementation @param [R10K::Environment] environment Optional environment that this module is a part of

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

# File lib/r10k/module.rb, line 24
def self.new(name, basedir, args, environment=nil)
  with_implementation(name, args) do |implementation|
    implementation.new(name, basedir, args, environment)
  end
end
register(klass) click to toggle source

Register an module implementation for later generation

# File lib/r10k/module.rb, line 6
def self.register(klass)
  @klasses ||= []
  @klasses << klass
end
with_implementation(name, args, &block) click to toggle source 
# File lib/r10k/module.rb, line 41
def self.with_implementation(name, args, &block)
  if implementation = @klasses.find { |klass| klass.implement?(name, args) }
    block.call(implementation)
  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