Fix Grape 3.1.0 and grape-swagger-entity 0.7.1 compatibility (#972)

* Fix Grape 3.1.0 compatibility: replace route.attributes with direct access

Grape 3.1.0 removed the `attributes` alias from BaseRoute.
Use direct method calls (route.success, route.produces) which work
in all versions via delegate_missing_to.

Fixes #971

* Update RouteHelper for Grape 3.1.0 Route/Pattern constructor changes

Grape 3.1.0 changed the Route constructor signature from
(method, origin, path, options) to (endpoint, method, pattern, options)
and Pattern now uses keyword arguments.

* Update test expectation for hidden attributes in required list

Align with grape-swagger-entity#87 which correctly excludes hidden
attributes from the required fields list in Swagger documentation.

* Add scheduled workflow for Grape HEAD compatibility testing

Runs weekly (Sundays at midnight UTC) to detect compatibility
issues with upcoming Grape releases early.

* Update test for grape-swagger-entity 0.7.1 allOf wrapper

grape-swagger-entity 0.7.1 now wraps $ref in allOf when description
is present, which is the correct OpenAPI format.

See: ruby-grape/grape-swagger-entity#90

* Update CHANGELOG for PR #972

* Use fetch with defaults in RouteHelper to handle falsey values

* Clean up: remove redundant comments, fix CHANGELOG placeholder

Author: numbata

.github/workflows/edge.yml

@@ -0,0 +1,43 @@
+name: Edge
+
+on:
+  schedule:
+    - cron: '0 0 * * 0' # Every Sunday at midnight UTC
+  workflow_dispatch: # Allow manual trigger
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: ['3.3', '3.4']
+    name: test (ruby=${{ matrix.ruby }}, grape=HEAD)
+    runs-on: ubuntu-latest
+    env:
+      GRAPE_VERSION: HEAD
+    steps:
+    - name: Check out branch
+      uses: actions/checkout@v6
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+    - 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

CHANGELOG.md

@@ -3,6 +3,12 @@
 #### Features
 
 * [#970](https://github.com/ruby-grape/grape-swagger/pull/970): Migrate Danger to use danger-pr-comment workflow - [@dblock](https://github.com/dblock).
+* [#972](https://github.com/ruby-grape/grape-swagger/pull/972): Add weekly scheduled workflow to test against Grape HEAD - [@numbata](https://github.com/numbata).
+* Your contribution here.
+
+#### Fixes
+
+* [#972](https://github.com/ruby-grape/grape-swagger/pull/972): Grape 3.1.0 and grape-swagger-entity 0.7.1 compatibility - [@numbata](https://github.com/numbata).
 * Your contribution here.
 
 ### 2.1.3 (2025-11-21)

lib/grape-swagger/endpoint.rb

@@ -155,8 +155,8 @@ def description_object(route)
     end
 
     def produces_object(route, format)
-      return ['application/octet-stream'] if file_response?(route.attributes.success) &&
-                                             !route.attributes.produces.present?
+      return ['application/octet-stream'] if file_response?(route.options[:success]) &&
+                                             !route.options[:produces].present?
 
       mime_types = GrapeSwagger::DocMethods::ProducesConsumes.call(format)
 

spec/issues/962_polymorphic_entity_with_custom_documentation_spec.rb

@@ -95,8 +95,7 @@ class EntityWithNestedEmptyEntity < Grape::Entity
   specify do
     expect(hidden_entity_definition).to eql({
       'type' => 'object',
-      'properties' => {},
-      'required' => ['hidden_prop']
+      'properties' => {}
     })
   end
 

spec/support/route_helper.rb

@@ -2,7 +2,18 @@
 
 module RouteHelper
   def self.build(method:, pattern:, options:, origin: nil)
-    if GrapeVersion.satisfy?('>= 2.3.0')
+    if GrapeVersion.satisfy?('>= 3.1.0')
+      pattern_obj = Grape::Router::Pattern.new(
+        origin: origin || pattern,
+        suffix: nil,
+        anchor: options.fetch(:anchor, true),
+        params: options.fetch(:params, {}),
+        format: nil,
+        version: nil,
+        requirements: options.fetch(:requirements, {})
+      )
+      Grape::Router::Route.new(nil, method, pattern_obj, options)
+    elsif GrapeVersion.satisfy?('>= 2.3.0')
       Grape::Router::Route.new(method, origin || pattern, pattern, options)
     else
       Grape::Router::Route.new(method, pattern, **options)

spec/swagger_v2/reference_entity_spec.rb

@@ -101,7 +101,7 @@ def app
         'properties' => {
           'title' => { 'type' => 'string', 'description' => 'Title of the kind.' },
           'something' => {
-            '$ref' => '#/definitions/SomethingCustom',
+            'allOf' => [{ '$ref' => '#/definitions/SomethingCustom' }],
             'description' => 'Something interesting.'
           }
         },