Class: RBS::Types::Function

Inherits:
Object
  • Object
show all
Defined in:
lib/rbs/types.rb

Defined Under Namespace

Classes: Param

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(required_positionals:, optional_positionals:, rest_positionals:, trailing_positionals:, required_keywords:, optional_keywords:, rest_keywords:, return_type:) ⇒ Function

Returns a new instance of Function.



714
715
716
717
718
719
720
721
722
723
 
# File 'lib/rbs/types.rb', line 714

def initialize(required_positionals:, optional_positionals:, rest_positionals:, trailing_positionals:, required_keywords:, optional_keywords:, rest_keywords:, return_type:)
  @return_type = return_type
  @required_positionals = required_positionals
  @optional_positionals = optional_positionals
  @rest_positionals = rest_positionals
  @trailing_positionals = trailing_positionals
  @required_keywords = required_keywords
  @optional_keywords = optional_keywords
  @rest_keywords = rest_keywords
end

Instance Attribute Details

#optional_keywords ⇒ Object (readonly)

Returns the value of attribute optional_keywords.



710
711
712
 
# File 'lib/rbs/types.rb', line 710

def optional_keywords
  @optional_keywords
end

#optional_positionals ⇒ Object (readonly)

Returns the value of attribute optional_positionals.



706
707
708
 
# File 'lib/rbs/types.rb', line 706

def optional_positionals
  @optional_positionals
end

#required_keywords ⇒ Object (readonly)

Returns the value of attribute required_keywords.



709
710
711
 
# File 'lib/rbs/types.rb', line 709

def required_keywords
  @required_keywords
end

#required_positionals ⇒ Object (readonly)

Returns the value of attribute required_positionals.



705
706
707
 
# File 'lib/rbs/types.rb', line 705

def required_positionals
  @required_positionals
end

#rest_keywords ⇒ Object (readonly)

Returns the value of attribute rest_keywords.



711
712
713
 
# File 'lib/rbs/types.rb', line 711

def rest_keywords
  @rest_keywords
end

#rest_positionals ⇒ Object (readonly)

Returns the value of attribute rest_positionals.



707
708
709
 
# File 'lib/rbs/types.rb', line 707

def rest_positionals
  @rest_positionals
end

#return_type ⇒ Object (readonly)

Returns the value of attribute return_type.



712
713
714
 
# File 'lib/rbs/types.rb', line 712

def return_type
  @return_type
end

#trailing_positionals ⇒ Object (readonly)

Returns the value of attribute trailing_positionals.



708
709
710
 
# File 'lib/rbs/types.rb', line 708

def trailing_positionals
  @trailing_positionals
end

Class Method Details

.empty(return_type) ⇒ Object 



848
849
850
851
852
853
854
855
856
857
858
859
 
# File 'lib/rbs/types.rb', line 848

def self.empty(return_type)
  Function.new(
    required_positionals: [],
    optional_positionals: [],
    rest_positionals: nil,
    trailing_positionals: [],
    required_keywords: {},
    optional_keywords: {},
    rest_keywords: nil,
    return_type: return_type
  )
end

Instance Method Details

#==(other) ⇒ Object Also known as: eql? 



725
726
727
728
729
730
731
732
733
734
735
 
# File 'lib/rbs/types.rb', line 725

def ==(other)
  other.is_a?(Function) &&
    other.required_positionals == required_positionals &&
    other.optional_positionals == optional_positionals &&
    other.rest_positionals == rest_positionals &&
    other.trailing_positionals == trailing_positionals &&
    other.required_keywords == required_keywords &&
    other.optional_keywords == optional_keywords &&
    other.rest_keywords == rest_keywords &&
    other.return_type == return_type
end

#drop_head ⇒ Object 



917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
 
# File 'lib/rbs/types.rb', line 917

def drop_head
  case
  when !required_positionals.empty?
    [
      required_positionals[0],
      update(required_positionals: required_positionals.drop(1))
    ]
  when !optional_positionals.empty?
    [
      optional_positionals[0],
      update(optional_positionals: optional_positionals.drop(1))
    ]
  else
    raise "Cannot #drop_head"
  end
end

#drop_tail ⇒ Object 



934
935
936
937
938
939
940
941
942
943
944
945
 
# File 'lib/rbs/types.rb', line 934

def drop_tail
  case
  when !trailing_positionals.empty?
    last = trailing_positionals.last or raise
    [
      last,
      update(trailing_positionals: trailing_positionals.take(trailing_positionals.size - 1))
    ]
  else
    raise "Cannot #drop_tail"
  end
end

#each_param(&block) ⇒ Object 



817
818
819
820
821
822
823
824
825
826
827
828
829
 
# File 'lib/rbs/types.rb', line 817

def each_param(&block)
  if block
    required_positionals.each(&block)
    optional_positionals.each(&block)
    rest_positionals&.yield_self(&block)
    trailing_positionals.each(&block)
    required_keywords.each_value(&block)
    optional_keywords.each_value(&block)
    rest_keywords&.yield_self(&block)
  else
    enum_for :each_param
  end
end

#each_type ⇒ Object 



802
803
804
805
806
807
808
809
810
811
812
813
814
815
 
# File 'lib/rbs/types.rb', line 802

def each_type
  if block_given?
    required_positionals.each {|param| yield param.type }
    optional_positionals.each {|param| yield param.type }
    rest_positionals&.yield_self {|param| yield param.type }
    trailing_positionals.each {|param| yield param.type }
    required_keywords.each_value {|param| yield param.type }
    optional_keywords.each_value {|param| yield param.type }
    rest_keywords&.yield_self {|param| yield param.type }
    yield(return_type)
  else
    enum_for :each_type
  end
end

#empty? ⇒ Boolean

Returns:

  • (Boolean) 


888
889
890
891
892
893
894
895
896
 
# File 'lib/rbs/types.rb', line 888

def empty?
  required_positionals.empty? &&
    optional_positionals.empty? &&
    !rest_positionals &&
    trailing_positionals.empty? &&
    required_keywords.empty? &&
    optional_keywords.empty? &&
    !rest_keywords
end

#free_variables(set = Set.new) ⇒ Object 



751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
 
# File 'lib/rbs/types.rb', line 751

def free_variables(set = Set.new)
  set.tap do
    required_positionals.each do |param|
      param.type.free_variables(set)
    end
    optional_positionals.each do |param|
      param.type.free_variables(set)
    end
    rest_positionals&.yield_self do |param|
      param.type.free_variables(set)
    end
    trailing_positionals.each do |param|
      param.type.free_variables(set)
    end
    required_keywords.each_value do |param|
      param.type.free_variables(set)
    end
    optional_keywords.each_value do |param|
      param.type.free_variables(set)
    end
    rest_keywords&.yield_self do |param|
      param.type.free_variables(set)
    end

    return_type.free_variables(set)
  end
end

#has_keyword? ⇒ Boolean

Returns:

  • (Boolean) 


947
948
949
950
951
952
953
 
# File 'lib/rbs/types.rb', line 947

def has_keyword?
  if !required_keywords.empty? || !optional_keywords.empty? || rest_keywords
    true
  else
    false
  end
end

#hash ⇒ Object 



739
740
741
742
743
744
745
746
747
748
749
 
# File 'lib/rbs/types.rb', line 739

def hash
  self.class.hash ^
    required_positionals.hash ^
    optional_positionals.hash ^
    rest_positionals.hash ^
    trailing_positionals.hash ^
    required_keywords.hash ^
    optional_keywords.hash ^
    rest_keywords.hash ^
    return_type.hash
end

#map_type(&block) ⇒ Object 



779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
 
# File 'lib/rbs/types.rb', line 779

def map_type(&block)
  if block
    Function.new(
      required_positionals: required_positionals.map {|param| param.map_type(&block) },
      optional_positionals: optional_positionals.map {|param| param.map_type(&block) },
      rest_positionals: rest_positionals&.yield_self {|param| param.map_type(&block) },
      trailing_positionals: trailing_positionals.map {|param| param.map_type(&block) },
      required_keywords: required_keywords.transform_values {|param| param.map_type(&block) },
      optional_keywords: optional_keywords.transform_values {|param| param.map_type(&block) },
      rest_keywords: rest_keywords&.yield_self {|param| param.map_type(&block) },
      return_type: yield(return_type)
    )
  else
    enum_for :map_type
  end
end

#map_type_name(&block) ⇒ Object 



796
797
798
799
800
 
# File 'lib/rbs/types.rb', line 796

def map_type_name(&block)
  map_type do |type|
    type.map_type_name(&block)
  end
end

#param_to_s ⇒ Object 



898
899
900
901
902
903
904
905
906
907
908
909
910
911
 
# File 'lib/rbs/types.rb', line 898

def param_to_s
  # @type var params: Array[String]
  params = []

  params.push(*required_positionals.map(&:to_s))
  params.push(*optional_positionals.map {|p| "?#{p}"})
  params.push("*#{rest_positionals}") if rest_positionals
  params.push(*trailing_positionals.map(&:to_s))
  params.push(*required_keywords.map {|name, param| "#{name}: #{param}" })
  params.push(*optional_keywords.map {|name, param| "?#{name}: #{param}" })
  params.push("**#{rest_keywords}") if rest_keywords

  params.join(", ")
end

#return_to_s ⇒ Object 



913
914
915
 
# File 'lib/rbs/types.rb', line 913

def return_to_s
  return_type.to_s(1)
end

#sub(s) ⇒ Object 



844
845
846
 
# File 'lib/rbs/types.rb', line 844

def sub(s)
  map_type {|ty| ty.sub(s) }
end

#to_json(state = _ = nil) ⇒ Object 



831
832
833
834
835
836
837
838
839
840
841
842
 
# File 'lib/rbs/types.rb', line 831

def to_json(state = _ = nil)
  {
    required_positionals: required_positionals,
    optional_positionals: optional_positionals,
    rest_positionals: rest_positionals,
    trailing_positionals: trailing_positionals,
    required_keywords: required_keywords,
    optional_keywords: optional_keywords,
    rest_keywords: rest_keywords,
    return_type: return_type
  }.to_json(state)
end

#update(required_positionals: self.required_positionals, optional_positionals: self.optional_positionals, rest_positionals: self.rest_positionals, trailing_positionals: self.trailing_positionals, required_keywords: self.required_keywords, optional_keywords: self.optional_keywords, rest_keywords: self.rest_keywords, return_type: self.return_type) ⇒ Object 



874
875
876
877
878
879
880
881
882
883
884
885
886
 
# File 'lib/rbs/types.rb', line 874

def update(required_positionals: self.required_positionals, optional_positionals: self.optional_positionals, rest_positionals: self.rest_positionals, trailing_positionals: self.trailing_positionals,
           required_keywords: self.required_keywords, optional_keywords: self.optional_keywords, rest_keywords: self.rest_keywords, return_type: self.return_type)
  Function.new(
    required_positionals: required_positionals,
    optional_positionals: optional_positionals,
    rest_positionals: rest_positionals,
    trailing_positionals: trailing_positionals,
    required_keywords: required_keywords,
    optional_keywords: optional_keywords,
    rest_keywords: rest_keywords,
    return_type: return_type
  )
end

#with_return_type(type) ⇒ Object 



861
862
863
864
865
866
867
868
869
870
871
872
 
# File 'lib/rbs/types.rb', line 861

def with_return_type(type)
  Function.new(
    required_positionals: required_positionals,
    optional_positionals: optional_positionals,
    rest_positionals: rest_positionals,
    trailing_positionals: trailing_positionals,
    required_keywords: required_keywords,
    optional_keywords: optional_keywords,
    rest_keywords: rest_keywords,
    return_type: type
  )
end