oas_rails 1.3.6 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 014c0df55b3801ba802ffd0653f7fb40b7edea57dd6db0b39ce76d91806b7fbc
-  data.tar.gz: 16c8ef0e16ab6743981acc211e24ce6f5618e8ab6e7b458d2f77363115557fe8
+  metadata.gz: 25a9bae1a6533ab3bf3b0ea8c00741c4bd07adc76e06aa5526d1cd9fa8c58d34
+  data.tar.gz: e75c2b1f815498fda47957d426aa6a39ce71b64cac89b1cf91d58ccea882ed3e
 SHA512:
-  metadata.gz: 7e6f1644a2d180b3ce2dc6b81e04cec77b4c3b6876eea7c45d5b0c5169c8d79a3c4dcde33d7c212117b2cc9e7eee3b2fe925c43282650cfe0efea93f1d0586a5
-  data.tar.gz: c1b571cfe98920827405ba76f76c4a03f685d881899a675bc153ff554d5c2986b520e8278b26ffb9353469f90bc006ae353e4efd463aed976fb6544115ba7508
+  metadata.gz: f8f82f7344bd96c8e4e70d65066cef4e1c647b7191318d681057df96e20e3ba7bc88346a85766f82c3e383d1548bba3e3bb9ff5c2a8ed980538ee800531765a2
+  data.tar.gz: ccf3a4c6566a3457b877aee8ba59bb3f8d9bfcf8bd4ee4a157e2c3033800704d6bf7b840b97155700535882d3077f99d0cd277f0fa37d986f96dff7fc38bc0fd

data/app/controllers/oas_rails/oas_rails_controller.rb

@@ -3,13 +3,22 @@ module OasRails
     # Include URL help if the layout is a user-customized layout.
     include Rails.application.routes.url_helpers
 
+    before_action :resolve_config
+
     def index
       respond_to do |format|
-        format.html { render "index", layout: OasRails.config.layout }
+        format.html { render "index", layout: @config.layout }
         format.json do
-          render json: OasRails.build.to_json, status: :ok
+          render json: OasRails.build(config: @config).to_json, status: :ok
         end
       end
     end
+
+    private
+
+    def resolve_config
+      config_name = params.dig("default", "configuration")&.to_sym || :default
+      @config = OasRails.config(config_name)
+    end
   end
 end

data/app/helpers/oas_rails/oas_rails_helper.rb

@@ -2,7 +2,7 @@ module OasRails
   module OasRailsHelper # rubocop:disable Metrics/ModuleLength
     def rapidoc_configuration_defaults
       {
-        "spec-url" => "#{OasRails::Engine.routes.find_script_name(params.permit!.to_h.symbolize_keys)}.json",
+        "spec-url" => "#{request.script_name}.json",
         "show-header" => "false",
         "font-size" => "largest",
         "show-method-in-nav-bar" => "as-colored-text",
@@ -16,13 +16,13 @@ module OasRails
 
     def rapidoc_configuration_attributes
       rapidoc_configuration_defaults.merge(
-        rapidoc_theme(OasRails.config.rapidoc_theme),
-        OasRails.config.rapidoc_configuration
+        rapidoc_theme(@config.rapidoc_theme),
+        @config.rapidoc_configuration
       ).map { |k, v| %(#{k}=#{ERB::Util.html_escape(v)}) }.join(' ')
     end
 
     def rapidoc_logo_url
-      OasRails.config.rapidoc_logo_url
+      @config.rapidoc_logo_url
     end
 
     THEMES = {

data/lib/oas_rails/active_record_example_finder.rb

@@ -1,12 +1,13 @@
 module OasRails
   class ActiveRecordExampleFinder
-    def initialize(context: :incoming, utils: Utils, factory_bot: FactoryBot, erb: ERB, yaml: YAML, file: File)
+    def initialize(context: :incoming, utils: Utils, factory_bot: FactoryBot, erb: ERB, yaml: YAML, file: File, config: nil)
       @context = context
       @utils = utils
       @factory_bot = factory_bot
       @erb = erb
       @yaml = yaml
       @file = file
+      @config = config
       @factory_examples = {}
     end
 
@@ -59,7 +60,8 @@ module OasRails
     end
 
     def clean_example_object(obj:)
-      obj.reject { |key, _| OasRails.config.send("excluded_columns_#{@context}").include?(key.to_sym) }
+      resolved_config = @config || OasRails.config
+      obj.reject { |key, _| resolved_config.send("excluded_columns_#{@context}").include?(key.to_sym) }
     end
   end
 end

data/lib/oas_rails/builders/esquema_builder.rb

@@ -5,12 +5,14 @@ module OasRails
         # 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.
+        # @param config [OasRails::Configuration, nil] Optional config override; falls back to OasRails.config.
         # @return [Hash] The schema as a JSON-compatible hash.
-        def build_incoming_schema(klass:, model_to_schema_class: EasyTalk)
+        def build_incoming_schema(klass:, model_to_schema_class: EasyTalk, config: nil)
+          resolved_config = config || OasRails.config
           build_schema(
             klass: klass,
             model_to_schema_class: model_to_schema_class,
-            excluded_columns: OasRails.config.excluded_columns_incoming,
+            excluded_columns: resolved_config.excluded_columns_incoming,
             exclude_primary_key: true
           )
         end
@@ -18,12 +20,14 @@ module OasRails
         # 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.
+        # @param config [OasRails::Configuration, nil] Optional config override; falls back to OasRails.config.
         # @return [Hash] The schema as a JSON-compatible hash.
-        def build_outgoing_schema(klass:, model_to_schema_class: EasyTalk)
+        def build_outgoing_schema(klass:, model_to_schema_class: EasyTalk, config: nil)
+          resolved_config = config || OasRails.config
           build_schema(
             klass: klass,
             model_to_schema_class: model_to_schema_class,
-            excluded_columns: OasRails.config.excluded_columns_outgoing,
+            excluded_columns: resolved_config.excluded_columns_outgoing,
             exclude_primary_key: false
           )
         end

data/lib/oas_rails/builders/oas_route_builder.rb

@@ -7,12 +7,13 @@ module OasRails
       # source file directly so that OasRails annotations remain readable.
       KNOWN_RUNTIME_WRAPPERS = %w[sorbet-runtime].freeze
 
-      def self.build_from_rails_route(rails_route)
-        new(rails_route).build
+      def self.build_from_rails_route(rails_route, config:)
+        new(rails_route, config:).build
       end
 
-      def initialize(rails_route)
+      def initialize(rails_route, config:)
         @rails_route = rails_route
+        @config = config
       end
 
       def build
@@ -46,7 +47,7 @@ module OasRails
       end
 
       def path
-        OasRails.config.prefix_path + OasRails.config.route_extractor.clean_route(@rails_route.path.spec.to_s)
+        @config.prefix_path + @config.route_extractor.clean_route(@rails_route.path.spec.to_s)
       end
 
       def source_string

data/lib/oas_rails/configuration.rb

@@ -1,10 +1,11 @@
 module OasRails
   class Configuration < OasCore::Configuration
     attr_accessor :autodiscover_request_body, :autodiscover_responses, :ignored_actions, :rapidoc_theme, :layout, :source_oas_path, :rapidoc_configuration, :rapidoc_logo_url
-    attr_reader :route_extractor, :include_mode, :mounted_path, :prefix_path
+    attr_reader :name, :route_extractor, :include_mode, :mounted_path, :prefix_path
 
     def initialize
       super
+      @name = :default
       @mounted_path = ""
       self.prefix_path = ENV["RAILS_RELATIVE_URL_ROOT"] || Rails.application.config.relative_url_root || ""
       @route_extractor = Extractors::RouteExtractor

data/lib/oas_rails/extractors/render_response_extractor.rb

@@ -2,6 +2,12 @@ module OasRails
   module Extractors
     # Extracts and processes render responses from a given source.
     module RenderResponseExtractor
+      # NOTE: This module is invoked as a callback by OasCore during the build pipeline.
+      # Because OasCore controls the call site, it is not possible to inject a named config
+      # here via dependency injection. As a result, calls to EsquemaBuilder and
+      # ActiveRecordExampleFinder from this module will use OasRails.config(:default).
+      # This is a known limitation of the multi-config feature.
+
       class << self
         # Extracts responses from the provided source string.
         #

data/lib/oas_rails/extractors/route_extractor.rb

@@ -10,25 +10,36 @@ module OasRails
       ].freeze
 
       class << self
-        def host_routes_by_path(path)
-          @host_routes ||= extract_host_routes
-          @host_routes.select { |r| r.path == path }
+        def host_routes_by_path(path, config:)
+          @host_routes_cache ||= {}
+          @host_routes_cache[config.name] ||= extract_host_routes(config:)
+          @host_routes_cache[config.name].select { |r| r.path == path }
         end
 
-        def host_routes
-          @host_routes ||= extract_host_routes
+        def host_routes(config:)
+          @host_routes_cache ||= {}
+          @host_routes_cache[config.name] ||= extract_host_routes(config:)
         end
 
-        # Clear Class Instance Variable @host_routes
+        # Clear the cached routes.
         #
-        # This method clear the class instance variable @host_routes
-        # to force a extraction of the routes again.
-        def clear_cache
-          @host_routes = nil
+        # When a +config+ is given, only that config's cache entry is cleared,
+        # forcing the next call to re-extract routes for that configuration.
+        # When called without arguments, the entire cache is cleared for all
+        # configurations.
+        def clear_cache(config: nil)
+          if config
+            @host_routes_cache&.delete(config.name)
+            @host_paths_cache&.delete(config.name)
+          else
+            @host_routes_cache = nil
+            @host_paths_cache = nil
+          end
         end
 
-        def host_paths
-          @host_paths ||= host_routes.map(&:path).uniq.sort
+        def host_paths(config:)
+          @host_paths_cache ||= {}
+          @host_paths_cache[config.name] ||= host_routes(config:).map(&:path).uniq.sort
         end
 
         def clean_route(route)
@@ -37,25 +48,25 @@ module OasRails
 
         private
 
-        def extract_host_routes
-          routes = valid_routes.map { |r| Builders::OasRouteBuilder.build_from_rails_route(r) }
+        def extract_host_routes(config:)
+          routes = valid_routes(config:).map { |r| Builders::OasRouteBuilder.build_from_rails_route(r, config:) }
 
-          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.select! { |route| route.tags.any? } if config.include_mode == :with_tags
+          routes.select! { |route| route.tags.any? { |t| t.tag_name == "oas_include" } } if config.include_mode == :explicit
           routes
         end
 
-        def valid_routes
+        def valid_routes(config:)
           Rails.application.routes.routes.select do |route|
-            valid_api_route?(route)
+            valid_api_route?(route, config:)
           end
         end
 
-        def valid_api_route?(route)
+        def valid_api_route?(route, config:)
           return false unless valid_route_implementation?(route)
           return false if RAILS_DEFAULT_CONTROLLERS.any? { |default| route.defaults[:controller].start_with?(default) }
-          return false unless route.path.spec.to_s.start_with?(OasRails.config.api_path)
-          return false if ignore_custom_actions?(route)
+          return false unless route.path.spec.to_s.start_with?(config.api_path)
+          return false if ignore_custom_actions?(route, config:)
 
           true
         end
@@ -88,9 +99,9 @@ module OasRails
         # Support controller name only to ignore all controller actions.
         # Support ignoring "controller#action"
         # Ignoring "controller#action" AND "api_path/controller#action"
-        def ignore_custom_actions?(route)
-          api_path = "#{OasRails.config.api_path.sub(%r{\A/}, '')}/".sub(%r{/+$}, '/')
-          ignored_actions = OasRails.config.ignored_actions.flat_map do |custom_route|
+        def ignore_custom_actions?(route, config:)
+          api_path = "#{config.api_path.sub(%r{\A/}, '')}/".sub(%r{/+$}, '/')
+          ignored_actions = config.ignored_actions.flat_map do |custom_route|
             if custom_route.start_with?(api_path)
               [custom_route]
             else

data/lib/oas_rails/version.rb

@@ -1,3 +1,3 @@
 module OasRails
-  VERSION = "1.3.6"
+  VERSION = "1.4.0"
 end

data/lib/oas_rails.rb

@@ -24,39 +24,48 @@ module OasRails
   end
 
   class << self
+    # NOTE: This lambda is called back by OasCore during build and has no way to receive
+    # a named config as a parameter. It falls back to OasRails.config(:default).
+    # This is a known limitation: excluded_columns in EsquemaBuilder will always use
+    # the default config when invoked from this re-entry point.
     OasCore::JsonSchemaGenerator.register_type_parser(
       ->(t) { Utils.active_record_class?(t) },
       ->(type, _required) { Builders::EsquemaBuilder.build_outgoing_schema(klass: type.constantize) }
     )
 
-    def build
-      clear_cache
+    def build(config: OasRails.config)
+      clear_cache(config:)
       OasCore.config = config
 
-      host_routes = config.route_extractor.host_routes
-      oas_source = config.source_oas_path ? read_source_oas_file : {}
+      host_routes = config.route_extractor.host_routes(config:)
+      oas_source = config.source_oas_path ? read_source_oas_file(config:) : {}
 
       OasCore.build(host_routes, oas_source: oas_source)
     end
 
-    def configure
-      yield config
+    def configure(name = :default)
+      cfg = Configuration.new
+      yield cfg
+      cfg.instance_variable_set(:@name, name)
+      @configs ||= {}
+      @configs[name] = cfg
     end
 
-    def config
-      @config ||= Configuration.new
+    def config(name = :default)
+      @configs ||= {}
+      @configs[name] ||= Configuration.new
     end
 
     private
 
-    def clear_cache
+    def clear_cache(config:)
       return if Rails.env.production?
 
       MethodSource.clear_cache
-      OasRails::Extractors::RouteExtractor.clear_cache
+      OasRails::Extractors::RouteExtractor.clear_cache(config:)
     end
 
-    def read_source_oas_file
+    def read_source_oas_file(config:)
       file_path = Rails.root.join(config.source_oas_path)
       JSON.parse(File.read(file_path), symbolize_names: true)
     rescue Errno::ENOENT => e

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: oas_rails
 version: !ruby/object:Gem::Version
-  version: 1.3.6
+  version: 1.4.0
 platform: ruby
 authors:
 - a-chacon