rabl 0.2.7 → 0.2.8

data/README.md

@@ -326,6 +326,7 @@ Thanks to [Miso](http://gomiso.com) for allowing me to create this for our appli
 * [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
+* [Chris Kimpton](https://github.com/kimptoc) - Helping with documentation and wiki
 
 More to come hopefully! Please fork and contribute, any help is appreciated!
 

data/lib/rabl.rb

@@ -3,6 +3,7 @@ require 'rabl/helpers'
 require 'rabl/engine'
 require 'rabl/builder'
 require 'rabl/configuration'
+require 'rabl/railtie' if defined?(Rails) && Rails.version =~ /^3/
 
 # Rabl.register!
 module Rabl
@@ -34,6 +35,4 @@ if defined?(Padrino)
   Padrino.after_load { Rabl.register! }
 elsif defined?(Rails) && Rails.version =~ /^2/
   Rabl.register!
-elsif defined?(Rails) && Rails.version =~ /^3/
-  Rabl.register!
 end

data/lib/rabl/engine.rb

@@ -162,5 +162,10 @@ module Rabl
     def method_missing(name, *args, &block)
       @_scope.respond_to?(name) ? @_scope.send(name, *args, &block) : super
     end
+
+    def copy_instance_variables_from(object, exclude = []) #:nodoc:
+      vars = object.instance_variables.map(&:to_s) - exclude.map(&:to_s)
+      vars.each { |name| instance_variable_set(name, object.instance_variable_get(name)) }
+    end
   end
 end

data/lib/rabl/helpers.rb

@@ -4,7 +4,7 @@ module Rabl
     # data_object(@user => :person) => @user
     # data_object(:user => :person) => @_object.send(:user)
     def data_object(data)
-      data = (data.is_a?(Hash) && data.keys.one?) ? data.keys.first : data
+      data = (data.is_a?(Hash) && data.keys.size == 1) ? data.keys.first : data
       data.is_a?(Symbol) && @_object ? @_object.send(data) : data
     end
 

data/lib/rabl/railtie.rb

@@ -0,0 +1,10 @@
+module Rabl
+  class Railtie < Rails::Railtie
+
+    initializer "rabl.initialize" do |app|
+      ActiveSupport.on_load(:action_view) do
+        Rabl.register!
+      end
+    end
+  end
+end

data/lib/rabl/template.rb

@@ -42,23 +42,26 @@ end
 
 # Rails 3.X Template
 if defined?(Rails) && Rails.version =~ /^3/
-  require 'action_view/base'
-  require 'action_view/template'
-
   module ActionView
     module Template::Handlers
-      class RablHandler < Template::Handler
-        include Compilable
+      class Rabl
 
+        class_attribute :default_format
         self.default_format = Mime::JSON
 
-        def compile(template) %{
-          ::Rabl::Engine.new(#{template.source.inspect}).
-            render(self, assigns.merge(local_assigns))
-        } end
-      end
-    end
+        def self.call(template)
+          source = if template.source.empty?
+            File.read(template.identifier)
+          else # use source
+            template.source
+          end
+
+          %{ ::Rabl::Engine.new(#{source.inspect}).
+              render(self, assigns.merge(local_assigns)) }
+        end # call
+      end # rabl class
+    end # handlers
   end
 
-  ActionView::Template.register_template_handler :rabl, ActionView::TemplateHandlers::RablHandler
+  ActionView::Template.register_template_handler :rabl, ActionView::TemplateHandlers::Rabl
 end

data/lib/rabl/version.rb

@@ -1,3 +1,3 @@
 module Rabl
-  VERSION = "0.2.7"
+  VERSION = "0.2.8"
 end

data/rabl.gemspec

@@ -22,5 +22,6 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'riot', '~>0.12.3'
   s.add_development_dependency 'rr', '~>1.0.2'
   s.add_development_dependency 'mongoid'
+  s.add_development_dependency 'tilt'
   s.add_development_dependency 'bson_ext'
 end

data/test/configuration_test.rb

@@ -0,0 +1,29 @@
+require File.expand_path('../teststrap', __FILE__)
+require File.expand_path('../../lib/rabl', __FILE__)
+
+context "Rabl::Configuration" do
+
+  context "with defaults" do
+    setup { Rabl.configuration }
+
+    asserts(:include_json_root).equals true
+    asserts(:include_xml_root).equals false
+    asserts(:enable_json_callbacks).equals false
+  end
+
+  context "with configuration" do
+    setup do
+      Rabl.configure do |config|
+        config.include_json_root     = false
+        config.include_xml_root      = true
+        config.enable_json_callbacks = true
+      end
+      Rabl.configuration
+    end
+
+    asserts(:include_json_root).equals false
+    asserts(:include_xml_root).equals true
+    asserts(:enable_json_callbacks).equals true
+  end
+
+end

data/test/engine_test.rb

@@ -1,2 +1,312 @@
-require File.expand_path('../teststrap',__FILE__)
+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 { t } }
+
+  context "#initialize" do
+    setup do
+      Rabl::Engine.new("...source...", { :format => 'xml', :root => true, :view_path => '/path/to/views' })
+    end
+
+    asserts_topic.assigns :_source
+    asserts_topic.assigns :_options
+  end
+
+
+  context "with defaults" do
+    setup do
+      Rabl.configure do |config|
+        config.include_json_root     = true
+        config.include_xml_root      = false
+        config.enable_json_callbacks = 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 "{\"user\":{}}"
+
+      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 "{\"person\":{}}"
+    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)
+      end.equals "[{\"user\":{}},{\"user\":{}}]"
+
+      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)
+      end.equals "{\"person\":[{\"person\":{}},{\"person\":{}}]}"
+
+    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)
+      end.equals "{\"user\":{\"name\":\"irvine\"}}"
+
+      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)
+      end.equals "{\"user\":{\"city\":\"irvine\"}}"
+
+      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)
+      end.equals "{\"user\":{\"city\":\"irvine\"}}"
+
+    end
+
+    context "#code" do
+
+      asserts "that it can create an arbitraty code node" do
+        template = rabl %{
+          code(:foo) { 'bar' }
+        }
+        template.render(Object.new)
+      end.equals "{\"foo\":\"bar\"}"
+
+      asserts "that it can be passed conditionals" do
+        template = rabl %{
+          code(:foo, :if => lambda { |i| false }) { 'bar' }
+        }
+        template.render(Object.new)
+      end.equals "{}"
+
+    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)
+      end.equals "{\"user\":{\"name\":\"leo\",\"user\":{\"city\":\"LA\"}}}"
+
+      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)
+
+      end.equals "{\"user\":{\"name\":\"leo\",\"person\":{\"city\":\"LA\"}}}"
+    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)
+      end.equals "{\"user\":{\"name\":\"leo\",\"city\":\"LA\",\"age\":12}}"
+    end
+  end
+
+
+  context "without json root" do
+    setup do
+      Rabl.configure do |config|
+        config.include_json_root     = false
+        config.include_xml_root      = false
+        config.enable_json_callbacks = 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 "{}"
+
+      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 "{}"
+    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)
+      end.equals "[{},{}]"
+
+      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)
+      end.equals "{\"person\":[{},{}]}"
+
+    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)
+      end.equals "{\"name\":\"irvine\"}"
+
+      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)
+      end.equals "{\"city\":\"irvine\"}"
+
+      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)
+      end.equals "{\"city\":\"irvine\"}"
+
+    end
+
+    context "#code" do
+
+      asserts "that it can create an arbitraty code node" do
+        template = rabl %{
+          code(:foo) { 'bar' }
+        }
+        template.render(Object.new)
+      end.equals "{\"foo\":\"bar\"}"
+
+      asserts "that it can be passed conditionals" do
+        template = rabl %{
+          code(:foo, :if => lambda { |i| false }) { 'bar' }
+        }
+        template.render(Object.new)
+      end.equals "{}"
+
+    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)
+      end.equals "{\"name\":\"leo\",\"user\":{\"city\":\"LA\"}}"
+
+      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)
+
+      end.equals "{\"name\":\"leo\",\"person\":{\"city\":\"LA\"}}"
+    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)
+      end.equals "{\"name\":\"leo\",\"city\":\"LA\",\"age\":12}"
+    end
+  end
+end

data/test/template_test.rb

@@ -1,2 +1,68 @@
 require File.expand_path('../teststrap',__FILE__)
+require File.expand_path('../../lib/rabl/template', __FILE__)
 
+class Scope
+end
+
+context "RablTemplate" do
+
+  asserts "that it registers for .rabl files" do
+    Tilt['test.rabl']
+  end.equals RablTemplate
+
+  context "#render" do
+    setup do
+      RablTemplate.new { |t| "code(:lol) { 'wut' }" }
+    end
+
+    asserts "preparing and evaluating templates on #render" do
+      topic.render
+    end.matches %r{"lol":"wut"}
+
+    3.times do |n|
+      asserts "can be rendered #{n} time(s)" do
+        topic.render
+      end.matches %r{"lol":"wut"}
+    end
+
+    # asserts "that it can be passed locals" do
+    #   template = RablTemplate.new { "code(:name) { @name }" }
+    #   template.render(Object.new, :object => 'Bob')
+    # end.matches %r{"name":"Bob"}
+
+    asserts "that it evaluates in object scope" do
+      template = RablTemplate.new { "code(:lol) { @name }" }
+      scope = Object.new
+      scope.instance_variable_set :@name, 'Joe'
+      template.render(scope)
+    end.matches %r{"lol":"Joe"}
+
+    asserts "that it can pass a block for yield" do
+      template = RablTemplate.new { "code(:lol) { 'Hey ' + yield + '!' }" }
+      template.render { 'Joe' }
+    end.matches %r{"lol":"Hey Joe!"}
+  end
+
+  context "#render compiled" do
+
+    # asserts "that it can be passed locals" do
+    #   template = RablTemplate.new { "code(:name) { @name }" }
+    #   template.render(Scope.new, :object => 'Bob')
+    # end.matches %r{"name":"Bob"}
+
+    asserts "that it evaluates in an object scope" do
+      template = RablTemplate.new { "code(:lol) { @name }" }
+      scope = Scope.new
+      scope.instance_variable_set :@name, 'Joe'
+      template.render(scope)
+    end.matches %r{"lol":"Joe"}
+
+    asserts "that it can pass a block for yield" do
+      template = RablTemplate.new { "code(:lol) { 'Hey ' + yield + '!' }" }
+      template.render(Scope.new) { 'Joe' }
+    end.matches %r{"lol":"Hey Joe!"}
+
+  end
+
+
+end

data/test/teststrap.rb

@@ -2,6 +2,7 @@ require 'riot'
 require 'riot/rr'
 require 'mongo'
 require 'mongoid'
+require 'tilt'
 require File.expand_path('../../lib/rabl',__FILE__)
 
 Riot.pretty_dots

metadata

@@ -2,7 +2,7 @@
 name: rabl
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.2.7
+  version: 0.2.8
 platform: ruby
 authors: 
 - Nathan Esquenazi
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-19 00:00:00 -07:00
+date: 2011-06-03 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -47,7 +47,7 @@ dependencies:
   type: :development
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
-  name: bson_ext
+  name: tilt
   prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
@@ -57,6 +57,17 @@ dependencies:
         version: "0"
   type: :development
   version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: bson_ext
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id005
 description: General ruby templating for json or xml
 email: 
 - nesquena@gmail.com
@@ -81,11 +92,13 @@ files:
 - lib/rabl/configuration.rb
 - lib/rabl/engine.rb
 - lib/rabl/helpers.rb
+- lib/rabl/railtie.rb
 - lib/rabl/template.rb
 - lib/rabl/version.rb
 - rabl.gemspec
 - test.watchr
 - test/builder_test.rb
+- test/configuration_test.rb
 - test/engine_test.rb
 - test/models/user.rb
 - test/template_test.rb
@@ -120,6 +133,7 @@ specification_version: 3
 summary: General ruby templating for json or xml
 test_files: 
 - test/builder_test.rb
+- test/configuration_test.rb
 - test/engine_test.rb
 - test/models/user.rb
 - test/template_test.rb