oas_rails 0.11.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0c02c7a454cec38660f5d327e61f35c88e3d7ab22b4fc5c18adbed3707c656d7
-  data.tar.gz: 8fb227b665f88c0c6299f1a1bbd9d4c681f1438c13fa93e6f552cd96b1ef7a00
+  metadata.gz: b929476e50a9620b4239738c1753cada50eaa6198ec363afe75dc2690f202504
+  data.tar.gz: df7125a57463f2782254b316cd235a6b11e075e5010bc07d61e6aca8e555cd47
 SHA512:
-  metadata.gz: 2d30c6f893f17476716208e57311b2c290f99208431781085de77d97d9c6c2d5601df5c29e53155d485a3e2d1268383ca6151dd97ae629461db2b8c369df9cdc
-  data.tar.gz: 6b7edd8df46e2ea3b8c20fdbc41ceed453f560a0c619fed3138ae49a5366625e34b36fd0ee6c5d1aff549602c00ae2e4e1b880b58ae1e6f62ffed4c1578e4c6d
+  metadata.gz: 95119f77419a24df6f3d22ef941e2dae351ad965ff2e8b84a7285a73932ab5e617d60c6c4ccfb08dfd44f555c58691ad1053b9983699d3f18b9f3c5a8a626693
+  data.tar.gz: b4cce805735d6c2f0ba7f653bf778f59d7dd4c92be23128cac8bfd2ac0c185ccfd3b79e1f149cb1c17a0d083e8d7e83777b89f2bb96462c1acd2cfefdd6d25b9

data/README.md

@@ -39,7 +39,7 @@ The goal is to minimize the effort required to create comprehensive documentatio
 
 ## Documentation
 
-For see how to install, configure and use OasRails please refere to the [OasRailsBook](http://a-chacon.com/oas_rails/book)
+For see how to install, configure and use OasRails please refere to the [OasRailsBook](http://a-chacon.com/oas_rails)
 
 ## Contributing
 

data/app/views/oas_rails/oas_rails/index.html.erb

@@ -133,6 +133,7 @@
       nav-item-spacing="relaxed"
       allow-spec-file-download="true"
       schema-style="table"
+      sort-tags="true"
     >
     </rapi-doc>
 

data/lib/oas_rails/configuration.rb

@@ -15,7 +15,8 @@ module OasRails
                   :http_verbs,
                   :use_model_names,
                   :rapidoc_theme
-    attr_reader :servers, :tags, :security_schema
+
+    attr_reader :servers, :tags, :security_schema, :include_mode
 
     def initialize
       @info = Spec::Info.new
@@ -37,6 +38,7 @@ module OasRails
       @response_body_of_default = "Hash{ success: !Boolean, message: String }"
       @use_model_names = false
       @rapidoc_theme = :rails
+      @include_mode = :all
     end
 
     def security_schema=(value)
@@ -64,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/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.11.0"
+  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)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: oas_rails
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.12.0
 platform: ruby
 authors:
 - a-chacon
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-04-07 00:00:00.000000000 Z
+date: 2025-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: easy_talk