Class: Puppet::Pops::Types::PIntegerType

Inherits:
PNumericType show all
Defined in:
lib/puppet/pops/types/types.rb

Constant Summary collapse

DEFAULT = 
PIntegerType.new(-Float::INFINITY)

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from PNumericType

#eql?, #from, #hash, #initialize, #intersect?, new_function, #numeric_from, #numeric_to, #to, #unbounded?

Methods inherited from PScalarType

#roundtrip_with_string?

Methods inherited from PAnyType

#==, #accept, #assignable?, #callable?, #callable_args?, #callable_with?, #check_self_recursion, #create, create, #eql?, #hash, #kind_of_callable?, #name, new_function, #normalize, #really_instance?, #resolve, #roundtrip_with_string?, #simple_name, simple_name, #to_alias_expanded_s, #to_s

Methods inherited from TypedModelObject

_pcore_type, create_ptype, register_ptypes

Methods included from Visitable

#accept

Methods included from PuppetObject

#_pcore_all_contents, #_pcore_contents, #_pcore_init_hash, #_pcore_type

Constructor Details

This class inherits a constructor from Puppet::Pops::Types::PNumericType

Class Method Details

.register_ptype(loader, ir) ⇒ Object 



921
922
923
 
# File 'lib/puppet/pops/types/types.rb', line 921

def self.register_ptype(loader, ir)
  create_ptype(loader, ir, 'NumericType')
end

Instance Method Details

#adjacent?(o) ⇒ Boolean

Checks if this range is adjacent to the given range

Parameters:

Returns:

  • (Boolean) —

    ‘true` if this range is adjacent to the other range



945
946
947
 
# File 'lib/puppet/pops/types/types.rb', line 945

def adjacent?(o)
  o.is_a?(PIntegerType) &&  (@to + 1 == o.from || o.to + 1 == @from)
end

#each(&block) ⇒ Object

Returns Enumerator if no block is given Returns nil if size is infinity (does not yield)



988
989
990
991
 
# File 'lib/puppet/pops/types/types.rb', line 988

def each(&block)
  r = Iterable.on(self)
  block_given? ? r.each(&block) : r
end

#finite_range? ⇒ Boolean

Will respond ‘true` for any range that is bounded at both ends.

Returns:

  • (Boolean) —

    ‘true` if the type describes a finite range.



928
929
930
 
# File 'lib/puppet/pops/types/types.rb', line 928

def finite_range?
  @from != -Float::INFINITY && @to != Float::INFINITY
end

#generalize ⇒ Object 



932
933
934
 
# File 'lib/puppet/pops/types/types.rb', line 932

def generalize
  DEFAULT
end

#instance?(o, guard = nil) ⇒ Boolean

Returns:

  • (Boolean) 


936
937
938
 
# File 'lib/puppet/pops/types/types.rb', line 936

def instance?(o, guard = nil)
  o.is_a?(Integer) && o >= numeric_from && o <= numeric_to
end

#iterable?(guard = nil) ⇒ Boolean

Returns:

  • (Boolean) 


965
966
967
 
# File 'lib/puppet/pops/types/types.rb', line 965

def iterable?(guard = nil)
  true
end

#iterable_type(guard = nil) ⇒ Object 



969
970
971
972
 
# File 'lib/puppet/pops/types/types.rb', line 969

def iterable_type(guard = nil)
  # It's unknown if the iterable will be a range (min, max) or a "times" (0, max)
  PIterableType.new(PIntegerType::DEFAULT)
end

#merge(o) ⇒ PIntegerType?

Concatenates this range with another range provided that the ranges intersect or are adjacent. When that’s not the case, this method will return ‘nil`

Parameters:

  • o (PIntegerType) —

    the range to concatenate with this range

Returns:

  • (PIntegerType, nil) —

    the concatenated range or ‘nil` when the ranges were apart



955
956
957
958
959
960
961
962
963
 
# File 'lib/puppet/pops/types/types.rb', line 955

def merge(o)
  if intersect?(o) || adjacent?(o)
    min = @from <= o.numeric_from ? @from : o.numeric_from
    max = @to >= o.numeric_to ? @to : o.numeric_to
    PIntegerType.new(min, max)
  else
    nil
  end
end

#new_function(loader) ⇒ Object 



1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
 
# File 'lib/puppet/pops/types/types.rb', line 1000

def new_function(loader)
  @@new_function ||= Puppet::Functions.create_loaded_function(:new, loader) do
    local_types do
      type 'Radix       = Variant[Default, Integer[2,2], Integer[8,8], Integer[10,10], Integer[16,16]]'
      type 'Convertible = Variant[Undef, Numeric, Boolean, String, Timespan, Timestamp]'
      type 'NamedArgs   = Struct[{from => Convertible, Optional[radix] => Radix, Optional[abs] => Boolean}]'
    end

    dispatch :from_args do
      param          'Convertible',  :from
      optional_param 'Radix',   :radix
      optional_param 'Boolean', :abs
    end

    dispatch :from_hash do
      param          'NamedArgs',  :hash_args
    end

    def from_args(from, radix = :default, abs = false)
      result = from_convertible(from, radix)
      abs ? result.abs : result
    end

    def from_hash(args_hash)
      from_args(args_hash['from'], args_hash['radix'] || :default, args_hash['abs'] || false)
    end

    def from_convertible(from, radix)
      case from
      when NilClass
        throw :undefined_value
      when Float, Time::TimeData
        from.to_i
      when Integer
        from
      when TrueClass
        1
      when FalseClass
        0
      when String
        begin
          radix == :default ? Integer(from) : Integer(from, assert_radix(radix))
        rescue TypeError => e
          raise TypeConversionError.new(e.message)
        rescue ArgumentError => e
          # Test for special case where there is whitespace between sign and number
          match = Patterns::WS_BETWEEN_SIGN_AND_NUMBER.match(from)
          if match
            begin
              # Try again, this time with whitespace removed
              return from_args(match[1] + match[2], radix)
            rescue TypeConversionError
              # Ignored to retain original error
            end
          end
          raise TypeConversionError.new(e.message)
        end
      else
        t = Puppet::Pops::Types::TypeCalculator.singleton.infer(from).generalize
        raise TypeConversionError.new("Value of type '#{t}' cannot be converted to an Integer")
      end
    end

    def assert_radix(radix)
      case radix
      when 2, 8, 10, 16, :default
      else
        raise ArgumentError.new("Illegal radix: '#{radix}', expected 2, 8, 10, 16, or default")
      end
      radix
    end

  end
end

#range ⇒ Object

Returns the range as an array ordered so the smaller number is always first. The number may be Infinity or -Infinity.



982
983
984
 
# File 'lib/puppet/pops/types/types.rb', line 982

def range
  [@from, @to]
end

#size ⇒ Object

Returns Float.Infinity if one end of the range is unbound



975
976
977
978
 
# File 'lib/puppet/pops/types/types.rb', line 975

def size
  return Float::INFINITY if @from == -Float::INFINITY || @to == Float::INFINITY
  1+(to-from).abs
end

#to_size ⇒ PIntegerType

Returns a range where both to and from are positive numbers. Negative numbers are converted to zero

Returns:



996
997
998
 
# File 'lib/puppet/pops/types/types.rb', line 996

def to_size
  @from >= 0 ? self : PIntegerType.new(0, @to < 0 ? 0 : @to)
end