rabl 0.14.2 → 0.15.0

data/test/helpers_test.rb

@@ -1,136 +0,0 @@
-require 'tmpdir'
-require 'pathname'
-require File.expand_path('../teststrap', __FILE__)
-
-class TestHelperMethods
-  include Rabl::Helpers
-end
-
-context "Rabl::Helpers" do
-  setup do
-    @helper_class = TestHelperMethods.new
-    @user = User.new
-  end
-
-  # determine_object_root(@user, :user, true) => "user"
-  # determine_object_root(@user, :person) => "person"
-  # determine_object_root([@user, @user]) => "user"
-  # def determine_object_root(data_token, data_name=nil, include_root=true)
-  context "for determine_object_root method" do
-    asserts "returns nil if include_root is false" do
-      @helper_class.determine_object_root(@user, :user, false)
-    end.equals(nil)
-
-    asserts "returns user root name if include_root is true" do
-      @helper_class.determine_object_root(@user, :user, true)
-    end.equals("user")
-
-    asserts "returns explicit alias if specified" do
-      @helper_class.determine_object_root(@user, :person)
-    end.equals("person")
-
-    asserts "returns explicit alias if object is nil" do
-      @helper_class.determine_object_root(nil, :person)
-    end.equals("person")
-  end
-
-  context "for data_name method" do
-    asserts "returns nil if no data" do
-      @helper_class.data_name(nil)
-    end.equals(nil)
-
-    asserts "returns symbol if symbol with empty children" do
-      @helper_class.data_name(:user)
-    end.equals(:user)
-
-    asserts "returns alias if hash with symbol is passed" do
-      @helper_class.data_name(@user => :user)
-    end.equals(:user)
-
-    asserts "returns name of first object of a collection" do
-      @helper_class.data_name([@user, @user])
-    end.equals('users')
-
-    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
-    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 true for a struct" do
-      obj = Struct.new(:name)
-      @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)
-  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 a struct" do
-      obj = Struct.new(:name)
-      @helper_class.is_collection?(obj.new('foo'))
-    end.equals(false)
-
-    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)
-
-    asserts "returns false for a Hashie::Mash with 1 key" do
-      obj = Hashie::Mash.new({:name => 'hello'})
-      @helper_class.is_collection?(obj)
-    end.equals(false)
-
-    asserts "returns false for a Hashie::Mash with 2 keys" do
-      obj = Hashie::Mash.new({:name => 'hello', :key2 => 'key2'})
-      @helper_class.is_collection?(obj)
-    end.equals(false)
-
-  end # is_collection method
-end

data/test/integration/posts_controller_test.rb

@@ -1,108 +0,0 @@
-# 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
-
-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 => "Paz", :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(&:iso8601) }
-
-    # 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
-
-  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.iso8601 }
-
-    # 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
-  end # show action
-end

data/test/integration/rails3_2/posts_controller_test.rb

@@ -1,263 +0,0 @@
-# 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(&:iso8601) }
-
-    # 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)
-
-    context "mime types" do
-      setup do
-        get "/posts", format: :rabl_test_v1
-      end
-
-      asserts("contains post title") do
-        json_output['articles'].first['article']
-      end.includes("title_v1")
-
-      asserts("contains post user child username") do
-        json_output['articles'].first['article']["user"]
-      end.includes("username_v1")
-    end
-  end
-
-
-  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.iso8601 }
-
-    # 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
-
-  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'] }
-
-      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'])[: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'] }
-    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'] }
-    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/rails3_2/users_controller_test.rb

@@ -1,87 +0,0 @@
-# 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"
-    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.iso8601 } }
-
-    # 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}"
-    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.iso8601 }
-    # 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