rswag-api 2.16.0 → 3.0.0.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bc04cec019aea5f72349e2a5e7649d0bd463273bed1fb7e401253ddd250c575c
-  data.tar.gz: a2292a7ffe820a8d47e18aa9dc1fff5ff9e8a319717f1096d6454be959ebf753
+  metadata.gz: 873e326e03b226aa5320861a43304f91adbd4cc8f9fb6fd03202b88199a8e981
+  data.tar.gz: cf45620fc8bf24785a6c9e0c7d0ba86238b5f0f6a5cdd999a013303b99202cce
 SHA512:
-  metadata.gz: e9bcacb5d5f71054e7e0ad28765500c4a030dddca24854cccfd705e8f6bdcab6e35e5d386e9f5d73ba66da888def57e7654663bd3a74af014b9a0b9f82f7aa90
-  data.tar.gz: 994751ed8609db4f71deede9e60770b226505e0414d44abaf702af3bbcd80e6cc916df5f5587cf0c51b26c4c0b07db24d67e009cce2b803d96f775ec4d1600e9
+  metadata.gz: 62b95022d5dbf14b01671db89c0cf0fc6ee2881bbf6fdd767bde4b60331ec24cf1cec0291bad0cd7f043aeb3854554e55de7488942856be17944c9ea5acb174d
+  data.tar.gz: de08556aaca450a7139c91e7ee3bed9687ea3b771179a5f129aae179f39add97f4be179bb79dc38badc72965f9879bcce243d4985941fe586e08bce673e5926d

data/Rakefile

@@ -1,4 +1,6 @@
 #!/usr/bin/env rake
+# frozen_string_literal: true
+
 begin
   require 'bundler/setup'
 rescue LoadError
@@ -20,8 +22,4 @@ RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
-
-
-
 Bundler::GemHelper.install_tasks
-

data/lib/generators/rswag/api/install/install_generator.rb

@@ -1,10 +1,11 @@
+# frozen_string_literal: true
+
 require 'rails/generators'
 
 module Rswag
   module Api
-
     class InstallGenerator < Rails::Generators::Base
-      source_root File.expand_path('../templates', __FILE__)
+      source_root File.expand_path('templates', __dir__)
 
       def add_initializer
         template('rswag_api.rb', 'config/initializers/rswag_api.rb')

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

@@ -1,14 +1,15 @@
-Rswag::Api.configure do |c|
+# frozen_string_literal: true
 
+Rswag::Api.configure do |c|
   # Specify a root folder where Swagger JSON files are located
   # 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.openapi_root = Rails.root.to_s + '/swagger'
+  c.openapi_root = Rails.root.join('openapi').to_s
 
-  # Inject a lambda function to alter the returned Swagger prior to serialization
+  # Inject a lambda function to alter the returned OpenAPI prior to serialization
   # The function will have access to the rack env for the current request
   # For example, you could leverage this to dynamically assign the "host" property
   #
-  #c.swagger_filter = lambda { |swagger, env| swagger['host'] = env['HTTP_HOST'] }
+  # c.openapi_filter = lambda { |swagger, env| swagger['host'] = env['HTTP_HOST'] }
 end

data/lib/rswag/api/configuration.rb

@@ -1,18 +1,12 @@
+# frozen_string_literal: true
+
 module Rswag
   module Api
     class Configuration
-      attr_accessor :openapi_root, :swagger_filter, :swagger_headers
+      attr_accessor :openapi_root, :openapi_filter, :openapi_headers
 
       def resolve_openapi_root(env)
         path_params = env['action_dispatch.request.path_parameters'] || {}
-
-        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

data/lib/rswag/api/engine.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rswag/api/middleware'
 
 module Rswag
@@ -5,7 +7,7 @@ module Rswag
     class Engine < ::Rails::Engine
       isolate_namespace Rswag::Api
 
-      initializer 'rswag-api.initialize' do |app|
+      initializer 'rswag-api.initialize' do |_app|
         middleware.use Rswag::Api::Middleware, Rswag::Api.config
       end
     end

data/lib/rswag/api/middleware.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'json'
 require 'yaml'
 require 'rack/mime'
@@ -19,11 +21,11 @@ module Rswag
         return @app.call(env) unless filename.start_with? openapi_root.to_s
 
         if env['REQUEST_METHOD'] == 'GET' && File.file?(filename)
-          swagger = parse_file(filename)
-          @config.swagger_filter.call(swagger, env) unless @config.swagger_filter.nil?
+          openapi = parse_file(filename)
+          @config.openapi_filter.call(openapi, env) unless @config.openapi_filter.nil?
           mime = Rack::Mime.mime_type(::File.extname(path), 'text/plain')
-          headers = { 'Content-Type' => mime }.merge(@config.swagger_headers || {})
-          body = unload_swagger(filename, swagger)
+          headers = { 'Content-Type' => mime }.merge(@config.openapi_headers || {})
+          body = unload_openapi(filename, openapi)
 
           return [
             '200',
@@ -38,7 +40,7 @@ module Rswag
       private
 
       def parse_file(filename)
-        if /\.ya?ml$/ === filename
+        if /\.ya?ml$/.match?(filename)
           load_yaml(filename)
         else
           load_json(filename)
@@ -53,11 +55,11 @@ module Rswag
         JSON.parse(File.read(filename))
       end
 
-      def unload_swagger(filename, swagger)
-        if /\.ya?ml$/ === filename
-          YAML.dump(swagger)
+      def unload_openapi(filename, openapi)
+        if /\.ya?ml$/.match?(filename)
+          YAML.dump(openapi)
         else
-          JSON.dump(swagger)
+          JSON.dump(openapi)
         end
       end
     end

data/lib/rswag/api.rb

@@ -1,14 +1,11 @@
+# frozen_string_literal: true
+
 require 'active_support/deprecation'
 require 'rswag/api/configuration'
 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
@@ -16,22 +13,5 @@ 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,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: rswag-api
 version: !ruby/object:Gem::Version
-  version: 2.16.0
+  version: 3.0.0.pre
 platform: ruby
 authors:
 - Richie Morris
 - Greg Myers
 - Jay Danielian
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-13 00:00:00.000000000 Z
+date: 2025-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -66,9 +66,10 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 0.21.2
-description: 'Open up your API to the phenomenal OpenAPI ecosystem by exposing OpenAPI
-  files, that describe your service, as JSON endpoints. More about the OpenAPI initiative
-  here: http://spec.openapis.org/'
+description: |
+  Open up your API to the phenomenal OpenAPI ecosystem by exposing OpenAPI files,
+  that describe your service, as JSON endpoints.
+  More about the OpenAPI initiative here: http://spec.openapis.org/
 email:
 - domaindrivendev@gmail.com
 executables: []
@@ -88,7 +89,7 @@ homepage: https://github.com/rswag/rswag
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -104,7 +105,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.5.11
-signing_key: 
+signing_key:
 specification_version: 4
 summary: A Rails Engine that exposes OpenAPI (formerly called Swagger) files as JSON
   endpoints