rabl 0.3.0 → 0.5.0

data/fixtures/rails3/public/robots.txt

@@ -0,0 +1,5 @@
+# See http://www.robotstxt.org/wc/norobots.html for documentation on how to use the robots.txt file
+#
+# To ban all spiders from the entire site uncomment the next two lines:
+# User-Agent: *
+# Disallow: /

data/fixtures/rails3/script/rails

@@ -0,0 +1,6 @@
++#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
+
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require File.expand_path('../../config/boot',  __FILE__)
+require 'rails/commands'

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

@@ -0,0 +1,108 @@
+# 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"
+    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}"
+      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/fixtures/rails3/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"
+    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(&: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 formatted node numbers") do
+      json_output.map { |u| u["user"]["node_numbers"].map { |n| n["formatted"] } }
+    end.equals { @users.map { |u| u.phone_numbers.map(&:formatted) } }
+  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

data/fixtures/rails3/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/fixtures/sinatra_test/Gemfile

@@ -0,0 +1,13 @@
+source :rubygems
+
+gem 'rake'
+gem 'activerecord', :require => "active_record"
+gem 'sqlite3'
+
+gem 'sinatra', '>= 1.2.0'
+gem 'json'
+gem 'rabl', :path => File.expand_path(File.dirname(__FILE__) + "/../../")
+
+# Test requirements
+gem 'riot', :group => "test"
+gem 'rack-test', :require => "rack/test", :group => "test"

data/fixtures/sinatra_test/Rakefile

@@ -0,0 +1,6 @@
+require 'rake/testtask'
+
+Rake::TestTask.new("test:rabl") do |test|
+  test.pattern = "test/functional/**/*_test.rb"
+  test.verbose = true
+end

data/fixtures/sinatra_test/app.rb

@@ -0,0 +1,44 @@
+require 'rubygems'
+require 'sinatra'
+require 'rabl'
+require 'active_support/core_ext'
+require 'active_support/inflector'
+require 'active_record'
+require 'builder'
+
+ActiveRecord::Base.establish_connection(
+  :adapter => 'sqlite3',
+  :database =>  ':memory:'
+)
+
+Dir[File.dirname(__FILE__) + "/models/*.rb"].each do |file|
+  require File.expand_path(file)
+end
+
+# Register RABL
+Rabl.register!
+
+class SinatraTest < Sinatra::Application
+  set :root, File.expand_path(File.dirname(__FILE__))
+  set :views, Proc.new { File.join(root, "views") }
+
+  get "/posts" do
+    @posts = Post.order("id ASC")
+    render :rabl, :"posts/index.json", :format => "json"
+  end
+
+  get "/posts/:id" do
+    @post = Post.find(params[:id])
+    render :rabl, :"posts/show.json", :format => "json"
+  end
+
+  get "/users" do
+    @users = User.order("username ASC")
+    render :rabl, :"users/index", :format => "json"
+  end
+
+  get "/users/:id" do
+    @user = User.find(params[:id])
+    render :rabl, :"users/show", :format => "json"
+  end
+end

data/fixtures/sinatra_test/config.ru

@@ -0,0 +1,7 @@
+require 'rubygems'
+require 'bundler'
+
+Bundler.require
+
+require './app'
+run SinatraTest

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

@@ -0,0 +1,108 @@
+# 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"
+    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}"
+      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/fixtures/sinatra_test/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"
+    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(&: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 formatted node numbers") do
+      json_output.map { |u| u["user"]["node_numbers"].map { |n| n["formatted"] } }
+    end.equals { @users.map { |u| u.phone_numbers.map(&:formatted) } }
+  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