Module: PuppetMetadata

Defined in:

lib/puppet_metadata.rb,
lib/puppet_metadata/aio.rb,
lib/puppet_metadata/beaker.rb,
lib/puppet_metadata/command.rb,
lib/puppet_metadata/metadata.rb,
lib/puppet_metadata/base_command.rb,
lib/puppet_metadata/github_actions.rb,
lib/puppet_metadata/operatingsystem.rb

Overview

A module that provides abstractions around Puppet’s metadata format.

Defined Under Namespace

Modules: Command Classes: AIO, BaseCommand, Beaker, GithubActions, InvalidMetadataException, Metadata, OperatingSystem

Class Method Summary

• .parse(data) ⇒ PuppetMetadata::Metadata

  Parse a JSON encoded metadata string.

• .read(path) ⇒ PuppetMetadata::Metadata

  Read and parse a path containing metadata.

• .write(path, metadata) ⇒ Object

  Write metadata back to disk.

Class Method Details

.parse(data) ⇒ PuppetMetadata::Metadata

Parse a JSON encoded metadata string

Parameters:

• data —

  A JSON encoded metadata string

Returns:

• (PuppetMetadata::Metadata) —

  A Metadata object

# File 'lib/puppet_metadata.rb', line 16

def self.parse(data)
  Metadata.new(JSON.parse(data))
end

.read(path) ⇒ PuppetMetadata::Metadata

Read and parse a path containing metadata

Parameters:

• path —

  The path metadata.json

Returns:

• (PuppetMetadata::Metadata) —

  A Metadata object

# File 'lib/puppet_metadata.rb', line 23

def self.read(path)
  parse(File.read(path))
end

.write(path, metadata) ⇒ Object

Write metadata back to disk

Parameters:

• path —

  The path metadata.json

• A (PuppetMetadata::Metadata) —

  Metadata object

# File 'lib/puppet_metadata.rb', line 30

def self.write(path, metadata)
  File.write(path, "#{JSON.pretty_generate(metadata.metadata)}\n")
end