Class: ScalarGalaxy::Internal::Type::ArrayOf Abstract Private

Inherits:
Object
  • Object
show all
Includes:
Converter, Util::SorbetRuntimeSupport
Defined in:
lib/galaxy-ruby/internal/type/array_of.rb,
sig/galaxy-ruby/internal/type/array_of.rbs

Overview

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.

This class is abstract.

Array of items of a given type.

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, to_sorbet_type

Methods included from Converter

coerce, dump, inspect, meta_info, new_coerce_state, type_info

Constructor Details

#initialize(type_info, spec = {}) ⇒ ArrayOf

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.

Returns a new instance of ArrayOf.

Parameters:

  • type_info (Hash{Symbol=>Object}, Proc, ScalarGalaxy::Internal::Type::Converter, Class)
  • spec (Hash{Symbol=>Object}) (defaults to: {}) —

    .

    @option spec [NilClass, TrueClass, FalseClass, Integer, Float, Symbol] :const

    @option spec [Proc] :enum

    @option spec [Proc] :union

    @option spec [Boolean] :"nil?"



145
146
147
148
149
 
# File 'lib/galaxy-ruby/internal/type/array_of.rb', line 145

def initialize(type_info, spec = {})
  @item_type_fn = ScalarGalaxy::Internal::Type::Converter.type_info(type_info || spec)
  @meta = ScalarGalaxy::Internal::Type::Converter.meta_info(type_info, spec)
  @nilable = spec.fetch(:nil?, false)
end

Class Method Details

.[](type_info, spec = {}) ⇒ self

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:

  • type_info (Hash{Symbol=>Object}, Proc, ScalarGalaxy::Internal::Type::Converter, Class)
  • spec (Hash{Symbol=>Object}) —

    .

    @option spec [NilClass, TrueClass, FalseClass, Integer, Float, Symbol] :const

    @option spec [Proc] :enum

    @option spec [Proc] :union

    @option spec [Boolean] :"nil?"

Returns:

  • (self) 


34
 
# File 'lib/galaxy-ruby/internal/type/array_of.rb', line 34

def self.[](...) = new(...)

Instance Method Details

#==(other) ⇒ Boolean

Parameters:

  • other (Object)

Returns:



48
49
50
51
 
# File 'lib/galaxy-ruby/internal/type/array_of.rb', line 48

def ==(other)
  other.is_a?(ScalarGalaxy::Internal::Type::ArrayOf) && other.nilable? == nilable? &&
    other.item_type == item_type
end

#===(other) ⇒ Boolean

Parameters:

  • other (Object)

Returns:



41
 
# File 'lib/galaxy-ruby/internal/type/array_of.rb', line 41

def ===(other) = other.is_a?(Array) && other.all?(item_type)

#coerce(value, state:) ⇒ Array<Object>, 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:

  • value (Array<Object>, Object)
  • state (Hash{Symbol=>Object}) —

    .

    @option state [Boolean] :translate_names

    @option state [Boolean] :strictness

    @option state [HashSymbol=>Object] :exactness

    @option state [Class] :error

    @option state [Integer] :branched

Returns:

  • (Array<Object>, Object) 


75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/galaxy-ruby/internal/type/array_of.rb', line 75

def coerce(value, state:)
  exactness = state.fetch(:exactness)

  unless value.is_a?(Array)
    exactness[:no] += 1
    state[:error] = TypeError.new("#{value.class} can't be coerced into #{Array}")
    return value
  end

  target = item_type
  exactness[:yes] += 1
  value.map do |item|
    case [nilable?, item]
    in [true, nil]
      exactness[:yes] += 1
      nil
    else
      ScalarGalaxy::Internal::Type::Converter.coerce(target, item, state: state)
    end
  end
end

#dump(value, state:) ⇒ Array<Object>, 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:

  • value (Array<Object>, Object)
  • state (Hash{Symbol=>Object}) —

    .

    @option state [Boolean] :can_retry

Returns:

  • (Array<Object>, Object) 


106
107
108
109
110
111
112
113
 
# File 'lib/galaxy-ruby/internal/type/array_of.rb', line 106

def dump(value, state:)
  target = item_type
  if value.is_a?(Array)
    value.map { ScalarGalaxy::Internal::Type::Converter.dump(target, _1, state: state) }
  else
    super
  end
end

#hash ⇒ Integer

Returns:

  • (Integer) 


56
 
# File 'lib/galaxy-ruby/internal/type/array_of.rb', line 56

def hash = [self.class, item_type].hash

#inspect(depth: 0) ⇒ String

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:

  • depth (Integer) (defaults to: 0)
  • depth: (Integer) (defaults to: 0)

Returns:

  • (String) 


156
157
158
159
160
 
# File 'lib/galaxy-ruby/internal/type/array_of.rb', line 156

def inspect(depth: 0)
  items = ScalarGalaxy::Internal::Type::Converter.inspect(item_type, depth: depth.succ)

  "#{self.class}[#{[items, nilable? ? "nil" : nil].compact.join(" | ")}]"
end

#item_type ⇒ generic<Elem>

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.

Returns:

  • (generic<Elem>) 


125
 
# File 'lib/galaxy-ruby/internal/type/array_of.rb', line 125

protected def item_type = @item_type_fn.call

#nilable? ⇒ Boolean

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.

Returns:



130
 
# File 'lib/galaxy-ruby/internal/type/array_of.rb', line 130

protected def nilable? = @nilable

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

Returns:

  • (Object) 


118
119
120
 
# File 'lib/galaxy-ruby/internal/type/array_of.rb', line 118

def to_sorbet_type
  T::Array[ScalarGalaxy::Internal::Util::SorbetRuntimeSupport.to_sorbet_type(item_type)]
end