rabl 0.6.10 → 0.6.11

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # CHANGELOG
 
+## 0.6.11
+
+  * Changes send to __send__ (Thanks @alindeman)
+  * Change object/collection checks to :map instead of :each
+  * Adds support for auto-escaping attribute configuration (Thanks @databyte)
+  * Adds support for configuration of view_paths (Thanks @ivanvanderbyl)
+  * Fix issue with helpers caching check
+
 ## 0.6.10
 
   * Fixes expected behavior with nil and collection keyword

data/README.md

@@ -101,6 +101,7 @@ Rabl.configure do |config|
   # Commented as these are defaults
   # config.cache_all_output = false
   # config.cache_sources = false
+  # config.escape_all_output = false
   # config.json_engine = nil # Any multi\_json engines
   # config.msgpack_engine = nil # Defaults to ::MessagePack
   # config.bson_engine = nil # Defaults to ::BSON
@@ -112,6 +113,7 @@ Rabl.configure do |config|
   # config.include_xml_root  = false
   # config.enable_json_callbacks = false
   # config.xml_options = { :dasherize  => true, :skip_types => false }
+  # config.view_paths = []
 end
 ```
 
@@ -122,10 +124,16 @@ output if the incoming request has a 'callback' parameter.
 If `cache_sources` is set to `true`, template lookups will be cached for improved performance.
 The cache can be reset manually by running `Rabl.reset_source_cache!` within your application.
 
-If `cache_all_output` is set to `true` then every template including each individual template used as part of a collection will be cached separately.
+If `cache_all_output` is set to `true`, every template including each individual template used as part of a collection will be cached separately.
 Additionally, anything within child, glue and partial will also be cached separately.
 To cache just a single template, see the section titled 'Caching' below.
 
+If `escape_all_output` is set to `true` and ActiveSupport is available, attribute output will be escaped using [ERB::Util.html_escape](http://corelib.rubyonrails.org/classes/ERB/Util.html).
+Custom nodes will not be escaped, use `ERB::Util.h(value)`.
+
+If `view_paths` is set to a path, this view path will be checked for every rabl template within your application.
+Add to this path especially when including Rabl in an engine and using view paths within a another Rails app.
+
 Note that the `json_engine` option uses [multi_json](http://intridea.com/2010/6/14/multi-json-the-swappable-json-handler) engine
 defaults so that in most cases you **don't need to configure this** directly. If you wish to use yajl as
 the primary JSON encoding engine simply add that to your Gemfile:
@@ -139,7 +147,7 @@ and RABL will automatically start using that engine for encoding your JSON respo
 
 ### Format Configuration ###
 
-RABL supports configuration for MessagePack, BSON, and Plist. Check the 
+RABL supports configuration for MessagePack, BSON, and Plist. Check the
 [Format Configuration](https://github.com/nesquena/rabl/wiki/Configuring-Formats) page for more details.
 
 ## Usage ##
@@ -380,7 +388,7 @@ Note that RABL can be nested arbitrarily deep within child nodes to allow for th
 
 ### Caching ###
 
-RABL has built-in caching support for templates leveraging fragment caching strategies. Note that caching is currently **only available** for but support for other frameworks is planned in a future release. Simplest caching usage is:
+RABL has built-in caching support for templates leveraging fragment caching strategies. Note that caching is currently **only available** for Rails but support for other frameworks is planned in a future release. Simplest caching usage is:
 
 ```ruby
 # app/views/users/show.json.rabl
@@ -490,7 +498,7 @@ Thanks to [Miso](http://gomiso.com) for allowing me to create this for our appli
 * [Nathan Esquenazi](https://github.com/nesquena) - Creator of the project
 * [Arthur Chiu](https://github.com/achiu) - Core Maintainer, Riot Testing Guru
 * [Tim Lee](https://github.com/timothy1ee) - RABL was a great name chosen by the Miso CTO.
-* [David Sommers](https://github.com/databyte) - Enhanced template resolution and added caching support
+* [David Sommers](https://github.com/databyte) - Template resolution, caching support, and much more
 * [Rick Thomas](https://github.com/rickthomasjr) - Added options for extends and Sinatra testing
 * [Benjamin Yu](https://github.com/byu) - Added msgpack format support
 * [Chris Kimpton](https://github.com/kimptoc) - Helping with documentation and wiki

data/fixtures/padrino_test/test/app/controllers/posts_controller_test.rb

@@ -21,7 +21,7 @@ context "PostsController" do
 
   context "for index action" do
     setup do
-      get "/posts", format: :json
+      get "/posts", :format => :json
     end
 
     # Attributes (regular)
@@ -74,7 +74,7 @@ context "PostsController" do
 
   context "for show action" do
     setup do
-      get "/posts/#{@post1.id}", format: :json
+      get "/posts/#{@post1.id}", :format => :json
       json_output['post']
     end
 

data/fixtures/rails2/test/functionals/posts_controller_test.rb

@@ -21,7 +21,7 @@ context "PostsController" do
 
   context "for index action" do
     setup do
-      get "/posts", format: :json
+      get "/posts", :format => :json
     end
 
     # Attributes (regular)
@@ -74,7 +74,7 @@ context "PostsController" do
 
   context "for show action" do
     setup do
-      get "/posts/#{@post1.id}", format: :json
+      get "/posts/#{@post1.id}", :format => :json
       json_output['post']
     end
 

data/fixtures/rails3/test/functional/posts_controller_test.rb

@@ -21,7 +21,7 @@ context "PostsController" do
 
   context "for index action" do
     setup do
-      get "/posts", format: :json
+      get "/posts", :format => :json
     end
 
     # Attributes (regular)
@@ -74,7 +74,7 @@ context "PostsController" do
 
   context "for show action" do
     setup do
-      get "/posts/#{@post1.id}", format: :json
+      get "/posts/#{@post1.id}", :format => :json
       json_output['post']
     end
 

data/fixtures/rails3_2/test/functional/posts_controller_test.rb

@@ -17,7 +17,7 @@ context "PostsController" do
     Post.delete_all
     @post1 = Post.create(:title => "Foo", :body => "Bar", :user_id => @user1.id)
     @post2 = Post.create(:title => "Baz", :body => "Bah", :user_id => @user2.id)
-    @post3 = Post.create(:title => "Kaz", :body => "Paz", :user_id => @user3.id)
+    @post3 = Post.create(:title => "Kaz", :body => "<script>alert('xss & test');</script>", :user_id => @user3.id)
     @posts = [@post1, @post2, @post3]
   end
 
@@ -74,6 +74,32 @@ context "PostsController" do
     end.includes(:created_by_admin)
   end # index action, json
 
+  context "escaping output in index action" do
+    context "for first post" do
+      setup do
+        Rabl.configuration.escape_all_output = true
+        get "/posts/#{@post1.id}", format: :json
+        json_output['post']
+      end
+
+      # Attributes (regular)
+      asserts("contains post title") { topic['title'] }.equals { @post1.title }
+      asserts("contains post body")  { topic['body'] }.equals { @post1.body }
+    end
+
+    context "for third post with script tags" do
+      setup do
+        Rabl.configuration.escape_all_output = true
+        get "/posts/#{@post3.id}", format: :json
+        json_output['post']
+      end
+
+      # Attributes (regular)
+      asserts("contains post title") { topic['title'] }.equals { @post3.title }
+      asserts("contains escaped post body")  { topic['body'] }.equals { ERB::Util.h(@post3.body) }
+    end
+  end # escaping output
+
   context "for show action" do
     setup do
       get "/posts/#{@post1.id}", format: :json
@@ -85,7 +111,7 @@ context "PostsController" do
     asserts("contains post body")  { topic['body'] }.equals { @post1.body }
 
     # Attributes (custom name)
-    asserts("contains post posted_at") { topic['posted_at'] }.equals { @post1.created_at.iso8601 }
+    asserts("contains post posted_at") { topic['posted_at'] }.equals { @post1.created_at.utc.to_s }
 
     # Child
     asserts("contains post user child username") { topic["user"]["username"] }.equals { @post1.user.username }

data/fixtures/rails3_2/test/functional/users_controller_test.rb

@@ -35,7 +35,7 @@ context "UsersController" do
     # Attributes (custom name)
     asserts("contains registered_at") do
       json_output.map { |u| u["user"]["registered_at"] }
-    end.equals { @users.map(&:created_at).map(&:iso8601) }
+    end.equals { @users.map(&:created_at).map(&:utc).map(&:to_s) }
 
     # Node (renders based on attribute)
     asserts("contains role") do
@@ -64,7 +64,7 @@ context "UsersController" do
     asserts("contains email") { json_output["person"]["email"] }.equals { @user1.email }
     asserts("contains location") { json_output["person"]["location"] }.equals { @user1.location }
     # Attributes (custom name)
-    asserts("contains registered_at") { json_output["person"]["registered_at"] }.equals { @user1.created_at.iso8601 }
+    asserts("contains registered_at") { json_output["person"]["registered_at"] }.equals { @user1.created_at.utc.to_s }
     # Node (renders based on attribute)
     asserts("contains role node") { json_output["person"]["role"] }.equals "normal"
 

data/fixtures/sinatra_test/test/functional/posts_controller_test.rb

@@ -21,7 +21,7 @@ context "PostsController" do
 
   context "for index action" do
     setup do
-      get "/posts", format: :json
+      get "/posts", :format => :json
     end
 
     # Attributes (regular)
@@ -74,7 +74,7 @@ context "PostsController" do
 
   context "for show action" do
     setup do
-      get "/posts/#{@post1.id}", format: :json
+      get "/posts/#{@post1.id}", :format => :json
       json_output['post']
     end
 

data/lib/rabl/builder.rb

@@ -63,7 +63,7 @@ module Rabl
     # Indicates an attribute or method should be included in the json output
     # attribute :foo, :as => "bar"
     def attribute(name, options={})
-      @_result[options[:as] || name] = @_object.send(name) if @_object && @_object.respond_to?(name)
+      @_result[options[:as] || name] = data_object_attribute(name) if @_object && @_object.respond_to?(name)
     end
     alias_method :attributes, :attribute
 

data/lib/rabl/configuration.rb

@@ -36,6 +36,8 @@ module Rabl
     attr_writer   :xml_options
     attr_accessor :cache_sources
     attr_accessor :cache_all_output
+    attr_accessor :escape_all_output
+    attr_accessor :view_paths
 
     DEFAULT_XML_OPTIONS = { :dasherize  => true, :skip_types => false }
 
@@ -55,6 +57,8 @@ module Rabl
       @xml_options           = {}
       @cache_sources         = false
       @cache_all_output      = false
+      @escape_all_output     = false
+      @view_paths            = []
     end
 
     # @param [Symbol, String, #encode] engine_name The name of a JSON engine,
@@ -94,7 +98,7 @@ module Rabl
     #
     # @param [Symbol] option Key for a given attribute
     def [](option)
-      send(option)
+      __send__(option)
     end
 
     # Returns merged default and inputted xml options

data/lib/rabl/engine.rb

@@ -176,7 +176,7 @@ module Rabl
     # Includes a helper module with a RABL template
     # helper ExampleHelper
     def helper(*klazzes)
-      klazzes.each { |klazz| self.class.send(:include, klazz) }
+      klazzes.each { |klazz| self.class.__send__(:include, klazz) }
     end
     alias_method :helpers, :helper
 
@@ -225,7 +225,7 @@ module Rabl
 
     # Supports calling helpers defined for the template scope using method_missing hook
     def method_missing(name, *args, &block)
-      context_scope.respond_to?(name) ? context_scope.send(name, *args, &block) : super
+      context_scope.respond_to?(name, true) ? context_scope.__send__(name, *args, &block) : super
     end
 
     def copy_instance_variables_from(object, exclude = []) #:nodoc:

data/lib/rabl/helpers.rb

@@ -8,7 +8,12 @@ module Rabl
     # data_object(:user => :person) => @_object.send(:user)
     def data_object(data)
       data = (data.is_a?(Hash) && data.keys.size == 1) ? data.keys.first : data
-      data.is_a?(Symbol) && @_object ? @_object.send(data) : data
+      data.is_a?(Symbol) && @_object ? @_object.__send__(data) : data
+    end
+
+    # data_object_attribute(data) => @_object.send(data)
+    def data_object_attribute(data)
+      escape_output @_object.__send__(data)
     end
 
     # data_name(data) => "user"
@@ -19,7 +24,7 @@ module Rabl
     def data_name(data)
       return nil unless data # nil or false
       return data.values.first if data.is_a?(Hash) # @user => :user
-      data = @_object.send(data) if data.is_a?(Symbol) && @_object # :address
+      data = @_object.__send__(data) if data.is_a?(Symbol) && @_object # :address
       if is_collection?(data) && data.respond_to?(:first) # data collection
         data_name(data.first).to_s.pluralize if data.first.present?
       elsif is_object?(data) # actual data object
@@ -50,12 +55,12 @@ module Rabl
     # is_object?([]) => false
     # is_object?({}) => false
     def is_object?(obj)
-      obj && !data_object(obj).respond_to?(:each)
+      obj && !data_object(obj).respond_to?(:map)
     end
 
     # Returns true if the obj is a collection of items
     def is_collection?(obj)
-      obj && data_object(obj).respond_to?(:each)
+      obj && data_object(obj).respond_to?(:map)
     end
 
     # Returns the scope wrapping this engine, used for retrieving data, invoking methods, etc
@@ -87,7 +92,12 @@ module Rabl
 
     # Returns true if the cache has been enabled for the application
     def template_cache_configured?
-      defined?(Rails) && defined?(ActionController) && ActionController::Base.perform_caching
+      defined?(Rails) && defined?(ActionController::Base) && ActionController::Base.perform_caching
+    end
+
+    # Escape output if configured and supported
+    def escape_output(data)
+      defined?(ERB::Util.h) && Rabl.configuration.escape_all_output ? ERB::Util.h(data) : data
     end
 
   end

data/lib/rabl/partials.rb

@@ -30,21 +30,21 @@ module Rabl
     # Returns source for a given relative file
     # fetch_source("show", :view_path => "...") => "...contents..."
     def fetch_source(file, options={})
-      Rabl.source_cache(file, options[:view_path]) do
+      view_paths = Array(options[:view_path]) + Array(Rabl.configuration.view_paths)
+      Rabl.source_cache(file, view_paths) do
         file_path = if defined?(Padrino) && context_scope.respond_to?(:settings)
           fetch_padrino_source(file, options)
         elsif defined?(Rails) && context_scope.respond_to?(:view_paths)
-          view_path = Array(options[:view_path] || context_scope.view_paths.to_a)
-          fetch_rails_source(file, options) || fetch_manual_template(view_path, file)
+          _view_paths = view_paths + Array(context_scope.view_paths.to_a)
+          fetch_rails_source(file, options) || fetch_manual_template(_view_paths, file)
         elsif defined?(Sinatra) && context_scope.respond_to?(:settings)
           fetch_sinatra_source(file, options)
         else # generic template resolution
-          view_path = Array(options[:view_path])
-          fetch_manual_template(view_path, file)
+          fetch_manual_template(view_paths, file)
         end
 
         unless File.exist?(file_path.to_s)
-          raise "Cannot find rabl template '#{file}' within registered (#{file_path}) view paths!"
+          raise "Cannot find rabl template '#{file}' within registered (#{view_paths.map(&:to_s).inspect}) view paths!"
         end
 
         [File.read(file_path.to_s), file_path.to_s] if file_path

data/lib/rabl/version.rb

@@ -1,3 +1,3 @@
 module Rabl
-  VERSION = "0.6.10"
+  VERSION = "0.6.11"
 end

data/test/bson_engine_test.rb

@@ -4,7 +4,6 @@ require File.expand_path('../../lib/rabl/template', __FILE__)
 require File.expand_path('../models/user', __FILE__)
 
 context "Rabl::Engine" do
-
   helper(:rabl) { |t| RablTemplate.new("code", :format => 'bson') { t } }
 
   context "with bson defaults" do
@@ -16,7 +15,6 @@ context "Rabl::Engine" do
     end
 
     context "#object" do
-
       asserts "that it sets data source" do
         template = rabl %q{
           object @user
@@ -37,7 +35,6 @@ context "Rabl::Engine" do
     end
 
     context "#collection" do
-
       asserts "that it sets object to be casted as a simple array" do
         template = rabl %{
           collection @users
@@ -55,11 +52,9 @@ context "Rabl::Engine" do
         scope.instance_variable_set :@users, [User.new, User.new]
         template.render(scope).split("").sort
       end.equals "<\x00\x00\x00\x04people\x00/\x00\x00\x00\x030\x00\x12\x00\x00\x00\x03person\x00\x05\x00\x00\x00\x00\x00\x031\x00\x12\x00\x00\x00\x03person\x00\x05\x00\x00\x00\x00\x00\x00\x00".split("").sort
-
     end
 
     context "#attribute" do
-
       asserts "that it adds an attribute or method to be included in output" do
         template = rabl %{
           object @user
@@ -89,11 +84,9 @@ context "Rabl::Engine" do
         scope.instance_variable_set :@user, User.new(:name => 'irvine')
         template.render(scope).split("").sort
       end.equals "!\x00\x00\x00\x03user\x00\x16\x00\x00\x00\x02city\x00\a\x00\x00\x00irvine\x00\x00\x00".split("").sort
-
     end
 
     context "#code" do
-
       asserts "that it can create an arbitraty code node" do
         template = rabl %{
           code(:foo) { 'bar' }
@@ -107,11 +100,9 @@ context "Rabl::Engine" do
         }
         template.render(Object.new).split("").sort
       end.equals "\x05\x00\x00\x00\x00".split("").sort
-
     end
 
     context "#child" do
-
       asserts "that it can create a child node" do
         template = rabl %{
           object @user
@@ -136,7 +127,6 @@ context "Rabl::Engine" do
     end
 
     context "#glue" do
-
       asserts "that it glues data from a child node" do
         template = rabl %{
           object @user
@@ -190,7 +180,6 @@ context "Rabl::Engine" do
     end
 
     context "#object" do
-
       asserts "that it sets data source" do
         template = rabl %q{
           object @user
@@ -211,7 +200,6 @@ context "Rabl::Engine" do
     end
 
     context "#collection" do
-
       asserts "that it sets object to be casted as a simple array" do
         template = rabl %{
           collection @users
@@ -229,11 +217,9 @@ context "Rabl::Engine" do
         scope.instance_variable_set :@users, [User.new, User.new]
         template.render(scope).split("").sort
       end.equals "\"\x00\x00\x00\x04person\x00\x15\x00\x00\x00\x030\x00\x05\x00\x00\x00\x00\x031\x00\x05\x00\x00\x00\x00\x00\x00".split("").sort
-
     end
 
     context "#attribute" do
-
       asserts "that it adds an attribute or method to be included in output" do
         template = rabl %{
           object @user
@@ -263,11 +249,9 @@ context "Rabl::Engine" do
         scope.instance_variable_set :@user, User.new(:name => 'irvine')
         template.render(scope).split("").sort
       end.equals "\x16\x00\x00\x00\x02city\x00\a\x00\x00\x00irvine\x00\x00".split("").sort
-
     end
 
     context "#code" do
-
       asserts "that it can create an arbitraty code node" do
         template = rabl %{
           code(:foo) { 'bar' }
@@ -281,11 +265,9 @@ context "Rabl::Engine" do
         }
         template.render(Object.new).split("").sort
       end.equals "\x05\x00\x00\x00\x00".split("").sort
-
     end
 
     context "#child" do
-
       asserts "that it can create a child node" do
         template = rabl %{
           object @user
@@ -310,7 +292,6 @@ context "Rabl::Engine" do
     end
 
     context "#glue" do
-
       asserts "that it glues data from a child node" do
         template = rabl %{
           object @user

data/test/builder_test.rb

@@ -2,7 +2,6 @@ require File.expand_path('../teststrap',   __FILE__)
 require File.expand_path('../models/user', __FILE__)
 
 context "Rabl::Builder" do
-
   helper(:builder)    { |opt| Rabl::Builder.new(opt) }
   helper(:build_hash) { |obj, opt| builder(opt).build(obj) }
 

data/test/configuration_test.rb

@@ -10,6 +10,7 @@ context 'Rabl::Configuration' do
     asserts(:include_json_root).equals true
     asserts(:include_xml_root).equals false
     asserts(:enable_json_callbacks).equals false
+    asserts(:view_paths).equals []
     asserts(:json_engine).equals { json_engine }
   end
 

data/test/engine_test.rb

@@ -5,7 +5,6 @@ require File.expand_path('../models/user', __FILE__)
 require File.expand_path('../models/ormless', __FILE__)
 
 context "Rabl::Engine" do
-
   helper(:rabl) { |t| RablTemplate.new { t } }
 
   context "#initialize" do

data/test/helpers_test.rb

@@ -28,5 +28,51 @@ context "Rabl::Helpers" do
     asserts "returns name of an object" do
       @helper_class.data_name(@user)
     end.equals('user')
-  end
+  end # data_name method
+
+  context "for is_object method" do
+    asserts "returns nil if no data" do
+      @helper_class.is_object?(nil)
+    end.equals(nil)
+
+    asserts "returns true for an object" do
+      @helper_class.is_object?(@user)
+    end.equals(true)
+
+    # asserts "returns true for an object with each" do
+    #   obj = Class.new { def each; end }
+    #   @helper_class.is_object?(obj.new)
+    # end.equals(true)
+
+    asserts "returns true for a hash alias" do
+      @helper_class.is_object?(@user => :user)
+    end.equals(true)
+
+    asserts "returns false for an array" do
+      @helper_class.is_object?([@user])
+    end.equals(false)
+  end # is_object method
+
+  context "for is_collection method" do
+    asserts "returns nil if no data" do
+      @helper_class.is_collection?(nil)
+    end.equals(nil)
+
+    asserts "returns false for an object" do
+      @helper_class.is_collection?(@user)
+    end.equals(false)
+
+    # asserts "returns false for an object with each" do
+    #  obj = Class.new { def each; end }
+    #  @helper_class.is_collection?(obj.new)
+    # end.equals(false)
+
+    asserts "returns false for a hash alias" do
+      @helper_class.is_collection?(@user => :user)
+    end.equals(false)
+
+    asserts "returns true for an array" do
+      @helper_class.is_collection?([@user])
+    end.equals(true)
+  end # is_collection method
 end

data/test/integration/posts_controller_test.rb

@@ -21,7 +21,7 @@ context "PostsController" do
 
   context "for index action" do
     setup do
-      get "/posts", format: :json
+      get "/posts", :format => :json
     end
 
     # Attributes (regular)
@@ -74,7 +74,7 @@ context "PostsController" do
 
   context "for show action" do
     setup do
-      get "/posts/#{@post1.id}", format: :json
+      get "/posts/#{@post1.id}", :format => :json
       json_output['post']
     end
 

data/test/integration/rails3_2/posts_controller_test.rb

@@ -17,7 +17,7 @@ context "PostsController" do
     Post.delete_all
     @post1 = Post.create(:title => "Foo", :body => "Bar", :user_id => @user1.id)
     @post2 = Post.create(:title => "Baz", :body => "Bah", :user_id => @user2.id)
-    @post3 = Post.create(:title => "Kaz", :body => "Paz", :user_id => @user3.id)
+    @post3 = Post.create(:title => "Kaz", :body => "<script>alert('xss & test');</script>", :user_id => @user3.id)
     @posts = [@post1, @post2, @post3]
   end
 
@@ -74,6 +74,32 @@ context "PostsController" do
     end.includes(:created_by_admin)
   end # index action, json
 
+  context "escaping output in index action" do
+    context "for first post" do
+      setup do
+        Rabl.configuration.escape_all_output = true
+        get "/posts/#{@post1.id}", format: :json
+        json_output['post']
+      end
+
+      # Attributes (regular)
+      asserts("contains post title") { topic['title'] }.equals { @post1.title }
+      asserts("contains post body")  { topic['body'] }.equals { @post1.body }
+    end
+
+    context "for third post with script tags" do
+      setup do
+        Rabl.configuration.escape_all_output = true
+        get "/posts/#{@post3.id}", format: :json
+        json_output['post']
+      end
+
+      # Attributes (regular)
+      asserts("contains post title") { topic['title'] }.equals { @post3.title }
+      asserts("contains escaped post body")  { topic['body'] }.equals { ERB::Util.h(@post3.body) }
+    end
+  end # escaping output
+
   context "for show action" do
     setup do
       get "/posts/#{@post1.id}", format: :json
@@ -85,7 +111,7 @@ context "PostsController" do
     asserts("contains post body")  { topic['body'] }.equals { @post1.body }
 
     # Attributes (custom name)
-    asserts("contains post posted_at") { topic['posted_at'] }.equals { @post1.created_at.iso8601 }
+    asserts("contains post posted_at") { topic['posted_at'] }.equals { @post1.created_at.utc.to_s }
 
     # Child
     asserts("contains post user child username") { topic["user"]["username"] }.equals { @post1.user.username }

data/test/integration/rails3_2/users_controller_test.rb

@@ -35,7 +35,7 @@ context "UsersController" do
     # Attributes (custom name)
     asserts("contains registered_at") do
       json_output.map { |u| u["user"]["registered_at"] }
-    end.equals { @users.map(&:created_at).map(&:iso8601) }
+    end.equals { @users.map(&:created_at).map(&:utc).map(&:to_s) }
 
     # Node (renders based on attribute)
     asserts("contains role") do
@@ -64,7 +64,7 @@ context "UsersController" do
     asserts("contains email") { json_output["person"]["email"] }.equals { @user1.email }
     asserts("contains location") { json_output["person"]["location"] }.equals { @user1.location }
     # Attributes (custom name)
-    asserts("contains registered_at") { json_output["person"]["registered_at"] }.equals { @user1.created_at.iso8601 }
+    asserts("contains registered_at") { json_output["person"]["registered_at"] }.equals { @user1.created_at.utc.to_s }
     # Node (renders based on attribute)
     asserts("contains role node") { json_output["person"]["role"] }.equals "normal"
 

data/test/msgpack_engine_test.rb

@@ -4,7 +4,6 @@ require File.expand_path('../../lib/rabl/template', __FILE__)
 require File.expand_path('../models/user', __FILE__)
 
 context "Rabl::Engine" do
-
   helper(:rabl) { |t| RablTemplate.new("code", :format => 'msgpack') { t } }
 
   context "with msgpack defaults" do
@@ -16,7 +15,6 @@ context "Rabl::Engine" do
     end
 
     context "#object" do
-
       asserts "that it sets data source" do
         template = rabl %q{
           object @user
@@ -37,7 +35,6 @@ context "Rabl::Engine" do
     end
 
     context "#collection" do
-
       asserts "that it sets object to be casted as a simple array" do
         template = rabl %{
           collection @users
@@ -55,11 +52,9 @@ context "Rabl::Engine" do
         scope.instance_variable_set :@users, [User.new, User.new]
         template.render(scope).split("").sort
       end.equals "\x81\xA6person\x92\x81\xA6person\x80\x81\xA6person\x80".split("").sort
-
     end
 
     context "#attribute" do
-
       asserts "that it adds an attribute or method to be included in output" do
         template = rabl %{
           object @user
@@ -89,11 +84,9 @@ context "Rabl::Engine" do
         scope.instance_variable_set :@user, User.new(:name => 'irvine')
         template.render(scope).split("").sort
       end.equals "\x81\xA4user\x81\xA4city\xA6irvine".split("").sort
-
     end
 
     context "#code" do
-
       asserts "that it can create an arbitraty code node" do
         template = rabl %{
           code(:foo) { 'bar' }
@@ -107,11 +100,9 @@ context "Rabl::Engine" do
         }
         template.render(Object.new).split("").sort
       end.equals "\x80".split("").sort
-
     end
 
     context "#child" do
-
       asserts "that it can create a child node" do
         template = rabl %{
           object @user
@@ -137,7 +128,6 @@ context "Rabl::Engine" do
     end
 
     context "#glue" do
-
       asserts "that it glues data from a child node" do
         template = rabl %{
           object @user
@@ -191,7 +181,6 @@ context "Rabl::Engine" do
     end
 
     context "#object" do
-
       asserts "that it sets data source" do
         template = rabl %q{
           object @user
@@ -212,7 +201,6 @@ context "Rabl::Engine" do
     end
 
     context "#collection" do
-
       asserts "that it sets object to be casted as a simple array" do
         template = rabl %{
           collection @users
@@ -230,11 +218,9 @@ context "Rabl::Engine" do
         scope.instance_variable_set :@users, [User.new, User.new]
         template.render(scope).split("").sort
       end.equals "\x81\xA6person\x92\x80\x80".split("").sort
-
     end
 
     context "#attribute" do
-
       asserts "that it adds an attribute or method to be included in output" do
         template = rabl %{
           object @user
@@ -264,11 +250,9 @@ context "Rabl::Engine" do
         scope.instance_variable_set :@user, User.new(:name => 'irvine')
         template.render(scope).split("").sort
       end.equals "\x81\xA4city\xA6irvine".split("").sort
-
     end
 
     context "#code" do
-
       asserts "that it can create an arbitraty code node" do
         template = rabl %{
           code(:foo) { 'bar' }
@@ -282,11 +266,9 @@ context "Rabl::Engine" do
         }
         template.render(Object.new).split("").sort
       end.equals "\x80".split("").sort
-
     end
 
     context "#child" do
-
       asserts "that it can create a child node" do
         template = rabl %{
           object @user
@@ -311,7 +293,6 @@ context "Rabl::Engine" do
     end
 
     context "#glue" do
-
       asserts "that it glues data from a child node" do
         template = rabl %{
           object @user

data/test/partials_test.rb

@@ -62,4 +62,27 @@ context "Rabl::Partials" do
     end
     teardown { Object.send(:remove_const, :Sinatra) }
   end
+
+  context "fetch source using configured view paths" do
+    helper(:tmp_path) { @tmp_path ||= Pathname.new(Dir.mktmpdir) }
+
+    setup do
+      Rabl.configure do |config|
+        config.view_paths = tmp_path
+      end
+
+      ::Sinatra = stub(Class.new)
+      File.open(tmp_path + "test.rabl", "w") do |f|
+        f.puts "content"
+      end
+      File.open(tmp_path + "test.json.rabl", "w") do |f|
+        f.puts "content2"
+      end
+      TestPartial.new.fetch_source('test')
+    end
+    asserts('detects file.json.rabl first') { topic }.equals do
+      ["content2\n", (tmp_path + 'test.json.rabl').to_s]
+    end
+    teardown { Object.send(:remove_const, :Sinatra) }
+  end
 end

data/test/plist_engine_test.rb

@@ -4,7 +4,6 @@ require File.expand_path('../../lib/rabl/template', __FILE__)
 require File.expand_path('../models/user', __FILE__)
 
 context "Rabl::Engine" do
-
   helper(:rabl) { |t| RablTemplate.new("code", :format => 'plist') { t } }
 
   context "with plist defaults" do
@@ -16,7 +15,6 @@ context "Rabl::Engine" do
     end
 
     context "#object" do
-
       asserts "that it sets data source" do
         template = rabl %q{
           object @user
@@ -37,7 +35,6 @@ context "Rabl::Engine" do
     end
 
     context "#collection" do
-
       asserts "that it sets object to be casted as a simple array" do
         template = rabl %{
           collection @users
@@ -55,11 +52,9 @@ context "Rabl::Engine" do
         scope.instance_variable_set :@users, [User.new, User.new]
         template.render(scope).split("").sort
       end.equals "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<!DOCTYPE plist PUBLIC \"-//Apple Computer//DTD PLIST 1.0//EN\" \"http://www.apple.com/DTDs/PropertyList-1.0.dtd\">\n<plist version=\"1.0\">\n<dict>\n\t<key>person</key>\n\t<array>\n\t\t<dict>\n\t\t\t<key>person</key>\n\t\t\t<dict/>\n\t\t</dict>\n\t\t<dict>\n\t\t\t<key>person</key>\n\t\t\t<dict/>\n\t\t</dict>\n\t</array>\n</dict>\n</plist>\n".split("").sort
-
     end
 
     context "#attribute" do
-
       asserts "that it adds an attribute or method to be included in output" do
         template = rabl %{
           object @user
@@ -89,11 +84,9 @@ context "Rabl::Engine" do
         scope.instance_variable_set :@user, User.new(:name => 'irvine')
         template.render(scope).split("").sort
       end.equals "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<!DOCTYPE plist PUBLIC \"-//Apple Computer//DTD PLIST 1.0//EN\" \"http://www.apple.com/DTDs/PropertyList-1.0.dtd\">\n<plist version=\"1.0\">\n<dict>\n\t<key>user</key>\n\t<dict>\n\t\t<key>city</key>\n\t\t<string>irvine</string>\n\t</dict>\n</dict>\n</plist>\n".split("").sort
-
     end
 
     context "#code" do
-
       asserts "that it can create an arbitraty code node" do
         template = rabl %{
           code(:foo) { 'bar' }
@@ -107,21 +100,18 @@ context "Rabl::Engine" do
         }
         template.render(Object.new).split("").sort
       end.equals "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<!DOCTYPE plist PUBLIC \"-//Apple Computer//DTD PLIST 1.0//EN\" \"http://www.apple.com/DTDs/PropertyList-1.0.dtd\">\n<plist version=\"1.0\">\n<dict/>\n</plist>\n".split("").sort
-
     end
 
     context "#child" do
-
       asserts "that it can create a child node" do
         template = rabl %{
           object @user
-          attribute :name
           child(@user) { attribute :city }
         }
         scope = Object.new
         scope.instance_variable_set :@user, User.new(:name => 'leo', :city => 'LA')
         template.render(scope).split("").sort
-      end.equals "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<!DOCTYPE plist PUBLIC \"-//Apple Computer//DTD PLIST 1.0//EN\" \"http://www.apple.com/DTDs/PropertyList-1.0.dtd\">\n<plist version=\"1.0\">\n<dict>\n\t<key>user</key>\n\t<dict>\n\t\t<key>name</key>\n\t\t<string>leo</string>\n\t\t<key>user</key>\n\t\t<dict>\n\t\t\t<key>city</key>\n\t\t\t<string>LA</string>\n\t\t</dict>\n\t</dict>\n</dict>\n</plist>\n".split("").sort
+      end.equals "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<!DOCTYPE plist PUBLIC \"-//Apple Computer//DTD PLIST 1.0//EN\" \"http://www.apple.com/DTDs/PropertyList-1.0.dtd\">\n<plist version=\"1.0\">\n<dict>\n\t<key>user</key>\n\t<dict>\n\t\t<key>user</key>\n\t\t<dict>\n\t\t\t<key>city</key>\n\t\t\t<string>LA</string>\n\t\t</dict>\n\t</dict>\n</dict>\n</plist>\n".split("").sort
 
       asserts "that it can create a child node with different key" do
         template = rabl %{
@@ -132,12 +122,10 @@ context "Rabl::Engine" do
         scope = Object.new
         scope.instance_variable_set :@user, User.new(:name => 'leo', :city => 'LA')
         template.render(scope)
-
       end.equals "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<!DOCTYPE plist PUBLIC \"-//Apple Computer//DTD PLIST 1.0//EN\" \"http://www.apple.com/DTDs/PropertyList-1.0.dtd\">\n<plist version=\"1.0\">\n<dict>\n\t<key>user</key>\n\t<dict>\n\t\t<key>name</key>\n\t\t<string>leo</string>\n\t\t<key>person</key>\n\t\t<dict>\n\t\t\t<key>city</key>\n\t\t\t<string>LA</string>\n\t\t</dict>\n\t</dict>\n</dict>\n</plist>\n"
     end
 
     context "#glue" do
-
       asserts "that it glues data from a child node" do
         template = rabl %{
           object @user
@@ -191,7 +179,6 @@ context "Rabl::Engine" do
     end
 
     context "#object" do
-
       asserts "that it sets data source" do
         template = rabl %q{
           object @user
@@ -212,7 +199,6 @@ context "Rabl::Engine" do
     end
 
     context "#collection" do
-
       asserts "that it sets object to be casted as a simple array" do
         template = rabl %{
           collection @users
@@ -230,11 +216,9 @@ context "Rabl::Engine" do
         scope.instance_variable_set :@users, [User.new, User.new]
         template.render(scope)
       end.equals "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<!DOCTYPE plist PUBLIC \"-//Apple Computer//DTD PLIST 1.0//EN\" \"http://www.apple.com/DTDs/PropertyList-1.0.dtd\">\n<plist version=\"1.0\">\n<dict>\n\t<key>person</key>\n\t<array>\n\t\t<dict/>\n\t\t<dict/>\n\t</array>\n</dict>\n</plist>\n"
-
     end
 
     context "#attribute" do
-
       asserts "that it adds an attribute or method to be included in output" do
         template = rabl %{
           object @user
@@ -264,11 +248,9 @@ context "Rabl::Engine" do
         scope.instance_variable_set :@user, User.new(:name => 'irvine')
         template.render(scope)
       end.equals "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<!DOCTYPE plist PUBLIC \"-//Apple Computer//DTD PLIST 1.0//EN\" \"http://www.apple.com/DTDs/PropertyList-1.0.dtd\">\n<plist version=\"1.0\">\n<dict>\n\t<key>city</key>\n\t<string>irvine</string>\n</dict>\n</plist>\n"
-
     end
 
     context "#code" do
-
       asserts "that it can create an arbitrary code node" do
         template = rabl %{
           code(:foo) { 'bar' }
@@ -282,21 +264,18 @@ context "Rabl::Engine" do
         }
         template.render(Object.new)
       end.equals "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<!DOCTYPE plist PUBLIC \"-//Apple Computer//DTD PLIST 1.0//EN\" \"http://www.apple.com/DTDs/PropertyList-1.0.dtd\">\n<plist version=\"1.0\">\n<dict/>\n</plist>\n"
-
     end
 
     context "#child" do
-
       asserts "that it can create a child node" do
         template = rabl %{
           object @user
-          attribute :name
           child(@user) { attribute :city }
         }
         scope = Object.new
         scope.instance_variable_set :@user, User.new(:name => 'leo', :city => 'LA')
         template.render(scope).split("").sort
-      end.equals "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<!DOCTYPE plist PUBLIC \"-//Apple Computer//DTD PLIST 1.0//EN\" \"http://www.apple.com/DTDs/PropertyList-1.0.dtd\">\n<plist version=\"1.0\">\n<dict>\n\t<key>name</key>\n\t<string>leo</string>\n\t<key>user</key>\n\t<dict>\n\t\t<key>city</key>\n\t\t<string>LA</string>\n\t</dict>\n</dict>\n</plist>\n".split("").sort
+      end.equals "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<!DOCTYPE plist PUBLIC \"-//Apple Computer//DTD PLIST 1.0//EN\" \"http://www.apple.com/DTDs/PropertyList-1.0.dtd\">\n<plist version=\"1.0\">\n<dict>\n\t<key>user</key>\n\t<dict>\n\t\t<key>city</key>\n\t\t<string>LA</string>\n\t</dict>\n</dict>\n</plist>\n".split("").sort
 
       asserts "that it can create a child node with different key" do
         template = rabl %{
@@ -311,7 +290,6 @@ context "Rabl::Engine" do
     end
 
     context "#glue" do
-
       asserts "that it glues data from a child node" do
         template = rabl %{
           object @user

data/test/renderer_test.rb

@@ -3,6 +3,7 @@ require 'pathname'
 
 context "Rabl::Renderer" do
   helper(:tmp_path) { @tmp_path ||= Pathname.new(Dir.mktmpdir) }
+
   context "#render" do
     asserts 'renders empty array' do
       source = %q{
@@ -60,14 +61,12 @@ context "Rabl::Renderer" do
         attribute :name, :as => 'city'
       }
 
-      scope = Object.new
       user = User.new(:name => 'irvine')
 
       renderer = Rabl::Renderer.new(source, nil, { :format => 'json', :locals => {:object => user} })
       renderer.render.split("").sort
     end.equals "{\"user\":{\"city\":\"irvine\"}}".split("").sort
 
-
     asserts 'loads source from file' do
       File.open(tmp_path + "test.json.rabl", "w") do |f|
         f.puts %q{
@@ -82,6 +81,23 @@ context "Rabl::Renderer" do
       renderer.render.split("").sort
     end.equals "{\"user\":{\"age\":24,\"name\":\"irvine\"}}".split("").sort
 
+    asserts 'uses globally configured view paths' do
+      Rabl.configure do |config|
+        config.view_paths << tmp_path
+      end
+
+      File.open(tmp_path + "test.rabl", "w") do |f|
+        f.puts %q{
+          attributes :age
+        }
+      end
+
+      user = User.new(:name => 'irvine')
+
+      renderer = Rabl::Renderer.new('test', user)
+      renderer.render.split("").sort
+    end.equals "{\"user\":{\"age\":24,\"name\":\"irvine\"}}".split("").sort
+
 
     asserts 'handles paths for extends' do
       File.open(tmp_path + "test.json.rabl", "w") do |f|
@@ -185,5 +201,4 @@ context "Rabl::Renderer" do
       Rabl::Renderer.plist(user, 'test', :view_path => tmp_path)
     end.equals "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<!DOCTYPE plist PUBLIC \"-//Apple Computer//DTD PLIST 1.0//EN\" \"http://www.apple.com/DTDs/PropertyList-1.0.dtd\">\n<plist version=\"1.0\">\n<dict>\n\t<key>user</key>\n\t<dict>\n\t\t<key>age</key>\n\t\t<integer>24</integer>\n\t\t<key>name</key>\n\t\t<string>ivan</string>\n\t</dict>\n</dict>\n</plist>\n"
   end
-
 end

data/test/silence.rb

@@ -18,4 +18,4 @@ module Kernel
   ensure
     $VERBOSE = old_verbose
   end
-end unless Kernel.respond_to? :silence_warnings
+end unless Kernel.respond_to? :silence_warnings

data/test/template_test.rb

@@ -5,7 +5,6 @@ class Scope
 end
 
 context "RablTemplate" do
-
   asserts "that it registers for .rabl files" do
     Tilt['test.rabl']
   end.equals RablTemplate
@@ -44,7 +43,6 @@ context "RablTemplate" do
   end
 
   context "#render compiled" do
-
     # asserts "that it can be passed locals" do
     #   template = RablTemplate.new { "code(:name) { @name }" }
     #   template.render(Scope.new, :object => 'Bob')
@@ -61,8 +59,5 @@ context "RablTemplate" do
       template = RablTemplate.new { "code(:lol) { 'Hey ' + yield + '!' }" }
       template.render(Scope.new) { 'Joe' }
     end.matches %r{"lol":"Hey Joe!"}
-
   end
-
-
 end

data/test/teststrap.rb

@@ -27,4 +27,3 @@ end
 class Riot::Context
   # Custom context code here
 end
-

metadata

@@ -2,7 +2,7 @@
 name: rabl
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.6.10
+  version: 0.6.11
 platform: ruby
 authors: 
 - Nathan Esquenazi
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-04-19 00:00:00 Z
+date: 2012-05-10 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: activesupport