rabl 0.10.1 → 0.11.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZDMwMmY3ZDU1N2QwN2Y3OGNjZmRlOTljMGRiZGE1NDU3ZjQwYmViNQ==
+    ZTQ1YmY1YjA4YWM5YmIwNmI1Y2M3NDYzYjg0OWRmOGE3NTRiMjJiMg==
   data.tar.gz: !binary |-
-    NzliNzM2YThjMmUxNzg3OTdhYzc5M2FiMmVhNmEwOTljYjBjYWI5Mw==
+    N2QxNDFjMjUwOTk2NTRhYmVmMWNiMjE3ZWQ5MmU4OWEyZTI5YzNlMQ==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    OTQ5YWQ4ZjYwNmRiMzc4YmRlYzIyYWZhZTA4Nzk3NzAyMWQxMDNlMzU5ZDdl
-    M2JiOTBhYTQxNDUwZjIwZjhhYmQ0ZWMyMDFiYTkyODhkMmU0MWNhMDNjY2Y5
-    MGQ3NTAzZDM0YmM0NzUwNmU1YjZjZTRhOTdhNjZmYzI5NjE4ZDA=
+    ZmE2N2I2MGZhNWM1ZWM3YTFkMDNmNzMyODhlNGM2NTFiMTRhYWE5MjJlOTlj
+    YjljMzc5YWEzMmJjZjdjNDRkZTAyYjE2NDA1MTMxODg3NzE3NWU2ODZlNTNk
+    MjczY2Y1YjgxNGI0YTBhNzE5NTY3MWQzOGIzZGFlNGQ5OTgxNjc=
   data.tar.gz: !binary |-
-    MmRiZjE3ZGYyZjU3M2FlZWViYjkzYjgzZjU4MTU3YjA4Y2JkZjFmNjE0NjA1
-    MDcyMTc2M2E2MjgyMGE2ZTI3NWZkN2IyN2MyZWE5MGJiMWM3ZWI4OGQyZDI1
-    NmZmMjRmMGE5YWQ3MjE5ODI0N2JkY2IwNDEzZGMwMjUzMWRlOGM=
+    MzBjMDE4YjY4ZjBiNmEzODY5NDZlMzI2OTI0ZjY4Mjk0M2YyMjVkYzY3YWZl
+    MWQ1MWMxNjM3NDlmMTc1ZmVmOGRiODkxOTc3YTU4YTM1NWJlNjc5YWVkMjBi
+    ZjNlNDZmNGZmODFiZWI5ZmJlNDAzYmQ3NjgyM2NiZGI2NmEwYzg=

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # CHANGELOG
 
+## 0.11.0 (August 16th)
+
+* Restore ruby 1.8 compatibility (@s01ipsist, @patrickdavey)
+* Fix Rabl::Tracker to match paths with numbers (@szimek)
+* Fix caching of a recursive template (@bonobos)
+* Fix cache for non-rails apps (@t-k)
+* Escape output all at once to properly escape content (@bholzer)
+* Add hashie mash to known object list (@nguyenmighty)
+* Remove root object when set to false value (@mrThe)
+
 ## 0.10.1 (May 28th)
 
 * Fix nasty formatting bug that broke XML (@bhicks)

data/Gemfile

@@ -20,6 +20,7 @@ group :test do
   gem 'activerecord', :require => 'active_record'
   gem 'sqlite3'
   gem 'sinatra', '>= 1.2.0'
+  gem 'hashie'
 end
 
 group :development, :test do

data/README.md

@@ -171,7 +171,6 @@ Additionally, anything within child, glue and partial will also be cached separa
 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.

data/fixtures/sinatra_test/app.rb

@@ -16,6 +16,9 @@ Dir[File.dirname(__FILE__) + "/models/*.rb"].each do |file|
 end
 
 # Register RABL
+Rabl.configure do |config|
+  config.perform_caching = true
+end
 Rabl.register!
 
 class SinatraTest < Sinatra::Application

data/lib/rabl/digestor.rb

@@ -2,11 +2,11 @@ module Rabl
   class Digestor < ActionView::Digestor
     # Override the original digest function to ignore partial which
     # rabl doesn't use the Rails conventional _ symbol.
-    if Rails.version.to_s >= '4.1'
+    if Gem::Version.new(Rails.version) >= Gem::Version.new('4.1')
       def self.digest(options = {})
         cache_key = [options[:name]] + Array.wrap(options[:dependencies])
         @@cache[cache_key.join('.')] ||= begin
-          Digestor.new({ name: options[:name], finder: options[:finder] }.merge!(options)).digest
+          Digestor.new({ :name => options[:name], :finder => options[:finder] }.merge!(options)).digest
         end
       end
     else
@@ -20,9 +20,9 @@ module Rabl
 
     private
       def dependency_digest
-        template_digests = dependencies.collect do |template_name|
-          if Rails.version.to_s >= '4.1'
-            Digestor.digest(name: template_name, finder: finder)
+        template_digests = (dependencies - [template.virtual_path]).collect do |template_name|
+          if Gem::Version.new(Rails.version) >= Gem::Version.new('4.1')
+            Digestor.digest(:name => template_name, :finder => finder)
           else
             Digestor.digest(template_name, format, finder)
           end

data/lib/rabl/engine.rb

@@ -1,6 +1,7 @@
 module Rabl
   class Engine
     include Rabl::Partials
+    include Rabl::Helpers::Escaper
 
     # List of supported rendering formats
     FORMATS = [:json, :xml, :plist, :bson, :msgpack]
@@ -35,12 +36,12 @@ module Rabl
       options[:root_name] = determine_object_root(data, root_name, options[:root])
 
       if is_object?(data) || !data # object @user
-        builder.build(data, options)
+        result = builder.build(data, options)
       elsif is_collection?(data) # collection @users
         result = data.map { |object| builder.build(object, options) }
         result = result.map(&:presence).compact if Rabl.configuration.exclude_empty_values_in_collections
-        result
       end
+      Rabl.configuration.escape_all_output ? escape_output(result) : result
     end
 
     # Returns a json representation of the data object
@@ -109,6 +110,10 @@ module Rabl
       current_data  = (@_locals[:object].nil? || template_data == false) ? template_data : @_locals[:object]
       @_data_object = data_object(current_data)
       @_data_name   = data_name(template_data.is_a?(Hash) && !current_data.is_a?(Hash) ? template_data : current_data)
+      if @_data_name == false
+        @_object_root_name = false
+        @_collection_name = false
+      end
     end
 
     # Returns the current object that is the topic of this template
@@ -277,10 +282,10 @@ module Rabl
       _cache = @_cache if defined?(@_cache)
       cache_key, cache_options = *_cache || nil
       if template_cache_configured? && cache_key
-        if Rails.version =~ /^[4]/
-          result_cache_key = cache_key_with_digest(cache_key)
-        else # fallback for Rails 3
-          result_cache_key = cache_key_simple(cache_key)
+        result_cache_key = if digestor_available?
+          cache_key_with_digest(cache_key)
+        else # fallback for Rails 3, and Non-Rails app
+          cache_key_simple(cache_key)
         end
         fetch_result_from_cache(result_cache_key, cache_options, &block)
       else # skip caching
@@ -288,11 +293,15 @@ module Rabl
       end
     end
 
+    def digestor_available?
+      defined?(Rails) && Rails.version =~ /^[4]/
+    end
+
     def cache_key_with_digest(cache_key)
       template = @_options[:template] || @virtual_path
 
-      if Rails.version.to_s >= '4.1'
-        digested =  Digestor.digest(name: template, finder: lookup_context)
+      if Gem::Version.new(Rails.version) >= Gem::Version.new('4.1')
+        digested =  Digestor.digest(:name => template, :finder => lookup_context)
       else
         digested = Digestor.digest(template, :rabl, lookup_context)
       end

data/lib/rabl/helpers.rb

@@ -3,7 +3,7 @@ require 'active_support/inflector' # for the sake of pluralizing
 module Rabl
   module Helpers
     # Set of class names known to be objects, not collections
-    KNOWN_OBJECT_CLASSES = ['Struct']
+    KNOWN_OBJECT_CLASSES = ['Struct', 'Hashie::Mash']
 
     # data_object(data) => <AR Object>
     # data_object(@user => :person) => @user
@@ -15,7 +15,7 @@ module Rabl
 
     # data_object_attribute(data) => @_object.send(data)
     def data_object_attribute(data)
-      escape_output @_object.__send__(data)
+      @_object.__send__(data)
     end
 
     # data_name(data) => "user"
@@ -119,10 +119,28 @@ module Rabl
       end
     end
 
-    # Escape output if configured and supported
-    def escape_output(data)
-      (data && defined?(ERB::Util.h) && Rabl.configuration.escape_all_output) ? ERB::Util.h(data) : data
-    end
+    module Escaper
+      def escape_output(response)
+        case response
+        when Hash
+          response.each{|k,v| response[k] = escape_value(v) }
+        when Array
+          response.map!{|v| escape_value(v) }
+        else
+          response
+        end
+      end
 
+      def escape_value(value)
+        case value
+        when String
+          ERB::Util.h(value)
+        when Array, Hash
+          escape_output(value)
+        else
+          value
+        end
+      end
+    end
   end
 end

data/lib/rabl/tracker.rb

@@ -6,7 +6,7 @@ module Rabl
     EXTENDS_DEPENDENCY = /
       extends\s*              # extends, followed by optional whitespace
       \(?                     # start an optional parenthesis for the extends call
-      \s*["']([a-z_\/\.]+)    # the template name itself
+      \s*["']([0-9a-z_\/\.]+) # the template name itself
     /x
 
     # Matches:
@@ -14,7 +14,7 @@ module Rabl
     PARTIAL_DEPENDENCY = /
       partial\s*              # partial, followed by optional whitespace
       \(?                     # start an optional parenthesis for the partial call
-      \s*["']([a-z_\/\.]+)    # the template name itself
+      \s*["']([0-9a-z_\/\.]+) # the template name itself
     /x
 
     def self.call(name, template)

data/lib/rabl/version.rb

@@ -1,3 +1,3 @@
 module Rabl
-  VERSION = "0.10.1"
+  VERSION = "0.11.0"
 end

data/test/engine_test.rb

@@ -37,7 +37,7 @@ context "Rabl::Engine" do
 
     context "with a specified format" do
       setup do
-        template = RablTemplate.new("code", format: 'xml') { "" }
+        template = RablTemplate.new("code", :format => 'xml') { "" }
         template.render(Object.new)
         engine = template.instance_eval('@engine')
         engine.instance_eval('@_options')[:format]
@@ -132,6 +132,26 @@ context "Rabl::Engine" do
         template.render(scope)
       end.equals "{\"person\":{}}"
 
+      asserts "that it can set false root node" do
+        template = rabl %q{
+          object @user => false
+        }
+        scope = Object.new
+        scope.instance_variable_set :@user, User.new
+        template.render(scope)
+      end.equals "{}"
+
+      asserts "that it can set false root node and correctly render object without root node" do
+        template = rabl %q{
+          object @user => false
+          attribute :name
+        }
+        user = User.new(:name => "John Doe")
+        scope = Object.new
+        scope.instance_variable_set :@user, user
+        template.render(scope)
+      end.equals "{\"name\":\"John Doe\"}"
+
       asserts "that it can use non-ORM objects" do
         template = rabl %q{
           object @other

data/test/helpers_test.rb

@@ -85,6 +85,11 @@ context "Rabl::Helpers" do
       @helper_class.is_object?(obj.new('foo'))
     end.equals(true)
 
+    asserts "returns true for a Hashie::Mash" do
+      obj = Hashie::Mash.new({:name => 'hello'})
+      @helper_class.is_object?(obj)
+    end.equals(true)
+
     asserts "returns false for an array" do
       @helper_class.is_object?([@user])
     end.equals(false)
@@ -116,5 +121,10 @@ context "Rabl::Helpers" do
     asserts "returns true for an array" do
       @helper_class.is_collection?([@user])
     end.equals(true)
+
+    asserts "returns true for an array" do
+      obj = Hashie::Mash.new({:name => 'hello'})
+      @helper_class.is_collection?(obj)
+    end.equals(false)
   end # is_collection method
 end

data/test/teststrap.rb

@@ -18,6 +18,7 @@ silence_warnings do
   require 'riot/rr'
   require 'tilt'
   require 'rabl'
+  require 'hashie'
   require File.expand_path('../models/user', __FILE__)
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rabl
 version: !ruby/object:Gem::Version
-  version: 0.10.1
+  version: 0.11.0
 platform: ruby
 authors:
 - Nathan Esquenazi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-29 00:00:00.000000000 Z
+date: 2014-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport