Class: PDK::Module::Metadata
- Inherits:
-
Object
- Object
- PDK::Module::Metadata
- Includes:
- Util::Filesystem
- Defined in:
- lib/pdk/module/metadata.rb
Constant Summary collapse
- OPERATING_SYSTEMS =
{ 'RedHat based Linux' => [ { 'operatingsystem' => 'CentOS', 'operatingsystemrelease' => ['7'], }, { 'operatingsystem' => 'OracleLinux', 'operatingsystemrelease' => ['7'], }, { 'operatingsystem' => 'RedHat', 'operatingsystemrelease' => ['7'], }, { 'operatingsystem' => 'Scientific', 'operatingsystemrelease' => ['7'], }, ], 'Debian based Linux' => [ { 'operatingsystem' => 'Debian', 'operatingsystemrelease' => ['8'], }, { 'operatingsystem' => 'Ubuntu', 'operatingsystemrelease' => ['16.04'], }, ], 'Fedora' => { 'operatingsystem' => 'Fedora', 'operatingsystemrelease' => ['25'], }, 'OSX' => { 'operatingsystem' => 'Darwin', 'operatingsystemrelease' => ['16'], }, 'SLES' => { 'operatingsystem' => 'SLES', 'operatingsystemrelease' => ['12'], }, 'Solaris' => { 'operatingsystem' => 'Solaris', 'operatingsystemrelease' => ['11'], }, 'Windows' => { 'operatingsystem' => 'windows', 'operatingsystemrelease' => ['2008 R2', '2012 R2', '10'], }, }.freeze
- DEFAULT_OPERATING_SYSTEMS =
[ 'RedHat based Linux', 'Debian based Linux', 'Windows', ].freeze
- DEFAULTS =
{ 'name' => nil, 'version' => '0.1.0', 'author' => nil, 'summary' => '', 'license' => 'Apache-2.0', 'source' => '', 'project_page' => nil, 'issues_url' => nil, 'dependencies' => [], 'data_provider' => nil, 'operatingsystem_support' => DEFAULT_OPERATING_SYSTEMS.map { |os_name| OPERATING_SYSTEMS[os_name] }.flatten, 'requirements' => [ { 'name' => 'puppet', 'version_requirement' => '>= 4.10.0 < 7.0.0' }, ], }.freeze
Instance Attribute Summary collapse
-
#data ⇒ Object
Returns the value of attribute data.
Class Method Summary collapse
Instance Method Summary collapse
- #forge_ready? ⇒ Boolean
-
#initialize(params = {}) ⇒ Metadata
constructor
A new instance of Metadata.
- #interview_for_forge! ⇒ Object
- #puppet_requirement ⇒ Object
- #to_json ⇒ Object
- #update!(data) ⇒ Object
- #validate_puppet_version_requirement! ⇒ Object
- #write!(path) ⇒ Object
Methods included from Util::Filesystem
Constructor Details
Instance Attribute Details
#data ⇒ Object
Returns the value of attribute data.
7 8 9 |
# File 'lib/pdk/module/metadata.rb', line 7 def data @data end |
Class Method Details
.from_file(metadata_json_path) ⇒ Object
92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 |
# File 'lib/pdk/module/metadata.rb', line 92 def self.from_file() if .nil? raise ArgumentError, _('Cannot read metadata from file: no path to file was given.') end unless File.file?() raise ArgumentError, _("'%{file}' does not exist or is not a file.") % { file: } end unless File.readable?() raise ArgumentError, _("Unable to open '%{file}' for reading.") % { file: } end begin data = JSON.parse(File.read()) rescue JSON::JSONError => e raise ArgumentError, _('Invalid JSON in metadata.json: %{msg}') % { msg: e. } end new(data) end |
Instance Method Details
#forge_ready? ⇒ Boolean
129 130 131 |
# File 'lib/pdk/module/metadata.rb', line 129 def forge_ready? missing_fields.empty? end |
#interview_for_forge! ⇒ Object
133 134 135 |
# File 'lib/pdk/module/metadata.rb', line 133 def interview_for_forge! PDK::Generate::Module.module_interview(self, only_ask: missing_fields) end |
#puppet_requirement ⇒ Object
150 151 152 153 154 |
# File 'lib/pdk/module/metadata.rb', line 150 def puppet_requirement @data['requirements'].find do |r| r.key?('name') && r['name'] == 'puppet' end end |
#to_json ⇒ Object
121 122 123 |
# File 'lib/pdk/module/metadata.rb', line 121 def to_json JSON.pretty_generate(@data.dup.delete_if { |_key, value| value.nil? }) end |
#update!(data) ⇒ Object
114 115 116 117 118 119 |
# File 'lib/pdk/module/metadata.rb', line 114 def update!(data) # TODO: validate all data process_name(data) if data['name'] @data.merge!(data) self end |
#validate_puppet_version_requirement! ⇒ Object
137 138 139 140 141 142 143 144 145 146 147 148 |
# File 'lib/pdk/module/metadata.rb', line 137 def validate_puppet_version_requirement! msgs = { no_reqs: _('Module metadata does not contain any requirements.'), no_puppet_req: _('Module metadata does not contain a "puppet" requirement.'), no_puppet_ver: _('The "puppet" requirement in module metadata does not specify a "version_requirement".'), } raise ArgumentError, msgs[:no_reqs] unless @data.key?('requirements') raise ArgumentError, msgs[:no_puppet_req] if puppet_requirement.nil? raise ArgumentError, msgs[:no_puppet_ver] unless puppet_requirement.key?('version_requirement') raise ArgumentError, msgs[:no_puppet_ver] if puppet_requirement['version_requirement'].empty? end |
#write!(path) ⇒ Object
125 126 127 |
# File 'lib/pdk/module/metadata.rb', line 125 def write!(path) write_file(path, to_json) end |