rabl-rails 0.2.2 → 0.3.0

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - jruby-19mode
+  - rbx-19mode

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # CHANGELOG
 
+## 0.3.0
+  * Travis integration
+  * Add test for keywords used as variable names
+  * Add PList renderer
+  * Remove location header from post responses in responder
+  * Fix bug with incomplete template prefixing
+
 ## 0.2.2
   * Add condition blocks
 

data/Gemfile

@@ -2,8 +2,16 @@ source "http://rubygems.org"
 
 gemspec
 
-gem 'oj'
-gem 'libxml-ruby'
+gem 'plist'
+
+platforms :ruby do
+  gem 'oj'
+  gem 'libxml-ruby'
+end
+
+platforms :jruby do
+  gem 'nokogiri'
+end
 
 group :test do
   gem 'rspec-mocks'

data/README.md

@@ -4,7 +4,7 @@ RABL (Ruby API Builder Language) is a ruby templating system for rendering resou
 
 rabl-rails is **faster** and uses **less memory** than the standard rabl gem while letting you access the same features. There are some slight changes to do on your templates to get this gem to work but it should't take you more than 5 minutes.
 
-rabl-rails only target **Rails 3+ application**.
+rabl-rails only targets **Rails 3+ application** and is compatible with mri 1.9.3, jRuby and rubinius.
 
 ## Installation
 
@@ -269,9 +269,9 @@ You can find more informations about other features (caching, custom_responder,
 
 ## Performance
 
-Benchmarks have been made using this [application](http://github.com/ccocchi/rabl-benchmark), with rabl 0.6.14 and rabl-rails 0.1.0
+Benchmarks have been made using this [application](http://github.com/ccocchi/rabl-benchmark), with rabl 0.7.6 and rabl-rails 0.3.0
 
-Overall, Rabl-rails is **20% faster and use 10% less memory**, even **twice faster** when rendering collections with extends.
+Overall, Rabl-rails is **20% faster and use 10% less memory**, even **twice faster** when using extends.
 
 You can see full tests on test application repository.
 
@@ -280,11 +280,12 @@ You can see full tests on test application repository.
 * [Christopher Cocchi-Perrier](http://github.com/ccocchi) - Creator of the project
 
 Want to add another format to Rabl-rails ? Checkout [JSON renderer](http://github.com/ccocchi/rabl-rails/blob/master/lib/rabl-rails/renderers/json.rb) for reference
-Want to make another change ? Just fork and contribute, any help is very much appreciated
+Want to make another change ? Just fork and contribute, any help is very much appreciated. If you found a bug, you can report it via the Github issues.
 
 ## Original idea
 
-* [RABL](http://github.com/nesquena/rabl) Standart RABL gem. I used it a lot before deciding I wanted faster views
+* [RABL](http://github.com/nesquena/rabl) Standart RABL gem. I used it a lot but I needed to improve my API response time, and
+  since most of the time was spent in view rendering, I decided to implement a faster rabl gem.
 
 ## Copyright
 

data/lib/rabl-rails/library.rb

@@ -21,7 +21,6 @@ module RablRails
     def compile_template_from_source(source, path = nil)
       if path && RablRails.cache_templates?
         @cached_templates[path] ||= Compiler.new.compile_source(source)
-        @cached_templates[path].dup
       else
         Compiler.new.compile_source(source)
       end

data/lib/rabl-rails/renderer.rb

@@ -1,6 +1,7 @@
 require 'rabl-rails/renderers/base'
 require 'rabl-rails/renderers/json'
 require 'rabl-rails/renderers/xml'
+require 'rabl-rails/renderers/plist'
 
 module RablRails
   module Renderer

data/lib/rabl-rails/renderers/base.rb

@@ -48,8 +48,7 @@ module RablRails
       # template source passed.
       #
       def render_resource(data, source)
-        source.inject({}) { |output, current|
-          key, value = current
+        source.inject({}) { |output, (key, value)|
 
           out = case value
           when Symbol

data/lib/rabl-rails/renderers/plist.rb

@@ -0,0 +1,11 @@
+module RablRails
+  module Renderers
+    class PLIST < Base
+
+      def format_output(hash)
+        hash = { _options[:root_name] => hash } if _options[:root_name] && RablRails.include_plist_root
+        RablRails.plist_engine.dump(hash)
+      end
+    end
+  end
+end

data/lib/rabl-rails/responder.rb

@@ -28,14 +28,15 @@ module RablRails
 
     def api_behavior(error)
       if post?
-        template = if @controller.respond_to?(:responder_default_template, true)
+        template = if controller.respond_to?(:responder_default_template, true)
           controller.send(:responder_default_template)
         else
           RablRails.responder_default_template
         end
-        options[:template] ||= "#{@controller.controller_name}/#{template}"
+        options[:prefixes] = controller._prefixes
+        options[:template] ||= template
 
-        controller.default_render options.merge(status: :created, location: api_location)
+        controller.default_render options.merge(status: :created)
       else
         head :no_content
       end

data/lib/rabl-rails/version.rb

@@ -1,3 +1,3 @@
 module RablRails
-  VERSION = '0.2.2'
+  VERSION = '0.3.0'
 end

data/lib/rabl-rails.rb

@@ -33,6 +33,12 @@ module RablRails
   mattr_accessor :responder_default_template
   @@responder_default_template = 'show'
 
+  mattr_reader :plist_engine
+  @@plist_engine = nil
+
+  mattr_accessor :include_plist_root
+  @@include_plist_root = nil
+
   def self.configure
     yield self
 
@@ -59,12 +65,23 @@ module RablRails
     ActiveSupport::XmlMini.backend
   end
 
+  def self.plist_engine=(name)
+    raise "Your plist engine does not respond to #dump" unless name.respond_to?(:dump)
+    @@plist_engine = name
+  end
+
   def self.cache_templates?
     ActionController::Base.perform_caching && @@cache_templates
   end
 
   def self.load_default_engines!
-    self.json_engine = MultiJson.default_engine
-    self.xml_engine  = 'LibXML' if defined?(LibXML)
+    self.json_engine  = MultiJson.default_engine
+    self.plist_engine = Plist::Emit if defined?(Plist)
+
+    if defined?(LibXML)
+      self.xml_engine = 'LibXML'
+    elsif defined?(Nokogiri)
+      self.xml_engine = 'Nokogiri'
+    end
   end
 end

data/test/keyword_test.rb

@@ -0,0 +1,47 @@
+require 'test_helper'
+
+class KeywordTest < ActiveSupport::TestCase
+  class Collection
+    attr_accessor :id, :name
+
+    def initialize(id, name)
+      @id   = id
+      @name = name
+    end
+
+    def cover(size)
+      "foo_#{size}"
+    end
+  end
+
+  setup do
+    RablRails::Library.reset_instance
+    @context = Context.new
+    @user = User.new(1, 'Marty')
+    @collections = [Collection.new(1, 'first'), Collection.new(2, 'last')]
+    @context.assigns['user'] = @user
+    @context.assigns['collections'] = @collections
+    @context.virtual_path = 'user/show'
+    @context.stub(lookup_context: nil)
+  end
+
+  test "collections model should render correctly" do
+    source = %{
+      object :@user
+      child(:@collections => :collections) do
+        attributes :id, :name
+        node(:cover_url) { |c|
+          c.cover(:medium)
+        }
+      end
+    }
+
+    assert_equal(MultiJson.encode(
+      user: { collections: [{
+        id: 1, name: 'first', cover_url: "foo_medium"
+      }, {
+        id: 2, name: 'last', cover_url: "foo_medium"
+      }] }
+    ), RablRails::Library.instance.get_rendered_template(source, @context))
+  end
+end

data/test/renderers/json_renderer_test.rb

@@ -140,6 +140,7 @@ class TestJsonRenderer < ActiveSupport::TestCase
   end
 
   test "render object with root node" do
+    RablRails.include_json_root = true
     @template.root_name = :author
     @template.source = { :id => :id, :name => :name }
     assert_equal %q({"author":{"id":1,"name":"foobar"}}), render_json_output

data/test/renderers/plist_renderer_test.rb

@@ -0,0 +1,135 @@
+require 'test_helper'
+
+class TestPlistRenderer < ActiveSupport::TestCase
+  INDENT_REGEXP = /\n(\s)*/
+  HEADER_REGEXP = /<\?[^>]+><![^>]+>/
+
+  setup do
+    @data = User.new(1, 'foobar', 'male')
+
+    @context = Context.new
+    @context.assigns['data'] = @data
+
+    @template = RablRails::CompiledTemplate.new
+    @template.data = :@data
+    @template.root_name = :user
+  end
+
+  def render_plist_output
+    output = RablRails::Renderers::PLIST.new(@context).render(@template).to_s.gsub!(INDENT_REGEXP, '')
+    output.sub!(HEADER_REGEXP, '').gsub!(%r(</?plist[^>]*>), '').sub!(%r(<dict/?>), '').sub(%r(</dict>), '')
+  end
+
+  test "plist engine should responsd to #dump" do
+    assert_raises(RuntimeError) { RablRails.plist_engine = Object.new }
+  end
+
+  test "render object wth empty template" do
+    @template.source = {}
+    assert_equal %q(), render_plist_output
+  end
+
+  test "render collection with empty template" do
+    @context.assigns['data'] = [@data]
+    @template.source = {}
+    assert_equal %q(<array></array>), render_plist_output
+  end
+
+  test "render object with local methods (used by decent_exposure)" do
+    @context.stub(:user).and_return(@data)
+    @template.data = :user
+    @template.source = { :id => :id }
+    assert_equal %q(<key>id</key><integer>1</integer>), render_plist_output
+  end
+
+  test "render single object attributes" do
+    @template.source = { :id => :id, :name => :name }
+    assert_equal %q(<key>id</key><integer>1</integer><key>name</key><string>foobar</string>), render_plist_output
+  end
+
+  test "render child with object association" do
+    @data.stub(:address).and_return(mock(:city => 'Paris'))
+    @template.source = { :address => { :_data => :address, :city => :city } }
+    assert_equal %q(<key>address</key><dict><key>city</key><string>Paris</string></dict>), render_plist_output
+  end
+
+  test "render child with arbitrary data source" do
+    @template.source = { :author => { :_data => :@data, :name => :name } }
+    assert_equal %q(<key>author</key><dict><key>name</key><string>foobar</string></dict>), render_plist_output
+  end
+
+  test "render child with local methods (used by decent_exposure)" do
+    @context.stub(:user).and_return(@data)
+    @template.source = { :author => { :_data => :user, :name => :name } }
+    assert_equal %q(<key>author</key><dict><key>name</key><string>foobar</string></dict>), render_plist_output
+  end
+
+  test "render node property" do
+    proc = lambda { |object| object.name }
+    @template.source = { :name => proc }
+    assert_equal %q(<key>name</key><string>foobar</string>), render_plist_output
+  end
+
+  test "render node property with true condition" do
+    condition = lambda { |u| true }
+    proc = lambda { |object| object.name }
+    @template.source = { :name => [condition, proc] }
+    assert_equal %q(<key>name</key><string>foobar</string>), render_plist_output
+  end
+
+  test "render node property with false condition" do
+    condition = lambda { |u| false }
+    proc = lambda { |object| object.name }
+    @template.source = { :name => [condition, proc] }
+    assert_equal %q(), render_plist_output
+  end
+
+  test "node with context method call" do
+    @context.stub(:respond_to?).with(:@data).and_return(false)
+    @context.stub(:respond_to?).with(:context_method).and_return(true)
+    @context.stub(:context_method).and_return('marty')
+    proc = lambda { |object| context_method }
+    @template.source = { :name => proc }
+    assert_equal %q(<key>name</key><string>marty</string>), render_plist_output
+  end
+
+  test "partial with no values should raise an error" do
+    @template.data = false
+    @template.source = { :user => ->(s) { partial('users/base') } }
+
+    assert_raises(RablRails::Renderers::PartialError) { render_plist_output }
+  end
+
+  test "partial with empty values should not raise an error" do
+    @template.data = false
+    @template.source = { :users => ->(s) { partial('users/base', :object => []) } }
+
+    assert_equal %q(<key>users</key><array/>), render_plist_output
+  end
+
+  test "condition blocks are transparent if the condition passed" do
+    c = RablRails::Condition.new(->(u) { true }, { :name => :name })
+    @template.source = { :_if0 => c }
+    assert_equal %q(<key>name</key><string>foobar</string>), render_plist_output
+  end
+
+  test "condition blocks are ignored if the condition is not met" do
+    c = RablRails::Condition.new(->(u) { false }, { :name => :name })
+    @template.source = { :_if0 => c }
+    assert_equal %q(), render_plist_output
+  end
+
+  test "render object with root node" do
+    RablRails.include_plist_root = true
+    @template.root_name = :author
+    @template.source = { :id => :id, :name => :name }
+    assert_equal %q(<key>author</key><dict><key>id</key><integer>1</integer><key>name</key><string>foobar</string></dict>), render_plist_output
+  end
+
+  test "render object with root options set to false" do
+    RablRails.include_plist_root = false
+    @template.root_name = :author
+    @template.source = { :id => :id, :name => :name }
+    assert_equal %q(<key>id</key><integer>1</integer><key>name</key><string>foobar</string>), render_plist_output
+  end
+end

data/test/test_helper.rb

@@ -22,6 +22,15 @@ class <<Singleton
 end
 
 require 'rabl-rails'
+require 'plist'
+
+if RUBY_ENGINE == 'jruby'
+  require 'nokogiri'
+else
+  require 'libxml'
+end
+
+RablRails.load_default_engines!
 
 module ActiveSupport
   class TestCase

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rabl-rails
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-05 00:00:00.000000000 Z
+date: 2012-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -67,6 +67,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - CHANGELOG.md
 - Gemfile
 - MIT-LICENSE
@@ -81,6 +82,7 @@ files:
 - lib/rabl-rails/renderer.rb
 - lib/rabl-rails/renderers/base.rb
 - lib/rabl-rails/renderers/json.rb
+- lib/rabl-rails/renderers/plist.rb
 - lib/rabl-rails/renderers/xml.rb
 - lib/rabl-rails/responder.rb
 - lib/rabl-rails/template.rb
@@ -90,9 +92,11 @@ files:
 - test/cache_templates_test.rb
 - test/compiler_test.rb
 - test/deep_nesting_test.rb
+- test/keyword_test.rb
 - test/non_restful_response_test.rb
 - test/render_test.rb
 - test/renderers/json_renderer_test.rb
+- test/renderers/plist_renderer_test.rb
 - test/renderers/xml_renderer_test.rb
 - test/test_helper.rb
 homepage: https://github.com/ccocchi/rabl-rails
@@ -123,8 +127,10 @@ test_files:
 - test/cache_templates_test.rb
 - test/compiler_test.rb
 - test/deep_nesting_test.rb
+- test/keyword_test.rb
 - test/non_restful_response_test.rb
 - test/render_test.rb
 - test/renderers/json_renderer_test.rb
+- test/renderers/plist_renderer_test.rb
 - test/renderers/xml_renderer_test.rb
 - test/test_helper.rb