rswag-specs 2.16.0 → 3.0.0.pre

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: rswag-specs
 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
@@ -78,14 +78,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.14'
+        version: '3.12'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.14'
+        version: '3.12'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -100,9 +100,10 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 0.21.2
-description: 'Simplify API integration testing with a succinct rspec DSL and generate
-  OpenAPI specification files directly from your rspec tests. More about the OpenAPI
-  initiative here: http://spec.openapis.org/'
+description: |
+  Simplify API integration testing with a succinct rspec DSL and generate OpenAPI
+  specification files directly from your rspec tests. More about the OpenAPI initiative
+  here: http://spec.openapis.org/
 email:
 - domaindrivendev@gmail.com
 executables: []
@@ -113,27 +114,27 @@ files:
 - MIT-LICENSE
 - Rakefile
 - lib/generators/rspec/USAGE
-- lib/generators/rspec/swagger_generator.rb
+- lib/generators/rspec/openapi_generator.rb
 - lib/generators/rspec/templates/spec.rb
 - lib/generators/rswag/specs/install/USAGE
 - lib/generators/rswag/specs/install/install_generator.rb
-- lib/generators/rswag/specs/install/templates/swagger_helper.rb
+- lib/generators/rswag/specs/install/templates/openapi_helper.rb
 - lib/rswag/route_parser.rb
 - lib/rswag/specs.rb
 - lib/rswag/specs/configuration.rb
 - lib/rswag/specs/example_group_helpers.rb
 - lib/rswag/specs/example_helpers.rb
 - lib/rswag/specs/extended_schema.rb
+- lib/rswag/specs/openapi_formatter.rb
 - lib/rswag/specs/railtie.rb
 - lib/rswag/specs/request_factory.rb
 - lib/rswag/specs/response_validator.rb
-- lib/rswag/specs/swagger_formatter.rb
 - lib/tasks/rswag-specs_tasks.rake
 homepage: https://github.com/rswag/rswag
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -149,7 +150,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.5.11
-signing_key: 
+signing_key:
 specification_version: 4
 summary: An OpenAPI-based (formerly called Swagger) DSL for rspec-rails & accompanying
   rake task for generating OpenAPI specification files

data/lib/rswag/specs/swagger_formatter.rb

@@ -1,229 +0,0 @@
-# frozen_string_literal: true
-
-require 'active_support/core_ext/hash/deep_merge'
-require 'rspec/core/formatters/base_text_formatter'
-require 'swagger_helper'
-
-module Rswag
-  module Specs
-    class SwaggerFormatter < ::RSpec::Core::Formatters::BaseTextFormatter
-      if RSPEC_VERSION > 2
-        ::RSpec::Core::Formatters.register self, :example_group_finished, :stop
-      end
-
-      def initialize(output, config = Rswag::Specs.config)
-        super(output)
-        @config = config
-
-        @output.puts 'Generating Swagger docs ...'
-      end
-
-      def example_group_finished(notification)
-        metadata = if RSPEC_VERSION > 2
-          notification.group.metadata
-        else
-          notification.metadata
-        end
-
-        # !metadata[:document] won't work, since nil means we should generate
-        # docs.
-        return if metadata[:document] == false
-        return unless metadata.key?(:response)
-
-        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!
-          # metadata[:operation] is also re-used between examples within file
-          # therefore be careful NOT to modify its content here.
-          upgrade_request_type!(metadata)
-          upgrade_servers!(swagger_doc)
-          upgrade_oauth!(swagger_doc)
-          upgrade_response_produces!(swagger_doc, metadata)
-        end
-
-        swagger_doc.deep_merge!(metadata_to_swagger(metadata))
-      end
-
-      def stop(_notification = nil)
-        @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|
-                is_hash = value.is_a?(Hash)
-                if is_hash && value[:parameters]
-                  schema_param = value[:parameters]&.find { |p| (p[:in] == :body || p[:in] == :formData) && p[:schema] }
-                  mime_list = value[:consumes] || doc[:consumes]
-
-                  if value && schema_param && mime_list
-                    value[:requestBody] = { content: {} } unless value.dig(:requestBody, :content)
-                    value[:requestBody][:required] = true if schema_param[:required]
-                    value[:requestBody][:description] = schema_param[:description] if schema_param[:description]
-                    examples = value.dig(:request_examples)
-                    mime_list.each do |mime|
-                      value[:requestBody][:content][mime] = { schema: schema_param[:schema] }
-                      if examples
-                        value[:requestBody][:content][mime][:examples] ||= {}
-                        examples.map do |example|
-                          value[:requestBody][:content][mime][:examples][example[:name]] = {
-                            summary: example[:summary] || value[:summary],
-                            value: example[:value]
-                          }
-                        end
-                      end
-                    end
-                  end
-
-                  enum_param = value.dig(:parameters).find{|p| p[:enum]}
-                  if enum_param && enum_param.is_a?(Hash)
-                    enum_param[:description] = generate_enum_description(enum_param)
-                  end
-
-                  value[:parameters].reject! { |p| p[:in] == :body || p[:in] == :formData }
-                end
-                remove_invalid_operation_keys!(value)
-              end
-            end
-          end
-
-          file_path = File.join(@config.openapi_root, url_path)
-          dirname = File.dirname(file_path)
-          FileUtils.mkdir_p dirname unless File.exist?(dirname)
-
-          File.open(file_path, 'w') do |file|
-            file.write(pretty_generate(doc))
-          end
-
-          @output.puts "Swagger doc generated at #{file_path}"
-        end
-      end
-
-      private
-
-      def pretty_generate(doc)
-        if @config.openapi_format == :yaml
-          clean_doc = yaml_prepare(doc)
-          YAML.dump(clean_doc)
-        else # config errors are thrown in 'def openapi_format', no throw needed here
-          JSON.pretty_generate(doc)
-        end
-      end
-
-      def yaml_prepare(doc)
-        json_doc = JSON.pretty_generate(doc)
-        JSON.parse(json_doc)
-      end
-
-      def metadata_to_swagger(metadata)
-        response_code = metadata[:response][:code]
-        response = metadata[:response].reject { |k, _v| k == :code }
-
-        verb = metadata[:operation][:verb]
-        operation = metadata[:operation]
-          .reject { |k, _v| k == :verb }
-          .merge(responses: { response_code => response })
-
-        path_template = metadata[:path_item][:template]
-        path_item = metadata[:path_item]
-          .reject { |k, _v| k == :template }
-          .merge(verb => operation)
-
-        { paths: { path_template => path_item } }
-      end
-
-      def doc_version(doc)
-        doc[:openapi] || doc[:swagger] || '3'
-      end
-
-      def upgrade_response_produces!(swagger_doc, metadata)
-        # Accept header
-        mime_list = Array(metadata[:operation][:produces] || swagger_doc[:produces])
-        target_node = metadata[:response]
-        upgrade_content!(mime_list, target_node)
-        metadata[:response].delete(:schema)
-      end
-
-      def upgrade_content!(mime_list, target_node)
-        schema = target_node[:schema]
-        return if mime_list.empty? || schema.nil?
-
-        target_node[:content] ||= {}
-        mime_list.each do |mime_type|
-          # TODO: upgrade to have content-type specific schema
-          (target_node[:content][mime_type] ||= {}).merge!(schema: schema)
-        end
-      end
-
-      def upgrade_request_type!(metadata)
-        # No deprecation here as it seems valid to allow type as a shorthand
-        operation_nodes = metadata[:operation][:parameters] || []
-        path_nodes = metadata[:path_item][:parameters] || []
-        header_node = metadata[:response][:headers] || {}
-
-        (operation_nodes + path_nodes + [header_node]).each do |node|
-          if node && node[:type] && node[:schema].nil?
-            node[:schema] = { type: node[:type] }
-            node.delete(:type)
-          end
-        end
-      end
-
-      def upgrade_servers!(swagger_doc)
-        return unless swagger_doc[:servers].nil? && swagger_doc.key?(:schemes)
-
-        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|
-          swagger_doc[:servers][:urls] << scheme + '://' + swagger_doc[:host] + swagger_doc[:basePath]
-        end
-
-        swagger_doc.delete(:schemes)
-        swagger_doc.delete(:host)
-        swagger_doc.delete(:basePath)
-      end
-
-      def upgrade_oauth!(swagger_doc)
-        # find flow in securitySchemes (securityDefinitions will have been re-written)
-        schemes = swagger_doc.dig(:components, :securitySchemes)
-        return unless schemes&.any? { |_k, v| v.key?(:flow) }
-
-        schemes.each do |name, v|
-          next unless v.key?(:flow)
-
-          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'
-            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'
-            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|
-            a[k] = swagger_doc[:components][:securitySchemes][name].delete(k)
-          end
-          swagger_doc[:components][:securitySchemes][name].merge!(flows: { flow => flow_elements })
-        end
-      end
-
-      def remove_invalid_operation_keys!(value)
-        return unless value.is_a?(Hash)
-
-        value.delete(:consumes) if value[:consumes]
-        value.delete(:produces) if value[:produces]
-        value.delete(:request_examples) if value[:request_examples]
-        value[:parameters].each { |p| p.delete(:getter) } if value[:parameters]
-      end
-
-      def generate_enum_description(param)
-        enum_description = "#{param[:description]}:\n "
-        param[:enum].each do |k,v|
-          enum_description += "* `#{k}` #{v}\n "
-        end
-        enum_description
-      end
-    end
-  end
-end