RubyGems - openapi_blocks - Versions diffs - 0.2.0 → 0.3.0 - Mend

openapi_blocks 0.2.0 → 0.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (16) hide show

checksums.yaml +4 -4
data/CHANGELOG.md +22 -0
data/README.md +152 -85
data/README.pt-BR.md +229 -342
data/app/controllers/openapi_blocks/spec_controller.rb +48 -13
data/config/routes.rb +2 -1
data/lib/openapi_blocks/base.rb +5 -2
data/lib/openapi_blocks/builder.rb +3 -1
data/lib/openapi_blocks/controller.rb +40 -0
data/lib/openapi_blocks/resource.rb +20 -0
data/lib/openapi_blocks/schema/extractor.rb +3 -3
data/lib/openapi_blocks/serializer.rb +193 -0
data/lib/openapi_blocks/spec/components.rb +21 -8
data/lib/openapi_blocks/version.rb +1 -1
data/lib/openapi_blocks.rb +4 -0
metadata +18 -1

data/app/controllers/openapi_blocks/spec_controller.rb CHANGED Viewed

@@ -4,14 +4,19 @@ require "action_controller/api"
 module OpenapiBlocks
   class SpecController < ActionController::API # rubocop:disable Style/Documentation
-    SWAGGER_UI_CSS = "https://unpkg.com/swagger-ui-dist@5.11.0/swagger-ui.css"
-    SWAGGER_UI_STANDALONE_JS = "https://unpkg.com/swagger-ui-dist@5.11.0/swagger-ui-standalone-preset.js"
-    SWAGGER_UI_JS = "https://unpkg.com/swagger-ui-dist@5.11.0/swagger-ui-bundle.js"
+    SWAGGER_UI_CSS             = "https://unpkg.com/swagger-ui-dist@5.11.0/swagger-ui.css"
+    SWAGGER_UI_STANDALONE_JS   = "https://unpkg.com/swagger-ui-dist@5.11.0/swagger-ui-standalone-preset.js"
+    SWAGGER_UI_JS              = "https://unpkg.com/swagger-ui-dist@5.11.0/swagger-ui-bundle.js"
+    SCALAR_JS                  = "https://cdn.jsdelivr.net/npm/@scalar/api-reference"
     def ui
       render html: swagger_ui_html.html_safe
     end
+    def scalar
+      render html: scalar_html.html_safe
+    end
     def show
       spec = OpenapiBlocks::Builder.build.deep_stringify_keys
       spec["servers"] = swagger_ui_servers(spec)
@@ -25,6 +30,42 @@ module OpenapiBlocks
     private
+    def scalar_html
+      spec_url = "#{swagger_spec_base_url}.json"
+      title    = "#{OpenapiBlocks.configuration.info.title} - Scalar"
+      <<~HTML
+        <!doctype html>
+        <html lang="en">
+          <head>
+            <meta charset="utf-8" />
+            <meta name="viewport" content="width=device-width, initial-scale=1" />
+            <title>#{title}</title>
+          </head>
+          <body>
+            <script
+              id="api-reference"
+              data-url="#{spec_url}"
+              data-configuration='#{scalar_configuration.to_json}'
+            ></script>
+            <script src="#{SCALAR_JS}"></script>
+          </body>
+        </html>
+      HTML
+    end
+    def scalar_configuration
+      {
+        theme:                  "default",
+        layout:                 "modern",
+        displayRequestDuration: true,
+        defaultHttpClient:      {
+          targetKey: "ruby",
+          clientKey: "net_http"
+        }
+      }
+    end
     def swagger_ui_html # rubocop:disable Metrics/MethodLength
       urls = swagger_ui_urls
@@ -69,22 +110,16 @@ module OpenapiBlocks
       "#{OpenapiBlocks.configuration.info.title} - SwaggerUI"
     end
-    def swagger_ui_urls # rubocop:disable Metrics/MethodLength
+    def swagger_ui_urls
       spec_base = swagger_spec_base_url
-      servers = OpenapiBlocks.configuration.to_h[:servers]
+      servers   = OpenapiBlocks.configuration.to_h[:servers]
       return default_swagger_ui_urls if servers.blank?
       servers.flat_map do |server|
         [
-          {
-            url:  "#{spec_base}.json",
-            name: "#{server[:url]} JSON"
-          },
-          {
-            url:  "#{spec_base}.yaml",
-            name: "#{server[:url]} YAML"
-          }
+          { url: "#{spec_base}.json", name: "#{server[:url]} JSON" },
+          { url: "#{spec_base}.yaml", name: "#{server[:url]} YAML" }
         ]
       end
     end

data/config/routes.rb CHANGED Viewed

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
 OpenapiBlocks::Engine.routes.draw do
-  root to: "spec#ui"
+  root to: "spec#scalar"
+  get "swagger", to: "spec#ui"
   get "openapi.json", to: "spec#show", defaults: { format: "json" }
   get "openapi.yaml", to: "spec#show", defaults: { format: "yaml" }
 end

data/lib/openapi_blocks/base.rb CHANGED Viewed

@@ -2,6 +2,8 @@
 module OpenapiBlocks
   class Base # rubocop:disable Style/Documentation
+    include Serializer
     class << self
       attr_reader :_model, :_ignored, :_associations, :_virtual_attributes, :_operations, :_tags
@@ -14,9 +16,9 @@ module OpenapiBlocks
         @_ignored.concat(attributes.map(&:to_s))
       end
-      def association(name, type: nil, input: true)
+      def association(name, type: nil, read_only: false)
         @_associations ||= []
-        @_associations << { name: name, type: type, input: input }
+        @_associations << { name: name, type: type, read_only: read_only }
       end
       def attribute(name, **)
@@ -40,6 +42,7 @@ module OpenapiBlocks
       def infer_model
         model_name = name
                      .gsub(/Openapi$/, "")
+                     .gsub(/Resource$/, "")
                      .split("::")
                      .last

data/lib/openapi_blocks/builder.rb CHANGED Viewed

@@ -16,7 +16,9 @@ module OpenapiBlocks
     def openapi_classes
       ObjectSpace.each_object(Class).select do |klass|
-        klass < OpenapiBlocks::Base
+        name = Module.instance_method(:name).bind_call(klass)
+        name&.end_with?("Openapi") &&
+          (klass < OpenapiBlocks::Base || klass < OpenapiBlocks::Controller)
       end
     end
   end

data/lib/openapi_blocks/controller.rb ADDED Viewed

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+module OpenapiBlocks
+  class Controller # rubocop:disable Style/Documentation
+    class << self
+      attr_reader :_resource, :_operations, :_tags
+      def resource(klass)
+        @_resource = klass
+      end
+      def model
+        @_resource&.model
+      end
+      def _associations
+        @_resource&._associations
+      end
+      def _virtual_attributes
+        @_resource&._virtual_attributes
+      end
+      def _ignored
+        @_resource&._ignored
+      end
+      def operation(action, &block)
+        @_operations ||= {}
+        builder = OperationBuilder.new
+        builder.instance_eval(&block) if block
+        @_operations[action] = builder
+      end
+      def tags(*values)
+        values.any? ? @_tags = values : @_tags
+      end
+    end
+  end
+end

data/lib/openapi_blocks/resource.rb ADDED Viewed

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+module OpenapiBlocks
+  class Resource < Base # rubocop:disable Style/Documentation
+    class << self
+      private
+      def infer_model
+        model_name = name
+                     .gsub(/Resource$/, "")
+                     .split("::")
+                     .last
+        Object.const_get(model_name)
+      rescue NameError
+        raise Error, "Could not infer model from #{name}. Use `model ModelClass` to define it explicitly."
+      end
+    end
+  end
+end

data/lib/openapi_blocks/schema/extractor.rb CHANGED Viewed

@@ -63,11 +63,11 @@ module OpenapiBlocks
         Array(@openapi_class._associations).each_with_object({}) do |assoc, hash|
           name      = assoc[:name]
           type      = assoc[:type]
-          input     = assoc.fetch(:input, true)
-          ref       = { "$ref" => "#/components/schemas/#{name.to_s.classify}" }
+          read_only = assoc.fetch(:read_only, false)
+          ref = { "$ref" => "#/components/schemas/#{name.to_s.classify}" }
           schema = type == :array ? { type: "array", items: ref } : ref
-          schema[:readOnly] = true unless input
+          schema[:readOnly] = true if read_only
           hash[name.to_s] = schema
         end

data/lib/openapi_blocks/serializer.rb ADDED Viewed

@@ -0,0 +1,193 @@
+# frozen_string_literal: true
+module OpenapiBlocks
+  module Serializer # rubocop:disable Style/Documentation
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+    module ClassMethods # rubocop:disable Metrics/ModuleLength,Style/Documentation
+      def serialize(resource, instance: nil) # rubocop:disable Lint/UnusedMethodArgument
+        extractor = compiled_extractor
+        if resource.respond_to?(:each)
+          resource.map { |r| extractor.call(r) }
+        else
+          extractor.call(resource)
+        end
+      end
+      def to_json(resource)
+        Oj.dump(serialize(resource), mode: :compat)
+      end
+      def fields
+        @fields ||= resolve_fields
+      end
+      def compiled_extractor
+        @compiled_extractor ||= build_compiled_extractor
+      end
+      private
+      def build_compiled_extractor # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
+        classified = classify_fields
+        model_lines     = classified[:model].map     { |f| %("#{f}" => object.public_send(:#{f})) }
+        virtual_lines   = classified[:virtual].map   { |f| %("#{f}" => inst.public_send(:#{f})) }
+        delegated_lines = classified[:delegated].map { |f| %("#{f}" => object.public_send(:#{f})) }
+        assoc_lines     = classified[:association].map do |f|
+          %("#{f}" => _serialize_assoc_#{f}(object))
+        end
+        classified[:association].each { |field| build_assoc_method(field) }
+        all_lines = (model_lines + delegated_lines + virtual_lines + assoc_lines).join(",\n        ")
+        if classified[:virtual].any?
+          serializer_klass = self
+          class_eval(<<~RUBY, __FILE__, __LINE__ + 1) # rubocop:disable Style/DocumentDynamicEvalDefinition
+            def self._extract(object)
+              inst = #{serializer_klass}.new(object)
+              {
+                #{all_lines}
+              }
+            end
+          RUBY
+        else
+          class_eval(<<~RUBY, __FILE__, __LINE__ + 1) # rubocop:disable Style/DocumentDynamicEvalDefinition
+            def self._extract(object)
+              {
+                #{all_lines}
+              }
+            end
+          RUBY
+        end
+        method(:_extract)
+      end
+      def build_assoc_method(field) # rubocop:disable Metrics/MethodLength
+        assoc = assoc_metadata_by_name[field]
+        assoc_name    = assoc[:name]
+        serializer    = resolve_assoc_serializer(assoc_name)
+        if serializer.nil?
+          class_eval(<<~RUBY, __FILE__, __LINE__ + 1) # rubocop:disable Style/DocumentDynamicEvalDefinition
+            def self._serialize_assoc_#{field}(object)
+              object.public_send(:#{assoc_name}).as_json
+            end
+          RUBY
+          return
+        end
+        if assoc[:type] == :array
+          class_eval(<<~RUBY, __FILE__, __LINE__ + 1) # rubocop:disable Style/DocumentDynamicEvalDefinition
+            def self._serialize_assoc_#{field}(object)
+              val = object.public_send(:#{assoc_name})
+              return nil if val.nil?
+              val.map { |v| #{serializer}.serialize(v) }
+            end
+          RUBY
+        else
+          class_eval(<<~RUBY, __FILE__, __LINE__ + 1) # rubocop:disable Style/DocumentDynamicEvalDefinition
+            def self._serialize_assoc_#{field}(object)
+              val = object.public_send(:#{assoc_name})
+              val.nil? ? nil : #{serializer}.serialize(val)
+            end
+          RUBY
+        end
+      end
+      def resolve_assoc_serializer(assoc_name)
+        classified = assoc_name.to_s.classify
+        ["#{classified}Resource", "#{classified}Openapi"].each do |name|
+          klass = Object.const_get(name)
+          return klass._resource if klass.respond_to?(:_resource) && klass._resource
+          return klass           if klass.respond_to?(:serialize)
+        rescue NameError
+          next
+        end
+        nil
+      end
+      def classify_fields # rubocop:disable Metrics/AbcSize,Metrics/CyclomaticComplexity,Metrics/MethodLength,Metrics/PerceivedComplexity
+        model_set = Set.new(resolve_model_fields)
+        assoc_set   = Set.new(assoc_metadata_by_name.keys)
+        virtual_set = Set.new(
+          Array(_virtual_attributes).map { |a| a[:name].to_s }
+        )
+        result = { model: [], virtual: [], delegated: [], association: [] }
+        fields.each do |field|
+          result[if assoc_set.include?(field)
+                   :association
+                 elsif model_set.include?(field)
+                   :model
+                 elsif virtual_set.include?(field) && method_defined?(field.to_sym)
+                   :virtual       # método definido no resource
+                 elsif virtual_set.include?(field)
+                   :delegated     # método definido no model
+                 else # rubocop:disable Lint/DuplicateBranch
+                   :delegated
+                 end] << field
+        end
+        result
+      end
+      def assoc_metadata_by_name
+        @assoc_metadata_by_name ||= begin
+          klass  = self
+          result = {}
+          while klass && klass != OpenapiBlocks::Base
+            Array(klass._associations)
+              .each { |a| result[a[:name].to_s] ||= a }
+            klass = klass.superclass
+          end
+          result
+        end
+      end
+      def resolve_fields # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
+        klass = self
+        model_fields   = resolve_model_fields
+        virtual_fields = []
+        ignored_fields = []
+        assoc_fields   = []
+        while klass && klass != OpenapiBlocks::Base
+          virtual_fields += Array(klass._virtual_attributes)
+                            .map    { |a| a[:name].to_s }
+          ignored_fields += Array(klass._ignored)
+          assoc_fields   += Array(klass._associations)
+                            .map    { |a| a[:name].to_s }
+          klass = klass.superclass
+        end
+        (model_fields + virtual_fields + assoc_fields - ignored_fields).uniq
+      end
+      def resolve_model_fields
+        klass = self
+        while klass && klass != OpenapiBlocks::Base
+          begin
+            return klass.model.column_names
+          rescue StandardError
+            klass = klass.superclass
+          end
+        end
+        []
+      end
+    end
+    attr_reader :object, :parent
+    def initialize(object, parent = nil)
+      @object = object
+      @parent = parent
+    end
+  end
+end

data/lib/openapi_blocks/spec/components.rb CHANGED Viewed

@@ -12,17 +12,25 @@ module OpenapiBlocks
         @openapi_classes = openapi_classes
       end
-      def build # rubocop:disable Metrics/AbcSize
+      def build # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
         schemas = @openapi_classes.each_with_object({}) do |klass, hash|
-          schema_name = klass.model.name
-          extractor   = Schema::Extractor.new(klass)
-          validator   = Schema::Validator.new(klass.model)
+          schema_klass = klass.respond_to?(:_resource) && klass._resource ? klass._resource : klass
+          begin
+            next unless schema_klass.model
+          rescue StandardError
+            next
+          end
+          schema_name = schema_klass.model.name
+          extractor   = Schema::Extractor.new(schema_klass)
+          validator   = Schema::Validator.new(schema_klass.model)
           schema              = extractor.extract
           schema[:properties] = merge_validations(schema[:properties], validator.extract)
-          hash[schema_name]            = schema
-          hash["#{schema_name}Input"]  = build_input(schema, klass)
+          hash[schema_name]           = schema
+          hash["#{schema_name}Input"] = build_input(schema, schema_klass)
         end
         { schemas: schemas }
@@ -30,14 +38,19 @@ module OpenapiBlocks
       private
-      def build_input(schema, openapi_class) # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
+      def build_input(schema, openapi_class) # rubocop:disable Metrics/AbcSize,Metrics/CyclomaticComplexity,Metrics/MethodLength,Metrics/PerceivedComplexity
         read_only_virtuals = Array(openapi_class._virtual_attributes)
                              .select { |attr| attr[:read_only] == true }
                              .map { |attr| attr[:name].to_s }
+        read_only_associations = Array(openapi_class._associations)
+                                 .select { |assoc| assoc[:read_only] == true }
+                                 .map { |assoc| assoc[:name].to_s }
         input_properties = schema[:properties].reject do |name, property|
           INPUT_IGNORED_PROPERTIES.include?(name.to_s) ||
-            read_only_virtuals.include?(name.to_s) ||
+            read_only_virtuals.include?(name.to_s)      ||
+            read_only_associations.include?(name.to_s)  ||
             property[:readOnly] == true
         end

data/lib/openapi_blocks/version.rb CHANGED Viewed

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 module OpenapiBlocks
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/lib/openapi_blocks.rb CHANGED Viewed

@@ -2,6 +2,7 @@
 require "active_support/all"
 require "active_record"
+require "oj"
 require_relative "openapi_blocks/version"
 require_relative "openapi_blocks/configuration"
@@ -17,10 +18,13 @@ require_relative "openapi_blocks/spec/components"
 require_relative "openapi_blocks/spec/paths"
 require_relative "openapi_blocks/spec/document"
 require_relative "openapi_blocks/builder"
+require_relative "openapi_blocks/serializer"
 require_relative "openapi_blocks/base"
 require_relative "openapi_blocks/engine"
 require_relative "openapi_blocks/railtie"
 require_relative "openapi_blocks/operation_builder"
+require_relative "openapi_blocks/resource"
+require_relative "openapi_blocks/controller"
 module OpenapiBlocks # rubocop:disable Style/Documentation
   class Error < StandardError; end

metadata CHANGED Viewed

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openapi_blocks
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Caio Santos
@@ -9,6 +9,20 @@ bindir: exe
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -134,16 +148,19 @@ files:
 - lib/openapi_blocks/configuration/security_builder.rb
 - lib/openapi_blocks/configuration/server_builder.rb
 - lib/openapi_blocks/configuration/servers_builder.rb
+- lib/openapi_blocks/controller.rb
 - lib/openapi_blocks/engine.rb
 - lib/openapi_blocks/file_watcher.rb
 - lib/openapi_blocks/middleware.rb
 - lib/openapi_blocks/operation_builder.rb
 - lib/openapi_blocks/railtie.rb
+- lib/openapi_blocks/resource.rb
 - lib/openapi_blocks/routing/extractor.rb
 - lib/openapi_blocks/routing/operation.rb
 - lib/openapi_blocks/schema/extractor.rb
 - lib/openapi_blocks/schema/types.rb
 - lib/openapi_blocks/schema/validator.rb
+- lib/openapi_blocks/serializer.rb
 - lib/openapi_blocks/spec/components.rb
 - lib/openapi_blocks/spec/document.rb
 - lib/openapi_blocks/spec/paths.rb