Class Puppet::ModuleTool::Metadata
In: lib/shared/puppet/module_tool/metadata.rb
Parent: Object

This class provides a data structure representing a module‘s metadata. @api private

Methods

add_dependency   dashed_name   dependencies   description   full_module_name   method_missing   new   release_name   to_data_hash   to_hash   to_json   update  

Constants

DEFAULTS = { 'name' => nil, 'version' => nil, 'author' => nil, 'summary' => nil, 'license' => 'Apache-2.0', 'source' => '', 'project_page' => nil, 'issues_url' => nil, 'dependencies' => Set.new.freeze, }

External Aliases

module_name -> name

Attributes

module_name  [RW] 

Public Class methods

Public Instance methods

add_dependency(name, version_requirement=nil, repository=nil)

Validates the name and version_requirement for a dependency, then creates the Dependency and adds it. Returns the Dependency that was added.

dashed_name()

Returns a filesystem-friendly version of this module name.

description()

Provides an accessor for the now defunct ‘description’ property. This addresses a regression in Puppet 3.6.x where previously valid templates refering to the ‘description’ property were broken. @deprecated

full_module_name()

Alias for dashed_name

method_missing(name, *args)

Expose any metadata keys as callable reader methods.

release_name()

Returns a string that uniquely represents this version of this module.

to_data_hash()

Alias for to_hash

to_hash()

Returns a hash of the module‘s metadata. Used by Puppet‘s automated serialization routines.

@see Puppet::Network::FormatSupport#to_data_hash

update(data, with_dependencies = true)

Merges the current set of metadata with another metadata hash. This method also handles the validation of module names and versions, in an effort to be proactive about module publishing constraints.

[Validate]