modern_treasury 0.1.0.pre.alpha.18 → 0.1.0.pre.alpha.20

data/lib/modern_treasury/internal/type/converter.rb

@@ -5,6 +5,8 @@ module ModernTreasury
     module Type
       # @api private
       module Converter
+        extend ModernTreasury::Internal::Util::SorbetRuntimeSupport
+
         # rubocop:disable Lint/UnusedMethodArgument
 
         # @api private
@@ -43,7 +45,10 @@ module ModernTreasury
             value.string
           in Pathname | IO
             state[:can_retry] = false if value.is_a?(IO)
-            ModernTreasury::Internal::Util::SerializationAdapter.new(value)
+            ModernTreasury::FilePart.new(value)
+          in ModernTreasury::FilePart
+            state[:can_retry] = false if value.content.is_a?(IO)
+            value
           else
             value
           end
@@ -265,6 +270,22 @@ module ModernTreasury
             end
           end
         end
+
+        define_sorbet_constant!(:Input) do
+          T.type_alias { T.any(ModernTreasury::Internal::Type::Converter, T::Class[T.anything]) }
+        end
+        define_sorbet_constant!(:CoerceState) do
+          T.type_alias do
+            {
+              strictness: T.any(T::Boolean, Symbol),
+              exactness: {yes: Integer, no: Integer, maybe: Integer},
+              branched: Integer
+            }
+          end
+        end
+        define_sorbet_constant!(:DumpState) do
+          T.type_alias { {can_retry: T::Boolean} }
+        end
       end
     end
   end

data/lib/modern_treasury/internal/type/enum.rb

@@ -17,11 +17,11 @@ module ModernTreasury
       # values safely.
       #
       # @example
-      #   # `accounts_type` is a `ModernTreasury::Models::AccountsType`
+      #   # `accounts_type` is a `ModernTreasury::AccountsType`
       #   case accounts_type
-      #   when ModernTreasury::Models::AccountsType::EXTERNAL_ACCOUNTS
+      #   when ModernTreasury::AccountsType::EXTERNAL_ACCOUNTS
       #     # ...
-      #   when ModernTreasury::Models::AccountsType::INTERNAL_ACCOUNTS
+      #   when ModernTreasury::AccountsType::INTERNAL_ACCOUNTS
       #     # ...
       #   else
       #     puts(accounts_type)
@@ -38,22 +38,22 @@ module ModernTreasury
       #   end
       module Enum
         include ModernTreasury::Internal::Type::Converter
+        include ModernTreasury::Internal::Util::SorbetRuntimeSupport
 
         # All of the valid Symbol values for this enum.
         #
         # @return [Array<NilClass, Boolean, Integer, Float, Symbol>]
-        def values = (@values ||= constants.map { const_get(_1) })
+        def values = constants.map { const_get(_1) }
 
-        # @api private
+        # @api public
         #
-        # Guard against thread safety issues by instantiating `@values`.
-        private def finalize! = values
-
         # @param other [Object]
         #
         # @return [Boolean]
         def ===(other) = values.include?(other)
 
+        # @api public
+        #
         # @param other [Object]
         #
         # @return [Boolean]
@@ -63,6 +63,11 @@ module ModernTreasury
           # rubocop:enable Style/CaseEquality
         end
 
+        # @api public
+        #
+        # @return [Integer]
+        def hash = values.to_set.hash
+
         # @api private
         #
         # Unlike with primitives, `Enum` additionally validates that the value is a member
@@ -92,17 +97,28 @@ module ModernTreasury
           end
         end
 
-        # @!parse
-        #   # @api private
-        #   #
-        #   # @param value [Symbol, Object]
-        #   #
-        #   # @param state [Hash{Symbol=>Object}] .
-        #   #
-        #   #   @option state [Boolean] :can_retry
-        #   #
-        #   # @return [Symbol, Object]
-        #   def dump(value, state:) = super
+        # @!method dump(value, state:)
+        #   @api private
+        #
+        #   @param value [Symbol, Object]
+        #
+        #   @param state [Hash{Symbol=>Object}] .
+        #
+        #     @option state [Boolean] :can_retry
+        #
+        #   @return [Symbol, Object]
+
+        # @api private
+        #
+        # @return [Object]
+        def to_sorbet_type
+          case values
+          in []
+            T.noreturn
+          in [value, *_]
+            T.all(ModernTreasury::Internal::Util::SorbetRuntimeSupport.to_sorbet_type(value), self)
+          end
+        end
 
         # @api private
         #

data/lib/modern_treasury/internal/type/{io_like.rb → file_input.rb}

@@ -7,28 +7,36 @@ module ModernTreasury
       #
       # @abstract
       #
-      # Either `Pathname` or `StringIO`.
-      class IOLike
+      # Either `Pathname` or `StringIO`, or `IO`, or
+      # `ModernTreasury::Internal::Type::FileInput`.
+      #
+      # Note: when `IO` is used, all retries are disabled, since many IO` streams are
+      # not rewindable.
+      class FileInput
         extend ModernTreasury::Internal::Type::Converter
 
         private_class_method :new
 
+        # @api public
+        #
         # @param other [Object]
         #
         # @return [Boolean]
         def self.===(other)
           case other
-          in StringIO | Pathname | IO
+          in Pathname | StringIO | IO | String | ModernTreasury::FilePart
             true
           else
             false
           end
         end
 
+        # @api public
+        #
         # @param other [Object]
         #
         # @return [Boolean]
-        def self.==(other) = other.is_a?(Class) && other <= ModernTreasury::Internal::Type::IOLike
+        def self.==(other) = other.is_a?(Class) && other <= ModernTreasury::Internal::Type::FileInput
 
         class << self
           # @api private
@@ -59,17 +67,35 @@ module ModernTreasury
             end
           end
 
-          # @!parse
-          #   # @api private
-          #   #
-          #   # @param value [Pathname, StringIO, IO, String, Object]
-          #   #
-          #   # @param state [Hash{Symbol=>Object}] .
-          #   #
-          #   #   @option state [Boolean] :can_retry
-          #   #
-          #   # @return [Pathname, StringIO, IO, String, Object]
-          #   def dump(value, state:) = super
+          # @api private
+          #
+          # @param value [Pathname, StringIO, IO, String, Object]
+          #
+          # @param state [Hash{Symbol=>Object}] .
+          #
+          #   @option state [Boolean] :can_retry
+          #
+          # @return [Pathname, StringIO, IO, String, Object]
+          def dump(value, state:)
+            # rubocop:disable Lint/DuplicateBranch
+            case value
+            in IO
+              state[:can_retry] = false
+            in ModernTreasury::FilePart if value.content.is_a?(IO)
+              state[:can_retry] = false
+            else
+            end
+            # rubocop:enable Lint/DuplicateBranch
+
+            value
+          end
+
+          # @api private
+          #
+          # @return [Object]
+          def to_sorbet_type
+            T.any(Pathname, StringIO, IO, String, ModernTreasury::FilePart)
+          end
         end
       end
     end

data/lib/modern_treasury/internal/type/hash_of.rb

@@ -12,6 +12,7 @@ module ModernTreasury
       # Hash of items of a given type.
       class HashOf
         include ModernTreasury::Internal::Type::Converter
+        include ModernTreasury::Internal::Util::SorbetRuntimeSupport
 
         private_class_method :new
 
@@ -28,8 +29,12 @@ module ModernTreasury
         #   @option spec [Proc] :union
         #
         #   @option spec [Boolean] :"nil?"
+        #
+        # @return [self]
         def self.[](...) = new(...)
 
+        # @api public
+        #
         # @param other [Object]
         #
         # @return [Boolean]
@@ -50,6 +55,8 @@ module ModernTreasury
           end
         end
 
+        # @api public
+        #
         # @param other [Object]
         #
         # @return [Boolean]
@@ -59,6 +66,11 @@ module ModernTreasury
           # rubocop:enable Layout/LineLength
         end
 
+        # @api public
+        #
+        # @return [Integer]
+        def hash = [self.class, item_type].hash
+
         # @api private
         #
         # @param value [Hash{Object=>Object}, Object]
@@ -119,6 +131,13 @@ module ModernTreasury
           end
         end
 
+        # @api private
+        #
+        # @return [Object]
+        def to_sorbet_type
+          T::Hash[ModernTreasury::Internal::Util::SorbetRuntimeSupport.to_sorbet_type(item_type)]
+        end
+
         # @api private
         #
         # @return [generic<Elem>]

data/lib/modern_treasury/internal/type/request_parameters.rb

@@ -5,16 +5,15 @@ module ModernTreasury
     module Type
       # @api private
       module RequestParameters
-        # @!parse
-        #   # Options to specify HTTP behaviour for this request.
-        #   # @return [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
-        #   attr_accessor :request_options
+        # @!attribute request_options
+        # Options to specify HTTP behaviour for this request.
+        #
+        #   @return [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
 
         # @param mod [Module]
         def self.included(mod)
-          return unless mod <= ModernTreasury::Internal::Type::BaseModel
+          raise ArgumentError.new(mod) unless mod <= ModernTreasury::Internal::Type::BaseModel
 
-          mod.extend(ModernTreasury::Internal::Type::RequestParameters::Converter)
           mod.optional(:request_options, ModernTreasury::RequestOptions)
         end
 
@@ -29,14 +28,8 @@ module ModernTreasury
             state = {can_retry: true}
             case (dumped = dump(params, state: state))
             in Hash
-              options = ModernTreasury::Internal::Util.coerce_hash(dumped[:request_options])
-              request_options =
-                case [options, state.fetch(:can_retry)]
-                in [Hash | nil, false]
-                  {**options.to_h, max_retries: 0}
-                else
-                  options
-                end
+              options = ModernTreasury::Internal::Util.coerce_hash!(dumped[:request_options]).to_h
+              request_options = state.fetch(:can_retry) ? options : {**options, max_retries: 0}
               [dumped.except(:request_options), request_options]
             else
               [dumped, nil]

data/lib/modern_treasury/internal/type/union.rb

@@ -8,7 +8,7 @@ module ModernTreasury
       # @example
       #   # `external_account_verify_response` is a `ModernTreasury::Models::ExternalAccountVerifyResponse`
       #   case external_account_verify_response
-      #   when ModernTreasury::Models::ExternalAccount
+      #   when ModernTreasury::ExternalAccount
       #     puts(external_account_verify_response.id)
       #   when ModernTreasury::Models::ExternalAccountVerifyResponse::ExternalAccountVerificationAttempt
       #     puts(external_account_verify_response.created_at)
@@ -17,6 +17,7 @@ module ModernTreasury
       #   end
       module Union
         include ModernTreasury::Internal::Type::Converter
+        include ModernTreasury::Internal::Util::SorbetRuntimeSupport
 
         # @api private
         #
@@ -29,7 +30,7 @@ module ModernTreasury
         #
         # @return [Array<Array(Symbol, Object)>]
         protected def derefed_variants
-          @known_variants.map { |key, variant_fn| [key, variant_fn.call] }
+          known_variants.map { |key, variant_fn| [key, variant_fn.call] }
         end
 
         # All of the specified variants for this union.
@@ -98,6 +99,8 @@ module ModernTreasury
         # rubocop:disable Style/HashEachMethods
         # rubocop:disable Style/CaseEquality
 
+        # @api public
+        #
         # @param other [Object]
         #
         # @return [Boolean]
@@ -107,6 +110,8 @@ module ModernTreasury
           end
         end
 
+        # @api public
+        #
         # @param other [Object]
         #
         # @return [Boolean]
@@ -114,6 +119,11 @@ module ModernTreasury
           ModernTreasury::Internal::Type::Union === other && other.derefed_variants == derefed_variants
         end
 
+        # @api public
+        #
+        # @return [Integer]
+        def hash = variants.hash
+
         # @api private
         #
         # @param value [Object]
@@ -198,6 +208,18 @@ module ModernTreasury
           super
         end
 
+        # @api private
+        #
+        # @return [Object]
+        def to_sorbet_type
+          case (v = variants)
+          in []
+            T.noreturn
+          else
+            T.any(*v.map { ModernTreasury::Internal::Util::SorbetRuntimeSupport.to_sorbet_type(_1) })
+          end
+        end
+
         # rubocop:enable Style/CaseEquality
         # rubocop:enable Style/HashEachMethods
 

data/lib/modern_treasury/internal/type/unknown.rb

@@ -10,16 +10,21 @@ module ModernTreasury
       # When we don't know what to expect for the value.
       class Unknown
         extend ModernTreasury::Internal::Type::Converter
+        extend ModernTreasury::Internal::Util::SorbetRuntimeSupport
 
         # rubocop:disable Lint/UnusedMethodArgument
 
         private_class_method :new
 
+        # @api public
+        #
         # @param other [Object]
         #
         # @return [Boolean]
         def self.===(other) = true
 
+        # @api public
+        #
         # @param other [Object]
         #
         # @return [Boolean]
@@ -44,17 +49,23 @@ module ModernTreasury
             value
           end
 
-          # @!parse
-          #   # @api private
-          #   #
-          #   # @param value [Object]
-          #   #
-          #   # @param state [Hash{Symbol=>Object}] .
-          #   #
-          #   #   @option state [Boolean] :can_retry
-          #   #
-          #   # @return [Object]
-          #   def dump(value, state:) = super
+          # @!method dump(value, state:)
+          #   @api private
+          #
+          #   @param value [Object]
+          #
+          #   @param state [Hash{Symbol=>Object}] .
+          #
+          #     @option state [Boolean] :can_retry
+          #
+          #   @return [Object]
+
+          # @api private
+          #
+          # @return [Object]
+          def to_sorbet_type
+            T.anything
+          end
         end
 
         # rubocop:enable Lint/UnusedMethodArgument