grape-rabl 0.0.5 → 0.0.6

data/.rspec

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

data/Gemfile

@@ -1,12 +1,12 @@
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in grape-rabl.gemspec
-gemspec
-
-gem "grape", :git => "git://github.com/intridea/grape.git", :branch => "frontier"
-
-group :test do
-  gem "rspec", "~> 2.8.0"
-  gem "rack-test"
-  gem "rake"
-end
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in grape-rabl.gemspec
+gemspec
+
+gem "grape", :git => "git://github.com/intridea/grape.git"
+
+group :test do
+  gem "rspec", "~> 2.8.0"
+  gem "rack-test"
+  gem "rake"
+end

data/README.md

@@ -1,146 +1,164 @@
-# Grape::Rabl
-
-Use rabl templates in grape!
-
-[![Build Status](https://secure.travis-ci.org/LTe/grape-rabl.png)](http://travis-ci.org/LTe/grape-rabl) [![Dependency Status](https://gemnasium.com/LTe/grape-rabl.png)](https://gemnasium.com/LTe/grape-rabl)
-
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'grape-rabl'
-gem 'grape', :git => "git://github.com/intridea/grape.git", :branch => "frontier"
-```
-
-And then execute:
-
-    $ bundle
-
-## Usage
-
-### Require grape-rabl
-```ruby
-# config.ru
-require 'grape/rabl'
-```
-
-### Setup view root directory
-```ruby
-# config.ru
-require 'grape/rabl'
-
-use Rack::Config do |env|
-  env['api.tilt.root'] = '/path/to/view/root/directory'
-end
-```
-
-### Create grape application
-
-To *get post put delete options* add **:rabl** options with template name.
-
-```ruby
-get "/path", :rabl => "template_name" do
-  # stuff
-  @var = "hello"
-end
-
-post "/path", :rabl => "template_name_diff" do
-  # stuff
-  @user = User.find_user("email@example.com")
-end
-```
-
-**You can use instance variables in templates!**
-
-## Template name
-
-You can use "**view.rabl**" or just "**view**"
-
-```ruby
-get "/home", :rabl => "view"
-get "/home", :rabl => "view.rabl"
-```
-
-### Example
-
-```ruby
-# config.ru
-require 'grape/rabl'
-
-use Rack::Config do |env|
-  env['api.tilt.root'] = '/path/to/view/root/directory'
-end
-
-class UserAPI < Grape::API
-  # use rabl with 'hello.rabl' template
-  get '/user', :rabl => 'hello' do
-    @user = User.first
-  end
-
-  # do not use rabl, normal usage
-  get '/user2' do
-    { :some => :hash }
-  end
-end
-```
-
-```ruby
-# hello.rabl
-object @user => :user
-
-attributes :name
-```
-
-## Usage with rails
-
-Create grape application
-
-```ruby
-# app/api/user.rb
-class MyAPI < Grape::API
-  get '/user', :rabl => "user" do
-    @user = User.first
-  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
-```
-
-## Rspec
-
-Writing Tests part at https://github.com/intridea/grape
-
-Enjoy :)
-
-## Contributing
-
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Added some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+# Grape::Rabl
+
+Use Rabl templates in [Grape](https://github.com/intridea/grape)!
+
+[![Build Status](https://secure.travis-ci.org/LTe/grape-rabl.png)](http://travis-ci.org/LTe/grape-rabl) [![Dependency Status](https://gemnasium.com/LTe/grape-rabl.png)](https://gemnasium.com/LTe/grape-rabl)
+
+
+## Installation
+
+Add the `grape` and `grape-rabl` gems to Gemfile. Currently requires HEAD of Grape.
+
+```ruby
+gem 'grape', :git => "https://github.com/intridea/grape.git"
+gem 'grape-rabl'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+### Require grape-rabl
+
+```ruby
+# config.ru
+require 'grape/rabl'
+```
+
+### Setup view root directory
+```ruby
+# config.ru
+require 'grape/rabl'
+
+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
+```
+
+## You can omit .rabl
+
+The following are identical.
+
+```ruby
+get "/home", :rabl => "view"
+get "/home", :rabl => "view.rabl"
+```
+
+### Example
+
+```ruby
+# config.ru
+require 'grape/rabl'
+
+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
+
+  # use rabl with 'user.rabl' template
+  get '/user/:id', :rabl => 'user' do
+    @user = User.find(params[:id])
+  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
+```
+
+## Rspec
+
+See "Writing Tests" in https://github.com/intridea/grape.
+
+Enjoy :)
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/lib/grape-rabl/formatter.rb

@@ -1,53 +1,53 @@
-require 'tilt'
-Rabl.register!
-
-module Grape
-  module Middleware
-    class Formatter
-      alias :old_after :after
-
-      def after
-        status, headers, bodies = *@app_response
-        current_endpoint = env['api.endpoint']
-
-        rabl(current_endpoint) do |template|
-          engine = ::Tilt.new(view_path(template))
-          rendered = engine.render(current_endpoint, {})
-          headers['Content-Type'] = content_types[env['api.format']]
-          Rack::Response.new(rendered, status, headers).to_a
-        end
-      end
-
-      private
-
-      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"))
-        end
-      end
-
-      def rabl(endpoint)
-        if template = rablable?(endpoint)
-          yield template
-        else
-          old_after
-        end
-      end
-
-      def rablable?(endpoint)
-        if template = endpoint.options[:route_options][:rabl]
-          set_view_root unless env['api.tilt.root']
-          template
-        else
-          false
-        end
-      end
-  
-      def set_view_root
-        raise "Use Rack::Config to set 'api.tilt.root' in config.ru"
-      end
-    end
-  end
-end
+module Grape
+  module Formatter
+    module Rabl
+      class << self
+
+        attr_reader :env
+        attr_reader :endpoint
+
+        def call(object, env)
+
+          @env = env
+          @endpoint = env['api.endpoint']
+
+          if rablable?
+            rabl do |template|
+              engine = ::Tilt.new(view_path(template))
+              engine.render endpoint, {}
+            end
+          else
+            Grape::Formatter::Json.call object, env
+          end
+
+        end
+
+        private
+
+          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"))
+            end
+          end
+
+          def rablable?
+            !! endpoint.options[:route_options][:rabl]
+          end
+
+          def rabl
+            template = endpoint.options[:route_options][:rabl]
+            raise "missing rabl 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-rabl/tilt.rb

@@ -0,0 +1,3 @@
+require 'tilt'
+
+Rabl.register!

data/lib/grape-rabl/version.rb

@@ -1,5 +1,5 @@
 module Grape
   module Rabl
-    VERSION = "0.0.5"
+    VERSION = "0.0.6"
   end
 end

data/lib/grape-rabl.rb

@@ -1,5 +1,6 @@
-require "rabl"
-require "grape"
-require "hashie/hash"
-require "grape-rabl/version"
-require "grape-rabl/formatter"
+require "rabl"
+require "grape"
+require "hashie/hash"
+require "grape-rabl/tilt"
+require "grape-rabl/version"
+require "grape-rabl/formatter"

data/spec/grape_rabl_spec.rb

@@ -1,48 +1,57 @@
-require 'spec_helper'
-
-describe Grape::Rabl do
-  subject { Class.new(Grape::API) }
-  before { subject.default_format :json }
-  def app; subject end
-
-  it 'should work without rabl 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", :rabl => true){}
-    lambda{ get "/home" }.should raise_error("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", :rabl => "user"){}
-      get("/home")
-      last_response.headers["Content-Type"].should == "application/json"
-    end
-
-    it "should not raise error about root directory" do
-      subject.get("/home", :rabl => true){}
-      lambda{ get "/home" }.should_not raise_error("Use Rack::Config to set 'api.tilt.root' in config.ru")
-    end
-
-    ["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")
-        end
-
-        get "/home"
-        last_response.body.should == '{"user":{"name":"LTe","email":"email@example.com","project":{"name":"First"}}}'
-      end
-    end
-  end
-end
+require 'spec_helper'
+
+describe Grape::Rabl do
+  subject do
+    Class.new(Grape::API)
+  end
+
+  before do
+    subject.format :json
+    subject.formatter :json, Grape::Formatter::Rabl
+  end
+
+  def app
+    subject
+  end
+
+  it 'should work without rabl 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", :rabl => true){}
+    lambda{ get "/home" }.should raise_error("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", :rabl => "user"){}
+      get("/home")
+      last_response.headers["Content-Type"].should == "application/json"
+    end
+
+    it "should not raise error about root directory" do
+      subject.get("/home", :rabl => true){}
+      lambda{ get "/home" }.should_not raise_error("Use Rack::Config to set 'api.tilt.root' in config.ru")
+    end
+
+    ["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")
+        end
+
+        get "/home"
+        last_response.body.should == '{"user":{"name":"LTe","email":"email@example.com","project":{"name":"First"}}}'
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: grape-rabl
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-03 00:00:00.000000000 Z
+date: 2012-12-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rabl
@@ -67,6 +67,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
 - .travis.yml
 - Gemfile
 - LICENSE
@@ -75,6 +76,7 @@ files:
 - grape-rabl.gemspec
 - lib/grape-rabl.rb
 - lib/grape-rabl/formatter.rb
+- lib/grape-rabl/tilt.rb
 - lib/grape-rabl/version.rb
 - lib/grape/rabl.rb
 - spec/grape_rabl_spec.rb