apiwork 0.0.0.pre → 0.1.1

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

@@ -0,0 +1,285 @@
+# frozen_string_literal: true
+
+module Apiwork
+  module Introspection
+    module Param
+      class Base
+        def initialize(dump)
+          @dump = dump
+        end
+
+        # @api public
+        # The type for this param.
+        #
+        # @return [Symbol]
+        def type
+          @dump[:type]
+        end
+
+        # @api public
+        # Whether this param is nullable.
+        #
+        # @return [Boolean]
+        def nullable?
+          @dump[:nullable]
+        end
+
+        # @api public
+        # Whether this param is optional.
+        #
+        # @return [Boolean]
+        def optional?
+          @dump[:optional]
+        end
+
+        # @api public
+        # Whether this param is deprecated.
+        #
+        # @return [Boolean]
+        def deprecated?
+          @dump[:deprecated]
+        end
+
+        # @api public
+        # The description for this param.
+        #
+        # @return [String, nil]
+        def description
+          @dump[:description]
+        end
+
+        # @api public
+        # The example for this param.
+        #
+        # @return [Object, nil]
+        def example
+          @dump[:example]
+        end
+
+        # @api public
+        # The default for this param.
+        #
+        # @return [Object, nil]
+        def default
+          @dump[:default]
+        end
+
+        # @api public
+        # Whether this param has a default.
+        #
+        # @return [Boolean]
+        def default?
+          @dump.key?(:default)
+        end
+
+        # @api public
+        # The tag for this param.
+        #
+        # @return [String, nil]
+        def tag
+          @dump[:tag]
+        end
+
+        # @api public
+        # Whether this param is scalar.
+        #
+        # @return [Boolean]
+        def scalar?
+          false
+        end
+
+        # @api public
+        # Whether this param is an array.
+        #
+        # @return [Boolean]
+        def array?
+          false
+        end
+
+        # @api public
+        # Whether this param is an object.
+        #
+        # @return [Boolean]
+        def object?
+          false
+        end
+
+        # @api public
+        # Whether this param is a union.
+        #
+        # @return [Boolean]
+        def union?
+          false
+        end
+
+        # @api public
+        # Whether this param is a literal.
+        #
+        # @return [Boolean]
+        def literal?
+          false
+        end
+
+        # @api public
+        # Whether this param is numeric.
+        #
+        # @return [Boolean]
+        def numeric?
+          false
+        end
+
+        # @api public
+        # Whether this param is boundable.
+        #
+        # @return [Boolean]
+        def boundable?
+          false
+        end
+
+        # @api public
+        # Whether this param is a string.
+        #
+        # @return [Boolean]
+        def string?
+          false
+        end
+
+        # @api public
+        # Whether this param is an integer.
+        #
+        # @return [Boolean]
+        def integer?
+          false
+        end
+
+        # @api public
+        # Whether this param is a number.
+        #
+        # @return [Boolean]
+        def number?
+          false
+        end
+
+        # @api public
+        # Whether this param is a decimal.
+        #
+        # @return [Boolean]
+        def decimal?
+          false
+        end
+
+        # @api public
+        # Whether this param is a boolean.
+        #
+        # @return [Boolean]
+        def boolean?
+          false
+        end
+
+        # @api public
+        # Whether this param is a datetime.
+        #
+        # @return [Boolean]
+        def datetime?
+          false
+        end
+
+        # @api public
+        # Whether this param is a date.
+        #
+        # @return [Boolean]
+        def date?
+          false
+        end
+
+        # @api public
+        # Whether this param is a time.
+        #
+        # @return [Boolean]
+        def time?
+          false
+        end
+
+        # @api public
+        # Whether this param is a UUID.
+        #
+        # @return [Boolean]
+        def uuid?
+          false
+        end
+
+        # @api public
+        # Whether this param is binary data.
+        #
+        # @return [Boolean]
+        def binary?
+          false
+        end
+
+        # @api public
+        # Whether this param is of unknown type.
+        #
+        # @return [Boolean]
+        def unknown?
+          false
+        end
+
+        # @api public
+        # Whether this param is a reference.
+        #
+        # @return [Boolean]
+        def reference?
+          false
+        end
+
+        # @api public
+        # Whether this param has an enum.
+        #
+        # @return [Boolean]
+        def enum?
+          false
+        end
+
+        # @api public
+        # Whether this param is an enum reference.
+        #
+        # @return [Boolean]
+        def enum_reference?
+          false
+        end
+
+        # @api public
+        # Whether this param is formattable.
+        #
+        # @return [Boolean]
+        def formattable?
+          false
+        end
+
+        # @api public
+        # Whether this param is partial.
+        #
+        # @return [Boolean]
+        def partial?
+          false
+        end
+
+        # @api public
+        # Converts this param to a hash.
+        #
+        # @return [Hash]
+        def to_h
+          {
+            default: default,
+            deprecated: deprecated?,
+            description: description,
+            example: example,
+            nullable: nullable?,
+            optional: optional?,
+            type: type,
+          }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module Apiwork
+  module Introspection
+    module Param
+      # @api public
+      # Binary param representing base64-encoded binary data.
+      #
+      # @example Basic usage
+      #   param.type # => :binary
+      #   param.scalar? # => true
+      #   param.binary? # => true
+      #
+      # @example Capabilities
+      #   param.formattable? # => false
+      #
+      # @example Enum
+      #   if param.enum?
+      #     param.enum # => ["SGVsbG8=", "V29ybGQ="]
+      #     param.enum_reference? # => false
+      #   end
+      class Binary < 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 binary data.
+        #
+        # @return [Boolean]
+        def binary?
+          true
+        end
+
+        # @api public
+        # Whether this param is formattable.
+        #
+        # @return [Boolean]
+        def formattable?
+          false
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module Apiwork
+  module Introspection
+    module Param
+      # @api public
+      # Boolean param representing true/false values.
+      #
+      # @example Basic usage
+      #   param.type # => :boolean
+      #   param.scalar? # => true
+      #   param.boolean? # => true
+      #
+      # @example Capabilities
+      #   param.formattable? # => false
+      #
+      # @example Enum
+      #   if param.enum?
+      #     param.enum # => [true]
+      #     param.enum_reference? # => false
+      #   end
+      class Boolean < 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<Boolean>, 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 boolean.
+        #
+        # @return [Boolean]
+        def boolean?
+          true
+        end
+
+        # @api public
+        # Whether this param is formattable.
+        #
+        # @return [Boolean]
+        def formattable?
+          false
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module Apiwork
+  module Introspection
+    module Param
+      # @api public
+      # Date param representing date values (year, month, day).
+      #
+      # @example Basic usage
+      #   param.type # => :date
+      #   param.scalar? # => true
+      #   param.date? # => true
+      #
+      # @example Capabilities
+      #   param.formattable? # => false
+      #
+      # @example Enum
+      #   if param.enum?
+      #     param.enum # => ["2024-01-01", "2024-12-31"]
+      #     param.enum_reference? # => false
+      #   end
+      class Date < 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 date.
+        #
+        # @return [Boolean]
+        def date?
+          true
+        end
+
+        # @api public
+        # Whether this param is formattable.
+        #
+        # @return [Boolean]
+        def formattable?
+          false
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module Apiwork
+  module Introspection
+    module Param
+      # @api public
+      # DateTime param representing date and time values with timezone.
+      #
+      # @example Basic usage
+      #   param.type # => :datetime
+      #   param.scalar? # => true
+      #   param.datetime? # => true
+      #
+      # @example Capabilities
+      #   param.formattable? # => false
+      #
+      # @example Enum
+      #   if param.enum?
+      #     param.enum # => ["2024-01-01T00:00:00Z"]
+      #     param.enum_reference? # => false
+      #   end
+      class DateTime < 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 datetime.
+        #
+        # @return [Boolean]
+        def datetime?
+          true
+        end
+
+        # @api public
+        # Whether this param is formattable.
+        #
+        # @return [Boolean]
+        def formattable?
+          false
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+
+module Apiwork
+  module Introspection
+    module Param
+      # @api public
+      # Decimal param representing precise decimal number values.
+      #
+      # @example Basic usage
+      #   param.type # => :decimal
+      #   param.scalar? # => true
+      #   param.decimal? # => 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 # => [9.99, 19.99, 29.99]
+      #     param.enum_reference? # => false
+      #   end
+      class Decimal < 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 decimal.
+        #
+        # @return [Boolean]
+        def decimal?
+          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