oas_rails 0.16.0 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 44055a7f28caf66419b7450458c652bfa88b28459669f856b35a83dc4a25f228
-  data.tar.gz: 188cafd5d14c17fe5055850af9fd712d086f135a20aa70e9640a29721a7656cf
+  metadata.gz: d60145b23d4b27b3fc5f1f58e024cb4ea0df37c6d10932d64b9bc5ce08641e83
+  data.tar.gz: '099cce8d88c18549bded9eaa2e3f4b9176a1a934f2a511bb3d6af567c18822ed'
 SHA512:
-  metadata.gz: 927cdf58a97c24ad7e6956bc09086b1baa221ec796cea3ccb08fc988a6ed92a4707097b956a00ac888cefaea4e238f48c49c6b197b96b08b4f48f0c6fd194c40
-  data.tar.gz: b64572ca08987c1461fe2ae799a3771021dc534e18a35b0f394181ad2fdfe7d8a46dd6124caf56aff2745476c2eacc795df72ca3b6ddbc73fce4146dc581a023
+  metadata.gz: 5bb4524c0f29f381c9e1fa3b351bbb5a860e05a71e83fa7298ec62b68a39f6a2b2a8c21057e1f0a262482d4e565be4e33ff79b490aff2539d074a98dc5506199
+  data.tar.gz: 22f0679476e47e8e72a7fd77c68d944a75b68fd8b004c030676a84ab8a008433d17530d1a985b75ffdebb55ce56795bf7c14679d65ade303c65732ffe705dfec

data/README.md

@@ -9,6 +9,8 @@
 
 OasRails is a Rails engine for generating **automatic interactive documentation for your Rails APIs**. It generates an **OAS 3.1** document and displays it using **[RapiDoc](https://rapidocweb.com)**.
 
+It relies on the [OasCore](https://github.com/a-chacon/oas_core) gem.
+
 ### 🚀 Demo App
 
 Explore the interactive documentation live:
@@ -47,7 +49,7 @@ The goal is to minimize the effort required to create comprehensive documentatio
 
 ## Documentation
 
-For see how to install, configure and use OasRails please refere to the [OasRailsBook](http://a-chacon.com/oas_rails)
+For see how to install, configure and use OasRails please refere to the [OasCore MDBook](http://a-chacon.com/oas_core)
 
 ## Contributing
 

data/lib/oas_rails/builders/oas_route_builder.rb

@@ -10,15 +10,14 @@ module OasRails
       end
 
       def build
-        OasRoute.new(
+        OasCore::OasRoute.new(
           controller_class: controller_class,
           controller_action: controller_action,
           controller: controller,
           controller_path: controller_path,
-          method: method,
+          method_name: method,
           verb: verb,
           path: path,
-          rails_route: @rails_route,
           docstring: docstring,
           source_string: source_string,
           tags: tags

data/lib/oas_rails/configuration.rb

@@ -1,78 +1,28 @@
 module OasRails
-  class Configuration
-    attr_accessor :info,
-                  :layout,
-                  :default_tags_from,
-                  :autodiscover_request_body,
-                  :autodiscover_responses,
-                  :api_path,
-                  :ignored_actions,
-                  :security_schemas,
-                  :authenticate_all_routes_by_default,
-                  :set_default_responses,
-                  :possible_default_responses,
-                  :http_verbs,
-                  :use_model_names,
-                  :rapidoc_theme
-
-    attr_reader :servers, :tags, :security_schema, :include_mode, :response_body_of_default, :route_extractor
+  class Configuration < OasCore::Configuration
+    attr_accessor :autodiscover_request_body, :autodiscover_responses, :ignored_actions, :rapidoc_theme, :layout
+    attr_reader :route_extractor, :include_mode
 
     def initialize
-      @info = Spec::Info.new
-      @layout = false
-      @servers = default_servers
-      @tags = []
-      @swagger_version = '3.1.0'
-      @default_tags_from = :namespace
+      super
+      @route_extractor = Extractors::RouteExtractor
+      @include_mode = :all
       @autodiscover_request_body = true
       @autodiscover_responses = true
-      @api_path = "/"
       @ignored_actions = []
-      @authenticate_all_routes_by_default = true
-      @security_schema = nil
-      @security_schemas = {}
-      @set_default_responses = true
-      @possible_default_responses = [:not_found, :unauthorized, :forbidden, :internal_server_error, :unprocessable_entity]
-      @http_verbs = [:get, :post, :put, :patch, :delete]
-      @response_body_of_default = "Hash{ status: !Integer, error: String }"
-      @use_model_names = false
       @rapidoc_theme = :rails
-      @include_mode = :all
-      @route_extractor = Extractors::RouteExtractor
-
-      @possible_default_responses.each do |response|
-        method_name = "response_body_of_#{response}="
-        variable_name = "@response_body_of_#{response}"
-
-        define_singleton_method(method_name) do |value|
-          raise ArgumentError, "#{method_name} must be a String With a valid object" unless value.is_a?(String)
-
-          OasRails::JsonSchemaGenerator.parse_type(value)
-          instance_variable_set(variable_name, value)
-        end
+      @layout = nil
 
-        define_singleton_method("response_body_of_#{response}") do
-          instance_variable_get(variable_name) || @response_body_of_default
-        end
-      end
-    end
-
-    def security_schema=(value)
-      return unless (security_schema = DEFAULT_SECURITY_SCHEMES[value])
-
-      @security_schemas = { value => security_schema }
+      # TODO: implement
+      # autodiscover_request_body
+      # autodiscover_responses
     end
 
-    def default_servers
-      [Spec::Server.new(url: "http://localhost:3000", description: "Rails Default Development Server")]
-    end
-
-    def servers=(value)
-      @servers = value.map { |s| Spec::Server.new(url: s[:url], description: s[:description]) }
-    end
+    def include_mode=(value)
+      valid_modes = %i[all with_tags explicit]
+      raise ArgumentError, "include_mode must be one of #{valid_modes}" unless valid_modes.include?(value)
 
-    def tags=(value)
-      @tags = value.map { |t| Spec::Tag.new(name: t[:name], description: t[:description]) }
+      @include_mode = value
     end
 
     def route_extractor=(value)
@@ -87,68 +37,5 @@ module OasRails
 
       @route_extractor = value
     end
-
-    def excluded_columns_incoming
-      %i[id created_at updated_at deleted_at]
-    end
-
-    def excluded_columns_outgoing
-      []
-    end
-
-    def include_mode=(value)
-      valid_modes = [:all, :with_tags, :explicit]
-      raise ArgumentError, "include_mode must be one of #{valid_modes}" unless valid_modes.include?(value)
-
-      @include_mode = value
-    end
-
-    def response_body_of_default=(value)
-      raise ArgumentError, "response_body_of_default must be a String With a valid object" unless value.is_a?(String)
-
-      OasRails::JsonSchemaGenerator.parse_type(value)
-      @response_body_of_default = value
-    end
   end
-
-  DEFAULT_SECURITY_SCHEMES = {
-    api_key_cookie: {
-      type: "apiKey",
-      in: "cookie",
-      name: "api_key",
-      description: "An API key that will be supplied in a named cookie."
-    },
-    api_key_header: {
-      type: "apiKey",
-      in: "header",
-      name: "X-API-Key",
-      description: "An API key that will be supplied in a named header."
-    },
-    api_key_query: {
-      type: "apiKey",
-      in: "query",
-      name: "apiKey",
-      description: "An API key that will be supplied in a named query parameter."
-    },
-    basic: {
-      type: "http",
-      scheme: "basic",
-      description: "Basic auth that takes a base64'd combination of `user:password`."
-    },
-    bearer: {
-      type: "http",
-      scheme: "bearer",
-      description: "A bearer token that will be supplied within an `Authorization` header as `bearer <token>`."
-    },
-    bearer_jwt: {
-      type: "http",
-      scheme: "bearer",
-      bearerFormat: "JWT",
-      description: "A bearer token that will be supplied within an `Authorization` header as `bearer <token>`. In this case, the format of the token is specified as JWT."
-    },
-    mutual_tls: {
-      type: "mutualTLS",
-      description: "Requires a specific mutual TLS certificate to use when making an HTTP request."
-    }
-  }.freeze
 end

data/lib/oas_rails/engine.rb

@@ -1,11 +1,6 @@
 module OasRails
   class Engine < ::Rails::Engine
     isolate_namespace OasRails
-    config.to_prepare do
-      ActiveSupport::Inflector.inflections(:en) do |inflect|
-        inflect.acronym 'YARD'
-      end
-    end
 
     config.app_middleware.use(
       Rack::Static,

data/lib/oas_rails/version.rb

@@ -1,3 +1,3 @@
 module OasRails
-  VERSION = "0.16.0"
+  VERSION = "0.17.0"
 end

data/lib/oas_rails.rb

@@ -1,62 +1,22 @@
-require "yard"
-require "method_source"
 require "easy_talk"
+require "oas_core"
+
+OasCore.configure_yard!
 
 module OasRails
   require "oas_rails/version"
   require "oas_rails/engine"
 
   autoload :Configuration, "oas_rails/configuration"
-  autoload :OasRoute, "oas_rails/oas_route"
   autoload :Utils, "oas_rails/utils"
   autoload :JsonSchemaGenerator, "oas_rails/json_schema_generator"
   autoload :ActiveRecordExampleFinder, "oas_rails/active_record_example_finder"
 
   module Builders
-    autoload :OperationBuilder, "oas_rails/builders/operation_builder"
-    autoload :PathItemBuilder, "oas_rails/builders/path_item_builder"
-    autoload :ResponseBuilder, "oas_rails/builders/response_builder"
-    autoload :ResponsesBuilder, "oas_rails/builders/responses_builder"
-    autoload :ContentBuilder, "oas_rails/builders/content_builder"
-    autoload :ParametersBuilder, "oas_rails/builders/parameters_builder"
-    autoload :ParameterBuilder, "oas_rails/builders/parameter_builder"
-    autoload :RequestBodyBuilder, "oas_rails/builders/request_body_builder"
     autoload :EsquemaBuilder, "oas_rails/builders/esquema_builder"
     autoload :OasRouteBuilder, "oas_rails/builders/oas_route_builder"
   end
 
-  # This module contains all the clases that represent a part of the OAS file.
-  module Spec
-    autoload :Hashable, "oas_rails/spec/hashable"
-    autoload :Specable, "oas_rails/spec/specable"
-    autoload :Components, "oas_rails/spec/components"
-    autoload :Parameter, "oas_rails/spec/parameter"
-    autoload :License, "oas_rails/spec/license"
-    autoload :Response, "oas_rails/spec/response"
-    autoload :PathItem, "oas_rails/spec/path_item"
-    autoload :Operation, "oas_rails/spec/operation"
-    autoload :RequestBody, "oas_rails/spec/request_body"
-    autoload :Responses, "oas_rails/spec/responses"
-    autoload :MediaType, "oas_rails/spec/media_type"
-    autoload :Paths, "oas_rails/spec/paths"
-    autoload :Contact, "oas_rails/spec/contact"
-    autoload :Info, "oas_rails/spec/info"
-    autoload :Server, "oas_rails/spec/server"
-    autoload :Tag, "oas_rails/spec/tag"
-    autoload :Specification, "oas_rails/spec/specification"
-    autoload :Reference, "oas_rails/spec/reference"
-  end
-
-  module YARD
-    autoload :RequestBodyTag, 'oas_rails/yard/request_body_tag'
-    autoload :ExampleTag, 'oas_rails/yard/example_tag'
-    autoload :RequestBodyExampleTag, 'oas_rails/yard/request_body_example_tag'
-    autoload :ParameterTag, 'oas_rails/yard/parameter_tag'
-    autoload :ResponseTag, 'oas_rails/yard/response_tag'
-    autoload :ResponseExampleTag, 'oas_rails/yard/response_example_tag'
-    autoload :OasRailsFactory, 'oas_rails/yard/oas_rails_factory'
-  end
-
   module Extractors
     autoload :RenderResponseExtractor, 'oas_rails/extractors/render_response_extractor'
     autoload :RouteExtractor, "oas_rails/extractors/route_extractor"
@@ -64,16 +24,22 @@ module OasRails
   end
 
   class << self
+    OasCore::JsonSchemaGenerator.register_type_parser(
+      ->(t) { Utils.active_record_class?(t) },
+      ->(type, _required) { Builders::EsquemaBuilder.build_outgoing_schema(klass: type.constantize) }
+    )
+
     def build
-      oas = Spec::Specification.new
-      oas.build
+      clear_cache
+      OasCore.config = config
+
+      host_routes = Extractors::RouteExtractor.host_routes
+      oas = OasCore::Builders::SpecificationBuilder.new.with_oas_routes(host_routes).build
 
       oas.to_spec
     end
 
-    # Configurations for make the OasRails engine Work.
     def configure
-      OasRails.configure_yard!
       yield config
     end
 
@@ -81,23 +47,11 @@ module OasRails
       @config ||= Configuration.new
     end
 
-    def configure_yard!
-      ::YARD::Tags::Library.default_factory = YARD::OasRailsFactory
-      yard_tags = {
-        'Request body' => [:request_body, :with_request_body],
-        'Request body Example' => [:request_body_example, :with_request_body_example],
-        'Parameter' => [:parameter, :with_parameter],
-        'Response' => [:response, :with_response],
-        'Response Example' => [:response_example, :with_response_example],
-        'Endpoint Tags' => [:tags],
-        'Summary' => [:summary],
-        'No Auth' => [:no_auth],
-        'Auth methods' => [:auth, :with_types],
-        'OAS Include' => [:oas_include]
-      }
-      yard_tags.each do |tag_name, (method_name, handler)|
-        ::YARD::Tags::Library.define_tag(tag_name, method_name, handler)
-      end
+    def clear_cache
+      return if Rails.env.production?
+
+      MethodSource.clear_cache
+      OasRails::Extractors::RouteExtractor.clear_cache
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: oas_rails
 version: !ruby/object:Gem::Version
-  version: 0.16.0
+  version: 0.17.0
 platform: ruby
 authors:
 - a-chacon
@@ -24,33 +24,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.1.2
 - !ruby/object:Gem::Dependency
-  name: method_source
+  name: oas_core
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 0.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: yard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
+        version: 0.4.0
 description: OasRails is a Rails engine for generating automatic interactive documentation
   for your Rails APIs. It generates an OAS 3.1 document and displays it using RapiDoc.
 email:
@@ -80,50 +66,14 @@ files:
 - lib/generators/oas_rails/config/templates/oas_rails_initializer.rb
 - lib/oas_rails.rb
 - lib/oas_rails/active_record_example_finder.rb
-- lib/oas_rails/builders/content_builder.rb
 - lib/oas_rails/builders/esquema_builder.rb
 - lib/oas_rails/builders/oas_route_builder.rb
-- lib/oas_rails/builders/operation_builder.rb
-- lib/oas_rails/builders/parameter_builder.rb
-- lib/oas_rails/builders/parameters_builder.rb
-- lib/oas_rails/builders/path_item_builder.rb
-- lib/oas_rails/builders/request_body_builder.rb
-- lib/oas_rails/builders/response_builder.rb
-- lib/oas_rails/builders/responses_builder.rb
 - lib/oas_rails/configuration.rb
 - lib/oas_rails/engine.rb
-- lib/oas_rails/extractors/oas_route_extractor.rb
 - lib/oas_rails/extractors/render_response_extractor.rb
 - lib/oas_rails/extractors/route_extractor.rb
-- lib/oas_rails/json_schema_generator.rb
-- lib/oas_rails/oas_route.rb
-- lib/oas_rails/spec/components.rb
-- lib/oas_rails/spec/contact.rb
-- lib/oas_rails/spec/hashable.rb
-- lib/oas_rails/spec/info.rb
-- lib/oas_rails/spec/license.rb
-- lib/oas_rails/spec/media_type.rb
-- lib/oas_rails/spec/operation.rb
-- lib/oas_rails/spec/parameter.rb
-- lib/oas_rails/spec/path_item.rb
-- lib/oas_rails/spec/paths.rb
-- lib/oas_rails/spec/reference.rb
-- lib/oas_rails/spec/request_body.rb
-- lib/oas_rails/spec/response.rb
-- lib/oas_rails/spec/responses.rb
-- lib/oas_rails/spec/server.rb
-- lib/oas_rails/spec/specable.rb
-- lib/oas_rails/spec/specification.rb
-- lib/oas_rails/spec/tag.rb
 - lib/oas_rails/utils.rb
 - lib/oas_rails/version.rb
-- lib/oas_rails/yard/example_tag.rb
-- lib/oas_rails/yard/oas_rails_factory.rb
-- lib/oas_rails/yard/parameter_tag.rb
-- lib/oas_rails/yard/request_body_example_tag.rb
-- lib/oas_rails/yard/request_body_tag.rb
-- lib/oas_rails/yard/response_example_tag.rb
-- lib/oas_rails/yard/response_tag.rb
 - public/oas-rails-assets/rapidoc-min.js
 homepage: https://github.com/a-chacon/oas_rails
 licenses:

data/lib/oas_rails/builders/content_builder.rb

@@ -1,62 +0,0 @@
-module OasRails
-  module Builders
-    class ContentBuilder
-      def initialize(specification, context)
-        @context = context || :incoming
-        @specification = specification
-        @media_type = Spec::MediaType.new(specification)
-        @content_type = "application/json"
-      end
-
-      def with_schema(schema)
-        @media_type.schema = @specification.components.add_schema(schema)
-
-        self
-      end
-
-      def with_examples(examples)
-        @media_type.examples = @specification.components.add_example(examples)
-
-        self
-      end
-
-      def with_content_type(content_type)
-        @content_type = content_type if content_type.present?
-
-        self
-      end
-
-      def with_examples_from_tags(tags)
-        @media_type.examples = @media_type.examples.merge(tags.each_with_object({}).with_index(1) do |(example, result), _index|
-          key = example.text.downcase.gsub(' ', '_')
-          value = {
-            "summary" => example.text,
-            "value" => example.content
-          }
-          result[key] = @specification.components.add_example(value)
-        end)
-
-        self
-      end
-
-      def from_model_class(klass)
-        return self unless Utils.active_record_class?(klass)
-
-        model_schema = Builders::EsquemaBuilder.send("build_#{@context}_schema", klass:)
-        model_schema["required"] = []
-        schema = { type: "object", properties: { klass.to_s.downcase => model_schema } }
-        examples = ActiveRecordExampleFinder.new(context: @context).search(klass)
-        @media_type.schema = @specification.components.add_schema(schema)
-        @media_type.examples = @media_type.examples.merge(examples)
-
-        self
-      end
-
-      def build
-        {
-          @content_type => @media_type
-        }
-      end
-    end
-  end
-end

data/lib/oas_rails/builders/operation_builder.rb

@@ -1,32 +0,0 @@
-module OasRails
-  module Builders
-    class OperationBuilder
-      include Extractors::OasRouteExtractor
-
-      def initialize(specification)
-        @specification = specification
-        @operation = Spec::Operation.new(specification)
-      end
-
-      def from_oas_route(oas_route)
-        @operation.summary = extract_summary(oas_route:)
-        @operation.operation_id = extract_operation_id(oas_route:)
-        @operation.description = oas_route.docstring
-        @operation.tags = extract_tags(oas_route:)
-        @operation.security = extract_security(oas_route:)
-        @operation.parameters = ParametersBuilder.new(@specification).from_oas_route(oas_route).build
-        @operation.request_body = RequestBodyBuilder.new(@specification).from_oas_route(oas_route).reference
-        @operation.responses = ResponsesBuilder.new(@specification)
-                                               .from_oas_route(oas_route)
-                                               .add_autodiscovered_responses(oas_route)
-                                               .add_default_responses(oas_route, !@operation.security.empty?).build
-
-        self
-      end
-
-      def build
-        @operation
-      end
-    end
-  end
-end

data/lib/oas_rails/builders/parameter_builder.rb

@@ -1,28 +0,0 @@
-module OasRails
-  module Builders
-    class ParameterBuilder
-      def initialize(specification)
-        @specification = specification
-        @parameter = Spec::Parameter.new(specification)
-      end
-
-      def from_path(path, param)
-        @parameter.name = param
-        @parameter.in = 'path'
-        @parameter.description = "#{param.split('_')[-1].titleize} of existing #{extract_word_before(path, param).singularize}."
-
-        self
-      end
-
-      def extract_word_before(string, param)
-        regex = %r{/([\w-]+)/\{#{param}\}}
-        match = string.match(regex)
-        match ? match[1] : ""
-      end
-
-      def build
-        @parameter
-      end
-    end
-  end
-end

data/lib/oas_rails/builders/parameters_builder.rb

@@ -1,39 +0,0 @@
-module OasRails
-  module Builders
-    class ParametersBuilder
-      def initialize(specification)
-        @specification = specification
-        @parameters = []
-      end
-
-      def from_oas_route(oas_route)
-        parameters_from_tags(tags: oas_route.tags(:parameter))
-        oas_route.path_params.try(:map) do |p|
-          @parameters << ParameterBuilder.new(@specification).from_path(oas_route.path, p).build unless @parameters.any? { |param| param.name.to_s == p.to_s }
-        end
-
-        self
-      end
-
-      def parameters_from_tags(tags:)
-        tags.each do |t|
-          parameter = Spec::Parameter.new(@specification)
-          parameter.name = t.name
-          parameter.in = t.location
-          parameter.required = t.required
-          parameter.schema = t.schema
-          parameter.description = t.text
-          @parameters << parameter
-        end
-
-        self
-      end
-
-      def build
-        @parameters.map do |p|
-          @specification.components.add_parameter(p)
-        end
-      end
-    end
-  end
-end

data/lib/oas_rails/builders/path_item_builder.rb

@@ -1,24 +0,0 @@
-module OasRails
-  module Builders
-    class PathItemBuilder
-      def initialize(specification)
-        @specification = specification
-        @path_item = Spec::PathItem.new(specification)
-      end
-
-      def from_path(path)
-        OasRails.config.route_extractor.host_routes_by_path(path).each do |oas_route|
-          oas_route.verb.downcase.split("|").each do |v|
-            @path_item.add_operation(v, OperationBuilder.new(@specification).from_oas_route(oas_route).build)
-          end
-        end
-
-        self
-      end
-
-      def build
-        @path_item
-      end
-    end
-  end
-end