rabl-rails 0.1.1 → 0.1.2

data/.gitignore

@@ -1,7 +1,10 @@
-.bundle/
-log/*.log
-pkg/
-test/dummy/db/*.sqlite3
-test/dummy/log/*.log
-test/dummy/tmp/
-test/dummy/.sass-cache
+## General
+log
+doc
+rdoc
+
+## Bundler
+.bundle
+pkg
+Gemfile.lock
+

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # CHANGELOG
 
+## 0.1.2
+  * Add RablRails#render method (see README or source code)
+  * Fix fail when JSON engine is not found. Now fallback to MultiJson.default_adapter
+  * Warning message printed on logger when JSON engine fail to load
+
 ## 0.1.1
 
   * Add CHANGELOG

data/README.md

@@ -81,6 +81,20 @@ The same rule applies for view helpers such as `current_user`
 
 After the template is compiled into a hash, Rabl-rails will use a renderer to do the actual output. Actually, only JSON and XML formats are supported.
 
+## Configuration
+
+RablRails works out of the box, with default options and fastest engine available (yajl, libxml). But depending on your needs, you might want to change that or how your output looks like. You can set global configuration in your application:
+
+```ruby
+  # config/initializers/rabl_rails.rb
+  RablRails.configure do |config|
+    # These are the default
+    # config.cache_templates = true
+    # config.include_json_root = true
+    # config.json_engine = :yajl
+  end
+```
+
 ## Usage
 
 ### Data declaration
@@ -218,6 +232,22 @@ child :posts do
 end
 ```
 
+### Caching
+
+Caching is not a part of Rabl-rails. It is already in Rails itself, because caching all view output is the same as action caching (Rails caching is even better because it will also not run your queries).
+
+Moreover caching each object in a collection can be really not effective with big collections or simple objects. This is also a nightmare with cache expiration.
+
+### Render object directly
+
+There are cases when you want to render object outside Rails view context. For instance to render objects in the console or to create message queue payloads. For these situations, you can use `RablRails.render` as show below:
+
+```ruby
+Rabl.render(object, template, :view_path => 'app/views', :format => :json) #=> "{...}"
+```
+
+You can find more informations about how to use this method in the [wiki](http://github.com/ccocchi/rabl-rails/wiki/Render-object-directly) 
+
 ## 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
@@ -226,12 +256,6 @@ Overall, Rabl-rails is **20% faster and use 10% less memory**.
 
 You can see full tests on test application repository.
 
-## Caching
-
-Caching is not a part of Rabl-rails. It is already in Rails itself, because caching all view output is the same as action caching (Rails caching is even better because it will also not run your queries).
-
-And caching each object in a collection can be really not effective with big collections or simple objects. This is also a nightmare with cache expiration.
-
 ## Authors and contributors
 
 * [Christopher Cocchi-Perrier](http://github.com/ccocchi) - Creator of the project

data/lib/rabl-rails.rb

@@ -16,26 +16,33 @@ require 'rabl-rails/railtie'
 require 'multi_json'
 
 module RablRails
+  extend Renderer
+  
   mattr_accessor :cache_templates
   @@cache_templates = true
   
   mattr_accessor :include_json_root
   @@include_json_root = true
 
-  mattr_accessor :json_engine
+  mattr_reader :json_engine
   @@json_engine = :yajl
 
   def self.configure
     yield self
-    post_configure
   end
-
+  
+  def self.json_engine=(name)
+    MultiJson.engine = name
+    @@json_engine = name
+  rescue LoadError
+    Rails.logger.warn %Q(WARNING: rabl-rails could not load "#{self.json_engine}" as JSON engine, fallback to default)
+  end
+  
   def self.cache_templates?
     ActionController::Base.perform_caching && @@cache_templates
   end
-
-  private
-  def self.post_configure
-    MultiJson.engine = self.json_engine 
+  
+  def self.load_default_engines!
+    self.json_engine = :yajl
   end
 end

data/lib/rabl-rails/railtie.rb

@@ -1,6 +1,8 @@
 module RablRails
   class Railtie < Rails::Railtie
     initializer "rabl.initialize" do |app|
+      RablRails.load_default_engines!
+      
       ActiveSupport.on_load(:action_view) do
         ActionView::Template.register_template_handler :rabl, RablRails::Handlers::Rabl
       end

data/lib/rabl-rails/renderer.rb

@@ -1,2 +1,91 @@
 require 'rabl-rails/renderers/base'
-require 'rabl-rails/renderers/json'
+require 'rabl-rails/renderers/json'
+
+module RablRails
+  module Renderer
+    class TemplateNotFound < StandardError; end
+    
+    mattr_reader :view_path
+    @@view_path = 'app/views'
+
+    class LookupContext
+      T = Struct.new(:source)
+
+      def initialize(view_path, format)
+        @view_path = view_path || RablRails::Renderer.view_path
+        @format = format
+      end
+
+      #
+      # Manually find given rabl template file with given format.
+      # View path can be set via options, otherwise default Rails
+      # path is used
+      #
+      def find_template(name, opt, partial = false)
+        path = File.join(@view_path, "#{name}.#{@format}.rabl")
+        File.exists?(path) ? T.new(File.read(path)) : nil
+      end
+    end
+
+    #
+    # Context class to emulate normal Rails view
+    # context
+    #
+    class Context
+      attr_reader :format
+      attr_accessor :target_object
+
+      def initialize(path, options)
+        @virtual_path = path
+        @format = options.delete(:format) || 'json'
+        @_assigns = {}
+        @options = options
+
+        options[:locals].each { |k, v| @_assigns[k.to_s] = v } if options[:locals]
+      end
+
+      def assigns
+        @_assigns
+      end
+
+      def params
+        { format: format }
+      end
+
+      def lookup_context
+        @lookup_context ||= LookupContext.new(@options[:view_path], format)
+      end
+    end
+  
+    #
+    # Renders object with the given rabl template.
+    # 
+    # Object can also be passed as an option :
+    # { locals: { object: obj_to_render } }
+    #
+    # Default render format is JSON, but can be changed via
+    # an option: { format: 'xml' }
+    #
+    # If template includes uses of instance variables (usually 
+    # defined in the controller), you can passed them as locals
+    # options.
+    # For example, if you have this template:
+    #   object :@user
+    #   node(:read) { |u| u.has_read?(@post) }
+    #
+    # Your method call should look like this:
+    #   RablRails.render(user, 'users/show', locals: { post: Post.new })
+    #
+    def render(object, template, options = {})
+      object = options[:locals].delete(:object) if !object && options[:locals]
+
+      c = Context.new(template, options)
+      c.target_object = object
+
+      t = c.lookup_context.find_template(template, [], false)
+      raise TemplateNotFound unless t
+
+      Library.instance.get_rendered_template(t.source, c)
+    end
+  end
+end

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

@@ -19,6 +19,7 @@ module RablRails
       #
       def render(template)
         collection_or_resource = instance_variable_get(template.data) if template.data
+        collection_or_resource = @_context.target_object unless collection_or_resource || template.data == false || !@_context.respond_to?(:target_object)
         output_hash = collection_or_resource.respond_to?(:each) ? render_collection(collection_or_resource, template.source) :
           render_resource(collection_or_resource, template.source)
         _options[:root_name] = template.root_name

data/lib/rabl-rails/version.rb

@@ -1,3 +1,3 @@
 module RablRails
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 end

data/test/render_test.rb

@@ -0,0 +1,64 @@
+require 'test_helper'
+require 'pathname'
+require 'tmpdir'
+
+class RenderTest < ActiveSupport::TestCase
+
+  setup do
+    @user = User.new(1, 'Marty')
+    @user.stub(:respond_to?).with(:each).and_return(false)
+    @tmp_path = Pathname.new(Dir.mktmpdir)
+  end
+
+  test "allow object to be passed as an option" do
+    File.open(@tmp_path + "nil.json.rabl", "w") do |f|
+      f.puts %q{
+        object :@user
+        attributes :name
+      }
+    end
+    assert_equal %q({"user":{"name":"Marty"}}), RablRails.render(nil, 'nil', locals: { object: @user }, view_path: @tmp_path)
+  end
+
+  test "load source from file" do
+    File.open(@tmp_path + "show.json.rabl", "w") do |f|
+      f.puts %q{
+        object :@user
+        attributes :id, :name
+      }
+    end
+    assert_equal %q({"user":{"id":1,"name":"Marty"}}), RablRails.render(@user, 'show', view_path: @tmp_path)
+  end
+  
+  test "raise error if template is not found" do
+    assert_raises(RablRails::Renderer::TemplateNotFound) { RablRails.render(@user, 'not_found') }
+  end
+  
+  test "instance variables can be passed via options[:locals]" do
+    File.open(@tmp_path + "instance.json.rabl", "w") do |f|
+      f.puts %q{
+        object false
+        node(:username) { |_| @user.name } 
+      }
+    end
+    assert_equal %q({"username":"Marty"}), RablRails.render(nil, 'instance', view_path: @tmp_path, locals: { user: @user })
+  end
+
+  test "handle path for extends" do
+    File.open(@tmp_path + "extend.json.rabl", "w") do |f|
+      f.puts %q{
+        object :@user
+        extends 'base'
+      }
+    end
+    
+    File.open(@tmp_path + "base.json.rabl", "w") do |f|
+      f.puts %q{
+        attribute :name, as: :extended_name
+      }
+    end
+
+    assert_equal %q({"user":{"extended_name":"Marty"}}), RablRails.render(@user, 'extend', view_path: @tmp_path)
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rabl-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-25 00:00:00.000000000 Z
+date: 2012-08-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -69,7 +69,6 @@ files:
 - .gitignore
 - CHANGELOG.md
 - Gemfile
-- Gemfile.lock
 - MIT-LICENSE
 - README.md
 - Rakefile
@@ -89,6 +88,7 @@ files:
 - test/compiler_test.rb
 - test/deep_nesting_test.rb
 - test/non_restful_response_test.rb
+- test/render_test.rb
 - test/renderers/json_renderer_test.rb
 - test/test_helper.rb
 homepage: https://github.com/ccocchi/rabl-rails
@@ -111,7 +111,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.22
+rubygems_version: 1.8.21
 signing_key: 
 specification_version: 3
 summary: Fast Rails 3+ templating system with JSON and XML support
@@ -120,5 +120,6 @@ test_files:
 - test/compiler_test.rb
 - test/deep_nesting_test.rb
 - test/non_restful_response_test.rb
+- test/render_test.rb
 - test/renderers/json_renderer_test.rb
 - test/test_helper.rb

data/Gemfile.lock

@@ -1,67 +0,0 @@
-PATH
-  remote: .
-  specs:
-    rabl-rails (0.1.0)
-      activesupport (~> 3.0)
-      railties (~> 3.0)
-
-GEM
-  remote: http://rubygems.org/
-  specs:
-    actionpack (3.2.6)
-      activemodel (= 3.2.6)
-      activesupport (= 3.2.6)
-      builder (~> 3.0.0)
-      erubis (~> 2.7.0)
-      journey (~> 1.0.1)
-      rack (~> 1.4.0)
-      rack-cache (~> 1.2)
-      rack-test (~> 0.6.1)
-      sprockets (~> 2.1.3)
-    activemodel (3.2.6)
-      activesupport (= 3.2.6)
-      builder (~> 3.0.0)
-    activesupport (3.2.6)
-      i18n (~> 0.6)
-      multi_json (~> 1.0)
-    builder (3.0.0)
-    erubis (2.7.0)
-    hike (1.2.1)
-    i18n (0.6.0)
-    journey (1.0.4)
-    json (1.7.3)
-    multi_json (1.3.6)
-    rack (1.4.1)
-    rack-cache (1.2)
-      rack (>= 0.4)
-    rack-ssl (1.3.2)
-      rack
-    rack-test (0.6.1)
-      rack (>= 1.0)
-    railties (3.2.6)
-      actionpack (= 3.2.6)
-      activesupport (= 3.2.6)
-      rack-ssl (~> 1.3.2)
-      rake (>= 0.8.7)
-      rdoc (~> 3.4)
-      thor (>= 0.14.6, < 2.0)
-    rake (0.9.2.2)
-    rdoc (3.12)
-      json (~> 1.4)
-    rspec-mocks (2.11.1)
-    sprockets (2.1.3)
-      hike (~> 1.2)
-      rack (~> 1.0)
-      tilt (~> 1.1, != 1.3.0)
-    thor (0.15.4)
-    tilt (1.3.3)
-    yajl-ruby (1.1.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  actionpack (~> 3.0)
-  rabl-rails!
-  rspec-mocks
-  yajl-ruby