Class: Puppet::ModuleTool::Applications::Application

Inherits:
Object
  • Object
show all
Includes:
Util::Colors
Defined in:
lib/puppet/module_tool/applications/application.rb

Direct Known Subclasses

Checksummer, Uninstaller

Constant Summary

Constants included from Util::Colors

Util::Colors::BG_BLUE, Util::Colors::BG_CYAN, Util::Colors::BG_GREEN, Util::Colors::BG_HBLUE, Util::Colors::BG_HCYAN, Util::Colors::BG_HGREEN, Util::Colors::BG_HMAGENTA, Util::Colors::BG_HRED, Util::Colors::BG_HWHITE, Util::Colors::BG_HYELLOW, Util::Colors::BG_MAGENTA, Util::Colors::BG_RED, Util::Colors::BG_WHITE, Util::Colors::BG_YELLOW, Util::Colors::BLACK, Util::Colors::BLUE, Util::Colors::CYAN, Util::Colors::Colormap, Util::Colors::GREEN, Util::Colors::HBLACK, Util::Colors::HBLUE, Util::Colors::HCYAN, Util::Colors::HGREEN, Util::Colors::HMAGENTA, Util::Colors::HRED, Util::Colors::HWHITE, Util::Colors::HYELLOW, Util::Colors::MAGENTA, Util::Colors::RED, Util::Colors::RESET, Util::Colors::WHITE, Util::Colors::YELLOW

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Util::Colors

#colorize, #console_color, #html_color

Constructor Details

#initialize(options = {}) ⇒ Application

Returns a new instance of Application.



16
17
18
 
# File 'lib/puppet/module_tool/applications/application.rb', line 16

def initialize(options = {})
  @options = options
end

Instance Attribute Details

#options ⇒ Object

Returns the value of attribute options.



14
15
16
 
# File 'lib/puppet/module_tool/applications/application.rb', line 14

def options
  @options
end

Class Method Details

.run(*args) ⇒ Object 



10
11
12
 
# File 'lib/puppet/module_tool/applications/application.rb', line 10

def self.run(*args)
  new(*args).run
end

Instance Method Details

#discuss(response, success, failure) ⇒ Object 



24
25
26
27
28
29
30
31
32
 
# File 'lib/puppet/module_tool/applications/application.rb', line 24

def discuss(response, success, failure)
  case response
  when Net::HTTPOK, Net::HTTPCreated
    Puppet.notice success
  else
    errors = JSON.parse(response.body)['error'] rescue "HTTP #{response.code}, #{response.body}"
    Puppet.warning "#{failure} (#{errors})"
  end
end

#load_metadata! ⇒ Object 



65
66
67
68
 
# File 'lib/puppet/module_tool/applications/application.rb', line 65

def load_metadata!
  @metadata = nil
  metadata(true)
end

#metadata(require_metadata = false) ⇒ Object 



34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/puppet/module_tool/applications/application.rb', line 34

def metadata(require_metadata = false)
  return @metadata if @metadata
  @metadata = Puppet::ModuleTool::Metadata.new

  unless @path
    raise ArgumentError, _("Could not determine module path")
  end

  if require_metadata && !Puppet::ModuleTool.is_module_root?(@path)
    raise ArgumentError, _("Unable to find metadata.json in module root at %{path} See https://docs.puppet.com/puppet/latest/reference/modules_publishing.html for required file format.") % { path: @path }
  end

  metadata_path   = File.join(@path, 'metadata.json')

  if File.file?(metadata_path)
    File.open(metadata_path) do |f|
      begin
        @metadata.update(JSON.load(f))
      rescue JSON::ParserError => ex
        raise ArgumentError, _("Could not parse JSON %{metadata_path}") % { metadata_path: metadata_path }, ex.backtrace
      end
    end
  end

  if File.file?(File.join(@path, 'Modulefile'))
    Puppet.warning _("A Modulefile was found in the root directory of the module. This file will be ignored and can safely be removed.")
  end

  return @metadata
end

#parse_filename(filename) ⇒ Object 



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/puppet/module_tool/applications/application.rb', line 70

def parse_filename(filename)
  if match = /^((.*?)-(.*?))-(\d+\.\d+\.\d+.*?)$/.match(File.basename(filename, '.tar.gz'))
    module_name, author, shortname, version = match.captures
  else
    raise ArgumentError, _("Could not parse filename to obtain the username, module name and version.  (%{release_name})") % { release_name: @release_name }
  end

  unless SemanticPuppet::Version.valid?(version)
    raise ArgumentError, _("Invalid version format: %{version} (Semantic Versions are acceptable: http://semver.org)") % { version: version }
  end

  return {
    :module_name => module_name,
    :author      => author,
    :dir_name    => shortname,
    :version     => version
  }
end

#run ⇒ Object

Raises:

  • (NotImplementedError) 


20
21
22
 
# File 'lib/puppet/module_tool/applications/application.rb', line 20

def run
  raise NotImplementedError, "Should be implemented in child classes."
end