grape-swagger 1.6.0 → 1.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9cff361f819d42d8c3f847c605a31190f82764da573728d043debfe312d30069
-  data.tar.gz: faada4385a0db1fec73606585085deec766991007a9f050df1f2c0bbd9e9e018
+  metadata.gz: 994c2be4c9a0a44106876c31785adc73458d67c669ac80db7352e831511b8b2d
+  data.tar.gz: ae834e4ab3533e107eec6f74763a3679da626fd1fffe0334fe9546b54b6f12e5
 SHA512:
-  metadata.gz: 7a86553f29d5b5a338a0ac21d049845ab609ee4adc2864940813f61384a8bcc19c8b0a644bb484f2b79533a111ab16a51c192236b23f540ed672e5e7a161fb23
-  data.tar.gz: 9b5bc29e3ead5f683781cbc0418e3d18f4b056368885e470224bb57ebe03f4232725a971e8589e109240c949aad565e80d5b4ecd31e31f6e5721f0c86c8aaf2f
+  metadata.gz: a8a3cafba1066fef61afcc744f9fc39f7aa607765a772cc071e4ac6d931c61a7810b6876bf2c35ba1722ce20b939e19a512983f4e185bae473c09486b06d4c8a
+  data.tar.gz: cc5f17f8c99c2abccc49bf1da169134dcfdbf249d5f039c10eb00ab8d373cd03a29afc1c46534a296d8b4fc4d2b82eae969561bf64ca47abd7405e67c26ee6fa

data/.github/workflows/ci.yml

@@ -1,4 +1,4 @@
-name: Ruby
+name: RSpec
 
 on:
   push:
@@ -23,14 +23,14 @@ jobs:
       - name: Run rubocop
         run: bundle exec rubocop --parallel --format progress
 
-  rspec:
+  grape-16:
     runs-on: ubuntu-latest
     needs: ['rubocop']
+    env:
+      GRAPE_VERSION: '1.6.2'
     strategy:
       matrix:
         ruby-version: ['3.0', '3.1', '3.2', 'head']
-        grape-version: [1.6.2, 1.7.0]
-        model-parser: [grape-swagger-entity, grape-swagger-representable, '']
     steps:
     - name: Check out branch
       uses: actions/checkout@v3
@@ -38,8 +38,83 @@ jobs:
       uses: ruby/setup-ruby@v1
       with:
         ruby-version: ${{ matrix.ruby-version }}
-        GRAPE_VERSION: ${{ matrix.grape-version }}
-        MODEL_PARSER: ${{ matrix.model-parser }}
-        bundler-cache: true
-    - name: Run rspec rest of the suite
-      run: bundle exec rspec
+    - name: Run rspec wo model parser
+      run: |
+        bundle update
+        bundle exec rspec
+    - name: Run rspec w entity parser
+      env:
+        MODEL_PARSER: grape-swagger-entity
+      run: |
+        bundle update
+        bundle exec rspec
+    - name: Run rspec w representable parser
+      env:
+        MODEL_PARSER: grape-swagger-representable
+      run: |
+        bundle update
+        bundle exec rspec
+
+  grape-17:
+    runs-on: ubuntu-latest
+    needs: ['rubocop']
+    env:
+      GRAPE_VERSION: '1.7.1'
+    strategy:
+      matrix:
+        ruby-version: ['3.0', '3.1', '3.2', 'head']
+    steps:
+    - name: Check out branch
+      uses: actions/checkout@v3
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+    - name: Run rspec wo model parser
+      run: |
+        bundle update
+        bundle exec rspec
+    - name: Run rspec w entity parser
+      env:
+        MODEL_PARSER: grape-swagger-entity
+      run: |
+        bundle update
+        bundle exec rspec
+    - name: Run rspec w representable parser
+      env:
+        MODEL_PARSER: grape-swagger-representable
+      run: |
+        bundle update
+        bundle exec rspec
+
+  grape-HEAD:
+    runs-on: ubuntu-latest
+    needs: ['rubocop']
+    env:
+      GRAPE_VERSION: 'HEAD'
+    strategy:
+      matrix:
+        ruby-version: ['3.0', '3.1', '3.2', 'head']
+    steps:
+    - name: Check out branch
+      uses: actions/checkout@v3
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+    - name: Run rspec wo model parser
+      run: |
+        bundle update
+        bundle exec rspec
+    - name: Run rspec w entity parser
+      env:
+        MODEL_PARSER: grape-swagger-entity
+      run: |
+        bundle update
+        bundle exec rspec
+    - name: Run rspec w representable parser
+      env:
+        MODEL_PARSER: grape-swagger-representable
+      run: |
+        bundle update
+        bundle exec rspec

data/.rubocop_todo.yml

@@ -1,38 +1,30 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2022-01-14 10:22:29 UTC using RuboCop version 1.24.1.
+# on 2023-05-20 18:23:47 UTC using RuboCop version 1.51.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
 # Offense count: 1
-# Cop supports --auto-correct.
-# Configuration parameters: Include.
-# Include: **/*.gemspec
-Gemspec/RequireMFA:
-  Exclude:
-    - 'grape-swagger.gemspec'
-
-# Offense count: 1
-# Configuration parameters: Include.
+# Configuration parameters: Severity, Include.
 # Include: **/*.gemspec
 Gemspec/RequiredRubyVersion:
   Exclude:
     - 'grape-swagger.gemspec'
 
-# Offense count: 31
-# Configuration parameters: IgnoredMethods, CountRepeatedAttributes.
+# Offense count: 32
+# Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes.
 Metrics/AbcSize:
   Max: 56
 
 # Offense count: 30
-# Configuration parameters: CountComments, CountAsOne, ExcludedMethods, IgnoredMethods.
+# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
 Metrics/MethodLength:
   Max: 28
 
-# Offense count: 7
-# Configuration parameters: IgnoredMethods.
+# Offense count: 8
+# Configuration parameters: AllowedMethods, AllowedPatterns.
 Metrics/PerceivedComplexity:
   Max: 16
 
@@ -41,20 +33,13 @@ Style/ClassVars:
   Exclude:
     - 'lib/grape-swagger/doc_methods.rb'
 
+# Offense count: 1
+# This cop supports unsafe autocorrection (--autocorrect-all).
+Style/CollectionCompact:
+  Exclude:
+    - 'lib/grape-swagger/endpoint.rb'
+
 # Offense count: 23
 # Configuration parameters: AllowedConstants.
 Style/Documentation:
   Enabled: false
-
-# Offense count: 43
-Style/OpenStructUse:
-  Exclude:
-    - 'spec/lib/endpoint_spec.rb'
-    - 'spec/lib/version_spec.rb'
-    - 'spec/support/mock_parser.rb'
-    - 'spec/support/model_parsers/mock_parser.rb'
-    - 'spec/swagger_v2/api_swagger_v2_hide_documentation_path_spec.rb'
-    - 'spec/swagger_v2/api_swagger_v2_mounted_spec.rb'
-    - 'spec/swagger_v2/api_swagger_v2_spec.rb'
-    - 'spec/swagger_v2/errors_spec.rb'
-    - 'spec/swagger_v2/reference_entity_spec.rb'

data/CHANGELOG.md

@@ -9,6 +9,13 @@
 * Your contribution here.
 
 
+### 1.6.1 (May 21, 2023)
+
+#### Fixes
+
+* [#868](https://github.com/ruby-grape/grape-swagger/pull/896): Fix parsing endless range values - [@dhruvCW](https://github.com/dhruvCW)
+
+
 ### 1.6.0 (March 19, 2023)
 
 #### Features

data/Gemfile

@@ -19,13 +19,13 @@ group :development, :test do
   gem 'pry', platforms: [:mri]
   gem 'pry-byebug', platforms: [:mri]
 
-  gem 'rack', '~> 3.0'
+  gem 'rack'
   gem 'rack-cors'
   gem 'rack-test'
   gem 'rake'
   gem 'rdoc'
   gem 'rspec', '~> 3.9'
-  gem 'rubocop', '~> 1.0', require: false
+  gem 'rubocop', '~> 1.50', require: false
   gem 'webrick'
 end
 

data/README.md

@@ -22,7 +22,7 @@
 
 ## What is grape-swagger? <a name="what"></a>
 
-The grape-swagger gem provides an autogenerated documentation for your [Grape](https://github.com/ruby-grape/grape) API. The generated documentation is Swagger-compliant, meaning it can easily be discovered in [Swagger UI](https://github.com/wordnik/swagger-ui). You should be able to point [the petstore demo](http://petstore.swagger.io/) to your API.
+The grape-swagger gem provides an autogenerated documentation for your [Grape](https://github.com/ruby-grape/grape) API. The generated documentation is Swagger-compliant, meaning it can easily be discovered in [Swagger UI](https://github.com/swagger-api/swagger-ui). You should be able to point [the petstore demo](http://petstore.swagger.io/) to your API.
 
 ![Demo Screenshot](example/swagger-example.png)
 
@@ -35,7 +35,7 @@ This screenshot is based on the [Hussars](https://github.com/LeFnord/hussars) sa
 * [Grape Swagger Entity](https://github.com/ruby-grape/grape-swagger-entity)
   * [Grape Entity](https://github.com/ruby-grape/grape-entity)
 * [Grape Swagger Representable](https://github.com/ruby-grape/grape-swagger-representable)
-* [Swagger UI](https://github.com/wordnik/swagger-ui)
+* [Swagger UI](https://github.com/swagger-api/swagger-ui)
 
 
 
@@ -95,14 +95,14 @@ module API
 end
 ```
 
-To explore your API, either download [Swagger UI](https://github.com/wordnik/swagger-ui) and set it up yourself or go to the [online swagger demo](http://petstore.swagger.wordnik.com/) and enter your localhost url documentation root in the url field (probably something in the line of http://localhost:3000/swagger_doc).
+To explore your API, either download [Swagger UI](https://github.com/swagger-api/swagger-ui) and set it up yourself or go to the [online swagger demo](http://petstore.swagger.io/) and enter your localhost url documentation root in the url field (probably something in the line of http://localhost:3000/swagger_doc).
 
 
 
 ## Model Parsers <a name="model_parsers"></a>
 
 Since 0.21.0, `Grape::Entity` is not a part of grape-swagger, you need to add `grape-swagger-entity` manually to your Gemfile.
-Also added support for [representable](https://github.com/apotonick/representable) via `grape-swagger-representable`.
+Also added support for [representable](https://github.com/trailblazer/representable) via `grape-swagger-representable`.
 
 ```ruby
 # For Grape::Entity ( https://github.com/ruby-grape/grape-entity )
@@ -115,7 +115,7 @@ If you are not using Rails, make sure to load the parser inside your application
 
 ### Custom Model Parsers
 
-You can create your own model parser, for example for [roar](https://github.com/apotonick/roar).
+You can create your own model parser, for example for [roar](https://github.com/trailblazer/roar).
 
 ```ruby
 module GrapeSwagger

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

@@ -39,12 +39,12 @@ module GrapeSwagger
 
             p_type = p[:type] == 'array' ? 'string' : p[:type]
             p[:items] = { type: p_type, format: p[:format], enum: p[:enum], is_array: p[:is_array] }
-            p[:items].delete_if { |_k, v| v.nil? }
+            p[:items].compact!
             p[:type] = 'array'
             p[:is_array] = parameter[:is_array]
             p.delete(:format)
             p.delete(:enum)
-            p.delete_if { |_k, v| v.nil? }
+            p.compact!
           end
         end
       end

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

@@ -171,7 +171,7 @@ module GrapeSwagger
         end
 
         def parse_range_values(values)
-          { minimum: values.first, maximum: values.last }
+          { minimum: values.begin, maximum: values.end }.compact
         end
       end
     end

data/lib/grape-swagger/version.rb

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

data/spec/lib/parse_params_spec.rb

@@ -12,6 +12,20 @@ describe GrapeSwagger::DocMethods::ParseParams do
       parsed_range = subject.send(:parse_range_values, start_value..end_value)
       expect(parsed_range).to eql(minimum: start_value, maximum: end_value)
     end
+
+    describe 'endless range' do
+      specify do
+        parsed_range = subject.send(:parse_range_values, start_value..)
+        expect(parsed_range).to eql(minimum: start_value)
+      end
+    end
+
+    describe 'beginless range' do
+      specify do
+        parsed_range = subject.send(:parse_range_values, ..end_value)
+        expect(parsed_range).to eql(maximum: end_value)
+      end
+    end
   end
 
   describe '#parse_enum_or_range_values' do

data/spec/swagger_v2/api_documentation_spec.rb

@@ -18,11 +18,9 @@ describe 'API with additional options' do
   end
 
   it 'documents api' do
-    expect(subject).to eq(
-      [
-        { description: 'Swagger compatible API description' },
-        { description: 'Swagger compatible API description for specific API', params: {} }
-      ]
-    )
+    expect(subject.pluck(:description)).to match_array [
+      'Swagger compatible API description',
+      'Swagger compatible API description for specific API'
+    ]
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: grape-swagger
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.6.1
 platform: ruby
 authors:
 - LeFnord
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-19 00:00:00.000000000 Z
+date: 2023-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grape
@@ -206,7 +206,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.7
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: Add auto generated documentation to your Grape API that can be displayed