grape-rabl 0.4.3 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 8192a5ce63fc8fcde53a8948ad61e8b659f1e4b7
-  data.tar.gz: d10abacc60cfc20af4679e18302cbe2d2cdb1220
+SHA256:
+  metadata.gz: 2139e066606a02ff9f13f498209f8b67b9edee1f17aa6765b0cdd0f304bf16e6
+  data.tar.gz: 3f026c83de19ed9c97ec5169dda8e4e9a7c52e5f977befa61a085ef3df07767b
 SHA512:
-  metadata.gz: ea70396b25b43e9ca3daa526679c86989fef25b014ae9683048d2b17ad57ef82f5459ea17667c85a546b03b75c6b2f13c06a95cb029f1527e632496cf5eacbd7
-  data.tar.gz: 3ef3faaa10a3f10bb83f2b68fe3fb00ebccae89e450a49e9c1912bdd58dd93711906e40abea81e431edae320b8694a8cb7b2022ad077906f42f383764ab81628
+  metadata.gz: a468e3a080bc6485c48ad71066d2dab882b2541e579cfe8bea3e644b1118bf91e1400184d03ed3d29ff01062449cf85e034aa9f7a56b0ebeedfb4d5c05c5565d
+  data.tar.gz: 49b59dfc17187e747844c375cfbf1d805f0158786141a8910516f0945108171475c11ffc31d7788ad59fd80c7650abefbf519e12437cd8bc3b25e1378b8d7413

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2016-06-08 16:00:13 -0400 using RuboCop version 0.40.0.
+# on 2017-11-17 09:51:46 -0500 using RuboCop version 0.51.0.
 # 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
@@ -11,8 +11,13 @@ Lint/RescueException:
   Exclude:
     - 'spec/grape_rabl_spec.rb'
 
-# Offense count: 21
-# Configuration parameters: AllowHeredoc, AllowURI, URISchemes.
+# Offense count: 8
+# Configuration parameters: CountComments, ExcludedMethods.
+Metrics/BlockLength:
+  Max: 169
+
+# Offense count: 23
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
 # URISchemes: http, https
 Metrics/LineLength:
   Max: 148
@@ -22,6 +27,13 @@ Metrics/LineLength:
 Metrics/MethodLength:
   Max: 13
 
+# Offense count: 1
+# Configuration parameters: ExpectMatchingDefinition, Regex, IgnoreExecutableScripts, AllowedAcronyms.
+# 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
 Style/Documentation:
   Exclude:
@@ -38,12 +50,6 @@ Style/DoubleNegation:
   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:

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+#### v0.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).
+
 #### v0.4.3
 
 * [#44](https://github.com/ruby-grape/grape-rabl/issues/44): Don't require unused hashie - [@tsuwatch](https://github.com/tsuwatch).

data/Gemfile

@@ -3,15 +3,15 @@ source 'https://rubygems.org'
 gemspec
 
 group :development do
-  gem 'rubocop', '0.40.0'
+  gem 'rubocop', '0.51.0'
 end
 
 group :test do
+  gem 'coveralls', require: false
   gem 'json'
-  gem 'rspec'
+  gem 'rabl'
   gem 'rack-test'
   gem 'rake'
-  gem 'coveralls', require: false
-  gem 'rabl'
+  gem 'rspec'
   gem 'ruby-grape-danger', '~> 0.1.1', require: false
 end

data/README.md

@@ -1,10 +1,9 @@
 # Grape::Rabl
 
-Use [Rabl](https://github.com/nesquena/rabl) templates in [Grape](https://github.com/intridea/grape)!
+Use [Rabl](https://github.com/nesquena/rabl) templates in [Grape](https://github.com/ruby-grape/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)
 
@@ -21,6 +20,10 @@ And then execute:
 
     $ bundle
 
+## Upgrading
+
+See [UPGRADING](UPGRADING.md).
+
 ## Usage
 
 ### Setup view root directory
@@ -135,7 +138,7 @@ class UserAPI < Grape::API
     @history = User.find(params[:id]).history
   end
 
-  # do not use rabl, fallback to the defalt Grape JSON formatter
+  # do not use rabl, fallback to the default Grape response formatter
   get '/users' do
     User.all
   end
@@ -191,13 +194,10 @@ end
 
 ## Specs
 
-See ["Writing Tests"](https://github.com/intridea/grape#writing-tests) in [https://github.com/intridea/grape](grape) README.
+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).
-
-[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/ruby-grape/grape-rabl/trend.png)](https://bitdeli.com/free "Bitdeli Badge")
-

data/Rakefile

@@ -11,4 +11,4 @@ end
 require 'rubocop/rake_task'
 RuboCop::RakeTask.new(:rubocop)
 
-task default: [:rubocop, :spec]
+task default: %i[rubocop spec]

data/UPGRADING.md

@@ -0,0 +1,32 @@
+# Upgrading Grape::Rabl
+
+## 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,8 @@
-# -*- encoding: utf-8 -*-
+
 require File.expand_path('../lib/grape-rabl/version', __FILE__)
 
 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'
@@ -17,7 +17,7 @@ Gem::Specification.new do |gem|
   gem.required_ruby_version = '>= 2.2.0'
 
   gem.add_dependency 'grape'
+  gem.add_dependency 'i18n'
   gem.add_dependency 'rabl'
   gem.add_dependency 'tilt'
-  gem.add_dependency 'i18n'
 end

data/lib/grape-rabl/formatter.rb

@@ -29,12 +29,18 @@ 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])
+      end
+
       def view_path(template)
         if template.split('.')[-1] == 'rabl'
           File.join(env['api.tilt.root'], template)

data/lib/grape-rabl/version.rb

@@ -1,5 +1,5 @@
 module Grape
   module Rabl
-    VERSION = '0.4.3'.freeze
+    VERSION = '0.5.0'.freeze
   end
 end

data/spec/grape_rabl_formatter_spec.rb

@@ -0,0 +1,84 @@
+require 'spec_helper'
+
+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=>["bad", "things", "happened"]}')
+        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/views/_partial.rabl

@@ -1 +1 @@
-attributes :type
+attributes :type

data/spec/views/admin.rabl

@@ -1,6 +1,6 @@
 object @user => :admin
 attributes :name
 
-node :details, :unless => lambda { |n| locals[:details].nil? } do |m|
+node :details, unless: ->(_n) { locals[:details].nil? } do |_m|
   locals[:details]
 end

data/spec/views/info.rabl

@@ -1 +1 @@
-attributes :author
+attributes :author

data/spec/views/project.rabl

@@ -2,9 +2,9 @@ object @project => :project
 attributes :name
 
 node :info do
-  partial "partial", object: @project.type
+  partial 'partial', object: @project.type
 end
 
 child @author => :author do
-  extends "info"
-end
+  extends 'info'
+end

data/spec/views/user.rabl

@@ -5,6 +5,6 @@ child @project => :project do
   attributes :name
 end
 
-node :details, :unless => lambda { |n| locals[:details].nil? } do |m|
+node :details, unless: ->(_n) { locals[:details].nil? } do |_m|
   locals[:details]
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape-rabl
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.5.0
 platform: ruby
 authors:
 - Piotr Niełacny
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-17 00:00:00.000000000 Z
+date: 2019-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grape
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rabl
+  name: i18n
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -39,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: tilt
+  name: rabl
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: i18n
+  name: tilt
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -87,6 +87,7 @@ files:
 - README.md
 - RELEASING.md
 - Rakefile
+- UPGRADING.md
 - grape-rabl.gemspec
 - lib/grape-rabl.rb
 - lib/grape-rabl/configuration.rb
@@ -96,6 +97,7 @@ files:
 - lib/grape-rabl/version.rb
 - lib/grape/rabl.rb
 - spec/grape_rabl_configuration.rb
+- spec/grape_rabl_formatter_spec.rb
 - spec/grape_rabl_layout_spec.rb
 - spec/grape_rabl_partials_spec.rb
 - spec/grape_rabl_spec.rb
@@ -129,13 +131,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Use rabl in grape
 test_files:
 - spec/grape_rabl_configuration.rb
+- spec/grape_rabl_formatter_spec.rb
 - spec/grape_rabl_layout_spec.rb
 - spec/grape_rabl_partials_spec.rb
 - spec/grape_rabl_spec.rb