jsapi 0.1.1

data/lib/jsapi/model/base.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Jsapi
+  module Model
+    # The base API model used to represent top-level parameters and nested
+    # object parameters by default.
+    class Base
+      extend Naming
+
+      include Attributes
+      include Validations
+
+      def initialize(nested)
+        @nested = nested
+      end
+
+      def ==(other) # :nodoc:
+        super || (
+          self.class == other.class &&
+          attributes == other.attributes
+        )
+      end
+
+      def inspect # :nodoc:
+        "#<#{self.class.name} " \
+        "#{attributes.map { |k, v| "#{k}: #{v.inspect}" }.join(', ')}>"
+      end
+
+      private
+
+      attr_reader :nested
+    end
+  end
+end

data/lib/jsapi/model/error.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Jsapi
+  module Model
+    class Error < ActiveModel::Error
+
+      # Overrides <code>ActiveModel::Error#full_message</code>.
+      def full_message
+        return message if attribute == :base || attribute.blank?
+
+        "'#{attribute}' #{message}".rstrip
+      end
+    end
+  end
+end

data/lib/jsapi/model/errors.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Jsapi
+  module Model
+    class Errors < ActiveModel::Errors
+      def initialize(base = nil)
+        @base = base
+        @path = []
+        super
+      end
+
+      # 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.
+      def import(error, options = {})
+        if (options = options.slice(:attribute, :type)).any?
+          attribute = (options[:attribute] || error.attribute).to_sym
+          type = options[:type] || error.raw_type
+          error = Error.new(error.base, attribute, type, **error.options)
+        end
+        errors << wrap(error)
+      end
+
+      # Calls the block in context of +attribute+.
+      def nested(attribute, &block)
+        @path.push(attribute.to_sym)
+        block&.call
+      ensure
+        @path.pop
+      end
+
+      private
+
+      def wrap(error)
+        return error if @path.empty?
+
+        @path.reverse_each do |attribute|
+          error = NestedError.new(attribute, error)
+        end
+        error
+      end
+    end
+  end
+end

data/lib/jsapi/model/naming.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Jsapi
+  module Model
+    module Naming
+      include ActiveModel::Naming
+      include ActiveModel::Translation
+
+      # Overrides <code>ActiveModel::Naming#model_name</code> to support
+      # anonymous model classes.
+      def model_name
+        @_model_name ||= begin
+          # Copied from ActiveModel::Naming#model_name
+          namespace = module_parents.detect do |m|
+            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
+          klass = self
+          klass = klass.superclass while klass.name.nil?
+
+          ActiveModel::Name.new(klass, namespace)
+        end
+      end
+    end
+  end
+end

data/lib/jsapi/model/nestable.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Jsapi
+  module Model
+    module Nestable
+
+      # Returns the value assigned to +name+.
+      def [](name)
+        raw_attributes[name&.to_s]&.value
+      end
+
+      # Returns +true+ if +name+ is present, false +otherwise+.
+      def attribute?(name)
+        raw_attributes.key?(name&.to_s)
+      end
+
+      # Returns a +Hash+ containing all attributes.
+      def attributes
+        raw_attributes.transform_values(&:value)
+      end
+
+      private
+
+      def validate_attributes(errors)
+        raw_attributes.map do |key, value|
+          errors.nested(key) do
+            next value.validate(errors) unless value.respond_to?(:model)
+            next true if (model = value.model).valid?
+
+            errors.merge!(model)
+            false
+          end
+        end.all?
+      end
+    end
+  end
+end

data/lib/jsapi/model/nested_error.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Jsapi
+  module Model
+    # Wraps an error related to a nested model.
+    class NestedError
+      attr_reader :attribute, :error
+
+      delegate_missing_to :error
+
+      def initialize(attribute, error)
+        @attribute = attribute
+        @error = error
+      end
+
+      def ==(other) # :nodoc:
+        other.is_a?(self.class) &&
+          @attribute == other.attribute &&
+          @error == other.error
+      end
+
+      # Like <code>ActiveModel::Error#full_message</code>.
+      def full_message
+        base? ? "'#{attribute}' #{message}" : "'#{attribute}.#{message[1..]}"
+      end
+
+      # Like <code>ActiveModel::Error#match?</code>.
+      def match?(attribute, type = nil, **options)
+        return false if self.attribute != attribute
+        return true if type.nil? && options.empty?
+
+        @error.match?(:base, type, **options)
+      end
+
+      # Like <code>ActiveModel::Error#message</code>.
+      def message
+        base? ? @error.message : "'#{@error.attribute}' #{@error.message}".rstrip
+      end
+
+      # Like <code>ActiveModel::Error#strict_match?</code>.
+      def strict_match?(attribute, type = nil, **options)
+        return false unless match?(attribute, type, **options)
+
+        @error.strict_match?(:base, type, **options)
+      end
+
+      private
+
+      def base?
+        @error.attribute == :base
+      end
+    end
+  end
+end

data/lib/jsapi/model/validations.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Jsapi
+  module Model
+    module Validations
+      extend ActiveSupport::Concern
+
+      include ActiveModel::Validations
+
+      included do
+        validate :nested_validity
+      end
+
+      # Overrides <code>ActiveModel::Validations#errors</code> to use
+      # Errors as error store.
+      def errors
+        @errors ||= Errors.new(self)
+      end
+
+      private
+
+      def nested_validity
+        nested.validate(errors)
+      end
+    end
+  end
+end

data/lib/jsapi/model.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative 'model/error'
+require_relative 'model/nested_error'
+require_relative 'model/errors'
+require_relative 'model/attributes'
+require_relative 'model/naming'
+require_relative 'model/validations'
+require_relative 'model/base'
+require_relative 'model/nestable'
+
+module Jsapi
+  # Provides classes and modules to deal with API models.
+  module Model end
+end

data/lib/jsapi/version.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Jsapi
+  # See https://bundler.io/guides/creating_gem.html
+  module Version # :nodoc:
+    VERSION = '0.1.1'
+  end
+end

data/lib/jsapi.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'jsapi/model'
+require 'jsapi/meta'
+require 'jsapi/dsl'
+require 'jsapi/json'
+require 'jsapi/controller'
+require 'jsapi/version'

metadata

@@ -0,0 +1,162 @@
+--- !ruby/object:Gem::Specification
+name: jsapi
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Denis Göller
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-05-27 00:00:00.000000000 Z
+dependencies: []
+description: Jsapi can be used to read requests, produce responses and create OpenAPI
+  documents
+email: denis@dmgoeller.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/jsapi.rb
+- lib/jsapi/controller.rb
+- lib/jsapi/controller/base.rb
+- lib/jsapi/controller/error_result.rb
+- lib/jsapi/controller/methods.rb
+- lib/jsapi/controller/parameters.rb
+- lib/jsapi/controller/parameters_invalid.rb
+- lib/jsapi/controller/response.rb
+- lib/jsapi/dsl.rb
+- lib/jsapi/dsl/callbacks.rb
+- lib/jsapi/dsl/class_methods.rb
+- lib/jsapi/dsl/definitions.rb
+- lib/jsapi/dsl/error.rb
+- lib/jsapi/dsl/examples.rb
+- lib/jsapi/dsl/node.rb
+- lib/jsapi/dsl/openapi.rb
+- lib/jsapi/dsl/openapi/callback.rb
+- lib/jsapi/dsl/openapi/root.rb
+- lib/jsapi/dsl/operation.rb
+- lib/jsapi/dsl/parameter.rb
+- lib/jsapi/dsl/request_body.rb
+- lib/jsapi/dsl/response.rb
+- lib/jsapi/dsl/schema.rb
+- lib/jsapi/json.rb
+- lib/jsapi/json/array.rb
+- lib/jsapi/json/boolean.rb
+- lib/jsapi/json/integer.rb
+- lib/jsapi/json/null.rb
+- lib/jsapi/json/number.rb
+- lib/jsapi/json/object.rb
+- lib/jsapi/json/string.rb
+- lib/jsapi/json/value.rb
+- lib/jsapi/meta.rb
+- lib/jsapi/meta/attributes.rb
+- lib/jsapi/meta/attributes/class_methods.rb
+- lib/jsapi/meta/attributes/type_caster.rb
+- lib/jsapi/meta/base.rb
+- lib/jsapi/meta/base_reference.rb
+- lib/jsapi/meta/definitions.rb
+- lib/jsapi/meta/example.rb
+- lib/jsapi/meta/example/model.rb
+- lib/jsapi/meta/example/reference.rb
+- lib/jsapi/meta/existence.rb
+- lib/jsapi/meta/invalid_argument_error.rb
+- lib/jsapi/meta/openapi.rb
+- lib/jsapi/meta/openapi/callback.rb
+- lib/jsapi/meta/openapi/callback/model.rb
+- lib/jsapi/meta/openapi/callback/reference.rb
+- lib/jsapi/meta/openapi/contact.rb
+- lib/jsapi/meta/openapi/external_documentation.rb
+- lib/jsapi/meta/openapi/info.rb
+- lib/jsapi/meta/openapi/license.rb
+- lib/jsapi/meta/openapi/link.rb
+- lib/jsapi/meta/openapi/link/model.rb
+- lib/jsapi/meta/openapi/link/reference.rb
+- lib/jsapi/meta/openapi/oauth_flow.rb
+- lib/jsapi/meta/openapi/root.rb
+- lib/jsapi/meta/openapi/security_requirement.rb
+- lib/jsapi/meta/openapi/security_scheme.rb
+- lib/jsapi/meta/openapi/security_scheme/api_key.rb
+- lib/jsapi/meta/openapi/security_scheme/base.rb
+- lib/jsapi/meta/openapi/security_scheme/http.rb
+- lib/jsapi/meta/openapi/security_scheme/http/basic.rb
+- lib/jsapi/meta/openapi/security_scheme/http/bearer.rb
+- lib/jsapi/meta/openapi/security_scheme/http/other.rb
+- lib/jsapi/meta/openapi/security_scheme/oauth2.rb
+- lib/jsapi/meta/openapi/security_scheme/open_id_connect.rb
+- lib/jsapi/meta/openapi/server.rb
+- lib/jsapi/meta/openapi/server_variable.rb
+- lib/jsapi/meta/openapi/tag.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/reference.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/reference.rb
+- lib/jsapi/meta/rescue_handler.rb
+- lib/jsapi/meta/response.rb
+- lib/jsapi/meta/response/model.rb
+- lib/jsapi/meta/response/reference.rb
+- lib/jsapi/meta/schema.rb
+- lib/jsapi/meta/schema/array.rb
+- lib/jsapi/meta/schema/base.rb
+- lib/jsapi/meta/schema/boolean.rb
+- lib/jsapi/meta/schema/boundary.rb
+- lib/jsapi/meta/schema/conversion.rb
+- lib/jsapi/meta/schema/delegator.rb
+- lib/jsapi/meta/schema/discriminator.rb
+- lib/jsapi/meta/schema/integer.rb
+- lib/jsapi/meta/schema/number.rb
+- lib/jsapi/meta/schema/numeric.rb
+- lib/jsapi/meta/schema/object.rb
+- lib/jsapi/meta/schema/reference.rb
+- lib/jsapi/meta/schema/string.rb
+- lib/jsapi/meta/schema/validation.rb
+- lib/jsapi/meta/schema/validation/base.rb
+- lib/jsapi/meta/schema/validation/enum.rb
+- lib/jsapi/meta/schema/validation/max_items.rb
+- lib/jsapi/meta/schema/validation/max_length.rb
+- lib/jsapi/meta/schema/validation/maximum.rb
+- lib/jsapi/meta/schema/validation/min_items.rb
+- lib/jsapi/meta/schema/validation/min_length.rb
+- lib/jsapi/meta/schema/validation/minimum.rb
+- lib/jsapi/meta/schema/validation/multiple_of.rb
+- lib/jsapi/meta/schema/validation/pattern.rb
+- lib/jsapi/model.rb
+- lib/jsapi/model/attributes.rb
+- lib/jsapi/model/base.rb
+- lib/jsapi/model/error.rb
+- lib/jsapi/model/errors.rb
+- lib/jsapi/model/naming.rb
+- lib/jsapi/model/nestable.rb
+- lib/jsapi/model/nested_error.rb
+- lib/jsapi/model/validations.rb
+- lib/jsapi/version.rb
+homepage: https://github.com/dmgoeller/jsapi
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.6
+signing_key:
+specification_version: 4
+summary: Build JSON APIs with Rails
+test_files: []