jsapi 0.5.0 → 0.6.1

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

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Jsapi
+  module Meta
+    module Base
+      # The base meta model class.
+      class Model
+        extend Attributes
+
+        # Creates a new meta model.
+        #
+        # Raises an +ArgumentError+ if at least one keyword is not supported.
+        def initialize(keywords = {})
+          keywords.each do |key, value|
+            if respond_to?(method = "#{key}=")
+              public_send(method, value)
+            else
+              raise ArgumentError, "unsupported keyword: #{key}"
+            end
+          end
+        end
+
+        def inspect # :nodoc:
+          klass = self.class
+          "#<#{klass.name} #{
+            klass.attribute_names.map do |name|
+              "#{name}: #{send(name).inspect}"
+            end.join(', ')
+          }>"
+        end
+
+        # Returns false.
+        def reference?
+          false
+        end
+
+        # Returns itself.
+        def resolve(*)
+          self
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+# 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
+
+        # Returns the name of the method to be called to look up the referred object
+        # in a Definitions instance.
+        def self.lookup_method_name
+          @lookup_method_name ||= name.delete_suffix('::Reference').demodulize.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(self.class.lookup_method_name, ref)
+          raise ReferenceError, ref if object.nil?
+
+          object.resolve(definitions)
+        end
+      end
+    end
+  end
+end

data/lib/jsapi/meta/{attributes → base}/type_caster.rb

@@ -2,7 +2,7 @@
 
 module Jsapi
   module Meta
-    module Attributes
+    module Base
       class TypeCaster
         STRING_CASTER = ->(arg) { arg&.to_s } # :nodoc:
 
@@ -41,7 +41,7 @@ module Jsapi
           casted_value = @caster.call(value)
           return casted_value unless @values&.exclude?(casted_value)
 
-          raise InvalidArgumentError.new(@name, casted_value, @values)
+          raise InvalidArgumentError.new(@name, casted_value, valid_values: @values)
         end
       end
     end

data/lib/jsapi/meta/base.rb

@@ -1,42 +1,6 @@
 # frozen_string_literal: true
 
-module Jsapi
-  module Meta
-    # The base meta model class.
-    class Base
-      extend Attributes::ClassMethods
-
-      # Creates a new meta model.
-      #
-      # Raises an +ArgumentError+ if at least one keyword is not supported.
-      def initialize(keywords = {})
-        keywords.each do |key, value|
-          if respond_to?(method = "#{key}=")
-            public_send(method, value)
-          else
-            raise ArgumentError, "unsupported keyword: #{key}"
-          end
-        end
-      end
-
-      def inspect # :nodoc:
-        klass = self.class
-        "#<#{klass.name} #{
-          klass.attribute_names.map do |name|
-            "#{name}: #{send(name).inspect}"
-          end.join(', ')
-        }>"
-      end
-
-      # Returns true if and only if this is a reference.
-      def reference?
-        false
-      end
-
-      # Returns itself.
-      def resolve(*)
-        self
-      end
-    end
-  end
-end
+require_relative 'base/type_caster'
+require_relative 'base/attributes'
+require_relative 'base/model'
+require_relative 'base/reference'

data/lib/jsapi/meta/callable/symbol_evaluator.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Jsapi
+  module Meta
+    module Callable
+      class SymbolEvaluator
+        attr_reader :symbol
+
+        def initialize(symbol)
+          @symbol = symbol
+          @keys = [@symbol, @symbol.to_s]
+        end
+
+        def inspect # :nodoc:
+          "#<#{self.class.name} #{@symbol.inspect}>"
+        end
+
+        # Evaluates the symbol within the context of +object+.
+        def call(object)
+          if object.respond_to?(@symbol)
+            object.public_send(@symbol)
+          elsif object.respond_to?(:[]) && object.respond_to?(:key?)
+            @keys.each { |key| return object[key] if object.key?(key) }
+            nil
+          end
+        end
+      end
+    end
+  end
+end

data/lib/jsapi/meta/callable/symbol_sequence_evaluator.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Jsapi
+  module Meta
+    module Callable
+      class SymbolSequenceEvaluator
+        attr_reader :symbols
+
+        def initialize(*symbols)
+          @symbols = symbols
+          @callables = symbols.map { |symbol| SymbolEvaluator.new(symbol) }
+        end
+
+        def inspect # :nodoc:
+          "#<#{self.class.name} #{@symbols.inspect}>"
+        end
+
+        # Evaluates the symbols in sequence starting within the context of +object+.
+        def call(object)
+          @callables.each do |callable|
+            object = callable.call(object)
+            break if object.nil?
+          end
+          object
+        end
+      end
+    end
+  end
+end

data/lib/jsapi/meta/callable.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require_relative 'callable/symbol_evaluator'
+require_relative 'callable/symbol_sequence_evaluator'
+
+module Jsapi
+  module Meta
+    module Callable
+      class << self
+        def from(arg)
+          raise ArgumentError, "argument can't be blank" if arg.blank?
+
+          return arg if arg.respond_to?(:call) # e.g. a Proc
+
+          symbols = Array.wrap(arg).flat_map do |symbol|
+            next symbol if symbol.is_a?(Symbol)
+
+            symbol.to_s.split('.')
+          end.map(&:to_sym)
+
+          return SymbolEvaluator.new(symbols.first) if symbols.one?
+
+          SymbolSequenceEvaluator.new(*symbols)
+        end
+      end
+    end
+  end
+end

data/lib/jsapi/meta/defaults.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Jsapi
+  module Meta
+    # Holds the default values for a particular Schema type.
+    class Defaults < Base::Model
+      ##
+      # :attr: read
+      # The default value of parameters and properties when reading requests.
+      attribute :within_requests, Object
+
+      ##
+      # :attr: write
+      # The default value of properties when writing responses.
+      attribute :within_responses, Object
+
+      # Returns the default value within +context+.
+      def value(context:)
+        case context
+        when :request
+          within_requests
+        when :response
+          within_responses
+        end
+      end
+    end
+  end
+end

data/lib/jsapi/meta/definitions.rb

@@ -3,26 +3,33 @@
 module Jsapi
   module Meta
     class Definitions
-      attr_reader :callbacks, :examples, :openapi_root, :operations, :parameters,
-                  :request_bodies, :rescue_handlers, :responses, :schemas
+      extend Base::Attributes
+
+      ##
+      # :attr: defaults
+      # The general default values.
+      attribute :defaults, { String => Defaults }, keys: Schema::TYPES, default: {}
+
+      ##
+      # :attr: openapi_root
+      # The OpenAPI::Root.
+      attribute :openapi_root, OpenAPI::Root
+
+      attr_reader :callbacks, :operations, :parameters, :request_bodies,
+                  :rescue_handlers, :responses, :schemas
 
       def initialize(owner = nil)
-        @callbacks = { on_rescue: [] }
         @owner = owner
-        @examples = {}
+        @callbacks = { on_rescue: [] }
         @operations = {}
         @parameters = {}
         @request_bodies = {}
+        @rescue_handlers = []
         @responses = {}
         @schemas = {}
-        @rescue_handlers = []
         @self_and_included = [self]
       end
 
-      def add_example(name, keywords = {})
-        @examples[name.to_s] = OpenAPI::Example.new(keywords)
-      end
-
       def add_on_rescue(method_or_proc)
         @callbacks[:on_rescue] << method_or_proc
       end
@@ -55,11 +62,14 @@ module Jsapi
         @schemas[name] = Schema.new(keywords)
       end
 
-      def example(name)
-        return unless (name = name.to_s).present?
+      def default_value(type, context: nil)
+        return unless (type = type.to_s).present?
 
-        definitions = @self_and_included.find { |d| d.examples.key?(name) }
-        definitions.examples[name] if definitions
+        @self_and_included.each do |definitions|
+          default = definitions.default(type)
+          return default.value(context: context) if default
+        end
+        nil
       end
 
       def include(definitions)
@@ -71,13 +81,13 @@ module Jsapi
       def inspect # :nodoc:
         "#<#{self.class.name} #{
           %i[owner operations parameters request_bodies responses schemas
-             examples openapi_root rescue_handlers].map do |name|
+             openapi_root rescue_handlers].map do |name|
             "#{name}: #{instance_variable_get("@#{name}").inspect}"
           end.join(', ')
         }>"
       end
 
-      # Returns the JSON Schema document for the given schema as a +Hash+.
+      # Returns a hash representing the \JSON \Schema document for +name+.
       def json_schema_document(name)
         schema(name)&.to_json_schema&.tap do |hash|
           definitions =
@@ -97,7 +107,8 @@ module Jsapi
         end
       end
 
-      # Returns a hash representing the OpenAPI document for +version+.
+      # Returns a hash representing the \OpenAPI document for +version+.
+
       # Raises an +ArgumentError+ if +version+ is not supported.
       def openapi_document(version = nil)
         version = OpenAPI::Version.from(version)
@@ -111,22 +122,24 @@ module Jsapi
               parameters: openapi_parameters(version),
               responses: openapi_responses(version)
             )
+            operations = @self_and_included.map(&:operations).reduce(&:reverse_merge).values
+
+            consumes = operations.filter_map { |operation| operation.consumes(self) }
+            h[:consumes] = consumes.uniq.sort if consumes.present?
+
+            produces = operations.flat_map { |operation| operation.produces(self) }
+            h[:produces] = produces.uniq.sort if produces.present?
           else
             h[:components] = (h[:components] || {}).merge(
               schemas: openapi_schemas(version),
               parameters: openapi_parameters(version),
               requestBodies: openapi_request_bodies(version),
-              responses: openapi_responses(version),
-              examples: openapi_examples
+              responses: openapi_responses(version)
             ).compact.presence
           end
         end.compact
       end
 
-      def openapi_root=(keywords = {})
-        @openapi_root = OpenAPI::Root.new(**keywords)
-      end
-
       def operation(name = nil)
         if (name = name.to_s).present?
           definitions = @self_and_included.find { |d| d.operations.key?(name) }
@@ -185,13 +198,6 @@ module Jsapi
         @default_path ||= "/#{default_operation_name}"
       end
 
-      def openapi_examples
-        @self_and_included
-          .map(&:examples).reduce(&:merge)
-          .transform_values(&:to_openapi)
-          .presence
-      end
-
       def openapi_parameters(version)
         @self_and_included
           .map(&:parameters).reduce(&:merge)

data/lib/jsapi/meta/openapi/callback/model.rb

@@ -5,7 +5,7 @@ module Jsapi
     module OpenAPI
       module Callback
         # Represents a callback object. Applies to \OpenAPI 3.0 and higher.
-        class Model < Base
+        class Model < Meta::Base::Model
           ##
           # :attr: operations
           attribute :operations, writer: false, default: {}

data/lib/jsapi/meta/openapi/callback/reference.rb

@@ -4,7 +4,7 @@ module Jsapi
   module Meta
     module OpenAPI
       module Callback
-        class Reference < BaseReference
+        class Reference < Meta::Base::Reference
           # Returns a hash representing the \OpenAPI reference object.
           def to_openapi(*)
             { '$ref': "#/components/callbacks/#{ref}" }

data/lib/jsapi/meta/openapi/contact.rb

@@ -4,7 +4,7 @@ module Jsapi
   module Meta
     module OpenAPI
       # Represents a contact object.
-      class Contact < Base
+      class Contact < Meta::Base::Model
         include Extensions
 
         ##

data/lib/jsapi/meta/openapi/example/model.rb

@@ -4,7 +4,7 @@ module Jsapi
   module Meta
     module OpenAPI
       module Example
-        class Model < Base
+        class Model < Meta::Base::Model
           include Extensions
 
           ##

data/lib/jsapi/meta/openapi/example/reference.rb

@@ -4,7 +4,7 @@ module Jsapi
   module Meta
     module OpenAPI
       module Example
-        class Reference < BaseReference
+        class Reference < Meta::Base::Reference
           # Returns a hash representing the \OpenAPI reference object.
           def to_openapi(*)
             { '$ref': "#/components/examples/#{ref}" }

data/lib/jsapi/meta/openapi/external_documentation.rb

@@ -4,7 +4,7 @@ module Jsapi
   module Meta
     module OpenAPI
       # Represents an external documentation object.
-      class ExternalDocumentation < Base
+      class ExternalDocumentation < Meta::Base::Model
         include Extensions
 
         ##

data/lib/jsapi/meta/openapi/header/model.rb

@@ -4,11 +4,23 @@ module Jsapi
   module Meta
     module OpenAPI
       module Header
-        class Model < Base
+        class Model < Meta::Base::Model
           include Extensions
 
           delegate_missing_to :schema
 
+          ##
+          # :attr: collection_format
+          # The collection format of a header whose values are arrays. Possible values are:
+          #
+          # - <code>"csv"</code> -  comma separated values
+          # - <code>"pipes"</code> - pipe separated values
+          # - <code>"ssv"</code> - space separated values
+          # - <code>"tsv"</code> - tab separated values
+          #
+          # Applies to \OpenAPI 2.0.
+          attribute :collection_format, values: %w[csv pipes ssv tsv]
+
           ##
           # :attr: deprecated
           # Specifies whether or not the header is deprecated.
@@ -30,8 +42,10 @@ module Jsapi
           attribute :schema, writer: false
 
           def initialize(keywords = {})
+            raise ArgumentError, "type can't be object" if keywords[:type] == 'object'
+
             keywords = keywords.dup
-            super(keywords.extract!(:deprecated, :description, :examples))
+            super(keywords.extract!(:collection_format, :deprecated, :description, :examples))
 
             add_example(value: keywords.delete(:example)) if keywords.key?(:example)
 
@@ -45,6 +59,7 @@ module Jsapi
             with_openapi_extensions(
               if version.major == 2
                 schema.to_openapi(version).merge(
+                  collection_format: (collection_format if array?),
                   description: description
                 )
               else

data/lib/jsapi/meta/openapi/header/reference.rb

@@ -4,7 +4,7 @@ module Jsapi
   module Meta
     module OpenAPI
       module Header
-        class Reference < BaseReference
+        class Reference < Meta::Base::Reference
           # Returns a hash representing the \OpenAPI reference object.
           def to_openapi(*)
             { '$ref': "#/components/headers/#{ref}" }

data/lib/jsapi/meta/openapi/info.rb

@@ -4,7 +4,7 @@ module Jsapi
   module Meta
     module OpenAPI
       # Represents an info object.
-      class Info < Base
+      class Info < Meta::Base::Model
         include Extensions
 
         ##

data/lib/jsapi/meta/openapi/license.rb

@@ -4,7 +4,7 @@ module Jsapi
   module Meta
     module OpenAPI
       # Represents a license object.
-      class License < Base
+      class License < Meta::Base::Model
         include Extensions
 
         ##

data/lib/jsapi/meta/openapi/link/model.rb

@@ -5,7 +5,7 @@ module Jsapi
     module OpenAPI
       module Link
         # Represents a link object.
-        class Model < Base
+        class Model < Meta::Base::Model
           include Extensions
 
           ##

data/lib/jsapi/meta/openapi/link/reference.rb

@@ -4,7 +4,7 @@ module Jsapi
   module Meta
     module OpenAPI
       module Link
-        class Reference < BaseReference
+        class Reference < Meta::Base::Reference
           # Returns a hash representing the \OpenAPI reference object.
           def to_openapi(*)
             { '$ref': "#/components/links/#{ref}" }

data/lib/jsapi/meta/openapi/oauth_flow.rb

@@ -4,10 +4,10 @@ module Jsapi
   module Meta
     module OpenAPI
       # Represents an OAuth flow object.
-      class OAuthFlow < Base
+      class OAuthFlow < Base::Model
         include Extensions
 
-        class Scope < Base
+        class Scope < Meta::Base::Model
           ##
           # :attr: description
           # The optional description of the scope.

data/lib/jsapi/meta/openapi/root.rb

@@ -4,7 +4,7 @@ module Jsapi
   module Meta
     module OpenAPI
       # Represents an \OpenAPI object.
-      class Root < Base
+      class Root < Meta::Base::Model
         include Extensions
 
         ##
@@ -18,17 +18,13 @@ module Jsapi
         attribute :base_path, String
 
         ##
-        # :attr: consumes
-        # The MIME types the API can consume. Applies to \OpenAPI 2.0.
-        attribute :consumed_mime_types, [String]
-
-        alias :consumes :consumed_mime_types
-        alias :consumes= :consumed_mime_types=
-        alias :add_consumes :add_consumed_mime_type
+        # :attr: examples
+        # The reusable Example objects. Applies to \OpenAPI 3.0 and higher.
+        attribute :examples, { String => Example }
 
         ##
         # :attr: external_docs
-        # The optional ExternalDocumentation object.
+        # The ExternalDocumentation object.
         attribute :external_docs, ExternalDocumentation
 
         ##
@@ -51,15 +47,6 @@ module Jsapi
         # The reusable Link objects. Applies to \OpenAPI 3.0 and higher.
         attribute :links, { String => Link }
 
-        ##
-        # :attr: produces
-        # The MIME types the API can produce. Applies to \OpenAPI 2.0.
-        attribute :produced_mime_types, [String]
-
-        alias :produces :produced_mime_types
-        alias :produces= :produced_mime_types=
-        alias :add_produces :add_produced_mime_type
-
         ##
         # :attr: schemes
         # The array of transfer protocols supported by the API. Possible values are:
@@ -111,8 +98,6 @@ module Jsapi
                 host: host || uri&.hostname,
                 basePath: base_path || uri&.path,
                 schemes: schemes || uri&.scheme&.then { |scheme| [scheme] },
-                consumes: consumed_mime_types,
-                produces: produced_mime_types,
                 securityDefinitions: security_schemes,
                 security: security_requirements&.map(&:to_openapi),
                 tags: tags&.map(&:to_openapi),
@@ -127,6 +112,7 @@ module Jsapi
                   callbacks: callbacks&.transform_values do |callback|
                     callback.to_openapi(version, definitions)
                   end,
+                  examples: examples&.transform_values(&:to_openapi),
                   headers: headers&.transform_values do |header|
                     header.to_openapi(version)
                   end,

data/lib/jsapi/meta/openapi/security_requirement.rb

@@ -4,8 +4,8 @@ module Jsapi
   module Meta
     module OpenAPI
       # Represents a security requirement object.
-      class SecurityRequirement < Base
-        class Scheme < Base
+      class SecurityRequirement < Meta::Base::Model
+        class Scheme < Meta::Base::Model
           ##
           # :attr: scopes
           # The array of scopes.

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

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

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

@@ -40,7 +40,7 @@ module Jsapi
               raise InvalidArgumentError.new(
                 'type',
                 type,
-                %w[api_key basic http oauth2 open_id_connect]
+                valid_values: %w[api_key basic http oauth2 open_id_connect]
               )
             end
           end

data/lib/jsapi/meta/openapi/server.rb

@@ -4,7 +4,7 @@ module Jsapi
   module Meta
     module OpenAPI
       # Represents a server object.
-      class Server < Base
+      class Server < Meta::Base::Model
         include Extensions
 
         ##