grape-rabl 0.2.0 → 0.2.1

data/.coveralls.yml

@@ -0,0 +1,2 @@
+service_name: travis-ci
+repo_token: budbVe8MwqMKtO4OalAxPvXy4P4kY284P

data/.rspec

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

data/.travis.yml

@@ -1,8 +1,10 @@
 rvm:
-  - 1.9.2
   - 1.9.3
   - ruby-head
   - rbx-19mode
-
+  - jruby-19mode
 env:
    - JRUBY_OPTS="--1.9"
+matrix:
+  allow_failures:
+    - rvm: ruby-head

data/CHANGELOG.md

@@ -0,0 +1,47 @@
+#### v0.2.1
+
+* Fix: render template according to request format. [#11](https://github.com/LTe/grape-rabl/pull/11) [@alovak](https://github.com/alovak) [view commit](http://github.com/LTe/grape-rabl/commit/f9658cf7a3026122afbb77e0da613731a5828338)
+
+#### v0.2.0
+
+* Allow to use partials in grape. [#10](https://github.com/LTe/grape-rabl/pull/10) [@ichilton](https://github.com/ichilton) [view commit](http://github.com/LTe/grape-rabl/commit/72c96c5acc9d8000f56ee8400ae0229053fb3e7e)
+* Stick to gem conventions. [@LTe](https://github.com/lte) [view commit](http://github.com/LTe/grape-rabl/commit/aabd0e2ad72f56a75427eebcc586deed57cf5f58)
+* Update for Grape 0.3 compatibility. [@alovak](https://github.com/alovak) [view commit](http://github.com/LTe/grape-rabl/commit/78bfdceffbfe90b700868ff1e79ab87e8baded81)
+* Format fix. [@LTe](https://github.com/lte) [view commit](http://github.com/LTe/grape-rabl/commit/13749cc18d332dcd0050bb32980cc233868a7992)
+
+#### v0.1.0
+
+* Updated w/ released Grape 0.2.3. [view commit](http://github.com/LTe/grape-rabl/commit/9a055dfd8e13e0952a587de7a2e19c9f762e939c)
+* Added link to Rabl. [view commit](http://github.com/LTe/grape-rabl/commit/2a7650cb5f9327761cac8b928453e451a973e131)
+* Grape 0.2.x and put back dependency status. [view commit](http://github.com/LTe/grape-rabl/commit/9c1183f3758db8a79737ff35f0c328be646a3f65)
+* Grape 0.2.3. [view commit](http://github.com/LTe/grape-rabl/commit/d06a6559a02095e1d84fbbd8df0c3eccdd31930b)
+* Updated Grape dependency via .gemspec. [view commit](http://github.com/LTe/grape-rabl/commit/fd44b6a91fa327438eac968fea62ac00ec3ae01f)
+
+#### v0.0.6
+
+* Use Grape formatter syntax instead of monkey-patching. [view commit](http://github.com/LTe/grape-rabl/commit/bfba4c382933fd0f912d9114676b6d79d627c3be)
+* Close block code in README. [view commit](http://github.com/LTe/grape-rabl/commit/f397a0de4399d0797b5e327d56234464091d7e3d)
+* Change home to user. [view commit](http://github.com/LTe/grape-rabl/commit/45178ec13c613d872c65475b330d20a548459681)
+
+#### v0.0.5
+
+* Respect default_format for rabl response. [view commit](http://github.com/LTe/grape-rabl/commit/ac54ebbb1d43d1fb76ee9516c5aa683c750c73b0)
+
+#### v0.0.4
+
+* Require `grape/rabl`. [view commit](http://github.com/LTe/grape-rabl/commit/e99a185b20974f5e72ac3c19ec377a5853780a33)
+
+#### v0.0.3
+
+* Template without `.rabl`. [view commit](http://github.com/LTe/grape-rabl/commit/cecca03a680f8ae50b406e1b8c170eba27d1bc99)
+
+#### v0.0.2
+
+* Add Travis. [view commit](http://github.com/LTe/grape-rabl/commit/71c905bc91066c6fdb628afb555561e23219e213)
+* Remove ruby debug. [view commit](http://github.com/LTe/grape-rabl/commit/f80fad14a49b14ae7264b08eff12832c37cbd0b2)
+* Works with rubinius. [view commit](http://github.com/LTe/grape-rabl/commit/fceece344de095916ded7c477bb5891537bb8663)
+* Add dependency status. [view commit](http://github.com/LTe/grape-rabl/commit/66820fb52155c65d4cd9bd7b67f0f22c1105fa46)
+
+#### v0.0.1
+
+* Initial public release. [@LTe](https://github.com/lte)

data/Gemfile

@@ -1,9 +1,11 @@
-source 'https://rubygems.org'
-
-gemspec
-
-group :test do
-  gem "rspec", "~> 2.12.0"
-  gem "rack-test"
-  gem "rake"
-end
+source 'https://rubygems.org'
+
+gemspec
+
+group :test do
+  gem "json", '~> 1.7.7'
+  gem "rspec", "~> 2.12.0"
+  gem "rack-test"
+  gem "rake"
+  gem "coveralls", require: false
+end

data/README.md

@@ -2,8 +2,11 @@
 
 Use [Rabl](https://github.com/nesquena/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)
-
+[![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)
+[![Code Climate](https://codeclimate.com/github/LTe/grape-rabl.png)](https://codeclimate.com/github/LTe/grape-rabl)
+[![Coverage Status](https://coveralls.io/repos/LTe/grape-rabl/badge.png?branch=master)](https://coveralls.io/r/LTe/grape-rabl?branch=master)
+[![Gem Version](https://badge.fury.io/rb/grape-rabl.png)](http://badge.fury.io/rb/grape-rabl)
 
 ## Installation
 
@@ -149,12 +152,13 @@ GrapeExampleRails::Application.routes.draw do
 end
 ```
 
-## Rspec
+## Specs
 
-See "Writing Tests" in https://github.com/intridea/grape.
+See ["Writing Tests"](https://github.com/intridea/grape#writing-tests) in [https://github.com/intridea/grape](grape) README.
 
 Enjoy :)
 
+
 ## Contributing
 
 1. Fork it
@@ -162,3 +166,7 @@ Enjoy :)
 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
+
+
+[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/LTe/grape-rabl/trend.png)](https://bitdeli.com/free "Bitdeli Badge")
+

data/grape-rabl.gemspec

@@ -14,6 +14,7 @@ Gem::Specification.new do |gem|
   gem.name          = "grape-rabl"
   gem.require_paths = ["lib"]
   gem.version       = Grape::Rabl::VERSION
+  gem.required_ruby_version = '>= 1.9.3'
 
   gem.add_dependency "grape", "~> 0.3"
   gem.add_dependency "rabl"

data/lib/grape-rabl/formatter.rb

@@ -1,53 +1,55 @@
-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), {format: env['api.format'], 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] == "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
+require 'json'
+
+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), {format: env['api.format'], 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] == "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/render.rb

@@ -0,0 +1,9 @@
+module GrapeRabl
+  module Render
+    def render(options = {})
+      env['api.endpoint'].options[:route_options][:rabl] = options.delete(:rabl)
+    end
+  end
+end
+
+Grape::Endpoint.send(:include, GrapeRabl::Render)

data/lib/grape-rabl/tilt.rb

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

data/lib/grape-rabl/version.rb

@@ -1,5 +1,5 @@
 module Grape
   module Rabl
-    VERSION = "0.2.0"
+    VERSION = "0.2.1"
   end
 end

data/lib/grape-rabl.rb

@@ -1,6 +1,7 @@
-require "rabl"
-require "grape"
-require "hashie/hash"
-require "grape-rabl/tilt"
-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"
+require "grape-rabl/render"

data/spec/grape_rabl_partials_spec.rb

@@ -1,29 +1,29 @@
-require 'spec_helper'
-
-describe "Grape::Rabl partials" do
-  subject do
-    Class.new(Grape::API)
-  end
-
-  before do
-    subject.format :json
-    subject.formatter :json, Grape::Formatter::Rabl
-    subject.before { env["api.tilt.root"] = "#{File.dirname(__FILE__)}/views" }
-  end
-
-  def app
-    subject
-  end
-
-  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)
-    end
-
-    get("/home")
-    last_response.body.should ==
-      "{\"project\":{\"name\":\"First\",\"info\":{\"type\":\"paper\"},\"author\":{\"author\":\"LTe\"}}}"
-  end
+require 'spec_helper'
+
+describe "Grape::Rabl partials" do
+  subject do
+    Class.new(Grape::API)
+  end
+
+  before do
+    subject.format :json
+    subject.formatter :json, Grape::Formatter::Rabl
+    subject.before { env["api.tilt.root"] = "#{File.dirname(__FILE__)}/views" }
+  end
+
+  def app
+    subject
+  end
+
+  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)
+    end
+
+    get("/home")
+    last_response.body.should ==
+      "{\"project\":{\"name\":\"First\",\"info\":{\"type\":\"paper\"},\"author\":{\"author\":\"LTe\"}}}"
+  end
 end

data/spec/grape_rabl_spec.rb

@@ -8,6 +8,7 @@ describe Grape::Rabl do
   before do
     subject.format :json
     subject.formatter :json, Grape::Formatter::Rabl
+    subject.helpers MyHelper
   end
 
   def app
@@ -17,22 +18,56 @@ describe Grape::Rabl do
   it 'should work without rabl template' do
     subject.get("/home") {"Hello World"}
     get "/home"
-    last_response.body.should == "Hello World"
+    last_response.body.should == "\"Hello World\""
   end
 
   it "should raise error about root directory" do
-    subject.get("/home", :rabl => true){}
-    get "/home"
-    last_response.status.should == 500
-    last_response.body.should include "Use Rack::Config to set 'api.tilt.root' in config.ru"
+    begin
+      subject.get("/home", :rabl => true){}
+      get "/home"
+    rescue Exception => e
+      e.message.should include "Use Rack::Config to set 'api.tilt.root' in config.ru"
+    end
   end
 
-
   context "titl root is setup"  do
     before do
       subject.before { env["api.tilt.root"] = "#{File.dirname(__FILE__)}/views" }
     end
 
+    describe "helpers" do
+      it "should execute helper" do
+        subject.get("/home", :rabl => "helper") { @user = OpenStruct.new }
+        get "/home"
+        last_response.body.should == "{\"user\":{\"helper\":\"my_helper\"}}"
+      end
+    end
+
+    describe "#render" do
+      before do
+        subject.get("/home", :rabl => "user") do
+          @user = OpenStruct.new(:name => "LTe")
+          render :rabl => "admin"
+        end
+
+        subject.get("/about", :rabl => "user") do
+          @user = OpenStruct.new(:name => "LTe")
+        end
+      end
+
+      it "renders template passed as argument to reneder method" do
+        get("/home")
+        last_response.body.should == '{"admin":{"name":"LTe"}}'
+      end
+
+      it "does not save rabl options after called #render method" do
+        get("/home")
+        get("/about")
+        last_response.body.should == '{"user":{"name":"LTe","project":null}}'
+      end
+    end
+
+
     it "should respond with proper content-type" do
       subject.get("/home", :rabl => "user"){}
       get("/home")
@@ -40,9 +75,9 @@ describe Grape::Rabl do
     end
 
     it "should not raise error about root directory" do
-      subject.get("/home", :rabl => true){}
+      subject.get("/home", :rabl => "user"){}
       get "/home"
-      last_response.status.should == 500
+      last_response.status.should == 200
       last_response.body.should_not include "Use Rack::Config to set 'api.tilt.root' in config.ru"
     end
 

data/spec/grape_rabl_xml_spec.rb

@@ -1,44 +1,44 @@
-require 'spec_helper'
-
-describe Grape::Rabl do
-  subject do
-    Class.new(Grape::API)
-  end
-
-  before do
-    subject.format :xml
-    subject.formatter :xml, Grape::Formatter::Rabl
-  end
-
-  def app
-    subject
-  end
-
-  context "with xml format"  do
-    before do
-      subject.before {
-        env["api.tilt.root"] = "#{File.dirname(__FILE__)}/views"
-        env["api.format"] = :xml
-      }
-    end
-
-    it "should respond with proper content-type" do
-      subject.get("/home", :rabl => "user"){}
-      get("/home")
-      last_response.headers["Content-Type"].should == "application/xml"
-    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 == %Q{<?xml version="1.0" encoding="UTF-8"?>\n<user>\n  <name>LTe</name>\n  <email>email@example.com</email>\n  <project>\n    <name>First</name>\n  </project>\n</user>\n}
-      end
-    end
-  end
-end
+require 'spec_helper'
+
+describe Grape::Rabl do
+  subject do
+    Class.new(Grape::API)
+  end
+
+  before do
+    subject.format :xml
+    subject.formatter :xml, Grape::Formatter::Rabl
+  end
+
+  def app
+    subject
+  end
+
+  context "with xml format"  do
+    before do
+      subject.before {
+        env["api.tilt.root"] = "#{File.dirname(__FILE__)}/views"
+        env["api.format"] = :xml
+      }
+    end
+
+    it "should respond with proper content-type" do
+      subject.get("/home", :rabl => "user"){}
+      get("/home")
+      last_response.headers["Content-Type"].should == "application/xml"
+    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 == %Q{<?xml version="1.0" encoding="UTF-8"?>\n<user>\n  <name>LTe</name>\n  <email>email@example.com</email>\n  <project>\n    <name>First</name>\n  </project>\n</user>\n}
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -4,6 +4,9 @@ $LOAD_PATH.unshift(File.dirname(__FILE__))
 require 'bundler'
 Bundler.setup :default, :test
 
+require 'coveralls'
+Coveralls.wear!
+
 require 'active_support/core_ext/hash/conversions'
 require 'grape/rabl'
 require 'rspec'

data/spec/support/my_helper.rb

@@ -0,0 +1,5 @@
+module MyHelper
+  def my_helper
+    "my_helper"
+  end
+end

data/spec/views/admin.rabl

@@ -0,0 +1,2 @@
+object @user => :admin
+attributes :name

data/spec/views/helper.rabl

@@ -0,0 +1,3 @@
+object @user => :user
+
+node(:helper) { my_helper }

data/spec/views/project.rabl

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: grape-rabl
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-28 00:00:00.000000000 Z
+date: 2013-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grape
@@ -82,9 +82,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .coveralls.yml
 - .gitignore
 - .rspec
 - .travis.yml
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
@@ -92,6 +94,7 @@ files:
 - grape-rabl.gemspec
 - lib/grape-rabl.rb
 - lib/grape-rabl/formatter.rb
+- lib/grape-rabl/render.rb
 - lib/grape-rabl/tilt.rb
 - lib/grape-rabl/version.rb
 - lib/grape/rabl.rb
@@ -99,7 +102,10 @@ files:
 - spec/grape_rabl_spec.rb
 - spec/grape_rabl_xml_spec.rb
 - spec/spec_helper.rb
+- spec/support/my_helper.rb
 - spec/views/_partial.rabl
+- spec/views/admin.rabl
+- spec/views/helper.rabl
 - spec/views/info.rabl
 - spec/views/project.rabl
 - spec/views/user.rabl
@@ -114,17 +120,31 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -2547421554864201049
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Use rabl in grape
-test_files: []
+test_files:
+- spec/grape_rabl_partials_spec.rb
+- spec/grape_rabl_spec.rb
+- spec/grape_rabl_xml_spec.rb
+- spec/spec_helper.rb
+- spec/support/my_helper.rb
+- spec/views/_partial.rabl
+- spec/views/admin.rabl
+- spec/views/helper.rabl
+- spec/views/info.rabl
+- spec/views/project.rabl
+- spec/views/user.rabl