apiwork 0.0.0.pre → 0.1.2

data/lib/apiwork/introspection/param/integer.rb

@@ -0,0 +1,131 @@
+# frozen_string_literal: true
+
+module Apiwork
+  module Introspection
+    module Param
+      # @api public
+      # Integer param representing whole number values.
+      #
+      # @example Basic usage
+      #   param.type # => :integer
+      #   param.scalar? # => true
+      #   param.integer? # => true
+      #   param.numeric? # => true
+      #
+      # @example Constraints
+      #   param.min # => 0 or nil
+      #   param.max # => 100 or nil
+      #   param.format # => :int32 or nil
+      #   param.boundable? # => true
+      #   param.formattable? # => true
+      #
+      # @example Enum
+      #   if param.enum?
+      #     param.enum # => [1, 2, 3]
+      #     param.enum_reference? # => false
+      #   end
+      class Integer < Base
+        # @api public
+        # The minimum for this param.
+        #
+        # @return [Numeric, nil]
+        def min
+          @dump[:min]
+        end
+
+        # @api public
+        # The maximum for this param.
+        #
+        # @return [Numeric, nil]
+        def max
+          @dump[:max]
+        end
+
+        # @api public
+        # The format for this param.
+        #
+        # @return [Symbol, nil]
+        def format
+          @dump[:format]
+        end
+
+        # @api public
+        # Whether this param is scalar.
+        #
+        # @return [Boolean]
+        def scalar?
+          true
+        end
+
+        # @api public
+        # Whether this param has an enum.
+        #
+        # @return [Boolean]
+        def enum?
+          @dump[:enum].present?
+        end
+
+        # @api public
+        # The enum for this param.
+        #
+        # @return [Array<Integer>, Symbol, nil]
+        def enum
+          @dump[:enum]
+        end
+
+        # @api public
+        # Whether this param is an enum reference.
+        #
+        # @return [Boolean]
+        def enum_reference?
+          @dump[:enum].is_a?(Symbol)
+        end
+
+        # @api public
+        # Whether this param is numeric.
+        #
+        # @return [Boolean]
+        def numeric?
+          true
+        end
+
+        # @api public
+        # Whether this param is boundable.
+        #
+        # @return [Boolean]
+        def boundable?
+          true
+        end
+
+        # @api public
+        # Whether this param is formattable.
+        #
+        # @return [Boolean]
+        def formattable?
+          true
+        end
+
+        # @api public
+        # Whether this param is an integer.
+        #
+        # @return [Boolean]
+        def integer?
+          true
+        end
+
+        # @api public
+        # Converts this param to a hash.
+        #
+        # @return [Hash]
+        def to_h
+          result = super
+          result[:enum] = enum if enum?
+          result[:format] = format
+          result[:max] = max
+          result[:min] = min
+          result
+        end
+      end
+    end
+  end
+end

data/lib/apiwork/introspection/param/literal.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Apiwork
+  module Introspection
+    module Param
+      # @api public
+      # Literal param representing a constant value.
+      #
+      # @example Basic usage
+      #   param.type # => :literal
+      #   param.literal? # => true
+      #   param.scalar? # => false
+      #
+      # @example Value
+      #   param.value # => "active" or 42 or true
+      class Literal < Base
+        # @api public
+        # The value for this param.
+        #
+        # @return [String, Numeric, Boolean, nil]
+        def value
+          @dump[:value]
+        end
+
+        # @api public
+        # Whether this param is a literal.
+        #
+        # @return [Boolean]
+        def literal?
+          true
+        end
+
+        # @api public
+        # Converts this param to a hash.
+        #
+        # @return [Hash]
+        def to_h
+          result = super
+          result[:value] = value
+          result
+        end
+      end
+    end
+  end
+end

data/lib/apiwork/introspection/param/number.rb

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+
+module Apiwork
+  module Introspection
+    module Param
+      # @api public
+      # Number param representing floating-point number values.
+      #
+      # @example Basic usage
+      #   param.type # => :number
+      #   param.scalar? # => true
+      #   param.number? # => true
+      #   param.numeric? # => true
+      #
+      # @example Constraints
+      #   param.min # => 0.0 or nil
+      #   param.max # => 100.0 or nil
+      #   param.boundable? # => true
+      #   param.formattable? # => false
+      #
+      # @example Enum
+      #   if param.enum?
+      #     param.enum # => [0.5, 1.0, 1.5]
+      #     param.enum_reference? # => false
+      #   end
+      class Number < Base
+        # @api public
+        # The minimum for this param.
+        #
+        # @return [Numeric, nil]
+        def min
+          @dump[:min]
+        end
+
+        # @api public
+        # The maximum for this param.
+        #
+        # @return [Numeric, nil]
+        def max
+          @dump[:max]
+        end
+
+        # @api public
+        # Whether this param is scalar.
+        #
+        # @return [Boolean]
+        def scalar?
+          true
+        end
+
+        # @api public
+        # Whether this param has an enum.
+        #
+        # @return [Boolean]
+        def enum?
+          @dump[:enum].present?
+        end
+
+        # @api public
+        # The enum for this param.
+        #
+        # @return [Array<Numeric>, Symbol, nil]
+        def enum
+          @dump[:enum]
+        end
+
+        # @api public
+        # Whether this param is an enum reference.
+        #
+        # @return [Boolean]
+        def enum_reference?
+          @dump[:enum].is_a?(Symbol)
+        end
+
+        # @api public
+        # Whether this param is numeric.
+        #
+        # @return [Boolean]
+        def numeric?
+          true
+        end
+
+        # @api public
+        # Whether this param is boundable.
+        #
+        # @return [Boolean]
+        def boundable?
+          true
+        end
+
+        # @api public
+        # Whether this param is a number.
+        #
+        # @return [Boolean]
+        def number?
+          true
+        end
+
+        # @api public
+        # Whether this param is formattable.
+        #
+        # @return [Boolean]
+        def formattable?
+          false
+        end
+
+        # @api public
+        # Converts this param to a hash.
+        #
+        # @return [Hash]
+        def to_h
+          result = super
+          result[:enum] = enum if enum?
+          result[:max] = max
+          result[:min] = min
+          result
+        end
+      end
+    end
+  end
+end

data/lib/apiwork/introspection/param/object.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module Apiwork
+  module Introspection
+    module Param
+      # @api public
+      # Object param representing structured data with named fields.
+      #
+      # @example Basic usage
+      #   param.type # => :object
+      #   param.object? # => true
+      #   param.scalar? # => false
+      #
+      # @example Fields
+      #   param.shape # => { name: Param, email: Param }
+      #
+      # @example Partial objects (for updates)
+      #   param.partial? # => true if all fields are optional
+      class Object < Base
+        # @api public
+        # The shape for this param.
+        #
+        # @return [Hash{Symbol => Param::Base}]
+        def shape
+          return @shape if defined?(@shape)
+
+          @shape = @dump[:shape]&.transform_values { |dump| Param.build(dump) } || {}
+        end
+
+        # @api public
+        # Whether this param is partial.
+        #
+        # @return [Boolean]
+        def partial?
+          @dump[:partial]
+        end
+
+        # @api public
+        # Whether this param is an object.
+        #
+        # @return [Boolean]
+        def object?
+          true
+        end
+
+        # @api public
+        # Converts this param to a hash.
+        #
+        # @return [Hash]
+        def to_h
+          result = super
+          result[:partial] = partial?
+          result[:shape] = shape.transform_values(&:to_h)
+          result
+        end
+      end
+    end
+  end
+end

data/lib/apiwork/introspection/param/reference.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Apiwork
+  module Introspection
+    module Param
+      # @api public
+      # Reference param representing a reference to a named type.
+      #
+      # @example Basic usage
+      #   param.type # => :reference
+      #   param.reference? # => true
+      #   param.scalar? # => false
+      #
+      # @example Reference
+      #   param.reference # => :address
+      class Reference < Base
+        # @api public
+        # The reference for this param.
+        #
+        # @return [Symbol]
+        def reference
+          @dump[:reference]
+        end
+
+        # @api public
+        # Whether this param is a reference.
+        #
+        # @return [Boolean]
+        def reference?
+          true
+        end
+
+        # @api public
+        # Converts this param to a hash.
+        #
+        # @return [Hash]
+        def to_h
+          result = super
+          result[:reference] = reference
+          result
+        end
+      end
+    end
+  end
+end

data/lib/apiwork/introspection/param/string.rb

@@ -0,0 +1,122 @@
+# frozen_string_literal: true
+
+module Apiwork
+  module Introspection
+    module Param
+      # @api public
+      # String param representing text values.
+      #
+      # @example Basic usage
+      #   param.type # => :string
+      #   param.scalar? # => true
+      #   param.string? # => true
+      #
+      # @example Constraints
+      #   param.min # => 1 or nil
+      #   param.max # => 255 or nil
+      #   param.format # => :email or nil
+      #   param.boundable? # => true
+      #   param.formattable? # => true
+      #
+      # @example Enum
+      #   if param.enum?
+      #     param.enum # => ["draft", "published"]
+      #     param.enum_reference? # => false
+      #   end
+      class String < Base
+        # @api public
+        # The format for this param.
+        #
+        # @return [Symbol, nil]
+        def format
+          @dump[:format]
+        end
+
+        # @api public
+        # The minimum for this param.
+        #
+        # @return [Integer, nil]
+        def min
+          @dump[:min]
+        end
+
+        # @api public
+        # The maximum for this param.
+        #
+        # @return [Integer, nil]
+        def max
+          @dump[:max]
+        end
+
+        # @api public
+        # Whether this param is scalar.
+        #
+        # @return [Boolean]
+        def scalar?
+          true
+        end
+
+        # @api public
+        # Whether this param has an enum.
+        #
+        # @return [Boolean]
+        def enum?
+          @dump[:enum].present?
+        end
+
+        # @api public
+        # The enum for this param.
+        #
+        # @return [Array<String>, Symbol, nil]
+        def enum
+          @dump[:enum]
+        end
+
+        # @api public
+        # Whether this param is an enum reference.
+        #
+        # @return [Boolean]
+        def enum_reference?
+          @dump[:enum].is_a?(Symbol)
+        end
+
+        # @api public
+        # Whether this param is boundable.
+        #
+        # @return [Boolean]
+        def boundable?
+          true
+        end
+
+        # @api public
+        # Whether this param is formattable.
+        #
+        # @return [Boolean]
+        def formattable?
+          true
+        end
+
+        # @api public
+        # Whether this param is a string.
+        #
+        # @return [Boolean]
+        def string?
+          true
+        end
+
+        # @api public
+        # Converts this param to a hash.
+        #
+        # @return [Hash]
+        def to_h
+          result = super
+          result[:enum] = enum if enum?
+          result[:format] = format
+          result[:max] = max
+          result[:min] = min
+          result
+        end
+      end
+    end
+  end
+end

data/lib/apiwork/introspection/param/time.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module Apiwork
+  module Introspection
+    module Param
+      # @api public
+      # Time param representing time-of-day values.
+      #
+      # @example Basic usage
+      #   param.type # => :time
+      #   param.scalar? # => true
+      #   param.time? # => true
+      #
+      # @example Capabilities
+      #   param.formattable? # => false
+      #
+      # @example Enum
+      #   if param.enum?
+      #     param.enum # => ["09:00", "17:00"]
+      #     param.enum_reference? # => false
+      #   end
+      class Time < Base
+        # @api public
+        # Whether this param is scalar.
+        #
+        # @return [Boolean]
+        def scalar?
+          true
+        end
+
+        # @api public
+        # Whether this param has an enum.
+        #
+        # @return [Boolean]
+        def enum?
+          @dump[:enum].present?
+        end
+
+        # @api public
+        # The enum for this param.
+        #
+        # @return [Array<String>, Symbol, nil]
+        def enum
+          @dump[:enum]
+        end
+
+        # @api public
+        # Whether this param is an enum reference.
+        #
+        # @return [Boolean]
+        def enum_reference?
+          @dump[:enum].is_a?(Symbol)
+        end
+
+        # @api public
+        # Whether this param is a time.
+        #
+        # @return [Boolean]
+        def time?
+          true
+        end
+
+        # @api public
+        # Whether this param is formattable.
+        #
+        # @return [Boolean]
+        def formattable?
+          false
+        end
+      end
+    end
+  end
+end

data/lib/apiwork/introspection/param/union.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module Apiwork
+  module Introspection
+    module Param
+      # @api public
+      # Union param representing a value that can be one of several types.
+      #
+      # @example Basic usage
+      #   param.type # => :union
+      #   param.union? # => true
+      #   param.scalar? # => false
+      #
+      # @example Variants
+      #   param.variants # => [Param, Param, ...]
+      #
+      # @example Discriminated unions
+      #   param.discriminator # => :type or nil
+      class Union < Base
+        # @api public
+        # The variants for this param.
+        #
+        # @return [Array<Param::Base>]
+        def variants
+          @variants ||= @dump[:variants].map { |dump| Param.build(dump) }
+        end
+
+        # @api public
+        # The discriminator for this param.
+        #
+        # @return [Symbol, nil]
+        def discriminator
+          @dump[:discriminator]
+        end
+
+        # @api public
+        # Whether this param is a union.
+        #
+        # @return [Boolean]
+        def union?
+          true
+        end
+
+        # @api public
+        # Converts this param to a hash.
+        #
+        # @return [Hash]
+        def to_h
+          result = super
+          result[:discriminator] = discriminator
+          result[:variants] = variants.map(&:to_h)
+          result
+        end
+      end
+    end
+  end
+end

data/lib/apiwork/introspection/param/unknown.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Apiwork
+  module Introspection
+    module Param
+      # @api public
+      # Unknown param representing an unrecognized type.
+      #
+      # Used as a fallback when the type cannot be determined during introspection.
+      #
+      # @example Basic usage
+      #   param.type # => :unknown
+      #   param.unknown? # => true
+      #   param.scalar? # => false
+      class Unknown < Base
+        # @api public
+        # Whether this param is of unknown type.
+        #
+        # @return [Boolean]
+        def unknown?
+          true
+        end
+      end
+    end
+  end
+end