puppet 4.0.0 → 4.9.1

data/lib/puppet/pops/types/type_conversion_error.rb

@@ -0,0 +1,15 @@
+
+module Puppet::Pops::Types
+  # Raised when a conversion of a value to another type failed.
+  #
+  class TypeConversionError < Puppet::Error
+
+    # Creates a new instance with a given message
+    #
+    # @param message [String] The error message describing what failed
+    #
+    def initialize(message)
+      super(message)
+    end
+  end
+end

data/lib/puppet/pops/types/type_factory.rb

@@ -1,52 +1,71 @@
+module Puppet::Pops
+module Types
 # Helper module that makes creation of type objects simpler.
 # @api public
 #
-module Puppet::Pops::Types::TypeFactory
-  @type_calculator = Puppet::Pops::Types::TypeCalculator.new()
-
-  Types = Puppet::Pops::Types
+module TypeFactory
+  @type_calculator = TypeCalculator.singleton
 
   # Produces the Integer type
   # @api public
   #
-  def self.integer()
-    Types::PIntegerType.new()
+  def self.integer
+    PIntegerType::DEFAULT
   end
 
   # Produces an Integer range type
   # @api public
   #
   def self.range(from, to)
-    t = Types::PIntegerType.new()
     # optimize eq with symbol (faster when it is left)
-    t.from = from unless (:default == from || from == 'default')
-    t.to = to unless (:default == to || to == 'default')
-    t
+    from = :default == from if from == 'default'
+    to = :default if to == 'default'
+    PIntegerType.new(from, to)
   end
 
   # Produces a Float range type
   # @api public
   #
   def self.float_range(from, to)
-    t = Types::PFloatType.new()
     # optimize eq with symbol (faster when it is left)
-    t.from = Float(from) unless :default == from || from.nil?
-    t.to = Float(to) unless :default == to || to.nil?
-    t
+    from = Float(from) unless :default == from || from.nil?
+    to = Float(to) unless :default == to || to.nil?
+    PFloatType.new(from, to)
   end
 
   # Produces the Float type
   # @api public
   #
-  def self.float()
-    Types::PFloatType.new()
+  def self.float
+    PFloatType::DEFAULT
+  end
+
+  # Produces the Sensitive type
+  # @api public
+  #
+  def self.sensitive(type = nil)
+    PSensitiveType.new(type)
   end
 
   # Produces the Numeric type
   # @api public
   #
-  def self.numeric()
-    Types::PNumericType.new()
+  def self.numeric
+    PNumericType::DEFAULT
+  end
+
+  # Produces the Iterable type
+  # @api public
+  #
+  def self.iterable(elem_type = nil)
+    elem_type.nil? ? PIterableType::DEFAULT : PIterableType.new(elem_type)
+  end
+
+  # Produces the Iterator type
+  # @api public
+  #
+  def self.iterator(elem_type = nil)
+    elem_type.nil? ? PIteratorType::DEFAULT : PIteratorType.new(elem_type)
   end
 
   # Produces a string representation of the type
@@ -56,77 +75,148 @@ module Puppet::Pops::Types::TypeFactory
     @type_calculator.string(t)
   end
 
-  # Produces the String type, optionally with specific string values
+  # Produces the String type based on nothing, a string value that becomes an exact match constraint, or a parameterized
+  # Integer type that constraints the size.
+  #
   # @api public
   #
-  def self.string(*values)
-    t = Types::PStringType.new()
-    values.each {|v| t.addValues(v) }
-    t
+  def self.string(size_type_or_value = nil, *deprecated_second_argument)
+    if deprecated_second_argument.empty?
+      size_type_or_value.nil? ? PStringType::DEFAULT : PStringType.new(size_type_or_value)
+    else
+      if Puppet[:strict] != :off
+        Puppet.warn_once(:deprecatation, "TypeFactory#string_multi_args", "Passing more than one argument to TypeFactory#string is deprecated")
+      end
+      deprecated_second_argument.size == 1 ? PStringType.new(deprecated_second_argument[0]) : PEnumType.new(*deprecated_second_argument)
+    end
   end
 
   # Produces the Optional type, i.e. a short hand for Variant[T, Undef]
+  # If the given 'optional_type' argument is a String, then it will be
+  # converted into a String type that represents that string.
+  #
+  # @param optional_type [String,PAnyType,nil] the optional type
+  # @return [POptionalType] the created type
+  #
+  # @api public
+  #
   def self.optional(optional_type = nil)
-    t = Types::POptionalType.new
-    t.optional_type = type_of(optional_type)
-    t
+    POptionalType.new(type_of(optional_type.is_a?(String) ? string(optional_type) : type_of(optional_type)))
   end
 
   # Produces the Enum type, optionally with specific string values
   # @api public
   #
   def self.enum(*values)
-    t = Types::PEnumType.new()
-    values.each {|v| t.addValues(v) }
-    t
+    PEnumType.new(values)
   end
 
   # Produces the Variant type, optionally with the "one of" types
   # @api public
   #
   def self.variant(*types)
-    t = Types::PVariantType.new()
-    t.types = types.map {|v| type_of(v) }
-    t
+    PVariantType.maybe_create(types.map {|v| type_of(v) })
   end
 
   # Produces the Struct type, either a non parameterized instance representing
-  # all structs (i.e. all hashes) or a hash with a given set of keys of String
-  # type (names), bound to a value of a given type. Type may be a Ruby Class, a
-  # Puppet Type, or an instance from which the type is inferred.
-  #
-  def self.struct(name_type_hash = {})
-    t = Types::PStructType.new
-    t.elements = name_type_hash.map do |name, type|
-      elem = Types::PStructElement.new
-      if name.is_a?(String) && name.empty?
-        raise ArgumentError, "An empty String can not be used where a String[1, default] is expected"
+  # all structs (i.e. all hashes) or a hash with entries where the key is
+  # either a literal String, an Enum with one entry, or a String representing exactly one value.
+  # The key type may also be wrapped in a NotUndef or an Optional.
+  #
+  # The value can be a ruby class, a String (interpreted as the name of a ruby class) or
+  # a Type.
+  #
+  # @param hash [{String,PAnyType=>PAnyType}] key => value hash
+  # @return [PStructType] the created Struct type
+  #
+  def self.struct(hash = {})
+    tc = @type_calculator
+    elements = hash.map do |key_type, value_type|
+      value_type = type_of(value_type)
+      raise ArgumentError, 'Struct element value_type must be a Type' unless value_type.is_a?(PAnyType)
+
+      # TODO: Should have stricter name rule
+      if key_type.is_a?(String)
+        raise ArgumentError, 'Struct element key cannot be an empty String' if key_type.empty?
+        key_type = string(key_type)
+        # Must make key optional if the value can be Undef
+        key_type = optional(key_type) if tc.assignable?(value_type, PUndefType::DEFAULT)
+      else
+        # assert that the key type is one of String[1], NotUndef[String[1]] and Optional[String[1]]
+        case key_type
+        when PNotUndefType
+          # We can loose the NotUndef wrapper here since String[1] isn't optional anyway
+          key_type = key_type.type
+          s = key_type
+        when POptionalType
+          s = key_type.optional_type
+        when PStringType
+          s = key_type
+        when PEnumType
+          s = key_type.values.size == 1 ? PStringType.new(key_type.values[0]) : nil
+        else
+          raise ArgumentError, "Illegal Struct member key type. Expected NotUndef, Optional, String, or Enum. Got: #{key_type.class.name}"
+        end
+        unless s.is_a?(PStringType) && !s.value.nil?
+          raise ArgumentError, "Unable to extract a non-empty literal string from Struct member key type #{tc.string(key_type)}"
+        end
       end
-      elem.name = name
-      elem.type = type_of(type)
-      elem
+      PStructElement.new(key_type, value_type)
+    end
+    PStructType.new(elements)
+  end
+
+  # Produces an `Object` type from the given _hash_ that represents the features of the object
+  #
+  # @param hash [{String=>Object}] the hash of feature groups
+  # @return [PObjectType] the created type
+  #
+  def self.object(hash = nil)
+    hash.nil? || hash.empty? ? PObjectType::DEFAULT : PObjectType.new(hash)
+  end
+
+  def self.type_set(hash = nil)
+    hash.nil? || hash.empty? ? PTypeSetType::DEFAULT : PTypeSetType.new(hash)
+  end
+
+  def self.timestamp(*args)
+    case args.size
+    when 0
+      PTimestampType::DEFAULT
+    when 1
+      PTimestampType.new(args[0], args[0])
+    else
+      PTimestampType.new(*args)
+    end
+  end
+
+  def self.timespan(*args)
+    case args.size
+    when 0
+      PTimespanType::DEFAULT
+    when 1
+      PTimespanType.new(args[0], args[0])
+    else
+      PTimespanType.new(*args)
     end
-    t
   end
 
-  def self.tuple(*types)
-    t = Types::PTupleType.new
-    t.types = types.map {|elem| type_of(elem) }
-    t
+  def self.tuple(types = [], size_type = nil)
+    PTupleType.new(types.map {|elem| type_of(elem) }, size_type)
   end
 
   # Produces the Boolean type
   # @api public
   #
-  def self.boolean()
-    Types::PBooleanType.new()
+  def self.boolean
+    PBooleanType::DEFAULT
   end
 
   # Produces the Any type
   # @api public
   #
-  def self.any()
-    Types::PAnyType.new()
+  def self.any
+    PAnyType::DEFAULT
   end
 
   # Produces the Regexp type
@@ -135,59 +225,45 @@ module Puppet::Pops::Types::TypeFactory
   # @api public
   #
   def self.regexp(pattern = nil)
-    t = Types::PRegexpType.new()
-    if pattern
-      t.pattern = pattern.is_a?(Regexp) ? pattern.inspect[1..-2] : pattern
-    end
-    t.regexp() unless pattern.nil? # compile pattern to catch errors
-    t
+    pattern ?  PRegexpType.new(pattern) : PRegexpType::DEFAULT
   end
 
   def self.pattern(*regular_expressions)
-    t = Types::PPatternType.new()
-    regular_expressions.each do |re|
+    patterns = regular_expressions.map do |re|
       case re
       when String
-        re_T = Types::PRegexpType.new()
-        re_T.pattern = re
-        re_T.regexp()  # compile it to catch errors
-        t.addPatterns(re_T)
+        re_t = PRegexpType.new(re)
+        re_t.regexp  # compile it to catch errors
+        re_t
 
       when Regexp
-        re_T = Types::PRegexpType.new()
-        # Regep.to_s includes options user did not enter and does not escape source
-        # to work either as a string or as a // regexp. The inspect method does a better
-        # job, but includes the //
-        re_T.pattern = re.inspect[1..-2]
-        t.addPatterns(re_T)
-
-      when Types::PRegexpType
-        t.addPatterns(re.copy)
-
-      when Types::PPatternType
-        re.patterns.each do |p|
-          t.addPatterns(p.copy)
-        end
+        PRegexpType.new(re)
+
+      when PRegexpType
+        re
+
+      when PPatternType
+        re.patterns
 
      else
        raise ArgumentError, "Only String, Regexp, Pattern-Type, and Regexp-Type are allowed: got '#{re.class}"
       end
-    end
-    t
+    end.flatten.uniq
+    PPatternType.new(patterns)
   end
 
   # Produces the Literal type
   # @api public
   #
-  def self.scalar()
-    Types::PScalarType.new()
+  def self.scalar
+    PScalarType::DEFAULT
   end
 
   # Produces a CallableType matching all callables
   # @api public
   #
-  def self.all_callables()
-    return Puppet::Pops::Types::PCallableType.new
+  def self.all_callables
+    return PCallableType::DEFAULT
   end
 
   # Produces a Callable type with one signature without support for a block
@@ -207,9 +283,13 @@ module Puppet::Pops::Types::TypeFactory
   # Params are given as a sequence of arguments to {#type_of}.
   #
   def self.callable(*params)
-    if Puppet::Pops::Types::TypeCalculator.is_kind_of_callable?(params.last)
-      last_callable = true
+    if params.size == 2 && params[0].is_a?(Array)
+      return_t = type_of(params[1])
+      params = params[0]
+    else
+      return_t = nil
     end
+    last_callable = TypeCalculator.is_kind_of_callable?(params.last)
     block_t = last_callable ? params.pop : nil
 
     # compute a size_type for the signature based on the two last parameters
@@ -219,63 +299,66 @@ module Puppet::Pops::Types::TypeFactory
     elsif is_range_parameter?(params[-1])
       size_type = range(params[-1], :default)
       params = params[0, params.size - 1]
+    else
+      size_type = nil
     end
 
     types = params.map {|p| type_of(p) }
 
     # If the specification requires types, and none were given, a Unit type is used
     if types.empty? && !size_type.nil? && size_type.range[1] > 0
-      types << Types::PUnitType.new
+      types << PUnitType::DEFAULT
     end
     # create a signature
-    callable_t = Types::PCallableType.new()
-    tuple_t = tuple(*types)
-    tuple_t.size_type = size_type unless size_type.nil?
-    callable_t.param_types = tuple_t
-
-    callable_t.block_type = block_t
-    callable_t
-  end
-
-  def self.with_block(callable, *block_params)
-    callable.block_type = callable(*block_params)
-    callable
-  end
-
-  def self.with_optional_block(callable, *block_params)
-    callable.block_type = optional(callable(*block_params))
-    callable
+    tuple_t = tuple(types, size_type)
+    PCallableType.new(tuple_t, block_t, return_t)
   end
 
   # Produces the abstract type Collection
   # @api public
   #
-  def self.collection()
-    Types::PCollectionType.new()
+  def self.collection(size_type = nil)
+    size_type.nil? ? PCollectionType::DEFAULT : PCollectionType.new(size_type)
   end
 
   # Produces the Data type
   # @api public
   #
-  def self.data()
-    Types::PDataType.new()
+  def self.data
+    PDataType::DEFAULT
   end
 
   # Creates an instance of the Undef type
   # @api public
-  def self.undef()
-    Types::PUndefType.new()
+  def self.undef
+    PUndefType::DEFAULT
   end
 
   # Creates an instance of the Default type
   # @api public
-  def self.default()
-    Types::PDefaultType.new()
+  def self.default
+    PDefaultType::DEFAULT
+  end
+
+  # Creates an instance of the Binary type
+  # @api public
+  def self.binary
+    PBinaryType::DEFAULT
   end
 
   # Produces an instance of the abstract type PCatalogEntryType
-  def self.catalog_entry()
-    Types::PCatalogEntryType.new()
+  def self.catalog_entry
+    PCatalogEntryType::DEFAULT
+  end
+
+  # Produces an instance of the SemVerRange type
+  def self.sem_ver_range
+    PSemVerRangeType::DEFAULT
+  end
+
+  # Produces an instance of the SemVer type
+  def self.sem_ver(*ranges)
+    ranges.empty? ? PSemVerType::DEFAULT : PSemVerType::new(ranges)
   end
 
   # Produces a PResourceType with a String type_name A PResourceType with a nil
@@ -284,18 +367,19 @@ module Puppet::Pops::Types::TypeFactory
   # name.  (There is no resource-type subtyping in Puppet (yet)).
   #
   def self.resource(type_name = nil, title = nil)
-    type = Types::PResourceType.new()
-    type_name = type_name.type_name if type_name.is_a?(Types::PResourceType)
-    type_name = type_name.downcase unless type_name.nil?
-    type.type_name = type_name
-    unless type_name.nil? || type_name =~ Puppet::Pops::Patterns::CLASSREF
-      raise ArgumentError, "Illegal type name '#{type.type_name}'"
-    end
-    if type_name.nil? && !title.nil?
-      raise ArgumentError, "The type name cannot be nil, if title is given"
+    case type_name
+    when PResourceType
+      PResourceType.new(type_name.type_name, title)
+    when String
+      type_name = TypeFormatter.singleton.capitalize_segments(type_name)
+      raise ArgumentError, "Illegal type name '#{type_name}'" unless type_name =~ Patterns::CLASSREF_EXT
+      PResourceType.new(type_name, title)
+    when nil
+      raise ArgumentError, 'The type name cannot be nil, if title is given' unless title.nil?
+      PResourceType::DEFAULT
+    else
+      raise ArgumentError, "The type name cannot be a #{type_name.class.name}"
     end
-    type.title = title
-    type
   end
 
   # Produces PHostClassType with a string class_name.  A PHostClassType with
@@ -304,60 +388,73 @@ module Puppet::Pops::Types::TypeFactory
   # with the same name.
   #
   def self.host_class(class_name = nil)
-    type = Types::PHostClassType.new()
-    unless class_name.nil?
-      type.class_name = class_name.sub(/^::/, '')
+    if class_name.nil?
+      PHostClassType::DEFAULT
+    else
+      PHostClassType.new(class_name.sub(/^::/, ''))
     end
-    type
   end
 
   # Produces a type for Array[o] where o is either a type, or an instance for
   # which a type is inferred.
   # @api public
   #
-  def self.array_of(o)
-    type = Types::PArrayType.new()
-    type.element_type = type_of(o)
-    type
+  def self.array_of(o, size_type = nil)
+    PArrayType.new(type_of(o), size_type)
   end
 
   # Produces a type for Hash[Scalar, o] where o is either a type, or an
   # instance for which a type is inferred.
   # @api public
   #
-  def self.hash_of(value, key = scalar())
-    type = Types::PHashType.new()
-    type.key_type = type_of(key)
-    type.element_type = type_of(value)
-    type
+  def self.hash_of(value, key = scalar, size_type = nil)
+    PHashType.new(type_of(key), type_of(value), size_type)
+  end
+
+  # Produces a type for Hash[key,value,size]
+  # @param key_type [PAnyType] the key type
+  # @param value_type [PAnyType] the value type
+  # @param size_type [PIntegerType]
+  # @return [PHashType] the created hash type
+  # @api public
+  #
+  def self.hash_kv(key_type, value_type, size_type = nil)
+    PHashType.new(key_type, value_type, size_type)
   end
 
   # Produces a type for Array[Data]
   # @api public
   #
-  def self.array_of_data()
-    type = Types::PArrayType.new()
-    type.element_type = data()
-    type
+  def self.array_of_data
+    PArrayType::DATA
   end
 
   # Produces a type for Hash[Scalar, Data]
   # @api public
   #
-  def self.hash_of_data()
-    type = Types::PHashType.new()
-    type.key_type = scalar()
-    type.element_type = data()
-    type
+  def self.hash_of_data
+    PHashType::DATA
+  end
+
+  # Produces a type for NotUndef[T]
+  # The given 'inst_type' can be a string in which case it will be converted into
+  # the type String[inst_type].
+  #
+  # @param inst_type [Type,String] the type to qualify
+  # @return [PNotUndefType] the NotUndef type
+  #
+  # @api public
+  #
+  def self.not_undef(inst_type = nil)
+    inst_type = string(inst_type) if inst_type.is_a?(String)
+    PNotUndefType.new(inst_type)
   end
 
   # Produces a type for Type[T]
   # @api public
   #
   def self.type_type(inst_type = nil)
-    type = Types::PType.new()
-    type.type = inst_type
-    type
+    inst_type.nil? ? PType::DEFAULT : PType.new(inst_type)
   end
 
   # Produce a type corresponding to the class of given unless given is a
@@ -367,10 +464,10 @@ module Puppet::Pops::Types::TypeFactory
   def self.type_of(o)
     if o.is_a?(Class)
       @type_calculator.type(o)
-    elsif o.is_a?(Types::PAnyType)
+    elsif o.is_a?(PAnyType)
       o
     elsif o.is_a?(String)
-      Types::PRuntimeType.new(:runtime => :ruby, :runtime_type_name => o)
+      PRuntimeType.new(:ruby, o)
     else
       @type_calculator.infer_generic(o)
     end
@@ -394,7 +491,7 @@ module Puppet::Pops::Types::TypeFactory
     if o.is_a?(Class)
       @type_calculator.type(o)
     else
-      Types::PRuntimeType.new(:runtime => :ruby, :runtime_type_name => o.class.name)
+      PRuntimeType.new(:ruby, o.class.name)
     end
   end
 
@@ -403,7 +500,7 @@ module Puppet::Pops::Types::TypeFactory
   # or mapps a Ruby Class to its name.
   #
   def self.ruby_type(class_name = nil)
-    Types::PRuntimeType.new(:runtime => :ruby, :runtime_type_name => class_name)
+    PRuntimeType.new(:ruby, class_name)
   end
 
   # Generic creator of a RuntimeType - allows creating the type with nil or
@@ -411,16 +508,23 @@ module Puppet::Pops::Types::TypeFactory
   #
   def self.runtime(runtime=nil, runtime_type_name = nil)
     runtime = runtime.to_sym if runtime.is_a?(String)
-    Types::PRuntimeType.new(:runtime => runtime, :runtime_type_name => runtime_type_name)
+    PRuntimeType.new(runtime, runtime_type_name)
   end
 
-  # Sets the accepted size range of a collection if something other than the
-  # default 0 to Infinity is wanted. The semantics for from/to are the same as
-  # for #range
-  #
-  def self.constrain_size(collection_t, from, to)
-    collection_t.size_type = range(from, to)
-    collection_t
+  # Returns the type alias for the given expression
+  # @param name [String] the name of the unresolved type
+  # @param expression [Model::Expression] an expression that will evaluate to a type
+  # @return [PTypeAliasType] the type alias
+  def self.type_alias(name = nil, expression = nil)
+    name.nil? ? PTypeAliasType::DEFAULT : PTypeAliasType.new(name, expression)
+  end
+
+  # Returns the type that represents a type reference with a given name and optional
+  # parameters.
+  # @param type_string [String] the string form of the type
+  # @return [PTypeReferenceType] the type reference
+  def self.type_reference(type_string = nil)
+    type_string == nil ? PTypeReferenceType::DEFAULT : PTypeReferenceType.new(type_string)
   end
 
   # Returns true if the given type t is of valid range parameter type (integer
@@ -430,3 +534,5 @@ module Puppet::Pops::Types::TypeFactory
   end
 
 end
+end
+end