Class: Puppet::Pops::Types::PStringType

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

Constant Summary collapse

DEFAULT = 
PStringType.new(nil)
NON_EMPTY = 
PStringType.new(PCollectionType::NOT_EMPTY_SIZE)
ITERABLE_TYPE =

Iterates over each character of the string

PIterableType.new(PStringType.new(PIntegerType.new(1,1)))

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from PScalarType

#roundtrip_with_string?

Methods inherited from PAnyType

#==, #assignable?, #callable?, #callable_args?, #callable_with?, #check_self_recursion, create, #create, #kind_of_callable?, #loader, #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 PuppetObject

#_pcore_all_contents, #_pcore_contents, #_pcore_init_hash, #_pcore_type

Constructor Details

#initialize(size_type_or_value, deprecated_multi_args = EMPTY_ARRAY) ⇒ PStringType

Returns a new instance of PStringType.



1427
1428
1429
1430
1431
1432
1433
1434
1435
 
# File 'lib/puppet/pops/types/types.rb', line 1427

def initialize(size_type_or_value, deprecated_multi_args = EMPTY_ARRAY)
  unless deprecated_multi_args.empty?
    if Puppet[:strict] != :off
      Puppet.warn_once('deprecations', "PStringType#initialize_multi_args", "Passing more than one argument to PStringType#initialize is deprecated")
    end
    size_type_or_value = deprecated_multi_args[0]
  end
  @size_type_or_value = size_type_or_value
end

Instance Attribute Details

#size_type_or_value ⇒ Object (readonly) 



1425
1426
1427
 
# File 'lib/puppet/pops/types/types.rb', line 1425

def size_type_or_value
  @size_type_or_value
end

Class Method Details

.new_function(type) ⇒ Object 



1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
 
# File 'lib/puppet/pops/types/types.rb', line 1503

def self.new_function(type)
  @new_function ||= Puppet::Functions.create_loaded_function(:new_string, type.loader) do
    local_types do
      type "Format = Pattern[/#{StringConverter::Format::FMT_PATTERN_STR}/]"
      type 'ContainerFormat = Struct[{
        Optional[format]         => Format,
        Optional[separator]      => String,
        Optional[separator2]     => String,
        Optional[string_formats] => Hash[Type, Format]
      }]'
      type 'TypeMap = Hash[Type, Variant[Format, ContainerFormat]]'
      type 'Convertible = Any'
      type 'Formats = Variant[Default, String[1], TypeMap]'
    end

    dispatch :from_args do
      param           'Convertible',  :from
      optional_param  'Formats',      :string_formats
    end

    def from_args(from, formats = :default)
      StringConverter.singleton.convert(from, formats)
    end
  end
end

.register_ptype(loader, ir) ⇒ Object 



1417
1418
1419
1420
1421
1422
1423
 
# File 'lib/puppet/pops/types/types.rb', line 1417

def self.register_ptype(loader, ir)
  create_ptype(loader, ir, 'ScalarDataType',
    'size_type_or_value' => {
      KEY_TYPE => POptionalType.new(PVariantType.new([PStringType::DEFAULT, PTypeType.new(PIntegerType::DEFAULT)])),
    KEY_VALUE => nil
  })
end

Instance Method Details

#accept(visitor, guard) ⇒ Object 



1437
1438
1439
1440
 
# File 'lib/puppet/pops/types/types.rb', line 1437

def accept(visitor, guard)
  super
  @size_type_or_value.accept(visitor, guard) if @size_type_or_value.is_a?(PIntegerType)
end

#derived_size_type ⇒ Object 



1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
 
# File 'lib/puppet/pops/types/types.rb', line 1492

def derived_size_type
  if @size_type_or_value.is_a?(PIntegerType)
    @size_type_or_value
  elsif @size_type_or_value.is_a?(String)
    sz = @size_type_or_value.size
    PIntegerType.new(sz, sz)
  else
    PCollectionType::DEFAULT_SIZE
  end
end

#eql?(o) ⇒ Boolean

Returns:

  • (Boolean) 


1458
1459
1460
 
# File 'lib/puppet/pops/types/types.rb', line 1458

def eql?(o)
  self.class == o.class && @size_type_or_value == o.size_type_or_value
end

#generalize ⇒ Object 



1442
1443
1444
 
# File 'lib/puppet/pops/types/types.rb', line 1442

def generalize
  DEFAULT
end

#hash ⇒ Object 



1446
1447
1448
 
# File 'lib/puppet/pops/types/types.rb', line 1446

def hash
  @size_type_or_value.hash
end

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

Returns:

  • (Boolean) 


1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
 
# File 'lib/puppet/pops/types/types.rb', line 1462

def instance?(o, guard = nil)
  # true if size compliant
  if o.is_a?(String)
    if @size_type_or_value.is_a?(PIntegerType)
      @size_type_or_value.instance?(o.size, guard)
    else
      @size_type_or_value.nil? ? true : o == value
    end
  else
    false
  end
end

#iterable?(guard = nil) ⇒ Boolean

Returns:

  • (Boolean) 


1450
1451
1452
 
# File 'lib/puppet/pops/types/types.rb', line 1450

def iterable?(guard = nil)
  true
end

#iterable_type(guard = nil) ⇒ Object 



1454
1455
1456
 
# File 'lib/puppet/pops/types/types.rb', line 1454

def iterable_type(guard = nil)
  ITERABLE_TYPE
end

#size_type ⇒ Object 



1488
1489
1490
 
# File 'lib/puppet/pops/types/types.rb', line 1488

def size_type
  @size_type_or_value.is_a?(PIntegerType) ? @size_type_or_value : nil
end

#value ⇒ Object 



1475
1476
1477
 
# File 'lib/puppet/pops/types/types.rb', line 1475

def value
  @size_type_or_value.is_a?(PIntegerType) ? nil : @size_type_or_value
end

#values ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Deprecated. 


1481
1482
1483
1484
1485
1486
 
# File 'lib/puppet/pops/types/types.rb', line 1481

def values
  if Puppet[:strict] != :off
    Puppet.warn_once('deprecations', "PStringType#values", "Method PStringType#values is deprecated. Use #value instead")
  end
  @value.is_a?(String) ? [@value] : EMPTY_ARRAY
end