rswag-api 2.12.0 → 2.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6bd09d4d8032f40d131905519035e07f94986f31505d4f7a79c376d265c538dd
-  data.tar.gz: 00e354141c50226d38b93bcb518ca30220bdd15cbf7e09685008e10855ea1124
+  metadata.gz: 2e80990b064d9bad51bb3eb217987dba1400c5f0b1ec68d903a6f34229f049d6
+  data.tar.gz: eb379a7fa481b8b623d4880d1f9fa9b77531b7b21f766a825ee7c21a4a36daf8
 SHA512:
-  metadata.gz: d02f3d0259e5d80dd9be65a615b845391ba60aefb617ccffbe66d286cb93563030b7a28a45d0b89025f21fffc78c04de43bf07291565f34fcffb968af7ad3ee0
-  data.tar.gz: 15fe7a1954145ce237113f03ca6c25a64fd486103a15e9ef8a9c6385655395e12d0424d89b19a169212c062a6a835307524cc292d436f926d76ab9983478289d
+  metadata.gz: f63243aa5dbb57b92d781f453e4860ca777765f2fdb76a63dee8e4076c9619fa36350ebeb472fb2108528fcd2164c939a67bc109fe55178011b2741b350b5417
+  data.tar.gz: e30f6dee44a3bb6145684fa82d7166c3b023b6a5b262b094670dce637652bb2893012df420a21eaa5857a79657aaef3cbc189dcfd9d35bed41660b6bfeb8b4d9

data/lib/generators/rswag/api/install/templates/rswag_api.rb

@@ -4,7 +4,7 @@ Rswag::Api.configure do |c|
   # This is used by the Swagger middleware to serve requests for API descriptions
   # NOTE: If you're using rswag-specs to generate Swagger, you'll need to ensure
   # that it's configured to generate files in the same folder
-  c.swagger_root = Rails.root.to_s + '/swagger'
+  c.openapi_root = Rails.root.to_s + '/swagger'
 
   # Inject a lambda function to alter the returned Swagger prior to serialization
   # The function will have access to the rack env for the current request

data/lib/rswag/api/configuration.rb

@@ -1,11 +1,19 @@
 module Rswag
   module Api
     class Configuration
-      attr_accessor :swagger_root, :swagger_filter, :swagger_headers
+      attr_accessor :openapi_root, :swagger_filter, :swagger_headers
 
-      def resolve_swagger_root(env)
+      def resolve_openapi_root(env)
         path_params = env['action_dispatch.request.path_parameters'] || {}
-        path_params[:swagger_root] || swagger_root
+
+        if path_params.key?(:swagger_root)
+          Rswag::Api.deprecator.warn(
+            'swagger_root is deprecated and will be removed from rswag-api 3.0 (use openapi_root instead)'
+          )
+          return path_params[:swagger_root]
+        end
+
+        path_params[:openapi_root] || openapi_root
       end
     end
   end

data/lib/rswag/api/middleware.rb

@@ -5,7 +5,6 @@ require 'rack/mime'
 module Rswag
   module Api
     class Middleware
-
       def initialize(app, config)
         @app = app
         @config = config
@@ -15,10 +14,9 @@ module Rswag
         path = env['PATH_INFO']
         # Sanitize the filename for directory traversal by expanding, and ensuring
         # its starts with the root directory.
-        filename = File.expand_path(File.join(@config.resolve_swagger_root(env), path))
-        unless filename.start_with? @config.resolve_swagger_root(env).to_s
-          return @app.call(env)
-        end
+        openapi_root = @config.resolve_openapi_root(env)
+        filename = File.expand_path(File.join(openapi_root, path))
+        return @app.call(env) unless filename.start_with? openapi_root.to_s
 
         if env['REQUEST_METHOD'] == 'GET' && File.file?(filename)
           swagger = parse_file(filename)
@@ -30,11 +28,11 @@ module Rswag
           return [
             '200',
             headers,
-            [ body ]
+            [body]
           ]
         end
 
-        return @app.call(env)
+        @app.call(env)
       end
 
       private

data/lib/rswag/api.rb

@@ -1,8 +1,14 @@
+require 'active_support/deprecation'
 require 'rswag/api/configuration'
-require 'rswag/api/engine'
+require 'rswag/api/engine' if defined?(Rails::Engine)
 
 module Rswag
   module Api
+    RENAMED_METHODS = {
+      swagger_root: :openapi_root
+    }.freeze
+    private_constant :RENAMED_METHODS
+
     def self.configure
       yield(config)
     end
@@ -10,5 +16,22 @@ module Rswag
     def self.config
       @config ||= Configuration.new
     end
+
+    def self.deprecator
+      @deprecator ||= ActiveSupport::Deprecation.new('3.0', 'rswag-api')
+    end
+
+    Configuration.class_eval do
+      RENAMED_METHODS.each do |old_name, new_name|
+        define_method("#{old_name}=") do |*args, &block|
+          public_send("#{new_name}=", *args, &block)
+        end
+      end
+    end
+
+    Api.deprecator.deprecate_methods(
+      Configuration,
+      RENAMED_METHODS.to_h { |old_name, new_name| ["#{old_name}=".to_sym, "#{new_name}=".to_sym] }
+    )
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rswag-api
 version: !ruby/object:Gem::Version
-  version: 2.12.0
+  version: 2.13.0
 platform: ruby
 authors:
 - Richie Morris
@@ -10,8 +10,28 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-11-25 00:00:00.000000000 Z
+date: 2023-11-29 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.2'
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement