grape-rabl 0.4.3 → 0.6.0

data/UPGRADING.md

@@ -0,0 +1,36 @@
+# Upgrading Grape::Rabl
+
+## Upgrading to the next release
+
+Ruby 2.7 or newer is required. Grape 1.x through 4.x are covered by CI, with Grape 3.x and 4.x tested on Ruby 3.3 and newer. Applications on Grape 1.x must use Rack 2.x.
+
+## Upgrading to >= 0.5
+
+### Fallback rendering when no RABL template is defined
+
+Prior to v0.5.0, Grape::Rabl would always render content as JSON when no Rabl template was specified for a request. Beginning in v0.5.0 Grape::Rabl will now fallback to using the default response format [as determined by Grape](https://github.com/ruby-grape/grape#api-formats)
+
+```ruby
+class SampleApi < Grape::API
+  format :xml
+  formatter :xml, Grape::Formatter::Rabl
+
+  get 'list' do
+    %w[thing]
+  end
+end
+```
+
+#### Former behavior
+
+```ruby
+response.body # => ["thing"]
+```
+
+#### Current behavior
+
+```ruby
+response.body # => <?xml version="1.0" encoding="UTF-8"?>\n<strings type="array">\n  <string>thing</string>\n</strings>
+```
+
+See [#34](https://github.com/ruby-grape/grape-rabl/pull/34) for more information.

data/grape-rabl.gemspec

@@ -1,8 +1,9 @@
-# -*- encoding: utf-8 -*-
-require File.expand_path('../lib/grape-rabl/version', __FILE__)
+# frozen_string_literal: true
+
+require File.expand_path('lib/grape-rabl/version', __dir__)
 
 Gem::Specification.new do |gem|
-  gem.authors       = ["Piotr Niełacny"]
+  gem.authors       = ['Piotr Niełacny']
   gem.email         = ['piotr.nielacny@gmail.com']
   gem.description   = 'Use rabl in grape'
   gem.summary       = 'Use rabl in grape'
@@ -10,14 +11,14 @@ Gem::Specification.new do |gem|
 
   gem.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
   gem.files         = `git ls-files`.split("\n")
-  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   gem.name          = 'grape-rabl'
   gem.require_paths = ['lib']
   gem.version       = Grape::Rabl::VERSION
-  gem.required_ruby_version = '>= 2.2.0'
+  gem.required_ruby_version = '>= 2.7.0'
 
   gem.add_dependency 'grape'
+  gem.add_dependency 'i18n'
   gem.add_dependency 'rabl'
   gem.add_dependency 'tilt'
-  gem.add_dependency 'i18n'
+  gem.metadata['rubygems_mfa_required'] = 'true'
 end

data/lib/grape/rabl.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'grape-rabl'
 
 module Grape

data/lib/grape-rabl/configuration.rb

@@ -1,10 +1,13 @@
+# frozen_string_literal: true
+
 module Grape
   module Rabl
     class Configuration
-      attr_accessor :cache_template_loading
+      attr_accessor :cache_template_loading, :tilt_root
 
       def initialize
         @cache_template_loading = false
+        @tilt_root = nil
       end
     end
   end

data/lib/grape-rabl/formatter.rb

@@ -1,11 +1,20 @@
+# frozen_string_literal: true
+
 require 'json'
 
 module Grape
   module Rabl
     class Formatter
+      @tilt_cache = {}
+      @tilt_cache_mutex = Mutex.new
+
       class << self
-        def tilt_cache
-          @tilt_cache ||= ::Tilt::Cache.new
+        attr_reader :tilt_cache
+
+        def fetch_cached_template(key)
+          @tilt_cache_mutex.synchronize do
+            tilt_cache.fetch(key) { tilt_cache[key] = yield }
+          end
         end
       end
 
@@ -29,17 +38,23 @@ module Grape
             end
           end
         else
-          Grape::Formatter::Json.call object, env
+          fallback_formatter.call object, env
         end
       end
 
       private
 
+      # Find a formatter to fallback to. `env[Grape::Env::API_FORMAT]` will always be a
+      # valid formatter, otherwise a HTTP 406 error would have already have been thrown
+      def fallback_formatter
+        Grape::Formatter.formatter_for(env[Grape::Env::API_FORMAT], formatters: {})
+      end
+
       def view_path(template)
         if template.split('.')[-1] == 'rabl'
           File.join(env['api.tilt.root'], template)
         else
-          File.join(env['api.tilt.root'], (template + '.rabl'))
+          File.join(env['api.tilt.root'], "#{template}.rabl")
         end
       end
 
@@ -49,6 +64,7 @@ module Grape
 
       def rabl
         raise 'missing rabl template' unless rabl_template
+
         set_view_root unless env['api.tilt.root']
         yield rabl_template
       end
@@ -62,12 +78,18 @@ module Grape
       end
 
       def set_view_root
-        raise "Use Rack::Config to set 'api.tilt.root' in config.ru"
+        root = Grape::Rabl.configuration.tilt_root
+        env['api.tilt.root'] = root.is_a?(Proc) ? endpoint.instance_exec(&root) : root
+        return if env['api.tilt.root']
+
+        raise "Use Rack::Config to set 'api.tilt.root' in config.ru or configure 'tilt_root'"
       end
 
       def tilt_template(template)
         if Grape::Rabl.configuration.cache_template_loading
-          Grape::Rabl::Formatter.tilt_cache.fetch(tilt_cache_key(template)) { ::Tilt.new(view_path(template), tilt_options) }
+          Grape::Rabl::Formatter.fetch_cached_template(tilt_cache_key(template)) do
+            ::Tilt.new(view_path(template), tilt_options)
+          end
         else
           ::Tilt.new(view_path(template), tilt_options)
         end
@@ -80,7 +102,9 @@ module Grape
       def layout_template
         layout_path = view_path(env['api.tilt.layout'] || 'layouts/application')
         if Grape::Rabl.configuration.cache_template_loading
-          Grape::Rabl::Formatter.tilt_cache.fetch(tilt_cache_key(layout_path)) { ::Tilt.new(layout_path, tilt_options) if File.exist?(layout_path) }
+          Grape::Rabl::Formatter.fetch_cached_template(tilt_cache_key(layout_path)) do
+            ::Tilt.new(layout_path, tilt_options) if File.exist?(layout_path)
+          end
         else
           ::Tilt.new(layout_path, tilt_options) if File.exist?(layout_path)
         end

data/lib/grape-rabl/render.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Grape
   module Rabl
     module Render
@@ -9,4 +11,4 @@ module Grape
   end
 end
 
-Grape::Endpoint.send(:include, Grape::Rabl::Render)
+Grape::Endpoint.include Grape::Rabl::Render

data/lib/grape-rabl/tilt.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'tilt'
 
 Rabl.register!

data/lib/grape-rabl/version.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module Grape
   module Rabl
-    VERSION = '0.4.3'.freeze
+    VERSION = '0.6.0'
   end
 end

data/lib/grape-rabl.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rabl'
 require 'grape'
 require 'grape/rabl'

data/spec/grape_rabl_configuration.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe 'Grape::Rabl configuration' do

data/spec/grape_rabl_formatter_spec.rb

@@ -0,0 +1,218 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Grape::Rabl::Formatter do
+  before do
+    hide_const('Tilt::Cache')
+    described_class.tilt_cache.clear
+  end
+
+  after do
+    described_class.tilt_cache.clear
+  end
+
+  it 'reuses a cached template without Tilt::Cache' do
+    template = described_class.fetch_cached_template(:template) { Object.new }
+
+    expect(described_class.fetch_cached_template(:template) { raise 'recompiled' })
+      .to equal(template)
+  end
+
+  it 'memoizes missing layouts' do
+    expect(described_class.fetch_cached_template(:missing) { nil }).to be_nil
+    expect(described_class.fetch_cached_template(:missing) { raise 'looked up again' })
+      .to be_nil
+  end
+
+  it 'creates one cached template for concurrent requests' do
+    threads = 4.times.map do
+      Thread.new do
+        described_class.fetch_cached_template(:concurrent) do
+          sleep 0.01
+          Object.new
+        end
+      end
+    end
+
+    expect(threads.map(&:value).map(&:object_id).uniq.size).to eq(1)
+  end
+end
+
+describe 'configured template roots' do
+  let(:app) { Class.new(Grape::API) }
+  let(:request_root) { nil }
+  let(:root) do
+    lambda {
+      File.join(__dir__, 'views', env['api.version'] == 'v2' ? 'layout_test' : '')
+    }
+  end
+
+  before do
+    Grape::Rabl.configuration.tilt_root = root
+    Grape::Rabl::Formatter.tilt_cache.clear
+    app.version %w[v1 v2], using: :path
+    app.format :json
+    app.formatter :json, Grape::Formatter::Rabl
+    override = request_root
+    app.before { env['api.tilt.root'] = override } if override
+    app.get('/user', rabl: 'user', rabl_locals: { details: 'base template' }) do
+      @user = Struct.new(:name).new('Jane')
+      @project = Struct.new(:name).new('First')
+      @status = 200
+    end
+  end
+
+  after do
+    Grape::Rabl.reset_configuration!
+    Grape::Rabl::Formatter.tilt_cache.clear
+  end
+
+  [false, true].each do |cache|
+    context "with template caching #{cache ? 'enabled' : 'disabled'}" do
+      before do
+        Grape::Rabl.configuration.cache_template_loading = cache
+      end
+
+      it 'resolves templates and layouts per request without leaking roots' do
+        user = { 'user' => { 'name' => 'Jane', 'project' => { 'name' => 'First' } } }
+        base_user = { 'user' => user.fetch('user').merge('details' => 'base template') }
+
+        get '/v1/user'
+        expect(JSON.parse(last_response.body)).to eq(base_user)
+
+        get '/v2/user'
+        expect(JSON.parse(last_response.body)).to eq('status' => 200, 'result' => user)
+
+        get '/v1/user'
+        expect(JSON.parse(last_response.body)).to eq(base_user)
+        expect(Grape::Rabl.configuration.tilt_root).to equal(root)
+      end
+    end
+  end
+
+  context 'a static configured root' do
+    let(:root) { File.join(__dir__, 'views') }
+
+    it 'does not automatically append the API version' do
+      get '/v2/user'
+      expect(JSON.parse(last_response.body)).to have_key('user')
+      expect(last_request.env['api.tilt.root']).to eq(root)
+    end
+  end
+
+  context 'an explicit request root' do
+    let(:root) { -> { raise 'configured root should not run' } }
+    let(:request_root) { File.join(__dir__, 'views') }
+
+    it 'takes precedence over the configured root' do
+      get '/v1/user'
+      expect(JSON.parse(last_response.body)).to have_key('user')
+    end
+  end
+
+  context 'a missing resolved root' do
+    let(:root) { -> {} }
+
+    it 'raises the configuration error' do
+      expect { get '/v1/user' }.to raise_error(RuntimeError, /configure 'tilt_root'/)
+    end
+  end
+
+  context 'a failing root resolver' do
+    let(:root) { -> { raise 'root lookup failed' } }
+
+    it 'propagates the error' do
+      expect { get '/v1/user' }.to raise_error(RuntimeError, 'root lookup failed')
+    end
+
+    it 'does not run when falling back to the default formatter' do
+      app.get('/health') { { healthy: true } }
+      get '/v1/health'
+      expect(JSON.parse(last_response.body)).to eq('healthy' => true)
+    end
+  end
+end
+
+describe 'Grape::Rabl formatter' do
+  subject do
+    Class.new(Grape::API)
+  end
+
+  let(:xml_render) do
+    %(<?xml version="1.0" encoding="UTF-8"?>
+<hash>
+  <errors type="array">
+    <error>bad</error>
+    <error>things</error>
+    <error>happened</error>
+  </errors>
+</hash>
+)
+  end
+
+  def app
+    subject
+  end
+
+  context 'rendering' do
+    context 'when no rabl template is specified' do
+      before do
+        # Grape::API defaults to the following declarations:
+        # content_type :xml, 'application/xml'
+        # content_type :json, 'application/json'
+        # content_type :binary, 'application/octet-stream'
+        # content_type :txt, 'text/plain'
+        # default_format :txt
+        subject.formatter :xml, Grape::Formatter::Rabl
+        subject.formatter :txt, Grape::Formatter::Rabl
+        subject.get('/oops') { { errors: %w[bad things happened] } }
+        expect_any_instance_of(Grape::Rabl::Formatter).to receive(:render).and_call_original
+      end
+
+      it 'falls back to :txt given no other format information' do
+        get '/oops'
+        expect(last_response.body).to eq({ errors: %w[bad things happened] }.to_s)
+        expect(last_response.headers['Content-Type']).to eq('text/plain')
+      end
+
+      it 'falls back to the file extension if it is a valid format' do
+        get '/oops.xml'
+        expect(last_response.body).to eq(xml_render)
+        expect(last_response.headers['Content-Type']).to eq('application/xml')
+      end
+
+      it 'falls back to the value of the `format` parameter in the query string if it is provided' do
+        get '/oops?format=xml'
+        expect(last_response.body).to eq(xml_render)
+        expect(last_response.headers['Content-Type']).to eq('application/xml')
+      end
+
+      it 'falls back to the format set by the `format` option if it is a valid format' do
+        # `format` option must be declared before endpoint
+        subject.format :xml
+        subject.get('/oops/2') { { errors: %w[bad things happened] } }
+
+        get '/oops/2'
+        expect(last_response.body).to eq(xml_render)
+        expect(last_response.headers['Content-Type']).to eq('application/xml')
+      end
+
+      it 'falls back to the `Accept` header if it is a valid format' do
+        get '/oops', {}, 'HTTP_ACCEPT' => 'application/xml'
+        expect(last_response.body).to eq(xml_render)
+        expect(last_response.headers['Content-Type']).to eq('application/xml')
+      end
+
+      it 'falls back to the default_format option if it is a valid format' do
+        # `default_format` option must be declared before endpoint
+        subject.default_format :xml
+        subject.get('/oops/2') { { errors: %w[bad things happened] } }
+
+        get '/oops/2'
+        expect(last_response.body).to eq(xml_render)
+        expect(last_response.headers['Content-Type']).to eq('application/xml')
+      end
+    end
+  end
+end

data/spec/grape_rabl_layout_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe 'Grape::Rabl layout' do
@@ -22,8 +24,8 @@ describe 'Grape::Rabl layout' do
   context 'default' do
     it 'proper render with default layout' do
       subject.get('/about', rabl: 'user') do
-        @user = OpenStruct.new(name: 'LTe')
-        @project = OpenStruct.new(name: 'First')
+        @user = Struct.new(:name).new('LTe')
+        @project = Struct.new(:name).new('First')
         @status = 200
       end
 
@@ -41,8 +43,8 @@ describe 'Grape::Rabl layout' do
 
     it 'proper render with specified layout' do
       subject.get('/about', rabl: 'user') do
-        @user = OpenStruct.new(name: 'LTe')
-        @project = OpenStruct.new(name: 'First')
+        @user = Struct.new(:name).new('LTe')
+        @project = Struct.new(:name).new('First')
         @status = 200
       end
 
@@ -61,8 +63,8 @@ describe 'Grape::Rabl layout' do
       FileUtils.cp_r("#{File.dirname(__FILE__)}/views/layout_test/.", @views_dir)
       subject.before { env['api.tilt.root'] = "#{File.expand_path('..', File.dirname(__FILE__))}/tmp" }
       subject.get('/home', rabl: 'user') do
-        @user = OpenStruct.new(name: 'LTe', email: 'email@example.com')
-        @project = OpenStruct.new(name: 'First')
+        @user = Struct.new(:name, :email).new('LTe', 'email@example.com')
+        @project = Struct.new(:name).new('First')
         @status = 200
       end
     end
@@ -79,7 +81,7 @@ describe 'Grape::Rabl layout' do
       get '/home'
       expect(last_response.status).to eq(200)
       old_response = last_response.body
-      open(@layout, 'a') { |f| f << 'node(:test) { "test" }' }
+      File.open(@layout, 'a') { |f| f << 'node(:test) { "test" }' }
       get '/home'
       expect(last_response.status).to eq(200)
       new_response = last_response.body
@@ -90,7 +92,7 @@ describe 'Grape::Rabl layout' do
       get '/home'
       expect(last_response.status).to eq(200)
       old_response = last_response.body
-      open(@layout, 'a') { |f| f << 'node(:test) { "test" }' }
+      File.open(@layout, 'a') { |f| f << 'node(:test) { "test" }' }
       get '/home'
       expect(last_response.status).to eq(200)
       new_response = last_response.body

data/spec/grape_rabl_partials_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe 'Grape::Rabl partials' do
@@ -19,9 +21,9 @@ describe 'Grape::Rabl partials' do
 
   it 'proper render partials' do
     subject.get('/home', rabl: 'project') do
-      @author   = OpenStruct.new(author: 'LTe')
-      @type     = OpenStruct.new(type: 'paper')
-      @project  = OpenStruct.new(name: 'First', type: @type, author: @author)
+      @author   = Struct.new(:author).new('LTe')
+      @type     = Struct.new(:type).new('paper')
+      @project  = Struct.new(:name, :type, :author).new('First', @type, @author)
     end
 
     get('/home')

data/spec/grape_rabl_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Grape::Rabl do
@@ -23,12 +25,8 @@ describe Grape::Rabl do
   end
 
   it 'should raise error about root directory' do
-    begin
-      subject.get('/home', rabl: true) {}
-      get '/home'
-    rescue Exception => e
-      expect(e.message).to include "Use Rack::Config to set 'api.tilt.root' in config.ru"
-    end
+    subject.get('/home', rabl: true) { nil }
+    expect { get '/home' }.to raise_error(RuntimeError, /Use Rack::Config to set 'api.tilt.root' in config.ru/)
   end
 
   context 'titl root is setup' do
@@ -40,7 +38,7 @@ describe Grape::Rabl do
 
     describe 'helpers' do
       it 'should execute helper' do
-        subject.get('/home', rabl: 'helper') { @user = OpenStruct.new }
+        subject.get('/home', rabl: 'helper') { @user = Object.new }
         get '/home'
         expect(parsed_response).to eq(JSON.parse('{"user":{"helper":"my_helper"}}'))
       end
@@ -49,27 +47,27 @@ describe Grape::Rabl do
     describe '#render' do
       before do
         subject.get('/home', rabl: 'user') do
-          @user = OpenStruct.new(name: 'LTe')
+          @user = Struct.new(:name).new('LTe')
           render rabl: 'admin'
         end
 
         subject.get('/admin/:id', rabl: 'user') do
-          @user = OpenStruct.new(name: 'LTe')
+          @user = Struct.new(:name).new('LTe')
 
           render rabl: 'admin' if params[:id] == '1'
         end
 
         subject.get('/home-detail', rabl: 'user') do
-          @user = OpenStruct.new(name: 'LTe')
+          @user = Struct.new(:name).new('LTe')
           render rabl: 'admin', locals: { details: 'amazing detail' }
         end
 
         subject.get('/about', rabl: 'user') do
-          @user = OpenStruct.new(name: 'LTe')
+          @user = Struct.new(:name).new('LTe')
         end
 
         subject.get('/about-detail', rabl: 'user') do
-          @user = OpenStruct.new(name: 'LTe')
+          @user = Struct.new(:name).new('LTe')
           render locals: { details: 'just a user' }
         end
       end
@@ -112,13 +110,13 @@ describe Grape::Rabl do
     end
 
     it 'should respond with proper content-type' do
-      subject.get('/home', rabl: 'user') {}
+      subject.get('/home', rabl: 'user') { nil }
       get('/home')
       expect(last_response.headers['Content-Type']).to eq('application/json')
     end
 
     it 'should not raise error about root directory' do
-      subject.get('/home', rabl: 'user') {}
+      subject.get('/home', rabl: 'user') { nil }
       get '/home'
       expect(last_response.status).to eq 200
       expect(last_response.body).not_to include "Use Rack::Config to set 'api.tilt.root' in config.ru"
@@ -127,8 +125,8 @@ describe Grape::Rabl do
     ['user', 'user.rabl'].each do |rabl_option|
       it "should render rabl template (#{rabl_option})" do
         subject.get('/home', rabl: rabl_option) do
-          @user = OpenStruct.new(name: 'LTe', email: 'email@example.com')
-          @project = OpenStruct.new(name: 'First')
+          @user = Struct.new(:name, :email).new('LTe', 'email@example.com')
+          @project = Struct.new(:name).new('First')
         end
 
         get '/home'
@@ -143,8 +141,8 @@ describe Grape::Rabl do
         FileUtils.cp("#{File.dirname(__FILE__)}/views/user.rabl", @template)
         subject.before { env['api.tilt.root'] = "#{File.expand_path('..', File.dirname(__FILE__))}/tmp" }
         subject.get('/home', rabl: 'user') do
-          @user = OpenStruct.new(name: 'LTe', email: 'email@example.com')
-          @project = OpenStruct.new(name: 'First')
+          @user = Struct.new(:name, :email).new('LTe', 'email@example.com')
+          @project = Struct.new(:name).new('First')
         end
       end
 
@@ -160,7 +158,7 @@ describe Grape::Rabl do
         get '/home'
         expect(last_response.status).to eq(200)
         old_response = last_response.body
-        open(@template, 'a') { |f| f << 'node(:test) { "test" }' }
+        File.open(@template, 'a') { |f| f << 'node(:test) { "test" }' }
         get '/home'
         expect(last_response.status).to eq(200)
         new_response = last_response.body
@@ -178,7 +176,7 @@ describe Grape::Rabl do
         expect(last_response.status).to eq(200)
         xml_response = last_response.body
         expect(json_response).not_to eq(xml_response)
-        open(@template, 'a') { |f| f << 'node(:test) { "test" }' }
+        File.open(@template, 'a') { |f| f << 'node(:test) { "test" }' }
         get '/home.xml'
         expect(last_response.status).to eq(200)
         expect(last_response.body).to eq(xml_response)
@@ -191,7 +189,7 @@ describe Grape::Rabl do
         get '/home'
         expect(last_response.status).to eq(200)
         old_response = last_response.body
-        open(@template, 'a') { |f| f << 'node(:test) { "test" }' }
+        File.open(@template, 'a') { |f| f << 'node(:test) { "test" }' }
         get '/home'
         expect(last_response.status).to eq(200)
         new_response = last_response.body

data/spec/grape_rabl_xml_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Grape::Rabl do
@@ -23,7 +25,7 @@ describe Grape::Rabl do
     end
 
     it 'should respond with proper content-type' do
-      subject.get('/home', rabl: 'user') {}
+      subject.get('/home', rabl: 'user') { nil }
       get('/home')
       expect(last_response.headers['Content-Type']).to eq('application/xml')
     end
@@ -31,8 +33,8 @@ describe Grape::Rabl do
     ['user', 'user.rabl'].each do |rabl_option|
       it "should render rabl template (#{rabl_option})" do
         subject.get('/home', rabl: rabl_option) do
-          @user = OpenStruct.new(name: 'LTe', email: 'email@example.com')
-          @project = OpenStruct.new(name: 'First')
+          @user = Struct.new(:name, :email).new('LTe', 'email@example.com')
+          @project = Struct.new(:name).new('First')
         end
 
         get '/home'