grape-swagger-rails 0.7.0 → 1.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (84) hide show
  1. checksums.yaml +4 -4
  2. data/.github/FUNDING.yml +1 -0
  3. data/.github/copilot-instructions.md +5 -0
  4. data/.github/workflows/danger-comment.yml +9 -0
  5. data/.github/workflows/danger.yml +9 -17
  6. data/.github/workflows/frontend.yml +29 -0
  7. data/.github/workflows/test.yml +35 -6
  8. data/.gitignore +3 -1
  9. data/.pnp.cjs +8105 -0
  10. data/.rubocop.yml +8 -3
  11. data/.rubocop_todo.yml +5 -5
  12. data/CHANGELOG.md +26 -0
  13. data/CLAUDE.md +80 -0
  14. data/Dangerfile +4 -1
  15. data/Gemfile +14 -4
  16. data/README.md +100 -18
  17. data/RELEASING.md +25 -7
  18. data/UPGRADING.md +21 -1
  19. data/app/assets/config/grape_swagger_rails_manifest.js +1 -0
  20. data/app/assets/javascripts/grape_swagger_rails/index.js +275 -0
  21. data/app/assets/javascripts/grape_swagger_rails/index.min.js +2 -0
  22. data/app/assets/javascripts/grape_swagger_rails/index.min.js.map +7 -0
  23. data/app/assets/javascripts/grape_swagger_rails/swagger-ui-bundle.js +2 -0
  24. data/app/assets/javascripts/grape_swagger_rails/swagger-ui-standalone-preset.js +2 -0
  25. data/app/assets/stylesheets/grape_swagger_rails/index.css +328 -0
  26. data/app/assets/stylesheets/grape_swagger_rails/swagger-ui.css +3 -0
  27. data/app/helpers/grape_swagger_rails/application_helper.rb +22 -0
  28. data/app/views/grape_swagger_rails/application/index.html.haml +21 -0
  29. data/frontend/grape_swagger_rails/index.ts +387 -0
  30. data/grape-swagger-rails.gemspec +7 -4
  31. data/lib/grape-swagger-rails/engine.rb +10 -4
  32. data/lib/grape-swagger-rails/version.rb +2 -1
  33. data/lib/grape-swagger-rails.rb +14 -5
  34. data/lib/tasks/swagger_ui.rake +38 -91
  35. data/package.json +15 -0
  36. data/spec/dummy/app/api/api.rb +58 -0
  37. data/spec/dummy/config/application.rb +3 -1
  38. data/spec/dummy/config/boot.rb +1 -2
  39. data/spec/dummy/config/environments/development.rb +14 -22
  40. data/spec/dummy/config/environments/production.rb +33 -49
  41. data/spec/dummy/config/environments/test.rb +15 -20
  42. data/spec/dummy/config/routes.rb +2 -0
  43. data/spec/features/grape-swagger-rails_spec.rb +0 -2
  44. data/spec/features/swagger_spec.rb +567 -98
  45. data/spec/features/welcome_spec.rb +1 -3
  46. data/spec/spec_helper.rb +2 -1
  47. data/spec/support/capybara.rb +1 -0
  48. data/tsconfig.json +12 -0
  49. data/yarn.lock +306 -0
  50. metadata +61 -43
  51. data/.github/workflows/head.yml +0 -35
  52. data/app/assets/images/grape_swagger_rails/collapse.gif +0 -0
  53. data/app/assets/images/grape_swagger_rails/expand.gif +0 -0
  54. data/app/assets/images/grape_swagger_rails/explorer_icons.png +0 -0
  55. data/app/assets/images/grape_swagger_rails/logo_small.png +0 -0
  56. data/app/assets/images/grape_swagger_rails/pet_store_api.png +0 -0
  57. data/app/assets/images/grape_swagger_rails/throbber.gif +0 -0
  58. data/app/assets/images/grape_swagger_rails/wordnik_api.png +0 -0
  59. data/app/assets/javascripts/grape_swagger_rails/application.js +0 -15
  60. data/app/assets/javascripts/grape_swagger_rails/backbone-min.js +0 -15
  61. data/app/assets/javascripts/grape_swagger_rails/base64.js +0 -134
  62. data/app/assets/javascripts/grape_swagger_rails/es5-shim.js +0 -2065
  63. data/app/assets/javascripts/grape_swagger_rails/handlebars-2.0.0.js +0 -28
  64. data/app/assets/javascripts/grape_swagger_rails/highlight.9.1.0.pack.js +0 -2
  65. data/app/assets/javascripts/grape_swagger_rails/highlight.9.1.0.pack_extended.js +0 -34
  66. data/app/assets/javascripts/grape_swagger_rails/jquery-1.8.0.min.js +0 -2
  67. data/app/assets/javascripts/grape_swagger_rails/jquery.ba-bbq.min.js +0 -18
  68. data/app/assets/javascripts/grape_swagger_rails/jquery.slideto.min.js +0 -1
  69. data/app/assets/javascripts/grape_swagger_rails/jquery.wiggle.min.js +0 -8
  70. data/app/assets/javascripts/grape_swagger_rails/js-yaml.min.js +0 -3
  71. data/app/assets/javascripts/grape_swagger_rails/jsoneditor.min.js +0 -11
  72. data/app/assets/javascripts/grape_swagger_rails/lodash.min.js +0 -102
  73. data/app/assets/javascripts/grape_swagger_rails/marked.js +0 -1272
  74. data/app/assets/javascripts/grape_swagger_rails/object-assign-pollyfill.js +0 -23
  75. data/app/assets/javascripts/grape_swagger_rails/swagger-oauth.js +0 -347
  76. data/app/assets/javascripts/grape_swagger_rails/swagger-ui.min.js +0 -10
  77. data/app/assets/stylesheets/grape_swagger_rails/application.css +0 -5
  78. data/app/assets/stylesheets/grape_swagger_rails/print.css +0 -1362
  79. data/app/assets/stylesheets/grape_swagger_rails/reset.css +0 -125
  80. data/app/assets/stylesheets/grape_swagger_rails/screen-propshaft.css +0 -1489
  81. data/app/assets/stylesheets/grape_swagger_rails/screen-sprockets.css.erb +0 -1489
  82. data/app/assets/stylesheets/grape_swagger_rails/style.css +0 -250
  83. data/app/assets/stylesheets/grape_swagger_rails/typography.css +0 -14
  84. data/app/views/grape_swagger_rails/application/index.html.erb +0 -136
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 6acf0c3a11fe817b12f2b4c4469f1fc3a6efce7517731b3afd217474a95840a0
4
- data.tar.gz: c4ab9b45226c2946ee4d20ff9c34e0cd3decfa83754c4119412587d383a4d12b
3
+ metadata.gz: 61a592b658be0f0b08a98137d907c771b4444627d3da072b40b73cfe4ea40773
4
+ data.tar.gz: c44bec534d280e3d579ecb71f4f0f63b722f672538b5b45495c6c5ca107da168
5
5
  SHA512:
6
- metadata.gz: d34167607d9a37eadcd4e387b1eb94e7ea1a810ef3abbfaf212de698c0d58d5f56d3c76325a6acc3863440aff2dddfd79e81bd56b949e77355a84dbbe796498d
7
- data.tar.gz: 272375f5ff9dc45ff9d78e8b35d199936f59c4011bf5cf972e794ea55793ca1cdc5311ae07ce35d868c5c18e68fae4311fc2d9eddd621e8ab7fa139d8d6df963
6
+ metadata.gz: 1fd25759115054c6885fdb7c31a8dd9be252c0b82f6935d50c639d37e349d1149773302db8265f2569799ba99e87f74f63827d41a25af9b6b14b4ecee7c804e1
7
+ data.tar.gz: cfedf854908cda46fd6ba7d55bb35fc02d5e65c35034251e12e90abaafe8889f137703564aec572acd470fe3e4d1574aa1d7185ad098fcc58dc9ca4c7b11421d
@@ -0,0 +1 @@
1
+ github: [dblock]
@@ -0,0 +1,5 @@
1
+ # Copilot Instructions
2
+
3
+ This file provides guidance to GitHub Copilot when working with this repository.
4
+
5
+ For complete project context, architecture details, and coding conventions, see [CLAUDE.md](../CLAUDE.md) — it contains the canonical instructions shared across all AI agents.
@@ -0,0 +1,9 @@
1
+ name: Danger Comment
2
+ on:
3
+ workflow_run:
4
+ workflows: ['Danger']
5
+ types: [completed]
6
+ jobs:
7
+ comment:
8
+ uses: numbata/danger-pr-comment/.github/workflows/danger-comment.yml@v0.1.0
9
+ secrets: inherit
@@ -1,19 +1,11 @@
1
1
  name: Danger
2
- on: [pull_request]
2
+ on:
3
+ pull_request:
4
+ types: [opened, reopened, synchronize, edited]
3
5
  jobs:
4
- lint:
5
- runs-on: ubuntu-latest
6
- steps:
7
- - uses: actions/checkout@v5
8
- with:
9
- fetch-depth: 0
10
- - name: Set up Ruby
11
- uses: ruby/setup-ruby@v1
12
- with:
13
- ruby-version: "2.7"
14
- bundler-cache: true
15
- - name: Run Danger
16
- run: |
17
- # the token is public, has public_repo scope and belongs to the grape-bot user owned by @dblock, this is ok
18
- TOKEN=$(echo -n Z2hwX2lYb0dPNXNyejYzOFJyaTV3QUxUdkNiS1dtblFwZTFuRXpmMwo= | base64 --decode)
19
- DANGER_GITHUB_API_TOKEN=$TOKEN bundle exec danger --verbose
6
+ danger:
7
+ uses: numbata/danger-pr-comment/.github/workflows/danger-run.yml@v0.1.0
8
+ with:
9
+ ruby-version: '3.4'
10
+ bundler-cache: true
11
+ secrets: inherit
@@ -0,0 +1,29 @@
1
+ name: Frontend
2
+ on:
3
+ push:
4
+ branches:
5
+ - master
6
+ pull_request:
7
+ jobs:
8
+ frontend:
9
+ runs-on: ubuntu-latest
10
+ steps:
11
+ - uses: actions/checkout@v5
12
+ - name: Set up Node
13
+ uses: actions/setup-node@v4
14
+ with:
15
+ node-version: "lts/*"
16
+ - name: Enable Corepack
17
+ run: corepack enable
18
+ - name: Install dependencies
19
+ run: yarn install --immutable
20
+ - name: TypeScript type check
21
+ run: yarn typecheck
22
+ - name: Build frontend
23
+ run: yarn build:frontend
24
+ - name: Check compiled output is committed
25
+ run: |
26
+ git diff --exit-code \
27
+ app/assets/javascripts/grape_swagger_rails/index.js \
28
+ app/assets/javascripts/grape_swagger_rails/index.min.js \
29
+ app/assets/javascripts/grape_swagger_rails/index.min.js.map
@@ -1,17 +1,46 @@
1
1
  name: Tests
2
- on: [push, pull_request]
2
+ on:
3
+ push:
4
+ branches:
5
+ - master
6
+ pull_request:
3
7
  jobs:
4
8
  test:
5
9
  runs-on: ubuntu-latest
6
10
  strategy:
7
11
  fail-fast: false
8
12
  matrix:
9
- ruby: ['3.1', '3.2', '3.3', '3.4', 'jruby']
10
- rails: ['7.2.2.2', '8.0.2.1']
11
- grape-swagger: ['1.6.1', '2.1.2']
12
- exclude:
13
- - { ruby: '3.1', rails: '8.0.2.1' } # Rails 8 requires Ruby >= 3.2
13
+ include:
14
+ - ruby: '3.2'
15
+ rails: '7.2.2.2'
16
+ grape: '~> 1.8.0'
17
+ grape-swagger: '1.6.1'
18
+ - ruby: '3.2'
19
+ rails: '7.2.2.2'
20
+ grape: '~> 3.1.0'
21
+ grape-swagger: '2.1.4'
22
+ - ruby: '3.3'
23
+ rails: '7.2.2.2'
24
+ grape: '~> 3.1.0'
25
+ grape-swagger: '2.1.4'
26
+ - ruby: '3.4'
27
+ rails: '7.2.2.2'
28
+ grape: '~> 3.1.0'
29
+ grape-swagger: '2.1.4'
30
+ - ruby: '3.2'
31
+ rails: '~> 8.1.3'
32
+ grape: '~> 3.1.0'
33
+ grape-swagger: '2.1.4'
34
+ - ruby: '3.3'
35
+ rails: '~> 8.1.3'
36
+ grape: '~> 3.1.0'
37
+ grape-swagger: '2.1.4'
38
+ - ruby: '3.4'
39
+ rails: '~> 8.1.3'
40
+ grape: '~> 3.1.0'
41
+ grape-swagger: '2.1.4'
14
42
  env:
43
+ GRAPE_VERSION: ${{ matrix.grape }}
15
44
  GRAPE_SWAGGER_VERSION: ${{ matrix.grape-swagger }}
16
45
  RAILS_VERSION: ${{ matrix.rails }}
17
46
  steps:
data/.gitignore CHANGED
@@ -16,4 +16,6 @@ test/tmp
16
16
  test/version_tmp
17
17
  tmp
18
18
  .idea
19
- .project
19
+ .project
20
+ .ruby-version
21
+ .yarn