oas_rails 0.14.0 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 041c5783e2bbbedca71601a21756f2d90398bed275866c6214935965a47766f8
-  data.tar.gz: 4ea6110ed149c0d90b2c47e980f06abb8ef9c6efad7aa35699e23a8e95017fb6
+  metadata.gz: 44055a7f28caf66419b7450458c652bfa88b28459669f856b35a83dc4a25f228
+  data.tar.gz: 188cafd5d14c17fe5055850af9fd712d086f135a20aa70e9640a29721a7656cf
 SHA512:
-  metadata.gz: bd3d0eb79205462ca026002e5bbb64898704d1c2576320568a5332cb50dccf5e7044a7cc12aab06344d583b4d6a7aa0cdf6901f2a9ddbd0509ca305ef3f9dd96
-  data.tar.gz: fcaf3d373fed62a411de505665b6f1c288834902d009fc0d5c1d399693a0a7011b00e3df77a2fce6c77d10113044430e9ffe03ee87400976e8d9bdaca23fa631
+  metadata.gz: 927cdf58a97c24ad7e6956bc09086b1baa221ec796cea3ccb08fc988a6ed92a4707097b956a00ac888cefaea4e238f48c49c6b197b96b08b4f48f0c6fd194c40
+  data.tar.gz: b64572ca08987c1461fe2ae799a3771021dc534e18a35b0f394181ad2fdfe7d8a46dd6124caf56aff2745476c2eacc795df72ca3b6ddbc73fce4146dc581a023

data/lib/oas_rails/builders/content_builder.rb

@@ -5,6 +5,7 @@ module OasRails
         @context = context || :incoming
         @specification = specification
         @media_type = Spec::MediaType.new(specification)
+        @content_type = "application/json"
       end
 
       def with_schema(schema)
@@ -19,6 +20,12 @@ module OasRails
         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(' ', '_')
@@ -47,7 +54,7 @@ module OasRails
 
       def build
         {
-          "application/json": @media_type
+          @content_type => @media_type
         }
       end
     end

data/lib/oas_rails/builders/oas_route_builder.rb

@@ -52,7 +52,7 @@ module OasRails
       end
 
       def path
-        Extractors::RouteExtractor.clean_route(@rails_route.path.spec.to_s)
+        OasRails.config.route_extractor.clean_route(@rails_route.path.spec.to_s)
       end
 
       def source_string

data/lib/oas_rails/builders/path_item_builder.rb

@@ -6,8 +6,8 @@ module OasRails
         @path_item = Spec::PathItem.new(specification)
       end
 
-      def from_path(path, route_extractor: Extractors::RouteExtractor)
-        route_extractor.host_routes_by_path(path).each do |oas_route|
+      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

data/lib/oas_rails/builders/request_body_builder.rb

@@ -19,10 +19,10 @@ module OasRails
 
       def from_tags(tag:, examples_tags: [])
         if Utils.active_record_class?(tag.klass)
-          from_model_class(klass: tag.klass, description: tag.text, required: tag.required, examples_tags:)
+          from_model_class(klass: tag.klass, description: tag.text, required: tag.required, content_type: tag.content_type, examples_tags:)
         else
           @request_body.description = tag.text
-          @request_body.content = ContentBuilder.new(@specification, :incoming).with_schema(tag.schema).with_examples_from_tags(examples_tags).build
+          @request_body.content = ContentBuilder.new(@specification, :incoming).with_schema(tag.schema).with_examples_from_tags(examples_tags).with_content_type(tag.content_type).build
           @request_body.required = tag.required
         end
 
@@ -31,7 +31,7 @@ module OasRails
 
       def from_model_class(klass:, **kwargs)
         @request_body.description = kwargs[:description] || klass.to_s
-        @request_body.content = ContentBuilder.new(@specification, :incoming).from_model_class(klass).with_examples_from_tags(kwargs[:examples_tags] || {}).build
+        @request_body.content = ContentBuilder.new(@specification, :incoming).from_model_class(klass).with_examples_from_tags(kwargs[:examples_tags] || {}).with_content_type(kwargs[:content_type]).build
         @request_body.required = kwargs[:required]
 
         self

data/lib/oas_rails/configuration.rb

@@ -15,7 +15,7 @@ module OasRails
                   :use_model_names,
                   :rapidoc_theme
 
-    attr_reader :servers, :tags, :security_schema, :include_mode, :response_body_of_default
+    attr_reader :servers, :tags, :security_schema, :include_mode, :response_body_of_default, :route_extractor
 
     def initialize
       @info = Spec::Info.new
@@ -38,6 +38,7 @@ module OasRails
       @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}="
@@ -74,6 +75,19 @@ module OasRails
       @tags = value.map { |t| Spec::Tag.new(name: t[:name], description: t[:description]) }
     end
 
+    def route_extractor=(value)
+      unless value.respond_to?(:host_routes) &&
+             value.respond_to?(:host_routes_by_path) &&
+             value.respond_to?(:clear_cache) &&
+             value.respond_to?(:host_paths) &&
+             value.respond_to?(:clean_route)
+        raise ArgumentError,
+              "Route extractor must have the following methods: host_routes, host_routes_by_path, clear_cache, host_paths, and clean_route"
+      end
+
+      @route_extractor = value
+    end
+
     def excluded_columns_incoming
       %i[id created_at updated_at deleted_at]
     end

data/lib/oas_rails/extractors/render_response_extractor.rb

@@ -62,7 +62,7 @@ module OasRails
 
           if Utils.active_record_class?(klass)
             schema = Builders::EsquemaBuilder.build_outgoing_schema(klass:)
-            if test_singularity(maybe_a_model)
+            if test_singularity?(maybe_a_model)
               build_singular_model_schema_and_examples(maybe_a_model, errors, klass, schema)
             else
               build_array_model_schema_and_examples(maybe_a_model, klass, schema)
@@ -118,7 +118,7 @@ module OasRails
         #
         # @param str [String] The string to test.
         # @return [Boolean] True if the string is a singular model, false otherwise.
-        def test_singularity(str)
+        def test_singularity?(str)
           str.pluralize != str && str.singularize == str
         end
 

data/lib/oas_rails/json_schema_generator.rb

@@ -124,6 +124,7 @@ module OasRails
       when 'nil' then { type: "null" }
       when 'date' then { type: "string", format: "date" }
       when 'datetime' then { type: "string", format: "date-time" }
+      when 'file' then { type: "string", format: "binary" }
       else type.to_s.downcase
       end
     end

data/lib/oas_rails/spec/path_item.rb

@@ -13,8 +13,8 @@ module OasRails
         @delete = nil
       end
 
-      def fill_from(path, route_extractor: Extractors::RouteExtractor)
-        route_extractor.host_routes_by_path(path).each do |oas_route|
+      def fill_from(path)
+        OasRails.config.route_extractor.host_routes_by_path(path).each do |oas_route|
           add_operation(oas_route.verb.downcase, Spec::Operation.new(@specification).fill_from(oas_route))
         end
 

data/lib/oas_rails/spec/specification.rb

@@ -20,8 +20,8 @@ module OasRails
         @paths = Spec::Paths.new(self)
       end
 
-      def build(route_extractor: Extractors::RouteExtractor)
-        route_extractor.host_paths.each do |path|
+      def build
+        OasRails.config.route_extractor.host_paths.each do |path|
           @paths.add_path(path)
         end
       end
@@ -31,7 +31,7 @@ module OasRails
       # @return [void]
       def clear_cache
         MethodSource.clear_cache
-        Extractors::RouteExtractor.clear_cache
+        OasRails.config.route_extractor.clear_cache
       end
 
       def oas_fields

data/lib/oas_rails/version.rb

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

data/lib/oas_rails/yard/oas_rails_factory.rb

@@ -6,8 +6,8 @@ module OasRails
       # @param text [String] The tag text to parse.
       # @return [RequestBodyTag] The parsed request body tag object.
       def parse_tag_with_request_body(tag_name, text)
-        description, klass, schema, required = extract_description_and_schema(text.squish)
-        RequestBodyTag.new(tag_name, description, klass, schema:, required:)
+        description, klass, schema, required, content_type = extract_description_and_schema(text.squish)
+        RequestBodyTag.new(tag_name, description, klass, schema:, required:, content_type:)
       end
 
       # Parses a tag that represents a request body example.
@@ -66,11 +66,13 @@ module OasRails
 
       # Specific method to extract description and schema for request body tags.
       # @param text [String] The text to parse.
-      # @return [Array] An array containing the description, class, schema, and required flag.
+      # @return [Array] An array containing the description, class, schema, required flag and content type.
       def extract_description_and_schema(text)
         description, type, = extract_description_type_and_content(text)
+        description, content_type = extract_text_and_parentheses_content(description)
         klass, schema, required = type_text_to_schema(type)
-        [description, klass, schema, required]
+
+        [description, klass, schema, required, content_type]
       end
 
       # Specific method to extract name, location, and schema for parameters.
@@ -119,7 +121,7 @@ module OasRails
       # @param input [String] The input text to parse.
       # @return [Array] An array containing the name and location.
       def extract_text_and_parentheses_content(input)
-        return unless input =~ /^(.+?)\(([^)]+)\)/
+        return input unless input =~ /^(.+?)\(([^)]+)\)/
 
         text = ::Regexp.last_match(1).strip
         parenthesis_content = ::Regexp.last_match(2).strip

data/lib/oas_rails/yard/request_body_tag.rb

@@ -1,14 +1,15 @@
 module OasRails
   module YARD
     class RequestBodyTag < ::YARD::Tags::Tag
-      attr_accessor :klass, :schema, :required
+      attr_accessor :klass, :schema, :required, :content_type
 
-      def initialize(tag_name, text, klass, schema: {}, required: false)
+      def initialize(tag_name, text, klass, schema: {}, required: false, content_type: 'application/json')
         # initialize(tag_name, text, types = nil, name = nil)
         super(tag_name, text, nil, nil)
         @klass = klass
         @schema = schema
         @required = required
+        @content_type = content_type
       end
     end
   end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: oas_rails
 version: !ruby/object:Gem::Version
-  version: 0.14.0
+  version: 0.16.0
 platform: ruby
 authors:
 - a-chacon
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-05-18 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: easy_talk_two
@@ -131,7 +130,6 @@ licenses:
 - GPL-3.0-only
 metadata:
   homepage_uri: https://github.com/a-chacon/oas_rails
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -146,8 +144,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
-signing_key:
+rubygems_version: 3.6.7
 specification_version: 4
 summary: OasRails is a Rails engine for generating automatic interactive documentation
   for your Rails APIs.