grape-rabl 0.4.3 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 8192a5ce63fc8fcde53a8948ad61e8b659f1e4b7
-  data.tar.gz: d10abacc60cfc20af4679e18302cbe2d2cdb1220
+SHA256:
+  metadata.gz: d1558b633e4d2bf6350bdfbb8b66007abf6c3bcb6fa3164cde86e086a2e78c03
+  data.tar.gz: 4157fccf4ea55393a8b4f0074c871a1e1c153b24723852cf2e163c67d4af8bf0
 SHA512:
-  metadata.gz: ea70396b25b43e9ca3daa526679c86989fef25b014ae9683048d2b17ad57ef82f5459ea17667c85a546b03b75c6b2f13c06a95cb029f1527e632496cf5eacbd7
-  data.tar.gz: 3ef3faaa10a3f10bb83f2b68fe3fb00ebccae89e450a49e9c1912bdd58dd93711906e40abea81e431edae320b8694a8cb7b2022ad077906f42f383764ab81628
+  metadata.gz: f796e497daf4317f7f9e29e218b8623b3c2890c358e304237aaf2a11e379891811885fd85faf6aa68bf7340cee74ea0c0d6cf376f33bde8609cd3c6d073736ff
+  data.tar.gz: c36abcb5a1427d7c2c252caadb1360fe7938bc9cdd1054fd2f9d313f0b376811591574c1125b8f4c8c0d33686a52a7caa425d8be9bb8ef702e313e0fe4cd8c36

data/.github/workflows/danger-comment.yml

@@ -0,0 +1,11 @@
+name: Danger Comment
+
+on:
+  workflow_run:
+    workflows: [Danger]
+    types: [completed]
+
+jobs:
+  comment:
+    uses: numbata/danger-pr-comment/.github/workflows/danger-comment.yml@v0.1.0
+    secrets: inherit

data/.github/workflows/danger.yml

@@ -0,0 +1,13 @@
+name: Danger
+
+on:
+  pull_request:
+    types: [opened, reopened, edited, synchronize]
+
+jobs:
+  danger:
+    uses: numbata/danger-pr-comment/.github/workflows/danger-run.yml@v0.1.0
+    secrets: inherit
+    with:
+      ruby-version: '3.4'
+      bundler-cache: true

data/.github/workflows/test.yml

@@ -0,0 +1,60 @@
+name: Test
+
+on: [push, pull_request]
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    runs-on: ${{ matrix.os || 'ubuntu-latest' }}
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - { ruby: '2.7', grape: '1', os: 'ubuntu-22.04' }
+          - { ruby: '2.7', grape: '2', os: 'ubuntu-22.04' }
+          - { ruby: '3.3', grape: '1' }
+          - { ruby: '3.3', grape: '2' }
+          - { ruby: '3.3', grape: '3' }
+          - { ruby: '3.3', grape: '4' }
+          - { ruby: '3.4', grape: '4' }
+          - { ruby: '4.0', grape: '4' }
+          - { ruby: 'ruby-head', grape: '4', experimental: true }
+    name: Ruby ${{ matrix.ruby }} / Grape ${{ matrix.grape }}
+    continue-on-error: ${{ matrix.experimental || false }}
+    env:
+      GRAPE_VERSION: ${{ matrix.grape }}
+    steps:
+      - uses: actions/checkout@v7
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - run: bundle exec rake spec
+      - uses: coverallsapp/github-action@v2
+        if: matrix.ruby != 'ruby-head'
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          file: coverage/lcov/grape-rabl.lcov
+          format: lcov
+          flag-name: test-${{ strategy.job-index }}
+          parallel: true
+  coverage:
+    name: Finish Coveralls
+    needs: test
+    runs-on: ubuntu-latest
+    steps:
+      - uses: coverallsapp/github-action@v2
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          parallel-finished: true
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v7
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.3'
+          bundler-cache: true
+      - run: bundle exec rake rubocop

data/.rubocop.yml

@@ -1,6 +1,8 @@
 AllCops:
+  NewCops: enable
+  TargetRubyVersion: 2.7
   Exclude:
-    - vendor/**
+    - vendor/**/*
     - .bundle
 
 inherit_from: .rubocop_todo.yml

data/.rubocop_todo.yml

@@ -1,28 +1,32 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2016-06-08 16:00:13 -0400 using RuboCop version 0.40.0.
+# on 2026-10-26 10:48:33 UTC using RuboCop version 1.92.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
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 1
-Lint/RescueException:
-  Exclude:
-    - 'spec/grape_rabl_spec.rb'
-
-# Offense count: 21
-# Configuration parameters: AllowHeredoc, AllowURI, URISchemes.
-# URISchemes: http, https
-Metrics/LineLength:
-  Max: 148
+# Offense count: 11
+# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
+# AllowedMethods: refine
+Metrics/BlockLength:
+  Max: 165
 
 # Offense count: 1
-# Configuration parameters: CountComments.
+# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
 Metrics/MethodLength:
   Max: 13
 
+# Offense count: 1
+# Configuration parameters: ExpectMatchingDefinition, CheckDefinitionPathHierarchy, CheckDefinitionPathHierarchyRoots, Regex, IgnoreExecutableScripts, AllowedAcronyms.
+# CheckDefinitionPathHierarchyRoots: lib, spec, test, src
+# 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:
+    - 'lib/grape-rabl.rb'
+
 # Offense count: 5
+# Configuration parameters: AllowedConstants.
 Style/Documentation:
   Exclude:
     - 'spec/**/*'
@@ -34,17 +38,15 @@ Style/Documentation:
     - 'lib/grape/rabl.rb'
 
 # Offense count: 1
-Style/DoubleNegation:
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: AllowIfModifier.
+Style/IfInsideElse:
   Exclude:
     - 'lib/grape-rabl/formatter.rb'
 
 # Offense count: 1
-# Configuration parameters: ExpectMatchingDefinition, Regex, IgnoreExecutableScripts.
-Style/FileName:
-  Exclude:
-    - 'lib/grape-rabl.rb'
-
-# Offense count: 1
-Style/IfInsideElse:
-  Exclude:
-    - 'lib/grape-rabl/formatter.rb'
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: AllowHeredoc, AllowURI, AllowQualifiedName, URISchemes, AllowRBSInlineAnnotation, AllowCopDirectives, AllowedPatterns, SplitStrings.
+# URISchemes: http, https
+Layout/LineLength:
+  Max: 131

data/CHANGELOG.md

@@ -1,26 +1,40 @@
-#### v0.4.3
+#### 0.6.0 (2026-10-27)
+
+* [#59](https://github.com/ruby-grape/grape-rabl/pull/59): Document optional Swagger generation with explicit response schemas while retaining Rabl rendering - [@dblock](https://github.com/dblock).
+* [#58](https://github.com/ruby-grape/grape-rabl/pull/58): Support static and request-aware configured template roots while preserving explicit request roots and cache isolation - [@dblock](https://github.com/dblock).
+* [#57](https://github.com/ruby-grape/grape-rabl/pull/57): Remove the obsolete Code Climate badge, use HTTPS and RubyGems for the gem badge, and scope the CI badge to master pushes - [@dblock](https://github.com/dblock).
+* [#56](https://github.com/ruby-grape/grape-rabl/pull/56): Merge Coveralls coverage across the stable Ruby/Grape matrix and refresh the coverage badge - [@dblock](https://github.com/dblock).
+* [#55](https://github.com/ruby-grape/grape-rabl/pull/55): Replace deprecated `Tilt::Cache` with a synchronized Hash cache for templates and layouts - [@dblock](https://github.com/dblock).
+* [#54](https://github.com/ruby-grape/grape-rabl/pull/54): Replaced Travis CI with GitHub Actions, modernized RuboCop and coverage reporting, and added a Ruby 2.7-4.0/Grape 1.x-4.x compatibility matrix; Ruby 2.7 or newer is now required - [@dblock](https://github.com/dblock).
+* [#54](https://github.com/ruby-grape/grape-rabl/pull/54): Fixed fallback rendering with newer Grape versions, including Grape 4.x - [@dblock](https://github.com/dblock).
+
+#### 0.5.0
+
+* [#34](https://github.com/ruby-grape/grape-rabl/pulls/34): If no RABL template is specified, fallback to the default response format as determined by Grape - [@chrisbloom7](https://github.com/chrisbloom7).
+
+#### 0.4.3
 
 * [#44](https://github.com/ruby-grape/grape-rabl/issues/44): Don't require unused hashie - [@tsuwatch](https://github.com/tsuwatch).
 * [#44](https://github.com/ruby-grape/grape-rabl/issues/44): Support Ruby >= 2.2 - [@tsuwatch](https://github.com/tsuwatch).
 * [#45](https://github.com/ruby-grape/grape-rabl/pull/45): Added danger, PR linter - [@dblock](https://github.com/dblock).
 
-#### v0.4.2
+#### 0.4.2
 
 * [#43](https://github.com/ruby-grape/grape-rabl/pull/43): Fix template caching for multiple formats - [@kushkella](https://github.com/kushkella).
 
-#### v0.4.1
+#### 0.4.1
 
 * [#39](https://github.com/ruby-grape/grape-rabl/issues/39): Automatically require 'grape/rabl' - [@martinezcoder](https://github.com/martinezcoder).
 
-#### v0.4.0
+#### 0.4.0
 
 * [#37](https://github.com/ruby-grape/grape-rabl/issues/37): Make grape-rabl thread-safe - [@kushkella](https://github.com/kushkella).
 
-#### v0.3.1
+#### 0.3.1
 
 * [#35](https://github.com/ruby-grape/grape-rabl/issues/35): The `render` method will no longer modify endpoint options at runtime - [@yesmeck](https://github.com/yesmeck).
 
-#### v0.3.0
+#### 0.3.0
 
 * [#22](https://github.com/ruby-grape/grape-rabl/pull/22): Enable using a layout template in Rabl - [@koko1000ban](https://github.com/koko1000ban).
 * Implemented Rubocop, Ruby style linter - [@dblock](https://github.com/dblock).
@@ -28,23 +42,22 @@
 * Enable using locals with `.render` - [@hobofan](https://github.com/hobofan).
 * Enable support for template caching - [@kushkella](https://github.com/kushkella).
 
-
-#### v0.2.2
+#### 0.2.2
 
 * [#20](https://github.com/ruby-grape/grape-rabl/pull/20): Relaxed dependency on a specific version of Grape - [@cheef](https://github.com/cheef).
 
-#### v0.2.1
+#### 0.2.1
 
 * [#11](https://github.com/ruby-grape/grape-rabl/pull/11): Fix: render template according to request format - [@alovak](https://github.com/alovak).
 
-#### v0.2.0
+#### 0.2.0
 
 * [#10](https://github.com/ruby-grape/grape-rabl/pull/10): Allow to use partials in Grape - [@ichilton](https://github.com/ichilton).
 * Stick to gem conventions - [@LTe](https://github.com/lte).
 * [#13](https://github.com/ruby-grape/grape-rabl/pull/13): Update for Grape 0.3 compatibility - [@alovak](https://github.com/alovak).
 * Format fix - [@LTe](https://github.com/LTe).
 
-#### v0.1.0
+#### 0.1.0
 
 * Updated w/released Grape 0.2.3 - [@dblock](https://github.com/dblock).
 * Added link to Rabl - [@dblock](https://github.com/dblock).
@@ -52,31 +65,31 @@
 * Grape 0.2.3 - [@dblock](https://github.com/dblock).
 * Updated Grape dependency via .gemspec - [@dblock](https://github.com/dblock).
 
-#### v0.0.6
+#### 0.0.6
 
 * [#6](https://github.com/ruby-grape/grape-rabl/pull/6): Use Grape formatter syntax instead of monkey-patching - [@dblock](https://github.com/dblock).
 * Close block code in README - [@LTe](https://github.com/LTe).
 * Change home to user - [@LTe](https://github.com/LTe).
 
-#### v0.0.5
+#### 0.0.5
 
 * Respect `default_format` for rabl response - [@LTe](https://github.com/LTe).
 
-#### v0.0.4
+#### 0.0.4
 
 * Require `grape/rabl` - [@LTe](https://github.com/LTe).
 
-#### v0.0.3
+#### 0.0.3
 
 * Template without `.rabl` - [@LTe](https://github.com/LTe).
 
-#### v0.0.2
+#### 0.0.2
 
 * Add Travis - [@LTe](https://github.com/LTe).
 * Remove ruby debug - [@LTe](https://github.com/LTe).
 * Works with rubinius - [@LTe](https://github.com/LTe).
 * Add dependency status - [@LTe](https://github.com/LTe).
 
-#### v0.0.1
+#### 0.0.1
 
 * Initial public release - [@LTe](https://github.com/lte).

data/CONTRIBUTING.md

@@ -32,6 +32,17 @@ bundle install
 bundle exec rake
 ```
 
+CI runs on GitHub Actions with Grape 1.x and 2.x on Ruby 2.7, Grape 1.x through 4.x on Ruby 3.3, and Grape 4.x on Ruby 3.4, Ruby 4.0, and ruby-head (allowed to fail). Ruby 2.7 jobs use Ubuntu 22.04; newer Rubies use the latest Ubuntu runner.
+
+Select a Grape major version locally using `GRAPE_VERSION`. Resolve the bundle again when switching versions:
+
+```sh
+GRAPE_VERSION=4 bundle update
+GRAPE_VERSION=4 bundle exec rake
+```
+
+Use `GRAPE_VERSION=1`, `2`, or `3` for the other supported majors. The Grape 1.x bundle selects Rack 2.x because Grape 1.x is not compatible with Rack 3.x. Without `GRAPE_VERSION`, Bundler selects the latest Grape compatible with your Ruby.
+
 #### Write Tests
 
 Try to write a test that reproduces the problem you're trying to fix or describes a feature that you want to build. Add to [spec/grape-rabl](spec/grape-rabl).
@@ -107,7 +118,7 @@ git push origin my-feature-branch -f
 
 #### Check on Your Pull Request
 
-Go back to your pull request after a few minutes and see whether it passed muster with Travis-CI. Everything should look green, otherwise fix issues and amend your commit as described above.
+Go back to your pull request after a few minutes and check its GitHub Actions results. Everything should look green, otherwise fix issues and amend your commit as described above.
 
 #### Be Patient
 

data/Dangerfile

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 danger.import_dangerfile(gem: 'ruby-grape-danger')

data/Gemfile

@@ -1,17 +1,24 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 gemspec
 
+gem 'grape', "~> #{ENV['GRAPE_VERSION']}.0" if ENV['GRAPE_VERSION']
+gem 'rack', '~> 2.2' if ENV['GRAPE_VERSION'] == '1'
+
 group :development do
-  gem 'rubocop', '0.40.0'
+  gem 'rubocop', '~> 1.92.0', require: false
+  gem 'ruby-grape-danger', '~> 0.3.0', require: false
 end
 
 group :test do
+  gem 'builder'
   gem 'json'
-  gem 'rspec'
+  gem 'rabl'
   gem 'rack-test'
   gem 'rake'
-  gem 'coveralls', require: false
-  gem 'rabl'
-  gem 'ruby-grape-danger', '~> 0.1.1', require: false
+  gem 'rspec'
+  gem 'simplecov', require: false
+  gem 'simplecov-lcov', require: false
 end