rabl 0.8.6 → 0.9.0.pre

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

@@ -0,0 +1,87 @@
+# Lives in <rabl>/test/integration/users_controller_test.rb
+# Symlinked to fixture applications
+
+begin # Sinatra
+  require File.expand_path(File.dirname(__FILE__) + '/../../test_config.rb')
+rescue LoadError # Rails
+  require File.expand_path(File.dirname(__FILE__) + '/../test_helper.rb')
+end
+
+context "UsersController" do
+  helper(:json_output) { JSON.parse(last_response.body) }
+
+  setup do
+    create_users!
+  end
+
+  context "for index action" do
+    # Tests `collection @users` extending from 'show' template
+
+    setup do
+      get "/users", format: :json
+    end
+
+    # Attributes (regular)
+    asserts("contains user usernames") do
+      json_output.map { |u| u["user"]["username"] }
+    end.equals { @users.map(&:username) }
+    asserts("contains email") do
+      json_output.map { |u| u["user"]["email"] }
+    end.equals { @users.map(&:email) }
+    asserts("contains location") do
+      json_output.map { |u| u["user"]["location"] }
+    end.equals { @users.map(&:location) }
+
+    # Attributes (custom name)
+    asserts("contains registered_at") do
+      json_output.map { |u| u["user"]["registered_at"] }
+    end.equals { @users.map(&:created_at).map(&:utc).map(&:to_s) }
+
+    # Node (renders based on attribute)
+    asserts("contains role") do
+      json_output.map { |u| u["user"]["role"] }
+    end.equals ['normal', 'normal', 'admin']
+
+    # Child (custom collection name)
+    asserts("contains formatted phone numbers") do
+      json_output.map { |u| u["user"]["pnumbers"].map { |n| n["pnumber"]["formatted"] } }
+    end.equals { @users.map { |u| u.phone_numbers.map(&:formatted) } }
+
+    # Node (renders collection partial)
+    asserts("contains reversed node numbers") do
+      json_output.map { |u| u["user"]["node_numbers"].map { |n| n["reversed"] } }
+    end.equals { @users.map { |u| u.phone_numbers.map(&:formatted).map(&:reverse) } }
+  end # index
+
+  context "for show action" do
+    # Tests `object :user => :person` custom parent node name
+    setup do
+      get "/users/#{@user1.id}", format: :json
+    end
+
+    # Attributes (regular)
+    asserts("contains username") { json_output["person"]["username"] }.equals { @user1.username }
+    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.utc.to_s }
+    # Node (renders based on attribute)
+    asserts("contains role node") { json_output["person"]["role"] }.equals "normal"
+
+    # Child (custom collection name)
+    asserts("contains first phone number") {
+      json_output["person"]["pnumbers"][0]["pnumber"]["formatted"]
+    }.equals { @user1.phone_numbers[0].formatted }
+    asserts("contains second phone number") {
+      json_output["person"]["pnumbers"][1]["pnumber"]["formatted"]
+    }.equals { @user1.phone_numbers[1].formatted }
+
+    # Node (renders collection partial)
+    asserts("contains first node number") {
+      json_output["person"]["node_numbers"][0]["formatted"]
+    }.equals { @user1.phone_numbers[0].formatted }
+    asserts("contains second node number") {
+      json_output["person"]["node_numbers"][1]["formatted"]
+    }.equals { @user1.phone_numbers[1].formatted }
+  end # show
+end

data/fixtures/rails4/test/test_helper.rb

@@ -0,0 +1,26 @@
+# Load Silence Functionality
+require File.expand_path(File.dirname(__FILE__) + "/../../../test/silence.rb")
+
+# Load Environment
+silence_warnings do
+  ENV["RAILS_ENV"] = "test"
+  require File.expand_path('../../config/environment', __FILE__)
+  require 'rails/test_help'
+end
+
+# Load Riot Test Environment
+require File.expand_path(File.dirname(__FILE__) + "/../../../test/integration/test_init.rb")
+
+# Run Migrations
+silence_stream(STDOUT) do
+  dbconf = YAML::load(File.open('config/database.yml'))[Rails.env]
+  ActiveRecord::Base.establish_connection(dbconf)
+  ActiveRecord::Base.logger = Logger.new(File.open('log/database.log', 'a'))
+  silence_stream(STDOUT) { ActiveRecord::Migrator.up('db/migrate') }
+end
+
+class Riot::Situation
+  def app
+    Rails.application
+  end
+end

data/lib/rabl.rb

@@ -13,7 +13,12 @@ require 'rabl/builder'
 require 'rabl/configuration'
 require 'rabl/renderer'
 require 'rabl/cache_engine'
-require 'rabl/railtie' if defined?(Rails) && Rails.version =~ /^[34]/
+
+if defined?(Rails)
+  require 'rabl/tracker'  if Rails.version =~ /^[4]/
+  require 'rabl/digestor' if Rails.version =~ /^[4]/
+  require 'rabl/railtie'  if Rails.version =~ /^[34]/
+end
 
 # Rabl.register!
 module Rabl

data/lib/rabl/builder.rb

@@ -99,9 +99,11 @@ module Rabl
     # child(@users => :people) { ... }
     def child(data, options={}, &block)
       return false unless data.present? && resolve_condition(options)
-      name, object = data_name(data), data_object(data)
+      name   = is_name_value?(options[:root]) ? options[:root] : data_name(data)
+      object = data_object(data)
       include_root = is_collection?(object) && options.fetch(:object_root, @options[:child_root]) # child @users
       engine_options = @options.slice(:child_root).merge(:root => include_root)
+      engine_options.merge!(:object_root_name => options[:object_root]) if is_name_value?(options[:object_root])
       object = { object => name } if data.respond_to?(:each_pair) && object # child :users => :people
       @_result[name] = self.object_to_hash(object, engine_options, &block)
     end

data/lib/rabl/digestor.rb

@@ -0,0 +1,21 @@
+module Rabl
+  class Digestor < ActionView::Digestor
+    # Override the original digest function to ignore partial which
+    # rabl doesn't use the Rails conventional _ symbol.
+    def self.digest(name, format, finder, options = {})
+      cache_key = [name, format] + Array.wrap(options[:dependencies])
+      @@cache[cache_key.join('.')] ||= begin
+        Digestor.new(name, format, finder, options).digest
+      end
+    end
+
+    private
+      def dependency_digest
+        template_digests = dependencies.collect do |template_name|
+          Digestor.digest(template_name, format, finder, partial: true)
+        end
+
+        (template_digests + injected_dependencies).join("-")
+      end
+  end
+end

data/lib/rabl/engine.rb

@@ -28,7 +28,8 @@ module Rabl
       @_options[:scope] = @_scope
       @_options[:format] ||= self.request_format
       data = locals[:object].nil? ? self.default_object : locals[:object]
-      @_data_object, @_data_name = data_object(data), data_name(data)
+      @_data_object = data_object(data)
+      @_data_name = @_options[:object_root_name] || data_name(data)
       if @_options[:source_location]
         instance_eval(@_source, @_options[:source_location]) if @_source.present?
       else # without source location
@@ -274,12 +275,29 @@ module Rabl
       _cache = @_cache if defined?(@_cache)
       cache_key, cache_options = *_cache || nil
       if template_cache_configured? && cache_key
-        result_cache_key = Array(cache_key) + [@_options[:root_name], @_options[:format]]
+        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)
+        end
         fetch_result_from_cache(result_cache_key, cache_options, &block)
       else # skip caching
         yield
       end
     end
 
+    def cache_key_with_digest(cache_key)
+      Array(cache_key) + [
+        @_options[:root_name],
+        @_options[:format],
+        Digestor.digest(@virtual_path, :rabl, lookup_context, dependencies: view_cache_dependencies)
+      ]
+    end
+    
+    def cache_key_simple(key)
+      Array(key) + [@_options[:root_name], @_options[:format]]
+    end
+    
+
   end
 end

data/lib/rabl/helpers.rb

@@ -28,7 +28,8 @@ module Rabl
       return data_token.values.first if data_token.is_a?(Hash) # @user => :user
       data = data_object(data_token)
       if is_collection?(data) && data.respond_to?(:first) # data is a collection
-        object_name = data_name(data.first).to_s.pluralize if data.first.present?
+        object_name = data.table_name if data.respond_to?(:table_name)
+        object_name ||= data_name(data.first).to_s.pluralize if data.first.present?
         object_name ||= data_token if data_token.is_a?(Symbol)
         object_name
       elsif is_object?(data) # data is an object
@@ -92,6 +93,11 @@ module Rabl
       defined?(@_collection_name) ? @_collection_name : nil
     end
 
+    # Returns true if the value is a name value (symbol or string)
+    def is_name_value?(val)
+      val.is_a?(String) || val.is_a?(Symbol)
+    end
+
     # Fetches a key from the cache and stores rabl template result otherwise
     # fetch_from_cache('some_key') { ...rabl template result... }
     def fetch_result_from_cache(cache_key, cache_options=nil, &block)

data/lib/rabl/railtie.rb

@@ -4,6 +4,12 @@ module Rabl
     initializer "rabl.initialize" do |app|
       ActiveSupport.on_load(:action_view) do
         Rabl.register!
+
+        # Inject dependency tracker for :rabl
+        if Rails.version =~ /^[4]/
+          require 'action_view/dependency_tracker'
+          ActionView::DependencyTracker.register_tracker :rabl, Rabl::Tracker
+        end
       end
     end
 

data/lib/rabl/template.rb

@@ -40,7 +40,7 @@ if defined?(ActionView) && defined?(Rails) && Rails.version.to_s =~ /^2/
   ActionView::Template.register_template_handler :rabl, ActionView::TemplateHandlers::RablHandler
 end
 
-# Rails 3.X Template
+# Rails 3.X / 4.X Template
 if defined?(ActionView) && defined?(Rails) && Rails.version.to_s =~ /^[34]/
   module ActionView
     module Template::Handlers

data/lib/rabl/tracker.rb

@@ -0,0 +1,53 @@
+module Rabl
+  # DependencyTracker for ActionView to support cache digest
+  class Tracker
+    # Matches:
+    #   extends "categories/show"
+    EXTENDS_DEPENDENCY = /
+      extends\s*              # extends, followed by optional whitespace
+      \(?                     # start an optional parenthesis for the extends call
+      \s*["']([a-z_\/\.]+)    # the template name itself
+    /x
+
+    # Matches:
+    #   partial "categories/show"
+    PARTIAL_DEPENDENCY = /
+      partial\s*              # partial, followed by optional whitespace
+      \(?                     # start an optional parenthesis for the partial call
+      \s*["']([a-z_\/\.]+)    # the template name itself
+    /x
+
+    def self.call(name, template)
+      new(name, template).dependencies
+    end
+
+    def initialize(name, template)
+      @name, @template = name, template
+    end
+
+    def dependencies
+      (extends_dependencies + partial_dependencies).uniq
+    end
+
+    attr_reader :name, :template
+    private :name, :template
+
+    private
+
+      def source
+        template.source
+      end
+
+      def directory
+        name.split("/")[0..-2].join("/")
+      end
+
+      def extends_dependencies
+        source.scan(EXTENDS_DEPENDENCY).flatten
+      end
+
+      def partial_dependencies
+        source.scan(PARTIAL_DEPENDENCY).flatten
+      end
+  end
+end

data/lib/rabl/version.rb

@@ -1,3 +1,3 @@
 module Rabl
-  VERSION = "0.8.6"
+  VERSION = "0.9.0.pre"
 end

data/rabl.gemspec

@@ -19,7 +19,12 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_dependency 'activesupport',        '>= 2.3.14'
+  
+  if RUBY_VERSION < "1.9"
+    s.add_dependency 'activesupport', '>= 2.3.14', '<= 4'
+  else
+    s.add_dependency "activesupport", '>= 2.3.14'
+  end
 
   s.add_development_dependency 'riot',     '~> 0.12.3'
   s.add_development_dependency 'rr',       '~> 1.0.2'

data/test/engine_test.rb

@@ -305,6 +305,29 @@ context "Rabl::Engine" do
         template.render(scope)
       end.equals "{\"user\":{\"name\":\"leo\",\"users\":[{\"city\":\"UNO\"},{\"city\":\"DOS\"}]}}"
 
+      asserts "it allows modification of object root node for child collection" do
+        template = rabl %{
+          object @user
+          attribute :name
+          child(@users, :object_root => 'person') { attribute :city }
+        }
+        scope = Object.new
+        scope.instance_variable_set :@user, User.new(:name => 'leo', :city => 'LA')
+        scope.instance_variable_set :@users, [User.new(:name => 'one', :city => 'UNO'), User.new(:name => 'two', :city => 'DOS')]
+        template.render(scope)
+      end.equals "{\"user\":{\"name\":\"leo\",\"users\":[{\"person\":{\"city\":\"UNO\"}},{\"person\":{\"city\":\"DOS\"}}]}}"
+
+      asserts "it allows modification of both root labels for child collection" do
+        template = rabl %{
+          object @user
+          attribute :name
+          child(@users, :root => "people", :object_root => 'item') { attribute :city }
+        }
+        scope = Object.new
+        scope.instance_variable_set :@user, User.new(:name => 'leo', :city => 'LA')
+        scope.instance_variable_set :@users, [User.new(:name => 'one', :city => 'UNO'), User.new(:name => 'two', :city => 'DOS')]
+        template.render(scope)
+      end.equals "{\"user\":{\"name\":\"leo\",\"people\":[{\"item\":{\"city\":\"UNO\"}},{\"item\":{\"city\":\"DOS\"}}]}}"
     end
 
     context "#glue" do

data/test/helpers_test.rb

@@ -32,6 +32,12 @@ context "Rabl::Helpers" do
     asserts "returns name of an object" do
       @helper_class.data_name(@user)
     end.equals('user')
+
+    asserts "returns table_name of collection if responds" do
+      @coll = [@user, @user]
+      mock(@coll).table_name { "people" }
+      @helper_class.data_name(@coll)
+    end.equals('people')
   end # data_name method
 
   context "for is_object method" do

data/test/integration/rails4/posts_controller_test.rb

@@ -0,0 +1,232 @@
+# Lives in <rabl>/test/integration/posts_controller_test.rb
+# Symlinked to fixture applications
+
+begin # Padrino
+  require File.expand_path(File.dirname(__FILE__) + '/../../test_config.rb')
+rescue LoadError # Rails
+  require File.expand_path(File.dirname(__FILE__) + '/../test_helper.rb')
+end
+
+require 'rexml/document'
+
+context "PostsController" do
+  helper(:json_output) { JSON.parse(last_response.body) }
+
+  setup do
+    create_users!
+    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 => "<script>alert('xss & test');</script>", :user_id => @user3.id)
+    @posts = [@post1, @post2, @post3]
+  end
+
+  context "for index action" do
+    setup do
+      get "/posts", format: :json
+    end
+
+    # Attributes (regular)
+    asserts("contains post titles") do
+      json_output['articles'].map { |o| o["article"]["title"] }
+    end.equals { @posts.map(&:title) }
+
+    asserts("contains post bodies") do
+      json_output['articles'].map { |o| o["article"]["body"] }
+    end.equals { @posts.map(&:body) }
+
+    # Attributes (custom name)
+    asserts("contains post posted_at") do
+      json_output['articles'].map { |o| o["article"]["posted_at"] }
+    end.equals { @posts.map(&:created_at).map{ |t| t.iso8601(3) } }
+
+    # Child
+    asserts("contains post user child username") do
+      json_output['articles'].map { |o| o["article"]["user"]["username"] }
+    end.equals { @posts.map(&:user).map(&:username) }
+
+    asserts("contains post user child role") do
+      json_output['articles'].map { |o| o["article"]["user"]["role"] }
+    end.equals { ["normal", "normal", "admin"] }
+
+    # Child Numbers of the Child User
+    asserts("contains post user child numbers") do
+      json_output['articles'].map { |o| o["article"]["user"]["pnumbers"][0]["pnumber"]["formatted"] }
+    end.equals { @posts.map(&:user).map(&:phone_numbers).map(&:first).map(&:formatted) }
+
+    # Glue (username to article)
+    asserts("contains glued usernames") do
+      json_output['articles'].map { |o| o["article"]["author_name"] }
+    end.equals { @posts.map(&:user).map(&:username) }
+
+    # Conditional Child (admin)
+    asserts("contains admin child only for admins") do
+      json_output['articles'].map { |o| o["article"]["admin"]["username"] if o["article"].has_key?("admin") }.compact
+    end.equals { [@user3.username] }
+
+    # Conditional Node (created_by_admin)
+    asserts("contains created_by_admin node for admins") do
+      json_output['articles'].last['article']['created_by_admin']
+    end.equals { true }
+
+    denies("contains no created_by_admin node for non-admins") do
+      json_output['articles'].first['article']
+    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
+      json_output['post']
+    end
+
+    # Attributes (regular)
+    asserts("contains post title") { topic['title'] }.equals { @post1.title }
+    asserts("contains post body")  { topic['body'] }.equals { @post1.body }
+
+    # Attributes (custom name)
+    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 }
+    asserts("contains post user child role") { topic["user"]["role"] }.equals { "normal" }
+
+    # Child Numbers of the Child User
+    asserts("contains post user child numbers") do
+      topic["user"]["pnumbers"][0]["pnumber"]["formatted"]
+    end.equals { @post1.user.phone_numbers[0].formatted }
+
+    # Glue (username to article)
+    asserts("contains glued username") { topic["author_name"] }.equals { @post1.user.username }
+
+    # Non-ORM Date Node Partial
+    context "for date node" do
+      setup { json_output['post']['created_date'] }
+      asserts("contains date partial with day")   { topic['day'] }.equals { @post1.created_at.day }
+      asserts("contains date partial with hour")  { topic['hour'] }.equals { @post1.created_at.hour }
+      asserts("contains date partial with full")  { topic['full'] }.equals { @post1.created_at.iso8601 }
+    end # date node
+
+    asserts("contains helper action") { topic["foo"] }.equals { "BAR!" }
+    denies("contains helper action") { topic["created_at_in_words"] }.nil
+
+    asserts("contains post attributes via node") { topic["post"] }.equals { [@post1.title, @post1.body] }
+  end # show action, json
+
+  context "for index action rendering JSON within HTML" do
+    setup do
+      get "/posts", format: :html
+    end
+
+    asserts(:body).includes { "<html>" }
+  end # index action, html
+
+  context "for show action rendering JSON within HTML" do
+    setup do
+      get "/posts/#{@post1.id}", format: :html
+    end
+
+    asserts(:body).includes { "<html>" }
+  end # show action, html
+
+  context "mime_type" do
+    setup do
+      get "/posts/#{@post1.id}", format: :rabl_test_v1
+    end
+
+    asserts("contains post title") { json_output['post']['title_v1'] }.equals { @post1.title }
+    asserts("contains username") { json_output['post']['user']['username_v1'] }.equals { @post1.user.username }
+  end
+
+  context "caching" do
+    helper(:cache_hit) do |key|
+      Rails.cache.read(ActiveSupport::Cache.expand_cache_key(key, :rabl))
+    end
+
+    setup do
+      mock(ActionController::Base).perform_caching.any_number_of_times { true }
+      Rails.cache.clear
+    end
+
+    context "for index action with caching in json" do
+      setup do
+        get "/posts", format: :json
+      end
+
+      asserts("contains post titles") do
+        json_output['articles'].map { |o| o['article']['title'] }
+      end.equals { @posts.map(&:title) }
+
+      asserts(:body).equals { cache_hit ['kittens!', @posts, nil, 'json', 'e83f65eee5ffb454c418a59105f222c4'] }
+
+      asserts("contains cache hits per object (posts by title)") do
+        json_output['articles'].map { |o| o['article']['title'] }
+      end.equals { @posts.map{ |p| cache_hit([p, nil, 'hash', 'e83f65eee5ffb454c418a59105f222c4'])[:title] } }
+    end # index action, caching, json
+
+    context "for index action with caching in xml" do
+      setup do
+        get "/posts", format: :xml
+      end
+
+      asserts("contains post titles") do
+        doc = REXML::Document.new topic.body
+        doc.elements.inject('articles/article/title', []) {|arr, ele| arr << ele.text}
+      end.equals { @posts.map(&:title) }
+
+      asserts(:body).equals { cache_hit ['kittens!', @posts, nil, 'xml', 'e83f65eee5ffb454c418a59105f222c4'] }
+    end # index action, caching, xml
+
+    context "for show action with caching" do
+      setup do
+        get "/posts/#{@post1.id}", format: :json
+      end
+
+      asserts("contains post title") { json_output['post']['title'] }.equals { @post1.title }
+
+      asserts(:body).equals { cache_hit [@post1, nil, 'json', 'e373525f49a3b3b044af05255e84839d'] }
+    end # show action, caching, json
+
+    context "cache_all_output" do
+      helper(:cache_hit) do |key|
+        Rails.cache.read(ActiveSupport::Cache.expand_cache_key([key, 'article', 'json'], :rabl))
+      end
+
+      setup do
+        Rabl.configuration.cache_all_output = true
+        get "/posts", format: :json
+      end
+
+      asserts("contains cache hits per object (posts by title)") do
+        json_output['articles'].map { |o| o['article']['title'] }
+      end.equals { @posts.map{ |p| cache_hit(p)['article'][:title] } }
+    end  # index action, cache_all_output
+  end
+
+end