oas_rails 0.4.1 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 85ae0895f424fb76a5e8b50b5f56c82f526a354ec5e9ec562f76219942da99a4
-  data.tar.gz: bcfa9af3b8500e7204b4143173f86ef17d7c36083dfd44490047b7f0beac0c44
+  metadata.gz: e565b7ee73dcf69c0b137f85039ef4de0e3a8d8b2fe3a4a8871df7141aecc30d
+  data.tar.gz: 56065fc1840d7a4a3ec59083e023ac4aaee4010ac3e34565cae763987dbcb53b
 SHA512:
-  metadata.gz: 7b6543957203039aec05ac6c324bd334df075871963f60408d257084df4f908fcac5facff6c69d867d02ad3bef02596a948b784d4f70e12ae7350d6c6dcf6632
-  data.tar.gz: 672a557da4a80d153ecc6d37e73ddabecbc1ad03b7556470cca2f038964214fcb061cedec7866cfe1a2b7e87a3ea77496e0f82e14d182c470e24e4ebcd0e0355
+  metadata.gz: 64185e13eb921be737e9536ece390e82632476632fd1a8ad67c5b5e4d75243c597f3d17e5be91b2e1d56bff5b7418955505082c06c7f823daba9a5a1dfcb877f
+  data.tar.gz: 47aa8d96c6dd12afd9c3047e3477f7ac164066f7a2f583a5f6fca8ca288934634b5d9c6911b6a7f08494f7055b6a1c7074004f918f3e65352e5b9043ee4e4af0

data/README.md

@@ -1,6 +1,9 @@
-![Gem Version](https://img.shields.io/gem/v/oas_rails)
-![GitHub License](https://img.shields.io/github/license/a-chacon/oas_rails)
+![Gem Version](https://img.shields.io/gem/v/oas_rails?color=E9573F)
+![GitHub License](https://img.shields.io/github/license/a-chacon/oas_rails?color=blue)
 ![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/a-chacon/oas_rails/.github%2Fworkflows%2Frubyonrails.yml)
+![Gem Total Downloads](https://img.shields.io/gem/dt/oas_rails)
+![Static Badge](https://img.shields.io/badge/Rails-%3E%3D7.0.0-%23E9573F)
+![Static Badge](https://img.shields.io/badge/Ruby-%3E%3D3.1.0-%23E9573F)
 
 # Open API Specification For Rails
 

data/lib/oas_rails/builders/content_builder.rb

@@ -35,7 +35,7 @@ module OasRails
       def from_model_class(klass)
         return self unless klass.ancestors.include? ActiveRecord::Base
 
-        model_schema = EsquemaBuilder.send("build_#{@context}_schema", 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)

data/lib/oas_rails/builders/esquema_builder.rb

@@ -0,0 +1,39 @@
+module OasRails
+  module Builders
+    module EsquemaBuilder
+      class << self
+        # Builds a schema for a class when it is used as incoming API data.
+        #
+        # @param klass [Class] The class for which the schema is built.
+        # @return [Hash] The schema as a JSON-compatible hash.
+        def build_incoming_schema(klass:, model_to_schema_class: Esquema)
+          configure_common_settings
+          model_to_schema_class.configuration.excluded_columns = OasRails.config.excluded_columns_incoming
+
+          model_to_schema_class::Builder.new(klass).build_schema.as_json
+        end
+
+        # Builds a schema for a class when it is used as outgoing API data.
+        #
+        # @param klass [Class] The class for which the schema is built.
+        # @return [Hash] The schema as a JSON-compatible hash.
+        def build_outgoing_schema(klass:, model_to_schema_class: Esquema)
+          configure_common_settings
+          model_to_schema_class.configuration.excluded_columns = OasRails.config.excluded_columns_outgoing
+
+          model_to_schema_class::Builder.new(klass).build_schema.as_json
+        end
+
+        private
+
+        # Configures common settings for schema building.
+        #
+        # Excludes associations and foreign keys from the schema.
+        def configure_common_settings
+          Esquema.configuration.exclude_associations = true
+          Esquema.configuration.exclude_foreign_keys = true
+        end
+      end
+    end
+  end
+end

data/lib/oas_rails/extractors/render_response_extractor.rb

@@ -61,7 +61,7 @@ module OasRails
           klass = maybe_a_model.singularize.camelize(:upper).constantize
 
           if klass.ancestors.include?(ActiveRecord::Base)
-            schema = EsquemaBuilder.build_outgoing_schema(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)
             else

data/lib/oas_rails/spec/parameter.rb

@@ -6,7 +6,8 @@ module OasRails
 
       STYLE_DEFAULTS = { query: 'form', path: 'simple', header: 'simple', cookie: 'form' }.freeze
 
-      attr_accessor :name, :in, :style, :description, :required, :schema
+      attr_accessor :name, :style, :description, :required, :schema
+      attr_reader :in
 
       def initialize(specification)
         @specification = specification
@@ -18,8 +19,10 @@ module OasRails
         @schema = { type: 'string' }
       end
 
-      def default_from_in
-        STYLE_DEFAULTS[@in.to_sym]
+      def in=(value)
+        @in = value
+        @style = STYLE_DEFAULTS[@in.to_sym]
+        @required = true if value == "path"
       end
 
       def required?

data/lib/oas_rails/spec/specable.rb

@@ -18,8 +18,6 @@ module OasRails
                             elsif value.is_a?(Array) && value.all? { |elem| elem.respond_to?(:to_spec) }
                               value.map(&:to_spec)
                             # elsif value.is_a?(Hash)
-                            #   p "Here"
-                            #   p value
                             #   hash = {}
                             #   value.each do |key, object|
                             #     hash[key] = object.to_spec
@@ -29,18 +27,23 @@ module OasRails
                               value
                             end
 
-          # hash[camel_case_key] = processed_value unless (processed_value.is_a?(Hash) || processed_value.is_a?(Array)) && processed_value.empty?
-          hash[camel_case_key] = processed_value unless processed_value.nil?
+          hash[camel_case_key] = processed_value unless valid_processed_value?(processed_value)
         end
         hash
       end
 
-      def as_json
+      # 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)

data/lib/oas_rails/utils.rb

@@ -80,7 +80,7 @@ module OasRails
         if status.to_s =~ /^\d+$/
           status.to_i
         else
-          status = "unprocessable_content" if status == "unprocessable_entity"
+          # status = "unprocessable_content" if status == "unprocessable_entity"
           Rack::Utils::SYMBOL_TO_STATUS_CODE[status.to_sym]
         end
       end

data/lib/oas_rails/version.rb

@@ -1,3 +1,3 @@
 module OasRails
-  VERSION = "0.4.1"
+  VERSION = "0.4.3"
 end

data/lib/oas_rails.rb

@@ -9,7 +9,6 @@ module OasRails
   autoload :Configuration, "oas_rails/configuration"
   autoload :OasRoute, "oas_rails/oas_route"
   autoload :Utils, "oas_rails/utils"
-  autoload :EsquemaBuilder, "oas_rails/esquema_builder"
 
   module Builders
     autoload :OperationBuilder, "oas_rails/builders/operation_builder"
@@ -20,6 +19,7 @@ module OasRails
     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"
   end
 
   # This module contains all the clases that represent a part of the OAS file.

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: oas_rails
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.3
 platform: ruby
 authors:
 - a-chacon
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-08-11 00:00:00.000000000 Z
+date: 2024-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: esquema
+  name: method_source
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.2
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.2
+        version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: method_source
+  name: model-to-schema
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 0.1.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 0.1.1
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -45,9 +45,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '7.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 7.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -55,9 +52,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '7.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 7.0.0
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -101,6 +95,7 @@ files:
 - lib/generators/oas_rails/config/templates/oas_rails_initializer.rb
 - lib/oas_rails.rb
 - lib/oas_rails/builders/content_builder.rb
+- lib/oas_rails/builders/esquema_builder.rb
 - lib/oas_rails/builders/operation_builder.rb
 - lib/oas_rails/builders/parameter_builder.rb
 - lib/oas_rails/builders/parameters_builder.rb
@@ -110,7 +105,6 @@ files:
 - lib/oas_rails/builders/responses_builder.rb
 - lib/oas_rails/configuration.rb
 - lib/oas_rails/engine.rb
-- lib/oas_rails/esquema_builder.rb
 - lib/oas_rails/extractors/oas_route_extractor.rb
 - lib/oas_rails/extractors/render_response_extractor.rb
 - lib/oas_rails/extractors/route_extractor.rb
@@ -156,7 +150,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.9
+rubygems_version: 3.5.11
 signing_key: 
 specification_version: 4
 summary: OasRails is a Rails engine for generating automatic interactive documentation

data/lib/oas_rails/esquema_builder.rb

@@ -1,37 +0,0 @@
-module OasRails
-  module EsquemaBuilder
-    class << self
-      # Builds a schema for a class when it is used as incoming API data.
-      #
-      # @param klass [Class] The class for which the schema is built.
-      # @return [Hash] The schema as a JSON-compatible hash.
-      def build_incoming_schema(klass:)
-        configure_common_settings
-        Esquema.configuration.excluded_columns = OasRails.config.excluded_columns_incoming
-
-        Esquema::Builder.new(klass).build_schema.as_json
-      end
-
-      # Builds a schema for a class when it is used as outgoing API data.
-      #
-      # @param klass [Class] The class for which the schema is built.
-      # @return [Hash] The schema as a JSON-compatible hash.
-      def build_outgoing_schema(klass:)
-        configure_common_settings
-        Esquema.configuration.excluded_columns = OasRails.config.excluded_columns_outgoing
-
-        Esquema::Builder.new(klass).build_schema.as_json
-      end
-
-      private
-
-      # Configures common settings for schema building.
-      #
-      # Excludes associations and foreign keys from the schema.
-      def configure_common_settings
-        Esquema.configuration.exclude_associations = true
-        Esquema.configuration.exclude_foreign_keys = true
-      end
-    end
-  end
-end