Class Puppet::Module::Tool::Metadata
In: lib/puppet/module/tool/metadata.rb
Parent: Object

Metadata

This class provides a data structure representing a module‘s metadata. It provides some basic parsing, but other data is injected into it using annotate methods in other classes.

Methods

author   author=   checksums   dashed_name   dependencies   description   description=   full_name=   license   license=   new   project_page   project_page=   release_name   source   source=   summary   summary=   to_pson   types  

Attributes

full_name  [R]  The full name of the module, which is a dash-separated combination of the username and module name.
name  [R]  The name of this module. See also full_name.
username  [R]  The name of the user that owns this module.
version  [RW]  The version of this module, a string like ‘0.1.0’.

Public Class methods

new(settings={})

Instantiate from a hash, whose keys are setters in this class.

Public Instance methods

checksums()

Return module‘s file checksums.

dashed_name()

Return the dashed name of the module, which may either be the dash-separated combination of the username and module name, or just the module name.

dependencies()

Return an array of the module‘s Dependency objects.

full_name=(full_name)

Set the full name of this module, and from it, the username and module name.

release_name()

Return the release name, which is the combination of the dashed_name of the module and its version number.

to_pson(*args)

Return the PSON record representing this instance.

types()

Return an array of the module‘s Puppet types, each one is a hash containing :name and :doc. TODO Shouldn‘t this be it‘s own class?

[Validate]