grape-swagger 2.1.0 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8fbf69e7e7bc7f3a836c574fe91df74abb10aab05c778cee716398d76afeace6
-  data.tar.gz: 5ab4bc60eafa3ad32959a040aed645943121912037a738278d88fb649390a0fa
+  metadata.gz: d07c4678df57d48124ef1afed6e8d60c0cedc0d5f1ea198b4c1ce2e6b3e30f2d
+  data.tar.gz: 35e02858f204c33f403a6b583c1c2ced2c3d66caaa94613d30de4c227ed96266
 SHA512:
-  metadata.gz: 8bcb10791418aa79af266d503f7fd5130157bb7971d7acb094964981d9ee8635fe6bcf72e212b81f22a25f2032a002fba99b97a7d078d8d35a908f0117fae379
-  data.tar.gz: d7843b9aaf70d83a9d0de3dc7f075b8f3df2e4cedda4a1c519cbc4109dc9da1cb1de82c9966fcf6a0083ebbe22a89c13654fbd9fe9e1156af4103e8bc70a344e
+  metadata.gz: 35c4824daa66db7842b786b580981a18223c1cb7c199a4a8dd754b2cc310fc876d8b7bb8dad659f5a92f554d4c8e306e960e739a9764b6a6c6c8bb004a87d37c
+  data.tar.gz: 2b4c8c3e19b0d9ee56a66655598b8293470f18a3815f0cc8c6e5bf003647f8ba46774017bcc5a5b2db7e947aafd75f90e15ad2ef46d6ec683bfc8d868a9205b9

data/CHANGELOG.md

@@ -1,13 +1,8 @@
-### next
-
-#### Features
-
-* Your contribution here.
+### 2.1.1 (Sep 21, 2024)
 
 #### Fixes
 
-* Your contribution here.
-
+* [#940](https://github.com/ruby-grape/grape-swagger/pull/940): Grape 2.2.0 compatibility - [@padde](https://github.com/padde)
 
 ### 2.1.0 (May 14, 2024)
 

data/grape-swagger.gemspec

@@ -15,8 +15,8 @@ Gem::Specification.new do |s|
   s.metadata['rubygems_mfa_required'] = 'true'
 
   s.required_ruby_version = '>= 3.0'
-  s.add_runtime_dependency 'grape', '>= 1.7', '< 3.0'
-  s.add_runtime_dependency 'rack-test', '~> 2'
+  s.add_dependency 'grape', '>= 1.7', '< 3.0'
+  s.add_dependency 'rack-test', '~> 2'
 
   s.files = Dir['lib/**/*', '*.md', 'LICENSE.txt', 'grape-swagger.gemspec']
   s.require_paths = ['lib']

data/lib/grape-swagger/doc_methods/parse_params.rb

@@ -25,6 +25,7 @@ module GrapeSwagger
           document_default_value(settings) unless value_type[:is_array]
           document_range_values(settings) unless value_type[:is_array]
           document_required(settings)
+          document_length_limits(value_type)
           document_additional_properties(definitions, settings) unless value_type[:is_array]
           document_add_extensions(settings)
           document_example(settings)
@@ -163,6 +164,16 @@ module GrapeSwagger
           end
         end
 
+        def document_length_limits(value_type)
+          if value_type[:is_array]
+            @parsed_param[:minItems] = value_type[:min_length] if value_type.key?(:min_length)
+            @parsed_param[:maxItems] = value_type[:max_length] if value_type.key?(:max_length)
+          else
+            @parsed_param[:minLength] = value_type[:min_length] if value_type.key?(:min_length)
+            @parsed_param[:maxLength] = value_type[:max_length] if value_type.key?(:max_length)
+          end
+        end
+
         def parse_enum_or_range_values(values)
           case values
           when Proc

data/lib/grape-swagger/doc_methods/produces_consumes.rb

@@ -7,7 +7,7 @@ module GrapeSwagger
         def call(*args)
           return ['application/json'] unless args.flatten.present?
 
-          args.flatten.map { |x| Grape::ContentTypes::CONTENT_TYPES[x] || x }.uniq
+          args.flatten.map { |x| GrapeSwagger::CONTENT_TYPE_DEFAULTS[x] || x }.uniq
         end
       end
     end

data/lib/grape-swagger/endpoint.rb

@@ -11,8 +11,8 @@ module Grape
 
       if content_types.empty?
         formats       = [target_class.format, target_class.default_format].compact.uniq
-        formats       = Grape::Formatter.formatters(**{}).keys if formats.empty?
-        content_types = Grape::ContentTypes::CONTENT_TYPES.select do |content_type, _mime_type|
+        formats       = GrapeSwagger::FORMATTER_DEFAULTS.keys if formats.empty?
+        content_types = GrapeSwagger::CONTENT_TYPE_DEFAULTS.select do |content_type, _mime_type|
           formats.include? content_type
         end.values
       end

data/lib/grape-swagger/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module GrapeSwagger
-  VERSION = '2.1.0'
+  VERSION = '2.1.1'
 end

data/lib/grape-swagger.rb

@@ -18,6 +18,24 @@ module GrapeSwagger
     end
   end
   autoload :Rake, 'grape-swagger/rake/oapi_tasks'
+
+  # Copied from https://github.com/ruby-grape/grape/blob/v2.2.0/lib/grape/formatter.rb
+  FORMATTER_DEFAULTS = {
+    json: Grape::Formatter::Json,
+    jsonapi: Grape::Formatter::Json,
+    serializable_hash: Grape::Formatter::SerializableHash,
+    txt: Grape::Formatter::Txt,
+    xml: Grape::Formatter::Xml
+  }.freeze
+
+  # Copied from https://github.com/ruby-grape/grape/blob/v2.2.0/lib/grape/content_types.rb
+  CONTENT_TYPE_DEFAULTS = {
+    xml: 'application/xml',
+    serializable_hash: 'application/json',
+    json: 'application/json',
+    binary: 'application/octet-stream',
+    txt: 'text/plain'
+  }.freeze
 end
 
 module SwaggerRouting
@@ -45,12 +63,10 @@ module SwaggerRouting
   end
 
   def determine_namespaced_routes(name, parent_route, routes)
-    if parent_route.nil?
-      routes.values.flatten
-    else
-      parent_route.reject do |route|
-        !route_path_start_with?(route, name) || !route_instance_variable_equals?(route, name)
-      end
+    return routes.values.flatten if parent_route.nil?
+
+    parent_route.select do |route|
+      route_path_start_with?(route, name) || route_namespace_equals?(route, name)
     end
   end
 
@@ -94,20 +110,27 @@ module SwaggerRouting
     matches.nil? ? route_name : matches[0].delete('/')
   end
 
-  def route_instance_variable(route)
-    route.instance_variable_get(:@options)[:namespace]
-  end
+  def route_namespace_equals?(route, name)
+    patterns = Enumerator.new do |yielder|
+      yielder << "/#{name}"
+      yielder << "/:version/#{name}"
+    end
 
-  def route_instance_variable_equals?(route, name)
-    route_instance_variable(route) == "/#{name}" ||
-      route_instance_variable(route) == "/:version/#{name}"
+    patterns.any? { |p| route.namespace == p }
   end
 
   def route_path_start_with?(route, name)
-    route_prefix = route.prefix ? "/#{route.prefix}/#{name}" : "/#{name}"
-    route_versioned_prefix = route.prefix ? "/#{route.prefix}/:version/#{name}" : "/:version/#{name}"
+    patterns = Enumerator.new do |yielder|
+      if route.prefix
+        yielder << "/#{route.prefix}/#{name}"
+        yielder << "/#{route.prefix}/:version/#{name}"
+      else
+        yielder << "/#{name}"
+        yielder << "/:version/#{name}"
+      end
+    end
 
-    route.path.start_with?(route_prefix, route_versioned_prefix)
+    patterns.any? { |p| route.path.start_with?(p) }
   end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: grape-swagger
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.1.1
 platform: ruby
 authors:
 - LeFnord
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-14 00:00:00.000000000 Z
+date: 2024-09-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grape
@@ -103,7 +103,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.9
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Add auto generated documentation to your Grape API that can be displayed