rswag-specs 2.12.0 → 2.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8365b4004ddfecc85ca45dd075921a254a22445f83dfbca7d400c80b92090062
-  data.tar.gz: c9909fc3b98dd83eae3f5d1d83cf065cb293583fc6b9b1edcad696cd5bf5398f
+  metadata.gz: a4cbdf31d7dbcce5ecc58c58544873479a159a78e54b08717a32c17a246e017a
+  data.tar.gz: d136dbe25d2ad3abebaa9f25c54788d989ad77e060c7777dbde1a007831701cc
 SHA512:
-  metadata.gz: d605e82f0cf92dc730a7c33ff205758328be6874381e72dfa7c5ff2adcc4ad330e67a1ca36781a838a09556059ad2a574b32c9fdb3ef7eeada7b9215465a1ff3
-  data.tar.gz: 1f9368eb7f6a268f59114ecf6a2fa8493cc855e8e9aeb708f6fe762e623a5a606b01080e44cd85734fe72add620d08c85949be71e31ae2f6c4207a4c047b9e63
+  metadata.gz: 123ca088b4c0bf69c45c399c61b29af122631111cc22c3e83965521fc36561f076e90f94b6ee53eeea56625a6ee5d432939dbd31494fb4e66f5ceefebd077752
+  data.tar.gz: 155f8b3dbbc824751ae8e82e1ba25da43253aa40f76aff419473f1f97faa64026ffde966d5a23c7b01c98e577e4f4a183d4f4e9b6b04c585fe054103ce00d76e

data/lib/generators/rswag/specs/install/templates/swagger_helper.rb

@@ -6,15 +6,15 @@ RSpec.configure do |config|
   # Specify a root folder where Swagger JSON files are generated
   # NOTE: If you're using the rswag-api to serve API descriptions, you'll need
   # to ensure that it's configured to serve Swagger from the same folder
-  config.swagger_root = Rails.root.join('swagger').to_s
+  config.openapi_root = Rails.root.join('swagger').to_s
 
   # Define one or more Swagger documents and provide global metadata for each one
   # When you run the 'rswag:specs:swaggerize' rake task, the complete Swagger will
-  # be generated at the provided relative path under swagger_root
+  # be generated at the provided relative path under openapi_root
   # By default, the operations defined in spec files are added to the first
-  # document below. You can override this behavior by adding a swagger_doc tag to the
-  # the root example_group in your specs, e.g. describe '...', swagger_doc: 'v2/swagger.json'
-  config.swagger_docs = {
+  # document below. You can override this behavior by adding a openapi_spec tag to the
+  # the root example_group in your specs, e.g. describe '...', openapi_spec: 'v2/swagger.json'
+  config.openapi_specs = {
     'v1/swagger.yaml' => {
       openapi: '3.0.1',
       info: {
@@ -36,8 +36,8 @@ RSpec.configure do |config|
   }
 
   # Specify the format of the output Swagger file when running 'rswag:specs:swaggerize'.
-  # The swagger_docs configuration option has the filename including format in
+  # The openapi_specs configuration option has the filename including format in
   # the key, this may want to be changed to avoid putting yaml in json files.
   # Defaults to json. Accepts ':json' and ':yaml'.
-  config.swagger_format = :yaml
+  config.openapi_format = :yaml
 end

data/lib/rswag/specs/configuration.rb

@@ -7,63 +7,59 @@ module Rswag
         @rspec_config = rspec_config
       end
 
-      def swagger_root
-        ActiveSupport::Deprecation.warn('Rswag::Specs: WARNING: The method will be renamed to "openapi_root" in v3.0')
-        @swagger_root ||= begin
-          if @rspec_config.swagger_root.nil?
-            raise ConfigurationError, 'No swagger_root provided. See swagger_helper.rb'
+      def openapi_root
+        @openapi_root ||=
+          @rspec_config.openapi_root || raise(ConfigurationError, 'No openapi_root provided. See swagger_helper.rb')
+      end
+
+      def openapi_specs
+        @openapi_specs ||= begin
+          if @rspec_config.openapi_specs.nil? || @rspec_config.openapi_specs.empty?
+            raise ConfigurationError, 'No openapi_specs defined. See swagger_helper.rb'
           end
 
-          @rspec_config.swagger_root
+          @rspec_config.openapi_specs
         end
       end
 
-      def swagger_docs
-        ActiveSupport::Deprecation.warn('Rswag::Specs: WARNING: The method will be renamed to "openapi_specs" in v3.0')
-        @swagger_docs ||= begin
-          if @rspec_config.swagger_docs.nil? || @rspec_config.swagger_docs.empty?
-            raise ConfigurationError, 'No swagger_docs defined. See swagger_helper.rb'
+      def rswag_dry_run
+        @rswag_dry_run ||= begin
+          if ENV.key?('SWAGGER_DRY_RUN') || ENV.key?('RSWAG_DRY_RUN')
+            @rspec_config.rswag_dry_run = ENV['SWAGGER_DRY_RUN'] == '1' || ENV['RSWAG_DRY_RUN'] == '1'
           end
 
-          @rspec_config.swagger_docs
+          @rspec_config.rswag_dry_run.nil? || @rspec_config.rswag_dry_run
         end
       end
 
-      def swagger_dry_run
-        ActiveSupport::Deprecation.warn('Rswag::Specs: WARNING: The method will be renamed to "rswag_dry_run" in v3.0')
-        return @swagger_dry_run if defined? @swagger_dry_run
-        if ENV.key?('SWAGGER_DRY_RUN')
-          @rspec_config.swagger_dry_run = ENV['SWAGGER_DRY_RUN'] == '1'
-        end
-        @swagger_dry_run = @rspec_config.swagger_dry_run.nil? || @rspec_config.swagger_dry_run
-      end
+      def openapi_format
+        @openapi_format ||= begin
+          if @rspec_config.openapi_format.nil? || @rspec_config.openapi_format.empty?
+            @rspec_config.openapi_format = :json
+          end
 
-      def swagger_format
-        ActiveSupport::Deprecation.warn('Rswag::Specs: WARNING: The method will be renamed to "openapi_format" in v3.0')
-        @swagger_format ||= begin
-          @rspec_config.swagger_format = :json if @rspec_config.swagger_format.nil? || @rspec_config.swagger_format.empty?
-          raise ConfigurationError, "Unknown swagger_format '#{@rspec_config.swagger_format}'" unless [:json, :yaml].include?(@rspec_config.swagger_format)
+          unless [:json, :yaml].include?(@rspec_config.openapi_format)
+            raise ConfigurationError, "Unknown openapi_format '#{@rspec_config.openapi_format}'"
+          end
 
-          @rspec_config.swagger_format
+          @rspec_config.openapi_format
         end
       end
 
-      def get_swagger_doc(name)
-        ActiveSupport::Deprecation.warn('Rswag::Specs: WARNING: The method will be renamed to "get_openapi_spec" in v3.0')
-        return swagger_docs.values.first if name.nil?
-        raise ConfigurationError, "Unknown swagger_doc '#{name}'" unless swagger_docs[name]
+      def get_openapi_spec(name)
+        return openapi_specs.values.first if name.nil?
+        raise ConfigurationError, "Unknown openapi_spec '#{name}'" unless openapi_specs[name]
 
-        swagger_docs[name]
+        openapi_specs[name]
       end
 
-      def get_swagger_doc_version(name)
-        doc = get_swagger_doc(name)
+      def get_openapi_spec_version(name)
+        doc = get_openapi_spec(name)
         doc[:openapi] || doc[:swagger]
       end
 
-      def swagger_strict_schema_validation
-        ActiveSupport::Deprecation.warn('Rswag::Specs: WARNING: The method will be renamed to "openapi_strict_schema_validation" in v3.0')
-        @swagger_strict_schema_validation ||= (@rspec_config.swagger_strict_schema_validation || false)
+      def openapi_strict_schema_validation
+        @rspec_config.openapi_strict_schema_validation || false
       end
     end
 

data/lib/rswag/specs/example_group_helpers.rb

@@ -5,8 +5,6 @@ require 'active_support'
 module Rswag
   module Specs
     module ExampleGroupHelpers
-      ActiveSupport::Deprecation.warn('Rswag::Specs: WARNING: Support for Ruby 2.6 will be dropped in v3.0') if RUBY_VERSION.start_with? '2.6'
-
       def path(template, metadata = {}, &block)
         metadata[:path_item] = { template: template }
         describe(template, metadata, &block)
@@ -129,7 +127,6 @@ module Rswag
         description ||= "returns a #{metadata[:response][:code]} response"
 
         if RSPEC_VERSION < 3
-          ActiveSupport::Deprecation.warn('Rswag::Specs: WARNING: Support for RSpec 2.X will be dropped in v3.0')
           before do
             submit_request(example.metadata)
           end

data/lib/rswag/specs/railtie.rb

@@ -8,7 +8,13 @@ module Rswag
       end
 
       generators do
-        require 'generators/rspec/swagger_generator.rb'
+        require 'generators/rspec/swagger_generator'
+      end
+
+      initializer 'rswag-specs.deprecator' do |app|
+        if app.respond_to?(:deprecators)
+          app.deprecators[:rswag_specs] = Rswag::Specs.deprecator
+        end
       end
     end
   end

data/lib/rswag/specs/request_factory.rb

@@ -12,7 +12,7 @@ module Rswag
       end
 
       def build_request(metadata, example)
-        swagger_doc = @config.get_swagger_doc(metadata[:swagger_doc])
+        swagger_doc = @config.get_openapi_spec(metadata[:openapi_spec] || metadata[:swagger_doc])
         parameters = expand_parameters(metadata, swagger_doc, example)
 
         {}.tap do |request|
@@ -53,7 +53,7 @@ module Rswag
           (swagger_doc[:securityDefinitions] || {}).slice(*scheme_names).values
         else # Openapi3
           if swagger_doc.key?(:securityDefinitions)
-            ActiveSupport::Deprecation.warn('Rswag::Specs: WARNING: securityDefinitions is replaced in OpenAPI3! Rename to components/securitySchemes (in swagger_helper.rb)')
+            Rswag::Specs.deprecator.warn('Rswag::Specs: WARNING: securityDefinitions is replaced in OpenAPI3! Rename to components/securitySchemes (in swagger_helper.rb)')
             swagger_doc[:components] ||= { securitySchemes: swagger_doc[:securityDefinitions] }
             swagger_doc.delete(:securityDefinitions)
           end
@@ -75,7 +75,7 @@ module Rswag
           ref.sub('#/parameters/', '').to_sym
         else # Openapi3
           if ref.start_with?('#/parameters/')
-            ActiveSupport::Deprecation.warn('Rswag::Specs: WARNING: #/parameters/ refs are replaced in OpenAPI3! Rename to #/components/parameters/')
+            Rswag::Specs.deprecator.warn('Rswag::Specs: WARNING: #/parameters/ refs are replaced in OpenAPI3! Rename to #/components/parameters/')
             ref.sub('#/parameters/', '').to_sym
           else
             ref.sub('#/components/parameters/', '').to_sym
@@ -88,7 +88,7 @@ module Rswag
           swagger_doc[:parameters]
         else # Openapi3
           if swagger_doc.key?(:parameters)
-            ActiveSupport::Deprecation.warn('Rswag::Specs: WARNING: parameters is replaced in OpenAPI3! Rename to components/parameters (in swagger_helper.rb)')
+            Rswag::Specs.deprecator.warn('Rswag::Specs: WARNING: parameters is replaced in OpenAPI3! Rename to components/parameters (in swagger_helper.rb)')
             swagger_doc[:parameters]
           else
             components = swagger_doc[:components] || {}
@@ -115,7 +115,7 @@ module Rswag
         uses_base_path = swagger_doc[:basePath].present?
 
         if open_api_3_doc && uses_base_path
-          ActiveSupport::Deprecation.warn('Rswag::Specs: WARNING: basePath is replaced in OpenAPI3! Update your swagger_helper.rb')
+          Rswag::Specs.deprecator.warn('Rswag::Specs: WARNING: basePath is replaced in OpenAPI3! Update your swagger_helper.rb')
         end
 
         if uses_base_path

data/lib/rswag/specs/response_validator.rb

@@ -13,7 +13,7 @@ module Rswag
       end
 
       def validate!(metadata, response)
-        swagger_doc = @config.get_swagger_doc(metadata[:swagger_doc])
+        swagger_doc = @config.get_openapi_spec(metadata[:openapi_spec] || metadata[:swagger_doc])
 
         validate_code!(metadata, response)
         validate_headers!(metadata, response.headers)
@@ -55,7 +55,7 @@ module Rswag
         response_schema = metadata[:response][:schema]
         return if response_schema.nil?
 
-        version = @config.get_swagger_doc_version(metadata[:swagger_doc])
+        version = @config.get_openapi_spec_version(metadata[:openapi_spec] || metadata[:swagger_doc])
         schemas = definitions_or_component_schemas(swagger_doc, version)
 
         validation_schema = response_schema
@@ -73,10 +73,12 @@ module Rswag
       end
 
       def validation_options_from(metadata)
-        is_strict = !!metadata.fetch(
-          :swagger_strict_schema_validation,
-          @config.swagger_strict_schema_validation
-        )
+        if metadata.key?(:swagger_strict_schema_validation)
+          Rswag::Specs.deprecator.warn('Rswag::Specs: WARNING: This option will be renamed to "openapi_strict_schema_validation" in v3.0')
+          is_strict = !!metadata[:swagger_strict_schema_validation]
+        else
+          is_strict = !!metadata.fetch(:openapi_strict_schema_validation, @config.openapi_strict_schema_validation)
+        end
 
         { strict: is_strict }
       end
@@ -86,7 +88,7 @@ module Rswag
           swagger_doc.slice(:definitions)
         else # Openapi3
           if swagger_doc.key?(:definitions)
-            ActiveSupport::Deprecation.warn('Rswag::Specs: WARNING: definitions is replaced in OpenAPI3! Rename to components/schemas (in swagger_helper.rb)')
+            Rswag::Specs.deprecator.warn('Rswag::Specs: WARNING: definitions is replaced in OpenAPI3! Rename to components/schemas (in swagger_helper.rb)')
             swagger_doc.slice(:definitions)
           else
             components = swagger_doc[:components] || {}

data/lib/rswag/specs/swagger_formatter.rb

@@ -7,16 +7,12 @@ require 'swagger_helper'
 module Rswag
   module Specs
     class SwaggerFormatter < ::RSpec::Core::Formatters::BaseTextFormatter
-      ActiveSupport::Deprecation.warn('Rswag::Specs: WARNING: Support for Ruby 2.6 will be dropped in v3.0') if RUBY_VERSION.start_with? '2.6'
-
       if RSPEC_VERSION > 2
         ::RSpec::Core::Formatters.register self, :example_group_finished, :stop
-      else
-        ActiveSupport::Deprecation.warn('Rswag::Specs: WARNING: Support for RSpec 2.X will be dropped in v3.0')
       end
 
       def initialize(output, config = Rswag::Specs.config)
-        @output = output
+        super(output)
         @config = config
 
         @output.puts 'Generating Swagger docs ...'
@@ -34,7 +30,7 @@ module Rswag
         return if metadata[:document] == false
         return unless metadata.key?(:response)
 
-        swagger_doc = @config.get_swagger_doc(metadata[:swagger_doc])
+        swagger_doc = @config.get_openapi_spec(metadata[:openapi_spec] || metadata[:swagger_doc])
 
         unless doc_version(swagger_doc).start_with?('2')
           # This is called multiple times per file!
@@ -50,7 +46,7 @@ module Rswag
       end
 
       def stop(_notification = nil)
-        @config.swagger_docs.each do |url_path, doc|
+        @config.openapi_specs.each do |url_path, doc|
           unless doc_version(doc).start_with?('2')
             doc[:paths]&.each_pair do |_k, v|
               v.each_pair do |_verb, value|
@@ -85,7 +81,7 @@ module Rswag
             end
           end
 
-          file_path = File.join(@config.swagger_root, url_path)
+          file_path = File.join(@config.openapi_root, url_path)
           dirname = File.dirname(file_path)
           FileUtils.mkdir_p dirname unless File.exist?(dirname)
 
@@ -100,10 +96,10 @@ module Rswag
       private
 
       def pretty_generate(doc)
-        if @config.swagger_format == :yaml
+        if @config.openapi_format == :yaml
           clean_doc = yaml_prepare(doc)
           YAML.dump(clean_doc)
-        else # config errors are thrown in 'def swagger_format', no throw needed here
+        else # config errors are thrown in 'def openapi_format', no throw needed here
           JSON.pretty_generate(doc)
         end
       end
@@ -170,7 +166,7 @@ module Rswag
       def upgrade_servers!(swagger_doc)
         return unless swagger_doc[:servers].nil? && swagger_doc.key?(:schemes)
 
-        ActiveSupport::Deprecation.warn('Rswag::Specs: WARNING: schemes, host, and basePath are replaced in OpenAPI3! Rename to array of servers[{url}] (in swagger_helper.rb)')
+        Rswag::Specs.deprecator.warn('Rswag::Specs: WARNING: schemes, host, and basePath are replaced in OpenAPI3! Rename to array of servers[{url}] (in swagger_helper.rb)')
 
         swagger_doc[:servers] = { urls: [] }
         swagger_doc[:schemes].each do |scheme|
@@ -190,14 +186,14 @@ module Rswag
         schemes.each do |name, v|
           next unless v.key?(:flow)
 
-          ActiveSupport::Deprecation.warn("Rswag::Specs: WARNING: securityDefinitions flow is replaced in OpenAPI3! Rename to components/securitySchemes/#{name}/flows[] (in swagger_helper.rb)")
+          Rswag::Specs.deprecator.warn("Rswag::Specs: WARNING: securityDefinitions flow is replaced in OpenAPI3! Rename to components/securitySchemes/#{name}/flows[] (in swagger_helper.rb)")
           flow = swagger_doc[:components][:securitySchemes][name].delete(:flow).to_s
           if flow == 'accessCode'
-            ActiveSupport::Deprecation.warn("Rswag::Specs: WARNING: securityDefinitions accessCode is replaced in OpenAPI3! Rename to clientCredentials (in swagger_helper.rb)")
+            Rswag::Specs.deprecator.warn("Rswag::Specs: WARNING: securityDefinitions accessCode is replaced in OpenAPI3! Rename to clientCredentials (in swagger_helper.rb)")
             flow = 'authorizationCode'
           end
           if flow == 'application'
-            ActiveSupport::Deprecation.warn("Rswag::Specs: WARNING: securityDefinitions application is replaced in OpenAPI3! Rename to authorizationCode (in swagger_helper.rb)")
+            Rswag::Specs.deprecator.warn("Rswag::Specs: WARNING: securityDefinitions application is replaced in OpenAPI3! Rename to authorizationCode (in swagger_helper.rb)")
             flow = 'clientCredentials'
           end
           flow_elements = swagger_doc[:components][:securitySchemes][name].except(:type).each_with_object({}) do |(k, _v), a|

data/lib/rswag/specs.rb

@@ -8,13 +8,22 @@ require 'rswag/specs/railtie' if defined?(Rails::Railtie)
 
 module Rswag
   module Specs
+    RENAMED_METHODS = {
+      swagger_root: :openapi_root,
+      swagger_docs: :openapi_specs,
+      swagger_dry_run: :rswag_dry_run,
+      swagger_format: :openapi_format,
+      swagger_strict_schema_validation: :openapi_strict_schema_validation
+    }.freeze
+    private_constant :RENAMED_METHODS
+
     # Extend RSpec with a swagger-based DSL
     ::RSpec.configure do |c|
-      c.add_setting :swagger_root
-      c.add_setting :swagger_docs
-      c.add_setting :swagger_dry_run
-      c.add_setting :swagger_format
-      c.add_setting :swagger_strict_schema_validation
+      c.add_setting :openapi_root
+      c.add_setting :openapi_specs
+      c.add_setting :rswag_dry_run
+      c.add_setting :openapi_format, default: :json
+      c.add_setting :openapi_strict_schema_validation
       c.extend ExampleGroupHelpers, type: :request
       c.include ExampleHelpers, type: :request
     end
@@ -23,8 +32,31 @@ module Rswag
       @config ||= Configuration.new(RSpec.configuration)
     end
 
+    def self.deprecator
+      @deprecator ||= ActiveSupport::Deprecation.new('3.0', 'rswag-specs')
+    end
+
     # Support Rails 3+ and RSpec 2+ (sigh!)
     RAILS_VERSION = Rails::VERSION::MAJOR
     RSPEC_VERSION = RSpec::Core::Version::STRING.split('.').first.to_i
+
+    RSpec::Core::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
+
+    Specs.deprecator.deprecate_methods(
+      RSpec::Core::Configuration,
+      RENAMED_METHODS.to_h { |old_name, new_name| ["#{old_name}=".to_sym, "#{new_name}=".to_sym] }
+    )
+
+    if RUBY_VERSION.start_with? '2.6'
+      Specs.deprecator.warn('Rswag::Specs: WARNING: Support for Ruby 2.6 will be dropped in v3.0')
+    end
+
+    Specs.deprecator.warn('Rswag::Specs: WARNING: Support for RSpec 2.X will be dropped in v3.0') if RSPEC_VERSION < 3
   end
 end

data/lib/tasks/rswag-specs_tasks.rake

@@ -18,10 +18,9 @@ namespace :rswag do
 
       t.rspec_opts = [additional_rspec_opts]
 
-      if Rswag::Specs::RSPEC_VERSION > 2 && Rswag::Specs.config.swagger_dry_run
+      if Rswag::Specs.config.rswag_dry_run
         t.rspec_opts += ['--format Rswag::Specs::SwaggerFormatter', '--dry-run', '--order defined']
       else
-        ActiveSupport::Deprecation.warn('Rswag::Specs: WARNING: Support for RSpec 2.X will be dropped in v3.0')
         t.rspec_opts += ['--format Rswag::Specs::SwaggerFormatter', '--order defined']
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rswag-specs
 version: !ruby/object:Gem::Version
-  version: 2.12.0
+  version: 2.13.0
 platform: ruby
 authors:
 - Richie Morris
@@ -10,7 +10,7 @@ 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