rabl 0.3.0 → 0.5.0

data/test/models/ormless.rb

@@ -0,0 +1,2 @@
+class Ormless
+end

data/test/models/user.rb

@@ -1,9 +1,20 @@
-require 'mongoid'
-
 class User
-  include Mongoid::Document
+  attr_accessor :age, :city, :name
+
+  DEFAULT_AGE  = 24
+  DEFAULT_CITY = 'irvine'
+  DEFAULT_NAME = 'rabl'
+
+  def initialize(attributes={})
+    self.age  = attributes[:age]  || DEFAULT_AGE
+    self.city = attributes[:city] || DEFAULT_CITY
+    self.name = attributes[:name] || DEFAULT_NAME
+  end
+end
 
-  field :name, :type => String,  :default => 'rabl'
-  field :city, :type => String,  :default => 'irvine'
-  field :age,  :type => Integer, :default => 24
+module NestedScope
+  class User
+    def controller; self; end
+    def controller_name; self.class.name.downcase; end
+  end
 end

data/test/msgpack_engine_test.rb

@@ -0,0 +1,332 @@
+require File.expand_path('../teststrap', __FILE__)
+require File.expand_path('../../lib/rabl', __FILE__)
+require File.expand_path('../../lib/rabl/template', __FILE__)
+require File.expand_path('../models/user', __FILE__)
+
+context "Rabl::Engine" do
+
+  helper(:rabl) { |t| RablTemplate.new("code", :format => 'msgpack') { t } }
+
+  context "with msgpack defaults" do
+    setup do
+      Rabl.configure do |config|
+        # Comment this line out because include_msgpack_root is default.
+        #config.include_msgpack_root = true
+      end
+    end
+
+    context "#object" do
+
+      asserts "that it sets data source" do
+        template = rabl %q{
+          object @user
+        }
+        scope = Object.new
+        scope.instance_variable_set :@user, User.new
+        template.render(scope)
+      end.matches "\x81\xA4user\x80"
+
+      asserts "that it can set root node" do
+        template = rabl %q{
+          object @user => :person
+        }
+        scope = Object.new
+        scope.instance_variable_set :@user, User.new
+        template.render(scope).split("").sort
+      end.equals "\x81\xA6person\x80".split("").sort
+    end
+
+    context "#collection" do
+
+      asserts "that it sets object to be casted as a simple array" do
+        template = rabl %{
+          collection @users
+        }
+        scope = Object.new
+        scope.instance_variable_set :@users, [User.new, User.new]
+        template.render(scope).split("").sort
+      end.equals "\x92\x81\xA4user\x80\x81\xA4user\x80".split("").sort
+
+      asserts "that it sets root node for objects" do
+        template = rabl %{
+          collection @users => :person
+        }
+        scope = Object.new
+        scope.instance_variable_set :@users, [User.new, User.new]
+        template.render(scope).split("").sort
+      end.equals "\x81\xA6person\x92\x81\xA6person\x80\x81\xA6person\x80".split("").sort
+
+    end
+
+    context "#attribute" do
+
+      asserts "that it adds an attribute or method to be included in output" do
+        template = rabl %{
+          object @user
+          attribute :name
+        }
+        scope = Object.new
+        scope.instance_variable_set :@user, User.new(:name => 'irvine')
+        template.render(scope).split("").sort
+      end.equals "\x81\xA4user\x81\xA4name\xA6irvine".split("").sort
+
+      asserts "that it can add attribute under a different key name through :as" do
+        template = rabl %{
+          object @user
+          attribute :name, :as => 'city'
+        }
+        scope = Object.new
+        scope.instance_variable_set :@user, User.new(:name => 'irvine')
+        template.render(scope).split("").sort
+      end.equals "\x81\xA4user\x81\xA4city\xA6irvine".split("").sort
+
+      asserts "that it can add attribute under a different key name through hash" do
+        template = rabl %{
+          object @user
+          attribute :name => :city
+        }
+        scope = Object.new
+        scope.instance_variable_set :@user, User.new(:name => 'irvine')
+        template.render(scope).split("").sort
+      end.equals "\x81\xA4user\x81\xA4city\xA6irvine".split("").sort
+
+    end
+
+    context "#code" do
+
+      asserts "that it can create an arbitraty code node" do
+        template = rabl %{
+          code(:foo) { 'bar' }
+        }
+        template.render(Object.new).split("").sort
+      end.equals "\x81\xA3foo\xA3bar".split("").sort
+
+      asserts "that it can be passed conditionals" do
+        template = rabl %{
+          code(:foo, :if => lambda { |i| false }) { 'bar' }
+        }
+        template.render(Object.new).split("").sort
+      end.equals "\x80".split("").sort
+
+    end
+
+    context "#child" do
+
+      asserts "that it can create a child node" do
+        template = rabl %{
+          object @user
+          attribute :name
+          child(@user) { attribute :city }
+        }
+        scope = Object.new
+        scope.instance_variable_set :@user, User.new(:name => 'leo', :city => 'LA')
+        template.render(scope).split("").sort
+      end.equals "\x81\xA4user\x82\xA4name\xA3leo\xA4user\x81\xA4city\xA2LA".split("").sort
+
+      asserts "that it can create a child node with different key" do
+        template = rabl %{
+          object @user
+          attribute :name
+          child(@user => :person) { attribute :city }
+        }
+        scope = Object.new
+        scope.instance_variable_set :@user, User.new(:name => 'leo', :city => 'LA')
+        template.render(scope).split("").sort
+
+      end.equals "\x81\xA4user\x82\xA4name\xA3leo\xA6person\x81\xA4city\xA2LA".split("").sort
+    end
+
+    context "#glue" do
+
+      asserts "that it glues data from a child node" do
+        template = rabl %{
+          object @user
+          attribute :name
+          glue(@user) { attribute :city }
+          glue(@user) { attribute :age  }
+        }
+        scope = Object.new
+        scope.instance_variable_set :@user, User.new(:name => 'leo', :city => 'LA', :age => 12)
+        template.render(scope).split("").sort
+      end.equals "\x81\xA4user\x83\xA4name\xA3leo\xA4city\xA2LA\xA3age\f".split("").sort
+    end
+
+    teardown do
+      Rabl.reset_configuration!
+    end
+  end
+
+  context "with msgpack_engine" do
+    setup do
+      class CustomEncodeEngine
+        def self.pack string
+          42
+        end
+      end
+
+      Rabl.configure do |config|
+        config.msgpack_engine = CustomEncodeEngine
+      end
+    end
+
+    asserts 'that it returns process by custom to_json' do
+      template = rabl %q{
+        object @user
+      }
+      scope = Object.new
+      scope.instance_variable_set :@user, User.new
+      template.render(scope)
+    end.equals 42
+
+    teardown do
+      Rabl.reset_configuration!
+    end
+  end
+
+  context "without msgpack root" do
+    setup do
+      Rabl.configure do |config|
+        config.include_msgpack_root = false
+      end
+    end
+
+    context "#object" do
+
+      asserts "that it sets data source" do
+        template = rabl %q{
+          object @user
+        }
+        scope = Object.new
+        scope.instance_variable_set :@user, User.new
+        template.render(scope)
+      end.matches "\x80"
+
+      asserts "that it can set root node" do
+        template = rabl %q{
+          object @user => :person
+        }
+        scope = Object.new
+        scope.instance_variable_set :@user, User.new
+        template.render(scope)
+      end.equals "\x80"
+    end
+
+    context "#collection" do
+
+      asserts "that it sets object to be casted as a simple array" do
+        template = rabl %{
+          collection @users
+        }
+        scope = Object.new
+        scope.instance_variable_set :@users, [User.new, User.new]
+        template.render(scope).split("").sort
+      end.equals "\x92\x80\x80".split("").sort
+
+      asserts "that it sets root node for objects" do
+        template = rabl %{
+          collection @users => :person
+        }
+        scope = Object.new
+        scope.instance_variable_set :@users, [User.new, User.new]
+        template.render(scope).split("").sort
+      end.equals "\x81\xA6person\x92\x80\x80".split("").sort
+
+    end
+
+    context "#attribute" do
+
+      asserts "that it adds an attribute or method to be included in output" do
+        template = rabl %{
+          object @user
+          attribute :name
+        }
+        scope = Object.new
+        scope.instance_variable_set :@user, User.new(:name => 'irvine')
+        template.render(scope).split("").sort
+      end.equals "\x81\xA4name\xA6irvine".split("").sort
+
+      asserts "that it can add attribute under a different key name through :as" do
+        template = rabl %{
+          object @user
+          attribute :name, :as => 'city'
+        }
+        scope = Object.new
+        scope.instance_variable_set :@user, User.new(:name => 'irvine')
+        template.render(scope).split("").sort
+      end.equals "\x81\xA4city\xA6irvine".split("").sort
+
+      asserts "that it can add attribute under a different key name through hash" do
+        template = rabl %{
+          object @user
+          attribute :name => :city
+        }
+        scope = Object.new
+        scope.instance_variable_set :@user, User.new(:name => 'irvine')
+        template.render(scope).split("").sort
+      end.equals "\x81\xA4city\xA6irvine".split("").sort
+
+    end
+
+    context "#code" do
+
+      asserts "that it can create an arbitraty code node" do
+        template = rabl %{
+          code(:foo) { 'bar' }
+        }
+        template.render(Object.new).split("").sort
+      end.equals "\x81\xA3foo\xA3bar".split("").sort
+
+      asserts "that it can be passed conditionals" do
+        template = rabl %{
+          code(:foo, :if => lambda { |i| false }) { 'bar' }
+        }
+        template.render(Object.new).split("").sort
+      end.equals "\x80".split("").sort
+
+    end
+
+    context "#child" do
+
+      asserts "that it can create a child node" do
+        template = rabl %{
+          object @user
+          attribute :name
+          child(@user) { attribute :city }
+        }
+        scope = Object.new
+        scope.instance_variable_set :@user, User.new(:name => 'leo', :city => 'LA')
+        template.render(scope).split("").sort
+      end.equals "\x82\xA4name\xA3leo\xA4user\x81\xA4city\xA2LA".split("").sort
+
+      asserts "that it can create a child node with different key" do
+        template = rabl %{
+          object @user
+          attribute :name
+          child(@user => :person) { attribute :city }
+        }
+        scope = Object.new
+        scope.instance_variable_set :@user, User.new(:name => 'leo', :city => 'LA')
+        template.render(scope).split("").sort
+      end.equals "\x82\xA4name\xA3leo\xA6person\x81\xA4city\xA2LA".split("").sort
+    end
+
+    context "#glue" do
+
+      asserts "that it glues data from a child node" do
+        template = rabl %{
+          object @user
+          attribute :name
+          glue(@user) { attribute :city }
+          glue(@user) { attribute :age  }
+        }
+        scope = Object.new
+        scope.instance_variable_set :@user, User.new(:name => 'leo', :city => 'LA', :age => 12)
+        template.render(scope).split("").sort
+      end.equals "\x83\xA4name\xA3leo\xA4city\xA2LA\xA3age\f".split("").sort
+    end
+
+    teardown do
+      Rabl.reset_configuration!
+    end
+  end
+end

data/test/silence.rb

@@ -0,0 +1,21 @@
+module Kernel
+  def silence_warnings
+    with_warnings(nil) { yield }
+  end
+
+  def silence_stream(stream)
+    old_stream = stream.dup
+    stream.reopen(RbConfig::CONFIG['host_os'] =~ /mswin|mingw/ ? 'NUL:' : '/dev/null')
+    stream.sync = true
+    yield
+  ensure
+    stream.reopen(old_stream)
+  end
+
+  def with_warnings(flag)
+    old_verbose, $VERBOSE = $VERBOSE, flag
+    yield
+  ensure
+    $VERBOSE = old_verbose
+  end
+end unless Kernel.respond_to? :silence_warnings

data/test/teststrap.rb

@@ -1,14 +1,30 @@
-require 'riot'
-require 'riot/rr'
-require 'mongo'
-require 'mongoid'
-require 'tilt'
-require File.expand_path('../../lib/rabl',__FILE__)
+module Kernel
+  def silence_warnings
+    with_warnings(nil) { yield }
+  end
+
+  def with_warnings(flag)
+    old_verbose, $VERBOSE = $VERBOSE, flag
+    yield
+  ensure
+    $VERBOSE = old_verbose
+  end
+end unless Kernel.respond_to? :silence_warnings
+
+silence_warnings do
+  require 'riot'
+  require 'riot/rr'
+  require 'tilt'
+  require File.expand_path('../../lib/rabl',__FILE__)
+end
 
 Riot.pretty_dots
 
 class Riot::Situation
+  # Custom situation code here
 end
 
 class Riot::Context
+  # Custom context code here
 end
+

metadata

@@ -2,7 +2,7 @@
 name: rabl
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.3.0
+  version: 0.5.0
 platform: ruby
 authors: 
 - Nathan Esquenazi
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-01 00:00:00 Z
+date: 2011-10-19 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: multi_json
@@ -24,40 +24,40 @@ dependencies:
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: riot
+  name: activesupport
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.12.3
-  type: :development
+        version: 2.3.14
+  type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: rr
+  name: riot
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        version: 1.0.2
+        version: 0.12.3
   type: :development
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
-  name: mongoid
+  name: rr
   prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
-        version: "0"
+        version: 1.0.2
   type: :development
   version_requirements: *id004
 - !ruby/object:Gem::Dependency 
-  name: tilt
+  name: rake
   prerelease: false
   requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
@@ -68,7 +68,7 @@ dependencies:
   type: :development
   version_requirements: *id005
 - !ruby/object:Gem::Dependency 
-  name: bson_ext
+  name: tilt
   prerelease: false
   requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
@@ -89,6 +89,17 @@ dependencies:
         version: "0"
   type: :development
   version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  name: msgpack
+  prerelease: false
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.4.5
+  type: :development
+  version_requirements: *id008
 description: General ruby templating for json or xml
 email: 
 - nesquena@gmail.com
@@ -100,6 +111,8 @@ extra_rdoc_files: []
 
 files: 
 - .gitignore
+- .travis.yml
+- CHANGELOG.md
 - Gemfile
 - MIT-LICENSE
 - README.md
@@ -108,6 +121,125 @@ files:
 - examples/base.json.rabl
 - examples/demo.json.rabl
 - examples/inherited.json.rabl
+- fixtures/ashared/NOTES
+- fixtures/ashared/README
+- fixtures/ashared/migrate/20111002092016_create_users.rb
+- fixtures/ashared/migrate/20111002092019_create_posts.rb
+- fixtures/ashared/migrate/20111002092024_create_phone_numbers.rb
+- fixtures/ashared/models/phone_number.rb
+- fixtures/ashared/models/post.rb
+- fixtures/ashared/models/user.rb
+- fixtures/ashared/views/layouts/application.html.erb
+- fixtures/ashared/views/posts/date.json.rabl
+- fixtures/ashared/views/posts/index.json.rabl
+- fixtures/ashared/views/posts/show.json.rabl
+- fixtures/ashared/views/users/index.rabl
+- fixtures/ashared/views/users/phone_number.rabl
+- fixtures/ashared/views/users/show.rabl
+- fixtures/padrino_test/.components
+- fixtures/padrino_test/.gitignore
+- fixtures/padrino_test/Gemfile
+- fixtures/padrino_test/Rakefile
+- fixtures/padrino_test/app/app.rb
+- fixtures/padrino_test/app/controllers/posts.rb
+- fixtures/padrino_test/app/controllers/users.rb
+- fixtures/padrino_test/app/helpers/posts_helper.rb
+- fixtures/padrino_test/app/helpers/users_helper.rb
+- fixtures/padrino_test/config.ru
+- fixtures/padrino_test/config/apps.rb
+- fixtures/padrino_test/config/boot.rb
+- fixtures/padrino_test/config/database.rb
+- fixtures/padrino_test/db/schema.rb
+- fixtures/padrino_test/public/favicon.ico
+- fixtures/padrino_test/test/app/controllers/posts_controller_test.rb
+- fixtures/padrino_test/test/app/controllers/users_controller_test.rb
+- fixtures/padrino_test/test/test.rake
+- fixtures/padrino_test/test/test_config.rb
+- fixtures/rails2/.gitignore
+- fixtures/rails2/Gemfile
+- fixtures/rails2/Rakefile
+- fixtures/rails2/app/controllers/application_controller.rb
+- fixtures/rails2/app/controllers/posts_controller.rb
+- fixtures/rails2/app/controllers/users_controller.rb
+- fixtures/rails2/config/boot.rb
+- fixtures/rails2/config/database.yml
+- fixtures/rails2/config/environment.rb
+- fixtures/rails2/config/environments/development.rb
+- fixtures/rails2/config/environments/production.rb
+- fixtures/rails2/config/environments/test.rb
+- fixtures/rails2/config/initializers/backtrace_silencers.rb
+- fixtures/rails2/config/initializers/cookie_verification_secret.rb
+- fixtures/rails2/config/initializers/inflections.rb
+- fixtures/rails2/config/initializers/mime_types.rb
+- fixtures/rails2/config/initializers/new_rails_defaults.rb
+- fixtures/rails2/config/initializers/session_store.rb
+- fixtures/rails2/config/locales/en.yml
+- fixtures/rails2/config/preinitializer.rb
+- fixtures/rails2/config/routes.rb
+- fixtures/rails2/db/schema.rb
+- fixtures/rails2/db/seeds.rb
+- fixtures/rails2/public/404.html
+- fixtures/rails2/public/422.html
+- fixtures/rails2/public/500.html
+- fixtures/rails2/public/favicon.ico
+- fixtures/rails2/public/images/rails.png
+- fixtures/rails2/public/index.html
+- fixtures/rails2/public/robots.txt
+- fixtures/rails2/script/about
+- fixtures/rails2/script/console
+- fixtures/rails2/script/dbconsole
+- fixtures/rails2/script/destroy
+- fixtures/rails2/script/generate
+- fixtures/rails2/script/performance/benchmarker
+- fixtures/rails2/script/performance/profiler
+- fixtures/rails2/script/plugin
+- fixtures/rails2/script/runner
+- fixtures/rails2/script/server
+- fixtures/rails2/test/functionals/posts_controller_test.rb
+- fixtures/rails2/test/functionals/users_controller_test.rb
+- fixtures/rails2/test/test_helper.rb
+- fixtures/rails3/.gitignore
+- fixtures/rails3/Gemfile
+- fixtures/rails3/Rakefile
+- fixtures/rails3/app/controllers/application_controller.rb
+- fixtures/rails3/app/controllers/posts_controller.rb
+- fixtures/rails3/app/controllers/users_controller.rb
+- fixtures/rails3/config.ru
+- fixtures/rails3/config/application.rb
+- fixtures/rails3/config/boot.rb
+- fixtures/rails3/config/database.yml
+- fixtures/rails3/config/environment.rb
+- fixtures/rails3/config/environments/development.rb
+- fixtures/rails3/config/environments/production.rb
+- fixtures/rails3/config/environments/test.rb
+- fixtures/rails3/config/initializers/backtrace_silencers.rb
+- fixtures/rails3/config/initializers/inflections.rb
+- fixtures/rails3/config/initializers/mime_types.rb
+- fixtures/rails3/config/initializers/secret_token.rb
+- fixtures/rails3/config/initializers/session_store.rb
+- fixtures/rails3/config/locales/en.yml
+- fixtures/rails3/config/routes.rb
+- fixtures/rails3/db/seeds.rb
+- fixtures/rails3/lib/tasks/.gitkeep
+- fixtures/rails3/public/404.html
+- fixtures/rails3/public/422.html
+- fixtures/rails3/public/500.html
+- fixtures/rails3/public/favicon.ico
+- fixtures/rails3/public/images/rails.png
+- fixtures/rails3/public/index.html
+- fixtures/rails3/public/robots.txt
+- fixtures/rails3/public/stylesheets/.gitkeep
+- fixtures/rails3/script/rails
+- fixtures/rails3/test/functional/posts_controller_test.rb
+- fixtures/rails3/test/functional/users_controller_test.rb
+- fixtures/rails3/test/test_helper.rb
+- fixtures/sinatra_test/Gemfile
+- fixtures/sinatra_test/Rakefile
+- fixtures/sinatra_test/app.rb
+- fixtures/sinatra_test/config.ru
+- fixtures/sinatra_test/test/functional/posts_controller_test.rb
+- fixtures/sinatra_test/test/functional/users_controller_test.rb
+- fixtures/sinatra_test/test/test_helper.rb
 - lib/rabl.rb
 - lib/rabl/builder.rb
 - lib/rabl/configuration.rb
@@ -121,7 +253,14 @@ files:
 - test/builder_test.rb
 - test/configuration_test.rb
 - test/engine_test.rb
+- test/helpers_test.rb
+- test/integration/posts_controller_test.rb
+- test/integration/test_init.rb
+- test/integration/users_controller_test.rb
+- test/models/ormless.rb
 - test/models/user.rb
+- test/msgpack_engine_test.rb
+- test/silence.rb
 - test/template_test.rb
 - test/teststrap.rb
 homepage: https://github.com/nesquena/rabl
@@ -147,7 +286,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: rabl
-rubygems_version: 1.7.2
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: General ruby templating for json or xml
@@ -155,6 +294,13 @@ test_files:
 - test/builder_test.rb
 - test/configuration_test.rb
 - test/engine_test.rb
+- test/helpers_test.rb
+- test/integration/posts_controller_test.rb
+- test/integration/test_init.rb
+- test/integration/users_controller_test.rb
+- test/models/ormless.rb
 - test/models/user.rb
+- test/msgpack_engine_test.rb
+- test/silence.rb
 - test/template_test.rb
 - test/teststrap.rb