oas_rails 0.12.0 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b929476e50a9620b4239738c1753cada50eaa6198ec363afe75dc2690f202504
-  data.tar.gz: df7125a57463f2782254b316cd235a6b11e075e5010bc07d61e6aca8e555cd47
+  metadata.gz: 041c5783e2bbbedca71601a21756f2d90398bed275866c6214935965a47766f8
+  data.tar.gz: 4ea6110ed149c0d90b2c47e980f06abb8ef9c6efad7aa35699e23a8e95017fb6
 SHA512:
-  metadata.gz: 95119f77419a24df6f3d22ef941e2dae351ad965ff2e8b84a7285a73932ab5e617d60c6c4ccfb08dfd44f555c58691ad1053b9983699d3f18b9f3c5a8a626693
-  data.tar.gz: b4cce805735d6c2f0ba7f653bf778f59d7dd4c92be23128cac8bfd2ac0c185ccfd3b79e1f149cb1c17a0d083e8d7e83777b89f2bb96462c1acd2cfefdd6d25b9
+  metadata.gz: bd3d0eb79205462ca026002e5bbb64898704d1c2576320568a5332cb50dccf5e7044a7cc12aab06344d583b4d6a7aa0cdf6901f2a9ddbd0509ca305ef3f9dd96
+  data.tar.gz: fcaf3d373fed62a411de505665b6f1c288834902d009fc0d5c1d399693a0a7011b00e3df77a2fce6c77d10113044430e9ffe03ee87400976e8d9bdaca23fa631

data/README.md

@@ -9,7 +9,15 @@
 
 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)**.
 
-🎬 A Demo Video Here:
+### 🚀 Demo App
+
+Explore the interactive documentation live:
+
+🔗 **[Open Demo App](https://paso.fly.dev/api/docs)**  
+👤 **Username**: `oasrails`  
+🔑 **Password**: `oasrails`
+
+🎬 A Demo Installation/Usage Video:
 <https://vimeo.com/1013687332>
 🎬
 
@@ -56,3 +64,7 @@ If you plan a big feature, first open an issue to discuss it before any developm
 ## License
 
 The gem is available as open source under the terms of the [GPL-3.0](https://www.gnu.org/licenses/gpl-3.0.en.html#license-text).
+
+## Star History
+
+[![Star History Chart](https://api.star-history.com/svg?repos=a-chacon/oas_rails&type=Date)](https://www.star-history.com/#a-chacon/oas_rails&Date)

data/lib/generators/oas_rails/config/templates/oas_rails_initializer.rb

@@ -26,6 +26,8 @@ OasRails.configure do |config|
 
     3. Use Yard tags in your controller methods to provide detailed API endpoint descriptions.
 
+    Docs: <https://a-chacon.com/oas_rails/>
+
     ## Features
 
     - Automatic OAS 3.1 document generation
@@ -105,6 +107,7 @@ OasRails.configure do |config|
   # Example, if you add forbidden then it will be added only if the endpoint requires authentication.
   # Example: not_found will be setted to the endpoint only if the operation is a show/update/destroy action.
   # config.set_default_responses = true
-  # config.possible_default_responses = [:not_found, :unauthorized, :forbidden]
-  # config.response_body_of_default = { message: String }
+  # config.possible_default_responses = [:not_found, :unauthorized, :forbidden, :internal_server_error, :unprocessable_entity]
+  # config.response_body_of_default = "Hash{ message: String }"
+  # config.response_body_of_unprocessable_entity= "Hash{ errors: Array<String> }"
 end

data/lib/oas_rails/active_record_example_finder.rb

@@ -0,0 +1,65 @@
+module OasRails
+  class ActiveRecordExampleFinder
+    def initialize(context: :incoming, utils: Utils, factory_bot: FactoryBot, erb: ERB, yaml: YAML, file: File)
+      @context = context
+      @utils = utils
+      @factory_bot = factory_bot
+      @erb = erb
+      @yaml = yaml
+      @file = file
+      @factory_examples = {}
+    end
+
+    def search(klass)
+      case @utils.detect_test_framework
+      when :factory_bot
+        fetch_factory_bot_examples(klass: klass)
+      when :fixtures
+        fetch_fixture_examples(klass: klass)
+      else
+        {}
+      end
+    end
+
+    # Fetches examples from FactoryBot for the provided class.
+    #
+    # @param klass [Class] the class to fetch examples for.
+    # @return [Hash] a hash containing examples data or an empty hash if no examples are found.
+    def fetch_factory_bot_examples(klass:)
+      klass_sym = @utils.class_to_symbol(klass)
+
+      begin
+        @factory_examples[klass_sym] = @factory_bot.build_stubbed_list(klass_sym, 1) if @factory_examples[klass_sym].nil?
+
+        @factory_examples[klass_sym].each_with_index.to_h do |obj, index|
+          ["#{klass_sym}#{index + 1}", { value: { klass_sym => clean_example_object(obj: obj.as_json) } }]
+        end.deep_symbolize_keys
+      rescue KeyError
+        {}
+      end
+    end
+
+    # Fetches examples from fixtures for the provided class.
+    #
+    # @param klass [Class] the class to fetch examples for.
+    # @return [Hash] a hash containing examples data or an empty hash if no examples are found.
+    def fetch_fixture_examples(klass:)
+      fixture_file = Rails.root.join('test', 'fixtures', "#{klass.to_s.pluralize.downcase}.yml")
+      begin
+        erb_result = @erb.new(@file.read(fixture_file)).result
+        fixture_data = @yaml.safe_load(
+          erb_result,
+          aliases: true,
+          permitted_classes: [Symbol, ActiveSupport::HashWithIndifferentAccess, Time]
+        ).with_indifferent_access
+      rescue Errno::ENOENT
+        return {}
+      end
+      fixture_data.transform_values { |attributes| { value: { klass.to_s.downcase => clean_example_object(obj: attributes) } } }.deep_symbolize_keys
+    end
+
+    def clean_example_object(obj:)
+      obj.reject { |key, _| OasRails.config.send("excluded_columns_#{@context}").include?(key.to_sym) }
+    end
+  end
+end

data/lib/oas_rails/builders/content_builder.rb

@@ -33,12 +33,12 @@ module OasRails
       end
 
       def from_model_class(klass)
-        return self unless klass.ancestors.map(&:to_s).include? 'ActiveRecord::Base'
+        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 = Spec::MediaType.search_for_examples_in_tests(klass, context: @context)
+        examples = ActiveRecordExampleFinder.new(context: @context).search(klass)
         @media_type.schema = @specification.components.add_schema(schema)
         @media_type.examples = @media_type.examples.merge(examples)
 

data/lib/oas_rails/builders/oas_route_builder.rb

@@ -0,0 +1,90 @@
+module OasRails
+  module Builders
+    class OasRouteBuilder
+      def self.build_from_rails_route(rails_route)
+        new(rails_route).build
+      end
+
+      def initialize(rails_route)
+        @rails_route = rails_route
+      end
+
+      def build
+        OasRoute.new(
+          controller_class: controller_class,
+          controller_action: controller_action,
+          controller: controller,
+          controller_path: controller_path,
+          method: method,
+          verb: verb,
+          path: path,
+          rails_route: @rails_route,
+          docstring: docstring,
+          source_string: source_string,
+          tags: tags
+        )
+      end
+
+      private
+
+      def controller_class
+        "#{@rails_route.defaults[:controller].camelize}Controller"
+      end
+
+      def controller_action
+        "#{controller_class}##{@rails_route.defaults[:action]}"
+      end
+
+      def controller
+        @rails_route.defaults[:controller]
+      end
+
+      def controller_path
+        Rails.root.join("app/controllers/#{controller}_controller.rb").to_s
+      end
+
+      def method
+        @rails_route.defaults[:action]
+      end
+
+      def verb
+        @rails_route.verb
+      end
+
+      def path
+        Extractors::RouteExtractor.clean_route(@rails_route.path.spec.to_s)
+      end
+
+      def source_string
+        controller_class.constantize.instance_method(method).source
+      end
+
+      def docstring
+        comment_lines = controller_class.constantize.instance_method(method).comment.lines
+        processed_lines = comment_lines.map { |line| line.sub(/^# /, '') }
+
+        filtered_lines = processed_lines.reject do |line|
+          line.include?('rubocop') ||
+            line.include?('TODO')
+        end
+
+        ::YARD::Docstring.parser.parse(filtered_lines.join).to_docstring
+      end
+
+      def tags
+        method_comment = controller_class.constantize.instance_method(method).comment
+        class_comment = controller_class.constantize.instance_method(method).class_comment
+
+        method_tags = parse_tags(method_comment)
+        class_tags = parse_tags(class_comment)
+
+        method_tags + class_tags
+      end
+
+      def parse_tags(comment)
+        lines = comment.lines.map { |line| line.sub(/^# /, '') }
+        ::YARD::Docstring.parser.parse(lines.join).tags
+      end
+    end
+  end
+end

data/lib/oas_rails/builders/parameters_builder.rb

@@ -7,7 +7,7 @@ module OasRails
       end
 
       def from_oas_route(oas_route)
-        parameters_from_tags(tags: oas_route.docstring.tags(:parameter))
+        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

data/lib/oas_rails/builders/request_body_builder.rb

@@ -7,18 +7,18 @@ module OasRails
       end
 
       def from_oas_route(oas_route)
-        tag_request_body = oas_route.docstring.tags(:request_body).first
+        tag_request_body = oas_route.tags(:request_body).first
         if tag_request_body.nil? && OasRails.config.autodiscover_request_body
           detect_request_body(oas_route) if %w[create update].include? oas_route.method
         elsif !tag_request_body.nil?
-          from_tags(tag: tag_request_body, examples_tags: oas_route.docstring.tags(:request_body_example))
+          from_tags(tag: tag_request_body, examples_tags: oas_route.tags(:request_body_example))
         end
 
         self
       end
 
       def from_tags(tag:, examples_tags: [])
-        if tag.klass.ancestors.map(&:to_s).include? 'ActiveRecord::Base'
+        if Utils.active_record_class?(tag.klass)
           from_model_class(klass: tag.klass, description: tag.text, required: tag.required, examples_tags:)
         else
           @request_body.description = tag.text

data/lib/oas_rails/builders/responses_builder.rb

@@ -7,8 +7,8 @@ module OasRails
       end
 
       def from_oas_route(oas_route)
-        oas_route.docstring.tags(:response).each do |tag|
-          content = ContentBuilder.new(@specification, :outgoing).with_schema(tag.schema).with_examples_from_tags(oas_route.docstring.tags(:response_example).filter { |re| re.code == tag.name }).build
+        oas_route.tags(:response).each do |tag|
+          content = ContentBuilder.new(@specification, :outgoing).with_schema(tag.schema).with_examples_from_tags(oas_route.tags(:response_example).filter { |re| re.code == tag.name }).build
           response = ResponseBuilder.new(@specification).with_code(tag.name.to_i).with_description(tag.text).with_content(content).build
 
           @responses.add_response(response)
@@ -18,7 +18,7 @@ module OasRails
       end
 
       def add_autodiscovered_responses(oas_route)
-        return self if !OasRails.config.autodiscover_responses || oas_route.docstring.tags(:response).any?
+        return self if !OasRails.config.autodiscover_responses || oas_route.tags(:response).any?
 
         new_responses = Extractors::RenderResponseExtractor.extract_responses_from_source(@specification, source: oas_route.source_string)
 
@@ -32,29 +32,49 @@ module OasRails
       def add_default_responses(oas_route, security)
         return self unless OasRails.config.set_default_responses
 
-        content = ContentBuilder.new(@specification, :outgoing).with_schema(JsonSchemaGenerator.process_string(OasRails.config.response_body_of_default)[:json_schema]).build
+        common_errors = determine_common_errors(oas_route, security)
+        add_responses_for_errors(common_errors)
+
+        self
+      end
+
+      def build
+        @responses
+      end
+
+      private
+
+      def determine_common_errors(oas_route, security)
         common_errors = []
-        common_errors.push(:unauthorized, :forbidden) if security
+        common_errors.push(:unauthorized, :forbidden, :internal_server_error) if security
 
         case oas_route.method
-        when "show", "update", "destroy"
+        when "show", "destroy"
           common_errors.push(:not_found)
-        when "create", "index"
-          # possible errors for this methods?
+        when "create"
+          common_errors.push(:unprocessable_entity)
+        when "update"
+          common_errors.push(:not_found, :unprocessable_entity)
         end
 
-        (OasRails.config.possible_default_responses & common_errors).each do |e|
-          code = Utils.status_to_integer(e)
+        OasRails.config.possible_default_responses & common_errors
+      end
+
+      def add_responses_for_errors(errors)
+        errors.each do |error|
+          response_body = resolve_response_body(error)
+          content = ContentBuilder.new(@specification, :outgoing).with_schema(JsonSchemaGenerator.process_string(response_body)[:json_schema]).build
+          code = Utils.status_to_integer(error)
           response = ResponseBuilder.new(@specification).with_code(code).with_description(Utils.get_definition(code)).with_content(content).build
 
           @responses.add_response(response) if @responses.responses[response.code].blank?
         end
-
-        self
       end
 
-      def build
-        @responses
+      def resolve_response_body(error)
+        OasRails.config.public_send("response_body_of_#{error}")
+      rescue StandardError
+        OasRails.config.response_body_of_default
       end
     end
   end

data/lib/oas_rails/configuration.rb

@@ -11,12 +11,11 @@ module OasRails
                   :authenticate_all_routes_by_default,
                   :set_default_responses,
                   :possible_default_responses,
-                  :response_body_of_default,
                   :http_verbs,
                   :use_model_names,
                   :rapidoc_theme
 
-    attr_reader :servers, :tags, :security_schema, :include_mode
+    attr_reader :servers, :tags, :security_schema, :include_mode, :response_body_of_default
 
     def initialize
       @info = Spec::Info.new
@@ -33,12 +32,28 @@ module OasRails
       @security_schema = nil
       @security_schemas = {}
       @set_default_responses = true
-      @possible_default_responses = [:not_found, :unauthorized, :forbidden]
+      @possible_default_responses = [:not_found, :unauthorized, :forbidden, :internal_server_error, :unprocessable_entity]
       @http_verbs = [:get, :post, :put, :patch, :delete]
-      @response_body_of_default = "Hash{ success: !Boolean, message: String }"
+      @response_body_of_default = "Hash{ status: !Integer, error: String }"
       @use_model_names = false
       @rapidoc_theme = :rails
       @include_mode = :all
+
+      @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
+
+        define_singleton_method("response_body_of_#{response}") do
+          instance_variable_get(variable_name) || @response_body_of_default
+        end
+      end
     end
 
     def security_schema=(value)
@@ -73,6 +88,13 @@ module OasRails
 
       @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 = {

data/lib/oas_rails/extractors/oas_route_extractor.rb

@@ -2,7 +2,7 @@ module OasRails
   module Extractors
     module OasRouteExtractor
       def extract_summary(oas_route:)
-        oas_route.docstring.tags(:summary).first.try(:text) || generate_crud_name(oas_route.method, oas_route.controller.downcase) || "#{oas_route.verb} #{oas_route.path}"
+        oas_route.tags(:summary).first.try(:text) || generate_crud_name(oas_route.method, oas_route.controller.downcase) || "#{oas_route.verb} #{oas_route.path}"
       end
 
       def extract_operation_id(oas_route:)
@@ -10,7 +10,7 @@ module OasRails
       end
 
       def extract_tags(oas_route:)
-        tags = oas_route.docstring.tags(:tags).first
+        tags = oas_route.tags(:tags).first
         if tags.nil?
           default_tags(oas_route:)
         else
@@ -30,9 +30,9 @@ module OasRails
       end
 
       def extract_security(oas_route:)
-        return [] if oas_route.docstring.tags(:no_auth).any?
+        return [] if oas_route.tags(:no_auth).any?
 
-        if (methods = oas_route.docstring.tags(:auth).first)
+        if (methods = oas_route.tags(:auth).first)
           OasRails.config.security_schemas.keys.map { |key| { key => [] } }.select do |schema|
             methods.types.include?(schema.keys.first.to_s)
           end

data/lib/oas_rails/extractors/render_response_extractor.rb

@@ -60,7 +60,7 @@ module OasRails
           maybe_a_model, errors = content.gsub('@', "").split(".")
           klass = maybe_a_model.singularize.camelize(:upper).constantize
 
-          if klass.ancestors.map(&:to_s).include? 'ActiveRecord::Base'
+          if Utils.active_record_class?(klass)
             schema = Builders::EsquemaBuilder.build_outgoing_schema(klass:)
             if test_singularity(maybe_a_model)
               build_singular_model_schema_and_examples(maybe_a_model, errors, klass, schema)
@@ -81,7 +81,7 @@ module OasRails
         # @return [Array<Hash, Hash>] An array where the first element is the schema and the second is the examples.
         def build_singular_model_schema_and_examples(_maybe_a_model, errors, klass, schema)
           if errors.nil?
-            [schema, Spec::MediaType.search_for_examples_in_tests(klass, context: :outgoing)]
+            [schema, ActiveRecordExampleFinder.new(context: :outgoing).search(klass)]
           else
             # TODO: this is not building the real schema.
             [
@@ -110,7 +110,7 @@ module OasRails
         # @param schema [Hash] The schema for the model.
         # @return [Array<Hash, Hash>] An array where the first element is the schema and the second is the examples.
         def build_array_model_schema_and_examples(maybe_a_model, klass, schema)
-          examples = { maybe_a_model => { value: Spec::MediaType.search_for_examples_in_tests(klass, context: :outgoing).values.map { |p| p.dig(:value, maybe_a_model.singularize.to_sym) } } }
+          examples = { maybe_a_model => { value: ActiveRecordExampleFinder.new(context: :outgoing).search(klass).values.map { |p| p.dig(:value, maybe_a_model.singularize.to_sym) } } }
           [{ type: "array", items: schema }, examples]
         end
 

data/lib/oas_rails/extractors/route_extractor.rb

@@ -48,10 +48,10 @@ module OasRails
         private
 
         def extract_host_routes
-          routes = valid_routes.map { |r| OasRoute.new_from_rails_route(rails_route: r) }
+          routes = valid_routes.map { |r| Builders::OasRouteBuilder.build_from_rails_route(r) }
 
-          routes.select! { |route| route.docstring.tags.any? } if OasRails.config.include_mode == :with_tags
-          routes.select! { |route| route.docstring.tags.any? { |t| t.tag_name == "oas_include" } } if OasRails.config.include_mode == :explicit
+          routes.select! { |route| route.tags.any? } if OasRails.config.include_mode == :with_tags
+          routes.select! { |route| route.tags.any? { |t| t.tag_name == "oas_include" } } if OasRails.config.include_mode == :explicit
           routes
         end
 

data/lib/oas_rails/json_schema_generator.rb

@@ -29,6 +29,8 @@ module OasRails
         { type: :object, required:, properties: parse_object_properties(::Regexp.last_match(1)) }
       when /^Array<(.+)>$/i
         { type: :array, required:, items: parse_type(::Regexp.last_match(1)) }
+      when ->(t) { Utils.active_record_class?(t) }
+        Builders::EsquemaBuilder.build_outgoing_schema(klass: type.constantize)
       else
         { type: type.downcase.to_sym, required: }
       end
@@ -100,6 +102,8 @@ module OasRails
           type: 'array',
           items: to_json_schema(parsed[:items])
         }
+      when nil
+        parsed
       else
         ruby_type_to_json_schema_type(parsed[:type])
       end

data/lib/oas_rails/oas_route.rb

@@ -1,47 +1,21 @@
 module OasRails
   class OasRoute
-    attr_accessor(:controller_class, :controller_action, :controller, :controller_path, :method, :verb, :path,
-                  :rails_route, :docstring, :source_string)
+    attr_accessor :controller_class, :controller_action, :controller, :controller_path, :method, :verb, :path,
+                  :rails_route, :docstring, :source_string
+    attr_writer :tags
 
-    def initialize; end
-
-    def self.new_from_rails_route(rails_route: ActionDispatch::Journey::Route)
-      instance = new
-      instance.rails_route = rails_route
-      instance.extract_rails_route_data
-      instance
-    end
-
-    def extract_rails_route_data
-      @controller_action = "#{@rails_route.defaults[:controller].camelize}Controller##{@rails_route.defaults[:action]}"
-      @controller_class = "#{@rails_route.defaults[:controller].camelize}Controller"
-      @controller = @rails_route.defaults[:controller]
-      @controller_path = controller_path_extractor(@rails_route.defaults[:controller])
-      @method = @rails_route.defaults[:action]
-      @verb = @rails_route.verb
-      @path = Extractors::RouteExtractor.clean_route(@rails_route.path.spec.to_s)
-      @docstring = extract_docstring
-      @source_string = extract_source_string
-    end
-
-    def extract_docstring
-      comment_lines = controller_class.constantize.instance_method(method).comment.lines
-      processed_lines = comment_lines.map do |line|
-        line.sub(/^# /, '')
-      end
-      ::YARD::Docstring.parser.parse(processed_lines.join).to_docstring
-    end
-
-    def extract_source_string
-      @controller_class.constantize.instance_method(method).source
+    def initialize(attributes = {})
+      attributes.each { |key, value| send("#{key}=", value) }
     end
 
     def path_params
       @rails_route.path.spec.to_s.scan(/:(\w+)/).flatten.reject! { |e| e == 'format' }
     end
 
-    def controller_path_extractor(controller)
-      Rails.root.join("app/controllers/#{controller}_controller.rb").to_s
+    def tags(name = nil)
+      return @tags if name.nil?
+
+      @tags.select { |tag| tag.tag_name.to_s == name.to_s }
     end
   end
 end

data/lib/oas_rails/spec/media_type.rb

@@ -5,9 +5,6 @@ module OasRails
 
       attr_accessor :schema, :example, :examples, :encoding
 
-      @context = :incoming
-      @factory_examples = {}
-
       # Initializes a new MediaType object.
       #
       # @param schema [Hash] the schema of the media type.
@@ -22,68 +19,6 @@ module OasRails
       def oas_fields
         [:schema, :example, :examples, :encoding]
       end
-
-      class << self
-        # Searches for examples in test files based on the provided class and test framework.
-        #
-        # @param klass [Class] the class to search examples for.
-        # @param utils [Module] a utility module that provides the `detect_test_framework` method. Defaults to `Utils`.
-        # @return [Hash] a hash containing examples data or an empty hash if no examples are found.
-        def search_for_examples_in_tests(klass, context: :incoming, utils: Utils)
-          @context = context
-          case utils.detect_test_framework
-          when :factory_bot
-            fetch_factory_bot_examples(klass:)
-          when :fixtures
-            fetch_fixture_examples(klass:)
-          else
-            {}
-          end
-        end
-
-        private
-
-        # Fetches examples from FactoryBot for the provided class.
-        #
-        # @param klass [Class] the class to fetch examples for.
-        # @return [Hash] a hash containing examples data or an empty hash if no examples are found.
-        def fetch_factory_bot_examples(klass:)
-          klass_sym = Utils.class_to_symbol(klass)
-
-          begin
-            @factory_examples[klass_sym] = FactoryBot.build_stubbed_list(klass_sym, 1) if @factory_examples[klass_sym].nil?
-
-            @factory_examples[klass_sym].each_with_index.to_h do |obj, index|
-              ["#{klass_sym}#{index + 1}", { value: { klass_sym => clean_example_object(obj: obj.as_json) } }]
-            end
-          rescue KeyError
-            {}
-          end
-        end
-
-        # Fetches examples from fixtures for the provided class.
-        #
-        # @param klass [Class] the class to fetch examples for.
-        # @return [Hash] a hash containing examples data or an empty hash if no examples are found.
-        def fetch_fixture_examples(klass:)
-          fixture_file = Rails.root.join('test', 'fixtures', "#{klass.to_s.pluralize.downcase}.yml")
-          begin
-            erb_result = ERB.new(File.read(fixture_file)).result
-            fixture_data = YAML.safe_load(
-              erb_result,
-              aliases: true,
-              permitted_classes: [Symbol, ActiveSupport::HashWithIndifferentAccess, Time]
-            ).with_indifferent_access
-          rescue Errno::ENOENT
-            return {}
-          end
-          fixture_data.transform_values { |attributes| { value: { klass.to_s.downcase => clean_example_object(obj: attributes) } } }
-        end
-
-        def clean_example_object(obj:)
-          obj.reject { |key, _| OasRails.config.send("excluded_columns_#{@context}").include?(key.to_sym) }
-        end
-      end
     end
   end
 end

data/lib/oas_rails/utils.rb

@@ -14,6 +14,8 @@ module OasRails
     }.freeze
 
     HTTP_STATUS_DEFINITIONS = {
+      200 => "The request has succeeded.",
+      201 => "The request has been fulfilled and resulted in a new resource being created.",
       404 => "The requested resource could not be found.",
       401 => "You are not authorized to access this resource. You need to authenticate yourself first.",
       403 => "You are not allowed to access this resource. You do not have the necessary permissions.",
@@ -34,19 +36,6 @@ module OasRails
         end
       end
 
-      # TODO: check if it is in use
-      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',
@@ -116,6 +105,16 @@ module OasRails
 
         nil # Return nil if no matching constant is found
       end
+
+      # Checks if a given text refers to an ActiveRecord class.
+      # @param text [String] The text to check.
+      # @return [Boolean] True if the text refers to an ActiveRecord class, false otherwise.
+      def active_record_class?(klass_or_string)
+        klass = klass_or_string.is_a?(Class) ? klass_or_string : klass_or_string.constantize
+        klass.ancestors.map(&:to_s).include? 'ActiveRecord::Base'
+      rescue StandardError
+        false
+      end
     end
   end
 end

data/lib/oas_rails/version.rb

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

data/lib/oas_rails/yard/oas_rails_factory.rb

@@ -147,23 +147,13 @@ module OasRails
         match
       end
 
-      # Checks if a given text refers to an ActiveRecord class.
-      # @param text [String] The text to check.
-      # @return [Boolean] True if the text refers to an ActiveRecord class, false otherwise.
-      def active_record_class?(text)
-        klass = text.constantize
-        klass.ancestors.map(&:to_s).include? 'ActiveRecord::Base'
-      rescue StandardError
-        false
-      end
-
       # Converts type text to a schema, checking if it's an ActiveRecord class.
       # @param text [String] The type text to convert.
       # @return [Array] An array containing the class, schema, and required flag.
       def type_text_to_schema(text)
         type_text, required = text_and_required(text)
 
-        if active_record_class?(type_text)
+        if Utils.active_record_class?(type_text)
           klass = type_text.constantize
           schema = Builders::EsquemaBuilder.build_outgoing_schema(klass:)
         else

data/lib/oas_rails.rb

@@ -10,6 +10,7 @@ module OasRails
   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"
@@ -21,6 +22,7 @@ module OasRails
     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.

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: oas_rails
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.14.0
 platform: ruby
 authors:
 - a-chacon
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-04-13 00:00:00.000000000 Z
+date: 2025-05-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: easy_talk
+  name: easy_talk_two
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 1.1.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 1.1.2
 - !ruby/object:Gem::Dependency
   name: method_source
   requirement: !ruby/object:Gem::Requirement
@@ -80,8 +80,10 @@ files:
 - lib/generators/oas_rails/config/config_generator.rb
 - 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