Class: PDK::Module::Metadata

Inherits:
Object
  • Object
show all
Defined in:
lib/pdk/module/metadata.rb

Constant Summary collapse

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' => [
    {
      'operatingsystem' => 'Debian',
      'operatingsystemrelease' => ['8'],
    },
    {
      'operatingsystem' => 'RedHat',
      'operatingsystemrelease' => ['7.0'],
    },
    {
      'operatingsystem' => 'Ubuntu',
      'operatingsystemrelease' => ['16.04'],
    },
    {
      'operatingsystem' => 'windows',
      'operatingsystemrelease' => ['2012 R2'],
    },
  ],
  'requirements' => [
    { 'name' => 'puppet', 'version_requirement' => '>= 4.7.0 < 6.0.0' },
  ],
}.freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(params = {}) ⇒ Metadata

Returns a new instance of Metadata.



42
43
44
45
 
# File 'lib/pdk/module/metadata.rb', line 42

def initialize(params = {})
  @data = DEFAULTS.dup
  update!(params) if params
end

Instance Attribute Details

#data ⇒ Object

Returns the value of attribute data.



6
7
8
 
# File 'lib/pdk/module/metadata.rb', line 6

def data
  @data
end

Class Method Details

.from_file(metadata_json_path) ⇒ Object 



47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/pdk/module/metadata.rb', line 47

def self.from_file(metadata_json_path)
  unless File.file?(metadata_json_path)
    raise ArgumentError, _("'%{file}' does not exist or is not a file.") % { file: metadata_json_path }
  end

  unless File.readable?(metadata_json_path)
    raise ArgumentError, _("Unable to open '%{file}' for reading.") % { file: metadata_json_path }
  end

  begin
    data = JSON.parse(File.read(metadata_json_path))
  rescue JSON::JSONError => e
    raise ArgumentError, _('Invalid JSON in metadata.json: %{msg}') % { msg: e.message }
  end

  new(data)
end

Instance Method Details

#forge_ready? ⇒ Boolean

Returns:

  • (Boolean) 


82
83
84
 
# File 'lib/pdk/module/metadata.rb', line 82

def forge_ready?
  missing_fields.empty?
end

#interview_for_forge! ⇒ Object 



86
87
88
 
# File 'lib/pdk/module/metadata.rb', line 86

def interview_for_forge!
  PDK::Generate::Module.module_interview(self, only_ask: missing_fields)
end

#to_json ⇒ Object 



72
73
74
 
# File 'lib/pdk/module/metadata.rb', line 72

def to_json
  JSON.pretty_generate(@data.dup.delete_if { |_key, value| value.nil? })
end

#update!(data) ⇒ Object 



65
66
67
68
69
70
 
# File 'lib/pdk/module/metadata.rb', line 65

def update!(data)
  # TODO: validate all data
  process_name(data) if data['name']
  @data.merge!(data)
  self
end

#write!(path) ⇒ Object 



76
77
78
79
80
 
# File 'lib/pdk/module/metadata.rb', line 76

def write!(path)
  File.open(path, 'w') do |file|
    file.puts to_json
  end
end