oas_rails 0.10.1 → 0.12.0

data/lib/oas_rails/builders/esquema_builder.rb

@@ -7,10 +7,12 @@ module OasRails
         # @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: EasyTalk)
-          configure_common_settings(model_to_schema_class:)
-          model_to_schema_class.configuration.excluded_columns = OasRails.config.excluded_columns_incoming
-
-          model_to_schema_class::ActiveRecordSchemaBuilder.new(klass).build_schema_definition.as_json["schema"]
+          build_schema(
+            klass: klass,
+            model_to_schema_class: model_to_schema_class,
+            excluded_columns: OasRails.config.excluded_columns_incoming,
+            exclude_primary_key: true
+          )
         end
 
         # Builds a schema for a class when it is used as outgoing API data.
@@ -18,21 +20,37 @@ module OasRails
         # @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: EasyTalk)
-          configure_common_settings(model_to_schema_class:)
-          model_to_schema_class.configuration.excluded_columns = OasRails.config.excluded_columns_outgoing
-          model_to_schema_class.configuration.exclude_primary_key = false
-
-          model_to_schema_class::ActiveRecordSchemaBuilder.new(klass).build_schema_definition.as_json["schema"]
+          build_schema(
+            klass: klass,
+            model_to_schema_class: model_to_schema_class,
+            excluded_columns: OasRails.config.excluded_columns_outgoing,
+            exclude_primary_key: false
+          )
         end
 
         private
 
+        # Builds a schema with the given configuration.
+        #
+        # @param klass [Class] The class for which the schema is built.
+        # @param model_to_schema_class [Class] The schema builder class.
+        # @param excluded_columns [Array] Columns to exclude from the schema.
+        # @param exclude_primary_key [Boolean] Whether to exclude the primary key.
+        # @return [Hash] The schema as a JSON-compatible hash.
+        def build_schema(klass:, model_to_schema_class:, excluded_columns:, exclude_primary_key:)
+          configure_common_settings(model_to_schema_class: model_to_schema_class)
+          model_to_schema_class.configuration.excluded_columns = excluded_columns
+          model_to_schema_class.configuration.exclude_primary_key = exclude_primary_key
+
+          definition = model_to_schema_class::ActiveRecordSchemaBuilder.new(klass).build_schema_definition
+          EasyTalk::Builders::ObjectBuilder.new(definition).build.as_json
+        end
+
         # Configures common settings for schema building.
         #
         # Excludes associations and foreign keys from the schema.
         def configure_common_settings(model_to_schema_class: EasyTalk)
           model_to_schema_class.configuration.exclude_associations = true
-          model_to_schema_class.configuration.exclude_foreign_keys = true
         end
       end
     end

data/lib/oas_rails/configuration.rb

@@ -13,8 +13,10 @@ module OasRails
                   :possible_default_responses,
                   :response_body_of_default,
                   :http_verbs,
-                  :use_model_names
-    attr_reader :servers, :tags, :security_schema
+                  :use_model_names,
+                  :rapidoc_theme
+
+    attr_reader :servers, :tags, :security_schema, :include_mode
 
     def initialize
       @info = Spec::Info.new
@@ -35,6 +37,8 @@ module OasRails
       @http_verbs = [:get, :post, :put, :patch, :delete]
       @response_body_of_default = "Hash{ success: !Boolean, message: String }"
       @use_model_names = false
+      @rapidoc_theme = :rails
+      @include_mode = :all
     end
 
     def security_schema=(value)
@@ -62,6 +66,13 @@ module OasRails
     def excluded_columns_outgoing
       []
     end
+
+    def include_mode=(value)
+      valid_modes = [:all, :with_tags, :explicit]
+      raise ArgumentError, "include_mode must be one of #{valid_modes}" unless valid_modes.include?(value)
+
+      @include_mode = value
+    end
   end
 
   DEFAULT_SECURITY_SCHEMES = {

data/lib/oas_rails/engine.rb

@@ -6,5 +6,11 @@ module OasRails
         inflect.acronym 'YARD'
       end
     end
+
+    config.app_middleware.use(
+      Rack::Static,
+      urls: ["/oas-rails-assets"],
+      root: OasRails::Engine.root.join("public")
+    )
   end
 end

data/lib/oas_rails/extractors/route_extractor.rb

@@ -45,41 +45,14 @@ module OasRails
           route.gsub('(.:format)', '').gsub(/:\w+/) { |match| "{#{match[1..]}}" }
         end
 
-        # THIS CODE IS NOT IN USE BUT CAN BE USEFULL WITH GLOBAL TAGS OR AUTH TAGS
-        # def get_controller_comments(controller_path)
-        #   YARD.parse_string(File.read(controller_path))
-        #   controller_class = YARD::Registry.all(:class).first
-        #   if controller_class
-        #     class_comment = controller_class.docstring.all
-        #     method_comments = controller_class.meths.map do |method|
-        #       {
-        #         name: method.name,
-        #         comment: method.docstring.all
-        #       }
-        #     end
-        #     YARD::Registry.clear
-        #     {
-        #       class_comment: class_comment,
-        #       method_comments: method_comments
-        #     }
-        #   else
-        #     YARD::Registry.clear
-        #     nil
-        #   end
-        # rescue StandardError
-        #   nil
-        # end
-        #
-        # def get_controller_comment(controller_path)
-        #   get_controller_comments(controller_path)&.dig(:class_comment) || ''
-        # rescue StandardError
-        #   ''
-        # end
-
         private
 
         def extract_host_routes
-          valid_routes.map { |r| OasRoute.new_from_rails_route(rails_route: r) }
+          routes = valid_routes.map { |r| OasRoute.new_from_rails_route(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
         end
 
         def valid_routes

data/lib/oas_rails/version.rb

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

data/lib/oas_rails.rb

@@ -90,7 +90,8 @@ module OasRails
         'Endpoint Tags' => [:tags],
         'Summary' => [:summary],
         'No Auth' => [:no_auth],
-        'Auth methods' => [:auth, :with_types]
+        'Auth methods' => [:auth, :with_types],
+        'OAS Include' => [:oas_include]
       }
       yard_tags.each do |tag_name, (method_name, handler)|
         ::YARD::Tags::Library.define_tag(tag_name, method_name, handler)