sorbet-runtime 0.5.5841

data/lib/types/utils.rb

@@ -0,0 +1,217 @@
+# frozen_string_literal: true
+# typed: true
+
+module T::Utils
+  # Used to convert from a type specification to a `T::Types::Base`.
+  def self.coerce(val)
+    if val.is_a?(T::Private::Types::TypeAlias)
+      val.aliased_type
+    elsif val.is_a?(T::Types::Base)
+      val
+    elsif val == ::Array
+      T::Array[T.untyped]
+    elsif val == ::Set
+      T::Set[T.untyped]
+    elsif val == ::Hash
+      T::Hash[T.untyped, T.untyped]
+    elsif val == ::Enumerable
+      T::Enumerable[T.untyped]
+    elsif val == ::Enumerator
+      T::Enumerator[T.untyped]
+    elsif val == ::Range
+      T::Range[T.untyped]
+    elsif val.is_a?(Module)
+      T::Types::Simple.new(val) # rubocop:disable PrisonGuard/UseOpusTypesShortcut
+    elsif val.is_a?(::Array)
+      T::Types::FixedArray.new(val) # rubocop:disable PrisonGuard/UseOpusTypesShortcut
+    elsif val.is_a?(::Hash)
+      T::Types::FixedHash.new(val) # rubocop:disable PrisonGuard/UseOpusTypesShortcut
+    elsif val.is_a?(T::Private::Methods::DeclBuilder)
+      T::Private::Methods.finalize_proc(val.decl)
+    elsif val.is_a?(::T::Enum)
+      T::Types::TEnum.new(val) # rubocop:disable PrisonGuard/UseOpusTypesShortcut
+    elsif val.is_a?(::String)
+      raise "Invalid String literal for type constraint. Must be an #{T::Types::Base}, a " \
+            "class/module, or an array. Got a String with value `#{val}`."
+    else
+      raise "Invalid value for type constraint. Must be an #{T::Types::Base}, a " \
+            "class/module, or an array. Got a `#{val.class}`."
+    end
+  end
+
+  # Returns the set of all methods (public, protected, private) defined on a module or its
+  # ancestors, excluding Object and its ancestors. Overrides of methods from Object (and its
+  # ancestors) are included.
+  def self.methods_excluding_object(mod)
+    # We can't just do mod.instance_methods - Object.instance_methods, because that would leave out
+    # any methods from Object that are overridden in mod.
+    mod.ancestors.flat_map do |ancestor|
+      # equivalent to checking Object.ancestors.include?(ancestor)
+      next [] if Object <= ancestor
+      ancestor.instance_methods(false) + ancestor.private_instance_methods(false)
+    end.uniq
+  end
+
+  # Associates a signature with a forwarder method that matches the signature of the method it
+  # forwards to. This is necessary because forwarder methods are often declared with catch-all
+  # splat parameters, rather than the exact set of parameters ultimately used by the target method,
+  # so they cannot be validated as strictly.
+  #
+  # The caller of this method must ensure that the forwarder method properly forwards all parameters
+  # such that the signature is accurate.
+  def self.register_forwarder(from_method, to_method, remove_first_param: false)
+    T::Private::Methods.register_forwarder(
+      from_method, to_method, remove_first_param: remove_first_param
+    )
+  end
+
+  # Returns the signature for the instance method on the supplied module, or nil if it's not found or not typed.
+  #
+  # @example T::Utils.signature_for_instance_method(MyClass, :my_method)
+  def self.signature_for_instance_method(mod, method_name)
+    T::Private::Methods.signature_for_method(mod.instance_method(method_name))
+  end
+
+  def self.wrap_method_with_call_validation_if_needed(mod, method_sig, original_method)
+    T::Private::Methods::CallValidation.wrap_method_if_needed(mod, method_sig, original_method)
+  end
+
+  # Unwraps all the sigs.
+  def self.run_all_sig_blocks
+    T::Private::Methods.run_all_sig_blocks
+  end
+
+  # Return the underlying type for a type alias. Otherwise returns type.
+  def self.resolve_alias(type)
+    case type
+    when T::Private::Types::TypeAlias
+      type.aliased_type
+    else
+      type
+    end
+  end
+
+  # Give a type which is a subclass of T::Types::Base, determines if the type is a simple nilable type (union of NilClass and something else).
+  # If so, returns the T::Types::Base of the something else. Otherwise, returns nil.
+  def self.unwrap_nilable(type)
+    case type
+    when T::Types::Union
+      non_nil_types = type.types.reject {|t| t == Nilable::NIL_TYPE}
+      if non_nil_types.length == 1
+        non_nil_types.first
+      else
+        nil
+      end
+    else
+      nil
+    end
+  end
+
+  # Returns the arity of a method, unwrapping the sig if needed
+  def self.arity(method)
+    arity = method.arity # rubocop:disable PrisonGuard/NoArity
+    return arity if arity != -1 || method.is_a?(Proc)
+    sig = T::Private::Methods.signature_for_method(method)
+    sig ? sig.method.arity : arity # rubocop:disable PrisonGuard/NoArity
+  end
+
+  # Elide the middle of a string as needed and replace it with an ellipsis.
+  # Keep the given number of characters at the start and end of the string.
+  #
+  # This method operates on string length, not byte length.
+  #
+  # If the string is shorter than the requested truncation length, return it
+  # without adding an ellipsis. This method may return a longer string than
+  # the original if the characters removed are shorter than the ellipsis.
+  #
+  # @param [String] str
+  #
+  # @param [Fixnum] start_len The length of string before the ellipsis
+  # @param [Fixnum] end_len The length of string after the ellipsis
+  #
+  # @param [String] ellipsis The string to add in place of the elided text
+  #
+  # @return [String]
+  #
+  def self.string_truncate_middle(str, start_len, end_len, ellipsis='...')
+    return unless str
+
+    raise ArgumentError.new('must provide start_len') unless start_len
+    raise ArgumentError.new('must provide end_len') unless end_len
+
+    raise ArgumentError.new('start_len must be >= 0') if start_len < 0
+    raise ArgumentError.new('end_len must be >= 0') if end_len < 0
+
+    str = str.to_s
+    return str if str.length <= start_len + end_len
+
+    start_part = str[0...start_len - ellipsis.length]
+    end_part = end_len == 0 ? '' : str[-end_len..-1]
+
+    "#{start_part}#{ellipsis}#{end_part}"
+  end
+
+  def self.lift_enum(enum)
+    unless enum.is_a?(T::Types::Enum)
+      raise ArgumentError.new("#{enum.inspect} is not a T.enum")
+    end
+
+    classes = enum.values.map(&:class).uniq
+    if classes.empty?
+      T.untyped
+    elsif classes.length > 1
+      T::Types::Union.new(classes)
+    else
+      T::Types::Simple.new(classes.first)
+    end
+  end
+
+  module Nilable
+    # :is_union_type, T::Boolean: whether the type is an T::Types::Union type
+    # :non_nilable_type, Class: if it is an T.nilable type, the corresponding underlying type; otherwise, nil.
+    TypeInfo = Struct.new(:is_union_type, :non_nilable_type)
+
+    NIL_TYPE = T::Utils.coerce(NilClass)
+
+    def self.get_type_info(prop_type)
+      if prop_type.is_a?(T::Types::Union)
+        non_nilable_type = T::Utils.unwrap_nilable(prop_type)
+        if non_nilable_type && non_nilable_type.is_a?(T::Types::Simple)
+          non_nilable_type = non_nilable_type.raw_type
+        end
+        TypeInfo.new(true, non_nilable_type)
+      else
+        TypeInfo.new(false, nil)
+      end
+    end
+
+    # Get the underlying type inside prop_type:
+    #  - if the type is A, the function returns A
+    #  - if the type is T.nilable(A), the function returns A
+    def self.get_underlying_type(prop_type)
+      type_info = get_type_info(prop_type)
+      if type_info.is_union_type
+        type_info.non_nilable_type || prop_type
+      elsif prop_type.is_a?(T::Types::Simple)
+        prop_type.raw_type
+      else
+        prop_type
+      end
+    end
+
+    # The difference between this function and the above function is that the Sorbet type, like T::Types::Simple
+    # is preserved.
+    def self.get_underlying_type_object(prop_type)
+      T::Utils.unwrap_nilable(prop_type) || prop_type
+    end
+
+    def self.is_union_with_nilclass(prop_type)
+      case prop_type
+      when T::Types::Union
+        prop_type.types.include?(NIL_TYPE)
+      else
+        false
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,223 @@
+--- !ruby/object:Gem::Specification
+name: sorbet-runtime
+version: !ruby/object:Gem::Version
+  version: 0.5.5841
+platform: ruby
+authors:
+- Stripe
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-07-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.11'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.5
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+description: Sorbet's runtime type checking component
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/sorbet-runtime.rb
+- lib/types/_types.rb
+- lib/types/abstract_utils.rb
+- lib/types/boolean.rb
+- lib/types/compatibility_patches.rb
+- lib/types/configuration.rb
+- lib/types/enum.rb
+- lib/types/generic.rb
+- lib/types/helpers.rb
+- lib/types/interface_wrapper.rb
+- lib/types/non_forcing_constants.rb
+- lib/types/private/abstract/data.rb
+- lib/types/private/abstract/declare.rb
+- lib/types/private/abstract/hooks.rb
+- lib/types/private/abstract/validate.rb
+- lib/types/private/casts.rb
+- lib/types/private/class_utils.rb
+- lib/types/private/decl_state.rb
+- lib/types/private/final.rb
+- lib/types/private/methods/_methods.rb
+- lib/types/private/methods/call_validation.rb
+- lib/types/private/methods/decl_builder.rb
+- lib/types/private/methods/modes.rb
+- lib/types/private/methods/signature.rb
+- lib/types/private/methods/signature_validation.rb
+- lib/types/private/mixins/mixins.rb
+- lib/types/private/retry.rb
+- lib/types/private/runtime_levels.rb
+- lib/types/private/sealed.rb
+- lib/types/private/types/not_typed.rb
+- lib/types/private/types/string_holder.rb
+- lib/types/private/types/type_alias.rb
+- lib/types/private/types/void.rb
+- lib/types/profile.rb
+- lib/types/props/_props.rb
+- lib/types/props/constructor.rb
+- lib/types/props/custom_type.rb
+- lib/types/props/decorator.rb
+- lib/types/props/errors.rb
+- lib/types/props/generated_code_validation.rb
+- lib/types/props/has_lazily_specialized_methods.rb
+- lib/types/props/optional.rb
+- lib/types/props/plugin.rb
+- lib/types/props/pretty_printable.rb
+- lib/types/props/private/apply_default.rb
+- lib/types/props/private/deserializer_generator.rb
+- lib/types/props/private/parser.rb
+- lib/types/props/private/serde_transform.rb
+- lib/types/props/private/serializer_generator.rb
+- lib/types/props/private/setter_factory.rb
+- lib/types/props/serializable.rb
+- lib/types/props/type_validation.rb
+- lib/types/props/utils.rb
+- lib/types/props/weak_constructor.rb
+- lib/types/runtime_profiled.rb
+- lib/types/sig.rb
+- lib/types/struct.rb
+- lib/types/types/attached_class.rb
+- lib/types/types/base.rb
+- lib/types/types/class_of.rb
+- lib/types/types/enum.rb
+- lib/types/types/fixed_array.rb
+- lib/types/types/fixed_hash.rb
+- lib/types/types/intersection.rb
+- lib/types/types/noreturn.rb
+- lib/types/types/proc.rb
+- lib/types/types/self_type.rb
+- lib/types/types/simple.rb
+- lib/types/types/t_enum.rb
+- lib/types/types/type_member.rb
+- lib/types/types/type_parameter.rb
+- lib/types/types/type_template.rb
+- lib/types/types/type_variable.rb
+- lib/types/types/typed_array.rb
+- lib/types/types/typed_enumerable.rb
+- lib/types/types/typed_enumerator.rb
+- lib/types/types/typed_hash.rb
+- lib/types/types/typed_range.rb
+- lib/types/types/typed_set.rb
+- lib/types/types/union.rb
+- lib/types/types/untyped.rb
+- lib/types/utils.rb
+homepage: https://sorbet.run
+licenses:
+- Apache-2.0
+metadata:
+  source_code_uri: https://github.com/sorbet/sorbet
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Sorbet runtime
+test_files: []