rabl 0.13.0 → 0.14.0

data/lib/rabl/digestor/rails41.rb

@@ -0,0 +1,10 @@
+module Rabl
+  class Digestor < ActionView::Digestor
+    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
+      end
+    end
+  end
+end

data/lib/rabl/digestor/rails5.rb

@@ -0,0 +1,4 @@
+module Rabl
+  class Digestor < ActionView::Digestor
+  end
+end

data/lib/rabl/digestor.rb

@@ -3,45 +3,11 @@ module Rabl
     # Override the original digest function to ignore partial which
     # rabl doesn't use the Rails conventional _ symbol.
     if Gem::Version.new(Rails.version) >= Gem::Version.new('5.0.0.beta1')
-      def self.digest(name:, finder:, **options)
-
-        options.assert_valid_keys(:dependencies, :partial)
-
-        cache_key = ([ name ].compact + Array.wrap(options[:dependencies])).join('.')
-
-        # this is a correctly done double-checked locking idiom
-        # (Concurrent::Map's lookups have volatile semantics)
-        finder.digest_cache[cache_key] || @@digest_monitor.synchronize do
-          finder.digest_cache.fetch(cache_key) do # re-check under lock
-            begin
-              # Prevent re-entry or else recursive templates will blow the stack.
-              # There is no need to worry about other threads seeing the +false+ value,
-              # as they will then have to wait for this thread to let go of the @@digest_monitor lock.
-
-              pre_stored = finder.digest_cache.put_if_absent(cache_key, false).nil? # put_if_absent returns nil on insertion
-
-              finder.digest_cache[cache_key] = stored_digest = Digestor.new(name, finder, options).digest
-            ensure
-              # something went wrong or ActionView::Resolver.caching? is false, make sure not to corrupt the @@cache
-              finder.digest_cache.delete_pair(cache_key, false) if pre_stored && !stored_digest
-            end
-          end
-        end
-      end
+      require 'rabl/digestor/rails5'
     elsif 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
-        end
-      end
+      require 'rabl/digestor/rails41'
     else
-      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
+      require 'rabl/digestor/rails3'
     end
 
     private

data/lib/rabl/engine.rb

@@ -27,6 +27,8 @@ module Rabl
     # Renders the representation based on source, object, context_scope and locals
     # Rabl::Engine.new("...source...", { :format => "xml" }).apply(context_scope, { :foo => "bar", :object => @user })
     def apply(context_scope, locals, &block)
+      locals = locals.dup unless locals.nil?
+
       set_instance_variables!(context_scope, locals)
 
       reset_settings!
@@ -417,5 +419,5 @@ module Rabl
           instance_eval(@_source)
         end
       end
-    end
+  end
 end

data/lib/rabl/railtie.rb

@@ -1,6 +1,23 @@
 module Rabl
   class Railtie < Rails::Railtie
     initializer "rabl.initialize" do |app|
+      # Force Rails to load view templates even in API mode
+      # Stolen shamelessly from jbuilder: https://github.com/rails/jbuilder/blob/master/lib/jbuilder/railtie.rb
+      if Rails::VERSION::MAJOR >= 5
+        module ::ActionController
+          module ApiRendering
+            include ActionView::Rendering
+          end
+        end
+
+        ActiveSupport.on_load :action_controller do
+          if self == ActionController::API
+            include ActionController::Helpers
+            include ActionController::ImplicitRender
+          end
+        end
+      end
+
       ActiveSupport.on_load(:action_view) do
         Rabl.register!
 

data/lib/rabl/version.rb

@@ -1,3 +1,3 @@
 module Rabl
-  VERSION = "0.13.0"
+  VERSION = "0.14.0"
 end

data/lib/rabl.rb

@@ -16,7 +16,7 @@ require 'rabl/configuration'
 require 'rabl/renderer'
 require 'rabl/cache_engine'
 
-if defined?(Rails)
+if defined?(Rails) && Rails.respond_to?(:version)
   require 'rabl/tracker'  if Rails.version =~ /^[45]/
   require 'rabl/digestor' if Rails.version =~ /^[45]/
   require 'rabl/railtie'  if Rails.version =~ /^[345]/
@@ -83,6 +83,6 @@ end
 if defined?(Padrino)
   require 'padrino-core'
   Padrino.after_load { Rabl.register! }
-elsif defined?(Rails) && Rails.version =~ /^2/
+elsif defined?(Rails.version) && Rails.version =~ /^2/
   Rabl.register!
 end

data/rabl.gemspec

@@ -30,7 +30,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'rake'
   s.add_development_dependency 'tilt'
   s.add_development_dependency 'oj'
-  s.add_development_dependency 'msgpack',  '~> 0.4.5'
+  s.add_development_dependency 'msgpack',  '~> 1.0.0'
   s.add_development_dependency 'bson',     '~> 1.7.0'
   s.add_development_dependency 'plist'
 end

data/test/builder_test.rb

@@ -91,6 +91,32 @@ context "Rabl::Builder" do
         Rabl.configuration.exclude_nil_values = false
       end
     end
+
+    context "when keys are camelized" do
+      setup do
+        Rabl.configuration.camelize_keys = true
+        builder(nil, { :attributes => [ { :name => :first_pets_name } ] })
+      end
+      asserts "that the key is camelized" do
+        topic.to_hash(User.new)
+      end.equivalent_to({ :firstPetsName => 'jack' })
+      teardown do
+        Rabl.configuration.camelize_keys = false
+      end
+    end
+
+    context "when keys are camelized with upper case first letter" do
+      setup do
+        Rabl.configuration.camelize_keys = :upper
+        builder(nil, { :attributes => [ { :name => :first_pets_name } ] })
+      end
+      asserts "that the key is camelized with upper case first letter" do
+        topic.to_hash(User.new)
+      end.equivalent_to({ :FirstPetsName => 'jack' })
+      teardown do
+        Rabl.configuration.camelize_keys = false
+      end
+    end
   end
 
   context "#attribute" do

data/test/engine_test.rb

@@ -23,6 +23,12 @@ context "Rabl::Engine" do
     asserts_topic.assigns :_view_path
   end
 
+  context "#apply" do
+    denies("that it raises exception when given frozen locals").raises(RuntimeError) do
+      Rabl::Engine.new("").apply(Object.new, {}.freeze)
+    end
+  end
+
   context "#request_format" do
     context "is json by default" do
       setup do

data/test/integration/rails5/posts_controller_test.rb

@@ -0,0 +1,251 @@
+# 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.strftime("%Y-%m-%d %H:%M:%S %Z") } }
+
+    # 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.strftime("%Y-%m-%d %H:%M:%S %Z") }
+
+    # 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 "renderer" do
+    setup do
+      mock(ActionController::Base).perform_caching.any_number_of_times { true }
+      get "/posts/#{@post1.id}/renderer"
+      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 (partial)
+    asserts("contains post partial title") { topic['partial']['title'] }.equals { @post1.title }
+    asserts("contains post partial body")  { topic['partial']['body'] }.equals { @post1.body }
+  end # renderer action, json
+
+  # HTML isn't supported in API mode
+  unless Rails.application.config.api_only
+    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
+  end
+
+  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', 'e373525f49a3b3b044af05255e84839d'])[: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

data/test/integration/rails5/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 { |t| t.strftime("%Y-%m-%d %H:%M:%S %Z") } }
+
+    # 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.strftime("%Y-%m-%d %H:%M:%S %Z") }
+    # 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/test/models/user.rb

@@ -1,17 +1,18 @@
 unless defined?(User)
   class User
-    attr_accessor :age, :city, :name, :first, :float, :hobbies, :twitter
+    attr_accessor :age, :city, :name, :first, :float, :hobbies, :twitter, :first_pets_name
 
-    DEFAULT_AGE      = 24
-    DEFAULT_CITY     = 'irvine'
-    DEFAULT_NAME     = 'rabl'
-    DEFAULT_FIRST    = 'bob'
-    DEFAULT_FLOAT    = 1234.56
-    DEFAULT_HOBBIES  = ['Photography']
-    DEFAULT_TWITTER  = 'rablgem'
+    DEFAULT_AGE              = 24
+    DEFAULT_CITY             = 'irvine'
+    DEFAULT_NAME             = 'rabl'
+    DEFAULT_FIRST            = 'bob'
+    DEFAULT_FLOAT            = 1234.56
+    DEFAULT_HOBBIES          = ['Photography']
+    DEFAULT_TWITTER          = 'rablgem'
+    DEFAULT_FIRST_PETS_NAME  = 'jack'
 
     def initialize(attributes = {})
-      %w(age city name first float hobbies twitter).each do |attr|
+      %w(age city name first float hobbies twitter first_pets_name).each do |attr|
         self.send "#{attr}=", (attributes.has_key?(attr.to_sym) ? attributes[attr.to_sym] : self.class.const_get("DEFAULT_#{attr.upcase}"))
       end
       self.hobbies = self.hobbies.map { |h| Hobby.new(h) }