terminal-shop 2.1.2 → 3.5.0

data/lib/terminal_shop/internal/type/array_of.rb

@@ -0,0 +1,154 @@
+# frozen_string_literal: true
+
+module TerminalShop
+  module Internal
+    module Type
+      # @api private
+      #
+      # @abstract
+      #
+      # @generic Elem
+      #
+      # Array of items of a given type.
+      class ArrayOf
+        include TerminalShop::Internal::Type::Converter
+
+        private_class_method :new
+
+        # @overload [](type_info, spec = {})
+        #
+        # @param type_info [Hash{Symbol=>Object}, Proc, TerminalShop::Internal::Type::Converter, Class]
+        #
+        # @param 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?"
+        #
+        # @return [TerminalShop::Internal::Type::ArrayOf]
+        def self.[](...) = new(...)
+
+        # @api public
+        #
+        # @param other [Object]
+        #
+        # @return [Boolean]
+        def ===(other) = other.is_a?(Array) && other.all?(item_type)
+
+        # @api public
+        #
+        # @param other [Object]
+        #
+        # @return [Boolean]
+        def ==(other)
+          # rubocop:disable Layout/LineLength
+          other.is_a?(TerminalShop::Internal::Type::ArrayOf) && other.nilable? == nilable? && other.item_type == item_type
+          # rubocop:enable Layout/LineLength
+        end
+
+        # @api public
+        #
+        # @return [Integer]
+        def hash = [self.class, item_type].hash
+
+        # @api private
+        #
+        # @param value [Array<Object>, Object]
+        #
+        # @param state [Hash{Symbol=>Object}] .
+        #
+        #   @option state [Boolean, :strong] :strictness
+        #
+        #   @option state [Hash{Symbol=>Object}] :exactness
+        #
+        #   @option state [Integer] :branched
+        #
+        # @return [Array<Object>, Object]
+        def coerce(value, state:)
+          exactness = state.fetch(:exactness)
+
+          unless value.is_a?(Array)
+            exactness[:no] += 1
+            return value
+          end
+
+          target = item_type
+          exactness[:yes] += 1
+          value
+            .map do |item|
+              case [nilable?, item]
+              in [true, nil]
+                exactness[:yes] += 1
+                nil
+              else
+                TerminalShop::Internal::Type::Converter.coerce(target, item, state: state)
+              end
+            end
+        end
+
+        # @api private
+        #
+        # @param value [Array<Object>, Object]
+        #
+        # @param state [Hash{Symbol=>Object}] .
+        #
+        #   @option state [Boolean] :can_retry
+        #
+        # @return [Array<Object>, Object]
+        def dump(value, state:)
+          target = item_type
+          if value.is_a?(Array)
+            value.map do
+              TerminalShop::Internal::Type::Converter.dump(target, _1, state: state)
+            end
+          else
+            super
+          end
+        end
+
+        # @api private
+        #
+        # @return [generic<Elem>]
+        protected def item_type = @item_type_fn.call
+
+        # @api private
+        #
+        # @return [Boolean]
+        protected def nilable? = @nilable
+
+        # @api private
+        #
+        # @param type_info [Hash{Symbol=>Object}, Proc, TerminalShop::Internal::Type::Converter, Class]
+        #
+        # @param 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?"
+        def initialize(type_info, spec = {})
+          @item_type_fn = TerminalShop::Internal::Type::Converter.type_info(type_info || spec)
+          @nilable = spec.fetch(:nil?, false)
+        end
+
+        # @api private
+        #
+        # @param depth [Integer]
+        #
+        # @return [String]
+        def inspect(depth: 0)
+          items = TerminalShop::Internal::Type::Converter.inspect(item_type, depth: depth.succ)
+
+          "#{self.class}[#{[items, nilable? ? 'nil' : nil].compact.join(' | ')}]"
+        end
+      end
+    end
+  end
+end

data/lib/terminal_shop/internal/type/base_model.rb

@@ -0,0 +1,443 @@
+# frozen_string_literal: true
+
+module TerminalShop
+  module Internal
+    module Type
+      # @abstract
+      class BaseModel
+        extend TerminalShop::Internal::Type::Converter
+
+        class << self
+          # @api private
+          #
+          # Assumes superclass fields are totally defined before fields are accessed /
+          # defined on subclasses.
+          #
+          # @return [Hash{Symbol=>Hash{Symbol=>Object}}]
+          def known_fields
+            @known_fields ||= (self < TerminalShop::Internal::Type::BaseModel ? superclass.known_fields.dup : {})
+          end
+
+          # @api private
+          #
+          # @return [Hash{Symbol=>Hash{Symbol=>Object}}]
+          def fields
+            known_fields.transform_values do |field|
+              {**field.except(:type_fn), type: field.fetch(:type_fn).call}
+            end
+          end
+
+          # @api private
+          #
+          # @param name_sym [Symbol]
+          #
+          # @param required [Boolean]
+          #
+          # @param type_info [Hash{Symbol=>Object}, Proc, TerminalShop::Internal::Type::Converter, Class]
+          #
+          # @param 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?"
+          private def add_field(name_sym, required:, type_info:, spec:)
+            type_fn, info =
+              case type_info
+              in Proc | TerminalShop::Internal::Type::Converter | Class
+                [TerminalShop::Internal::Type::Converter.type_info({**spec, union: type_info}), spec]
+              in Hash
+                [TerminalShop::Internal::Type::Converter.type_info(type_info), type_info]
+              end
+
+            setter = "#{name_sym}="
+            api_name = info.fetch(:api_name, name_sym)
+            nilable = info.fetch(:nil?, false)
+            const = if required && !nilable
+              info.fetch(
+                :const,
+                TerminalShop::Internal::OMIT
+              )
+            else
+              TerminalShop::Internal::OMIT
+            end
+
+            [name_sym, setter].each { undef_method(_1) } if known_fields.key?(name_sym)
+
+            known_fields[name_sym] =
+              {
+                mode: @mode,
+                api_name: api_name,
+                required: required,
+                nilable: nilable,
+                const: const,
+                type_fn: type_fn
+              }
+
+            define_method(setter) { @data.store(name_sym, _1) }
+
+            define_method(name_sym) do
+              target = type_fn.call
+              value = @data.fetch(name_sym) { const == TerminalShop::Internal::OMIT ? nil : const }
+              state = {strictness: :strong, exactness: {yes: 0, no: 0, maybe: 0}, branched: 0}
+              if (nilable || !required) && value.nil?
+                nil
+              else
+                TerminalShop::Internal::Type::Converter.coerce(
+                  target, value, state: state
+                )
+              end
+            rescue StandardError => e
+              cls = self.class.name.split("::").last
+              message = [
+                "Failed to parse #{cls}.#{__method__} from #{value.class} to #{target.inspect}.",
+                "To get the unparsed API response, use #{cls}[#{__method__.inspect}].",
+                "Cause: #{e.message}"
+              ].join(" ")
+              raise TerminalShop::Errors::ConversionError.new(message)
+            end
+          end
+
+          # @api private
+          #
+          # @param name_sym [Symbol]
+          #
+          # @param type_info [Hash{Symbol=>Object}, Proc, TerminalShop::Internal::Type::Converter, Class]
+          #
+          # @param 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?"
+          def required(name_sym, type_info, spec = {})
+            add_field(name_sym, required: true, type_info: type_info, spec: spec)
+          end
+
+          # @api private
+          #
+          # @param name_sym [Symbol]
+          #
+          # @param type_info [Hash{Symbol=>Object}, Proc, TerminalShop::Internal::Type::Converter, Class]
+          #
+          # @param 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?"
+          def optional(name_sym, type_info, spec = {})
+            add_field(name_sym, required: false, type_info: type_info, spec: spec)
+          end
+
+          # @api private
+          #
+          # `request_only` attributes not excluded from `.#coerce` when receiving responses
+          # even if well behaved servers should not send them
+          #
+          # @param blk [Proc]
+          private def request_only(&blk)
+            @mode = :dump
+            blk.call
+          ensure
+            @mode = nil
+          end
+
+          # @api private
+          #
+          # `response_only` attributes are omitted from `.#dump` when making requests
+          #
+          # @param blk [Proc]
+          private def response_only(&blk)
+            @mode = :coerce
+            blk.call
+          ensure
+            @mode = nil
+          end
+
+          # @api public
+          #
+          # @param other [Object]
+          #
+          # @return [Boolean]
+          def ==(other)
+            other.is_a?(Class) && other <= TerminalShop::Internal::Type::BaseModel && other.fields == fields
+          end
+
+          # @api public
+          #
+          # @return [Integer]
+          def hash = fields.hash
+        end
+
+        # @api public
+        #
+        # @param other [Object]
+        #
+        # @return [Boolean]
+        def ==(other) = self.class == other.class && @data == other.to_h
+
+        # @api public
+        #
+        # @return [Integer]
+        def hash = [self.class, @data].hash
+
+        class << self
+          # @api private
+          #
+          # @param value [TerminalShop::Internal::Type::BaseModel, Hash{Object=>Object}, Object]
+          #
+          # @param state [Hash{Symbol=>Object}] .
+          #
+          #   @option state [Boolean, :strong] :strictness
+          #
+          #   @option state [Hash{Symbol=>Object}] :exactness
+          #
+          #   @option state [Integer] :branched
+          #
+          # @return [TerminalShop::Internal::Type::BaseModel, Object]
+          def coerce(value, state:)
+            exactness = state.fetch(:exactness)
+
+            if value.is_a?(self.class)
+              exactness[:yes] += 1
+              return value
+            end
+
+            unless (val = TerminalShop::Internal::Util.coerce_hash(value)).is_a?(Hash)
+              exactness[:no] += 1
+              return value
+            end
+            exactness[:yes] += 1
+
+            keys = val.keys.to_set
+            instance = new
+            data = instance.to_h
+
+            # rubocop:disable Metrics/BlockLength
+            fields.each do |name, field|
+              mode, required, target = field.fetch_values(:mode, :required, :type)
+              api_name, nilable, const = field.fetch_values(:api_name, :nilable, :const)
+
+              unless val.key?(api_name)
+                if required && mode != :dump && const == TerminalShop::Internal::OMIT
+                  exactness[nilable ? :maybe : :no] += 1
+                else
+                  exactness[:yes] += 1
+                end
+                next
+              end
+
+              item = val.fetch(api_name)
+              keys.delete(api_name)
+
+              converted =
+                if item.nil? && (nilable || !required)
+                  exactness[nilable ? :yes : :maybe] += 1
+                  nil
+                else
+                  coerced = TerminalShop::Internal::Type::Converter.coerce(target, item, state: state)
+                  case target
+                  in TerminalShop::Internal::Type::Converter | Symbol
+                    coerced
+                  else
+                    item
+                  end
+                end
+              data.store(name, converted)
+            end
+            # rubocop:enable Metrics/BlockLength
+
+            keys.each { data.store(_1, val.fetch(_1)) }
+            instance
+          end
+
+          # @api private
+          #
+          # @param value [TerminalShop::Internal::Type::BaseModel, Object]
+          #
+          # @param state [Hash{Symbol=>Object}] .
+          #
+          #   @option state [Boolean] :can_retry
+          #
+          # @return [Hash{Object=>Object}, Object]
+          def dump(value, state:)
+            unless (coerced = TerminalShop::Internal::Util.coerce_hash(value)).is_a?(Hash)
+              return super
+            end
+
+            acc = {}
+
+            coerced.each do |key, val|
+              name = key.is_a?(String) ? key.to_sym : key
+              case (field = known_fields[name])
+              in nil
+                acc.store(name, super(val, state: state))
+              else
+                api_name, mode, type_fn = field.fetch_values(:api_name, :mode, :type_fn)
+                case mode
+                in :coerce
+                  next
+                else
+                  target = type_fn.call
+                  acc.store(api_name, TerminalShop::Internal::Type::Converter.dump(target, val, state: state))
+                end
+              end
+            end
+
+            known_fields.each_value do |field|
+              api_name, mode, const = field.fetch_values(:api_name, :mode, :const)
+              next if mode == :coerce || acc.key?(api_name) || const == TerminalShop::Internal::OMIT
+              acc.store(api_name, const)
+            end
+
+            acc
+          end
+        end
+
+        # @api public
+        #
+        # Returns the raw value associated with the given key, if found. Otherwise, nil is
+        # returned.
+        #
+        # It is valid to lookup keys that are not in the API spec, for example to access
+        # undocumented features. This method does not parse response data into
+        # higher-level types. Lookup by anything other than a Symbol is an ArgumentError.
+        #
+        # @param key [Symbol]
+        #
+        # @return [Object, nil]
+        def [](key)
+          unless key.instance_of?(Symbol)
+            raise ArgumentError.new("Expected symbol key for lookup, got #{key.inspect}")
+          end
+
+          @data[key]
+        end
+
+        # @api public
+        #
+        # Returns a Hash of the data underlying this object. O(1)
+        #
+        # Keys are Symbols and values are the raw values from the response. The return
+        # value indicates which values were ever set on the object. i.e. there will be a
+        # key in this hash if they ever were, even if the set value was nil.
+        #
+        # This method is not recursive. The returned value is shared by the object, so it
+        # should not be mutated.
+        #
+        # @return [Hash{Symbol=>Object}]
+        def to_h = @data
+
+        alias_method :to_hash, :to_h
+
+        # @param keys [Array<Symbol>, nil]
+        #
+        # @return [Hash{Symbol=>Object}]
+        def deconstruct_keys(keys)
+          (keys || self.class.known_fields.keys)
+            .filter_map do |k|
+              unless self.class.known_fields.key?(k)
+                next
+              end
+
+              [k, public_send(k)]
+            end
+            .to_h
+        end
+
+        class << self
+          # @api private
+          #
+          # @param model [TerminalShop::Internal::Type::BaseModel]
+          #
+          # @return [Hash{Symbol=>Object}]
+          def walk(model)
+            walk = ->(x) do
+              case x
+              in TerminalShop::Internal::Type::BaseModel
+                walk.call(x.to_h)
+              in Hash
+                x.transform_values(&walk)
+              in Array
+                x.map(&walk)
+              else
+                x
+              end
+            end
+            walk.call(model)
+          end
+        end
+
+        # @api public
+        #
+        # @param a [Object]
+        #
+        # @return [String]
+        def to_json(*a) = TerminalShop::Internal::Type::Converter.dump(self.class, self).to_json(*a)
+
+        # @api public
+        #
+        # @param a [Object]
+        #
+        # @return [String]
+        def to_yaml(*a) = TerminalShop::Internal::Type::Converter.dump(self.class, self).to_yaml(*a)
+
+        # Create a new instance of a model.
+        #
+        # @param data [Hash{Symbol=>Object}, self]
+        def initialize(data = {})
+          case TerminalShop::Internal::Util.coerce_hash(data)
+          in Hash => coerced
+            @data = coerced
+          else
+            message = "Expected a #{Hash} or #{TerminalShop::Internal::Type::BaseModel}, got #{data.inspect}"
+            raise ArgumentError.new(message)
+          end
+        end
+
+        class << self
+          # @api private
+          #
+          # @param depth [Integer]
+          #
+          # @return [String]
+          def inspect(depth: 0)
+            return super() if depth.positive?
+
+            depth = depth.succ
+            deferred = fields.transform_values do |field|
+              type, required, nilable = field.fetch_values(:type, :required, :nilable)
+              inspected = [
+                TerminalShop::Internal::Type::Converter.inspect(type, depth: depth),
+                !required || nilable ? "nil" : nil
+              ].compact.join(" | ")
+              -> { inspected }.tap { _1.define_singleton_method(:inspect) { call } }
+            end
+
+            "#{name}[#{deferred.inspect}]"
+          end
+        end
+
+        # @api public
+        #
+        # @return [String]
+        def to_s = self.class.walk(@data).to_s
+
+        # @api private
+        #
+        # @return [String]
+        def inspect = "#<#{self.class}:0x#{object_id.to_s(16)} #{self}>"
+      end
+    end
+  end
+end

data/lib/terminal_shop/internal/type/base_page.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module TerminalShop
+  module Internal
+    module Type
+      # @api private
+      #
+      # @generic Elem
+      #
+      # This module provides a base implementation for paginated responses in the SDK.
+      module BasePage
+        # rubocop:disable Lint/UnusedMethodArgument
+
+        # @api public
+        #
+        # @return [Boolean]
+        def next_page? = (raise NotImplementedError)
+
+        # @api public
+        #
+        # @raise [TerminalShop::Errors::APIError]
+        # @return [self]
+        def next_page = (raise NotImplementedError)
+
+        # @api public
+        #
+        # @param blk [Proc]
+        #
+        # @yieldparam [generic<Elem>]
+        # @return [void]
+        def auto_paging_each(&blk) = (raise NotImplementedError)
+
+        # @return [Enumerable<generic<Elem>>]
+        def to_enum = super(:auto_paging_each)
+
+        alias_method :enum_for, :to_enum
+
+        # @api private
+        #
+        # @param client [TerminalShop::Internal::Transport::BaseClient]
+        # @param req [Hash{Symbol=>Object}]
+        # @param headers [Hash{String=>String}, Net::HTTPHeader]
+        # @param page_data [Object]
+        def initialize(client:, req:, headers:, page_data:)
+          @client = client
+          @req = req
+          @model = req.fetch(:model)
+          super()
+        end
+
+        # rubocop:enable Lint/UnusedMethodArgument
+      end
+    end
+  end
+end

data/lib/terminal_shop/internal/type/boolean.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module TerminalShop
+  module Internal
+    module Type
+      # @api private
+      #
+      # @abstract
+      #
+      # Ruby has no Boolean class; this is something for models to refer to.
+      class Boolean
+        extend TerminalShop::Internal::Type::Converter
+
+        private_class_method :new
+
+        # @api public
+        #
+        # @param other [Object]
+        #
+        # @return [Boolean]
+        def self.===(other) = other == true || other == false
+
+        # @api public
+        #
+        # @param other [Object]
+        #
+        # @return [Boolean]
+        def self.==(other) = other.is_a?(Class) && other <= TerminalShop::Internal::Type::Boolean
+
+        class << self
+          # @api private
+          #
+          # @param value [Boolean, Object]
+          #
+          # @param state [Hash{Symbol=>Object}] .
+          #
+          #   @option state [Boolean, :strong] :strictness
+          #
+          #   @option state [Hash{Symbol=>Object}] :exactness
+          #
+          #   @option state [Integer] :branched
+          #
+          # @return [Boolean, Object]
+          def coerce(value, state:)
+            state.fetch(:exactness)[value == true || value == false ? :yes : :no] += 1
+            value
+          end
+
+          # @!parse
+          #   # @api private
+          #   #
+          #   # @param value [Boolean, Object]
+          #   #
+          #   # @param state [Hash{Symbol=>Object}] .
+          #   #
+          #   #   @option state [Boolean] :can_retry
+          #   #
+          #   # @return [Boolean, Object]
+          #   def dump(value, state:) = super
+        end
+      end
+    end
+  end
+end