grape-rabl 0.4.3 → 0.6.0

data/README.md

@@ -1,203 +1,300 @@
-# Grape::Rabl
-
-Use [Rabl](https://github.com/nesquena/rabl) templates in [Grape](https://github.com/intridea/grape)!
-
-[![Gem Version](http://img.shields.io/gem/v/grape-rabl.svg)](http://badge.fury.io/rb/grape-rabl)
-[![Build Status](http://img.shields.io/travis/ruby-grape/grape-rabl.svg)](https://travis-ci.org/ruby-grape/grape-rabl)
-[![Dependency Status](https://gemnasium.com/ruby-grape/grape-rabl.svg)](https://gemnasium.com/ruby-grape/grape-rabl)
-[![Code Climate](https://codeclimate.com/github/ruby-grape/grape-rabl.svg)](https://codeclimate.com/github/ruby-grape/grape-rabl)
-[![Coverage Status](https://img.shields.io/coveralls/ruby-grape/grape-rabl.svg)](https://coveralls.io/r/ruby-grape/grape-rabl?branch=master)
-
-## Installation
-
-Add the `grape` and `grape-rabl` gems to Gemfile.
-
-```ruby
-gem 'grape'
-gem 'grape-rabl'
-```
-
-And then execute:
-
-    $ bundle
-
-## Usage
-
-### Setup view root directory
-
-```ruby
-# config.ru
-use Rack::Config do |env|
-  env['api.tilt.root'] = '/path/to/view/root/directory'
-end
-```
-
-### Tell your API to use Grape::Formatter::Rabl
-
-```ruby
-class API < Grape::API
-  format :json
-  formatter :json, Grape::Formatter::Rabl
-end
-```
-
-### Use rabl templates conditionally
-
-Add the template name to the API options.
-
-```ruby
-get "/user/:id", :rabl => "user.rabl" do
-  @user = User.find(params[:id])
-end
-```
-
-You can use instance variables in the Rabl template.
-
-```ruby
-object @user => :user
-attributes :name, :email
-
-child @project => :project do
-  attributes :name
-end
-```
-
-### Use rabl layout
-
-Gape-rabl first looks for a layout file in `#{env['api.tilt.root']}/layouts/application.rabl`.
-
-You can override the default layout conventions:
-
-```ruby
-# config.ru
-use Rack::Config do |env|
-  env['api.tilt.root'] = '/path/to/view/root/directory'
-  env['api.tilt.layout'] = 'layouts/another'
-end
-```
-
-### Enable template caching
-
-Grape-rabl allows for template caching after templates are loaded initially.
-
-You can enable template caching:
-
-```ruby
-# config.ru
-Grape::Rabl.configure do |config|
-  config.cache_template_loading = true # default: false
-end
-```
-
-## You can omit .rabl
-
-The following are identical.
-
-```ruby
-get "/home", :rabl => "view"
-get "/home", :rabl => "view.rabl"
-```
-
-### Example
-
-```ruby
-# config.ru
-use Rack::Config do |env|
-  env['api.tilt.root'] = '/path/to/view/root/directory'
-end
-
-class UserAPI < Grape::API
-  format :json
-  formatter :json, Grape::Formatter::Rabl
-
-  get '/user/:id' do
-    @user = User.find(params[:id])
-
-    # use rabl with 'user.rabl' or 'admin.rabl' template
-    if @user.admin?
-      # pass locals with the #render method
-      render rabl: 'admin', locals: { details: 'this user is an admin' }
-    else
-      render rabl: 'user'
-    end
-  end
-
-  get '/admin/:id', :rabl => 'admin' do
-    @user = User.find(params[:id])
-
-    # use rabl with 'super_admin.rabl'
-    render rabl: 'super_admin' if @user.super_admin?
-    # when render method has not been used use template from endpoint definition
-  end
-
-  # use rabl with 'user_history.rabl' template
-  get '/user/:id/history', :rabl => 'user_history' do
-    @history = User.find(params[:id]).history
-  end
-
-  # do not use rabl, fallback to the defalt Grape JSON formatter
-  get '/users' do
-    User.all
-  end
-end
-```
-
-```ruby
-# user.rabl
-object @user => :user
-
-attributes :name
-```
-
-## Usage with rails
-
-Create grape application
-
-```ruby
-# app/api/user.rb
-class MyAPI < Grape::API
-  format :json
-  formatter :json, Grape::Formatter::Rabl
-  get '/user/:id', :rabl => "user" do
-    @user = User.find(params[:id])
-  end
-end
-```
-
-```ruby
-# app/views/api/user.rabl
-object @user => :user
-```
-
-Edit your **config/application.rb** and add view path
-
-```ruby
-# application.rb
-class Application < Rails::Application
-  config.middleware.use(Rack::Config) do |env|
-    env['api.tilt.root'] = Rails.root.join "app", "views", "api"
-  end
-end
-```
-
-Mount application to rails router
-
-```ruby
-# routes.rb
-GrapeExampleRails::Application.routes.draw do
-  mount MyAPI , :at => "/api"
-end
-```
-
-## Specs
-
-See ["Writing Tests"](https://github.com/intridea/grape#writing-tests) in [https://github.com/intridea/grape](grape) README.
-
-Enjoy :)
-
-## Contributing
-
-See [CONTRIBUTING](CONTRIBUTING.md).
-
-[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/ruby-grape/grape-rabl/trend.png)](https://bitdeli.com/free "Bitdeli Badge")
-
+# Grape::Rabl
+
+Use [Rabl](https://github.com/nesquena/rabl) templates in [Grape](https://github.com/ruby-grape/grape)!
+
+[![Gem Version](https://img.shields.io/gem/v/grape-rabl.svg)](https://rubygems.org/gems/grape-rabl)
+[![Build Status](https://github.com/ruby-grape/grape-rabl/actions/workflows/test.yml/badge.svg?branch=master&event=push)](https://github.com/ruby-grape/grape-rabl/actions/workflows/test.yml?query=branch%3Amaster)
+[![Coverage Status](https://coveralls.io/repos/github/ruby-grape/grape-rabl/badge.svg?branch=master)](https://coveralls.io/github/ruby-grape/grape-rabl?branch=master)
+
+# Table of Contents
+
+- [Installation](#installation)
+- [Upgrading](#upgrading)
+- [Usage](#usage)
+  - [Setup view root directory](#setup-view-root-directory)
+  - [Configure request-aware view roots](#configure-request-aware-view-roots)
+  - [Tell your API to use Grape::Formatter::Rabl](#tell-your-api-to-use-grapeformatterrabl)
+  - [Use rabl templates conditionally](#use-rabl-templates-conditionally)
+  - [Use rabl layout](#use-rabl-layout)
+  - [Enable template caching](#enable-template-caching)
+- [You can omit .rabl](#you-can-omit-rabl)
+  - [Example](#example)
+- [Usage with rails](#usage-with-rails)
+- [Swagger documentation](#swagger-documentation)
+- [Specs](#specs)
+- [Contributing](#contributing)
+
+## Installation
+
+Requires Ruby 2.7 or newer. CI covers Grape 1.x, 2.x, 3.x, and 4.x; Grape 3.x and 4.x are tested on Ruby 3.3 and newer. Grape 1.x requires Rack 2.x.
+
+Add the `grape` and `grape-rabl` gems to Gemfile.
+
+```ruby
+gem 'grape'
+gem 'grape-rabl'
+```
+
+And then execute:
+
+    $ bundle
+
+## Upgrading
+
+See [UPGRADING](UPGRADING.md).
+
+## Usage
+
+### Setup view root directory
+
+```ruby
+# config.ru
+use Rack::Config do |env|
+  env['api.tilt.root'] = '/path/to/view/root/directory'
+end
+```
+
+### Configure request-aware view roots
+
+Instead of setting a root with middleware, configure a static directory or a zero-argument Proc/lambda:
+
+```ruby
+Grape::Rabl.configure do |config|
+  config.tilt_root = -> { File.join('/path/to/views', env['api.version'].to_s) }
+end
+```
+
+The Proc runs in the current Grape endpoint's context, so it can access `env`, `params`, and API helpers. The example uses `/path/to/views/v1` for version `v1` and `/path/to/views` for an unversioned request. Version directories are opt-in: a static `config.tilt_root` or existing `env['api.tilt.root']` is used unchanged.
+
+An explicit `env['api.tilt.root']` takes precedence over the configured root, and the Proc is not called in that case. Resolution happens only when rendering a Rabl template; the resolved root is stored in the request environment, not back into configuration. Templates, partials, and layouts use that root, and cached templates remain separated by resolved directory and format. Resolver exceptions propagate; returning `nil` or `false` raises the missing-root configuration error.
+
+### Tell your API to use Grape::Formatter::Rabl
+
+```ruby
+class API < Grape::API
+  format :json
+  formatter :json, Grape::Formatter::Rabl
+end
+```
+
+### Use rabl templates conditionally
+
+Add the template name to the API options.
+
+```ruby
+get "/user/:id", :rabl => "user.rabl" do
+  @user = User.find(params[:id])
+end
+```
+
+You can use instance variables in the Rabl template.
+
+```ruby
+object @user => :user
+attributes :name, :email
+
+child @project => :project do
+  attributes :name
+end
+```
+
+### Use rabl layout
+
+Gape-rabl first looks for a layout file in `#{env['api.tilt.root']}/layouts/application.rabl`.
+
+You can override the default layout conventions:
+
+```ruby
+# config.ru
+use Rack::Config do |env|
+  env['api.tilt.root'] = '/path/to/view/root/directory'
+  env['api.tilt.layout'] = 'layouts/another'
+end
+```
+
+### Enable template caching
+
+Grape-rabl allows for template caching after templates are loaded initially.
+
+Template creation and cache lookups are synchronized across requests, including cached missing layouts. Caching does not depend on the deprecated `Tilt::Cache` class. Disable caching during development if templates need to reload after changes.
+
+You can enable template caching:
+
+```ruby
+# config.ru
+Grape::Rabl.configure do |config|
+  config.cache_template_loading = true # default: false
+end
+```
+
+## You can omit .rabl
+
+The following are identical.
+
+```ruby
+get "/home", :rabl => "view"
+get "/home", :rabl => "view.rabl"
+```
+
+### Example
+
+```ruby
+# config.ru
+use Rack::Config do |env|
+  env['api.tilt.root'] = '/path/to/view/root/directory'
+end
+
+class UserAPI < Grape::API
+  format :json
+  formatter :json, Grape::Formatter::Rabl
+
+  get '/user/:id' do
+    @user = User.find(params[:id])
+
+    # use rabl with 'user.rabl' or 'admin.rabl' template
+    if @user.admin?
+      # pass locals with the #render method
+      render rabl: 'admin', locals: { details: 'this user is an admin' }
+    else
+      render rabl: 'user'
+    end
+  end
+
+  get '/admin/:id', :rabl => 'admin' do
+    @user = User.find(params[:id])
+
+    # use rabl with 'super_admin.rabl'
+    render rabl: 'super_admin' if @user.super_admin?
+    # when render method has not been used use template from endpoint definition
+  end
+
+  # use rabl with 'user_history.rabl' template
+  get '/user/:id/history', :rabl => 'user_history' do
+    @history = User.find(params[:id]).history
+  end
+
+  # do not use rabl, fallback to the default Grape response formatter
+  get '/users' do
+    User.all
+  end
+end
+```
+
+```ruby
+# user.rabl
+object @user => :user
+
+attributes :name
+```
+
+## Usage with rails
+
+Create grape application
+
+```ruby
+# app/api/user.rb
+class MyAPI < Grape::API
+  format :json
+  formatter :json, Grape::Formatter::Rabl
+  get '/user/:id', :rabl => "user" do
+    @user = User.find(params[:id])
+  end
+end
+```
+
+```ruby
+# app/views/api/user.rabl
+object @user => :user
+```
+
+Edit your **config/application.rb** and add view path
+
+```ruby
+# application.rb
+class Application < Rails::Application
+  config.middleware.use(Rack::Config) do |env|
+    env['api.tilt.root'] = Rails.root.join "app", "views", "api"
+  end
+end
+```
+
+Mount application to rails router
+
+```ruby
+# routes.rb
+GrapeExampleRails::Application.routes.draw do
+  mount MyAPI , :at => "/api"
+end
+```
+
+## Swagger documentation
+
+Use [grape-swagger](https://github.com/ruby-grape/grape-swagger) to generate Swagger/OpenAPI 2.0 documentation. Rabl still renders the responses: Swagger does not infer a response schema by executing a template or reading its Ruby code.
+
+One option is to define documentation-only entities with the optional [grape-swagger-entity](https://github.com/ruby-grape/grape-swagger-entity) parser. Add these gems to your application's Gemfile, choosing versions compatible with your Grape version:
+
+```ruby
+gem 'grape-rabl'
+gem 'grape-entity'
+gem 'grape-swagger'
+gem 'grape-swagger-entity'
+```
+
+Load the parser before generating documentation. For example, with an application-provided `User` model:
+
+```ruby
+# config.ru
+require 'grape/rabl'
+require 'grape-swagger'
+require 'grape-swagger/entity'
+
+class UserFields < Grape::Entity
+  expose :id, documentation: { type: Integer }
+  expose :name, documentation: { type: String }
+end
+
+class UserResponse < Grape::Entity
+  expose :user, using: UserFields
+end
+
+class API < Grape::API
+  format :json
+  formatter :json, Grape::Formatter::Rabl
+
+  desc 'Return a user', success: UserResponse
+  get '/users/:id', rabl: 'user' do
+    @user = User.find(params[:id])
+  end
+
+  add_swagger_documentation
+end
+
+use Rack::Config do |env|
+  env['api.tilt.root'] = File.expand_path('views', __dir__)
+end
+run API
+```
+
+```ruby
+# views/user.rabl
+object @user => :user
+attributes :id, :name
+```
+
+`GET /users/1` returns a Rabl-rendered response such as `{ "user": { "id": 1, "name": "Jane" } }`. `GET /swagger_doc` returns the documentation, with the endpoint's success response referencing `UserResponse` and its nested `UserFields` definition.
+
+The entities describe the output only; do not call `present` or replace the Rabl formatter with an Entity formatter. `success: UserResponse` selects the documented schema, not the response serializer. Documentation endpoints have no Rabl template and use the normal JSON fallback.
+
+Keep the schema aligned with the actual template, including root envelopes, collections, layouts, partials, and conditional fields. These are not inferred from Rabl automatically. For a schema system other than Entity, use grape-swagger's [custom model parser interface](https://github.com/ruby-grape/grape-swagger#custom-model-parsers). None of these documentation dependencies is required for normal Rabl rendering.
+
+## Specs
+
+Spec runs generate `coverage/lcov/grape-rabl.lcov` with SimpleCov. CI merges coverage from every stable Ruby/Grape matrix job in Coveralls using the built-in GitHub token; ruby-head remains experimental and does not publish coverage.
+
+See ["Writing Tests"](https://github.com/ruby-grape/grape#writing-tests) in [grape](https://github.com/ruby-grape/grape) README.
+
+Enjoy :)
+
+## Contributing
+
+See [CONTRIBUTING](CONTRIBUTING.md).

data/RELEASING.md

@@ -1,64 +1,79 @@
 # Releasing Grape-Rabl
 
-There're no particular rules about when to release grape-rabl. Release bug fixes frequently, features not so frequently and breaking API changes rarely.
+Release bug fixes frequently, features less frequently, and breaking API changes deliberately. Publishing requires repository push access, RubyGems ownership, and RubyGems multi-factor authentication.
 
-### Release
+## Prepare the release
 
-Run tests, check that all tests succeed locally.
+Use a clean checkout whose `origin` points to the canonical `ruby-grape/grape-rabl` repository, not a fork:
 
+```sh
+git remote get-url origin
+git switch master
+git pull --ff-only origin master
+git status --short
 ```
-bundle install
-rake
-```
-
-Check that the last build succeeded in [Travis CI](https://travis-ci.org/ruby-grape/grape-rabl) for all supported platforms.
 
-Increment the version, modify [lib/grape-rabl/version.rb](lib/grape-rabl/version.rb).
+Update `Grape::Rabl::VERSION` in [lib/grape-rabl/version.rb](lib/grape-rabl/version.rb). Increment the patch version for fixes and the minor version for new features or breaking changes while the gem is below 1.0.
 
-*  Increment the third number if the release has bug fixes and/or very minor features, only (eg. change `0.7.1` to `0.7.2`).
-*  Increment the second number if the release contains major features or breaking API changes (eg. change `0.7.1` to `0.8.0`).
+Replace `(Next)` in [CHANGELOG.md](CHANGELOG.md) with the version and release date, remove `Your contribution here.`, and keep entries contiguous with a single blank line between release sections:
 
-Change "Next Release" in [CHANGELOG.md](CHANGELOG.md) to the new version.
+```markdown
+#### 0.6.0 (2026-10-27)
 
+* Release entry.
 ```
-### 0.7.2 (February 6, 2014)
-```
-
-Remove the line with "Your contribution here.", since there will be no more contributions to this release.
 
-Commit your changes.
+Resolve dependencies if necessary and run the existing lint and spec tasks:
 
+```sh
+bundle install
+bundle exec rake
 ```
-git add CHANGELOG.md lib/grape-rabl/version.rb
-git commit -m "Preparing for release, 0.7.2."
+
+Commit and push the release preparation:
+
+```sh
+git add CHANGELOG.md RELEASING.md lib/grape-rabl/version.rb
+git commit -m "Prepare grape-rabl 0.6.0"
 git push origin master
 ```
 
-Release.
+Wait for the [GitHub Actions test workflow](https://github.com/ruby-grape/grape-rabl/actions/workflows/test.yml) to pass for that exact commit. The test matrix covers the supported Ruby/Grape combinations, including an experimental ruby-head job. If using a release-preparation PR, also require its Danger checks to pass; Danger does not run on direct pushes to `master`. Review the minimum Ruby requirement and other compatibility changes before publishing.
 
-```
-$ rake release
+## Publish
 
-grape-rabl 0.7.2 built to pkg/grape-rabl-0.7.2.gem.
-Tagged v0.7.2.
-Pushed git commits and tags.
-Pushed grape-rabl 0.7.2 to rubygems.org.
+Confirm that the version is not already published and that the worktree is clean. From the canonical checkout, Bundler's release task builds the gem, creates and pushes the version tag, and publishes to RubyGems:
+
+```sh
+bundle exec rake release
 ```
 
-### Prepare for the Next Version
+Supply a fresh RubyGems one-time password when requested. Never put credentials or one-time passwords in repository files. If publishing fails after the tag was pushed, diagnose the failure and resume with `gem push pkg/grape-rabl-0.6.0.gem`; do not move an existing release tag.
 
-Add the next release to [CHANGELOG.md](CHANGELOG.md).
+Verify that the RubyGems version, gem checksum, and remote tag match the artifact and release commit:
 
+```sh
+gem specification pkg/grape-rabl-0.6.0.gem version
+shasum -a 256 pkg/grape-rabl-0.6.0.gem
+curl --fail https://rubygems.org/api/v2/rubygems/grape-rabl/versions/0.6.0.json
+git ls-remote origin 'refs/tags/v0.6.0*'
 ```
-#### Next
 
-* Your contribution here.
+Create a non-draft GitHub release from the existing tag using the matching changelog section as its release notes:
+
+```sh
+gh release create v0.6.0 --repo ruby-grape/grape-rabl \
+  --verify-tag --title "grape-rabl 0.6.0" --notes-file /path/to/release-notes.txt
 ```
 
-Commit your changes.
+## Prepare the next development version
 
+After confirming publication, bump the version to the next patch development iteration and add an empty changelog section:
+
+```markdown
+#### (Next)
+
+* Your contribution here.
 ```
-git add CHANGELOG.md
-git commit -m "Preparing for next development iteration, 0.7.3."
-git push origin master
-```
+
+For example, after releasing 0.6.0, set the version to `0.6.1`, commit the version and changelog changes, and push `master` normally. Never force-push `master` or overwrite a published gem or release tag.

data/Rakefile

@@ -1,4 +1,6 @@
 #!/usr/bin/env rake
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 
 require 'rspec/core'
@@ -11,4 +13,4 @@ end
 require 'rubocop/rake_task'
 RuboCop::RakeTask.new(:rubocop)
 
-task default: [:rubocop, :spec]
+task default: %i[rubocop spec]