swagalicious 1.1.2 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4ca52a8e05e2526715dbe6aa1adb367871fa7a4223fd8fe0ee3149f9fe359320
-  data.tar.gz: 3d3c99f74587e2597f0903a2bfc871e3ed7b15509de9a3a80bc90b0184eae5d9
+  metadata.gz: db96b90cafb99e7b2a59562be7588b11c0901522b796eee416820c26649125b0
+  data.tar.gz: d79fe5dbfab29895efc34f3efd216100e6da011679221bf7cd31790e2f9a08e2
 SHA512:
-  metadata.gz: 345fc5a8d989328ce28f076e08ed5f3a4f62e0bfb6e28a3e1553af30332dd5d5ca5b55d36192d0709a6177b91917b71e82420902cc4887c2b623bdc0a7d093e3
-  data.tar.gz: 05f683d0306a80565d593e4bc86eb1079977677a991150ccfddfc99484f414f4c5b64d602794e637e6a68999102e89d20299f9a2db9ee1873d9506c924e54e4e
+  metadata.gz: 75c6e5395e8fdb026a6e6067bac80b04b904851f9fd5635c7a9137326ab0354ea0117ae0c28bdb0e5cc52b23773bf4264f82d9dc3f132cce11997784c4cb14b2
+  data.tar.gz: e9dbd71dd735faa4779bb95f8862e841d698966307c7dbfc04156bd38c6857bfc94fae355d01452cfdad096ee913e18f45b670406c0fc4bfe150920e1dc09209

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    swagalicious (1.1.1)
+    swagalicious (2.0.0)
       faraday (~> 2.0)
       faraday-rack
       json-schema
@@ -13,100 +13,123 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.1.6)
+    activesupport (7.1.3.4)
+      base64
+      bigdecimal
       concurrent-ruby (~> 1.0, >= 1.0.2)
+      connection_pool (>= 2.2.5)
+      drb
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
+      mutex_m
       tzinfo (~> 2.0)
-      zeitwerk (~> 2.3)
-    addressable (2.8.5)
+    addressable (2.8.6)
       public_suffix (>= 2.0.2, < 6.0)
     ast (2.4.2)
+    base64 (0.2.0)
+    bigdecimal (3.1.8)
     byebug (11.1.3)
     coderay (1.1.3)
-    concurrent-ruby (1.1.10)
-    diff-lcs (1.5.0)
-    factory_bot (6.1.0)
+    concurrent-ruby (1.3.3)
+    connection_pool (2.4.1)
+    diff-lcs (1.5.1)
+    drb (2.2.1)
+    factory_bot (6.4.6)
       activesupport (>= 5.0.0)
-    faraday (2.7.10)
-      faraday-net_http (>= 2.0, < 3.1)
-      ruby2_keywords (>= 0.0.4)
-    faraday-net_http (3.0.2)
+    faraday (2.9.1)
+      faraday-net_http (>= 2.0, < 3.2)
+    faraday-net_http (3.1.0)
+      net-http
     faraday-rack (2.0.0)
       faraday (~> 2.0)
-    i18n (1.10.0)
+    i18n (1.14.5)
       concurrent-ruby (~> 1.0)
-    json (2.6.3)
-    json-schema (4.0.0)
+    json (2.7.2)
+    json-schema (4.3.0)
       addressable (>= 2.8)
-    method_source (1.0.0)
-    minitest (5.16.1)
-    oj (3.16.0)
-    ox (2.14.17)
-    parallel (1.22.1)
-    parser (3.2.1.0)
+    language_server-protocol (3.17.0.3)
+    method_source (1.1.0)
+    minitest (5.23.1)
+    mutex_m (0.2.0)
+    net-http (0.4.1)
+      uri
+    oj (3.16.4)
+      bigdecimal (>= 3.0)
+    ox (2.14.18)
+    parallel (1.25.1)
+    parser (3.3.3.0)
       ast (~> 2.4.1)
-    pry (0.13.1)
+      racc
+    pry (0.14.2)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    pry-byebug (3.9.0)
+    pry-byebug (3.10.1)
       byebug (~> 11.0)
-      pry (~> 0.13.0)
-    public_suffix (5.0.3)
-    rack (3.0.8)
+      pry (>= 0.13, < 0.15)
+    public_suffix (5.1.1)
+    racc (1.8.0)
+    rack (3.1.3)
     rack-test (2.1.0)
       rack (>= 1.3)
     rainbow (3.1.1)
     rake (12.3.3)
-    regexp_parser (2.7.0)
-    rexml (3.2.5)
-    rspec (3.11.0)
-      rspec-core (~> 3.11.0)
-      rspec-expectations (~> 3.11.0)
-      rspec-mocks (~> 3.11.0)
-    rspec-core (3.11.0)
-      rspec-support (~> 3.11.0)
-    rspec-expectations (3.11.0)
+    regexp_parser (2.9.2)
+    rexml (3.3.0)
+      strscan
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.0)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-mocks (3.11.1)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-support (3.11.0)
-    rubocop (1.48.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.1)
+    rubocop (1.64.1)
       json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
-      parser (>= 3.2.0.0)
+      parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.26.0, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.27.0)
-      parser (>= 3.2.1.0)
-    rubocop-capybara (2.17.1)
+    rubocop-ast (1.31.3)
+      parser (>= 3.3.1.0)
+    rubocop-capybara (2.21.0)
       rubocop (~> 1.41)
-    rubocop-rspec (2.19.0)
-      rubocop (~> 1.33)
+    rubocop-factory_bot (2.26.1)
+      rubocop (~> 1.61)
+    rubocop-rspec (2.31.0)
+      rubocop (~> 1.40)
       rubocop-capybara (~> 2.17)
+      rubocop-factory_bot (~> 2.22)
+      rubocop-rspec_rails (~> 2.28)
+    rubocop-rspec_rails (2.29.1)
+      rubocop (~> 1.61)
     ruby-progressbar (1.13.0)
-    ruby2_keywords (0.0.5)
-    tzinfo (2.0.4)
+    strscan (3.1.0)
+    tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (2.4.2)
-    zeitwerk (2.6.0)
+    unicode-display_width (2.5.0)
+    uri (0.13.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  factory_bot (~> 6.1.0)
-  pry-byebug (~> 3.9.0)
+  factory_bot (~> 6.1)
+  pry-byebug
   rake (~> 12.0)
   rspec (~> 3.0)
-  rubocop (~> 1.48.0)
-  rubocop-rspec (~> 2.19.0)
+  rubocop (~> 1.48)
+  rubocop-rspec (~> 2.19)
   swagalicious!
 
 BUNDLED WITH

data/lib/swagalicious/configuration.rb

@@ -38,6 +38,13 @@ class Swagalicious
                           end
     end
 
+    def logger
+      @swagger_format ||= begin
+                            @rspec_config.swagalicious_logger = ::Logger.new($stdout) if @rspec_config.swagalicious_logger.nil?
+                            @rspec_config.swagalicious_logger
+                          end
+    end
+
     def get_swagger_doc(name)
       return swagger_docs.values.first if name.nil?
       raise ConfigurationError, "Unknown swagger_doc '#{name}'" unless swagger_docs[name]

data/lib/swagalicious/request_factory.rb

@@ -47,7 +47,7 @@ class Swagalicious
 
     def security_version(scheme_names, swagger_doc)
       if swagger_doc.key?(:securityDefinitions)
-        puts "Swagalicious: WARNING: securityDefinitions is replaced in OpenAPI3! Rename to components/securitySchemes (in swagger_helper.rb)"
+        @config.logger.warn "Swagalicious: 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
@@ -65,7 +65,7 @@ class Swagalicious
 
     def key_version(ref, swagger_doc)
       if ref.start_with?("#/parameters/")
-        puts "Swagalicious: WARNING: #/parameters/ refs are replaced in OpenAPI3! Rename to #/components/parameters/"
+        @config.logger.warn "Swagalicious: WARNING: #/parameters/ refs are replaced in OpenAPI3! Rename to #/components/parameters/"
         ref.sub("#/parameters/", "").to_sym
       else
         ref.sub("#/components/parameters/", "").to_sym
@@ -74,7 +74,7 @@ class Swagalicious
 
     def definition_version(swagger_doc)
       if swagger_doc.key?(:parameters)
-        puts "Swagalicious: WARNING: parameters is replaced in OpenAPI3! Rename to components/parameters (in swagger_helper.rb)"
+        @config.logger.warn "Swagalicious: WARNING: parameters is replaced in OpenAPI3! Rename to components/parameters (in swagger_helper.rb)"
         swagger_doc[:parameters]
       else
         components = swagger_doc[:components] || {}
@@ -105,19 +105,48 @@ class Swagalicious
 
     def build_query_string_part(param, value)
       name = param[:name]
-      return "#{name}=#{value}" unless param[:type].to_sym == :array
-
-      case param[:collectionFormat]
-      when :ssv
-        "#{name}=#{value.join(" ")}"
-      when :tsv
-        "#{name}=#{value.join("\t")}"
-      when :pipes
-        "#{name}=#{value.join("|")}"
-      when :multi
-        value.map { |v| "#{name}=#{v}" }.join("&")
+      if param[:type]
+        @config.logger.warn "Swagalicious: WARNING: type is replaced in OpenAPI3! Rename to schema[type] in query param definition for #{name}"
+        param[:schema]      ||= {}
+        param[:schema][:type] = param.delete(:type)
+      end
+      return "#{name}=#{value}" unless (param.dig(:schema, :type) || "").to_sym == :array
+
+      unless param[:schema]
+        @config.logger.warn "Schema was not specified for #{name}"
+      end
+
+      if param[:collection_format] || param[:collectionFormat]
+        @config.logger.warn "Swagalicious: WARNING: collection_format is replaced in OpenAPI3! Rename to style/explode in query param definition for #{name}"
+        format = params[:collection_format] || param[:collectionFormat]
+        case format
+        when :multi
+          param[:style]   = :form
+          param[:explode] = true
+        when :ssv
+          param[:style]   = :spaceDelimited
+          param[:explode] = false
+        when :pipes
+          param[:style]   = :pipeDelimited
+          param[:explode] = false
+        else
+          param[:style]   = :form
+          param[:explode] = false
+        end
+      end
+
+      style   = param[:style] || :form
+      explode = param[:explode] || false
+
+      case style
+      when :spaceDelimited
+        explode ? value.map { |v| "#{name}=#{v}" }.join("&") : "#{name}=#{value.join(" ")}"
+      when :pipeDelimited
+        explode ? value.map { |v| "#{name}=#{v}" }.join("&") : "#{name}=#{value.join("|")}"
+      when :form
+        explode ? value.map { |v| "#{name}=#{v}" }.join("&") : "#{name}=#{value.join(",")}"
       else
-        "#{name}=#{value.join(",")}" # csv is default
+        raise "Invalid combination"
       end
     end
 

data/lib/swagalicious/response_validator.rb

@@ -52,7 +52,7 @@ class Swagalicious
         swagger_doc.slice(:definitions)
       else # Openapi3
         if swagger_doc.key?(:definitions)
-          puts "Swagger::Specs: WARNING: definitions is replaced in OpenAPI3! Rename to components/schemas (in swagger_helper.rb)"
+          @config.logger.warn "Swagger::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/swagalicious/swagger_formatter.rb

@@ -45,7 +45,7 @@ class Swagalicious
         FileUtils.mkdir_p dirname unless File.exist?(dirname)
 
         File.open(file_path, "w") do |file|
-          file.write(pretty_generate(merged_doc))
+          file.write(pretty_generate(merged_doc.except(:metadata)))
         end
 
         @output.puts "Swagger doc generated at #{file_path}"
@@ -104,6 +104,7 @@ class Swagalicious
 
         operation[:parameters].reject! { |p| p[:in] == :body || p[:in] == :formData }
       end
+      remove_invalid_operation_keys!(operation)
 
       path_template = metadata[:path_item][:template]
       path_item     = metadata[:path_item]
@@ -119,7 +120,7 @@ class Swagalicious
 
     def upgrade_response_produces!(swagger_doc, metadata)
       # Accept header
-      mime_list   = Array(metadata[:operation].delete(:produces) || swagger_doc[:produces])
+      mime_list   = Array(metadata[:operation].delete(:produces) || swagger_doc.dig(:metadata, :produces))
       target_node = metadata[:response]
       upgrade_content!(mime_list, target_node)
       metadata[:response].delete(:schema)
@@ -157,7 +158,7 @@ class Swagalicious
     def upgrade_servers!(swagger_doc)
       return unless swagger_doc[:servers].nil? && swagger_doc.key?(:schemes)
 
-      puts "Swagalicious: WARNING: schemes, host, and basePath are replaced in OpenAPI3! Rename to array of servers[{url}] (in swagger_helper.rb)"
+      @config.logger.warn "Swagalicious: 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|
@@ -177,17 +178,17 @@ class Swagalicious
       schemes.each do |name, v|
         next unless v.key?(:flow)
 
-        puts "Swagalicious: WARNING: securityDefinitions flow is replaced in OpenAPI3! Rename to components/securitySchemes/#{name}/flows[] (in swagger_helper.rb)"
+        @config.logger.warn "Swagalicious: 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"
-          puts "Swagalicious: WARNING: securityDefinitions accessCode is replaced in OpenAPI3! Rename to clientCredentials (in swagger_helper.rb)"
+          @config.logger.warn "Swagalicious: WARNING: securityDefinitions accessCode is replaced in OpenAPI3! Rename to clientCredentials (in swagger_helper.rb)"
           flow = "authorizationCode"
         end
 
         if flow == "application"
-          puts "Swagalicious: WARNING: securityDefinitions application is replaced in OpenAPI3! Rename to authorizationCode (in swagger_helper.rb)"
+          @config.logger.warn "Swagalicious: WARNING: securityDefinitions application is replaced in OpenAPI3! Rename to authorizationCode (in swagger_helper.rb)"
           flow = "clientCredentials"
         end
 

data/lib/swagalicious/version.rb

@@ -1,3 +1,3 @@
 class Swagalicious
-  VERSION = "1.1.2"
+  VERSION = "2.0.0"
 end

data/lib/swagalicious.rb

@@ -30,6 +30,7 @@ class Swagalicious
     c.add_setting :swagger_root
     c.add_setting :swagger_docs
     c.add_setting :swagger_dry_run
+    c.add_setting :swagalicious_logger
 
     if defined?(Rails) && defined?(RSpec::Rails)
       c.include RSpec::Rails::RequestExampleGroup, type: :doc

data/swagalicious.gemspec

@@ -32,8 +32,8 @@ Gem::Specification.new do |spec|
   spec.add_dependency "rack-test"
   spec.add_dependency "rspec", "~> 3"
 
-  spec.add_development_dependency "rubocop", "~> 1.48.0"
-  spec.add_development_dependency "rubocop-rspec", "~> 2.19.0"
-  spec.add_development_dependency "factory_bot", "~> 6.1.0"
-  spec.add_development_dependency "pry-byebug",  "~> 3.9.0"
+  spec.add_development_dependency "rubocop", "~> 1.48"
+  spec.add_development_dependency "rubocop-rspec", "~> 2.19"
+  spec.add_development_dependency "factory_bot", "~> 6.1"
+  spec.add_development_dependency "pry-byebug"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: swagalicious
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 2.0.0
 platform: ruby
 authors:
 - Eugene Howe
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-08-18 00:00:00.000000000 Z
+date: 2024-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -114,56 +114,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.48.0
+        version: '1.48'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.48.0
+        version: '1.48'
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.19.0
+        version: '2.19'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.19.0
+        version: '2.19'
 - !ruby/object:Gem::Dependency
   name: factory_bot
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 6.1.0
+        version: '6.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 6.1.0
+        version: '6.1'
 - !ruby/object:Gem::Dependency
   name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.9.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.9.0
+        version: '0'
 description: This gem is almost a straight copy and paste of https://github.com/rswag/rswag/tree/master/rswag-specs
   with the Rails specific code stripped out so it can be used in Rack applications
   that don't use Rails.
@@ -217,7 +217,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.33
+rubygems_version: 3.5.9
 signing_key:
 specification_version: 4
 summary: RSwag without Rails