rabl 0.3.0 → 0.5.0

data/.gitignore

@@ -3,3 +3,5 @@
 .rvmrc
 Gemfile.lock
 pkg/*
+fixtures/rails2/log/*.log
+tags

data/.travis.yml

@@ -0,0 +1,10 @@
+# http://about.travis-ci.org/docs/user/build-configuration/
+before_script: "git submodule update --init"
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - rbx-2.0
+  - ree
+notifications:
+  recipients:
+    - nesquena@gmail.com

data/CHANGELOG.md

@@ -0,0 +1,34 @@
+# CHANGELOG
+
+## 0.5.1 (Unreleased)
+
+## 0.5.0
+
+ * Adds comprehensive fixture suite (padrino,rails2,rails3,sinatra)
+ * Travis CI Integration Testing
+ * Cleanup json configuration and related tests (Thanks mschulkind)
+ * Adds CHANGELOG to track changes
+ * Adds optional MessagePack format support (thanks byu)
+ * Explicit requires for ActiveSupport now in gemspec and lib
+ * Adds template support for regular (non-ORM) ruby objects (thanks plukevdh)
+ * Fixes bug with the child root not properly appearing in all cases
+ * Better stack traces by tracking source location in instance_eval (thanks skade)
+ * Fix issue with controller object detection failing in namespaces (thanks alunny)
+ * Fix ruby -w warnings (thanks achiu)
+ * Better partial implementation which passes options
+ * Better fetch_source implementation for Padrino (thanks skade)
+ * Better fetch_source implementation for Rails
+ * Added fetch_source implementation for Sinatra
+ * Lots of test refactorings / cleanup / improvement
+ * Code block name is now optional [Thanks brentmurphy]
+
+## 0.3.0
+
+ * Use multi_json to handle JSON encoding (Thanks kossnocorp)
+ * Fixes unit tests with hash order on 1.8.7
+
+## 0.2.8
+
+ * Fixes Rails 3.1 Compatibility (Thanks skyeagle)
+ * Fixes Ruby 1.8.6 Compatibility (Thanks Don)
+ * Adds much better riot unit testing (Thanks Achiu)

data/Gemfile

@@ -1,8 +1,21 @@
-source "http://rubygems.org"
+source :rubygems
 
 # Specify your gem's dependencies in rabl.gemspec
 gemspec
 
+gem "rake"
+gem "i18n", '~> 0.6'
+
 platforms :mri_18 do
   gem 'SystemTimer'
+end
+
+# FIXTURES
+group :test do
+  gem 'rack-test', :require => "rack/test"
+  gem 'activerecord', :require => "active_record"
+  gem 'sqlite3'
+  gem 'padrino', '>= 0.10.2'
+  gem 'sinatra', '>= 1.2.0'
+  gem 'rails', '>= 2.3.0'
 end

data/README.md

@@ -26,6 +26,8 @@ or add to your Gemfile:
 ```ruby
 # Gemfile
 gem 'rabl'
+# Also add either `json` or `yajl-ruby` as the JSON parser
+gem 'yajl-ruby'
 ```
 
 and run `bundle install` to install the dependency.
@@ -87,7 +89,9 @@ RABL is intended to require little to no configuration to get working. This is t
 Rabl.configure do |config|
   # Commented as these are the defaults
   # config.json_engine = nil # Any multi\_json engines
+  # config.msgpack_engine = nil # Defaults to ::MessagePack
   # config.include_json_root = true
+  # config.include_msgpack_root = true
   # config.include_xml_root  = false
   # config.enable_json_callbacks = false
   # config.xml_options = { :dasherize  => true, :skip_types => false }
@@ -105,6 +109,32 @@ gem 'yajl-ruby', :require => "yajl"
 
 and RABL will automatically start using that engine for encoding your JSON responses!
 
+### Message Pack ###
+
+Rabl also includes optional support for [Message Pack](http://www.msgpack.org/) serialization format using the [msgpack gem](https://rubygems.org/gems/msgpack).
+To enable, include the msgpack gem in your project's Gemfile. Then use Rabl as normal with the `msgpack` format (akin to json and xml formats).
+
+```ruby
+# Gemfile
+gem 'msgpack', '~> 0.4.5'
+```
+
+One can additionally use a custom Message Pack implementation by setting the Rabl `msgpack_engine` configuration attribute. This custom message pack engine must conform to the MessagePack#pack method signature.
+
+```ruby
+class CustomEncodeEngine
+  def self.pack string
+    # Custom Encoding by your own engine.
+  end
+end
+
+Rabl.configure do |config|
+  config.msgpack_engine = CustomEncodeEngine
+end
+```
+
+*NOTE*: Attempting to render the msgpack format without either including the msgpack gem or setting a `msgpack_engine` will cause an exception to be raised.
+
 ## Usage ##
 
 ### Object Assignment ###
@@ -234,6 +264,15 @@ code(:foo, :if => lambda { |m| m.has_foo? }) do |m|
 end
 ```
 
+or don't pass a name and have the code block merged into the response:
+
+```ruby
+code do |u|
+  { :full_name => u.first_name + " " + u.last_name }
+  # => { full_name : "Bob Johnson" }
+end
+```
+
 You can use custom "code" nodes to create flexible representations of a value utilizing all the data from the model.
 
 ### Partials ###
@@ -327,6 +366,12 @@ Check out the [Issues](https://github.com/nesquena/rabl/issues) tab for a full l
  * Better Tilt template support (precompiling templates)
  * Benchmarks and performance optimizations
 
+## Continuous Integration
+
+[![Continuous Integration status](https://secure.travis-ci.org/nesquena/rabl.png)](http://travis-ci.org/nesquena/rabl)
+
+CI is hosted by [travis-ci.org](http://travis-ci.org).
+
 ## Authors and Contributors ##
 
 Thanks to [Miso](http://gomiso.com) for allowing me to create this for our applications and release this project!
@@ -334,12 +379,16 @@ Thanks to [Miso](http://gomiso.com) for allowing me to create this for our appli
 * [Nathan Esquenazi](https://github.com/nesquena) - Creator of the project
 * [Arthur Chiu](https://github.com/achiu) - Core Maintainer, Riot Testing Guru
 * [Tim Lee](https://github.com/timothy1ee) - RABL is an awesome name and was chosen by the Miso CTO.
-* [Rick Thomas](https://github.com/rickthomasjr) - Added options passing for extends and Sinatra testing
-* [Marjun](https://github.com/mpagalan) - Added xml option configurations
+* [Rick Thomas](https://github.com/rickthomasjr) - Added options for extends and Sinatra testing
 * [Chris Kimpton](https://github.com/kimptoc) - Helping with documentation and wiki
+* [Marjun](https://github.com/mpagalan) - Added xml option configurations
+* [Anton Orel](https://github.com/skyeagle) - Added Rails 3.1 compatibility
 * [Sasha Koss](https://github.com/kossnocorp) - Added multi_json support
+* [Matthew Schulkind](https://github.com/mschulkind) - Cleanup of configuration and tests
+* [Luke van der Hoeven](https://github.com/plukevdh) - Support non-ORM objects in templates
 
-More to come hopefully! Please fork and contribute, any help is appreciated!
+and many more contributors listed in the [CHANGELOG](https://github.com/nesquena/rabl/blob/master/CHANGELOG.md).
+Please fork and contribute, any help in making this project better is appreciated!
 
 ## Inspirations ##
 
@@ -357,4 +406,4 @@ See the [examples](https://github.com/nesquena/rabl/tree/master/examples) direct
 
 ## Copyright
 
-Copyright © 2011 Nathan Esquenazi. See [MIT-LICENSE](https://github.com/nesquena/rabl/blob/master/MIT-LICENSE) for details.
+Copyright © 2011 Nathan Esquenazi. See [MIT-LICENSE](https://github.com/nesquena/rabl/blob/master/MIT-LICENSE) for details.

data/Rakefile

@@ -1,10 +1,35 @@
+include Rake::DSL
+
 require 'bundler'
 Bundler::GemHelper.install_tasks
 
 require 'rake/testtask'
 Rake::TestTask.new(:test) do |test|
   test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/*_test.rb'
+  test.pattern = 'test/*_test.rb'
+  test.warning = true
   test.verbose = true
   test.ruby_opts = ['-rubygems']
 end
+
+desc "Prepares the fixtures for being tested by installing dependencies"
+task "test:setup" do
+  Dir[File.dirname(__FILE__) + "/fixtures/{padrino_test,sinatra_test,rails2,rails3}"].each do |fixture|
+    puts "\n*** Setting up for #{File.basename(fixture)} tests ***\n"
+    `export BUNDLE_GEMFILE=#{fixture}/Gemfile` if ENV['TRAVIS']
+    puts `cd #{fixture}; bundle install;`
+  end
+end
+
+desc "Executes the fixture tests"
+task "test:fixtures" do
+  Dir[File.dirname(__FILE__) + "/fixtures/{padrino_test,sinatra_test,rails2,rails3}"].each do |fixture|
+    puts "\n*** Running tests for #{File.basename(fixture)}... ***\n"
+    puts `cd #{fixture}; bundle check; bundle exec rake test:rabl`
+  end
+end
+
+task "test:full" => [:test, "test:fixtures"]
+
+desc "Run tests for rabl"
+task :default => :test

data/fixtures/ashared/NOTES

@@ -0,0 +1,35 @@
+# Padrino
+
+cd fixtures/padrino_test
+ln -s "../ashared/models" models
+ln -s "../../ashared/views/" app/views
+ln -s "../../ashared/migrate" db/migrate
+ln ../../test/integration/posts_controller_test.rb test/app/controllers/posts_controller_test.rb
+ln ../../test/integration/users_controller_test.rb test/app/controllers/users_controller_test.rb
+
+# Rails 2
+
+cd fixtures/rails2
+ln -s "../../ashared/models" app/models
+ln -s "../../ashared/views/" app/views
+ln -s "../../ashared/migrate" db/migrate
+ln ../../test/integration/posts_controller_test.rb test/functionals/posts_controller_test.rb
+ln ../../test/integration/users_controller_test.rb test/functionals/users_controller_test.rb
+
+# Rails 3
+
+cd fixtures/rails3
+ln -s "../../ashared/models" app/models
+ln -s "../../ashared/views/" app/views
+ln -s "../../ashared/migrate" db/migrate
+ln ../../test/integration/posts_controller_test.rb test/functional/posts_controller_test.rb
+ln ../../test/integration/users_controller_test.rb test/functional/users_controller_test.rb
+
+# Sinatra
+
+cd fixtures/sinatra_test
+ln -s "../ashared/models" models
+ln -s "../ashared/views/" views
+ln -s "../../ashared/migrate" db/migrate
+ln ../../test/integration/posts_controller_test.rb test/functional/posts_controller_test.rb
+ln ../../test/integration/users_controller_test.rb test/functional/users_controller_test.rb

data/fixtures/ashared/README

@@ -0,0 +1,35 @@
+Fixtures to test RABL:
+
+models:
+
+  user
+    t.string :username
+    t.string :email
+    t.string :location
+    t.boolean :is_admin
+    t.timestamps
+  posts
+    t.integer :user_id
+    t.string  :title
+    t.text    :body
+    t.timestamps
+  phone_number
+    t.integer :user_id
+    t.boolean :is_primary
+    t.string :area_code
+    t.string :prefix
+    t.string :suffix
+    t.string :name
+
+controllers:
+
+  users
+  posts
+
+layouts:
+
+  application.html.haml
+
+views:
+   posts (index, show, date)
+   users (index, show)

data/fixtures/ashared/migrate/20111002092016_create_users.rb

@@ -0,0 +1,15 @@
+class CreateUsers < ActiveRecord::Migration
+  def self.up
+    create_table :users do |t|
+      t.string  :username
+      t.string  :email
+      t.string  :location
+      t.boolean :is_admin
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :users
+  end
+end

data/fixtures/ashared/migrate/20111002092019_create_posts.rb

@@ -0,0 +1,14 @@
+class CreatePosts < ActiveRecord::Migration
+  def self.up
+    create_table :posts do |t|
+      t.integer :user_id
+      t.string  :title
+      t.text    :body
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :posts
+  end
+end

data/fixtures/ashared/migrate/20111002092024_create_phone_numbers.rb

@@ -0,0 +1,16 @@
+class CreatePhoneNumbers < ActiveRecord::Migration
+  def self.up
+    create_table :phone_numbers do |t|
+      t.integer :user_id
+      t.boolean :is_primary
+      t.string :area_code
+      t.string :prefix
+      t.string :suffix
+      t.string :name
+    end
+  end
+
+  def self.down
+    drop_table :phone_numbers
+  end
+end

data/fixtures/ashared/models/phone_number.rb

@@ -0,0 +1,7 @@
+class PhoneNumber < ActiveRecord::Base
+  belongs_to :user
+
+  def formatted
+    "(#{self.area_code}) #{self.prefix}-#{self.suffix}"
+  end
+end

data/fixtures/ashared/models/post.rb

@@ -0,0 +1,3 @@
+class Post < ActiveRecord::Base
+  belongs_to :user
+end

data/fixtures/ashared/models/user.rb

@@ -0,0 +1,3 @@
+class User < ActiveRecord::Base
+  has_many :phone_numbers
+end

data/fixtures/ashared/views/layouts/application.html.erb

@@ -0,0 +1,6 @@
+<head>
+  Not for RABL
+</head>
+<body>
+  Not for RABL
+</body>

data/fixtures/ashared/views/posts/date.json.rabl

@@ -0,0 +1,3 @@
+code(:day) { |d| d.day }
+code(:hour) { |d| d.hour }
+code(:full) { |d| d.iso8601 }

data/fixtures/ashared/views/posts/index.json.rabl

@@ -0,0 +1,11 @@
+collection @posts => :articles
+
+extends "posts/show"
+
+node(:created_by_admin, :if => lambda { |p| p.user.is_admin }) do |p|
+  true
+end
+
+child({ :user => :admin }, { :if => lambda { |p| p.user.is_admin  }}) do |p|
+  extends "users/show"
+end

data/fixtures/ashared/views/posts/show.json.rabl

@@ -0,0 +1,16 @@
+object @post
+
+attributes :title, :body
+attributes :created_at => :posted_at
+
+child :user do
+  extends "users/show"
+end
+
+glue :user do
+  attributes :username => :author_name
+end
+
+code(:created_date) do |p|
+  partial("posts/date", :object => p.created_at)
+end

data/fixtures/ashared/views/users/index.rabl

@@ -0,0 +1,3 @@
+collection @users
+
+extends "users/show"

data/fixtures/ashared/views/users/phone_number.rabl

@@ -0,0 +1,6 @@
+attributes :prefix, :suffix, :area_code
+attributes :is_primary => :primary
+
+node :formatted do |n|
+  n.formatted
+end

data/fixtures/ashared/views/users/show.rabl

@@ -0,0 +1,16 @@
+object @user => :person
+
+attributes :username, :email, :location
+attributes :created_at => :registered_at
+
+node :role do |user|
+  user.is_admin ? 'admin' : 'normal'
+end
+
+child :phone_numbers => :pnumbers do
+  extends "users/phone_number"
+end
+
+node :node_numbers do |u|
+  partial("users/phone_number", :object => u.phone_numbers)
+end

data/fixtures/padrino_test/.components

@@ -0,0 +1,7 @@
+--- 
+:orm: activerecord
+:test: riot
+:mock: none
+:script: none
+:renderer: haml
+:stylesheet: none