puppet 4.10.12 → 5.0.0

data/lib/puppet/face/facts.rb

@@ -3,9 +3,9 @@ require 'puppet/node/facts'
 
 Puppet::Indirector::Face.define(:facts, '0.0.1') do
   copyright "Puppet Inc.", 2011
-  license   "Apache 2 license; see COPYING"
+  license   _("Apache 2 license; see COPYING")
 
-  summary "Retrieve and store facts."
+  summary _("Retrieve and store facts.")
   description <<-'EOT'
     This subcommand manages facts, which are collections of normalized system
     information used by Puppet. It can read facts directly from the local system
@@ -13,8 +13,8 @@ Puppet::Indirector::Face.define(:facts, '0.0.1') do
   EOT
 
   find = get_action(:find)
-  find.summary "Retrieve a node's facts."
-  find.arguments "[<node_certname>]"
+  find.summary _("Retrieve a node's facts.")
+  find.arguments _("[<node_certname>]")
   find.returns <<-'EOT'
     A hash containing some metadata and (under the "values" key) the set
     of facts for the requested node. When used from the Ruby API: A

data/lib/puppet/face/generate.rb

@@ -4,12 +4,12 @@ require 'puppet/generate/type'
 # Create the Generate face
 Puppet::Face.define(:generate, '0.1.0') do
   copyright 'Puppet Inc.', 2016
-  license   'Apache 2 license; see COPYING'
+  license   _('Apache 2 license; see COPYING')
 
-  summary 'Generates Puppet code from Ruby definitions.'
+  summary _('Generates Puppet code from Ruby definitions.')
 
   action(:types) do
-    summary 'Generates Puppet code for custom types'
+    summary _('Generates Puppet code for custom types')
 
     description <<-'EOT'
       Generates definitions for custom resource types using Puppet code.
@@ -28,17 +28,17 @@ Puppet::Face.define(:generate, '0.1.0') do
           $ puppet generate types --environment development
     EOT
 
-    option '--format <format>' do
-      summary 'The generation output format to use. Supported formats: pcore.'
+    option '--format ' + _('<format>') do
+      summary _('The generation output format to use. Supported formats: pcore.')
       default_to { 'pcore' }
 
       before_action do |_, _, options|
-        raise ArgumentError, "'#{options[:format]}' is not a supported format for type generation." unless ['pcore'].include?(options[:format])
+        raise ArgumentError, _("'%{format}' is not a supported format for type generation.") % { format: options[:format] } unless ['pcore'].include?(options[:format])
       end
     end
 
     option '--force' do
-      summary 'Forces the generation of output files (skips up-to-date checks).'
+      summary _('Forces the generation of output files (skips up-to-date checks).')
       default_to { false }
     end
 
@@ -53,7 +53,7 @@ Puppet::Face.define(:generate, '0.1.0') do
       path_to_env = environment.configuration.path_to_env
       outputdir = File.join(path_to_env, '.resource_types')
       if Puppet::FileSystem.exist?(outputdir) && !Puppet::FileSystem.directory?(outputdir)
-        raise ArgumentError, "The output directory '#{outputdir}' exists and is not a directory"
+        raise ArgumentError, _("The output directory '%{outputdir}' exists and is not a directory") % { outputdir: outputdir }
       end
       Puppet::FileSystem::mkpath(outputdir)
 

data/lib/puppet/face/help.rb

@@ -78,11 +78,11 @@ Puppet::Face.define(:help, '0.0.1') do
   def render_application_help(applicationname)
     return Puppet::Application[applicationname].help
   rescue StandardError, LoadError => detail
-    msg = _(<<-MSG)
-Could not load help for the application #{applicationname}.
+    msg = _(<<-MSG) % { applicationname: applicationname, detail: detail.message }
+Could not load help for the application %{applicationname}.
 Please check the error logs for more information.
 
-Detail: "#{detail.message}"
+Detail: "%{detail}"
 MSG
     fail ArgumentError, msg, detail.backtrace
   end
@@ -91,11 +91,11 @@ MSG
     face, action = load_face_help(facename, actionname, version)
     return template_for(face, action).result(binding)
   rescue StandardError, LoadError => detail
-    msg = _(<<-MSG)
-Could not load help for the face #{facename}.
+    msg = _(<<-MSG) % { facename: facename, detail: detail.message }
+Could not load help for the face %{facename}.
 Please check the error logs for more information.
 
-Detail: "#{detail.message}"
+Detail: "%{detail}"
 MSG
     fail ArgumentError, msg, detail.backtrace
   end
@@ -105,7 +105,7 @@ MSG
     if actionname
       action = face.get_action(actionname.to_sym)
       if not action
-        fail ArgumentError, _("Unable to load action #{actionname} from #{face}")
+        fail ArgumentError, _("Unable to load action %{actionname} from %{face}") % { actionname: actionname, face: face }
       end
     end
 

data/lib/puppet/face/key.rb

@@ -2,9 +2,9 @@ require 'puppet/indirector/face'
 
 Puppet::Indirector::Face.define(:key, '0.0.1') do
   copyright "Puppet Inc.", 2011
-  license   "Apache 2 license; see COPYING"
+  license   _("Apache 2 license; see COPYING")
 
-  summary "Create, save, and remove certificate keys."
+  summary _("Create, save, and remove certificate keys.")
   description <<-'EOT'
     This subcommand manages certificate private keys. Keys are created
     automatically by puppet agent and when certificate requests are generated

data/lib/puppet/face/man.rb

@@ -5,9 +5,9 @@ require 'erb'
 
 Puppet::Face.define(:man, '0.0.1') do
   copyright "Puppet Inc.", 2011
-  license   "Apache 2 license; see COPYING"
+  license   _("Apache 2 license; see COPYING")
 
-  summary "Display Puppet manual pages."
+  summary _("Display Puppet manual pages.")
 
   description <<-EOT
     This subcommand displays manual pages for all Puppet subcommands. If the
@@ -23,9 +23,9 @@ Puppet::Face.define(:man, '0.0.1') do
   EOT
 
   action(:man) do
-    summary "Display the manual page for a Puppet subcommand."
-    arguments "<subcommand>"
-    returns <<-'EOT'
+    summary _("Display the manual page for a Puppet subcommand.")
+    arguments _("<subcommand>")
+    returns _(<<-'EOT')
       The man data, in Markdown format, suitable for consumption by Ronn.
 
       RENDERING ISSUES: To skip fancy formatting and output the raw Markdown

data/lib/puppet/face/module.rb

@@ -6,9 +6,9 @@ Puppet::Face.define(:module, '1.0.0') do
   extend Puppet::Util::Colors
 
   copyright "Puppet Inc.", 2012
-  license   "Apache 2 license; see COPYING"
+  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/module/build.rb

@@ -1,6 +1,6 @@
 Puppet::Face.define(:module, '1.0.0') do
   action(:build) do
-    summary "Build a module release package."
+    summary _("Build a module release package.")
     description <<-EOT
       Prepares a local module for release on the Puppet Forge by building a
       ready-to-upload archive file.
@@ -13,7 +13,7 @@ Puppet::Face.define(:module, '1.0.0') do
       `pkg` directory.
     EOT
 
-    returns "Pathname object representing the path to the release archive."
+    returns _("Pathname object representing the path to the release archive.")
 
     examples <<-EOT
       Build a module release:
@@ -30,12 +30,12 @@ Puppet::Face.define(:module, '1.0.0') do
       Module built: /Users/kelseyhightower/puppetlabs-apache/pkg/puppetlabs-apache-0.0.1.tar.gz
     EOT
 
-    arguments "[<path>]"
+    arguments _("[<path>]")
 
     when_invoked do |*args|
       options = args.pop
       if options.nil? or args.length > 1 then
-        raise ArgumentError, "puppet module build only accepts 0 or 1 arguments"
+        raise ArgumentError, _("puppet module build only accepts 0 or 1 arguments")
       end
 
       module_path = args.first
@@ -43,11 +43,11 @@ Puppet::Face.define(:module, '1.0.0') do
         pwd = Dir.pwd
         module_path = Puppet::ModuleTool.find_module_root(pwd)
         if module_path.nil?
-          raise "Unable to find metadata.json in module root #{pwd} or parent directories. See <https://docs.puppetlabs.com/puppet/latest/reference/modules_publishing.html> for required file format."
+          raise _("Unable to find metadata.json in module root %{pwd} or parent directories. See <https://docs.puppetlabs.com/puppet/latest/reference/modules_publishing.html> for required file format.") % { pwd: pwd }
         end
       else
         unless Puppet::ModuleTool.is_module_root?(module_path)
-          raise "Unable to find metadata.json in module root #{module_path} or parent directories. See <https://docs.puppetlabs.com/puppet/latest/reference/modules_publishing.html> for required file format."
+          raise _("Unable to find metadata.json in module root %{module_path} or parent directories. See <https://docs.puppetlabs.com/puppet/latest/reference/modules_publishing.html> for required file format.") % { module_path: module_path }
         end
       end
 
@@ -57,7 +57,7 @@ Puppet::Face.define(:module, '1.0.0') do
 
     when_rendering :console do |return_value|
       # Get the string representation of the Pathname object.
-      "Module built: " + return_value.expand_path.to_s
+      _("Module built: ") + return_value.expand_path.to_s
     end
   end
 end

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

@@ -1,6 +1,6 @@
 Puppet::Face.define(:module, '1.0.0') do
   action(:changes) do
-    summary "Show modified files of an installed module."
+    summary _("Show modified files of an installed module.")
     description <<-EOT
       Shows any files in a module that have been modified since it was
       installed. This action compares the files on disk to the md5 checksums
@@ -8,7 +8,7 @@ Puppet::Face.define(:module, '1.0.0') do
       metadata.json.
     EOT
 
-    returns "Array of strings representing paths of modified files."
+    returns _("Array of strings representing paths of modified files.")
 
     examples <<-EOT
       Show modified files of an installed module:
@@ -18,21 +18,21 @@ Puppet::Face.define(:module, '1.0.0') do
       lib/puppet/provider/vcsrepo.rb
     EOT
 
-    arguments "<path>"
+    arguments _("<path>")
 
     when_invoked do |path, options|
       Puppet::ModuleTool.set_option_defaults options
       unless root_path = Puppet::ModuleTool.find_module_root(path)
-        raise ArgumentError, "Could not find a valid module at #{path.inspect}"
+        raise ArgumentError, _("Could not find a valid module at %{path}") % { path: path.inspect }
       end
       Puppet::ModuleTool::Applications::Checksummer.run(root_path, options)
     end
 
     when_rendering :console do |return_value|
       if return_value.empty?
-        Puppet.notice "No modified files"
+        Puppet.notice _("No modified files")
       else
-        Puppet.warning "#{return_value.size} files modified"
+        Puppet.warning _("%{count} files modified") % { count: return_value.size }
       end
       return_value.map do |changed_file|
         "#{changed_file}"

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])