jsapi 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5740302f08b361b1f70f50844a1c3858e8bf2d29b781ea245ec201c2290fb3f4
-  data.tar.gz: 27f401b21f5fece8a1dd675ab8597a7822d101a3d738a6f5ef76e5a8969dca8d
+  metadata.gz: 162f63ee5ef06ba76a2acb100e92928144533e8d2486175b95cf4f8a38d6f93d
+  data.tar.gz: bf6579a80a1bdc8eb2ab3ca7921f42f1a68466508425568e3c5b984e7e1b34b8
 SHA512:
-  metadata.gz: fe84b39402a26fa951058ba59fab7cc20e0e0321c74826b672bd65b87a4975d68f37517bfa54f62549f2287c3221702d4d338e312ae01551481f5a529a865f40
-  data.tar.gz: 476347dfb1a27d43dc42835d87a845a75806a7a6c6f721ad9e372d53d435650c685b9cf7c8cb70f34718dffc675e1536475851b841e549b50789f9f08965aa33
+  metadata.gz: 71c6b38cb010530b4b6f4cfebee131981c2874114bf663287739452f709863e64e073b358dded464ee86d2d14ce68439170e15c709667d1098a804f874728cd3
+  data.tar.gz: 8e60c31c91af85df15c2bb9c2c0a17fa67599df3621c90603bbe624615a6749e3a909b1a8e91cb5ea5a7aab8d75ee03adaf32ea28e4abd95d30bc7fd1cadd754

data/lib/jsapi/controller/error_result.rb

@@ -2,19 +2,26 @@
 
 module Jsapi
   module Controller
-    # Used by +api_operation!+ to produce an error response.
+    # Used by Methods#api_operation! to produce an error response.
     class ErrorResult
+      delegate_missing_to :@exception
 
       # The HTTP status code of the error response to be produced.
       attr_reader :status
 
-      delegate :message, :to_s, to: :@exception
-
       # Creates a new instance to produce an error response with the given HTTP status code.
-      def initialize(exception, status:)
+      def initialize(exception, status: nil)
         @exception = exception
         @status = status
       end
+
+      # Returns the string representation of the exception encountered to render this string
+      # when the response type is +string+, for example:
+      #
+      #   response 500, type: 'string'
+      def to_s
+        @exception.to_s
+      end
     end
   end
 end

data/lib/jsapi/controller/parameters.rb

@@ -45,7 +45,7 @@ module Jsapi
         [
           validate_attributes(errors),
           !@strong || validate_parameters(
-            @params.except(:controller, :action),
+            @params.except(:controller, :action, :format),
             attributes,
             errors
           )

data/lib/jsapi/controller/parameters_invalid.rb

@@ -2,8 +2,10 @@
 
 module Jsapi
   module Controller
-    # Raised by Methods#api_operation! if the request parameters are invalid.
+    # Raised by Methods#api_operation! when the request parameters are invalid.
     class ParametersInvalid < StandardError
+
+      # The parameters.
       attr_reader :params
 
       def initialize(params)
@@ -11,13 +13,14 @@ module Jsapi
         super('')
       end
 
-      # Overrides <code>StandardError#message</code> to lazily generate the error message.
+      # Returns the errors encountered.
+      def errors
+        @params.errors.errors
+      end
+
+      # Overrides <code>Exception#message</code> to lazily generate the error message.
       def message
-        "#{
-          @params.errors.full_messages.map do |message|
-            message.delete_suffix('.')
-          end.join('. ')
-        }."
+        "#{@params.errors.full_messages.map { |m| m.delete_suffix('.') }.join('. ')}."
       end
     end
   end

data/lib/jsapi/controller/response.rb

@@ -81,7 +81,11 @@ module Jsapi
         # Serialize properties
         properties = schema.resolve_properties(:read, @definitions).transform_values do |property|
           serialize(
-            object.public_send(property.source || property.name.underscore),
+            if (method_chain = property.source).present?
+              method_chain.call(object)
+            else
+              object.public_send(property.name.underscore)
+            end,
             property.schema.resolve(@definitions),
             path.nil? ? property.name : "#{path}.#{property.name}"
           )
@@ -89,7 +93,7 @@ module Jsapi
         if (additional_properties = schema.additional_properties&.resolve(@definitions))
           additional_properties_schema = additional_properties.schema.resolve(@definitions)
 
-          object.public_send(additional_properties.source)&.each do |key, value|
+          additional_properties.source.call(object)&.each do |key, value|
             # Don't replace the property with the same key
             next if properties.key?(key = key.to_s)
 

data/lib/jsapi/meta/attributes/class_methods.rb

@@ -54,7 +54,8 @@ module Jsapi
 
             # hash value reader
             define_method(singular_name) do |key = nil|
-              send(name)&.[](key_type_caster.cast(key) || default_key)
+              key = default_key if key.to_s.empty?
+              send(name)&.[](key_type_caster.cast(key))
             end
 
             if writer
@@ -66,9 +67,10 @@ module Jsapi
                   key = default_key
                   value = key_or_value
                 else
-                  key = key_or_value || default_key
+                  key = key_or_value
+                  key = default_key if key.to_s.empty?
                 end
-                raise ArgumentError, "key can't be blank" if key.blank?
+                raise ArgumentError, "key can't be blank" if key.to_s.empty?
 
                 casted_key = key_type_caster.cast(key)
                 casted_value = value_type_caster.cast(value)

data/lib/jsapi/meta/method_chain.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Jsapi
+  module Meta
+    class MethodChain
+      # The methods to be called in chain.
+      attr_reader :methods
+
+      def initialize(methods)
+        @methods = Array.wrap(methods).flat_map do |method|
+          next method if method.is_a?(Symbol)
+
+          method.to_s.split('.')
+        end.map(&:to_sym)
+      end
+
+      def inspect # :nodoc:
+        "#<#{self.class.name} #{methods.inspect}>"
+      end
+
+      # Calls the chained methods on +object+.
+      def call(object)
+        return if methods.blank?
+
+        methods.each do |method|
+          object = object.public_send(method)
+        end
+        object
+      end
+    end
+  end
+end

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

@@ -7,6 +7,8 @@ module Jsapi
         class Model < Base
           include Extensions
 
+          delegate_missing_to :schema
+
           ##
           # :attr: deprecated
           # Specifies whether or not the header is deprecated.
@@ -27,8 +29,6 @@ module Jsapi
           # The Schema of the header.
           attribute :schema, writer: false
 
-          delegate_missing_to :schema
-
           def initialize(keywords = {})
             keywords = keywords.dup
             super(keywords.extract!(:deprecated, :description, :examples))

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

@@ -6,6 +6,8 @@ module Jsapi
       class Model < Base
         include OpenAPI::Extensions
 
+        delegate_missing_to :schema
+
         ##
         # :attr: deprecated
         # Specifies whether or not the parameter is deprecated.
@@ -41,8 +43,6 @@ module Jsapi
         # The Schema of the parameter.
         attribute :schema, writer: false
 
-        delegate_missing_to :schema
-
         # Creates a new parameter.
         #
         # Raises an +ArgumentError+ if +name+ is blank.

data/lib/jsapi/meta/property.rb

@@ -3,6 +3,8 @@
 module Jsapi
   module Meta
     class Property < Base
+      delegate_missing_to :schema
+
       ##
       # :attr_reader: name
       # The name of the property.
@@ -19,15 +21,13 @@ module Jsapi
 
       ##
       # :attr: source
-      # The alternative method to read a property value when serializing an object.
-      attribute :source, Symbol
+      # The MethodChain to be called when reading a property value.
+      attribute :source, MethodChain
 
       ##
       # :attr: write_only
       attribute :write_only, values: [true, false]
 
-      delegate_missing_to :schema
-
       # Creates a new property.
       #
       # Raises an +ArgumentError+ if +name+ is blank.

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

@@ -6,6 +6,8 @@ module Jsapi
       class Model < Base
         include OpenAPI::Extensions
 
+        delegate_missing_to :schema
+
         ##
         # :attr: description
         # The optional description of the request body.
@@ -21,8 +23,6 @@ module Jsapi
         # The Schema of the request body.
         attribute :schema, writer: false
 
-        delegate_missing_to :schema
-
         def initialize(keywords = {})
           keywords = keywords.dup
           super(keywords.extract!(:description, :examples))

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

@@ -6,6 +6,8 @@ module Jsapi
       class Model < Base
         include OpenAPI::Extensions
 
+        delegate_missing_to :schema
+
         ##
         # :attr: description
         # The optional description of the response.
@@ -36,8 +38,6 @@ module Jsapi
         # The Schema of the response.
         attribute :schema, writer: false
 
-        delegate_missing_to :schema
-
         def initialize(keywords = {})
           keywords = keywords.dup
           super(keywords.extract!(:description, :examples, :locale))

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

@@ -4,18 +4,20 @@ module Jsapi
   module Meta
     module Schema
       class AdditionalProperties < Meta::Base
-        #
+        DEFAULT_METHOD_CHAIN = MethodChain.new(:additional_properties) # :nodoc:
+
+        delegate_missing_to :schema
+
+        ##
         # :attr: schema
         # The Schema of additional properties.
         attribute :schema, Schema, writer: false
 
         ##
         # :attr: source
-        # The method to read additional properties when serializing an object.
+        # The MethodChain to be called when reading additional properties.
         # The default method is +additional_properties+.
-        attribute :source, Symbol, default: :additional_properties
-
-        delegate_missing_to :schema
+        attribute :source, MethodChain, default: DEFAULT_METHOD_CHAIN
 
         def initialize(keywords = {})
           keywords = keywords.dup

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

@@ -5,11 +5,11 @@ module Jsapi
     module Schema
       # Used by Reference to delegate method calls to the referred schema.
       class Delegator
+        delegate_missing_to :@schema
+
         # The level of Existence.
         attr_reader :existence
 
-        delegate_missing_to :@schema
-
         def initialize(schema, existence)
           @schema = schema
           @existence = existence

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

@@ -6,7 +6,7 @@ module Jsapi
       class Discriminator < Meta::Base
         ##
         # :attr: mappings
-        attribute :mappings, { String => String }
+        attribute :mappings, { Object => String }
 
         ##
         # :attr: property_name
@@ -27,7 +27,7 @@ module Jsapi
 
           {
             propertyName: property_name,
-            mapping: mappings
+            mapping: mappings&.transform_keys(&:to_s)
           }.compact
         end
       end

data/lib/jsapi/meta.rb

@@ -7,6 +7,7 @@ require_relative 'meta/base'
 require_relative 'meta/base_reference'
 require_relative 'meta/openapi'
 require_relative 'meta/existence'
+require_relative 'meta/method_chain'
 require_relative 'meta/property'
 require_relative 'meta/schema'
 require_relative 'meta/request_body'

data/lib/jsapi/model/nested_error.rb

@@ -4,10 +4,10 @@ module Jsapi
   module Model
     # Wraps an error related to a nested model.
     class NestedError
-      attr_reader :attribute, :error
-
       delegate_missing_to :error
 
+      attr_reader :attribute, :error
+
       def initialize(attribute, error)
         @attribute = attribute
         @error = error

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.4.0'
+    VERSION = '0.5.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jsapi
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Denis Göller
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-08-21 00:00:00.000000000 Z
+date: 2024-08-31 00:00:00.000000000 Z
 dependencies: []
 description: Jsapi can be used to read requests, produce responses and create OpenAPI
   documents
@@ -58,6 +58,7 @@ files:
 - lib/jsapi/meta/definitions.rb
 - lib/jsapi/meta/existence.rb
 - lib/jsapi/meta/invalid_argument_error.rb
+- lib/jsapi/meta/method_chain.rb
 - lib/jsapi/meta/openapi.rb
 - lib/jsapi/meta/openapi/callback.rb
 - lib/jsapi/meta/openapi/callback/model.rb