oas_rails 0.16.0 → 0.17.0

data/lib/oas_rails/spec/parameter.rb

@@ -1,37 +0,0 @@
-module OasRails
-  module Spec
-    class Parameter
-      include Specable
-      include Hashable
-
-      STYLE_DEFAULTS = { query: 'form', path: 'simple', header: 'simple', cookie: 'form' }.freeze
-
-      attr_accessor :name, :style, :description, :required, :schema
-      attr_reader :in
-
-      def initialize(specification)
-        @specification = specification
-        @name = ""
-        @in = ""
-        @description = ""
-        @required = false
-        @style = ""
-        @schema = { type: 'string' }
-      end
-
-      def in=(value)
-        @in = value
-        @style = STYLE_DEFAULTS[@in.to_sym]
-        @required = true if value == "path"
-      end
-
-      def required?
-        @in == 'path'
-      end
-
-      def oas_fields
-        [:name, :in, :description, :required, :schema, :style]
-      end
-    end
-  end
-end

data/lib/oas_rails/spec/path_item.rb

@@ -1,33 +0,0 @@
-module OasRails
-  module Spec
-    class PathItem
-      include Specable
-      attr_reader :get, :post, :put, :patch, :delete
-
-      def initialize(specification)
-        @specification = specification
-        @get = nil
-        @post = nil
-        @put = nil
-        @patch = nil
-        @delete = nil
-      end
-
-      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
-
-        self
-      end
-
-      def add_operation(http_method, operation)
-        instance_variable_set("@#{http_method}", operation)
-      end
-
-      def oas_fields
-        OasRails.config.http_verbs
-      end
-    end
-  end
-end

data/lib/oas_rails/spec/paths.rb

@@ -1,26 +0,0 @@
-module OasRails
-  module Spec
-    class Paths
-      include Specable
-
-      attr_accessor :path_items
-
-      def initialize(specification)
-        @specification = specification
-        @path_items = {}
-      end
-
-      def add_path(path)
-        @path_items[path] = Builders::PathItemBuilder.new(@specification).from_path(path).build
-      end
-
-      def to_spec
-        paths_hash = {}
-        @path_items.each do |path, path_object|
-          paths_hash[path] = path_object.to_spec
-        end
-        paths_hash
-      end
-    end
-  end
-end

data/lib/oas_rails/spec/reference.rb

@@ -1,16 +0,0 @@
-module OasRails
-  module Spec
-    class Reference
-      include Specable
-      attr_reader :ref
-
-      def initialize(ref)
-        @ref = ref
-      end
-
-      def to_spec
-        { '$ref' => @ref }
-      end
-    end
-  end
-end

data/lib/oas_rails/spec/request_body.rb

@@ -1,21 +0,0 @@
-module OasRails
-  module Spec
-    class RequestBody
-      include Specable
-      include Hashable
-
-      attr_accessor :description, :content, :required
-
-      def initialize(specification)
-        @specification = specification
-        @description = ""
-        @content = {} # a hash with media type objects
-        @required = false
-      end
-
-      def oas_fields
-        [:description, :content, :required]
-      end
-    end
-  end
-end

data/lib/oas_rails/spec/response.rb

@@ -1,20 +0,0 @@
-module OasRails
-  module Spec
-    class Response
-      include Specable
-      include Hashable
-
-      attr_accessor :code, :description, :content
-
-      def initialize(specification)
-        @specification = specification
-        @description = ""
-        @content = {} # Hash with {content: MediaType}
-      end
-
-      def oas_fields
-        [:description, :content]
-      end
-    end
-  end
-end

data/lib/oas_rails/spec/responses.rb

@@ -1,25 +0,0 @@
-module OasRails
-  module Spec
-    class Responses
-      include Specable
-      attr_accessor :responses
-
-      def initialize(specification)
-        @specification = specification
-        @responses = {}
-      end
-
-      def add_response(response)
-        @responses[response.code] = @specification.components.add_response(response)
-      end
-
-      def to_spec
-        spec = {}
-        @responses.each do |key, value|
-          spec[key] = value.to_spec
-        end
-        spec
-      end
-    end
-  end
-end

data/lib/oas_rails/spec/server.rb

@@ -1,17 +0,0 @@
-module OasRails
-  module Spec
-    class Server
-      include Specable
-      attr_accessor :url, :description
-
-      def initialize(url:, description:)
-        @url = url
-        @description = description
-      end
-
-      def oas_fields
-        [:url, :description]
-      end
-    end
-  end
-end

data/lib/oas_rails/spec/specable.rb

@@ -1,54 +0,0 @@
-module OasRails
-  module Spec
-    module Specable
-      def oas_fields
-        []
-      end
-
-      def to_spec
-        hash = {}
-        oas_fields.each do |var|
-          key = var.to_s
-
-          camel_case_key = key.camelize(:lower).to_sym
-          value = send(var)
-
-          processed_value = if value.respond_to?(:to_spec)
-                              value.to_spec
-                            elsif value.is_a?(Array) && value.all? { |elem| elem.respond_to?(:to_spec) }
-                              value.map(&:to_spec)
-                            # elsif value.is_a?(Hash)
-                            #   hash = {}
-                            #   value.each do |key, object|
-                            #     hash[key] = object.to_spec
-                            #   end
-                            #   hash
-                            else
-                              value
-                            end
-
-          hash[camel_case_key] = processed_value unless valid_processed_value?(processed_value)
-        end
-        hash
-      end
-
-      # rubocop:disable Lint/UnusedMethodArgument
-      def as_json(options = nil)
-        to_spec
-      end
-      # rubocop:enable Lint/UnusedMethodArgument
-
-      private
-
-      def valid_processed_value?(processed_value)
-        ((processed_value.is_a?(Hash) || processed_value.is_a?(Array)) && processed_value.empty?) || processed_value.nil?
-      end
-
-      def snake_to_camel(snake_str)
-        words = snake_str.to_s.split('_')
-        words[1..].map!(&:capitalize)
-        (words[0] + words[1..].join).to_sym
-      end
-    end
-  end
-end

data/lib/oas_rails/spec/specification.rb

@@ -1,50 +0,0 @@
-require 'json'
-
-module OasRails
-  module Spec
-    class Specification
-      include Specable
-      attr_accessor :components, :info, :openapi, :servers, :tags, :external_docs, :paths
-
-      # Initializes a new Specification object.
-      # Clears the cache if running in the development environment.
-      def initialize
-        clear_cache unless Rails.env.production?
-
-        @components = Components.new(self)
-        @info = OasRails.config.info
-        @openapi = '3.1.0'
-        @servers = OasRails.config.servers
-        @tags = OasRails.config.tags
-        @external_docs = {}
-        @paths = Spec::Paths.new(self)
-      end
-
-      def build
-        OasRails.config.route_extractor.host_paths.each do |path|
-          @paths.add_path(path)
-        end
-      end
-
-      # Clears the cache for MethodSource and RouteExtractor.
-      #
-      # @return [void]
-      def clear_cache
-        MethodSource.clear_cache
-        OasRails.config.route_extractor.clear_cache
-      end
-
-      def oas_fields
-        [:openapi, :info, :servers, :paths, :components, :security, :tags, :external_docs]
-      end
-
-      # Create the Security Requirement Object.
-      # @see https://spec.openapis.org/oas/latest.html#security-requirement-object
-      def security
-        return [] unless OasRails.config.authenticate_all_routes_by_default
-
-        OasRails.config.security_schemas.map { |key, _| { key => [] } }
-      end
-    end
-  end
-end

data/lib/oas_rails/spec/tag.rb

@@ -1,18 +0,0 @@
-module OasRails
-  module Spec
-    class Tag
-      include Specable
-
-      attr_accessor :name, :description
-
-      def initialize(name:, description:)
-        @name = name.titleize
-        @description = description
-      end
-
-      def oas_fields
-        [:name, :description]
-      end
-    end
-  end
-end

data/lib/oas_rails/yard/example_tag.rb

@@ -1,12 +0,0 @@
-module OasRails
-  module YARD
-    class ExampleTag < ::YARD::Tags::Tag
-      attr_accessor :content
-
-      def initialize(tag_name, text, content: {})
-        super(tag_name, text, nil, nil)
-        @content = content
-      end
-    end
-  end
-end

data/lib/oas_rails/yard/oas_rails_factory.rb

@@ -1,169 +0,0 @@
-module OasRails
-  module YARD
-    class OasRailsFactory < ::YARD::Tags::DefaultFactory
-      # Parses a tag that represents a request body.
-      # @param tag_name [String] The name of the tag.
-      # @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, 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.
-      # @param tag_name [String] The name of the tag.
-      # @param text [String] The tag text to parse.
-      # @return [RequestBodyExampleTag] The parsed request body example tag object.
-      def parse_tag_with_request_body_example(tag_name, text)
-        description, _, hash = extract_description_type_and_content(text.squish, process_content: true, expresion: /^(.*?)\[([^\]]*)\](.*)$/m)
-        RequestBodyExampleTag.new(tag_name, description, content: hash)
-      end
-
-      # Parses a tag that represents a parameter.
-      # @param tag_name [String] The name of the tag.
-      # @param text [String] The tag text to parse.
-      # @return [ParameterTag] The parsed parameter tag object.
-      def parse_tag_with_parameter(tag_name, text)
-        name, location, schema, required, description = extract_name_location_schema_and_description(text.squish)
-        name = "#{name}[]" if location == "query" && schema[:type] == "array"
-        ParameterTag.new(tag_name, name, description, schema, location, required:)
-      end
-
-      # Parses a tag that represents a response.
-      # @param tag_name [String] The name of the tag.
-      # @param text [String] The tag text to parse.
-      # @return [ResponseTag] The parsed response tag object.
-      def parse_tag_with_response(tag_name, text)
-        name, code, schema = extract_name_code_and_schema(text.squish)
-        ResponseTag.new(tag_name, code, name, schema)
-      end
-
-      # Parses a tag that represents a response example.
-      # @param tag_name [String] The name of the tag.
-      # @param text [String] The tag text to parse.
-      # @return [ResponseExampleTag] The parsed response example tag object.
-      def parse_tag_with_response_example(tag_name, text)
-        description, code, hash = extract_name_code_and_hash(text.squish)
-        ResponseExampleTag.new(tag_name, description, content: hash, code:)
-      end
-
-      private
-
-      # Reusable method for extracting description, type, and content with an option to process content.
-      # @param text [String] The text to parse.
-      # @param process_content [Boolean] Whether to evaluate the content as a hash.
-      # @return [Array] An array containing the description, type, and content or remaining text.
-      def extract_description_type_and_content(text, process_content: false, expresion: /^(.*?)\s*\[(.*)\]\s*(.*)$/)
-        match = text.match(expresion)
-        raise ArgumentError, "Invalid tag format: #{text}" if match.nil?
-
-        description = match[1].strip
-        type = match[2].strip
-        content = process_content ? eval_content(match[3].strip) : match[3].strip
-
-        [description, type, content]
-      end
-
-      # 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, 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, content_type]
-      end
-
-      # Specific method to extract name, location, and schema for parameters.
-      # @param text [String] The text to parse.
-      # @return [Array] An array containing the name, location, schema, and required flag.
-      def extract_name_location_schema_and_description(text)
-        match = text.match(/^(.*?)\s*\[(.*?)\]\s*(.*)$/)
-        name, location = extract_text_and_parentheses_content(match[1].strip)
-        schema, required = type_text_to_schema(match[2].strip)[1..]
-        description = match[3].strip
-        [name, location, schema, required, description]
-      end
-
-      # Specific method to extract name, code, and schema for responses.
-      # @param text [String] The text to parse.
-      # @return [Array] An array containing the name, code, and schema.
-      def extract_name_code_and_schema(text)
-        name, code = extract_text_and_parentheses_content(text)
-        _, type, = extract_description_type_and_content(text)
-        schema = type_text_to_schema(type)[1]
-        [name, code, schema]
-      end
-
-      # Specific method to extract name, code, and hash for responses examples.
-      # @param text [String] The text to parse.
-      # @return [Array] An array containing the name, code, and schema.
-      def extract_name_code_and_hash(text)
-        name, code = extract_text_and_parentheses_content(text)
-        _, _, content = extract_description_type_and_content(text, expresion: /^(.*?)\[([^\]]*)\](.*)$/m)
-        hash = eval_content(content)
-        [name, code, hash]
-      end
-
-      # Evaluates a string as a hash, handling errors gracefully.
-      # @param content [String] The content string to evaluate.
-      # @return [Hash] The evaluated hash, or an empty hash if an error occurs.
-      # rubocop:disable Security/Eval
-      def eval_content(content)
-        eval(content)
-      rescue StandardError
-        {}
-      end
-      # rubocop:enable Security/Eval
-
-      # Parses the position name and location from input text.
-      # @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 input unless input =~ /^(.+?)\(([^)]+)\)/
-
-        text = ::Regexp.last_match(1).strip
-        parenthesis_content = ::Regexp.last_match(2).strip
-        [text, parenthesis_content]
-      end
-
-      # Extracts the text and whether it's required.
-      # @param text [String] The text to parse.
-      # @return [Array] An array containing the text and a required flag.
-      def text_and_required(text)
-        if text.start_with?('!')
-          [text.sub(/^!/, ''), true]
-        else
-          [text, false]
-        end
-      end
-
-      # Matches and validates a description and type from text.
-      # @param text [String] The text to parse.
-      # @return [MatchData] The match data from the regex.
-      def description_and_type(text)
-        match = text.match(/^(.*?)\s*\[(.*?)\]\s*(.*)$/)
-        raise ArgumentError, "The request body tag is not valid: #{text}" if match.nil?
-
-        match
-      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 Utils.active_record_class?(type_text)
-          klass = type_text.constantize
-          schema = Builders::EsquemaBuilder.build_outgoing_schema(klass:)
-        else
-          schema = JsonSchemaGenerator.process_string(type_text)[:json_schema]
-          klass = Object
-        end
-        [klass, schema, required]
-      end
-    end
-  end
-end

data/lib/oas_rails/yard/parameter_tag.rb

@@ -1,14 +0,0 @@
-module OasRails
-  module YARD
-    class ParameterTag < ::YARD::Tags::Tag
-      attr_accessor :schema, :required, :location
-
-      def initialize(tag_name, name, text, schema, location, required: false)
-        super(tag_name, text, nil, name)
-        @schema = schema
-        @required = required
-        @location = location
-      end
-    end
-  end
-end

data/lib/oas_rails/yard/request_body_example_tag.rb

@@ -1,11 +0,0 @@
-module OasRails
-  module YARD
-    class RequestBodyExampleTag < ExampleTag
-      attr_accessor :content
-
-      def initialize(tag_name, text, content: {})
-        super
-      end
-    end
-  end
-end

data/lib/oas_rails/yard/request_body_tag.rb

@@ -1,16 +0,0 @@
-module OasRails
-  module YARD
-    class RequestBodyTag < ::YARD::Tags::Tag
-      attr_accessor :klass, :schema, :required, :content_type
-
-      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
-end

data/lib/oas_rails/yard/response_example_tag.rb

@@ -1,12 +0,0 @@
-module OasRails
-  module YARD
-    class ResponseExampleTag < ExampleTag
-      attr_accessor :code
-
-      def initialize(tag_name, text, content: {}, code: 200)
-        super(tag_name, text, content:)
-        @code = code
-      end
-    end
-  end
-end

data/lib/oas_rails/yard/response_tag.rb

@@ -1,13 +0,0 @@
-module OasRails
-  module YARD
-    class ResponseTag < ::YARD::Tags::Tag
-      attr_accessor :schema
-
-      # TODO: name == code. The name MUST be changed to code for better understanding
-      def initialize(tag_name, name, text, schema)
-        super(tag_name, text, nil, name)
-        @schema = schema
-      end
-    end
-  end
-end