bolt 0.0.1 → 0.5.0

data/vendored/puppet/lib/puppet/pops/types/p_binary_type.rb

@@ -0,0 +1,226 @@
+require 'base64'
+module Puppet::Pops
+module Types
+
+# A Puppet Language Type that exposes the {{SemanticPuppet::Version}} and {{SemanticPuppet::VersionRange}}.
+# The version type is parameterized with version ranges.
+#
+# @api public
+class PBinaryType < PAnyType
+
+  # Represents a binary buffer
+  # @api public
+  class Binary
+    attr_reader :binary_buffer
+
+    # Constructs an instance of Binary from a base64 urlsafe encoded string (RFC 2045).
+    # @param [String] A string with RFC 2045 compliant encoded binary
+    #
+    def self.from_base64(str)
+      new(Base64.decode64(str))
+    end
+
+    # Constructs an instance of Binary from a base64 encoded string (RFC4648 with "URL and Filename
+    # Safe Alphabet" (That is with '-' instead of '+', and '_' instead of '/').
+    #
+    def self.from_base64_urlsafe(str)
+      new(Base64.urlsafe_decode64(str))
+    end
+
+    # Constructs an instance of Binary from a base64 strict encoded string (RFC 4648)
+    # Where correct padding must be used and line breaks causes an error to be raised.
+    #
+    # @param [String] A string with RFC 4648 compliant encoded binary
+    #
+    def self.from_base64_strict(str)
+      new(Base64.strict_decode64(str))
+    end
+
+    # Creates a new Binary from a String containing binary data. If the string's encoding
+    # is not already ASCII-8BIT, a copy of the string is force encoded as ASCII-8BIT (that is Ruby's "binary" format).
+    # This means that this binary will have the exact same content, but the string will considered
+    # to hold a sequence of bytes in the range 0 to 255.
+    #
+    # The given string will be frozen as a side effect if it is in ASCII-8BIT encoding. If this is not
+    # wanted, a copy should be given to this method.
+    #
+    # @param [String] A string with binary data
+    # @api public
+    #
+    def self.from_binary_string(bin)
+      new(bin)
+    end
+
+    # Creates a new Binary from a String containing text/binary in its given encoding. If the string's encoding
+    # is not already UTF-8, the string is first transcoded to UTF-8.
+    # This means that this binary will have the UTF-8 byte representation of the original string.
+    # For this to be valid, the encoding used in the given string must be valid.
+    # The validity of the given string is therefore asserted.
+    #
+    # The given string will be frozen as a side effect if it is in ASCII-8BIT encoding. If this is not
+    # wanted, a copy should be given to this method.
+    #
+    # @param [String] A string with valid content in its given encoding
+    # @return [Puppet::Pops::Types::PBinaryType::Binary] with the UTF-8 representation of the UTF-8 transcoded string
+    # @api public
+    #
+    def self.from_string(encoded_string)
+      enc = encoded_string.encoding.name
+      unless encoded_string.valid_encoding?
+        raise ArgumentError, _("The given string in encoding '%{enc}' is invalid. Cannot create a Binary UTF-8 representation") % { enc: enc }
+      end
+      # Convert to UTF-8 (if not already UTF-8), and then to binary
+      encoded_string = (enc == "UTF-8") ? encoded_string.dup : encoded_string.encode('UTF-8')
+      encoded_string.force_encoding("ASCII-8BIT")
+      new(encoded_string)
+    end
+
+    # Creates a new Binary from a String containing raw binary data of unknown encoding. If the string's encoding
+    # is not already ASCII-8BIT, a copy of the string is forced to ASCII-8BIT (that is Ruby's "binary" format).
+    # This means that this binary will have the exact same content, but the string will considered
+    # to hold a sequence of bytes in the range 0 to 255.
+    #
+    # @param [String] A string with binary data
+    # @api private
+    #
+    def initialize(bin)
+      # TODO: When Ruby 1.9.3 support is dropped change this to `bin.b` for binary encoding instead of force_encoding
+      @binary_buffer = (bin.encoding.name == "ASCII-8BIT" ? bin : bin.dup.force_encoding("ASCII-8BIT")).freeze
+    end
+
+    # Presents the binary content as a string base64 encoded string (without line breaks).
+    #
+    def to_s
+      Base64.strict_encode64(@binary_buffer)
+    end
+
+    # Returns the binary content as a "relaxed" base64 (standard) encoding where
+    # the string is broken up with new lines.
+    def relaxed_to_s
+      Base64.encode64(@binary_buffer)
+    end
+
+    # Returns the binary content as a url safe base64 string (where + and / are replaced by - and _)
+    #
+    def urlsafe_to_s
+      Base64.urlsafe_encode64(@binary_buffer)
+    end
+
+    def hash
+      @binary_buffer.hash
+    end
+
+    def eql?(o)
+      self.class == o.class && @binary_buffer == o.binary_buffer
+    end
+
+    def ==(o)
+      self.eql?(o)
+    end
+
+    def length()
+      @binary_buffer.length
+    end
+  end
+
+  def self.register_ptype(loader, ir)
+    create_ptype(loader, ir, 'AnyType')
+  end
+
+  # Only instances of Binary are instances of the PBinaryType
+  #
+  def instance?(o, guard = nil)
+    o.is_a?(Binary)
+  end
+
+  def eql?(o)
+    self.class == o.class
+  end
+
+  # Binary uses the strict base64 format as its string representation
+  # @return [TrueClass] true
+  def roundtrip_with_string?
+    true
+  end
+
+  # @api private
+  def self.new_function(type)
+    @new_function ||= Puppet::Functions.create_loaded_function(:new_Binary, type.loader) do
+      local_types do
+        type 'ByteInteger = Integer[0,255]'
+        type 'Base64Format = Enum["%b", "%u", "%B", "%s", "%r"]'
+        type 'StringHash = Struct[{value => String, "format" => Optional[Base64Format]}]'
+        type 'ArrayHash = Struct[{value => Array[ByteInteger]}]'
+        type 'BinaryArgsHash = Variant[StringHash, ArrayHash]'
+      end
+
+      # Creates a binary from a base64 encoded string in one of the formats %b, %u, %B, %s, or %r
+      dispatch :from_string do
+        param 'String', :str
+        optional_param 'Base64Format', :format
+      end
+
+      dispatch :from_array do
+        param 'Array[ByteInteger]', :byte_array
+      end
+
+      # Same as from_string, or from_array, but value and (for string) optional format are given in the form
+      # of a hash.
+      #
+      dispatch :from_hash do
+        param 'BinaryArgsHash', :hash_args
+      end
+
+      def from_string(str, format = nil)
+        format ||= '%B'
+        case format
+        when "%b"
+          # padding must be added for older rubies to avoid truncation
+          padding = '=' * (str.length % 3)
+          Binary.new(Base64.decode64(str + padding))
+
+        when "%u"
+          Binary.new(Base64.urlsafe_decode64(str))
+
+        when "%B"
+          Binary.new(Base64.strict_decode64(str))
+
+        when "%s"
+          Binary.from_string(str)
+
+        when "%r"
+          Binary.from_binary_string(str)
+
+        else
+          raise ArgumentError, "Unsupported Base64 format '#{format}'"
+        end
+      end
+
+      def from_array(array)
+        # The array is already known to have bytes in the range 0-255, or it is in error
+        # Without this pack C would produce weird results
+        Binary.from_binary_string(array.pack("C*"))
+      end
+
+      def from_hash(hash)
+        case hash['value']
+        when Array
+          from_array(hash['value'])
+        when String
+          from_string(hash['value'], hash['format'])
+        end
+      end
+    end
+  end
+
+  DEFAULT = PBinaryType.new
+
+  protected
+
+  def _assignable?(o, guard)
+    o.class == self.class
+  end
+
+end
+end
+end

data/vendored/puppet/lib/puppet/pops/types/p_error_type.rb

@@ -0,0 +1,146 @@
+module Puppet::Pops
+module Types
+class PErrorType < PAnyType
+  DEFAULT_ISSUE_CODE = 'ERROR'.freeze
+
+  class Error
+    include PuppetObject
+
+    attr_reader :message, :kind, :issue_code, :partial_result, :details
+
+    def self._pcore_type
+      return PErrorType::DEFAULT
+    end
+
+    def initialize(message, kind = nil, issue_code = DEFAULT_ISSUE_CODE, partial_result = nil, details = nil)
+      @issue_code = issue_code
+      @kind = kind
+      @message = message
+      @partial_result = partial_result
+      @details = details
+    end
+
+    def to_s
+      s = 'Error('
+      s << StringConverter.convert(_pcore_init_hash, '%p')
+      s << ')'
+      s
+    end
+
+    def _pcore_type
+      return PErrorType.new(@kind.nil? ? nil : PStringType.new(@kind), @issue_code.nil? ? nil : PStringType.new(@issue_code))
+    end
+
+    def _pcore_init_hash
+      hash = {
+        'message' => @message,
+      }
+      hash['kind'] = @kind unless @kind.nil?
+      hash['issue_code'] = @issue_code unless @issue_code.nil?
+      hash['partial_result'] = @partial_result unless @partial_result.nil?
+      hash['details'] = @details unless @details.nil?
+      hash
+    end
+  end
+
+  TYPE_ERROR_TYPE_PARAM = PVariantType.new([PTypeType.new(PEnumType::DEFAULT), PTypeType.new(PPatternType::DEFAULT)])
+  TYPE_ERROR_PARAM = PVariantType.new([PUndefType::DEFAULT, PDefaultType::DEFAULT, PRegexpType::DEFAULT, PStringType::DEFAULT, TYPE_ERROR_TYPE_PARAM])
+
+  def self.register_ptype(loader, ir)
+    create_ptype(loader, ir, 'AnyType',
+      'kind' => { KEY_TYPE => TYPE_ERROR_PARAM, KEY_VALUE => nil },
+      'issue_code' => { KEY_TYPE => TYPE_ERROR_PARAM, KEY_VALUE => nil }
+    )
+  end
+
+  def self.new_function(type)
+    @new_function ||= Puppet::Functions.create_loaded_function(:new_error, type.loader) do
+      dispatch :create do
+        param 'String[1]', :message
+        optional_param 'Optional[String[1]]', :kind
+        optional_param 'Optional[String[1]]', :issue_code
+        optional_param 'Data', :partial_result
+        optional_param 'Optional[DataHash]', :details
+      end
+
+      def create(message, kind = nil, issue_code = nil, partial_result = nil, details = nil)
+        issue_code = DEFAULT_ISSUE_CODE if issue_code.nil?
+        Error.new(message, kind, issue_code, partial_result, details)
+      end
+    end
+  end
+
+  attr_reader :kind, :issue_code
+
+  def initialize(kind = nil, issue_code = nil)
+    @kind = convert_arg(kind)
+    @issue_code = convert_arg(issue_code)
+  end
+
+  def eql?(o)
+    self.class == o.class && @kind == o.kind && @issue_code == o.issue_code
+  end
+
+  def generalize
+    DEFAULT
+  end
+
+  def hash
+    self.class.hash ^ @kind.hash ^ @issue_code.hash
+  end
+
+  def instance?(o, guard = nil)
+    if o.is_a?(Error)
+      unless @kind.nil?
+        return false unless @kind.instance?(o.kind)
+      end
+      unless @issue_code.nil?
+        return false unless @issue_code.instance?(o.issue_code)
+      end
+      true
+    else
+      false
+    end
+  end
+
+  def normalize(guard = nil)
+    nk = @kind.nil? ? nil : @kind.normalize(guard)
+    ni = @issue_code.nil? ? nil : @issue_code.normalize(guard)
+    nk.equal?(@kind) && ni.equal?(@issue_code) ? self : new(nk, ni)
+  end
+
+  protected
+
+  def _assignable?(o, guard = nil)
+    if o.class == self.class
+      unless @kind.nil?
+        return false unless o.kind && @kind.assignable?(o.kind, guard)
+      end
+      unless @issue_code.nil?
+        return false unless o.issue_code && @issue_code.assignable?(o.issue_code)
+      end
+      true
+    else
+      false
+    end
+  end
+
+  private
+
+  def convert_arg(arg)
+    case arg
+    when nil, :default
+      nil
+    when String
+      PStringType.new(arg)
+    when Regexp
+      PPatternType.new([PRegexpType.new(arg)])
+    else
+      arg
+    end
+  end
+
+  DEFAULT = PErrorType.new(nil, nil)
+end
+end
+end

data/vendored/puppet/lib/puppet/pops/types/p_init_type.rb

@@ -0,0 +1,238 @@
+module Puppet::Pops
+module Types
+
+# @api public
+class PInitType < PTypeWithContainedType
+  def self.register_ptype(loader, ir)
+    create_ptype(loader, ir, 'AnyType',
+      'type' => {
+        KEY_TYPE => POptionalType.new(PTypeType::DEFAULT),
+        KEY_VALUE => nil
+      },
+      'init_args' => {
+        KEY_TYPE => PArrayType::DEFAULT,
+        KEY_VALUE => EMPTY_ARRAY
+      }
+    )
+  end
+
+  attr_reader :init_args
+
+  def initialize(type, init_args)
+    super(type)
+    @init_args = init_args.nil? ? EMPTY_ARRAY : init_args
+
+    if type.nil?
+      raise ArgumentError, _('Init cannot be parameterized with an undefined type and additional arguments') unless @init_args.empty?
+      @initialized = true
+    else
+      @initialized = false
+    end
+  end
+
+  def instance?(o, guard = nil)
+    really_instance?(o, guard) == 1
+  end
+
+  # @api private
+  def really_instance?(o, guard = nil)
+    if @type.nil?
+      TypeFactory.rich_data.really_instance?(o)
+    else
+      assert_initialized
+      guarded_recursion(guard, 0) do |g|
+        v = @type.really_instance?(o, g)
+        if v < 1
+          if @single_type
+            s = @single_type.really_instance?(o, g)
+            v = s if s > v
+          end
+        end
+        if v < 1
+          if @other_type
+            s = @other_type.really_instance?(o, g)
+            s = @other_type.really_instance?([o], g) if s < 0 && @has_optional_single
+            v = s if s > v
+          end
+        end
+        v
+      end
+    end
+  end
+
+  def eql?(o)
+    super && @init_args == o.init_args
+  end
+
+  def hash
+    super ^ @init_args.hash
+  end
+
+  def new_function
+    return super if type.nil?
+    assert_initialized
+
+    target_type = type
+    single_type = @single_type
+    if @init_args.empty?
+      @new_function ||= Puppet::Functions.create_function(:new_Init, Puppet::Functions::InternalFunction) do
+        @target_type = target_type
+        @single_type = single_type
+
+        dispatch :from_array do
+          scope_param
+          param 'Array', :value
+        end
+
+        dispatch :create do
+          scope_param
+          param 'Any', :value
+        end
+
+        def self.create(scope, value, func)
+          func.call(scope, @target_type, value)
+        end
+
+        def self.from_array(scope, value, func)
+          # If there is a single argument that matches the array, then that gets priority over
+          # expanding the array into all arguments
+          if @single_type.instance?(value) || (@other_type && !@other_type.instance?(value) && @has_optional_single && @other_type.instance?([value]))
+            func.call(scope, @target_type, value)
+          else
+            func.call(scope, @target_type, *value)
+          end
+        end
+
+        def from_array(scope, value)
+          self.class.from_array(scope, value, loader.load(:function, 'new'))
+        end
+
+        def create(scope, value)
+          self.class.create(scope, value, loader.load(:function, 'new'))
+        end
+      end
+    else
+      init_args = @init_args
+      @new_function ||= Puppet::Functions.create_function(:new_Init, Puppet::Functions::InternalFunction) do
+        @target_type = target_type
+        @init_args = init_args
+
+        dispatch :create do
+          scope_param
+          param 'Any', :value
+        end
+
+        def self.create(scope, value, func)
+          func.call(scope, @target_type, value, *@init_args)
+        end
+
+        def create(scope, value)
+          self.class.create(scope, value, loader.load(:function, 'new'))
+        end
+      end
+    end
+  end
+
+  DEFAULT = PInitType.new(nil, EMPTY_ARRAY)
+
+  EXACTLY_ONE = [1, 1].freeze
+
+  def assert_initialized
+    return self if @initialized
+
+    @initialized = true
+    @self_recursion = true
+
+    begin
+      # Filter out types that will provide a new_function but are unsuitable to be contained in Init
+      #
+      # Calling Init#new would cause endless recursion
+      # The Optional is the same as Variant[T,Undef].
+      # The NotUndef is not meaningful to create instances of
+      if @type.instance_of?(PInitType) || @type.instance_of?(POptionalType) || @type.instance_of?(PNotUndefType)
+        raise ArgumentError.new
+      end
+      new_func = @type.new_function
+    rescue ArgumentError
+      raise ArgumentError, _("Creation of new instance of type '%{type_name}' is not supported") % { type_name: @type.to_s }
+    end
+    param_tuples = new_func.dispatcher.dispatchers.map { |closure| closure.type.param_types }
+
+    # An instance of the contained type is always a match to this type.
+    single_types = [@type]
+
+    if @init_args.empty?
+      # A value that is assignable to the type of a single parameter is also a match
+      single_tuples, other_tuples = param_tuples.partition { |tuple| EXACTLY_ONE == tuple.size_range }
+      single_types.concat(single_tuples.map { |tuple| tuple.types[0] })
+    else
+      tc = TypeCalculator.singleton
+      init_arg_types = @init_args.map { |arg| tc.infer_set(arg) }
+      arg_count = 1 + init_arg_types.size
+
+      # disqualify all parameter tuples that doesn't allow one value (type unknown at ths stage) + init args.
+      param_tuples = param_tuples.select do |tuple|
+        min, max = tuple.size_range
+        if arg_count >= min && arg_count <= max
+          # Aside from the first parameter, does the other parameters match?
+          tuple.assignable?(PTupleType.new(tuple.types[0..0].concat(init_arg_types)))
+        else
+          false
+        end
+      end
+      if param_tuples.empty?
+        raise ArgumentError, _("The type '%{type}' does not represent a valid set of parameters for %{subject}.new()") %
+          { type: to_s, subject: @type.generalize.name }
+      end
+      single_types.concat(param_tuples.map { |tuple| tuple.types[0] })
+      other_tuples = EMPTY_ARRAY
+    end
+    @single_type = PVariantType.maybe_create(single_types)
+    unless other_tuples.empty?
+      @other_type = PVariantType.maybe_create(other_tuples)
+      @has_optional_single = other_tuples.any? { |tuple| tuple.size_range.min == 1 }
+    end
+
+    guard = RecursionGuard.new
+    accept(NoopTypeAcceptor::INSTANCE, guard)
+    @self_recursion = guard.recursive_this?(self)
+  end
+
+  def accept(visitor, guard)
+    guarded_recursion(guard, nil) do |g|
+      super(visitor, g)
+      @single_type.accept(visitor, guard) if @single_type
+      @other_type.accept(visitor, guard) if @other_type
+    end
+  end
+
+  protected
+
+  def _assignable?(o, guard)
+    guarded_recursion(guard, false) do |g|
+      assert_initialized
+      if o.is_a?(PInitType)
+        @type.nil? || @type.assignable?(o.type, g)
+      elsif @type.nil?
+        TypeFactory.rich_data.assignable?(o, g)
+      else
+        @type.assignable?(o, g) ||
+          @single_type && @single_type.assignable?(o, g) ||
+          @other_type && (@other_type.assignable?(o, g) || @has_optional_single && @other_type.assignable?(PTupleType.new([o])))
+      end
+    end
+  end
+
+  private
+
+  def guarded_recursion(guard, dflt)
+    if @self_recursion
+      guard ||= RecursionGuard.new
+      guard.with_this(self) { |state| (state & RecursionGuard::SELF_RECURSION_IN_THIS) == 0 ? yield(guard) : dflt }
+    else
+      yield(guard)
+    end
+  end
+end
+end
+end