grape-jbuilder 0.1.0 → 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6ba4826d37afc59462d6f7fe3b6ed36ee801e0b9
+  data.tar.gz: 5656897b9154ae71e56bee5ab1cb458f932dbb16
+SHA512:
+  metadata.gz: a0967132a6118476b59d6673befe9704a1f81a44062d7ad0d0244ddaaa1d79ddd9b6884281e0671fe66499c3b8d410e303e934d15498b29736b332e97265a11d
+  data.tar.gz: 34ec154af6909af5a2db3d43b1624de6c280ac3573759f3219665be04094a0ab96a288fdc40b15c11afb2ca4e9bb6b9097ee6d707a203a8ca2472d6bdf33ff9d

data/.travis.yml

@@ -1,9 +1,5 @@
 rvm:
-  - 1.9.2
   - 1.9.3
   - 2.0.0
-  - ruby-head
-  - rbx-19mode
-
-env:
-  - JRUBY_OPTS="--1.9"
+  - 2.1.0
+  - 2.1.1

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+0.2.0
+=====
+
+* [#4](https://github.com/milkcocoa/grape-jbuilder/pull/4) Shifting rendering into a separate class, to support dynamic changing of templates within the logic of a Grape endpoint.
+* [#4](https://github.com/milkcocoa/grape-jbuilder/pull/4) Drop support MRI 1.9.2.
+* Support MRI 2.1.1.
+
+0.1.0
+=====
+
+* Initial commit.
+

data/README.md

@@ -53,7 +53,7 @@ end
 Add the template name to the API options.
 
 ```ruby
-get '/user/:id', :jbuilder => 'user.jbuilder' do
+get '/user/:id', jbuilder: 'user.jbuilder' do
   @user = User.find(params[:id])
 end
 ```
@@ -69,6 +69,21 @@ json.user do
 end
 ```
 
+### Use Jbuilder templates dynamically
+
+```ruby
+get ':id' do
+  user = User.find_by(id: params[:id])
+  if article
+    env['api.tilt.template'] = 'users/show'
+    env['api.tilt.locals']   = {user: user}
+  else
+    status 404
+    {'status' => 'Not Found', 'errors' => "User id '#{params[:id]}' is not found."}
+  end
+end
+```
+
 ## You can omit .jbuilder
 
 The following are identical.

data/grape-jbuilder.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["masushu@gmail.com"]
   spec.description   = %q{Use Jbuilder in Grape}
   spec.summary       = %q{Use Jbuilder in Grape}
-  spec.homepage      = ""
+  spec.homepage      = "https://github.com/milkcocoa/grape-jbuilder"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)

data/lib/grape/formatter/jbuilder.rb

@@ -0,0 +1,38 @@
+module Grape
+  module Formatter
+    class Jbuilder
+      attr_reader :env, :endpoint, :object
+
+      def self.call(object, env)
+        new(object, env).call
+      end
+
+      def initialize(object, env)
+        @object, @env = object, env
+        @endpoint     = env['api.endpoint']
+      end
+
+      def call
+        return Grape::Formatter::Json.call(object, env) unless template?
+
+        Grape::Jbuilder::Renderer.new(env['api.tilt.root'], template).
+          render(endpoint, locals)
+      end
+
+      private
+
+      def locals
+        env['api.tilt.locals'] || {}
+      end
+
+      def template
+        env['api.tilt.template'] ||
+        endpoint.options.fetch(:route_options, {})[:jbuilder]
+      end
+
+      def template?
+        !!template
+      end
+    end
+  end
+end

data/lib/grape/jbuilder.rb

@@ -3,5 +3,7 @@ require 'hashie/hash'
 require 'jbuilder'
 require 'tilt'
 require 'tilt/jbuilder.rb'
-require 'grape/jbuilder/formatter'
+
+require 'grape/formatter/jbuilder'
+require 'grape/jbuilder/renderer'
 require 'grape/jbuilder/version'

data/lib/grape/jbuilder/renderer.rb

@@ -0,0 +1,30 @@
+module Grape
+  module Jbuilder
+    class Renderer
+      def initialize(view_path, template)
+        @view_path, @template = view_path, template
+      end
+
+      def render(scope, locals = {})
+        unless view_path
+          raise "Use Rack::Config to set 'api.tilt.root' in config.ru"
+        end
+
+        engine = ::Tilt.new file, nil, view_path: view_path
+        engine.render scope, locals
+      end
+
+      private
+
+      attr_reader :view_path, :template
+
+      def file
+        File.join view_path, template_with_extension
+      end
+
+      def template_with_extension
+        template[/\.jbuilder$/] ? template : "#{template}.jbuilder"
+      end
+    end
+  end
+end

data/lib/grape/jbuilder/version.rb

@@ -1,5 +1,5 @@
 module Grape
   module Jbuilder
-    VERSION = "0.1.0"
+    VERSION = '0.2.0'
   end
 end

data/spec/{grape_jbuilder_partials_spec.rb → acceptance/partials_spec.rb}

@@ -1,22 +1,18 @@
 require 'spec_helper'
 
 describe 'Grape::Jbuilder partials' do
-  subject do
-    Class.new(Grape::API)
-  end
-
-  before do
-    subject.format :json
-    subject.formatter :json, Grape::Formatter::Jbuilder
-    subject.before { env['api.tilt.root'] = "#{File.dirname(__FILE__)}/views" }
-  end
+  let(:app) { Class.new(Grape::API) }
 
-  def app
-    subject
+  before :each do
+    app.format :json
+    app.formatter :json, Grape::Formatter::Jbuilder
+    app.before do
+      env['api.tilt.root'] = "#{File.dirname(__FILE__)}/../views"
+    end
   end
 
   it 'proper render partials' do
-    subject.get('/home', jbuilder: 'project') do
+    app.get('/home', jbuilder: 'project') do
       @author   = OpenStruct.new(author: 'LTe')
       @type     = OpenStruct.new(type: 'paper')
       @project  = OpenStruct.new(name: 'First', type: @type, author: @author)
@@ -35,8 +31,9 @@ describe 'Grape::Jbuilder partials' do
     }
 
     get('/home')
-    last_response.body.should match_json_expression(pattern)
-    last_response.body.should ==
+    expect(last_response.body).to match_json_expression(pattern)
+    expect(last_response.body).to eq(
       "{\"project\":{\"name\":\"First\",\"info\":{\"type\":\"paper\"},\"author\":{\"author\":\"LTe\"}}}"
+    )
   end
 end

data/spec/acceptance/templates_spec.rb

@@ -0,0 +1,60 @@
+require 'spec_helper'
+
+describe Grape::Jbuilder do
+  let(:app) { Class.new(Grape::API) }
+
+  before do
+    app.format :json
+    app.formatter :json, Grape::Formatter::Jbuilder
+    app.before do
+      env['api.tilt.root'] = "#{File.dirname(__FILE__)}/../views"
+    end
+  end
+
+  it 'should work without jbuilder template' do
+    app.get('/home') { 'Hello World' }
+
+    get '/home'
+
+    expect(last_response.body).to eq('"Hello World"')
+  end
+
+  it 'should work with dynamically set templates' do
+    app.get('/home') { env['api.tilt.template'] = 'test' }
+
+    get '/home'
+
+    expect(last_response.body).to eq({'foo' => 'bar'}.to_json)
+  end
+
+  it 'should respond with proper content-type' do
+    app.get('/home', jbuilder: 'user') do
+      @user    = OpenStruct.new(name: 'LTe', email: 'email@example.com')
+      @project = OpenStruct.new(name: 'First')
+    end
+
+    get('/home')
+
+    expect(last_response.headers['Content-Type']).to eq('application/json')
+  end
+
+  it "renders the template's content" do
+    app.get('/home', jbuilder: 'user') do
+      @user    = OpenStruct.new(name: 'LTe', email: 'email@example.com')
+      @project = OpenStruct.new(name: 'First')
+    end
+
+    get('/home')
+
+    pattern = {
+      user: {
+        name: 'LTe',
+        email: 'email@example.com',
+        project: {
+          name: 'First'
+        }
+      }
+    }
+    expect(last_response.body).to match_json_expression(pattern)
+  end
+end

data/spec/grape/formatter/jbuilder_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+
+describe Grape::Formatter::Jbuilder do
+  let(:object)   { double }
+  let(:env)      { {'api.endpoint' => endpoint, 'api.tilt.root' => '/tmp'} }
+  let(:endpoint) { double :options => {} }
+  let(:renderer) { double :render  => '' }
+
+  before :each do
+    Grape::Jbuilder::Renderer.stub :new => renderer
+
+    endpoint.options[:route_options] = {:jbuilder => 'user'}
+  end
+
+  describe '.call' do
+    it "passes the call to the Json render if no template is provided" do
+      endpoint.options.clear
+
+      expect(Grape::Formatter::Json).to receive(:call).with(object, env)
+
+      Grape::Formatter::Jbuilder.call object, env
+    end
+
+    it "creates a renderer with the root and template" do
+      expect(Grape::Jbuilder::Renderer).to receive(:new).with('/tmp', 'user').
+        and_return(renderer)
+
+      Grape::Formatter::Jbuilder.call object, env
+    end
+
+    it "accepts templates in the env hash" do
+      env['api.tilt.template'] = 'foo'
+
+      expect(Grape::Jbuilder::Renderer).to receive(:new).with('/tmp', 'foo').
+        and_return(renderer)
+
+      Grape::Formatter::Jbuilder.call object, env
+    end
+
+    it "passes the endpoint in as the render scope" do
+      expect(renderer).to receive(:render).with(endpoint, {}).and_return('')
+
+      Grape::Formatter::Jbuilder.call object, env
+    end
+
+    it "accepts custom locals for the render call" do
+      env['api.tilt.locals'] = {:foo => :bar}
+
+      expect(renderer).to receive(:render).with(endpoint, {:foo => :bar}).
+        and_return('')
+
+      Grape::Formatter::Jbuilder.call object, env
+    end
+  end
+end

data/spec/grape/jbuilder/renderer_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+describe Grape::Jbuilder::Renderer do
+  let(:engine) { double :render => '' }
+  let(:scope)  { double }
+
+  before :each do
+    Tilt.stub :new => engine
+  end
+
+  describe '#render' do
+    it "raises an error if the view path is nil" do
+      renderer = Grape::Jbuilder::Renderer.new(nil, 'file')
+
+      expect { renderer.render scope }.to raise_error
+    end
+
+    it "creates a new Tilt engine with the file and view path" do
+      renderer = Grape::Jbuilder::Renderer.new('/tmp', 'file.jbuilder')
+
+      expect(Tilt).to receive(:new).
+        with('/tmp/file.jbuilder', nil, :view_path => '/tmp').
+        and_return(engine)
+
+      renderer.render scope
+    end
+
+    it "appends jbuilder extension to the file if required" do
+      renderer = Grape::Jbuilder::Renderer.new('/tmp', 'file')
+
+      expect(Tilt).to receive(:new).
+        with('/tmp/file.jbuilder', nil, :view_path => '/tmp').
+        and_return(engine)
+
+      renderer.render scope
+    end
+
+    it "renders with the provided scope and locals" do
+      renderer = Grape::Jbuilder::Renderer.new('/tmp', 'file')
+
+      expect(engine).to receive(:render).with(scope, :foo => :bar).
+        and_return('')
+
+      renderer.render scope, :foo => :bar
+    end
+  end
+end

data/spec/views/test.jbuilder

@@ -0,0 +1 @@
+json.foo 'bar'

metadata

@@ -1,174 +1,153 @@
 --- !ruby/object:Gem::Specification
 name: grape-jbuilder
 version: !ruby/object:Gem::Version
-  version: 0.1.0
-  prerelease: 
+  version: 0.2.0
 platform: ruby
 authors:
 - Shu Masuda
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-13 00:00:00.000000000 Z
+date: 2014-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grape
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.3'
 - !ruby/object:Gem::Dependency
   name: jbuilder
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: tilt
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: tilt-jbuilder
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.4.0
 - !ruby/object:Gem::Dependency
   name: i18n
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: json_expressions
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rack-test
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Use Jbuilder in Grape
@@ -178,52 +157,59 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - grape-jbuilder.gemspec
+- lib/grape/formatter/jbuilder.rb
 - lib/grape/jbuilder.rb
-- lib/grape/jbuilder/formatter.rb
+- lib/grape/jbuilder/renderer.rb
 - lib/grape/jbuilder/version.rb
-- spec/grape_jbuilder_partials_spec.rb
-- spec/grape_jbuilder_spec.rb
+- spec/acceptance/partials_spec.rb
+- spec/acceptance/templates_spec.rb
+- spec/grape/formatter/jbuilder_spec.rb
+- spec/grape/jbuilder/renderer_spec.rb
 - spec/spec_helper.rb
 - spec/views/_partial.jbuilder
 - spec/views/project.jbuilder
+- spec/views/test.jbuilder
 - spec/views/user.jbuilder
-homepage: ''
+homepage: https://github.com/milkcocoa/grape-jbuilder
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Use Jbuilder in Grape
 test_files:
-- spec/grape_jbuilder_partials_spec.rb
-- spec/grape_jbuilder_spec.rb
+- spec/acceptance/partials_spec.rb
+- spec/acceptance/templates_spec.rb
+- spec/grape/formatter/jbuilder_spec.rb
+- spec/grape/jbuilder/renderer_spec.rb
 - spec/spec_helper.rb
 - spec/views/_partial.jbuilder
 - spec/views/project.jbuilder
+- spec/views/test.jbuilder
 - spec/views/user.jbuilder

data/lib/grape/jbuilder/formatter.rb

@@ -1,50 +0,0 @@
-module Grape
-  module Formatter
-    module Jbuilder
-      class << self
-
-        attr_reader :env
-        attr_reader :endpoint
-
-        def call(object, env)
-          @env      = env
-          @endpoint = env['api.endpoint']
-
-          if jbuilderable?
-            jbuilder do |template|
-              engine = ::Tilt.new(view_path(template), nil, view_path: env['api.tilt.root'])
-              engine.render(endpoint, {})
-            end
-          else
-            Grape::Formatter::Json.call object, env
-          end
-        end
-
-        private
-
-        def view_path(template)
-          if template.split('.')[-1] == 'jbuilder'
-            File.join(env['api.tilt.root'], template)
-          else
-            File.join(env['api.tilt.root'], (template + '.jbuilder'))
-          end
-        end
-
-        def jbuilderable?
-          !! endpoint.options[:route_options][:jbuilder]
-        end
-
-        def jbuilder
-          template = endpoint.options[:route_options][:jbuilder]
-          raise 'missing jbuilder template' unless template
-          set_view_root unless env['api.tilt.root']
-          yield template
-        end
-
-        def set_view_root
-          raise "Use Rack::Config to set 'api.tilt.root' in config.ru"
-        end
-      end
-    end
-  end
-end

data/spec/grape_jbuilder_spec.rb

@@ -1,71 +0,0 @@
-require 'spec_helper'
-
-describe Grape::Jbuilder do
-  subject do
-    Class.new(Grape::API)
-  end
-
-  before do
-    subject.format :json
-    subject.formatter :json, Grape::Formatter::Jbuilder
-  end
-
-  def app
-    subject
-  end
-
-  it 'should work without jbuilder template' do
-    subject.get('/home') { 'Hello World' }
-    get '/home'
-    last_response.body.should == 'Hello World'
-  end
-
-  it 'should raise error about root directory' do
-    subject.get('/home', jbuilder: true){}
-    get '/home'
-    last_response.status.should == 500
-    last_response.body.should include "Use Rack::Config to set 'api.tilt.root' in config.ru"
-  end
-
-
-  context 'titl root is setup'  do
-    before do
-      subject.before { env['api.tilt.root'] = "#{File.dirname(__FILE__)}/views" }
-    end
-
-    it 'should respond with proper content-type' do
-      subject.get('/home', jbuilder: 'user'){}
-      get('/home')
-      last_response.headers['Content-Type'].should == 'application/json'
-    end
-
-    it 'should not raise error about root directory' do
-      subject.get('/home', jbuilder: true){}
-      get '/home'
-      last_response.status.should == 500
-      last_response.body.should_not include "Use Rack::Config to set 'api.tilt.root' in config.ru"
-    end
-
-    ['user', 'user.jbuilder'].each do |jbuilder_option|
-      it 'should render jbuilder template (#{jbuilder_option})' do
-        subject.get('/home', jbuilder: jbuilder_option) do
-          @user    = OpenStruct.new(name: 'LTe', email: 'email@example.com')
-          @project = OpenStruct.new(name: 'First')
-        end
-
-        pattern = {
-          user: {
-            name: 'LTe',
-            email: 'email@example.com',
-            project: {
-              name: 'First'
-            }
-          }
-        }
-
-        get '/home'
-        last_response.body.should match_json_expression(pattern)
-      end
-    end
-  end
-end