123456789_123456789_123456789_123456789_123456789_

Class: RBS::Types::Record

Relationships & Source Files
Inherits: Object
Defined in: lib/rbs/types.rb

Class Method Summary

Instance Attribute Summary

Instance Method Summary

Constructor Details

.new(all_fields: nil, fields: nil, location:) ⇒ Record

[ GitHub ] 

  


# File 'lib/rbs/types.rb', line 531



def initialize(all_fields: nil, fields: nil, location:)
  case
  when fields && all_fields.nil?
    @all_fields = fields.transform_values { |v| [v, true] }
    @fields = fields
    @optional_fields = {}
  when all_fields && fields.nil?
    @all_fields = all_fields
    @fields = {}
    @optional_fields = {}
    all_fields.each do |(k, (v, required))|
      if required
        @fields[k] = v
      else
        @optional_fields[k] = v
      end
    end
  else
    raise ArgumentError, "only one of `:fields` or `:all_fields` is required"
  end

  @location = location
end


  







Instance Attribute Details



  

    #all_fields   (readonly)
  

  [ GitHub ]


  

  


# File 'lib/rbs/types.rb', line 528



attr_reader :all_fields, :fields, :optional_fields


  








  

    #fields   (readonly)
  

  [ GitHub ]


  

  


# File 'lib/rbs/types.rb', line 528



attr_reader :all_fields, :fields, :optional_fields


  








  

    #has_classish_type?  ⇒ Boolean  (readonly)
  

  [ GitHub ]


  

  


# File 'lib/rbs/types.rb', line 636



def has_classish_type?
  each_type.any? {|type| type.has_classish_type? }
end


  








  

    #has_self_type?  ⇒ Boolean  (readonly)
  

  [ GitHub ]


  

  


# File 'lib/rbs/types.rb', line 632



def has_self_type?
  each_type.any? {|type| type.has_self_type? }
end


  








  

    #location   (readonly)
  

  [ GitHub ]


  

  


# File 'lib/rbs/types.rb', line 529



attr_reader :location


  








  

    #optional_fields   (readonly)
  

  [ GitHub ]


  

  


# File 'lib/rbs/types.rb', line 528



attr_reader :all_fields, :fields, :optional_fields


  








  

    #with_nonreturn_void?  ⇒ Boolean  (readonly)
  

  [ GitHub ]


  

  


# File 'lib/rbs/types.rb', line 640



def with_nonreturn_void?
  each_type.any? {|type| type.with_nonreturn_void? }
end


  







Instance Method Details



  

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

  [ GitHub ]


  

  


# File 'lib/rbs/types.rb', line 555



def ==(other)
  other.is_a?(Record) && other.fields == fields && other.optional_fields == optional_fields
end


  








  

    #each_type(&block)  
  

  [ GitHub ]


  

  


# File 'lib/rbs/types.rb', line 605



def each_type(&block)
  if block
    fields.each_value(&block)
    optional_fields.each_value(&block)
  else
    enum_for :each_type
  end
end


  








  

    #eql?(other)  
  



  

    

Alias for #==.


  



  [ GitHub ]


  

  


# File 'lib/rbs/types.rb', line 559



alias eql? ==


  








  

    #free_variables(set = Set.new)  
  

  [ GitHub ]


  

  


# File 'lib/rbs/types.rb', line 565



def free_variables(set = Set.new)
  set.tap do
    fields.each_value do |type|
      type.free_variables set
    end
    optional_fields.each_value do |type|
      type.free_variables set
    end
  end
end


  








  

    #hash  
  

  [ GitHub ]


  

  


# File 'lib/rbs/types.rb', line 561



def hash
  self.class.hash ^ all_fields.hash
end


  








  

    #map_type(&block)  
  

  [ GitHub ]


  

  


# File 'lib/rbs/types.rb', line 621



def map_type(&block)
  if block
    Record.new(
      all_fields: all_fields.transform_values {|type, required| [yield(type), required] },
      location: location
    )
  else
    enum_for :map_type
  end
end


  








  

    #map_type_name(&block)  
  

  [ GitHub ]


  

  


# File 'lib/rbs/types.rb', line 614



def map_type_name(&block)
  Record.new(
    all_fields: all_fields.transform_values {|ty, required| [ty.map_type_name(&block), required] },
    location: location
  )
end


  








  

    #sub(s)  
  

  [ GitHub ]


  

  


# File 'lib/rbs/types.rb', line 580



def sub(s)
  return self if s.empty?

  self.class.new(
    all_fields: all_fields.transform_values {|ty, required| [ty.sub(s), required] },
    location: location
  )
end


  








  

    #to_json(state = _ = nil)  
  

  [ GitHub ]


  

  


# File 'lib/rbs/types.rb', line 576



def to_json(state = _ = nil)
  { class: :record, fields: fields, optional_fields: optional_fields, location: location }.to_json(state)
end


  








  

    #to_s(level = 0)  
  

  [ GitHub ]


  

  


# File 'lib/rbs/types.rb', line 589



def to_s(level = 0)
  return "{ }" if all_fields.empty?

  fields = all_fields.map do |key, (type, required)|
    field = if key.is_a?(Symbol) && key.match?(/\A[A-Za-z_][A-Za-z_0-9]*\z/)
      "#{key}: #{type}"
    else
      "#{key.inspect} => #{type}"
    end

    field = "?#{field}" unless required
    field
  end
  "{ #{fields.join(", ")} }"
end