jsapi 0.9.1 → 1.0

data/lib/jsapi/meta/rescue_handler.rb

@@ -3,7 +3,7 @@
 module Jsapi
   module Meta
     # Maps an error class to a response status.
-    class RescueHandler < Base::Model
+    class RescueHandler < Model::Base
       ##
       # :attr: error_class
       # The error class to be mapped.

data/lib/jsapi/meta/response/{model.rb → base.rb}

@@ -3,8 +3,8 @@
 module Jsapi
   module Meta
     module Response
-      # Defines a response.
-      class Model < Base::Model
+      # Specifies a response.
+      class Base < Model::Base
         include OpenAPI::Extensions
 
         delegate_missing_to :schema
@@ -42,7 +42,7 @@ module Jsapi
         ##
         # :attr_reader: schema
         # The Schema of the response.
-        attribute :schema, read_only: true
+        attribute :schema, accessors: %i[reader]
 
         def initialize(keywords = {})
           keywords = keywords.dup

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

@@ -3,15 +3,8 @@
 module Jsapi
   module Meta
     module Response
-      class Reference < Base::Reference
-        # Returns a hash representing the \OpenAPI reference object.
-        def to_openapi(version, *)
-          version = OpenAPI::Version.from(version)
-          path = version.major == 2 ? 'responses' : 'components/responses'
-
-          { '$ref': "#/#{path}/#{ref}" }
-        end
-      end
+      # Refers a reusable response.
+      class Reference < Model::Reference; end
     end
   end
 end

data/lib/jsapi/meta/response.rb

@@ -1,17 +1,17 @@
 # frozen_string_literal: true
 
-require_relative 'response/model'
+require_relative 'response/base'
 require_relative 'response/reference'
 
 module Jsapi
   module Meta
     module Response
       class << self
-        # Creates a Model or Reference.
+        # Creates a Base or Reference.
         def new(keywords = {})
           return Reference.new(keywords) if keywords.key?(:ref)
 
-          Model.new(keywords)
+          Base.new(keywords)
         end
       end
     end

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

@@ -3,13 +3,13 @@
 module Jsapi
   module Meta
     module Schema
-      class AdditionalProperties < Meta::Base::Model
+      class AdditionalProperties < Model::Base
         delegate_missing_to :schema
 
         ##
         # :attr: schema
         # The Schema of additional properties.
-        attribute :schema, read_only: true
+        attribute :schema, accessors: %i[reader]
 
         ##
         # :attr: source

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

@@ -7,19 +7,17 @@ module Jsapi
         ##
         # :attr: items
         # The Schema defining the kind of items.
-        attribute :items, Schema
+        attribute :items, Schema, accessors: %i[reader]
 
         ##
         # :attr: max_items
         # The maximum length of an array.
-        attribute :max_items
+        attribute :max_items, accessors: %i[reader]
 
         ##
         # :attr: min_items
         # The minimum length of an array.
-        attribute :min_items
-
-        undef items=, max_items=, min_items=
+        attribute :min_items, accessors: %i[reader]
 
         def items=(keywords = {}) # :nodoc:
           if keywords.key?(:schema)

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

@@ -3,7 +3,7 @@
 module Jsapi
   module Meta
     module Schema
-      class Base < Meta::Base::Model
+      class Base < Model::Base
         include OpenAPI::Extensions
 
         ##
@@ -24,7 +24,7 @@ module Jsapi
         ##
         # :attr: enum
         # The allowed values.
-        attribute :enum
+        attribute :enum, accessors: %i[reader]
 
         ##
         # :attr: examples
@@ -53,8 +53,6 @@ module Jsapi
         # The validations.
         attr_reader :validations
 
-        undef enum=
-
         # Creates a new schema.
         def initialize(keywords = {})
           keywords = keywords.dup
@@ -96,9 +94,9 @@ module Jsapi
             default: default,
             examples: examples.presence,
             deprecated: deprecated?.presence
-          }.tap do |hash|
+          }.tap do |result|
             validations.each_value do |validation|
-              hash.merge!(validation.to_json_schema_validation)
+              result.merge!(validation.to_json_schema_validation)
             end
           end.compact
         end
@@ -129,14 +127,14 @@ module Jsapi
                 examples: examples.presence,
                 deprecated: deprecated?.presence
               }
-            end.tap do |hash|
-              hash[:title] = title
-              hash[:description] = description
-              hash[:default] = default
-              hash[:externalDocs] = external_docs&.to_openapi
+            end.tap do |result|
+              result[:title] = title
+              result[:description] = description
+              result[:default] = default
+              result[:externalDocs] = external_docs&.to_openapi
 
               validations.each_value do |validation|
-                hash.merge!(validation.to_openapi_validation(version))
+                result.merge!(validation.to_openapi_validation(version))
               end
             end
           )

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

@@ -6,8 +6,8 @@ module Jsapi
   module Meta
     module Schema
       module Conversion
-        def self.included(mod)
-          mod.attr_accessor :conversion
+        def self.included(base) # :nodoc:
+          base.attr_accessor :conversion
         end
 
         def convert(object)

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

@@ -3,7 +3,7 @@
 module Jsapi
   module Meta
     module Schema
-      class Discriminator < Meta::Base::Model
+      class Discriminator < Model::Base
         ##
         # :attr: mappings
         attribute :mappings, { Object => String }

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

@@ -9,18 +9,16 @@ module Jsapi
         ##
         # :attr: maximum
         # The (exclusive) maximum.
-        attribute :maximum
+        attribute :maximum, accessors: %i[reader]
 
         ##
         # :attr: minimum
         # The (exclusive) minimum.
-        attribute :minimum
+        attribute :minimum, accessors: %i[reader]
 
         ##
         # :attr: multiple_of
-        attribute :multiple_of
-
-        undef maximum=, minimum=, multiple_of=
+        attribute :multiple_of, accessors: %i[reader]
 
         def maximum=(value) # :nodoc:
           boundary = Boundary.from(value)

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

@@ -24,15 +24,13 @@ module Jsapi
         ##
         # :attr: model
         # The model class to access nested object parameters by. The default
-        # model class is Model::Base.
-        attribute :model, Class, default: Model::Base
+        # model class is Jsapi::Model::Base.
+        attribute :model, Class, default: Jsapi::Model::Base
 
         ##
         # :attr: properties
         # The properties.
-        attribute :properties, { String => Property }
-
-        undef add_property
+        attribute :properties, { String => Property }, accessors: %i[reader writer]
 
         def add_property(name, keywords = {}) # :nodoc:
           (@properties ||= {})[name.to_s] = Property.new(name, **keywords)

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

@@ -3,7 +3,8 @@
 module Jsapi
   module Meta
     module Schema
-      class Reference < Base::Reference
+      # Refers a reusable schema.
+      class Reference < Model::Reference
         ##
         # :attr: existence
         # The level of Existence. The default level of existence is +ALLOW_OMITTED+.
@@ -21,12 +22,11 @@ module Jsapi
           { '$ref': "#/definitions/#{ref}" }
         end
 
-        # Returns a hash representing the \OpenAPI reference object.
-        def to_openapi(version, *)
-          version = OpenAPI::Version.from(version)
-          path = version.major == 2 ? 'definitions' : 'components/schemas'
+        private
 
-          { '$ref': "#/#{path}/#{ref}" }
+        # Overrides Model::Reference#openapi_components_path.
+        def openapi_components_path(version)
+          version.major == 2 ? 'definitions' : super
         end
       end
     end

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

@@ -14,19 +14,17 @@ module Jsapi
         ##
         # :attr: max_length
         # The maximum length of a string.
-        attribute :max_length
+        attribute :max_length, accessors: %i[reader]
 
         ##
         # :attr: min_length
         # The minimum length of a string.
-        attribute :min_length
+        attribute :min_length, accessors: %i[reader]
 
         ##
         # :attr: pattern
         # The regular expression a string must match.
-        attribute :pattern
-
-        undef max_length=, min_length=, pattern=
+        attribute :pattern, accessors: %i[reader]
 
         def max_length=(value) # :nodoc:
           add_validation('max_length', Validation::MaxLength.new(value))

data/lib/jsapi/meta/security_requirement.rb

@@ -2,9 +2,9 @@
 
 module Jsapi
   module Meta
-    # Specifies a security requirement object.
-    class SecurityRequirement < Base::Model
-      class Scheme < Base::Model
+    # Specifies a security requirement.
+    class SecurityRequirement < Model::Base
+      class Scheme < Model::Base
         ##
         # :attr: scopes
         # The array of scopes.

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

@@ -3,7 +3,7 @@
 module Jsapi
   module Meta
     module SecurityScheme
-      class Base < Meta::Base::Model
+      class Base < Model::Base
         ##
         # :attr: description
         # The description of the security scheme.

data/lib/jsapi/meta/server.rb

@@ -2,8 +2,8 @@
 
 module Jsapi
   module Meta
-    # Specifiess a server object.
-    class Server < Base::Model
+    # Specifies a server.
+    class Server < Model::Base
       include OpenAPI::Extensions
 
       ##

data/lib/jsapi/meta/server_variable.rb

@@ -2,8 +2,8 @@
 
 module Jsapi
   module Meta
-    # Specifies a server variable object.
-    class ServerVariable < Base::Model
+    # Specifies a server variable.
+    class ServerVariable < Model::Base
       include OpenAPI::Extensions
 
       ##

data/lib/jsapi/meta/tag.rb

@@ -2,8 +2,8 @@
 
 module Jsapi
   module Meta
-    # Specifies a tag object.
-    class Tag < Base::Model
+    # Specifies a tag.
+    class Tag < Model::Base
       include OpenAPI::Extensions
 
       ##

data/lib/jsapi/meta.rb

@@ -4,7 +4,7 @@ require_relative 'meta/reference_error'
 require_relative 'meta/callable'
 require_relative 'meta/existence'
 require_relative 'meta/openapi'
-require_relative 'meta/base'
+require_relative 'meta/model'
 require_relative 'meta/defaults'
 require_relative 'meta/example'
 require_relative 'meta/external_documentation'

data/lib/jsapi/version.rb

@@ -5,6 +5,6 @@ module Jsapi
     # NOTE: See https://bundler.io/guides/creating_gem.html
 
     # The current GEM version.
-    VERSION = '0.9.1'
+    VERSION = '1.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jsapi
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: '1.0'
 platform: ruby
 authors:
 - Denis Göller
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-18 00:00:00.000000000 Z
+date: 2024-11-01 00:00:00.000000000 Z
 dependencies: []
 description:
 email: denis@dmgoeller.de
@@ -50,50 +50,49 @@ files:
 - lib/jsapi/json/string.rb
 - lib/jsapi/json/value.rb
 - lib/jsapi/meta.rb
-- lib/jsapi/meta/base.rb
-- lib/jsapi/meta/base/attributes.rb
-- lib/jsapi/meta/base/model.rb
-- lib/jsapi/meta/base/reference.rb
-- lib/jsapi/meta/base/type_caster.rb
 - lib/jsapi/meta/callable.rb
 - lib/jsapi/meta/callable/symbol_evaluator.rb
 - lib/jsapi/meta/callable/symbol_sequence_evaluator.rb
 - lib/jsapi/meta/callback.rb
-- lib/jsapi/meta/callback/model.rb
+- lib/jsapi/meta/callback/base.rb
 - lib/jsapi/meta/callback/reference.rb
 - lib/jsapi/meta/contact.rb
 - lib/jsapi/meta/defaults.rb
 - lib/jsapi/meta/definitions.rb
 - lib/jsapi/meta/example.rb
-- lib/jsapi/meta/example/model.rb
+- lib/jsapi/meta/example/base.rb
 - lib/jsapi/meta/example/reference.rb
 - lib/jsapi/meta/existence.rb
 - lib/jsapi/meta/external_documentation.rb
 - lib/jsapi/meta/header.rb
-- lib/jsapi/meta/header/model.rb
+- lib/jsapi/meta/header/base.rb
 - lib/jsapi/meta/header/reference.rb
 - lib/jsapi/meta/info.rb
 - lib/jsapi/meta/license.rb
 - lib/jsapi/meta/link.rb
-- lib/jsapi/meta/link/model.rb
+- lib/jsapi/meta/link/base.rb
 - lib/jsapi/meta/link/reference.rb
+- lib/jsapi/meta/model.rb
+- lib/jsapi/meta/model/attributes.rb
+- lib/jsapi/meta/model/base.rb
+- lib/jsapi/meta/model/reference.rb
+- lib/jsapi/meta/model/type_caster.rb
 - lib/jsapi/meta/oauth_flow.rb
 - lib/jsapi/meta/openapi.rb
 - lib/jsapi/meta/openapi/extensions.rb
 - lib/jsapi/meta/openapi/version.rb
 - lib/jsapi/meta/operation.rb
 - lib/jsapi/meta/parameter.rb
-- lib/jsapi/meta/parameter/model.rb
+- lib/jsapi/meta/parameter/base.rb
 - lib/jsapi/meta/parameter/reference.rb
-- lib/jsapi/meta/parameter/to_openapi.rb
 - lib/jsapi/meta/property.rb
 - lib/jsapi/meta/reference_error.rb
 - lib/jsapi/meta/request_body.rb
-- lib/jsapi/meta/request_body/model.rb
+- lib/jsapi/meta/request_body/base.rb
 - lib/jsapi/meta/request_body/reference.rb
 - lib/jsapi/meta/rescue_handler.rb
 - lib/jsapi/meta/response.rb
-- lib/jsapi/meta/response/model.rb
+- lib/jsapi/meta/response/base.rb
 - lib/jsapi/meta/response/reference.rb
 - lib/jsapi/meta/schema.rb
 - lib/jsapi/meta/schema/additional_properties.rb

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

@@ -1,35 +0,0 @@
-# frozen_string_literal: true
-
-module Jsapi
-  module Meta
-    module Base
-      # The base reference class.
-      class Reference < Model
-        ##
-        # :attr: ref
-        # The name of the referred object.
-        attribute :ref, String
-
-        # Derrives the component type from the inner most module name.
-        def self.component_type
-          @component_type ||= name.split('::')[-2].underscore
-        end
-
-        # Returns true.
-        def reference?
-          true
-        end
-
-        # Resolves +ref+ by looking up the object with that name in +definitions+.
-        #
-        # Raises a ReferenceError if +ref+ could not be resolved.
-        def resolve(definitions)
-          object = definitions.send("find_#{self.class.component_type}", ref)
-          raise ReferenceError, ref if object.nil?
-
-          object.resolve(definitions)
-        end
-      end
-    end
-  end
-end

data/lib/jsapi/meta/base.rb

@@ -1,6 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'base/type_caster'
-require_relative 'base/attributes'
-require_relative 'base/model'
-require_relative 'base/reference'

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

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-module Jsapi
-  module Meta
-    module Parameter
-      module ToOpenAPI
-        def to_openapi(version, definitions)
-          to_openapi_parameters(version, definitions).first
-        end
-      end
-    end
-  end
-end