Class: Puppet::Pops::Types::TypeMismatchDescriber Private

Inherits:
Object
  • Object
show all
Defined in:
lib/puppet/pops/types/type_mismatch_describer.rb

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

Defined Under Namespace

Classes: UnresolvedTypeFinder

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.describe_signatures(closure, signatures, args_tuple) ⇒ 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. 



496
497
498
 
# File 'lib/puppet/pops/types/type_mismatch_describer.rb', line 496

def self.describe_signatures(closure, signatures, args_tuple)
  singleton.describe_signatures(closure, signatures, args_tuple)
end

.singleton ⇒ 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. 



500
501
502
 
# File 'lib/puppet/pops/types/type_mismatch_describer.rb', line 500

def self.singleton
  @singleton ||= new
end

.validate_default_parameter(subject, param_name, param_type, value) ⇒ 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. 



492
493
494
 
# File 'lib/puppet/pops/types/type_mismatch_describer.rb', line 492

def self.validate_default_parameter(subject, param_name, param_type, value)
  singleton.validate_default_parameter(subject, param_name, param_type, value)
end

.validate_parameters(subject, params_struct, given_hash, missing_ok = false) ⇒ 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. 



488
489
490
 
# File 'lib/puppet/pops/types/type_mismatch_describer.rb', line 488

def self.validate_parameters(subject, params_struct, given_hash, missing_ok = false)
  singleton.validate_parameters(subject, params_struct, given_hash, missing_ok)
end

Instance Method Details

#describe(expected, actual, path) ⇒ 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. 



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

def describe(expected, actual, path)
  ures_finder = UnresolvedTypeFinder.new
  expected.accept(ures_finder, nil)
  unresolved = ures_finder.unresolved
  if unresolved
    [UnresolvedTypeReference.new(path, unresolved)]
  else
    internal_describe(expected.normalize, expected, actual, path)
  end
end

#describe_argument_tuple(expected, actual, path) ⇒ 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. 



851
852
853
 
# File 'lib/puppet/pops/types/type_mismatch_describer.rb', line 851

def describe_argument_tuple(expected, actual, path)
  describe_tuple(expected, expected, actual, path, CountMismatch)
end

#describe_mismatch(name, expected, actual, tense = :ignored) ⇒ 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.

Describe a confirmed mismatch using present tense

Parameters:

  • name (String) —

    name of mismatch

  • expected (PAnyType) —

    expected type

  • actual (PAnyType) —

    actual type

  • tense (Symbol) (defaults to: :ignored) —

    deprecated and ignored



537
538
539
540
541
542
543
544
545
546
547
548
 
# File 'lib/puppet/pops/types/type_mismatch_describer.rb', line 537

def describe_mismatch(name, expected, actual, tense = :ignored)
  tense_deprecated unless tense == :ignored
  errors = describe(expected, actual, [SubjectPathElement.new(name)])
  case errors.size
  when 0
    ''
  when 1
    errors[0].format.strip
  else
    errors.map { |error| error.format }.join("\n ")
  end
end

#describe_no_block_arguments(signature, atypes, path, expected_size, actual_size, arg_count) ⇒ 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. 



683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
 
# File 'lib/puppet/pops/types/type_mismatch_describer.rb', line 683

def describe_no_block_arguments(signature, atypes, path, expected_size, actual_size, arg_count)
  # not assignable if the number of types in actual is outside number of types in expected
  if expected_size.assignable?(actual_size)
    etypes = signature.type.param_types.types
    enames = signature.parameter_names
    arg_count.times do |index|
      adx = index >= etypes.size ? etypes.size - 1 : index
      etype = etypes[adx]
      unless etype.assignable?(atypes[index])
        descriptions = describe(etype, atypes[index], path + [ParameterPathElement.new(enames[adx])])
        return descriptions unless descriptions.empty?
      end
    end
    EMPTY_ARRAY
  else
    [CountMismatch.new(path, expected_size, actual_size)]
  end
end

#describe_PAnyType(expected, original, actual, path) ⇒ 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. 



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

def describe_PAnyType(expected, original, actual, path)
  expected.assignable?(actual) ? EMPTY_ARRAY : [TypeMismatch.new(path, original, actual)]
end

#describe_PArrayType(expected, original, actual, path) ⇒ 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. 



759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
 
# File 'lib/puppet/pops/types/type_mismatch_describer.rb', line 759

def describe_PArrayType(expected, original, actual, path)
  descriptions = []
  element_type = expected.element_type || PAnyType::DEFAULT
  if actual.is_a?(PTupleType)
    types = actual.types
    expected_size = expected.size_type || PCollectionType::DEFAULT_SIZE
    actual_size = actual.size_type || PIntegerType.new(types.size, types.size)
    if expected_size.assignable?(actual_size)
      types.each_with_index do |type, idx|
        descriptions.concat(describe(element_type, type, path + [ArrayPathElement.new(idx)])) unless element_type.assignable?(type)
      end
    else
      descriptions << SizeMismatch.new(path, expected_size, actual_size)
    end
  elsif actual.is_a?(PArrayType)
    expected_size = expected.size_type
    actual_size = actual.size_type || PCollectionType::DEFAULT_SIZE
    if expected_size.nil? || expected_size.assignable?(actual_size)
      descriptions << TypeMismatch.new(path, original, PArrayType.new(actual.element_type))
    else
      descriptions << SizeMismatch.new(path, expected_size, actual_size)
    end
  else
    descriptions << TypeMismatch.new(path, original, actual)
  end
  descriptions
end

#describe_PCallableType(expected, original, actual, path) ⇒ 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. 



902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
 
# File 'lib/puppet/pops/types/type_mismatch_describer.rb', line 902

def describe_PCallableType(expected, original, actual, path)
  if actual.is_a?(PCallableType)
    # nil param_types means, any other Callable is assignable
    if expected.param_types.nil? && expected.return_type.nil?
      EMPTY_ARRAY
    else
      # NOTE: these tests are made in reverse as it is calling the callable that is constrained
      # (it's lower bound), not its upper bound
      param_errors = describe_argument_tuple(expected.param_types, actual.param_types, path)
      if param_errors.empty?
        this_return_t = expected.return_type || PAnyType::DEFAULT
        that_return_t = actual.return_type || PAnyType::DEFAULT
        unless this_return_t.assignable?(that_return_t)
          [TypeMismatch.new(path + [ReturnTypeElement.new], this_return_t, that_return_t)]
        else
          # names are ignored, they are just information
          # Blocks must be compatible
          this_block_t = expected.block_type || PUndefType::DEFAULT
          that_block_t = actual.block_type || PUndefType::DEFAULT
          if that_block_t.assignable?(this_block_t)
            EMPTY_ARRAY
          else
            [TypeMismatch.new(path + [BlockPathElement.new], this_block_t, that_block_t)]
          end
        end
      else
        param_errors
      end
    end
  else
    [TypeMismatch.new(path, original, actual)]
  end
end

#describe_PEnumType(expected, original, actual, path) ⇒ 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. 



747
748
749
 
# File 'lib/puppet/pops/types/type_mismatch_describer.rb', line 747

def describe_PEnumType(expected, original, actual, path)
  [PatternMismatch.new(path, original, actual)]
end

#describe_PHashType(expected, original, actual, path) ⇒ 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. 



787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
 
# File 'lib/puppet/pops/types/type_mismatch_describer.rb', line 787

def describe_PHashType(expected, original, actual, path)
  descriptions = []
  key_type = expected.key_type || PAnyType::DEFAULT
  value_type = expected.value_type || PAnyType::DEFAULT
  if actual.is_a?(PStructType)
    elements = actual.elements
    expected_size = expected.size_type || PCollectionType::DEFAULT_SIZE
    actual_size = PIntegerType.new(elements.count { |a| !a.key_type.assignable?(PUndefType::DEFAULT) }, elements.size)
    if expected_size.assignable?(actual_size)
      elements.each do |a|
        descriptions.concat(describe(key_type, a.key_type, path + [EntryKeyPathElement.new(a.name)])) unless key_type.assignable?(a.key_type)
        descriptions.concat(describe(value_type, a.value_type, path + [EntryValuePathElement.new(a.name)])) unless value_type.assignable?(a.value_type)
      end
    else
      descriptions << SizeMismatch.new(path, expected_size, actual_size)
    end
  elsif actual.is_a?(PHashType)
    expected_size = expected.size_type
    actual_size = actual.size_type || PCollectionType::DEFAULT_SIZE
    if expected_size.nil? || expected_size.assignable?(actual_size)
      descriptions << TypeMismatch.new(path, original, PHashType.new(actual.key_type, actual.value_type))
    else
      descriptions << SizeMismatch.new(path, expected_size, actual_size)
    end
  else
    descriptions << TypeMismatch.new(path, original, actual)
  end
  descriptions
end

#describe_POptionalType(expected, original, actual, path) ⇒ 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. 



742
743
744
745
 
# File 'lib/puppet/pops/types/type_mismatch_describer.rb', line 742

def describe_POptionalType(expected, original, actual, path)
  return EMPTY_ARRAY if actual.is_a?(PUndefType)
  internal_describe(expected.optional_type, original.is_a?(PTypeAliasType) ? original : expected, actual, path)
end

#describe_PPatternType(expected, original, actual, path) ⇒ 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. 



751
752
753
 
# File 'lib/puppet/pops/types/type_mismatch_describer.rb', line 751

def describe_PPatternType(expected, original, actual, path)
  [PatternMismatch.new(path, original, actual)]
end

#describe_PStructType(expected, original, actual, path) ⇒ 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. 



817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
 
# File 'lib/puppet/pops/types/type_mismatch_describer.rb', line 817

def describe_PStructType(expected, original, actual, path)
  elements = expected.elements
  descriptions = []
  if actual.is_a?(PStructType)
    h2 = actual.hashed_elements.clone
    elements.each do |e1|
      key = e1.name
      e2 = h2.delete(key)
      if e2.nil?
        descriptions << MissingKey.new(path, key) unless e1.key_type.assignable?(PUndefType::DEFAULT)
      else
        descriptions.concat(describe(e1.key_type, e2.key_type, path + [EntryKeyPathElement.new(key)])) unless e1.key_type.assignable?(e2.key_type)
        descriptions.concat(describe(e1.value_type, e2.value_type, path + [EntryValuePathElement.new(key)])) unless e1.value_type.assignable?(e2.value_type)
      end
    end
    h2.each_key { |key| descriptions << ExtraneousKey.new(path, key) }
  elsif actual.is_a?(PHashType)
    actual_size = actual.size_type || PCollectionType::DEFAULT_SIZE
    expected_size = PIntegerType.new(elements.count { |e| !e.key_type.assignable?(PUndefType::DEFAULT) }, elements.size)
    if expected_size.assignable?(actual_size)
      descriptions << TypeMismatch.new(path, original, PHashType.new(actual.key_type, actual.value_type))
    else
      descriptions << SizeMismatch.new(path, expected_size, actual_size)
    end
  else
    descriptions << TypeMismatch.new(path, original, actual)
  end
  descriptions
end

#describe_PTupleType(expected, original, actual, path) ⇒ 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. 



847
848
849
 
# File 'lib/puppet/pops/types/type_mismatch_describer.rb', line 847

def describe_PTupleType(expected, original, actual, path)
  describe_tuple(expected, original, actual, path, SizeMismatch)
end

#describe_PTypeAliasType(expected, original, actual, path) ⇒ 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. 



755
756
757
 
# File 'lib/puppet/pops/types/type_mismatch_describer.rb', line 755

def describe_PTypeAliasType(expected, original, actual, path)
  internal_describe(expected.resolved_type.normalize, expected, actual, path)
end

#describe_PVariantType(expected, original, actual, path) ⇒ 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. 



702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
 
# File 'lib/puppet/pops/types/type_mismatch_describer.rb', line 702

def describe_PVariantType(expected, original, actual, path)
  variant_descriptions = []
  types = expected.types
  types = [PUndefType::DEFAULT] + types if original.is_a?(POptionalType)
  types.each_with_index do |vt, index|
    d = describe(vt, actual, path + [VariantPathElement.new(index)])
    return EMPTY_ARRAY if d.empty?
    variant_descriptions << d
  end
  descriptions = merge_descriptions(path.length, SizeMismatch, variant_descriptions)
  if original.is_a?(PTypeAliasType) && descriptions.size == 1
    # All variants failed in this alias so we report it as a mismatch on the alias
    # rather than reporting individual failures of the variants
    [TypeMismatch.new(path, original, actual)]
  else
    descriptions
  end
end

#describe_signature_arguments(signature, args_tuple, path) ⇒ 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. 



640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
 
# File 'lib/puppet/pops/types/type_mismatch_describer.rb', line 640

def describe_signature_arguments(signature, args_tuple, path)
  params_tuple = signature.type.param_types
  params_size_t = params_tuple.size_type || TypeFactory.range(*params_tuple.size_range)

  if args_tuple.is_a?(PTupleType)
    arg_types = args_tuple.types
  elsif args_tuple.is_a?(PArrayType)
    arg_types = Array.new(params_tuple.types.size, args_tuple.element_type || PUndefType::DEFAULT)
  else
    return [TypeMismatch.new(path, params_tuple, args_tuple)]
  end

  if arg_types.last.kind_of_callable?
    # Check other arguments
    arg_count = arg_types.size - 1
    describe_no_block_arguments(signature, arg_types, path, params_size_t, TypeFactory.range(arg_count, arg_count), arg_count)
  else
    args_size_t = TypeFactory.range(*args_tuple.size_range)
    describe_no_block_arguments(signature, arg_types, path, params_size_t, args_size_t, arg_types.size)
  end
end

#describe_signature_block(signature, args_tuple, path) ⇒ 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. 



662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
 
# File 'lib/puppet/pops/types/type_mismatch_describer.rb', line 662

def describe_signature_block(signature, args_tuple, path)
  param_block_t = signature.block_type
  arg_block_t = args_tuple.is_a?(PTupleType) ? args_tuple.types.last : nil
  if TypeCalculator.is_kind_of_callable?(arg_block_t)
    # Can't pass a block to a callable that doesn't accept one
    if param_block_t.nil?
      [UnexpectedBlock.new(path)]
    else
      # Check that the block is of the right type
      describe(param_block_t, arg_block_t, path + [BlockPathElement.new])
    end
  else
    # Check that the block is optional
    if param_block_t.nil? || param_block_t.assignable?(PUndefType::DEFAULT)
      EMPTY_ARRAY
    else
      [MissingRequiredBlock.new(path)]
    end
  end
end

#describe_signatures(closure, signatures, args_tuple, tense = :ignored) ⇒ 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. 



596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
 
# File 'lib/puppet/pops/types/type_mismatch_describer.rb', line 596

def describe_signatures(closure, signatures, args_tuple, tense = :ignored)
  tense_deprecated unless tense == :ignored
  error_arrays = []
  signatures.each_with_index do |signature, index|
    error_arrays << describe_signature_arguments(signature, args_tuple, [SignaturePathElement.new(index)])
  end

  # Skip block checks if all signatures have argument errors
  unless error_arrays.all? { |a| !a.empty? }
    block_arrays = []
    signatures.each_with_index do |signature, index|
      block_arrays << describe_signature_block(signature, args_tuple, [SignaturePathElement.new(index)])
    end
    bc_count = block_arrays.count { |a| !a.empty? }
    if bc_count == block_arrays.size
      # Skip argument errors when all alternatives have block errors
      error_arrays = block_arrays
    elsif bc_count > 0
      # Merge errors giving argument errors precedence over block errors
      error_arrays.each_with_index { |a, index| error_arrays[index] = block_arrays[index] if a.empty? }
    end
  end
  return nil if error_arrays.empty?

  label = closure == 'lambda' ? 'block' : "'#{closure}'"
  errors = merge_descriptions(0, CountMismatch, error_arrays)
  if errors.size == 1
    "#{label}#{errors[0].format}"
  else
    if signatures.size == 1
      sig = signatures[0]
      result = ["#{label} expects (#{signature_string(sig)})"]
      result.concat(error_arrays[0].map { |e| "  rejected:#{e.chop_path(0).format}" })
    else
      result = ["#{label} expects one of:"]
      signatures.each_with_index do |sg, index|
        result << "  (#{signature_string(sg)})"
        result.concat(error_arrays[index].map { |e| "    rejected:#{e.chop_path(0).format}" })
      end
    end
    result.join("\n")
  end
end

#describe_struct_signature(params_struct, param_hash, missing_ok = false) ⇒ Array<Mismatch>

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.

Validates that all entries in the param_hash exists in the given param_struct, that their type conforms with the corresponding param_struct element and that all required values are provided. An error message is created for each problem found.

Parameters:

  • params_struct (PStructType) —

    Struct to use for validation

  • param_hash (Hash<String,Object>) —

    The parameters to validate

  • missing_ok (Boolean) (defaults to: false) —

    Do not generate errors on missing parameters

Returns:

  • (Array<Mismatch>) —

    An array of found errors. An empty array indicates no errors.



579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
 
# File 'lib/puppet/pops/types/type_mismatch_describer.rb', line 579

def describe_struct_signature(params_struct, param_hash, missing_ok = false)
  param_type_hash = params_struct.hashed_elements
  result =  param_hash.each_key.reject { |name| param_type_hash.include?(name) }.map { |name| InvalidParameter.new(nil, name) }

  params_struct.elements.each do |elem|
    name = elem.name
    value = param_hash[name]
    value_type = elem.value_type
    if param_hash.include?(name)
      result << describe(value_type, TypeCalculator.singleton.infer_set(value), [ParameterPathElement.new(name)]) unless value_type.instance?(value)
    else
      result << MissingParameter.new(nil, name) unless missing_ok || elem.key_type.is_a?(POptionalType)
    end
  end
  result
end

#describe_tuple(expected, original, actual, path, size_mismatch_class) ⇒ 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. 



855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
 
# File 'lib/puppet/pops/types/type_mismatch_describer.rb', line 855

def describe_tuple(expected, original, actual, path, size_mismatch_class)
  return EMPTY_ARRAY if expected == actual || expected.types.empty? && (actual.is_a?(PArrayType))
  expected_size = expected.size_type || TypeFactory.range(*expected.size_range)

  if actual.is_a?(PTupleType)
    actual_size = actual.size_type || TypeFactory.range(*actual.size_range)

    # not assignable if the number of types in actual is outside number of types in expected
    if expected_size.assignable?(actual_size)
      etypes = expected.types
      descriptions = []
      unless etypes.empty?
        actual.types.each_with_index do |atype, index|
          adx = index >= etypes.size ? etypes.size - 1 : index
          descriptions.concat(describe(etypes[adx], atype, path + [ArrayPathElement.new(adx)]))
        end
      end
      descriptions
    else
      [size_mismatch_class.new(path, expected_size, actual_size)]
    end
  elsif actual.is_a?(PArrayType)
    t2_entry = actual.element_type

    if t2_entry.nil?
      # Array of anything can not be assigned (unless tuple is tuple of anything) - this case
      # was handled at the top of this method.
      #
      [TypeMismatch.new(path, original, actual)]
    else
      expected_size = expected.size_type || TypeFactory.range(*expected.size_range)
      actual_size = actual.size_type || PCollectionType::DEFAULT_SIZE
      if expected_size.assignable?(actual_size)
        descriptions = []
        expected.types.each_with_index do |etype, index|
          descriptions.concat(describe(etype, actual.element_type, path + [ArrayPathElement.new(index)]))
        end
        descriptions
      else
        [size_mismatch_class.new(path, expected_size, actual_size)]
      end
    end
  else
    [TypeMismatch.new(path, original, actual)]
  end
end

#max(a, b) ⇒ 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.

Why oh why Ruby do you not have a standard Math.max ?



1051
1052
1053
 
# File 'lib/puppet/pops/types/type_mismatch_describer.rb', line 1051

def max(a, b)
  a >= b ? a : b
end

#merge_descriptions(varying_path_position, size_mismatch_class, variant_descriptions) ⇒ 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. 



721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
 
# File 'lib/puppet/pops/types/type_mismatch_describer.rb', line 721

def merge_descriptions(varying_path_position, size_mismatch_class, variant_descriptions)
  descriptions = variant_descriptions.flatten
  [size_mismatch_class, MissingRequiredBlock, UnexpectedBlock, TypeMismatch].each do |mismatch_class|
    mismatches = descriptions.select { |desc| desc.is_a?(mismatch_class) }
    if mismatches.size == variant_descriptions.size
      # If they all have the same canonical path, then we can compact this into one
      generic_mismatch = mismatches.inject do |prev, curr|
        break nil unless prev.canonical_path == curr.canonical_path
        prev.merge(prev.path, curr)
      end
      unless generic_mismatch.nil?
        # Report the generic mismatch and skip the rest
        descriptions = [generic_mismatch]
        break
      end
    end
  end
  descriptions = descriptions.uniq
  descriptions.size == 1 ? [descriptions[0].chop_path(varying_path_position)] : descriptions
end

#optional(index, required_count) ⇒ 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. 



1056
1057
1058
1059
 
# File 'lib/puppet/pops/types/type_mismatch_describer.rb', line 1056

def optional(index, required_count)
  count = index + 1
  count > required_count
end

#signature_string(signature) ⇒ 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.

Produces a string for the signature(s)



998
999
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
 
# File 'lib/puppet/pops/types/type_mismatch_describer.rb', line 998

def signature_string(signature)
  param_types = signature.type.param_types
  param_names = signature.parameter_names

  from, to = param_types.size_range
  if from == 0 && to == 0
    # No parameters function
    return ''
  end

  required_count = from
  types =
    case param_types
    when PTupleType
      param_types.types
    when PArrayType
      [param_types.element_type]
    end

  # join type with names (types are always present, names are optional)
  # separate entries with comma
  #
  param_names = Array.new(types.size, '') if param_names.empty?
  limit = param_names.size
  result = param_names.each_with_index.map do |name, index|
    type = types[index] || types[-1]
    indicator = ''
    if to == Float::INFINITY && index == limit - 1
      # Last is a repeated_param.
      indicator = from == param_names.size ? '+' : '*'
    elsif optional(index, required_count)
      indicator = '?'
      type = type.optional_type if type.is_a?(POptionalType)
    end
    "#{type} #{name}#{indicator}"
  end.join(', ')

  # If there is a block, include it
  case signature.type.block_type
  when POptionalType
    result << ', ' unless result == ''
    result << "#{signature.type.block_type.optional_type} #{signature.block_name}?"
  when PCallableType
    result << ', ' unless result == ''
    result << "#{signature.type.block_type} #{signature.block_name}"
  when NilClass
    # nothing
  end
  result
end

#tense_deprecated ⇒ 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. 



504
505
506
 
# File 'lib/puppet/pops/types/type_mismatch_describer.rb', line 504

def tense_deprecated
  Puppet.warn_once('deprecations', 'typemismatch#tense', "Passing a 'tense' argument to the TypeMismatchDescriber is deprecated and ignored. Everything is now reported using present tense")
end

#validate_default_parameter(subject, param_name, param_type, value, tense = :ignored) ⇒ 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.

Parameters:

  • subject (String) —

    string to be prepended to the exception message

  • param_name (String) —

    parameter name

  • param_type (PAnyType) —

    parameter type

  • value (Object) —

    value to be validated against the given type

  • tense (Symbol) (defaults to: :ignored) —

    deprecated and ignored



556
557
558
559
560
561
562
563
564
565
566
567
568
569
 
# File 'lib/puppet/pops/types/type_mismatch_describer.rb', line 556

def validate_default_parameter(subject, param_name, param_type, value, tense = :ignored)
  tense_deprecated unless tense == :ignored
  unless param_type.instance?(value)
    errors = describe(param_type, TypeCalculator.singleton.infer_set(value).generalize, [ParameterPathElement.new(param_name)])
    case errors.size
    when 0
    when 1
      raise Puppet::ParseError.new("#{subject}:#{errors[0].format}")
    else
      errors_str = errors.map { |error| error.format }.join("\n ")
      raise Puppet::ParseError.new("#{subject}:\n #{errors_str}")
    end
  end
end

#validate_parameters(subject, params_struct, given_hash, missing_ok = false, tense = :ignored) ⇒ 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.

Validates that all entries in the give_hash exists in the given param_struct, that their type conforms with the corresponding param_struct element and that all required values are provided.

Parameters:

  • subject (String) —

    string to be prepended to the exception message

  • params_struct (PStructType) —

    Struct to use for validation

  • given_hash (Hash<String,Object>) —

    the parameters to validate

  • missing_ok (Boolean) (defaults to: false) —

    Do not generate errors on missing parameters

  • tense (Symbol) (defaults to: :ignored) —

    deprecated and ignored



517
518
519
520
521
522
523
524
525
526
527
528
 
# File 'lib/puppet/pops/types/type_mismatch_describer.rb', line 517

def validate_parameters(subject, params_struct, given_hash, missing_ok = false, tense = :ignored)
  tense_deprecated unless tense == :ignored
  errors = describe_struct_signature(params_struct, given_hash, missing_ok).flatten
  case errors.size
  when 0
  when 1
    raise Puppet::ParseError.new("#{subject}:#{errors[0].format}")
  else
    errors_str = errors.map { |error| error.format }.join("\n ")
    raise Puppet::ParseError.new("#{subject}:\n #{errors_str}")
  end
end