jsapi 0.1.1 → 0.2.0

data/lib/jsapi/meta/parameter/reference.rb

@@ -4,10 +4,9 @@ module Jsapi
   module Meta
     module Parameter
       class Reference < BaseReference
-        # Returns an array of hashes. Each element represents an \OpenAPI
-        # parameter object if the type of the referred parameter is
-        # <code>"object"</code>. Otherwise the array contains a single
-        # hash representing the \OpenAPI reference object.
+        # Returns an array of hashes. Each element represents an \OpenAPI parameter object
+        # if the type of the referred parameter is <code>"object"</code>. Otherwise the
+        # array contains a single hash representing the \OpenAPI reference object.
         #
         # Raises a ReferenceError if the reference could not be resolved.
         def to_openapi(version, definitions)

data/lib/jsapi/meta/property.rb

@@ -19,8 +19,7 @@ module Jsapi
 
       ##
       # :attr: source
-      # The alternative method to read a property value when serializing
-      # an object.
+      # The alternative method to read a property value when serializing an object.
       attribute :source, Symbol
 
       ##
@@ -35,15 +34,17 @@ module Jsapi
       def initialize(name, keywords = {})
         raise ArgumentError, "property name can't be blank" if name.blank?
 
+        @name = name.to_s
+
         keywords = keywords.dup
         super(keywords.extract!(:read_only, :source, :write_only))
+        keywords[:ref] = keywords.delete(:schema) if keywords.key?(:schema)
 
-        @name = name.to_s
         @schema = Schema.new(keywords)
       end
 
-      # Returns true if the level of existence is greater than or equal to
-      # +ALLOW_NIL+, false otherwise.
+      # Returns true if the level of existence is greater than or equal to +ALLOW_NIL+,
+      # false otherwise.
       def required?
         schema.existence >= Existence::ALLOW_NIL
       end

data/lib/jsapi/meta/request_body/model.rb

@@ -16,7 +16,7 @@ module Jsapi
 
         ##
         # :attr_reader: schema
-        # The Schema of the parameter.
+        # The Schema of the request body.
         attribute :schema, writer: false
 
         delegate_missing_to :schema
@@ -26,6 +26,7 @@ module Jsapi
           super(keywords.extract!(:description, :examples))
 
           add_example(value: keywords.delete(:example)) if keywords.key?(:example)
+          keywords[:ref] = keywords.delete(:schema) if keywords.key?(:schema)
 
           @schema = Schema.new(keywords)
         end

data/lib/jsapi/meta/rescue_handler.rb

@@ -2,9 +2,15 @@
 
 module Jsapi
   module Meta
+    # Maps a +StandardError+ class to a response status.
     class RescueHandler
+      # The response status.
       attr_reader :status
 
+      # Creates a new rescue handler to map +klass+ to +status+. The default response status
+      # is <code>"default"</code>.
+      #
+      # Raises an +ArgumentError+ if +klass+ isn't a +StandardError+ class.
       def initialize(klass, status: nil)
         unless klass.is_a?(Class) && klass.ancestors.include?(StandardError)
           raise ArgumentError, "#{klass.inspect} must be a standard error class"
@@ -18,6 +24,7 @@ module Jsapi
         "#<#{self.class.name} class: #{@klass}, status: #{@status.inspect}>"
       end
 
+      # Returns true if +exception+ is an instance of the class to be mapped, false otherwise.
       def match?(exception)
         exception.is_a?(@klass)
       end

data/lib/jsapi/meta/response/model.rb

@@ -26,7 +26,7 @@ module Jsapi
 
         ##
         # :attr_reader: schema
-        # The Schema of the parameter.
+        # The Schema of the response.
         attribute :schema, writer: false
 
         delegate_missing_to :schema
@@ -36,6 +36,7 @@ module Jsapi
           super(keywords.extract!(:description, :examples, :locale))
 
           add_example(value: keywords.delete(:example)) if keywords.key?(:example)
+          keywords[:ref] = keywords.delete(:schema) if keywords.key?(:schema)
 
           @schema = Schema.new(**keywords)
         end

data/lib/jsapi/meta/schema/array.rb

@@ -7,7 +7,7 @@ module Jsapi
         ##
         # :attr: items
         # The Schema defining the kind of items.
-        attribute :items, Schema
+        attribute :items, Schema, writer: false
 
         ##
         # :attr: max_items
@@ -19,6 +19,14 @@ module Jsapi
         # The minimum length of an array.
         attribute :min_items, writer: false
 
+        def items=(keywords = {}) # :nodoc:
+          if keywords.key?(:schema)
+            keywords = keywords.dup
+            keywords[:ref] = keywords.delete(:schema)
+          end
+          @items = Schema.new(keywords)
+        end
+
         def max_items=(value) # :nodoc:
           add_validation('max_items', Validation::MaxItems.new(value))
           @max_items = value

data/lib/jsapi/meta/schema/base.rb

@@ -12,7 +12,7 @@ module Jsapi
 
         ##
         # :attr: default
-        # The optional default value.
+        # The default value.
         attribute :default
 
         ##
@@ -22,7 +22,7 @@ module Jsapi
 
         ##
         # :attr: description
-        # The optional description of the schema.
+        # The description of the schema.
         attribute :description, ::String
 
         ##
@@ -32,23 +32,22 @@ module Jsapi
 
         ##
         # :attr: examples
-        # The optional examples.
+        # The samples matching the schema.
         attribute :examples, [::Object]
 
         ##
         # :attr: external_docs
-        # The optional OpenAPI::ExternalDocumentation object.
+        # The OpenAPI::ExternalDocumentation object.
         attribute :external_docs, OpenAPI::ExternalDocumentation
 
         ##
         # :attr: existence
-        # The level of Existence. The default level of existence
-        # is +ALLOW_OMITTED+.
+        # The level of Existence. The default level of existence is +ALLOW_OMITTED+.
         attribute :existence, Existence, default: Existence::ALLOW_OMITTED
 
         ##
         # :attr: title
-        # The optional title of the schema.
+        # The title of the schema.
         attribute :title, String
 
         ##
@@ -73,8 +72,7 @@ module Jsapi
           @enum = value
         end
 
-        # Returns true if and only if values can be +null+ as specified
-        # by \JSON \Schema.
+        # Returns true if and only if values can be +null+ as specified by \JSON \Schema.
         def nullable?
           existence <= Existence::ALLOW_NIL
         end

data/lib/jsapi/meta/schema/object.rb

@@ -72,7 +72,7 @@ module Jsapi
           {}.tap do |properties|
             all_of_references.each do |reference|
               schema = reference.resolve(definitions)
-              raise "circular reference: #{reference.schema}" if schema.in?(path)
+              raise "circular reference: #{reference.ref}" if schema.in?(path)
 
               properties.merge!(schema.merge_properties(definitions, path + [self]))
             end

data/lib/jsapi/meta/schema/reference.rb

@@ -4,13 +4,9 @@ module Jsapi
   module Meta
     module Schema
       class Reference < BaseReference
-        alias :schema :ref
-        alias :schema= :ref=
-
         ##
         # :attr: existence
-        # The level of Existence. The default level of existence
-        # is +ALLOW_OMITTED+.
+        # The level of Existence. The default level of existence is +ALLOW_OMITTED+.
         attribute :existence, Existence, default: Existence::ALLOW_OMITTED
 
         def resolve(definitions) # :nodoc:

data/lib/jsapi/meta/schema/string.rb

@@ -8,12 +8,8 @@ module Jsapi
 
         ##
         # :attr: format
-        # The optional format of a string. Possible values are:
-        #
-        # - <code>"date"</code>
-        # - <code>"date-time"</code>
-        #
-        attribute :format, ::String, values: %w[date date-time]
+        # The format of a string.
+        attribute :format, ::String
 
         ##
         # :attr: max_length

data/lib/jsapi/meta/schema/validation/maximum.rb

@@ -9,9 +9,13 @@ module Jsapi
 
           def initialize(value, exclusive: false)
             if exclusive
-              raise ArgumentError, "invalid exclusive maximum: #{value.inspect}" unless value.respond_to?(:<)
+              unless value.respond_to?(:<)
+                raise ArgumentError, "invalid exclusive maximum: #{value.inspect}"
+              end
             else
-              raise ArgumentError, "invalid maximum: #{value.inspect}" unless value.respond_to?(:<=)
+              unless value.respond_to?(:<=)
+                raise ArgumentError, "invalid maximum: #{value.inspect}"
+              end
             end
 
             super(value)

data/lib/jsapi/meta/schema/validation/minimum.rb

@@ -9,9 +9,13 @@ module Jsapi
 
           def initialize(value, exclusive: false)
             if exclusive
-              raise ArgumentError, "invalid exclusive minimum: #{value.inspect}" unless value.respond_to?(:>)
+              unless value.respond_to?(:>)
+                raise ArgumentError, "invalid exclusive minimum: #{value.inspect}"
+              end
             else
-              raise ArgumentError, "invalid minimum: #{value.inspect}" unless value.respond_to?(:>=)
+              unless value.respond_to?(:>=)
+                raise ArgumentError, "invalid minimum: #{value.inspect}"
+              end
             end
 
             super(value)

data/lib/jsapi/meta/schema/validation/multiple_of.rb

@@ -6,7 +6,9 @@ module Jsapi
       module Validation
         class MultipleOf < Base
           def initialize(value)
-            raise ArgumentError, "invalid multiple of: #{value.inspect}" unless value.respond_to?(:%)
+            unless value.respond_to?(:%)
+              raise ArgumentError, "invalid multiple of: #{value.inspect}"
+            end
 
             super
           end

data/lib/jsapi/meta/schema.rb

@@ -33,9 +33,7 @@ module Jsapi
         #
         # Raises an InvalidArgumentError if the given type is invalid.
         def new(keywords = {})
-          if keywords.key?(:ref) || keywords.key?(:schema)
-            return Reference.new(keywords)
-          end
+          return Reference.new(keywords) if keywords.key?(:ref)
 
           type = keywords[:type]
           case type&.to_s

data/lib/jsapi/model/base.rb

@@ -2,8 +2,8 @@
 
 module Jsapi
   module Model
-    # The base API model used to represent top-level parameters and nested
-    # object parameters by default.
+    # The base API model used to represent top-level parameters and nested object
+    # parameters by default.
     class Base
       extend Naming
 

data/lib/jsapi/model/errors.rb

@@ -9,16 +9,15 @@ module Jsapi
         super
       end
 
-      # Overrides <code>ActiveModel::Errors#add</code> to wrap errors related
-      # to nested models.
+      # Overrides <code>ActiveModel::Errors#add</code> to wrap errors related to nested models.
       def add(attribute, type = :invalid, **options)
         type = type.call(@base, options) if type.respond_to?(:call)
 
         errors << wrap(Error.new(@base, attribute.to_sym, type, **options))
       end
 
-      # Overrides <code>ActiveModel::Errors#import</code> to wrap errors
-      # related to nested models.
+      # Overrides <code>ActiveModel::Errors#import</code> to wrap errors related to
+      # nested models.
       def import(error, options = {})
         if (options = options.slice(:attribute, :type)).any?
           attribute = (options[:attribute] || error.attribute).to_sym

data/lib/jsapi/model/naming.rb

@@ -6,8 +6,8 @@ module Jsapi
       include ActiveModel::Naming
       include ActiveModel::Translation
 
-      # Overrides <code>ActiveModel::Naming#model_name</code> to support
-      # anonymous model classes.
+      # Overrides <code>ActiveModel::Naming#model_name</code> to support anonymous
+      # model classes.
       def model_name
         @_model_name ||= begin
           # Copied from ActiveModel::Naming#model_name
@@ -15,8 +15,7 @@ module Jsapi
             m.respond_to?(:use_relative_model_naming?) &&
               m.use_relative_model_naming?
           end
-          # Prevent that ActiveModel::Name::new raises an error if this is
-          # an anonymous class
+          # Prevent that ActiveModel::Name::new raises an error if this is an anonymous class
           klass = self
           klass = klass.superclass while klass.name.nil?
 

data/lib/jsapi/model/validations.rb

@@ -11,8 +11,8 @@ module Jsapi
         validate :nested_validity
       end
 
-      # Overrides <code>ActiveModel::Validations#errors</code> to use
-      # Errors as error store.
+      # Overrides <code>ActiveModel::Validations#errors</code>
+      # to use Errors as error store.
       def errors
         @errors ||= Errors.new(self)
       end

data/lib/jsapi/version.rb

@@ -1,8 +1,10 @@
 # frozen_string_literal: true
 
 module Jsapi
-  # See https://bundler.io/guides/creating_gem.html
-  module Version # :nodoc:
-    VERSION = '0.1.1'
+  module Version
+    # NOTE: See https://bundler.io/guides/creating_gem.html
+
+    # The current GEM version.
+    VERSION = '0.2.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jsapi
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Denis Göller
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-27 00:00:00.000000000 Z
+date: 2024-07-05 00:00:00.000000000 Z
 dependencies: []
 description: Jsapi can be used to read requests, produce responses and create OpenAPI
   documents
@@ -139,7 +139,9 @@ files:
 homepage: https://github.com/dmgoeller/jsapi
 licenses:
 - MIT
-metadata: {}
+metadata:
+  homepage_uri: https://github.com/dmgoeller/jsapi
+  source_code_uri: https://github.com/dmgoeller/jsapi
 post_install_message:
 rdoc_options: []
 require_paths: