rabl 0.3.0 → 0.5.0

data/fixtures/padrino_test/.gitignore

@@ -0,0 +1,7 @@
+.DS_Store
+log/**/*
+tmp/**/*
+bin/*
+vendor/gems/*
+!vendor/gems/cache/
+.sass-cache/*

data/fixtures/padrino_test/Gemfile

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

data/fixtures/padrino_test/Rakefile

@@ -0,0 +1,3 @@
+require File.expand_path('../config/boot.rb', __FILE__)
+require 'padrino-core/cli/rake'
+PadrinoTasks.init

data/fixtures/padrino_test/app/app.rb

@@ -0,0 +1,59 @@
+class PadrinoTest < Padrino::Application
+  register Padrino::Rendering
+  register Padrino::Mailer
+  register Padrino::Helpers
+
+  enable :sessions
+
+  ##
+  # Caching support
+  #
+  # register Padrino::Cache
+  # enable :caching
+  #
+  # You can customize caching store engines:
+  #
+  #   set :cache, Padrino::Cache::Store::Memcache.new(::Memcached.new('127.0.0.1:11211', :exception_retry_limit => 1))
+  #   set :cache, Padrino::Cache::Store::Memcache.new(::Dalli::Client.new('127.0.0.1:11211', :exception_retry_limit => 1))
+  #   set :cache, Padrino::Cache::Store::Redis.new(::Redis.new(:host => '127.0.0.1', :port => 6379, :db => 0))
+  #   set :cache, Padrino::Cache::Store::Memory.new(50)
+  #   set :cache, Padrino::Cache::Store::File.new(Padrino.root('tmp', app_name.to_s, 'cache')) # default choice
+  #
+
+  ##
+  # Application configuration options
+  #
+  # set :raise_errors, true     # Raise exceptions (will stop application) (default for test)
+  # set :dump_errors, true      # Exception backtraces are written to STDERR (default for production/development)
+  # set :show_exceptions, true  # Shows a stack trace in browser (default for development)
+  # set :logging, true          # Logging in STDOUT for development and file for production (default only for development)
+  # set :public, "foo/bar"      # Location for static assets (default root/public)
+  # set :reload, false          # Reload application files (default in development)
+  # set :default_builder, "foo" # Set a custom form builder (default 'StandardFormBuilder')
+  # set :locale_path, "bar"     # Set path for I18n translations (default your_app/locales)
+  # disable :sessions           # Disabled sessions by default (enable if needed)
+  # disable :flash              # Disables rack-flash (enabled by default if Rack::Flash is defined)
+  # layout  :my_layout          # Layout can be in views/layouts/foo.ext or views/foo.ext (default :application)
+  #
+
+  ##
+  # You can configure for a specified environment like:
+  #
+  #   configure :development do
+  #     set :foo, :bar
+  #     disable :asset_stamp # no asset timestamping for dev
+  #   end
+  #
+
+  ##
+  # You can manage errors like:
+  #
+  #   error 404 do
+  #     render 'errors/404'
+  #   end
+  #
+  #   error 505 do
+  #     render 'errors/505'
+  #   end
+  #
+end

data/fixtures/padrino_test/app/controllers/posts.rb

@@ -0,0 +1,11 @@
+PadrinoTest.controllers :posts do
+  get :index do
+    @posts = Post.order("id ASC")
+    render "posts/index"
+  end
+
+  get :show, :map => "/posts", :with => :id do
+    @post = Post.find(params[:id])
+    render "posts/show"
+  end
+end

data/fixtures/padrino_test/app/controllers/users.rb

@@ -0,0 +1,11 @@
+PadrinoTest.controllers :users do
+  get :index do
+    @users = User.order("username ASC")
+    render "users/index"
+  end
+
+  get :show, :map => "/users", :with => :id do
+    @user = User.find(params[:id])
+    render "users/show"
+  end
+end

data/fixtures/padrino_test/app/helpers/posts_helper.rb

@@ -0,0 +1,7 @@
+# Helper methods defined here can be accessed in any controller or view in the application
+
+PadrinoTest.helpers do
+  # def simple_helper_method
+  #  ...
+  # end
+end

data/fixtures/padrino_test/app/helpers/users_helper.rb

@@ -0,0 +1,7 @@
+# Helper methods defined here can be accessed in any controller or view in the application
+
+PadrinoTest.helpers do
+  # def simple_helper_method
+  #  ...
+  # end
+end

data/fixtures/padrino_test/config.ru

@@ -0,0 +1,9 @@
+#!/usr/bin/env rackup
+# encoding: utf-8
+
+# This file can be used to start Padrino,
+# just execute it from the command line.
+
+require File.expand_path("../config/boot.rb", __FILE__)
+
+run Padrino.application

data/fixtures/padrino_test/config/apps.rb

@@ -0,0 +1,34 @@
+##
+# This file mounts each app in the Padrino project to a specified sub-uri.
+# You can mount additional applications using any of these commands below:
+#
+#   Padrino.mount("blog").to('/blog')
+#   Padrino.mount("blog", :app_class => "BlogApp").to('/blog')
+#   Padrino.mount("blog", :app_file =>  "path/to/blog/app.rb").to('/blog')
+#
+# You can also map apps to a specified host:
+#
+#   Padrino.mount("Admin").host("admin.example.org")
+#   Padrino.mount("WebSite").host(/.*\.?example.org/)
+#   Padrino.mount("Foo").to("/foo").host("bar.example.org")
+#
+# Note 1: Mounted apps (by default) should be placed into the project root at '/app_name'.
+# Note 2: If you use the host matching remember to respect the order of the rules.
+#
+# By default, this file mounts the primary app which was generated with this project.
+# However, the mounted app can be modified as needed:
+#
+#   Padrino.mount("AppName", :app_file => "path/to/file", :app_class => "BlogApp").to('/')
+#
+
+##
+# Setup global project settings for your apps. These settings are inherited by every subapp. You can
+# override these settings in the subapps as needed.
+#
+Padrino.configure_apps do
+  # enable :sessions
+  set :session_secret, '1559bdc5e1f33a0d1c9a597580a189080b39ab7d06eed1a7db12e90f9d269e89'
+end
+
+# Mounts the core application for this project
+Padrino.mount("PadrinoTest").to('/')

data/fixtures/padrino_test/config/boot.rb

@@ -0,0 +1,29 @@
+# Defines our constants
+PADRINO_ENV  = ENV["PADRINO_ENV"] ||= ENV["RACK_ENV"] ||= "development"  unless defined?(PADRINO_ENV)
+PADRINO_ROOT = File.expand_path('../..', __FILE__) unless defined?(PADRINO_ROOT)
+
+# Load our dependencies
+require 'rubygems' unless defined?(Gem)
+require 'bundler/setup'
+Bundler.require(:default, PADRINO_ENV)
+
+##
+# Enable devel logging
+#
+# Padrino::Logger::Config[:development] = { :log_level => :devel, :stream => :stdout }
+# Padrino::Logger.log_static = true
+#
+
+##
+# Add your before load hooks here
+#
+Padrino.before_load do
+end
+
+##
+# Add your after load hooks here
+#
+Padrino.after_load do
+end
+
+Padrino.load!

data/fixtures/padrino_test/config/database.rb

@@ -0,0 +1,43 @@
+##
+# You can use other adapters like:
+#
+#   ActiveRecord::Base.configurations[:development] = {
+#     :adapter   => 'mysql',
+#     :encoding  => 'utf8',
+#     :reconnect => true,
+#     :database  => 'your_database',
+#     :pool      => 5,
+#     :username  => 'root',
+#     :password  => '',
+#     :host      => 'localhost',
+#     :socket    => '/tmp/mysql.sock'
+#   }
+#
+ActiveRecord::Base.configurations[:development] = {
+  :adapter => 'sqlite3',
+  :database => ":memory:"
+}
+
+ActiveRecord::Base.configurations[:test] = {
+  :adapter => 'sqlite3',
+  :database => ":memory:"
+}
+
+# Setup our logger
+ActiveRecord::Base.logger = logger
+
+# Include Active Record class name as root for JSON serialized output.
+ActiveRecord::Base.include_root_in_json = true
+
+# Store the full class name (including module namespace) in STI type column.
+ActiveRecord::Base.store_full_sti_class = true
+
+# Use ISO 8601 format for JSON serialized times and dates.
+ActiveSupport.use_standard_json_time_format = true
+
+# Don't escape HTML entities in JSON, leave that for the #json_escape helper.
+# if you're including raw json in an HTML page.
+ActiveSupport.escape_html_entities_in_json = false
+
+# Now we can estabilish connection with our db
+ActiveRecord::Base.establish_connection(ActiveRecord::Base.configurations[Padrino.env])

data/fixtures/padrino_test/db/schema.rb

@@ -0,0 +1,42 @@
+# encoding: UTF-8
+# This file is auto-generated from the current state of the database. Instead
+# of editing this file, please use the migrations feature of Active Record to
+# incrementally modify your database, and then regenerate this schema definition.
+#
+# Note that this schema.rb definition is the authoritative source for your
+# database schema. If you need to create the application database on another
+# system, you should be using db:schema:load, not running all the migrations
+# from scratch. The latter is a flawed and unsustainable approach (the more migrations
+# you'll amass, the slower it'll run and the greater likelihood for issues).
+#
+# It's strongly recommended to check this file into your version control system.
+
+ActiveRecord::Schema.define(:version => 3) do
+
+  create_table "phone_numbers", :force => true do |t|
+    t.integer "user_id"
+    t.boolean "is_primary"
+    t.string  "area_code"
+    t.string  "prefix"
+    t.string  "suffix"
+    t.string  "name"
+  end
+
+  create_table "posts", :force => true do |t|
+    t.integer  "user_id"
+    t.string   "title"
+    t.text     "body"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+
+  create_table "users", :force => true do |t|
+    t.string   "username"
+    t.string   "email"
+    t.string   "location"
+    t.boolean  "is_admin"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+
+end

data/fixtures/padrino_test/test/app/controllers/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/padrino_test/test/app/controllers/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