puppet 4.10.0 → 5.0.0

data/lib/puppet/face/module/generate.rb

@@ -1,6 +1,6 @@
 Puppet::Face.define(:module, '1.0.0') do
   action(:generate) do
-    summary "Generate boilerplate for a new module."
+    summary _("Generate boilerplate for a new module.")
     description <<-EOT
       Generates boilerplate for a new module by creating the directory
       structure and files recommended for the Puppet community's best practices.
@@ -9,7 +9,7 @@ Puppet::Face.define(:module, '1.0.0') do
       if it provides plugins, files, or templates.
     EOT
 
-    returns "Array of Pathname objects representing paths of generated files."
+    returns _("Array of Pathname objects representing paths of generated files.")
 
     examples <<-EOT
       Generate a new module in the current directory:
@@ -77,14 +77,14 @@ Puppet::Face.define(:module, '1.0.0') do
     EOT
 
     option "--skip-interview" do
-      summary "Bypass the interactive metadata interview"
+      summary _("Bypass the interactive metadata interview")
       description <<-EOT
         Do not attempt to perform a metadata interview.  Primarily useful for automatic
         execution of `puppet module generate`.
       EOT
     end
 
-    arguments "<name>"
+    arguments _("<name>")
 
     when_invoked do |name, options|
       # Since we only want to interview if it's being rendered to the console
@@ -98,7 +98,7 @@ Puppet::Face.define(:module, '1.0.0') do
       #
       # All this is necessary because it is not possible at this point in time
       # to know what the destination of the output is.
-      "This format is not supported by this action."
+      _("This format is not supported by this action.")
     end
 
     when_rendering :console do |_, name, options|
@@ -118,7 +118,7 @@ Puppet::Face.define(:module, '1.0.0') do
           ]
         )
       rescue ArgumentError
-        msg = "Could not generate directory #{name.inspect}, you must specify a dash-separated username and module name."
+        msg = _("Could not generate directory %{name}, you must specify a dash-separated username and module name.") % { name: name.inspect }
         raise ArgumentError, msg, $!.backtrace
       end
 
@@ -126,7 +126,7 @@ Puppet::Face.define(:module, '1.0.0') do
       result = Puppet::ModuleTool::Generate.generate(metadata, options[:skip_interview])
 
       path = dest.relative_path_from(Pathname.pwd)
-      puts "Finished; module generated in #{path}."
+      puts _("Finished; module generated in %{path}.") % { path: path }
       result.join("\n")
     end
   end
@@ -144,42 +144,42 @@ module Puppet::ModuleTool::Generate
   end
 
   def interview(metadata)
-    puts "We need to create a metadata.json file for this module.  Please answer the"
-    puts "following questions; if the question is not applicable to this module, feel free"
-    puts "to leave it blank."
+    puts _("We need to create a metadata.json file for this module.  Please answer the
+    following questions; if the question is not applicable to this module, feel free
+    to leave it blank.")
 
     begin
       puts
-      puts "Puppet uses Semantic Versioning (semver.org) to version modules."
-      puts "What version is this module?  [#{metadata.version}]"
+      puts _("Puppet uses Semantic Versioning (semver.org) to version modules.")
+      puts _("What version is this module?  [%{version}]") % { version: metadata.version }
       metadata.update 'version' => user_input(metadata.version)
     rescue
-      Puppet.err "We're sorry, we could not parse that as a Semantic Version."
+      Puppet.err _("We're sorry, we could not parse that as a Semantic Version.")
       retry
     end
 
     puts
-    puts "Who wrote this module?  [#{metadata.author}]"
+    puts _("Who wrote this module?  [%{author}]") % { author: metadata.author }
     metadata.update 'author' => user_input(metadata.author)
 
     puts
-    puts "What license does this module code fall under?  [#{metadata.license}]"
+    puts _("What license does this module code fall under?  [%{license}]") % { license: metadata.license }
     metadata.update 'license' => user_input(metadata.license)
 
     puts
-    puts "How would you describe this module in a single sentence?"
+    puts _("How would you describe this module in a single sentence?")
     metadata.update 'summary' => user_input(metadata.summary)
 
     puts
-    puts "Where is this module's source code repository?"
+    puts _("Where is this module's source code repository?")
     metadata.update 'source' => user_input(metadata.source)
 
     puts
-    puts "Where can others go to learn more about this module?#{ metadata.project_page && "  [#{metadata.project_page}]" }"
+    puts _("Where can others go to learn more about this module?%{project_page}") % { project_page: metadata.project_page && "  [#{metadata.project_page}]" }
     metadata.update 'project_page' => user_input(metadata.project_page)
 
     puts
-    puts "Where can others go to file issues about this module?#{ metadata.issues_url && "  [#{metadata.issues_url}]" }"
+    puts _("Where can others go to file issues about this module?%{issues}") % { issues: metadata.issues_url && "  [#{metadata.issues_url}]" }
     metadata.update 'issues_url' => user_input(metadata.issues_url)
 
     puts
@@ -187,10 +187,10 @@ module Puppet::ModuleTool::Generate
     puts metadata.to_json
     puts '-' * 40
     puts
-    puts "About to generate this metadata; continue? [n/Y]"
+    puts _("About to generate this metadata; continue? [n/Y]")
 
     if user_input('Y') !~ /^y(es)?$/i
-      puts "Aborting..."
+      puts _("Aborting...")
       exit 0
     end
   end
@@ -205,7 +205,7 @@ module Puppet::ModuleTool::Generate
   def destination(metadata)
     return @dest if defined? @dest
     @dest = Pathname.pwd + metadata.name
-    raise ArgumentError, "#{@dest} already exists." if @dest.exist?
+    raise ArgumentError, _("%{destination} already exists.") % { destination: @dest } if @dest.exist?
     return @dest
   end
 
@@ -213,7 +213,7 @@ module Puppet::ModuleTool::Generate
     dest = destination(metadata)
 
     puts
-    Puppet.notice "Generating module at #{dest}..."
+    Puppet.notice _("Generating module at %{dest}...") % { dest: dest }
     FileUtils.cp_r skeleton_path, dest
 
     populate_templates(metadata, dest)
@@ -221,7 +221,7 @@ module Puppet::ModuleTool::Generate
   end
 
   def populate_templates(metadata, destination)
-    Puppet.notice "Populating templates..."
+    Puppet.notice _("Populating templates...")
 
     formatters = {
       :erb      => proc { |data, ctx| ERB.new(data).result(ctx) },

data/lib/puppet/face/module/install.rb

@@ -5,7 +5,7 @@ require 'pathname'
 
 Puppet::Face.define(:module, '1.0.0') do
   action(:install) do
-    summary "Install a module from the Puppet Forge or a release archive."
+    summary _("Install a module from the Puppet Forge or a release archive.")
     description <<-EOT
       Installs a module from the Puppet Forge or from a release archive file.
 
@@ -14,7 +14,7 @@ Puppet::Face.define(:module, '1.0.0') do
       directory in the modulepath.
     EOT
 
-    returns "Pathname object representing the path to the installed module."
+    returns _("Pathname object representing the path to the installed module.")
 
     examples <<-'EOT'
       Install a module:
@@ -81,10 +81,10 @@ Puppet::Face.define(:module, '1.0.0') do
 
     EOT
 
-    arguments "<name>"
+    arguments _("<name>")
 
     option "--force", "-f" do
-      summary "Force overwrite of existing module, if any. (Implies --ignore-dependencies.)"
+      summary _("Force overwrite of existing module, if any. (Implies --ignore-dependencies.)")
       description <<-EOT
         Force overwrite of existing module, if any.
         Implies --ignore-dependencies.
@@ -92,7 +92,7 @@ Puppet::Face.define(:module, '1.0.0') do
     end
 
     option "--target-dir DIR", "-i DIR" do
-      summary "The directory into which modules are installed."
+      summary _("The directory into which modules are installed.")
       description <<-EOT
         The directory into which modules are installed; defaults to the first
         directory in the modulepath.
@@ -105,23 +105,27 @@ Puppet::Face.define(:module, '1.0.0') do
     end
 
     option "--ignore-dependencies" do
-      summary "Do not attempt to install dependencies. (Implied by --force.)"
+      summary _("Do not attempt to install dependencies. (Implied by --force.)")
       description <<-EOT
         Do not attempt to install dependencies. Implied by --force.
       EOT
     end
 
     option "--version VER", "-v VER" do
-      summary "Module version to install."
+      summary _("Module version to install.")
       description <<-EOT
         Module version to install; can be an exact version or a requirement string,
         eg '>= 1.0.3'. Defaults to latest version.
       EOT
     end
 
+    option '--strict-semver' do
+      summary _('Whether version ranges should exclude pre-release versions')
+    end
+
     when_invoked do |name, options|
       Puppet::ModuleTool.set_option_defaults options
-      Puppet.notice "Preparing to install into #{options[:target_dir]} ..."
+      Puppet.notice _("Preparing to install into %{dir} ...") % { dir: options[:target_dir] }
 
       install_dir = Puppet::ModuleTool::InstallDirectory.new(Pathname.new(options[:target_dir]))
       Puppet::ModuleTool::Applications::Installer.run(name, install_dir, options)
@@ -129,7 +133,7 @@ Puppet::Face.define(:module, '1.0.0') do
 
     when_rendering :console do |return_value, name, options|
       if return_value[:result] == :noop
-        Puppet.notice "Module #{name} #{return_value[:version]} is already installed."
+        Puppet.notice _("Module %{name} %{version} is already installed.") % { name: name, version: return_value[:version] }
         exit 0
       elsif return_value[:result] == :failure
         Puppet.err(return_value[:error][:multiline])

data/lib/puppet/face/module/list.rb

@@ -2,7 +2,7 @@
 
 Puppet::Face.define(:module, '1.0.0') do
   action(:list) do
-    summary "List installed modules"
+    summary _("List installed modules")
     description <<-HEREDOC
       Lists the installed puppet modules. By default, this action scans the
       modulepath from puppet.conf's `[main]` block; use the --modulepath
@@ -11,10 +11,14 @@ Puppet::Face.define(:module, '1.0.0') do
       The output of this action includes information from the module's
       metadata, including version numbers and unmet module dependencies.
     HEREDOC
-    returns "hash of paths to module objects"
+    returns _("hash of paths to module objects")
 
     option "--tree" do
-      summary "Whether to show dependencies as a tree view"
+      summary _("Whether to show dependencies as a tree view")
+    end
+
+    option '--strict-semver' do
+      summary _('Whether version ranges should exclude pre-release versions')
     end
 
     examples <<-'EOT'
@@ -73,11 +77,12 @@ Puppet::Face.define(:module, '1.0.0') do
 
       output = ''
 
+      environment.modules_strict_semver = !!options[:strict_semver]
       warn_unmet_dependencies(environment)
 
       environment.modulepath.each do |path|
         modules = modules_by_path[path]
-        no_mods = modules.empty? ? ' (no modules installed)' : ''
+        no_mods = modules.empty? ? _(' (no modules installed)') : ''
         output << "#{path}#{no_mods}\n"
 
         if options[:tree]
@@ -106,13 +111,13 @@ Puppet::Face.define(:module, '1.0.0') do
   def warn_unmet_dependencies(environment)
     error_types = {
       :non_semantic_version => {
-        :title => "Non semantic version dependency"
+        :title => _("Non semantic version dependency")
       },
       :missing => {
-        :title => "Missing dependency"
+        :title => _("Missing dependency")
       },
       :version_mismatch => {
-        :title => "Module '%s' (v%s) fails to meet some dependencies:"
+        :title => _("Module '%s' (v%s) fails to meet some dependencies:")
       }
     }
 
@@ -139,8 +144,7 @@ Puppet::Face.define(:module, '1.0.0') do
             parent_name        = dep[:parent][:name].gsub('/', '-')
             parent_version     = dep[:parent][:version]
 
-            msg = "'#{parent_name}' (#{parent_version})"
-            msg << " requires '#{dep_name}' (#{version_constraint})"
+            msg = _("'%{parent_name}' (%{parent_version}) requires '%{dependency_name}' (%{dependency_version})") % { parent_name: parent_name, parent_version: parent_version, dependency_name: dep_name, dependency_version: version_constraint }
             @unmet_deps[type][dep[:name]][:errors] << msg
             @unmet_deps[type][dep[:name]][:parent] = {
               :name    => dep[:parent][:name],
@@ -226,7 +230,7 @@ Puppet::Face.define(:module, '1.0.0') do
           dep[:reason] == :missing
         end
         missing_deps.map do |mis_mod|
-          str = "#{colorize(:bg_red, 'UNMET DEPENDENCY')} #{mis_mod[:name].gsub('/', '-')} "
+          str = "#{colorize(:bg_red, _('UNMET DEPENDENCY'))} #{mis_mod[:name].gsub('/', '-')} "
           str << "(#{colorize(:cyan, mis_mod[:version_constraint])})"
           node[:dependencies] << { :text => str }
         end
@@ -260,12 +264,12 @@ Puppet::Face.define(:module, '1.0.0') do
 
     if @unmet_deps[:version_mismatch].include?(mod.forge_name)
       if params[:label_invalid]
-        str << '  ' + colorize(:red, 'invalid')
+        str << '  ' + colorize(:red, _('invalid'))
       elsif parent.respond_to?(:forge_name)
         unmet_parent = @unmet_deps[:version_mismatch][mod.forge_name][:parent]
         if (unmet_parent[:name] == parent.forge_name &&
             unmet_parent[:version] == "v#{parent.version}")
-          str << '  ' + colorize(:red, 'invalid')
+          str << '  ' + colorize(:red, _('invalid'))
         end
       end
     end

data/lib/puppet/face/module/search.rb

@@ -3,13 +3,13 @@ require 'puppet/forge'
 
 Puppet::Face.define(:module, '1.0.0') do
   action(:search) do
-    summary "Search the Puppet Forge for a module."
+    summary _("Search the Puppet Forge for a module.")
     description <<-EOT
       Searches a repository for modules whose names, descriptions, or keywords
       match the provided search term.
     EOT
 
-    returns "Array of module metadata hashes"
+    returns _("Array of module metadata hashes")
 
     examples <<-EOT
       Search the Puppet Forge for a module:
@@ -19,7 +19,7 @@ Puppet::Face.define(:module, '1.0.0') do
       bacula        This is a generic Apache module      @puppetlabs        backups
     EOT
 
-    arguments "<search_term>"
+    arguments _("<search_term>")
 
     when_invoked do |term, options|
       Puppet::ModuleTool.set_option_defaults options
@@ -31,7 +31,7 @@ Puppet::Face.define(:module, '1.0.0') do
         raise results[:error][:multiline]
       end
 
-      return "No results found for '#{term}'." if results[:answers].empty?
+      return _("No results found for '%{term}'.") % { term: term } if results[:answers].empty?
 
       padding = '  '
       headers = {

data/lib/puppet/face/module/uninstall.rb

@@ -1,12 +1,12 @@
 Puppet::Face.define(:module, '1.0.0') do
   action(:uninstall) do
-    summary "Uninstall a puppet module."
+    summary _("Uninstall a puppet module.")
     description <<-EOT
       Uninstalls a puppet module from the modulepath (or a specific
       target directory).
     EOT
 
-    returns "Hash of module objects representing uninstalled modules and related errors."
+    returns _("Hash of module objects representing uninstalled modules and related errors.")
 
     examples <<-'EOT'
       Uninstall a module:
@@ -30,10 +30,10 @@ Puppet::Face.define(:module, '1.0.0') do
       Removed /etc/puppetlabs/code/modules/ssh (v2.0.0)
     EOT
 
-    arguments "<name>"
+    arguments _("<name>")
 
     option "--force", "-f" do
-      summary "Force uninstall of an installed module."
+      summary _("Force uninstall of an installed module.")
       description <<-EOT
         Force the uninstall of an installed module even if there are local
         changes or the possibility of causing broken dependencies.
@@ -41,25 +41,29 @@ Puppet::Face.define(:module, '1.0.0') do
     end
 
     option "--ignore-changes", "-c" do
-      summary "Ignore any local changes made. (Implied by --force.)"
+      summary _("Ignore any local changes made. (Implied by --force.)")
       description <<-EOT
         Uninstall an installed module even if there are local changes to it.  (Implied by --force.)
       EOT
     end
 
     option "--version=" do
-      summary "The version of the module to uninstall"
+      summary _("The version of the module to uninstall")
       description <<-EOT
         The version of the module to uninstall. When using this option, a module
         matching the specified version must be installed or else an error is raised.
       EOT
     end
 
+    option '--strict-semver' do
+      summary _('Whether version ranges should exclude pre-release versions')
+    end
+
     when_invoked do |name, options|
       name = name.gsub('/', '-')
 
       Puppet::ModuleTool.set_option_defaults options
-      Puppet.notice "Preparing to uninstall '#{name}'" << (options[:version] ? " (#{colorize(:cyan, options[:version].sub(/^(?=\d)/, 'v'))})" : '') << " ..."
+      Puppet.notice _("Preparing to uninstall '%{name}'") % { name: name } << (options[:version] ? " (#{colorize(:cyan, options[:version].sub(/^(?=\d)/, 'v'))})" : '') << " ..."
       Puppet::ModuleTool::Applications::Uninstaller.run(name, options)
     end
 
@@ -69,9 +73,8 @@ Puppet::Face.define(:module, '1.0.0') do
         exit 1
       else
         mod = return_value[:affected_modules].first
-        "Removed '#{return_value[:module_name]}'" <<
-        (mod.version ? " (#{colorize(:cyan, mod.version.to_s.sub(/^(?=\d)/, 'v'))})" : '') <<
-        " from #{mod.modulepath}"
+        module_version = mod.version ? " (#{colorize(:cyan, mod.version.to_s.sub(/^(?=\d)/, 'v'))})" : ''
+        _("Removed '%{name}'%{module_version} from %{path}") % { name: return_value[:module_name], module_version: module_version, path: mod.modulepath }
       end
     end
   end

data/lib/puppet/face/module/upgrade.rb

@@ -2,7 +2,7 @@
 
 Puppet::Face.define(:module, '1.0.0') do
   action(:upgrade) do
-    summary "Upgrade a puppet module."
+    summary _("Upgrade a puppet module.")
     description <<-EOT
       Upgrades a puppet module.
     EOT
@@ -29,10 +29,10 @@ Puppet::Face.define(:module, '1.0.0') do
       └── puppetlabs-apache (v1.0.0 -> v2.4.0)
     EOT
 
-    arguments "<name>"
+    arguments _("<name>")
 
     option "--force", "-f" do
-      summary "Force upgrade of an installed module. (Implies --ignore-dependencies.)"
+      summary _("Force upgrade of an installed module. (Implies --ignore-dependencies.)")
       description <<-EOT
         Force the upgrade of an installed module even if there are local
         changes or the possibility of causing broken dependencies.
@@ -41,29 +41,33 @@ Puppet::Face.define(:module, '1.0.0') do
     end
 
     option "--ignore-dependencies" do
-      summary "Do not attempt to install dependencies. (Implied by --force.)"
+      summary _("Do not attempt to install dependencies. (Implied by --force.)")
       description <<-EOT
         Do not attempt to install dependencies. Implied by --force.
       EOT
     end
 
     option "--ignore-changes", "-c" do
-      summary "Ignore and overwrite any local changes made. (Implied by --force.)"
+      summary _("Ignore and overwrite any local changes made. (Implied by --force.)")
       description <<-EOT
         Upgrade an installed module even if there are local changes to it.  (Implied by --force.)
       EOT
     end
 
     option "--version=" do
-      summary "The version of the module to upgrade to."
+      summary _("The version of the module to upgrade to.")
       description <<-EOT
         The version of the module to upgrade to.
       EOT
     end
 
+    option '--strict-semver' do
+      summary _('Whether version ranges should exclude pre-release versions')
+    end
+
     when_invoked do |name, options|
       name = name.gsub('/', '-')
-      Puppet.notice "Preparing to upgrade '#{name}' ..."
+      Puppet.notice _("Preparing to upgrade '%{name}' ...") % { name: name }
       Puppet::ModuleTool.set_option_defaults options
       Puppet::ModuleTool::Applications::Upgrader.new(name, options).run
     end

data/lib/puppet/face/module.rb

@@ -5,10 +5,10 @@ require 'puppet/util/colors'
 Puppet::Face.define(:module, '1.0.0') do
   extend Puppet::Util::Colors
 
-  copyright "Puppet Labs", 2012
-  license   "Apache 2 license; see COPYING"
+  copyright "Puppet Inc.", 2012
+  license   _("Apache 2 license; see COPYING")
 
-  summary "Creates, installs and searches for modules on the Puppet Forge."
+  summary _("Creates, installs and searches for modules on the Puppet Forge.")
   description <<-EOT
     This subcommand can find, install, and manage modules from the Puppet Forge,
     a repository of user-contributed Puppet code. It can also generate empty

data/lib/puppet/face/node/clean.rb

@@ -1,8 +1,8 @@
 Puppet::Face.define(:node, '0.0.1') do
   action(:clean) do
 
-    summary "Clean up signed certs, cached facts, node objects, and reports for a node stored by the puppetmaster"
-    arguments "<host1> [<host2> ...]"
+    summary _("Clean up signed certs, cached facts, node objects, and reports for a node stored by the puppetmaster")
+    arguments _("<host1> [<host2> ...]")
     description <<-'EOT'
       Cleans up the following information a puppet master knows about a node:
 
@@ -19,7 +19,7 @@ Puppet::Face.define(:node, '0.0.1') do
     when_invoked do |*args|
       nodes = args[0..-2]
       options = args.last
-      raise "At least one node should be passed" if nodes.empty? || nodes == options
+      raise _("At least one node should be passed") if nodes.empty? || nodes == options
 
       # This seems really bad; run_mode should be set as part of a class
       # definition, and should not be modifiable beyond that.  This is one of
@@ -56,28 +56,28 @@ Puppet::Face.define(:node, '0.0.1') do
     if Puppet::SSL::CertificateAuthority.ca?
       Puppet::Face[:ca, :current].revoke(node)
       Puppet::Face[:ca, :current].destroy(node)
-      Puppet.info "#{node} certificates removed from ca"
+      Puppet.info _("%{node} certificates removed from ca") % { node: node }
     else
-      Puppet.info "Not managing #{node} certs as this host is not a CA"
+      Puppet.info _("Not managing %{node} certs as this host is not a CA") % { node: node }
     end
   end
 
   # clean facts for +host+
   def clean_cached_facts(node)
     Puppet::Node::Facts.indirection.destroy(node)
-    Puppet.info "#{node}'s facts removed"
+    Puppet.info _("%{node}'s facts removed") % { node: node }
   end
 
   # clean cached node +host+
   def clean_cached_node(node)
     Puppet::Node.indirection.destroy(node)
-    Puppet.info "#{node}'s cached node removed"
+    Puppet.info _("%{node}'s cached node removed") % { node: node }
   end
 
   # clean node reports for +host+
   def clean_reports(node)
     Puppet::Transaction::Report.indirection.destroy(node)
-    Puppet.info "#{node}'s reports removed"
+    Puppet.info _("%{node}'s reports removed") % { node: node }
   end
 
   def environment

data/lib/puppet/face/node.rb

@@ -1,9 +1,9 @@
 require 'puppet/indirector/face'
 Puppet::Indirector::Face.define(:node, '0.0.1') do
-  copyright "Puppet Labs", 2011
-  license   "Apache 2 license; see COPYING"
+  copyright "Puppet Inc.", 2011
+  license   _("Apache 2 license; see COPYING")
 
-  summary "View and manage node definitions."
+  summary _("View and manage node definitions.")
   description <<-'EOT'
     This subcommand interacts with node objects, which are used by Puppet to
     build a catalog. A node object consists of the node's facts, environment,
@@ -15,9 +15,9 @@ Puppet::Indirector::Face.define(:node, '0.0.1') do
   deactivate_action(:save)
 
   find = get_action(:find)
-  find.summary "Retrieve a node object."
-  find.arguments "<host>"
-  find.returns <<-'EOT'
+  find.summary _("Retrieve a node object.")
+  find.arguments _("<host>")
+  find.returns _(<<-'EOT')
     A hash containing the node's `classes`, `environment`, `expiration`, `name`,
     `parameters` (its facts, combined with any ENC-set parameters), and `time`.
     When used from the Ruby API: a Puppet::Node object.