| Current Path : /usr/share/ruby/vendor_ruby/puppet/ |
Linux gator3171.hostgator.com 4.19.286-203.ELK.el7.x86_64 #1 SMP Wed Jun 14 04:33:55 CDT 2023 x86_64 |
| Current File : //usr/share/ruby/vendor_ruby/puppet/interface.rb |
require 'puppet'
require 'puppet/util/autoload'
require 'prettyprint'
require 'semver'
# @api public
class Puppet::Interface
require 'puppet/interface/documentation'
require 'puppet/interface/face_collection'
require 'puppet/interface/action'
require 'puppet/interface/action_builder'
require 'puppet/interface/action_manager'
require 'puppet/interface/option'
require 'puppet/interface/option_builder'
require 'puppet/interface/option_manager'
include FullDocs
include Puppet::Interface::ActionManager
extend Puppet::Interface::ActionManager
include Puppet::Interface::OptionManager
extend Puppet::Interface::OptionManager
include Puppet::Util
class << self
# This is just so we can search for actions. We only use its
# list of directories to search.
# @api private
# @deprecated
def autoloader
Puppet.deprecation_warning("Puppet::Interface.autoloader is deprecated; please use Puppet::Interface#loader instead")
@autoloader ||= Puppet::Util::Autoload.new(:application, "puppet/face")
end
# Lists all loaded faces
# @return [Array<Symbol>] The names of the loaded faces
def faces
Puppet::Interface::FaceCollection.faces
end
# Register a face
# @param instance [Puppet::Interface] The face
# @return [void]
# @api private
def register(instance)
Puppet::Interface::FaceCollection.register(instance)
end
# Defines a new Face.
# @todo Talk about using Faces DSL inside the block
#
# @param name [Symbol] the name of the face
# @param version [String] the version of the face (this should
# conform to {http://semver.org/ Semantic Versioning})
# @overload define(name, version, {|| ... })
# @return [Puppet::Interface] The created face
# @api public
# @dsl Faces
def define(name, version, &block)
face = Puppet::Interface::FaceCollection[name, version]
if face.nil? then
face = self.new(name, version)
Puppet::Interface::FaceCollection.register(face)
# REVISIT: Shouldn't this be delayed until *after* we evaluate the
# current block, not done before? --daniel 2011-04-07
face.load_actions
end
face.instance_eval(&block) if block_given?
return face
end
# Retrieves a face by name and version. Use `:current` for the
# version to get the most recent available version.
#
# @param name [Symbol] the name of the face
# @param version [String, :current] the version of the face
#
# @return [Puppet::Interface] the face
#
# @api public
def face?(name, version)
Puppet::Interface::FaceCollection[name, version]
end
# Retrieves a face by name and version
#
# @param name [Symbol] the name of the face
# @param version [String] the version of the face
#
# @return [Puppet::Interface] the face
#
# @api public
def [](name, version)
unless face = Puppet::Interface::FaceCollection[name, version]
# REVISIT (#18042) no sense in rechecking if version == :current -- josh
if Puppet::Interface::FaceCollection[name, :current]
raise Puppet::Error, "Could not find version #{version} of #{name}"
else
raise Puppet::Error, "Could not find Puppet Face #{name.to_s}"
end
end
face
end
# Retrieves an action for a face
# @param name [Symbol] The face
# @param action [Symbol] The action name
# @param version [String, :current] The version of the face
# @return [Puppet::Interface::Action] The action
def find_action(name, action, version = :current)
Puppet::Interface::FaceCollection.get_action_for_face(name, action, version)
end
end
########################################################################
# Documentation. We currently have to rewrite both getters because we share
# the same instance between build-time and the runtime instance. When that
# splits out this should merge into a module that both the action and face
# include. --daniel 2011-04-17
# Returns the synopsis for the face. This shows basic usage and global
# options.
# @return [String] usage synopsis
# @api private
def synopsis
build_synopsis self.name, '<action>'
end
########################################################################
# The name of the face
# @return [Symbol]
# @api private
attr_reader :name
# The version of the face
# @return [SemVer]
attr_reader :version
# The autoloader instance for the face
# @return [Puppet::Util::Autoload]
# @api private
attr_reader :loader
private :loader
# @api private
def initialize(name, version, &block)
unless SemVer.valid?(version)
raise ArgumentError, "Cannot create face #{name.inspect} with invalid version number '#{version}'!"
end
@name = Puppet::Interface::FaceCollection.underscorize(name)
@version = SemVer.new(version)
# The few bits of documentation we actually demand. The default license
# is a favour to our end users; if you happen to get that in a core face
# report it as a bug, please. --daniel 2011-04-26
@authors = []
@license = 'All Rights Reserved'
@loader = Puppet::Util::Autoload.new(@name, "puppet/face/#{@name}")
instance_eval(&block) if block_given?
end
# Loads all actions defined in other files.
#
# @return [void]
# @api private
def load_actions
loader.loadall
end
# Returns a string representation with the face's name and version
# @return [String]
def to_s
"Puppet::Face[#{name.inspect}, #{version.inspect}]"
end
########################################################################
# Action decoration, whee! You are not expected to care about this code,
# which exists to support face building and construction. I marked these
# private because the implementation is crude and ugly, and I don't yet know
# enough to work out how to make it clean.
#
# Once we have established that these methods will likely change radically,
# to be unrecognizable in the final outcome. At which point we will throw
# all this away, replace it with something nice, and work out if we should
# be making this visible to the outside world... --daniel 2011-04-14
private
# @return [void]
# @api private
def __invoke_decorations(type, action, passed_args = [], passed_options = {})
[:before, :after].member?(type) or fail "unknown decoration type #{type}"
# Collect the decoration methods matching our pass.
methods = action.options.select do |name|
passed_options.has_key? name
end.map do |name|
action.get_option(name).__decoration_name(type)
end
methods.reverse! if type == :after
# Exceptions here should propagate up; this implements a hook we can use
# reasonably for option validation.
methods.each do |hook|
respond_to? hook and self.__send__(hook, action, passed_args, passed_options)
end
end
# @return [void]
# @api private
def __add_method(name, proc)
meta_def(name, &proc)
method(name).unbind
end
# @return [void]
# @api private
def self.__add_method(name, proc)
define_method(name, proc)
instance_method(name)
end
end