puppet 5.3.3 → 5.3.4

data/lib/puppet/interface/action_builder.rb

@@ -49,10 +49,12 @@ class Puppet::Interface::ActionBuilder
   # @dsl Faces
   def when_rendering(type = nil, &block)
     if type.nil? then           # the default error message sucks --daniel 2011-04-18
-      raise ArgumentError, 'You must give a rendering format to when_rendering'
+      #TRANSLATORS 'when_rendering' is a method name and should not be translated
+      raise ArgumentError, _('You must give a rendering format to when_rendering')
     end
     if block.nil? then
-      raise ArgumentError, 'You must give a block to when_rendering'
+      #TRANSLATORS 'when_rendering' is a method name and should not be translated
+      raise ArgumentError, _('You must give a block to when_rendering')
     end
     @action.set_rendering_method_for(type, block)
   end
@@ -111,11 +113,15 @@ class Puppet::Interface::ActionBuilder
   # Sets the default rendering format
   # @api private
   def render_as(value = nil)
-    value.nil? and raise ArgumentError, "You must give a rendering format to render_as"
+    if value.nil?
+      #TRANSLATORS 'render_as' is a method name and should not be translated
+      raise ArgumentError, _("You must give a rendering format to render_as")
+    end
 
     formats = Puppet::Network::FormatHandler.formats
     unless formats.include? value
-      raise ArgumentError, "#{value.inspect} is not a valid rendering format: #{formats.sort.join(", ")}"
+      raise ArgumentError, _("%{value} is not a valid rendering format: %{formats_list}") %
+          { value: value.inspect, formats_list: formats.sort.join(", ")}
     end
 
     @action.render_as = value
@@ -144,6 +150,9 @@ class Puppet::Interface::ActionBuilder
     @face   = face
     @action = Puppet::Interface::Action.new(face, name)
     instance_eval(&block)
-    @action.when_invoked or raise ArgumentError, "actions need to know what to do when_invoked; please add the block"
+    unless @action.when_invoked
+      #TRANSLATORS 'when_invoked' is a method name and should not be translated and 'block' is a Ruby code block
+      raise ArgumentError, _("actions need to know what to do when_invoked; please add the block")
+    end
   end
 end

data/lib/puppet/interface/action_manager.rb

@@ -17,7 +17,7 @@ module Puppet::Interface::ActionManager
   # @dsl Faces
   def action(name, &block)
     @actions ||= {}
-    Puppet.warning "Redefining action #{name} for #{self}" if action?(name)
+    Puppet.warning _("Redefining action %{name} for %{self}") % { name: name, self: self } if action?(name)
 
     action = Puppet::Interface::ActionBuilder.build(self, name, &block)
 

data/lib/puppet/interface/documentation.rb

@@ -56,7 +56,8 @@ class Puppet::Interface
     # @dsl Faces
     attr_doc :summary do |value|
       value =~ /\n/ and
-        raise ArgumentError, "Face summary should be a single line; put the long text in 'description' instead."
+        #TRANSLATORS 'Face' refers to a programming API in Puppet, 'summary' and 'description' are specifc attribute names and should not be translated
+        raise ArgumentError, _("Face summary should be a single line; put the long text in 'description' instead.")
       value
     end
 
@@ -200,11 +201,13 @@ class Puppet::Interface
     def author(value = nil)
       unless value.nil? then
         unless value.is_a? String
-          raise ArgumentError, 'author must be a string; use multiple statements for multiple authors'
+          #TRANSLATORS 'author' is an attribute name and should not be translated
+          raise ArgumentError, _('author must be a string; use multiple statements for multiple authors')
         end
 
         if value =~ /\n/ then
-          raise ArgumentError, 'author should be a single line; use multiple statements for multiple authors'
+          #TRANSLATORS 'author' is an attribute name and should not be translated
+          raise ArgumentError, _('author should be a single line; use multiple statements for multiple authors')
         end
         @authors.push(Puppet::Interface::DocGen.strip_whitespace(value))
       end
@@ -223,7 +226,8 @@ class Puppet::Interface
       # I think it's a bug that this ends up being the exposed
       # version of `author` on ActionBuilder
       if Array(value).any? {|x| x =~ /\n/ } then
-        raise ArgumentError, 'author should be a single line; use multiple statements'
+        #TRANSLATORS 'author' is an attribute name and should not be translated
+        raise ArgumentError, _('author should be a single line; use multiple statements')
       end
       @authors = Array(value).map{|x| Puppet::Interface::DocGen.strip_whitespace(x) }
     end
@@ -243,7 +247,8 @@ class Puppet::Interface
     # @dsl Faces
     def copyright(owner = nil, years = nil)
       if years.nil? and not owner.nil? then
-        raise ArgumentError, 'copyright takes the owners names, then the years covered'
+        #TRANSLATORS 'copyright' is an attribute name and should not be translated
+        raise ArgumentError, _('copyright takes the owners names, then the years covered')
       end
       self.copyright_owner = owner unless owner.nil?
       self.copyright_years = years unless years.nil?
@@ -266,7 +271,8 @@ class Puppet::Interface
       when String then @copyright_owner = value
       when Array  then @copyright_owner = value.join(", ")
       else
-        raise ArgumentError, "copyright owner must be a string or an array of strings"
+        #TRANSLATORS 'copyright' is an attribute name and should not be translated
+        raise ArgumentError, _("copyright owner must be a string or an array of strings")
       end
       @copyright_owner
     end
@@ -302,7 +308,9 @@ class Puppet::Interface
           fault = "after #{future}"
         end
         if fault then
-          raise ArgumentError, "copyright with a year #{fault} is very strange; did you accidentally add or subtract two years?"
+          #TRANSLATORS 'copyright' is an attribute name and should not be translated
+          raise ArgumentError, _("copyright with a year %{value} is very strange; did you accidentally add or subtract two years?") %
+              { value: fault }
         end
 
         input
@@ -314,11 +322,13 @@ class Puppet::Interface
             part.to_i
           elsif found = part.split(/-/) then
             unless found.length == 2 and found.all? {|x| x.strip =~ /^\d+$/ }
-              raise ArgumentError, "#{part.inspect} is not a good copyright year or range"
+              #TRANSLATORS 'copyright' is an attribute name and should not be translated
+              raise ArgumentError, _("%{value} is not a good copyright year or range") % { value: part.inspect }
             end
             Range.new(found[0].to_i, found[1].to_i)
           else
-            raise ArgumentError, "#{part.inspect} is not a good copyright year or range"
+            #TRANSLATORS 'copyright' is an attribute name and should not be translated
+            raise ArgumentError, _("%{value} is not a good copyright year or range") % { value: part.inspect }
           end
         end
 
@@ -335,7 +345,8 @@ class Puppet::Interface
         result
 
       else
-        raise ArgumentError, "#{input.inspect} is not a good copyright year, set, or range"
+        #TRANSLATORS 'copyright' is an attribute name and should not be translated
+        raise ArgumentError, _("%{value} is not a good copyright year, set, or range") % { value: input.inspect }
       end
     end
   end

data/lib/puppet/interface/face_collection.rb

@@ -111,7 +111,7 @@ module Puppet::Interface::FaceCollection
     nil
   rescue SyntaxError => e
     raise unless e.message =~ %r{#{path}\.rb:\d+: }
-    Puppet.err "Failed to load face #{name}:\n#{e}"
+    Puppet.err _("Failed to load face %{name}:\n%{detail}") % { name: name, detail: e }
     # ...but we just carry on after complaining.
     nil
   end
@@ -122,7 +122,9 @@ module Puppet::Interface::FaceCollection
 
   def self.underscorize(name)
     unless name.to_s =~ /^[-_a-z][-_a-z0-9]*$/i then
-      raise ArgumentError, "#{name.inspect} (#{name.class}) is not a valid face name"
+      #TRANSLATORS 'face' refers to a programming API in Puppet
+      raise ArgumentError, _("%{name} (%{class_name}) is not a valid face name") %
+          { name: name.inspect, class_name: name.class }
     end
 
     name.to_s.downcase.split(/[-_]/).join('_').to_sym

data/lib/puppet/interface/option.rb

@@ -18,7 +18,7 @@ class Puppet::Interface::Option
     declaration.each do |item|
       if item.is_a? String and item.to_s =~ /^-/ then
         unless item =~ /^-[a-z]\b/ or item =~ /^--[^-]/ then
-          raise ArgumentError, "#{item.inspect}: long options need two dashes (--)"
+          raise ArgumentError, _("%{option}: long options need two dashes (--)") % { option: item.inspect }
         end
         @optparse << item
 
@@ -33,20 +33,21 @@ class Puppet::Interface::Option
         # jeffweiss 17 april 2012
         name = optparse_to_optionname(item)
         if Puppet.settings.include? name then
-          raise ArgumentError, "#{item.inspect}: already defined in puppet"
+          raise ArgumentError, _("%{option}: already defined in puppet") % { option: item.inspect }
         end
         if dup = dups[name] then
-          raise ArgumentError, "#{item.inspect}: duplicates existing alias #{dup.inspect} in #{@parent}"
+          raise ArgumentError, _("%{option}: duplicates existing alias %{duplicate} in %{parent}") %
+              { option: item.inspect, duplicate: dup.inspect, parent: @parent }
         else
           dups[name] = item
         end
       else
-        raise ArgumentError, "#{item.inspect} is not valid for an option argument"
+        raise ArgumentError, _("%{option} is not valid for an option argument") % { option: item.inspect }
       end
     end
 
     if @optparse.empty? then
-      raise ArgumentError, "No option declarations found while building"
+      raise ArgumentError, _("No option declarations found while building")
     end
 
     # Now, infer the name from the options; we prefer the first long option as
@@ -59,15 +60,17 @@ class Puppet::Interface::Option
     # relax this rule later if we find a valid use case for it. --daniel 2011-03-30
     @argument = @optparse.any? { |o| o =~ /[ =]/ }
     if @argument and not @optparse.all? { |o| o =~ /[ =]/ } then
-      raise ArgumentError, "Option #{@name} is inconsistent about taking an argument"
+      raise ArgumentError, _("Option %{name} is inconsistent about taking an argument") % { name: @name }
     end
 
     # Is our argument optional?  The rules about consistency apply here, also,
     # just like they do to taking arguments at all. --daniel 2011-03-30
     @optional_argument = @optparse.any? { |o| o=~/[ =]\[/ }
-    @optional_argument and raise ArgumentError, "Options with optional arguments are not supported"
+    if @optional_argument
+      raise ArgumentError, _("Options with optional arguments are not supported")
+    end
     if @optional_argument and not @optparse.all? { |o| o=~/[ =]\[/ } then
-      raise ArgumentError, "Option #{@name} is inconsistent about the argument being optional"
+      raise ArgumentError, _("Option %{name} is inconsistent about the argument being optional") % { name: @name }
     end
   end
 
@@ -82,7 +85,7 @@ class Puppet::Interface::Option
   # @api private
   def optparse_to_optionname(declaration)
     unless found = declaration.match(/^-+(?:\[no-\])?([^ =]+)/) then
-      raise ArgumentError, "Can't find a name in the declaration #{declaration.inspect}"
+      raise ArgumentError, _("Can't find a name in the declaration %{declaration}") % { declaration: declaration.inspect }
     end
     found.captures.first
   end
@@ -90,7 +93,9 @@ class Puppet::Interface::Option
   # @api private
   def optparse_to_name(declaration)
     name = optparse_to_optionname(declaration).tr('-', '_')
-    raise "#{name.inspect} is an invalid option name" unless name.to_s =~ /^[a-z]\w*$/
+    unless name.to_s =~ /^[a-z]\w*$/
+      raise _("%{name} is an invalid option name") % { name: name.inspect }
+    end
     name.to_sym
   end
 
@@ -110,8 +115,14 @@ class Puppet::Interface::Option
   end
 
   def default=(proc)
-    required and raise ArgumentError, "#{self} can't be optional and have a default value"
-    proc.is_a? Proc or raise ArgumentError, "default value for #{self} is a #{proc.class.name.inspect}, not a proc"
+    if required
+      raise ArgumentError, _("%{name} can't be optional and have a default value") % { name: self }
+    end
+    unless proc.is_a? Proc
+      #TRANSLATORS 'proc' is a Ruby block of code
+      raise ArgumentError, _("default value for %{name} is a %{class_name}, not a proc") %
+          { name: self, class_name: proc.class.name.inspect }
+    end
     @default = proc
   end
 
@@ -122,20 +133,30 @@ class Puppet::Interface::Option
   attr_reader   :parent, :name, :aliases, :optparse
   attr_accessor :required
   def required=(value)
-    has_default? and raise ArgumentError, "#{self} can't be optional and have a default value"
+    if has_default?
+      raise ArgumentError, _("%{name} can't be optional and have a default value") % { name: self }
+    end
     @required = value
   end
 
   attr_accessor :before_action
   def before_action=(proc)
-    proc.is_a? Proc or raise ArgumentError, "before action hook for #{self} is a #{proc.class.name.inspect}, not a proc"
+    unless proc.is_a? Proc
+      #TRANSLATORS 'proc' is a Ruby block of code
+      raise ArgumentError, _("before action hook for %{name} is a %{class_name}, not a proc") %
+          { name: self, class_name: proc.class.name.inspect }
+    end
     @before_action =
       @parent.__send__(:__add_method, __decoration_name(:before), proc)
   end
 
   attr_accessor :after_action
   def after_action=(proc)
-    proc.is_a? Proc or raise ArgumentError, "after action hook for #{self} is a #{proc.class.name.inspect}, not a proc"
+    unless proc.is_a? Proc
+      #TRANSLATORS 'proc' is a Ruby block of code
+      raise ArgumentError, _("after action hook for %{name} is a %{class_name}, not a proc") %
+          { name: self, class_name: proc.class.name.inspect }
+    end
     @after_action =
       @parent.__send__(:__add_method, __decoration_name(:after), proc)
   end

data/lib/puppet/interface/option_builder.rb

@@ -40,12 +40,17 @@ class Puppet::Interface::OptionBuilder
   # @api public
   # @dsl Faces
   def before_action(&block)
-    block or raise ArgumentError, "#{@option} before_action requires a block"
+    unless block
+      #TRANSLATORS 'before_action' is a method name and should not be translated
+      raise ArgumentError, _("%{option} before_action requires a block") % { option: @option }
+    end
     if @option.before_action
-      raise ArgumentError, "#{@option} already has a before_action set"
+      #TRANSLATORS 'before_action' is a method name and should not be translated
+      raise ArgumentError, _("%{option} already has a before_action set") % { option: @option }
     end
     unless block.arity == 3 then
-      raise ArgumentError, "before_action takes three arguments, action, args, and options"
+      #TRANSLATORS 'before_action' is a method name and should not be translated
+      raise ArgumentError, _("before_action takes three arguments, action, args, and options")
     end
     @option.before_action = block
   end
@@ -55,12 +60,17 @@ class Puppet::Interface::OptionBuilder
   # @api public
   # @dsl Faces
   def after_action(&block)
-    block or raise ArgumentError, "#{@option} after_action requires a block"
+    unless block
+      #TRANSLATORS 'after_action' is a method name and should not be translated
+      raise ArgumentError, _("%{option} after_action requires a block") % { option: @option }
+    end
     if @option.after_action
-      raise ArgumentError, "#{@option} already has an after_action set"
+      #TRANSLATORS 'after_action' is a method name and should not be translated
+      raise ArgumentError, _("%{option} already has an after_action set") % { option: @option }
     end
     unless block.arity == 3 then
-      raise ArgumentError, "after_action takes three arguments, action, args, and options"
+      #TRANSLATORS 'after_action' is a method name and should not be translated
+      raise ArgumentError, _("after_action takes three arguments, action, args, and options")
     end
     @option.after_action = block
   end
@@ -79,12 +89,16 @@ class Puppet::Interface::OptionBuilder
   # @api public
   # @dsl Faces
   def default_to(&block)
-    block or raise ArgumentError, "#{@option} default_to requires a block"
+    unless block
+      #TRANSLATORS 'default_to' is a method name and should not be translated
+      raise ArgumentError, _("%{option} default_to requires a block") % { option: @option }
+    end
     if @option.has_default?
-      raise ArgumentError, "#{@option} already has a default value"
+      raise ArgumentError, _("%{option} already has a default value") % { option: @option }
     end
     unless block.arity == 0
-      raise ArgumentError, "#{@option} default_to block should not take any arguments"
+      #TRANSLATORS 'default_to' is a method name and should not be translated
+      raise ArgumentError, _("%{option} default_to block should not take any arguments") % { option: @option }
     end
     @option.default = block
   end

data/lib/puppet/interface/option_manager.rb

@@ -9,7 +9,10 @@ module Puppet::Interface::OptionManager
   def display_global_options(*args)
     @display_global_options ||= []
     [args].flatten.each do |refopt|
-      raise ArgumentError, "Global option #{refopt} does not exist in Puppet.settings" unless Puppet.settings.include? refopt
+      unless Puppet.settings.include?(refopt)
+        #TRANSLATORS 'Puppet.settings' references to the Puppet settings options and should not be translated
+        raise ArgumentError, _("Global option %{option} does not exist in Puppet.settings") % { option: refopt }
+      end
       @display_global_options << refopt if refopt
     end
     @display_global_options.uniq!
@@ -51,13 +54,15 @@ module Puppet::Interface::OptionManager
 
     option.aliases.each do |name|
       if conflict = get_option(name) then
-        raise ArgumentError, "Option #{option} conflicts with existing option #{conflict}"
+        raise ArgumentError, _("Option %{option} conflicts with existing option %{conflict}") %
+            { option: option, conflict: conflict }
       end
 
       actions.each do |action|
         action = get_action(action)
         if conflict = action.get_option(name) then
-          raise ArgumentError, "Option #{option} conflicts with existing option #{conflict} on #{action}"
+          raise ArgumentError, _("Option %{option} conflicts with existing option %{conflict} on %{action}") %
+              { option: option, conflict: conflict, action: action }
         end
       end
     end

data/lib/puppet/metatype/manager.rb

@@ -72,7 +72,9 @@ module Manager
   def newtype(name, options = {}, &block)
     # Handle backward compatibility
     unless options.is_a?(Hash)
-      Puppet.warning "Puppet::Type.newtype(#{name}) now expects a hash as the second argument, not #{options.inspect}"
+      #TRANSLATORS 'Puppet::Type.newtype' should not be translated
+      Puppet.warning(_("Puppet::Type.newtype(%{name}) now expects a hash as the second argument, not %{argument}") %
+                         { name: name, argument: options.inspect})
     end
 
     # First make sure we don't have a method sitting around
@@ -107,7 +109,8 @@ module Manager
     # Now define a "new<type>" method for convenience.
     if self.respond_to? newmethod
       # Refuse to overwrite existing methods like 'newparam' or 'newtype'.
-      Puppet.warning "'new#{name.to_s}' method already exists; skipping"
+      #TRANSLATORS 'new%{method}' will become a method name, do not translate this string
+      Puppet.warning(_("'new%{method}' method already exists; skipping") % { method: name.to_s })
     else
       selfobj.send(:define_method, newmethod) do |*args|
         klass.new(*args)
@@ -169,7 +172,8 @@ module Manager
     end
     # Try loading the type.
     if typeloader.load(name, Puppet.lookup(:current_environment))
-      Puppet.warning "Loaded puppet/type/#{name} but no class was created" unless @types.include? name
+      #TRANSLATORS 'puppet/type/%{name}' should not be translated
+      Puppet.warning(_("Loaded puppet/type/%{name} but no class was created") % { name: name }) unless @types.include? name
     elsif !Puppet[:always_retry_plugins]
       # PUP-5482 - Only look for a type once if plugin retry is disabled
       @types[name] = nil

data/lib/puppet/module.rb

@@ -23,6 +23,7 @@ class Puppet::Module
     "templates" => "templates",
     "plugins" => "lib",
     "pluginfacts" => "facts.d",
+    "locales" => "locales",
   }
 
   # Find and return the +module+ that +path+ belongs to. If +path+ is
@@ -96,9 +97,6 @@ class Puppet::Module
     load_metadata
 
     @absolute_path_to_manifests = Puppet::FileSystem::PathPattern.absolute(manifests)
-
-    # i18n initialization for modules
-    initialize_i18n unless Puppet[:disable_i18n]
   end
 
   # @deprecated The puppetversion module metadata field is no longer used.
@@ -208,7 +206,8 @@ class Puppet::Module
   rescue Errno::ENOENT
     {}
   rescue JSON::JSONError => e
-    msg = "#{name} has an invalid and unparsable metadata.json file. The parse error: #{e.message}"
+    #TRANSLATORS 'metadata.json' is a specific file name and should not be translated.
+    msg = _("%{name} has an invalid and unparsable metadata.json file. The parse error: %{error}") % { name: name, error: e.message }
     case Puppet[:strict]
     when :off
       Puppet.debug(msg)
@@ -302,6 +301,21 @@ class Puppet::Module
     subpath("facts.d")
   end
 
+  #@return [String]
+  def locale_directory
+    subpath("locales")
+  end
+
+  # Returns true if the module has translation files for the
+  # given locale.
+  # @param [String] locale the two-letter language code to check
+  #        for translations
+  # @return true if the module has a directory for the locale, false
+  #         false otherwise
+  def has_translations?(locale)
+    return Puppet::FileSystem.exist?(File.join(locale_directory, locale))
+  end
+
   def has_external_facts?
     File.directory?(plugin_fact_directory)
   end
@@ -422,23 +436,6 @@ class Puppet::Module
     @strict_semver
   end
 
-  def initialize_i18n
-    # this name takes the form "namespace-module", and should match the name of
-    # the PO file containing the translations.
-    module_name = @forge_name ? @forge_name.gsub("/", "-") : name
-    return if Puppet::GettextConfig.translations_loaded?(module_name)
-
-    locales_path = File.absolute_path('locales', path)
-
-    if Puppet::GettextConfig.load_translations(module_name, locales_path, :po)
-      Puppet.debug "i18n initialized for #{module_name}"
-    elsif Puppet::GettextConfig.gettext_loaded?
-      Puppet.debug "Could not find translation files for #{module_name} at #{locales_path}. Skipping i18n initialization."
-    else
-      Puppet.debug "No gettext library found, skipping i18n initialization."
-    end
-  end
-
   private
 
   def wanted_manifests_from(pattern)