grape-jbuilder 0.1.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format=documentation

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in grape-jbuilder.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,23 @@
+Copyright (c) 2012 Piotr Niełacny
+Copyright (c) 2013 Shu Masuda
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,173 @@
+# Grape::Jbuilder
+
+Use [Jbuilder](https://github.com/rails/jbuilder) templates in [Grape](https://github.com/intridea/grape)!
+
+This gem is completely based on [grape-rabl](https://github.com/LTe/grape-rabl).
+
+[![Build Status](https://travis-ci.org/milkcocoa/grape-jbuilder.png?branch=master)](http://travis-ci.org/milkcocoa/grape-jbuilder)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'grape-jbuilder'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install grape-jbuilder
+
+## Usage
+
+### Require grape-jbuilder
+
+```ruby
+# config.ru
+require 'grape/jbuilder'
+```
+
+### Setup view root directory
+```ruby
+# config.ru
+require 'grape/jbuilder'
+
+use Rack::Config do |env|
+  env['api.tilt.root'] = '/path/to/view/root/directory'
+end
+```
+
+### Tell your API to use Grape::Formatter:: Jbuilder
+
+```ruby
+class API < Grape::API
+  format :json
+  formatter :json, Grape::Formatter::Jbuilder
+end
+```
+
+### Use Jbuilder templates conditionally
+
+Add the template name to the API options.
+
+```ruby
+get '/user/:id', :jbuilder => 'user.jbuilder' do
+  @user = User.find(params[:id])
+end
+```
+
+You can use instance variables in the Jbuilder template.
+
+```ruby
+json.user do
+  json.(@user, :name, :email)
+  json.project do
+    json.(@project, :name)
+  end
+end
+```
+
+## You can omit .jbuilder
+
+The following are identical.
+
+```ruby
+get '/home', jbuilder: 'view'
+get '/home', jbuilder: 'view.jbuilder'
+```
+
+### Example
+
+```ruby
+# config.ru
+require 'grape/jbuilder'
+
+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::Jbuilder
+
+  # use Jbuilder with 'user.jbuilder' template
+  get '/user/:id', jbuilder: 'user' do
+    @user = User.find(params[:id])
+  end
+
+  # do not use jbuilder, fallback to the defalt Grape JSON formatter
+  get '/users' do
+    User.all
+  end
+end
+```
+
+```ruby
+# user.jbuilder
+json.user do
+  json.(@user, :name)
+end
+```
+
+## Usage with Rails
+
+Create a grape application.
+
+```ruby
+# app/api/user.rb
+class MyAPI < Grape::API
+  format :json
+  formatter :json, Grape::Formatter::Jbuilder
+  get '/user/:id', jbuilder: 'user' do
+    @user = User.find(params[:id])
+  end
+end
+```
+
+```ruby
+# app/views/api/user.jbuilder
+json.user do
+  json.(@user, :name)
+end
+```
+
+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
+```
+
+## Rspec
+
+See "Writing Tests" in https://github.com/intridea/grape.
+
+Enjoy :)
+
+
+## Special Thanks
+
+Special thanks to [@LTe](https://github.com/LTe) because this gem is completely based on [grape-rabl](https://github.com/LTe/grape-rabl).
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.rspec_opts = ['-fd -c']
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+task default: :spec

data/grape-jbuilder.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'grape/jbuilder/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "grape-jbuilder"
+  spec.version       = Grape::Jbuilder::VERSION
+  spec.authors       = ["Shu Masuda"]
+  spec.email         = ["masushu@gmail.com"]
+  spec.description   = %q{Use Jbuilder in Grape}
+  spec.summary       = %q{Use Jbuilder in Grape}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "grape", ">= 0.3"
+  spec.add_dependency "jbuilder"
+  spec.add_dependency "tilt"
+  spec.add_dependency "tilt-jbuilder", ">= 0.4.0"
+  spec.add_dependency "i18n"
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "json_expressions"
+  spec.add_development_dependency "rack-test"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/lib/grape/jbuilder.rb

@@ -0,0 +1,7 @@
+require 'grape'
+require 'hashie/hash'
+require 'jbuilder'
+require 'tilt'
+require 'tilt/jbuilder.rb'
+require 'grape/jbuilder/formatter'
+require 'grape/jbuilder/version'

data/lib/grape/jbuilder/formatter.rb

@@ -0,0 +1,50 @@
+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/lib/grape/jbuilder/version.rb

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

data/spec/grape_jbuilder_partials_spec.rb

@@ -0,0 +1,42 @@
+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
+
+  def app
+    subject
+  end
+
+  it 'proper render partials' do
+    subject.get('/home', jbuilder: 'project') do
+      @author   = OpenStruct.new(author: 'LTe')
+      @type     = OpenStruct.new(type: 'paper')
+      @project  = OpenStruct.new(name: 'First', type: @type, author: @author)
+    end
+
+    pattern = {
+      project: {
+        name: 'First',
+        info: {
+          type: 'paper'
+        },
+        author: {
+          author: 'LTe'
+        }
+      }
+    }
+
+    get('/home')
+    last_response.body.should match_json_expression(pattern)
+    last_response.body.should ==
+      "{\"project\":{\"name\":\"First\",\"info\":{\"type\":\"paper\"},\"author\":{\"author\":\"LTe\"}}}"
+  end
+end

data/spec/grape_jbuilder_spec.rb

@@ -0,0 +1,71 @@
+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

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'bundler'
+Bundler.setup :default, :test
+
+require 'active_support/core_ext/hash/conversions'
+require 'grape/jbuilder'
+require 'json_expressions/rspec'
+require 'ostruct'
+require 'rack/test'
+require 'rspec'
+
+RSpec.configure do |config|
+  config.include Rack::Test::Methods
+end
+
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}

data/spec/views/_partial.jbuilder

@@ -0,0 +1 @@
+json.(type, :type)

data/spec/views/project.jbuilder

@@ -0,0 +1,9 @@
+json.project do
+  json.(@project, :name)
+
+  json.info do
+	json.partial! 'partial', type: @type
+  end
+
+  json.author(@author, :author)
+end

data/spec/views/user.jbuilder

@@ -0,0 +1,7 @@
+json.user do
+  json.(@user, :name, :email)
+
+  json.project do
+    json.(@project, :name)
+  end
+end

metadata

@@ -0,0 +1,229 @@
+--- !ruby/object:Gem::Specification
+name: grape-jbuilder
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Shu Masuda
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-13 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
+email:
+- masushu@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- grape-jbuilder.gemspec
+- lib/grape/jbuilder.rb
+- lib/grape/jbuilder/formatter.rb
+- lib/grape/jbuilder/version.rb
+- spec/grape_jbuilder_partials_spec.rb
+- spec/grape_jbuilder_spec.rb
+- spec/spec_helper.rb
+- spec/views/_partial.jbuilder
+- spec/views/project.jbuilder
+- spec/views/user.jbuilder
+homepage: ''
+licenses:
+- MIT
+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
+signing_key: 
+specification_version: 3
+summary: Use Jbuilder in Grape
+test_files:
+- spec/grape_jbuilder_partials_spec.rb
+- spec/grape_jbuilder_spec.rb
+- spec/spec_helper.rb
+- spec/views/_partial.jbuilder
+- spec/views/project.jbuilder
+- spec/views/user.jbuilder