puppet-retrospec 1.5.0 → 1.6.0

data/vendor/pup410/lib/puppet/pops/functions/dispatch.rb

@@ -0,0 +1,105 @@
+module Puppet::Pops
+  module Functions
+# Defines a connection between a implementation method and the signature that
+# the method will handle.
+#
+# This interface should not be used directly. Instead dispatches should be
+# constructed using the DSL defined in {Puppet::Functions}.
+#
+# @api private
+class Dispatch < Evaluator::CallableSignature
+  # @api public
+  attr_reader :type
+  # TODO: refactor to parameter_names since that makes it API
+  attr_reader :param_names
+  attr_reader :injections
+
+  # Describes how arguments are woven if there are injections, a regular argument is a given arg index, an array
+  # an injection description.
+  #
+  attr_reader :weaving
+  # @api public
+  attr_reader :block_name
+
+  # @param type [Puppet::Pops::Types::PArrayType, Puppet::Pops::Types::PTupleType] - type describing signature
+  # @param method_name [String] the name of the method that will be called when type matches given arguments
+  # @param param_names [Array<String>] names matching the number of parameters specified by type (or empty array)
+  # @param block_name [String,nil] name of block parameter, no nil
+  # @param injections [Array<Array>] injection data for weaved parameters
+  # @param weaving [Array<Integer,Array>] weaving knits
+  # @param last_captures [Boolean] true if last parameter is captures rest
+  # @param argument_mismatch_handler [Boolean] true if this is a dispatch for an argument mismatch
+  # @api private
+  def initialize(type, method_name, param_names, last_captures = false, block_name = nil, injections = EMPTY_ARRAY, weaving = EMPTY_ARRAY, argument_mismatch_handler = false)
+    @type = type
+    @method_name = method_name
+    @param_names = param_names
+    @last_captures = last_captures
+    @block_name = block_name
+    @injections = injections
+    @weaving = weaving
+    @argument_mismatch_handler = argument_mismatch_handler
+  end
+
+  # @api private
+  def parameter_names
+    @param_names
+  end
+
+  # @api private
+  def last_captures_rest?
+    @last_captures
+  end
+
+  def argument_mismatch_handler?
+    @argument_mismatch_handler
+  end
+
+  # @api private
+  def invoke(instance, calling_scope, args, &block)
+    result = instance.send(@method_name, *weave(calling_scope, args), &block)
+    return_type = @type.return_type
+    Types::TypeAsserter.assert_instance_of(nil, return_type, result) { "value returned from function '#{@method_name}'" } unless return_type.nil?
+    result
+  end
+
+  # @api private
+  def weave(scope, args)
+    # no need to weave if there are no injections
+    if @injections.empty?
+      args
+    else
+      injector = nil # lazy lookup of injector Puppet.lookup(:injector)
+      new_args = []
+      @weaving.each do |knit|
+        if knit.is_a?(Array)
+          injection_data = @injections[knit[0]]
+          new_args <<
+            case injection_data[3]
+            when :dispatcher_internal
+              # currently only supports :scope injection
+              scope
+            when :producer
+              injector ||= Puppet.lookup(:injector)
+              injector.lookup_producer(scope, injection_data[0], injection_data[2])
+            else
+              injector ||= Puppet.lookup(:injector)
+              injector.lookup(scope, injection_data[0], injection_data[2])
+            end
+        else
+          # Careful so no new nil arguments are added since they would override default
+          # parameter values in the received
+          if knit < 0
+            idx = -knit - 1
+            new_args += args[idx..-1] if idx < args.size
+          else
+            new_args << args[knit] if knit < args.size
+          end
+        end
+      end
+      new_args
+    end
+  end
+end
+end
+end

data/vendor/pup410/lib/puppet/pops/functions/dispatcher.rb

@@ -0,0 +1,71 @@
+# Evaluate the dispatches defined as {Puppet::Pops::Functions::Dispatch}
+# instances to call the appropriate method on the
+# {Puppet::Pops::Functions::Function} instance.
+#
+# @api private
+class Puppet::Pops::Functions::Dispatcher
+  attr_reader :dispatchers
+
+  # @api private
+  def initialize()
+    @dispatchers = [ ]
+  end
+
+  # Answers if dispatching has been defined
+  # @return [Boolean] true if dispatching has been defined
+  #
+  # @api private
+  def empty?
+    @dispatchers.empty?
+  end
+
+  # Dispatches the call to the first found signature (entry with matching type).
+  #
+  # @param instance [Puppet::Functions::Function] - the function to call
+  # @param calling_scope [T.B.D::Scope] - the scope of the caller
+  # @param args [Array<Object>] - the given arguments in the form of an Array
+  # @return [Object] - what the called function produced
+  #
+  # @api private
+  def dispatch(instance, calling_scope, args, &block)
+    found = @dispatchers.find { |d| d.type.callable_with?(args, block) }
+    unless found
+      args_type = Puppet::Pops::Types::TypeCalculator.singleton.infer_set(block_given? ? args + [block] : args)
+      raise ArgumentError, Puppet::Pops::Types::TypeMismatchDescriber.describe_signatures(instance.class.name, signatures, args_type)
+    end
+
+    if found.argument_mismatch_handler?
+      msg = found.invoke(instance, calling_scope, args)
+      raise ArgumentError, "'#{instance.class.name}' #{msg}"
+    end
+
+    catch(:next) do
+      found.invoke(instance, calling_scope, args, &block)
+    end
+  end
+
+  # Adds a dispatch directly to the set of dispatchers.
+  # @api private
+  def add(a_dispatch)
+    @dispatchers << a_dispatch
+  end
+
+  # Produces a CallableType for a single signature, and a Variant[<callables>] otherwise
+  #
+  # @api private
+  def to_type()
+    # make a copy to make sure it can be contained by someone else (even if it is not contained here, it
+    # should be treated as immutable).
+    #
+    callables = dispatchers.map { | dispatch | dispatch.type }
+
+    # multiple signatures, produce a Variant type of Callable1-n (must copy them)
+    # single signature, produce single Callable
+    callables.size > 1 ?  Puppet::Pops::Types::TypeFactory.variant(*callables) : callables.pop
+  end
+
+  # @api private
+  def signatures
+    @dispatchers.reject { |dispatcher| dispatcher.argument_mismatch_handler? }
+  end
+end

data/vendor/pup410/lib/puppet/pops/functions/function.rb

@@ -0,0 +1,135 @@
+# @note WARNING: This new function API is still under development and may change at
+#   any time
+#
+# A function in the puppet evaluator.
+#
+# Functions are normally defined by another system, which produces subclasses
+# of this class as well as constructing delegations to call the appropriate methods.
+#
+# This class should rarely be used directly. Instead functions should be
+# constructed using {Puppet::Functions.create_function}.
+#
+# @api public
+class Puppet::Pops::Functions::Function
+  # The scope where the function was defined
+  attr_reader :closure_scope
+
+  # The loader that loaded this function.
+  # Should be used if function wants to load other things.
+  #
+  attr_reader :loader
+
+  def initialize(closure_scope, loader)
+    @closure_scope = closure_scope
+    @loader = loader
+  end
+
+  # Invokes the function via the dispatching logic that performs type check and weaving.
+  # A specialized function may override this method to do its own dispatching and checking of
+  # the raw arguments. A specialized implementation can rearrange arguments, add or remove
+  # arguments and then delegate to the dispatching logic by calling:
+  #
+  # @example Delegating to the dispatcher
+  #     def call(scope, *args)
+  #       manipulated_args = args + ['easter_egg']
+  #       self.class.dispatcher.dispatch(self, scope, manipulated_args)
+  #     end
+  #
+  # System functions that must have access to the calling scope can use this technique. Functions
+  # in general should not need the calling scope. (The closure scope; what is visible where the function
+  # is defined) is available via the method `closure_scope`).
+  #
+  # @api public
+  def call(scope, *args, &block)
+    begin
+      result = catch(:return) do
+        return self.class.dispatcher.dispatch(self, scope, args, &block)
+      end
+      return result.value
+    rescue Puppet::Pops::Evaluator::Next => jumper
+      begin
+        throw :next, jumper.value
+      rescue Puppet::Parser::Scope::UNCAUGHT_THROW_EXCEPTION => uncaught
+        raise Puppet::ParseError.new("next() from context where this is illegal", jumper.file, jumper.line)
+      end
+    rescue Puppet::Pops::Evaluator::Return => jumper
+      begin
+        throw :return, jumper
+      rescue Puppet::Parser::Scope::UNCAUGHT_THROW_EXCEPTION => uncaught
+        raise Puppet::ParseError.new("return() from context where this is illegal", jumper.file, jumper.line)
+      end
+    end
+  end
+
+  # Allows the implementation of a function to call other functions by name. The callable functions
+  # are those visible to the same loader that loaded this function (the calling function). The
+  # referenced function is called with the calling functions closure scope as the caller's scope.
+  #
+  # @param function_name [String] The name of the function
+  # @param *args [Object] splat of arguments
+  # @return [Object] The result returned by the called function
+  #
+  # @api public
+  def call_function(function_name, *args, &block)
+    internal_call_function(closure_scope, function_name, args, &block)
+  end
+
+  def closure_scope
+    # If closure scope is explicitly set to not nil, if there is a global scope, otherwise an empty hash
+    @closure_scope || Puppet.lookup(:global_scope) { {} }
+  end
+
+  # The dispatcher for the function
+  #
+  # @api private
+  def self.dispatcher
+    @dispatcher ||= Puppet::Pops::Functions::Dispatcher.new
+  end
+
+  # Produces information about parameters in a way that is compatible with Closure
+  #
+  # @api private
+  def self.signatures
+    @dispatcher.signatures
+  end
+
+  protected
+
+  # Allows the implementation of a function to call other functions by name and pass the caller
+  # scope. The callable functions are those visible to the same loader that loaded this function
+  # (the calling function).
+  #
+  # @param scope [Puppet::Parser::Scope] The caller scope
+  # @param function_name [String] The name of the function
+  # @param args [Array] array of arguments
+  # @return [Object] The result returned by the called function
+  #
+  # @api public
+  def internal_call_function(scope, function_name, args, &block)
+
+    the_loader = loader
+    raise ArgumentError, "Function #{self.class.name}(): cannot call function '#{function_name}' - no loader specified" unless the_loader
+
+    func = the_loader.load(:function, function_name)
+    if func
+      Puppet::Util::Profiler.profile(function_name, [:functions, function_name]) do
+        return func.call(scope, *args, &block)
+      end
+    end
+
+    # Check if a 3x function is present. Raise a generic error if it's not to allow upper layers to fill in the details
+    # about where in a puppet manifest this error originates. (Such information is not available here).
+    loader_scope = closure_scope
+    func_3x = Puppet::Parser::Functions.function(function_name, loader_scope.environment) if loader_scope.is_a?(Puppet::Parser::Scope)
+    raise ArgumentError, "Function #{self.class.name}(): Unknown function: '#{function_name}'" unless func_3x
+
+    # Call via 3x API
+    # Arguments must be mapped since functions are unaware of the new and magical creatures in 4x.
+    # NOTE: Passing an empty string last converts nil/:undef to empty string
+    result = scope.send(func_3x, Puppet::Pops::Evaluator::Runtime3FunctionArgumentConverter.map_args(args, loader_scope, ''), &block)
+
+    # Prevent non r-value functions from leaking their result (they are not written to care about this)
+    Puppet::Parser::Functions.rvalue?(function_name) ? result : nil
+  end
+
+end

data/vendor/pup410/lib/puppet/pops/issue_reporter.rb

@@ -0,0 +1,115 @@
+module Puppet::Pops
+class IssueReporter
+
+  # @param acceptor [Validation::Acceptor] the acceptor containing reported issues
+  # @option options [String] :message (nil) A message text to use as prefix in
+  #   a single Error message
+  # @option options [Boolean] :emit_warnings (false) whether warnings should be emitted
+  # @option options [Boolean] :emit_errors (true) whether errors should be
+  #   emitted or only the given message
+  # @option options [Exception] :exception_class (Puppet::ParseError) The exception to raise
+  #
+  def self.assert_and_report(acceptor, options)
+    return unless acceptor
+
+    max_errors       = options[:max_errors]   || Puppet[:max_errors]
+    max_warnings     = options[:max_warnings] || Puppet[:max_warnings]
+    max_deprecations = options[:max_deprecations] || (Puppet[:disable_warnings].include?('deprecations') ? 0 : Puppet[:max_deprecations])
+
+    emit_warnings    = options[:emit_warnings] || false
+    emit_errors      = options[:emit_errors].nil? ? true : !!options[:emit_errors]
+    emit_message     = options[:message]
+    emit_exception   = options[:exception_class] || Puppet::ParseErrorWithIssue
+
+    # If there are warnings output them
+    warnings = acceptor.warnings
+    if emit_warnings && warnings.size > 0
+      formatter = Validation::DiagnosticFormatterPuppetStyle.new
+      emitted_w = 0
+      emitted_dw = 0
+      acceptor.warnings.each do |w|
+        if w.severity == :deprecation
+          # Do *not* call Puppet.deprecation_warning it is for internal deprecation, not
+          # deprecation of constructs in manifests! (It is not designed for that purpose even if
+          # used throughout the code base).
+          #
+          log_message(:warning, formatter, w) if emitted_dw < max_deprecations
+          emitted_dw += 1
+        else
+          log_message(:warning, formatter, w) if emitted_w < max_warnings
+          emitted_w += 1
+        end
+        break if emitted_w >= max_warnings && emitted_dw >= max_deprecations # but only then
+      end
+    end
+
+    # If there were errors, report the first found. Use a puppet style formatter.
+    errors = acceptor.errors
+    if errors.size > 0
+      unless emit_errors
+        raise emit_exception.new(emit_message)
+      end
+      formatter = Validation::DiagnosticFormatterPuppetStyle.new
+      if errors.size == 1 || max_errors <= 1
+        # raise immediately
+        exception = create_exception(emit_exception, emit_message, formatter, errors[0])
+        # if an exception was given as cause, use it's backtrace instead of the one indicating "here"
+        if errors[0].exception
+          exception.set_backtrace(errors[0].exception.backtrace)
+        end
+        raise exception
+      end
+      emitted = 0
+      if emit_message
+        Puppet.err(emit_message)
+      end
+      errors.each do |e|
+        log_message(:err, formatter, e)
+        emitted += 1
+        break if emitted >= max_errors
+      end
+      warnings_message = (emit_warnings && warnings.size > 0) ? ", and #{warnings.size} warnings" : ""
+      giving_up_message = "Language validation logged #{errors.size} errors#{warnings_message}. Giving up"
+      exception = emit_exception.new(giving_up_message)
+      exception.file = errors[0].file
+      raise exception
+    end
+  end
+
+  def self.format_with_prefix(prefix, message)
+    return message unless prefix
+    [prefix, message].join(' ')
+  end
+
+  def self.create_exception(exception_class, emit_message, formatter, diagnostic)
+    file = diagnostic.file
+    file = (file.is_a?(String) && file.empty?) ? nil : file
+    line = pos = nil
+    if diagnostic.source_pos
+      line = diagnostic.source_pos.line
+      pos = diagnostic.source_pos.pos
+    end
+    exception_class.new(format_with_prefix(emit_message, formatter.format_message(diagnostic)), file, line, pos, nil, diagnostic.issue.issue_code)
+  end
+  private_class_method :create_exception
+
+  def self.log_message(severity, formatter, diagnostic)
+    file = diagnostic.file
+    file = (file.is_a?(String) && file.empty?) ? nil : file
+    line = pos = nil
+    if diagnostic.source_pos
+      line = diagnostic.source_pos.line
+      pos = diagnostic.source_pos.pos
+    end
+    Puppet::Util::Log.create({
+        :level => severity,
+        :message => formatter.format_message(diagnostic),
+        :issue_code => diagnostic.issue.issue_code,
+        :file => file,
+        :line => line,
+        :pos => pos,
+      })
+  end
+  private_class_method :log_message
+end
+end

data/vendor/pup410/lib/puppet/pops/issues.rb

@@ -0,0 +1,834 @@
+# Defines classes to deal with issues, and message formatting and defines constants with Issues.
+# @api public
+#
+module Puppet::Pops
+module Issues
+  # Describes an issue, and can produce a message for an occurrence of the issue.
+  #
+  class Issue
+    # The issue code
+    # @return [Symbol]
+    attr_reader :issue_code
+
+    # A block producing the message
+    # @return [Proc]
+    attr_reader :message_block
+
+    # Names that must be bound in an occurrence of the issue to be able to produce a message.
+    # These are the names in addition to requirements stipulated by the Issue formatter contract; i.e. :label`,
+    # and `:semantic`.
+    #
+    attr_reader :arg_names
+
+    # If this issue can have its severity lowered to :warning, :deprecation, or :ignored
+    attr_writer :demotable
+    # Configures the Issue with required arguments (bound by occurrence), and a block producing a message.
+    def initialize issue_code, *args, &block
+      @issue_code = issue_code
+      @message_block = block
+      @arg_names = args
+      @demotable = true
+    end
+
+    # Returns true if it is allowed to demote this issue
+    def demotable?
+      @demotable
+    end
+
+    # Formats a message for an occurrence of the issue with argument bindings passed in a hash.
+    # The hash must contain a LabelProvider bound to the key `label` and the semantic model element
+    # bound to the key `semantic`. All required arguments as specified by `arg_names` must be bound
+    # in the given `hash`.
+    # @api public
+    #
+    def format(hash ={})
+      # Create a Message Data where all hash keys become methods for convenient interpolation
+      # in issue text.
+      msgdata = MessageData.new(*arg_names)
+      begin
+        # Evaluate the message block in the msg data's binding
+        msgdata.format(hash, &message_block)
+      rescue StandardError => e
+        MessageData
+        raise RuntimeError, "Error while reporting issue: #{issue_code}. #{e.message}", caller
+      end
+    end
+  end
+
+  # Provides a binding of arguments passed to Issue.format to method names available
+  # in the issue's message producing block.
+  # @api private
+  #
+  class MessageData
+    def initialize *argnames
+      singleton = class << self; self end
+      argnames.each do |name|
+        singleton.send(:define_method, name) do
+          @data[name]
+        end
+      end
+    end
+
+    def format(hash, &block)
+      @data = hash
+      instance_eval &block
+    end
+
+    # Obtains the label provider given as a key `:label` in the hash passed to #format. The label provider is
+    # return if no arguments are given. If given an argument, returns the result of calling #label on the label
+    # provider.
+    #
+    # @param args [Object] one object to obtain a label for or zero arguments to obtain the label provider
+    # @return [LabelProvider,String] the label provider or label depending on if an argument is given or not
+    # @raise [Puppet::Error] if no label provider is found
+    def label(*args)
+      args.empty? ? label_provider : label_provider.label(args[0])
+    end
+
+    # Returns the label provider given as key `:label` in the hash passed to #format.
+    # @return [LabelProvider] the label provider
+    # @raise [Puppet::Error] if no label provider is found
+    def label_provider
+      label_provider = @data[:label]
+      raise Puppet::Error, 'Label provider key :label must be set to produce the text of the message!' unless label_provider
+      label_provider
+    end
+
+    # Returns the label provider given as a key in the hash passed to #format.
+    #
+    def semantic
+      raise Puppet::Error, 'Label provider key :semantic must be set to produce the text of the message!' unless @data[:semantic]
+      @data[:semantic]
+    end
+  end
+
+  # Defines an issue with the given `issue_code`, additional required parameters, and a block producing a message.
+  # The block is evaluated in the context of a MessageData which provides convenient access to all required arguments
+  # via accessor methods. In addition to accessors for specified arguments, these are also available:
+  # * `label` - a `LabelProvider` that provides human understandable names for model elements and production of article (a/an/the).
+  # * `semantic` - the model element for which the issue is reported
+  #
+  # @param issue_code [Symbol] the issue code for the issue used as an identifier, should be the same as the constant
+  #   the issue is bound to.
+  # @param args [Symbol] required arguments that must be passed when formatting the message, may be empty
+  # @param block [Proc] a block producing the message string, evaluated in a MessageData scope. The produced string
+  #   should not end with a period as additional information may be appended.
+  #
+  # @see MessageData
+  # @api public
+  #
+  def self.issue (issue_code, *args, &block)
+    Issue.new(issue_code, *args, &block)
+  end
+
+  # Creates a non demotable issue.
+  # @see Issue.issue
+  #
+  def self.hard_issue(issue_code, *args, &block)
+    result = Issue.new(issue_code, *args, &block)
+    result.demotable = false
+    result
+  end
+
+  # @comment Here follows definitions of issues. The intent is to provide a list from which yardoc can be generated
+  #   containing more detailed information / explanation of the issue.
+  #   These issues are set as constants, but it is unfortunately not possible for the created object to easily know which
+  #   name it is bound to. Instead the constant has to be repeated. (Alternatively, it could be done by instead calling
+  #   #const_set on the module, but the extra work required to get yardoc output vs. the extra effort to repeat the name
+  #   twice makes it not worth it (if doable at all, since there is no tag to artificially construct a constant, and
+  #   the parse tag does not produce any result for a constant assignment).
+
+  # This is allowed (3.1) and has not yet been deprecated.
+  # @todo configuration
+  #
+  NAME_WITH_HYPHEN = issue :NAME_WITH_HYPHEN, :name do
+    "#{label.a_an_uc(semantic)} may not have a name containing a hyphen. The name '#{name}' is not legal"
+  end
+
+  # When a variable name contains a hyphen and these are illegal.
+  # It is possible to control if a hyphen is legal in a name or not using the setting TODO
+  # @todo describe the setting
+  # @api public
+  # @todo configuration if this is error or warning
+  #
+  VAR_WITH_HYPHEN = issue :VAR_WITH_HYPHEN, :name do
+    "A variable name may not contain a hyphen. The name '#{name}' is not legal"
+  end
+
+  # A class, definition, or node may only appear at top level or inside other classes
+  # @todo Is this really true for nodes? Can they be inside classes? Isn't that too late?
+  # @api public
+  #
+  NOT_TOP_LEVEL = hard_issue :NOT_TOP_LEVEL do
+    "Classes, definitions, and nodes may only appear at toplevel or inside other classes"
+  end
+
+  NOT_ABSOLUTE_TOP_LEVEL = hard_issue :NOT_ABSOLUTE_TOP_LEVEL do
+    "#{label.a_an_uc(semantic)} may only appear at toplevel"
+  end
+
+  CROSS_SCOPE_ASSIGNMENT = hard_issue :CROSS_SCOPE_ASSIGNMENT, :name do
+    "Illegal attempt to assign to '#{name}'. Cannot assign to variables in other namespaces"
+  end
+
+  # Assignment can only be made to certain types of left hand expressions such as variables.
+  ILLEGAL_ASSIGNMENT = hard_issue :ILLEGAL_ASSIGNMENT do
+    "Illegal attempt to assign to '#{label.a_an(semantic)}'. Not an assignable reference"
+  end
+
+  # Variables are immutable, cannot reassign in the same assignment scope
+  ILLEGAL_REASSIGNMENT = hard_issue :ILLEGAL_REASSIGNMENT, :name do
+    if Validation::Checker4_0::RESERVED_PARAMETERS[name]
+      "Cannot reassign built in (or already assigned) variable '$#{name}'"
+    else
+      "Cannot reassign variable '$#{name}'"
+    end
+  end
+
+  # Variables facts and trusted
+  ILLEGAL_RESERVED_ASSIGNMENT = hard_issue :ILLEGAL_RESERVED_ASSIGNMENT, :name do
+    "Attempt to assign to a reserved variable name: '$#{name}'"
+  end
+
+  # Assignment cannot be made to numeric match result variables
+  ILLEGAL_NUMERIC_ASSIGNMENT = issue :ILLEGAL_NUMERIC_ASSIGNMENT, :varname do
+    "Illegal attempt to assign to the numeric match result variable '$#{varname}'. Numeric variables are not assignable"
+  end
+
+  # Assignment can only be made to certain types of left hand expressions such as variables.
+  ILLEGAL_ASSIGNMENT_CONTEXT = hard_issue :ILLEGAL_ASSIGNMENT_CONTEXT do
+    "Assignment not allowed here"
+  end
+
+  # parameters cannot have numeric names, clashes with match result variables
+  ILLEGAL_NUMERIC_PARAMETER = issue :ILLEGAL_NUMERIC_PARAMETER, :name do
+    "The numeric parameter name '$#{name}' cannot be used (clashes with numeric match result variables)"
+  end
+
+  # In certain versions of Puppet it may be allowed to assign to a not already assigned key
+  # in an array or a hash. This is an optional validation that may be turned on to prevent accidental
+  # mutation.
+  #
+  ILLEGAL_INDEXED_ASSIGNMENT = issue :ILLEGAL_INDEXED_ASSIGNMENT do
+    "Illegal attempt to assign via [index/key]. Not an assignable reference"
+  end
+
+  # When indexed assignment ($x[]=) is allowed, the leftmost expression must be
+  # a variable expression.
+  #
+  ILLEGAL_ASSIGNMENT_VIA_INDEX = hard_issue :ILLEGAL_ASSIGNMENT_VIA_INDEX do
+    "Illegal attempt to assign to #{label.a_an(semantic)} via [index/key]. Not an assignable reference"
+  end
+
+  ILLEGAL_MULTI_ASSIGNMENT_SIZE = hard_issue :ILLEGAL_MULTI_ASSIGNMENT_SIZE, :expected, :actual do
+    "Mismatched number of assignable entries and values, expected #{expected}, got #{actual}"
+  end
+
+  MISSING_MULTI_ASSIGNMENT_KEY = hard_issue :MISSING_MULTI_ASSIGNMENT_KEY, :key do
+    "No value for required key '#{key}' in assignment to variables from hash"
+  end
+
+  MISSING_MULTI_ASSIGNMENT_VARIABLE = hard_issue :MISSING_MULTI_ASSIGNMENT_VARIABLE, :name do
+    "No value for required variable '$#{name}' in assignment to variables from class reference"
+  end
+
+  APPENDS_DELETES_NO_LONGER_SUPPORTED = hard_issue :APPENDS_DELETES_NO_LONGER_SUPPORTED, :operator do
+    "The operator '#{operator}' is no longer supported. See http://links.puppetlabs.com/remove-plus-equals"
+  end
+
+  # For unsupported operators (e.g. += and -= in puppet 4).
+  #
+  UNSUPPORTED_OPERATOR = hard_issue :UNSUPPORTED_OPERATOR, :operator do
+    "The operator '#{operator}' is not supported."
+  end
+
+  # For operators that are not supported in specific contexts (e.g. '* =>' in
+  # resource defaults)
+  #
+  UNSUPPORTED_OPERATOR_IN_CONTEXT = hard_issue :UNSUPPORTED_OPERATOR_IN_CONTEXT, :operator do
+    "The operator '#{operator}' in #{label.a_an(semantic)} is not supported."
+  end
+
+  # For non applicable operators (e.g. << on Hash).
+  #
+  OPERATOR_NOT_APPLICABLE = hard_issue :OPERATOR_NOT_APPLICABLE, :operator, :left_value do
+    "Operator '#{operator}' is not applicable to #{label.a_an(left_value)}."
+  end
+
+  OPERATOR_NOT_APPLICABLE_WHEN = hard_issue :OPERATOR_NOT_APPLICABLE_WHEN, :operator, :left_value, :right_value do
+    "Operator '#{operator}' is not applicable to #{label.a_an(left_value)} when right side is #{label.a_an(right_value)}."
+  end
+
+  COMPARISON_NOT_POSSIBLE = hard_issue :COMPARISON_NOT_POSSIBLE, :operator, :left_value, :right_value, :detail do
+    "Comparison of: #{label(left_value)} #{operator} #{label(right_value)}, is not possible. Caused by '#{detail}'."
+  end
+
+  MATCH_NOT_REGEXP = hard_issue :MATCH_NOT_REGEXP, :detail do
+    "Can not convert right match operand to a regular expression. Caused by '#{detail}'."
+  end
+
+  MATCH_NOT_STRING = hard_issue :MATCH_NOT_STRING, :left_value do
+    "Left match operand must result in a String value. Got #{label.a_an(left_value)}."
+  end
+
+  # Some expressions/statements may not produce a value (known as right-value, or rvalue).
+  # This may vary between puppet versions.
+  #
+  NOT_RVALUE = issue :NOT_RVALUE do
+    "Invalid use of expression. #{label.a_an_uc(semantic)} does not produce a value"
+  end
+
+  # Appending to attributes is only allowed in certain types of resource expressions.
+  #
+  ILLEGAL_ATTRIBUTE_APPEND = hard_issue :ILLEGAL_ATTRIBUTE_APPEND, :name, :parent do
+    "Illegal +> operation on attribute #{name}. This operator can not be used in #{label.a_an(parent)}"
+  end
+
+  ILLEGAL_NAME = hard_issue :ILLEGAL_NAME, :name do
+    "Illegal name. The given name '#{name}' does not conform to the naming rule /^((::)?[a-z_]\w*)(::[a-z]\\w*)*$/"
+  end
+
+  ILLEGAL_SINGLE_TYPE_MAPPING = hard_issue :ILLEGAL_TYPE_MAPPING, :expression do
+    "Illegal type mapping. Expected a Type on the left side, got #{label.a_an_uc(semantic)}"
+  end
+
+  ILLEGAL_REGEXP_TYPE_MAPPING = hard_issue :ILLEGAL_TYPE_MAPPING, :expression do
+    "Illegal type mapping. Expected a Tuple[Regexp,String] on the left side, got #{label.a_an_uc(semantic)}"
+  end
+
+  ILLEGAL_PARAM_NAME = hard_issue :ILLEGAL_PARAM_NAME, :name do
+    "Illegal parameter name. The given name '#{name}' does not conform to the naming rule /^[a-z_]\\w*$/"
+  end
+
+  ILLEGAL_VAR_NAME = hard_issue :ILLEGAL_VAR_NAME, :name do
+    "Illegal variable name, The given name '#{name}' does not conform to the naming rule /^((::)?[a-z]\\w*)*((::)?[a-z_]\\w*)$/"
+  end
+
+  ILLEGAL_NUMERIC_VAR_NAME = hard_issue :ILLEGAL_NUMERIC_VAR_NAME, :name do
+    "Illegal numeric variable name, The given name '#{name}' must be a decimal value if it starts with a digit 0-9"
+  end
+
+  # In case a model is constructed programmatically, it must create valid type references.
+  #
+  ILLEGAL_CLASSREF = hard_issue :ILLEGAL_CLASSREF, :name do
+    "Illegal type reference. The given name '#{name}' does not conform to the naming rule"
+  end
+
+  # This is a runtime issue - storeconfigs must be on in order to collect exported. This issue should be
+  # set to :ignore when just checking syntax.
+  # @todo should be a :warning by default
+  #
+  RT_NO_STORECONFIGS = issue :RT_NO_STORECONFIGS do
+    "You cannot collect exported resources without storeconfigs being set; the collection will be ignored"
+  end
+
+  # This is a runtime issue - storeconfigs must be on in order to export a resource. This issue should be
+  # set to :ignore when just checking syntax.
+  # @todo should be a :warning by default
+  #
+  RT_NO_STORECONFIGS_EXPORT = issue :RT_NO_STORECONFIGS_EXPORT do
+    "You cannot collect exported resources without storeconfigs being set; the export is ignored"
+  end
+
+  # A hostname may only contain letters, digits, '_', '-', and '.'.
+  #
+  ILLEGAL_HOSTNAME_CHARS = hard_issue :ILLEGAL_HOSTNAME_CHARS, :hostname do
+    "The hostname '#{hostname}' contains illegal characters (only letters, digits, '_', '-', and '.' are allowed)"
+  end
+
+  # A hostname may only contain letters, digits, '_', '-', and '.'.
+  #
+  ILLEGAL_HOSTNAME_INTERPOLATION = hard_issue :ILLEGAL_HOSTNAME_INTERPOLATION do
+    "An interpolated expression is not allowed in a hostname of a node"
+  end
+
+  # Issues when an expression is used where it is not legal.
+  # E.g. an arithmetic expression where a hostname is expected.
+  #
+  ILLEGAL_EXPRESSION = hard_issue :ILLEGAL_EXPRESSION, :feature, :container do
+    "Illegal expression. #{label.a_an_uc(semantic)} is unacceptable as #{feature} in #{label.a_an(container)}"
+  end
+
+  # Issues when a variable is not a NAME
+  #
+  ILLEGAL_VARIABLE_EXPRESSION = hard_issue :ILLEGAL_VARIABLE_EXPRESSION do
+    "Illegal variable expression. #{label.a_an_uc(semantic)} did not produce a variable name (String or Numeric)."
+  end
+
+  # Issues when an expression is used illegally in a query.
+  # query only supports == and !=, and not <, > etc.
+  #
+  ILLEGAL_QUERY_EXPRESSION = hard_issue :ILLEGAL_QUERY_EXPRESSION do
+    "Illegal query expression. #{label.a_an_uc(semantic)} cannot be used in a query"
+  end
+
+  # If an attempt is made to make a resource default virtual or exported.
+  #
+  NOT_VIRTUALIZEABLE = hard_issue :NOT_VIRTUALIZEABLE do
+    "Resource Defaults are not virtualizable"
+  end
+
+  CLASS_NOT_VIRTUALIZABLE = issue :CLASS_NOT_VIRTUALIZABLE do
+    "Classes are not virtualizable"
+  end
+
+  # When an attempt is made to use multiple keys (to produce a range in Ruby - e.g. $arr[2,-1]).
+  # This is not supported in 3x, but it allowed in 4x.
+  #
+  UNSUPPORTED_RANGE = issue :UNSUPPORTED_RANGE, :count do
+    "Attempt to use unsupported range in #{label.a_an(semantic)}, #{count} values given for max 1"
+  end
+
+  # Issues when expressions that are not implemented or activated in the current version are used.
+  #
+  UNSUPPORTED_EXPRESSION = issue :UNSUPPORTED_EXPRESSION do
+    "Expressions of type #{label.a_an(semantic)} are not supported in this version of Puppet"
+  end
+
+  ILLEGAL_RELATIONSHIP_OPERAND_TYPE = issue :ILLEGAL_RELATIONSHIP_OPERAND_TYPE, :operand do
+    "Illegal relationship operand, can not form a relationship with #{label.a_an(operand)}. A Catalog type is required."
+  end
+
+  NOT_CATALOG_TYPE = issue :NOT_CATALOG_TYPE, :type do
+    "Illegal relationship operand, can not form a relationship with something of type #{type}. A Catalog type is required."
+  end
+
+  BAD_STRING_SLICE_ARITY = issue :BAD_STRING_SLICE_ARITY, :actual do
+    "String supports [] with one or two arguments. Got #{actual}"
+  end
+
+  BAD_STRING_SLICE_TYPE = issue :BAD_STRING_SLICE_TYPE, :actual do
+    "String-Type [] requires all arguments to be integers (or default). Got #{actual}"
+  end
+
+  BAD_ARRAY_SLICE_ARITY = issue :BAD_ARRAY_SLICE_ARITY, :actual do
+    "Array supports [] with one or two arguments. Got #{actual}"
+  end
+
+  BAD_HASH_SLICE_ARITY = issue :BAD_HASH_SLICE_ARITY, :actual do
+    "Hash supports [] with one or more arguments. Got #{actual}"
+  end
+
+  BAD_INTEGER_SLICE_ARITY = issue :BAD_INTEGER_SLICE_ARITY, :actual do
+    "Integer-Type supports [] with one or two arguments (from, to). Got #{actual}"
+  end
+
+  BAD_INTEGER_SLICE_TYPE = issue :BAD_INTEGER_SLICE_TYPE, :actual do
+    "Integer-Type [] requires all arguments to be integers (or default). Got #{actual}"
+  end
+
+  BAD_COLLECTION_SLICE_TYPE = issue :BAD_COLLECTION_SLICE_TYPE, :actual do
+    "A Type's size constraint arguments must be a single Integer type, or 1-2 integers (or default). Got #{label.a_an(actual)}"
+  end
+
+  BAD_FLOAT_SLICE_ARITY = issue :BAD_INTEGER_SLICE_ARITY, :actual do
+    "Float-Type supports [] with one or two arguments (from, to). Got #{actual}"
+  end
+
+  BAD_FLOAT_SLICE_TYPE = issue :BAD_INTEGER_SLICE_TYPE, :actual do
+    "Float-Type [] requires all arguments to be floats, or integers (or default). Got #{actual}"
+  end
+
+  BAD_SLICE_KEY_TYPE = issue :BAD_SLICE_KEY_TYPE, :left_value, :expected_classes, :actual do
+    expected_text = if expected_classes.size > 1
+      "one of #{expected_classes.join(', ')} are"
+    else
+      "#{expected_classes[0]} is"
+    end
+    "#{label.a_an_uc(left_value)}[] cannot use #{actual} where #{expected_text} expected"
+  end
+
+  BAD_STRING_SLICE_KEY_TYPE = issue :BAD_STRING_SLICE_KEY_TYPE, :left_value, :actual_type do
+    actual_type_text = "#{label.article(actual_type)} #{actual_type}"
+    "A substring operation does not accept #{actual_type_text} as a character index. Expected an Integer"
+  end
+
+  BAD_NOT_UNDEF_SLICE_TYPE = issue :BAD_NOT_UNDEF_SLICE_TYPE, :base_type, :actual do
+    "#{base_type}[] argument must be a Type or a String. Got #{actual}"
+  end
+
+  BAD_TYPE_SLICE_TYPE = issue :BAD_TYPE_SLICE_TYPE, :base_type, :actual do
+    "#{base_type}[] arguments must be types. Got #{actual}"
+  end
+
+  BAD_TYPE_SLICE_ARITY = issue :BAD_TYPE_SLICE_ARITY, :base_type, :min, :max, :actual do
+    base_type_label = base_type.is_a?(String) ? base_type : label.a_an_uc(base_type)
+    if max == -1 || max == Float::INFINITY
+      "#{base_type_label}[] accepts #{min} or more arguments. Got #{actual}"
+    elsif max && max != min
+      "#{base_type_label}[] accepts #{min} to #{max} arguments. Got #{actual}"
+    else
+      "#{base_type_label}[] accepts #{min} #{label.plural_s(min, 'argument')}. Got #{actual}"
+    end
+  end
+
+  BAD_TYPE_SPECIALIZATION = hard_issue :BAD_TYPE_SPECIALIZATION, :type, :message do
+    "Error creating type specialization of #{label.a_an(type)}, #{message}"
+  end
+
+  ILLEGAL_TYPE_SPECIALIZATION = issue :ILLEGAL_TYPE_SPECIALIZATION, :kind do
+    "Cannot specialize an already specialized #{kind} type"
+  end
+
+  ILLEGAL_RESOURCE_SPECIALIZATION = issue :ILLEGAL_RESOURCE_SPECIALIZATION, :actual do
+    "First argument to Resource[] must be a resource type or a String. Got #{actual}."
+  end
+
+  EMPTY_RESOURCE_SPECIALIZATION = issue :EMPTY_RESOURCE_SPECIALIZATION do
+    "Arguments to Resource[] are all empty/undefined"
+  end
+
+  ILLEGAL_HOSTCLASS_NAME = hard_issue :ILLEGAL_HOSTCLASS_NAME, :name do
+    "Illegal Class name in class reference. #{label.a_an_uc(name)} cannot be used where a String is expected"
+  end
+
+  ILLEGAL_DEFINITION_NAME = hard_issue :ILLEGAL_DEFINITION_NAME, :name do
+    "Unacceptable name. The name '#{name}' is unacceptable as the name of #{label.a_an(semantic)}"
+  end
+
+  CAPTURES_REST_NOT_LAST = hard_issue :CAPTURES_REST_NOT_LAST, :param_name do
+    "Parameter $#{param_name} is not last, and has 'captures rest'"
+  end
+
+  CAPTURES_REST_NOT_SUPPORTED = hard_issue :CAPTURES_REST_NOT_SUPPORTED, :container, :param_name do
+    "Parameter $#{param_name} has 'captures rest' - not supported in #{label.a_an(container)}"
+  end
+
+  REQUIRED_PARAMETER_AFTER_OPTIONAL = hard_issue :REQUIRED_PARAMETER_AFTER_OPTIONAL, :param_name do
+    "Parameter $#{param_name} is required but appears after optional parameters"
+  end
+
+  MISSING_REQUIRED_PARAMETER = hard_issue :MISSING_REQUIRED_PARAMETER, :param_name do
+    "Parameter $#{param_name} is required but no value was given"
+  end
+
+  NOT_NUMERIC = issue :NOT_NUMERIC, :value do
+    "The value '#{value}' cannot be converted to Numeric."
+  end
+
+  NUMERIC_COERCION = issue :NUMERIC_COERCION, :before, :after do
+    "The string '#{before}' was automatically coerced to the numerical value #{after}"
+  end
+
+  UNKNOWN_FUNCTION = issue :UNKNOWN_FUNCTION, :name do
+    "Unknown function: '#{name}'."
+  end
+
+  UNKNOWN_VARIABLE = issue :UNKNOWN_VARIABLE, :name do
+    "Unknown variable: '#{name}'."
+  end
+
+  RUNTIME_ERROR = issue :RUNTIME_ERROR, :detail do
+    "Error while evaluating #{label.a_an(semantic)}, #{detail}"
+  end
+
+  UNKNOWN_RESOURCE_TYPE = issue :UNKNOWN_RESOURCE_TYPE, :type_name do
+    "Resource type not found: #{type_name}"
+  end
+
+  ILLEGAL_RESOURCE_TYPE = hard_issue :ILLEGAL_RESOURCE_TYPE, :actual do
+    "Illegal Resource Type expression, expected result to be a type name, or untitled Resource, got #{actual}"
+  end
+
+  DUPLICATE_TITLE = issue :DUPLICATE_TITLE, :title  do
+    "The title '#{title}' has already been used in this resource expression"
+  end
+
+  DUPLICATE_ATTRIBUTE = issue :DUPLICATE_ATTRIBUE, :attribute  do
+    "The attribute '#{attribute}' has already been set"
+  end
+
+  MISSING_TITLE = hard_issue :MISSING_TITLE do
+    "Missing title. The title expression resulted in undef"
+  end
+
+  MISSING_TITLE_AT = hard_issue :MISSING_TITLE_AT, :index do
+    "Missing title at index #{index}. The title expression resulted in an undef title"
+  end
+
+  ILLEGAL_TITLE_TYPE_AT = hard_issue :ILLEGAL_TITLE_TYPE_AT, :index, :actual do
+    "Illegal title type at index #{index}. Expected String, got #{actual}"
+  end
+
+  EMPTY_STRING_TITLE_AT = hard_issue :EMPTY_STRING_TITLE_AT, :index do
+    "Empty string title at #{index}. Title strings must have a length greater than zero."
+  end
+
+  UNKNOWN_RESOURCE = issue :UNKNOWN_RESOURCE, :type_name, :title do
+    "Resource not found: #{type_name}['#{title}']"
+  end
+
+  UNKNOWN_RESOURCE_PARAMETER = issue :UNKNOWN_RESOURCE_PARAMETER, :type_name, :title, :param_name do
+    "The resource #{type_name.capitalize}['#{title}'] does not have a parameter called '#{param_name}'"
+  end
+
+  DIV_BY_ZERO = hard_issue :DIV_BY_ZERO do
+    "Division by 0"
+  end
+
+  RESULT_IS_INFINITY = hard_issue :RESULT_IS_INFINITY, :operator do
+    "The result of the #{operator} expression is Infinity"
+  end
+
+  # TODO_HEREDOC
+  EMPTY_HEREDOC_SYNTAX_SEGMENT = issue :EMPTY_HEREDOC_SYNTAX_SEGMENT, :syntax do
+    "Heredoc syntax specification has empty segment between '+' : '#{syntax}'"
+  end
+
+  ILLEGAL_EPP_PARAMETERS = issue :ILLEGAL_EPP_PARAMETERS do
+    "Ambiguous EPP parameter expression. Probably missing '<%-' before parameters to remove leading whitespace"
+  end
+
+  DISCONTINUED_IMPORT = hard_issue :DISCONTINUED_IMPORT do
+    "Use of 'import' has been discontinued in favor of a manifest directory. See http://links.puppetlabs.com/puppet-import-deprecation"
+  end
+
+  IDEM_EXPRESSION_NOT_LAST = issue :IDEM_EXPRESSION_NOT_LAST do
+    "This #{label.label(semantic)} has no effect. A value was produced and then forgotten (one or more preceding expressions may have the wrong form)"
+  end
+
+  RESOURCE_WITHOUT_TITLE = issue :RESOURCE_WITHOUT_TITLE, :name do
+    "This expression is invalid. Did you try declaring a '#{name}' resource without a title?"
+  end
+
+  IDEM_NOT_ALLOWED_LAST = hard_issue :IDEM_NOT_ALLOWED_LAST, :container do
+    "This #{label.label(semantic)} has no effect. #{label.a_an_uc(container)} can not end with a value-producing expression without other effect"
+  end
+
+  RESERVED_WORD = hard_issue :RESERVED_WORD, :word do
+    "Use of reserved word: #{word}, must be quoted if intended to be a String value"
+  end
+
+  FUTURE_RESERVED_WORD = issue :FUTURE_RESERVED_WORD, :word do
+    "Use of future reserved word: '#{word}'"
+  end
+
+  RESERVED_TYPE_NAME = hard_issue :RESERVED_TYPE_NAME, :name do
+    "The name: '#{name}' is already defined by Puppet and can not be used as the name of #{label.a_an(semantic)}."
+  end
+
+  UNMATCHED_SELECTOR = hard_issue :UNMATCHED_SELECTOR, :param_value do
+    "No matching entry for selector parameter with value '#{param_value}'"
+  end
+
+  ILLEGAL_NODE_INHERITANCE = issue :ILLEGAL_NODE_INHERITANCE do
+    "Node inheritance is not supported in Puppet >= 4.0.0. See http://links.puppetlabs.com/puppet-node-inheritance-deprecation"
+  end
+
+  ILLEGAL_OVERRIDEN_TYPE = issue :ILLEGAL_OVERRIDEN_TYPE, :actual do
+    "Resource Override can only operate on resources, got: #{label.label(actual)}"
+  end
+
+  DUPLICATE_PARAMETER = hard_issue :DUPLICATE_PARAMETER, :param_name do
+    "The parameter '#{param_name}' is declared more than once in the parameter list"
+  end
+
+  DUPLICATE_KEY = issue :DUPLICATE_KEY, :key do
+    "The key '#{key}' is declared more than once"
+  end
+
+  DUPLICATE_DEFAULT = issue :DUPLICATE_DEFAULT, :container do
+    "This #{label.label(container)} already has a 'default' entry - this is a duplicate"
+  end
+
+  RESERVED_PARAMETER = hard_issue :RESERVED_PARAMETER, :container, :param_name do
+    "The parameter $#{param_name} redefines a built in parameter in #{label.the(container)}"
+  end
+
+  TYPE_MISMATCH = hard_issue :TYPE_MISMATCH, :expected, :actual do
+    "Expected value of type #{expected}, got #{actual}"
+  end
+
+  MULTIPLE_ATTRIBUTES_UNFOLD = hard_issue :MULTIPLE_ATTRIBUTES_UNFOLD do
+    "Unfolding of attributes from Hash can only be used once per resource body"
+  end
+
+  ILLEGAL_CATALOG_RELATED_EXPRESSION = hard_issue :ILLEGAL_CATALOG_RELATED_EXPRESSION do
+    "This #{label.label(semantic)} appears in a context where catalog related expressions are not allowed"
+  end
+
+  SYNTAX_ERROR = hard_issue :SYNTAX_ERROR, :where do
+    "Syntax error at #{where}"
+  end
+
+  ILLEGAL_CLASS_REFERENCE = hard_issue :ILLEGAL_CLASS_REFERENCE do
+    'Illegal class reference'
+  end
+
+  ILLEGAL_FULLY_QUALIFIED_CLASS_REFERENCE = hard_issue :ILLEGAL_FULLY_QUALIFIED_CLASS_REFERENCE do
+    'Illegal fully qualified class reference'
+  end
+
+  ILLEGAL_FULLY_QUALIFIED_NAME = hard_issue :ILLEGAL_FULLY_QUALIFIED_NAME do
+    'Illegal fully qualified name'
+  end
+
+  ILLEGAL_NAME_OR_BARE_WORD = hard_issue :ILLEGAL_NAME_OR_BARE_WORD do
+    'Illegal name or bare word'
+  end
+
+  ILLEGAL_NUMBER = hard_issue :ILLEGAL_NUMBER, :value do
+    "Illegal number '#{value}'"
+  end
+
+  ILLEGAL_UNICODE_ESCAPE = issue :ILLEGAL_UNICODE_ESCAPE do
+    "Unicode escape '\\u' was not followed by 4 hex digits or 1-6 hex digits in {} or was > 10ffff"
+  end
+
+  INVALID_HEX_NUMBER = hard_issue :INVALID_HEX_NUMBER, :value do
+    "Not a valid hex number #{value}"
+  end
+
+  INVALID_OCTAL_NUMBER = hard_issue :INVALID_OCTAL_NUMBER, :value do
+    "Not a valid octal number #{value}"
+  end
+
+  INVALID_DECIMAL_NUMBER = hard_issue :INVALID_DECIMAL_NUMBER, :value do
+    "Not a valid decimal number #{value}"
+  end
+
+  NO_INPUT_TO_LEXER = hard_issue :NO_INPUT_TO_LEXER do
+    "Internal Error: No string or file given to lexer to process."
+  end
+
+  UNRECOGNIZED_ESCAPE = issue :UNRECOGNIZED_ESCAPE, :ch do
+    "Unrecognized escape sequence '\\#{ch}'"
+  end
+
+  UNCLOSED_QUOTE = hard_issue :UNCLOSED_QUOTE, :after, :followed_by do
+    "Unclosed quote after #{after} followed by '#{followed_by}'"
+  end
+
+  UNCLOSED_MLCOMMENT = hard_issue :UNCLOSED_MLCOMMENT do
+    'Unclosed multiline comment'
+  end
+
+  EPP_INTERNAL_ERROR = hard_issue :EPP_INTERNAL_ERROR, :error do
+    "Internal error: #{error}"
+  end
+
+  EPP_UNBALANCED_TAG = hard_issue :EPP_UNBALANCED_TAG do
+    'Unbalanced epp tag, reached <eof> without closing tag.'
+  end
+
+  EPP_UNBALANCED_COMMENT = hard_issue :EPP_UNBALANCED_COMMENT do
+    'Reaching end after opening <%# without seeing %>'
+  end
+
+  EPP_UNBALANCED_EXPRESSION = hard_issue :EPP_UNBALANCED_EXPRESSION do
+    'Unbalanced embedded expression - opening <% and reaching end of input'
+  end
+
+  HEREDOC_UNCLOSED_PARENTHESIS = hard_issue :HEREDOC_UNCLOSED_PARENTHESIS, :followed_by do
+    "Unclosed parenthesis after '@(' followed by '#{followed_by}'"
+  end
+
+  HEREDOC_WITHOUT_END_TAGGED_LINE = hard_issue :HEREDOC_WITHOUT_END_TAGGED_LINE do
+    'Heredoc without end-tagged line'
+  end
+
+  HEREDOC_INVALID_ESCAPE = hard_issue :HEREDOC_INVALID_ESCAPE, :actual do
+    "Invalid heredoc escape char. Only t, r, n, s,  u, L, $ allowed. Got '#{actual}'"
+  end
+
+  HEREDOC_INVALID_SYNTAX = hard_issue :HEREDOC_INVALID_SYNTAX do
+    'Invalid syntax in heredoc expected @(endtag[:syntax][/escapes])'
+  end
+
+  HEREDOC_WITHOUT_TEXT = hard_issue :HEREDOC_WITHOUT_TEXT do
+    'Heredoc without any following lines of text'
+  end
+
+  HEREDOC_MULTIPLE_AT_ESCAPES = hard_issue :HEREDOC_MULTIPLE_AT_ESCAPES, :escapes do
+    "An escape char for @() may only appear once. Got '#{escapes.join(', ')}'"
+  end
+
+  ILLEGAL_BOM = hard_issue :ILLEGAL_BOM, :format_name, :bytes do
+    "Illegal #{format_name} Byte Order mark at beginning of input: #{bytes} - remove these from the puppet source"
+  end
+
+  HIERA_UNSUPPORTED_VERSION = hard_issue :HIERA_UNSUPPORTED_VERSION, :version do
+    "This runtime does not support hiera.yaml version #{version}"
+  end
+
+  HIERA_VERSION_3_NOT_GLOBAL = hard_issue :HIERA_VERSION_3_NOT_GLOBAL, :where do
+    "hiera.yaml version 3 cannot be used in #{label.a_an(where)}"
+  end
+
+  HIERA_UNSUPPORTED_VERSION_IN_GLOBAL = hard_issue :HIERA_UNSUPPORTED_VERSION_IN_GLOBAL do
+    'hiera.yaml version 4 cannot be used in the global layer'
+  end
+
+  HIERA_UNDEFINED_VARIABLE = hard_issue :HIERA_UNDEFINED_VARIABLE, :name do
+    "Undefined variable '#{name}'"
+  end
+
+  HIERA_BACKEND_MULTIPLY_DEFINED = hard_issue :HIERA_BACKEND_MULTIPLY_DEFINED, :name, :first_line do
+    msg = "Backend '#{name}' is defined more than once"
+    fl = first_line
+    fl ? "#{msg}. First defined at line #{fl}" : msg
+  end
+
+  HIERA_NO_PROVIDER_FOR_BACKEND = hard_issue :HIERA_NO_PROVIDER_FOR_BACKEND, :name do
+    "No data provider is registered for backend '#{name}'"
+  end
+
+  HIERA_HIERARCHY_NAME_MULTIPLY_DEFINED = hard_issue :HIERA_HIERARCHY_NAME_MULTIPLY_DEFINED, :name, :first_line do
+    msg = "Hierarchy name '#{name}' defined more than once"
+    fl = first_line
+    fl ? "#{msg}. First defined at line #{fl}" : msg
+  end
+
+  HIERA_V3_BACKEND_NOT_GLOBAL = hard_issue :HIERA_V3_BACKEND_NOT_GLOBAL do
+    "'hiera3_backend' is only allowed in the global layer"
+  end
+
+  HIERA_DEFAULT_HIERARCHY_NOT_IN_MODULE = hard_issue :HIERA_DEFAULT_HIERARCHY_NOT_IN_MODULE do
+    "'default_hierarchy' is only allowed in the module layer"
+  end
+
+  HIERA_V3_BACKEND_REPLACED_BY_DATA_HASH = hard_issue :HIERA_V3_BACKEND_REPLACED_BY_DATA_HASH, :function_name do
+    "Use \"data_hash: #{function_name}_data\" instead of \"hiera3_backend: #{function_name}\""
+  end
+
+  HIERA_MISSING_DATA_PROVIDER_FUNCTION = hard_issue :HIERA_MISSING_DATA_PROVIDER_FUNCTION, :name do
+    "One of #{label.combine_strings(Lookup::HieraConfig::FUNCTION_KEYS)} must be defined in hierarchy '#{name}'"
+  end
+
+  HIERA_MULTIPLE_DATA_PROVIDER_FUNCTIONS = hard_issue :HIERA_MULTIPLE_DATA_PROVIDER_FUNCTIONS, :name do
+    "Only one of #{label.combine_strings(Lookup::HieraConfig::FUNCTION_KEYS)} can be defined in hierarchy '#{name}'"
+  end
+
+  HIERA_MULTIPLE_DATA_PROVIDER_FUNCTIONS_IN_DEFAULT = hard_issue :HIERA_MULTIPLE_DATA_PROVIDER_FUNCTIONS_IN_DEFAULT do
+    "Only one of #{label.combine_strings(Lookup::HieraConfig::FUNCTION_KEYS)} can be defined in defaults"
+  end
+
+  HIERA_MULTIPLE_LOCATION_SPECS = hard_issue :HIERA_MULTIPLE_LOCATION_SPECS, :name do
+    "Only one of #{label.combine_strings(Lookup::HieraConfig::LOCATION_KEYS)} can be defined in hierarchy '#{name}'"
+  end
+
+  HIERA_OPTION_RESERVED_BY_PUPPET = hard_issue :HIERA_OPTION_RESERVED_BY_PUPPET, :key, :name do
+    "Option key '#{key}' used in hierarchy '#{name}' is reserved by Puppet"
+  end
+
+  HIERA_DEFAULT_OPTION_RESERVED_BY_PUPPET = hard_issue :HIERA_DEFAULT_OPTION_RESERVED_BY_PUPPET, :key do
+    "Option key '#{key}' used in defaults is reserved by Puppet"
+  end
+
+  HIERA_DATA_PROVIDER_FUNCTION_NOT_FOUND = hard_issue :HIERA_DATA_PROVIDER_FUNCTION_NOT_FOUND, :function_type, :function_name do
+    "Unable to find '#{function_type}' function named '#{function_name}'"
+  end
+
+  HIERA_INTERPOLATION_ALIAS_NOT_ENTIRE_STRING = hard_issue :HIERA_INTERPOLATION_ALIAS_NOT_ENTIRE_STRING do
+    "'alias' interpolation is only permitted if the expression is equal to the entire string"
+  end
+
+  HIERA_INTERPOLATION_UNKNOWN_INTERPOLATION_METHOD = hard_issue :HIERA_INTERPOLATION_UNKNOWN_INTERPOLATION_METHOD, :name do
+    "Unknown interpolation method '#{name}'"
+  end
+
+  HIERA_INTERPOLATION_METHOD_SYNTAX_NOT_ALLOWED = hard_issue :HIERA_INTERPOLATION_METHOD_SYNTAX_NOT_ALLOWED do
+    'Interpolation using method syntax is not allowed in this context'
+  end
+end
+end