oas_rails 0.1.0 → 0.2.0

data/lib/oas_rails/utils.rb

@@ -0,0 +1,66 @@
+module OasRails
+  module Utils
+    TYPE_MAPPING = {
+      'String' => 'string',
+      'Integer' => 'number',
+      'Float' => 'number',
+      'TrueClass' => 'boolean',
+      'FalseClass' => 'boolean',
+      'Boolean' => 'boolean',
+      'NilClass' => 'null',
+      'Hash' => 'object',
+      'Object' => 'object',
+      'DateTime' => 'string'
+    }.freeze
+
+    class << self
+      # Method for detect test framework of the Rails App
+      # It is used for generate examples in operations
+      def detect_test_framework
+        if defined?(FactoryBot)
+          :factory_bot
+        elsif ActiveRecord::Base.connection.table_exists?('ar_internal_metadata')
+          :fixtures
+        else
+          :unknown
+        end
+      end
+
+      def type_to_schema(type_string)
+        if type_string.start_with?('Array<')
+          inner_type = type_string[/Array<(.+)>$/, 1]
+          {
+            "type" => "array",
+            "items" => type_to_schema(inner_type)
+          }
+        else
+          { "type" => TYPE_MAPPING.fetch(type_string, 'string') }
+        end
+      end
+
+      def hash_to_json_schema(hash)
+        {
+          type: 'object',
+          properties: hash_to_properties(hash),
+          required: []
+        }
+      end
+
+      def hash_to_properties(hash)
+        hash.transform_values do |value|
+          if value.is_a?(Hash)
+            hash_to_json_schema(value)
+          elsif value.is_a?(Class)
+            { type: ruby_type_to_json_type(value.name) }
+          else
+            { type: ruby_type_to_json_type(value.class.name) }
+          end
+        end
+      end
+
+      def ruby_type_to_json_type(ruby_type)
+        TYPE_MAPPING.fetch(ruby_type, 'string')
+      end
+    end
+  end
+end

data/lib/oas_rails/version.rb

@@ -1,3 +1,3 @@
 module OasRails
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/oas_rails/yard/oas_yard_factory.rb

@@ -55,7 +55,7 @@ module OasRails
 
             begin
               hash = eval(hash_string)
-              hash = OasRails.hash_to_json_schema(hash)
+              hash = Utils.hash_to_json_schema(hash)
             rescue StandardError
               hash = {}
             end
@@ -94,7 +94,7 @@ module OasRails
           text = match[1].strip
           name, location = parse_position_name(text)
           type, required = parse_type(match[2].strip)
-          schema = OasRails.type_to_schema(type)
+          schema = Utils.type_to_schema(type)
 
           ParameterTag.new(tag_name, name, match[3].strip, schema, location, required:)
         else
@@ -109,7 +109,7 @@ module OasRails
 
           begin
             hash = parse_str_to_hash(match[3].strip)
-            hash = OasRails.hash_to_json_schema(hash)
+            hash = Utils.hash_to_json_schema(hash)
           rescue StandardError
             hash = {}
           end

data/lib/oas_rails.rb

@@ -2,30 +2,35 @@ require "yard"
 require "method_source"
 require "esquema"
 
-require_relative 'oas_rails/version'
-require_relative 'oas_rails/engine'
-require_relative 'oas_rails/oas_base'
-require_relative 'oas_rails/configuration'
-require_relative 'oas_rails/specification'
-require_relative 'oas_rails/route_extractor'
-require_relative 'oas_rails/oas_route'
-require_relative 'oas_rails/operation'
+module OasRails
+  require "oas_rails/version"
+  require "oas_rails/engine"
 
-require_relative 'oas_rails/info'
-require_relative 'oas_rails/contact'
-require_relative 'oas_rails/paths'
-require_relative 'oas_rails/path_item'
-require_relative 'oas_rails/parameter'
-require_relative 'oas_rails/tag'
-require_relative 'oas_rails/license'
-require_relative 'oas_rails/server'
-require_relative "oas_rails/request_body"
-require_relative "oas_rails/media_type"
-require_relative 'oas_rails/yard/oas_yard_factory'
-require_relative "oas_rails/response"
-require_relative "oas_rails/responses"
+  autoload :OasBase, "oas_rails/oas_base"
+  autoload :Configuration, "oas_rails/configuration"
+  autoload :Specification, "oas_rails/specification"
+  autoload :RouteExtractor, "oas_rails/route_extractor"
+  autoload :OasRoute, "oas_rails/oas_route"
+  autoload :Operation, "oas_rails/operation"
+  autoload :Info, "oas_rails/info"
+  autoload :Contact, "oas_rails/contact"
+  autoload :Paths, "oas_rails/paths"
+  autoload :PathItem, "oas_rails/path_item"
+  autoload :Parameter, "oas_rails/parameter"
+  autoload :Tag, "oas_rails/tag"
+  autoload :License, "oas_rails/license"
+  autoload :Server, "oas_rails/server"
+  autoload :RequestBody, "oas_rails/request_body"
+  autoload :MediaType, "oas_rails/media_type"
+  autoload :Response, "oas_rails/response"
+  autoload :Responses, "oas_rails/responses"
+
+  autoload :Utils, "oas_rails/utils"
+
+  module Yard
+    autoload :OasYardFactory, 'oas_rails/yard/oas_yard_factory'
+  end
 
-module OasRails
   class << self
     def configure
       yield config
@@ -43,7 +48,9 @@ module OasRails
         'Parameter' => [:parameter, :with_parameter],
         'Response' => [:response, :with_response],
         'Endpoint Tags' => [:tags],
-        'Summary' => [:summary]
+        'Summary' => [:summary],
+        'No Auth' => [:no_auth],
+        'Auth methods' => [:auth, :with_types]
       }
       yard_tags.each do |tag_name, (method_name, handler)|
         ::YARD::Tags::Library.define_tag(tag_name, method_name, handler)
@@ -57,64 +64,5 @@ module OasRails
         config.excluded_columns = %i[id created_at updated_at deleted_at]
       end
     end
-
-    def detect_test_framework
-      if defined?(FactoryBot)
-        :factory_bot
-      elsif ActiveRecord::Base.connection.table_exists?('ar_internal_metadata')
-        :fixtures
-      else
-        :unknown
-      end
-    end
-
-    TYPE_MAPPING = {
-      'String' => 'string',
-      'Integer' => 'number',
-      'Float' => 'number',
-      'TrueClass' => 'boolean',
-      'FalseClass' => 'boolean',
-      'Boolean' => 'boolean',
-      'NilClass' => 'null',
-      'Hash' => 'object',
-      'Object' => 'object',
-      'DateTime' => 'string'
-    }.freeze
-
-    def type_to_schema(type_string)
-      if type_string.start_with?('Array<')
-        inner_type = type_string[/Array<(.+)>$/, 1]
-        {
-          "type" => "array",
-          "items" => type_to_schema(inner_type)
-        }
-      else
-        { "type" => TYPE_MAPPING.fetch(type_string, 'string') }
-      end
-    end
-
-    def hash_to_json_schema(hash)
-      {
-        type: 'object',
-        properties: hash_to_properties(hash),
-        required: []
-      }
-    end
-
-    def hash_to_properties(hash)
-      hash.transform_values do |value|
-        if value.is_a?(Hash)
-          hash_to_json_schema(value)
-        elsif value.is_a?(Class)
-          { type: ruby_type_to_json_type(value.name) }
-        else
-          { type: ruby_type_to_json_type(value.class.name) }
-        end
-      end
-    end
-
-    def ruby_type_to_json_type(ruby_type)
-      TYPE_MAPPING.fetch(ruby_type, 'string')
-    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: oas_rails
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - a-chacon
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-07-27 00:00:00.000000000 Z
+date: 2024-07-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: esquema
@@ -72,24 +72,15 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
-description: |2+
-      # Open API Specification For Rails
-
-      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)**.
-
-      ## What Sets OasRails Apart?
-
-      - **Dynamic**: No command required to generate docs
-      - **Simple**: Complement default documentation with a few comments; no need to learn a complex DSL
-      - **Pure Ruby on Rails APIs**: No additional frameworks needed (e.g., Grape, RSpec)
-
+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:
 - andres.ch@protonmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- MIT-LICENSE
+- LICENSE
 - README.md
 - Rakefile
 - app/assets/config/oas_rails_manifest.js
@@ -128,6 +119,7 @@ files:
 - lib/oas_rails/server.rb
 - lib/oas_rails/specification.rb
 - lib/oas_rails/tag.rb
+- lib/oas_rails/utils.rb
 - lib/oas_rails/version.rb
 - lib/oas_rails/yard/oas_yard_factory.rb
 homepage: https://github.com/a-chacon/oas_rails
@@ -135,7 +127,7 @@ licenses:
 - GPL-3.0-only
 metadata:
   homepage_uri: https://github.com/a-chacon/oas_rails
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -143,17 +135,16 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.0'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.15
-signing_key:
+rubygems_version: 3.5.9
+signing_key: 
 specification_version: 4
 summary: OasRails is a Rails engine for generating automatic interactive documentation
-  for your Rails APIs. It generates an OAS document and displays it using a nice UI.
+  for your Rails APIs.
 test_files: []
-...

data/MIT-LICENSE

@@ -1,20 +0,0 @@
-Copyright a-chacon
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.