grape-swagger-rails 0.5.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d4c9588b4ccf8e66253f11a742506fc512c9a70d4d0f32c8ec72db06bdc47af5
-  data.tar.gz: 3148cee4aad16dced2e22f6f8639e6daa1c3190fcb46c9bc1627cdc385861d9c
+  metadata.gz: 6acf0c3a11fe817b12f2b4c4469f1fc3a6efce7517731b3afd217474a95840a0
+  data.tar.gz: c4ab9b45226c2946ee4d20ff9c34e0cd3decfa83754c4119412587d383a4d12b
 SHA512:
-  metadata.gz: 91b7f33ff1190d15f16937087ca698a94e2daf43aed206b80821bbc879d1cdeac98e7fe151d1a5414fa50ae649adaa293d87ac0fd06135540903159ff8ed0e98
-  data.tar.gz: 69968abc92dc53117812b3901cb98baa72036496005fc5ba65fc7b759eb9a0e40536af7bbcd0f4cced9567a7e7687b53144bb18599731554569fd0f2f4938f50
+  metadata.gz: d34167607d9a37eadcd4e387b1eb94e7ea1a810ef3abbfaf212de698c0d58d5f56d3c76325a6acc3863440aff2dddfd79e81bd56b949e77355a84dbbe796498d
+  data.tar.gz: 272375f5ff9dc45ff9d78e8b35d199936f59c4011bf5cf972e794ea55793ca1cdc5311ae07ce35d868c5c18e68fae4311fc2d9eddd621e8ab7fa139d8d6df963

data/.github/workflows/danger.yml

@@ -4,7 +4,7 @@ jobs:
   lint:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v5
         with:
           fetch-depth: 0
       - name: Set up Ruby

data/.github/workflows/head.yml

@@ -7,26 +7,29 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        entry:
-          - { ruby: "3.2", grape-swagger: "HEAD" }
-          - { ruby: "ruby-head", grape-swagger: "HEAD" }
-          - { ruby: "jruby-head", grape-swagger: "HEAD" }
+        ruby: ['3.2', 'ruby-head', 'jruby-head']
+        rails: ['edge']
+        grape-swagger: ['HEAD']
     env:
-      GRAPE_SWAGGER_VERSION: ${{ matrix.entry.grape-swagger }}
+      GRAPE_SWAGGER_VERSION: ${{ matrix.grape-swagger }}
+      RAILS_VERSION: ${{ matrix.rails }}
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v5
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: ${{ matrix.entry.ruby }}
+          ruby-version: ${{ matrix.ruby }}
           bundler-cache: true
+      - name: Print Bundler Versions
+        run: bundle show
       - name: Setup Firefox
         uses: browser-actions/setup-firefox@v1
         with:
-          firefox-version: "111.0.1"
+          firefox-version: "130.0"
       - uses: browser-actions/setup-geckodriver@latest
         with:
-          geckodriver-version: "0.32.2"
-      - uses: coactions/setup-xvfb@v1
+          geckodriver-version: "0.35.0"
+      - name: Run tests
+        uses: coactions/setup-xvfb@v1
         with:
           run: bundle exec rake spec

data/.github/workflows/rubocop.yml

@@ -4,7 +4,7 @@ jobs:
   rubocop:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v5
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:

data/.github/workflows/test.yml

@@ -6,30 +6,39 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        entry:
-          - { ruby: "2.7", grape-swagger: "1.6.1" }
-          - { ruby: "3.0", grape-swagger: "1.6.1" }
-          - { ruby: "3.1", grape-swagger: "1.6.1" }
-          - { ruby: "3.2", grape-swagger: "1.6.1" }
-          - { ruby: "3.2", grape-swagger: "2.0.2" }
-          - { ruby: "jruby-9.4.6", grape-swagger: "1.6.1" }
-          - { ruby: "jruby-9.4.6", grape-swagger: "2.0.2" }
+        ruby: ['3.1', '3.2', '3.3', '3.4', 'jruby']
+        rails: ['7.2.2.2', '8.0.2.1']
+        grape-swagger: ['1.6.1', '2.1.2']
+        exclude:
+          - { ruby: '3.1', rails: '8.0.2.1' } # Rails 8 requires Ruby >= 3.2
     env:
-      GRAPE_SWAGGER_VERSION: ${{ matrix.entry.grape-swagger }}
+      GRAPE_SWAGGER_VERSION: ${{ matrix.grape-swagger }}
+      RAILS_VERSION: ${{ matrix.rails }}
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v5
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: ${{ matrix.entry.ruby }}
+          ruby-version: ${{ matrix.ruby }}
           bundler-cache: true
+      - name: Print Bundler Versions
+        run: bundle show
       - name: Setup Firefox
         uses: browser-actions/setup-firefox@v1
         with:
-          firefox-version: "111.0.1"
+          firefox-version: "130.0"
       - uses: browser-actions/setup-geckodriver@latest
         with:
-          geckodriver-version: "0.32.2"
-      - uses: coactions/setup-xvfb@v1
+          geckodriver-version: "0.35.0"
+      - name: Run tests with Sprockets
+        uses: coactions/setup-xvfb@v1
+        env:
+          ASSET_PIPELINE: sprockets
+        with:
+          run: bundle exec rake spec
+      - name: Run tests with Propshaft
+        uses: coactions/setup-xvfb@v1
+        env:
+          ASSET_PIPELINE: propshaft
         with:
           run: bundle exec rake spec

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2024-04-06 14:14:58 UTC using RuboCop version 1.62.1.
+# on 2024-09-11 20:09:03 UTC using RuboCop version 1.66.1.
 # 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
@@ -49,6 +49,7 @@ Metrics/BlockLength:
 # AllowedAcronyms: CLI, DSL, ACL, API, ASCII, CPU, CSS, DNS, EOF, GUID, HTML, HTTP, HTTPS, ID, IP, JSON, LHS, QPS, RAM, RHS, RPC, SLA, SMTP, SQL, SSH, TCP, TLS, TTL, UDP, UI, UID, UUID, URI, URL, UTF8, VM, XML, XMPP, XSRF, XSS
 Naming/FileName:
   Exclude:
+    - 'Rakefile.rb'
     - 'lib/grape-swagger-rails.rb'
     - 'spec/features/grape-swagger-rails_spec.rb'
 
@@ -61,7 +62,7 @@ RSpec/ContextWording:
 
 # Offense count: 1
 # This cop supports unsafe autocorrection (--autocorrect-all).
-# Configuration parameters: SkipBlocks, EnforcedStyle.
+# Configuration parameters: SkipBlocks, EnforcedStyle, OnlyStaticConstants.
 # SupportedStyles: described_class, explicit
 RSpec/DescribedClass:
   Exclude:
@@ -72,13 +73,6 @@ RSpec/DescribedClass:
 RSpec/ExampleLength:
   Max: 8
 
-# Offense count: 1
-# Configuration parameters: Include, CustomTransform, IgnoreMethods, SpecSuffixOnly.
-# Include: **/*_spec*rb*, **/spec/**/*
-RSpec/FilePath:
-  Exclude:
-    - 'spec/features/grape-swagger-rails_spec.rb'
-
 # Offense count: 2
 # Configuration parameters: AssignmentOnly.
 RSpec/InstanceVariable:
@@ -124,9 +118,9 @@ Style/OpenStructUse:
   Exclude:
     - 'lib/grape-swagger-rails.rb'
 
-# Offense count: 2
+# Offense count: 1
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, AllowedPatterns.
 # URISchemes: http, https
 Layout/LineLength:
-  Max: 143
+  Max: 124

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+### 0.7.0 (2025/09/16)
+
+* [#132](https://github.com/ruby-grape/grape-swagger-rails/pull/132): Automatically register assets with Sprockets - [@olivier-thatch](https://github.com/olivier-thatch).
+* [#130](https://github.com/ruby-grape/grape-swagger-rails/pull/130): Propshaft support - [@olivier-thatch](https://github.com/olivier-thatch).
+
+### 0.6.0 (2024/11/21)
+
+* [#124](https://github.com/ruby-grape/grape-swagger-rails/pull/124): Rails 7 compatibility - [@padde](https://github.com/padde).
+* [#125](https://github.com/ruby-grape/grape-swagger-rails/pull/125): Add rails versions to CI matrix - [@padde](https://github.com/padde).
+* [#126](https://github.com/ruby-grape/grape-swagger-rails/pull/126): Ruby 3.5 compatibility - [@padde](https://github.com/padde).
+* [#127](https://github.com/ruby-grape/grape-swagger-rails/pull/127): Bump Firefox and geckodriver - [@padde](https://github.com/padde).
+
 ### 0.5.0 (2024/04/06)
 
 * [#110](https://github.com/ruby-grape/grape-swagger-rails/pull/110): Update dummy app to current rails conventions - [@duffn](https://github.com/duffn).

data/Gemfile

@@ -4,12 +4,19 @@ source 'https://rubygems.org'
 
 gemspec
 
-case version = ENV['GRAPE_SWAGGER_VERSION'] || '~> 1.6.0'
+case grape_swagger_version = ENV.fetch('GRAPE_SWAGGER_VERSION', '~> 1.6.0')
 when 'HEAD'
   gem 'grape-swagger', github: 'ruby-grape/grape-swagger'
 else
   gem 'grape', '>= 1.3.0'
-  gem 'grape-swagger', version
+  gem 'grape-swagger', grape_swagger_version
+end
+
+case rails_version = ENV.fetch('RAILS_VERSION', '>= 6.0.6.1')
+when 'edge'
+  gem 'railties', github: 'rails/rails', branch: 'main'
+else
+  gem 'railties', rails_version
 end
 
 group :development, :test do
@@ -18,6 +25,7 @@ group :development, :test do
   gem 'jquery-rails'
   gem 'mime-types'
   gem 'nokogiri'
+  gem 'propshaft', require: false
   gem 'rack', '< 3.0'
   gem 'rack-cors'
   gem 'rake'
@@ -28,7 +36,8 @@ group :development, :test do
   gem 'rubocop-rspec'
   gem 'ruby-grape-danger', '~> 0.2.0', require: false
   gem 'selenium-webdriver'
-  gem 'sprockets-rails', require: 'sprockets/railtie'
+  gem 'sprockets', ENV.fetch('SPROCKETS_VERSION', '>= 4.0.0'), require: false
+  gem 'sprockets-rails', require: false
   gem 'uglifier'
   gem 'webrick'
 end

data/README.md

@@ -1,7 +1,7 @@
 # GrapeSwaggerRails
 
 [![Gem Version](https://badge.fury.io/rb/grape-swagger-rails.svg)](http://badge.fury.io/rb/grape-swagger-rails)
-[![Test](https://github.com/ruby-grape/grape-swagger-rails/workflows/test/badge.svg?branch=master)](https://github.com/ruby-grape/grape-swagger-rails/actions)
+[![Tests](https://github.com/ruby-grape/grape-swagger-rails/actions/workflows/test.yml/badge.svg)](https://github.com/ruby-grape/grape-swagger-rails/actions/workflows/test.yml)
 [![Code Climate](https://codeclimate.com/github/ruby-grape/grape-swagger-rails/badges/gpa.svg)](https://codeclimate.com/github/ruby-grape/grape-swagger-rails)
 
 Swagger UI as Rails Engine for grape-swagger gem.
@@ -18,8 +18,6 @@ Swagger UI as Rails Engine for grape-swagger gem.
     - [Integration with DoorKeeper](#integration-with-doorkeeper)
   - [Hiding the API or Authorization text boxes](#hiding-the-api-or-authorization-text-boxes)
   - [Updating Swagger UI from Dist](#updating-swagger-ui-from-dist)
-  - [Enabling in a Rails-API Project](#enabling-in-a-rails-api-project)
-  - [Enabling in Rails 6 (Sprokets 5)](#enabling-in-rails-6-sprokets-5)
 - [Contributors](#contributors)
 - [Contributing](#contributing)
 - [License](#license)
@@ -49,6 +47,8 @@ grape  | grape-swagger
 0.9.0  | 0.8.0
 0.10.0 | 0.9.0
 0.16.2 | 0.20.2
+1.8.0  | 1.6.1
+2.2.0  | 2.1.1
 
 ## Usage
 
@@ -215,42 +215,6 @@ NOTE: This action should be run part of this gem (not your application). In case
 make it up-to-date, clone the repo, run the rake task, examine the diff, fix any bugs, make sure
 tests pass and then send PR here.
 
-### Enabling in a Rails-API Project
-
-The grape-swagger-rails gem uses the Rails asset pipeline for its Javascript and CSS. Enable the asset pipeline with [rails-api](https://github.com/rails-api/rails-api).
-
-Add sprockets to `config/application.rb`.
-
-```ruby
-require 'sprockets/railtie'
-```
-
-Include JavaScript in `app/assets/javascripts/application.js`.
-
-```javascript
-//
-//= require_tree .
-```
-
-Include CSS stylesheets in `app/assets/stylesheets/application.css`.
-
-```css
-/*
-*= require_tree .
-*/
-```
-
-### Enabling in Rails 6 (Sprokets 5)
-
-Rails 6 top-level targets are determined via `./app/assets/config/manifest.js`. Specify `grape-swagger-rails` asset files as follows.
-
-```javascript
-//= link grape_swagger_rails/application.css
-//= link grape_swagger_rails/application.js
-```
-
-See [Upgrading Sprokets](https://github.com/rails/sprockets/blob/master/UPGRADING.md#manifestjs) for more information.
-
 ## Contributors
 
 * [unloved](https://github.com/unloved)

data/app/assets/stylesheets/grape_swagger_rails/application.css

@@ -1,5 +1,5 @@
 /*
 *= require ./reset
-*= require ./screen
+*= require ./screen-sprockets
 *= require_self
 */