rabl 0.3.0 → 0.5.0

data/fixtures/sinatra_test/test/test_helper.rb

@@ -0,0 +1,19 @@
+# Load Silence Functionality
+require File.expand_path(File.dirname(__FILE__) + "/../../../test/silence.rb")
+
+silence_warnings do
+  PADRINO_ENV = 'test' unless defined?(PADRINO_ENV)
+  require 'bundler'
+  Bundler.require
+  require File.expand_path(File.dirname(__FILE__) + "/../app.rb")
+  silence_stream(STDOUT) { ActiveRecord::Migrator.up('db/migrate') } # Load up test migrations
+end
+
+# Load Riot Test Environment
+require File.expand_path(File.dirname(__FILE__) + "/../../../test/integration/test_init.rb")
+
+class Riot::Situation
+  def app
+    @app || SinatraTest
+  end
+end

data/lib/rabl.rb

@@ -1,3 +1,9 @@
+require 'active_support'
+require 'active_support/core_ext/string/inflections'
+require 'active_support/core_ext/object/blank'
+require 'active_support/core_ext/hash/reverse_merge'
+require 'active_support/core_ext/hash/slice'
+
 require 'rabl/version'
 require 'rabl/helpers'
 require 'rabl/engine'
@@ -18,7 +24,8 @@ module Rabl
     #  config.enable_json_callbacks = true
     # end
     def configure(&block)
-      yield(self.configuration)
+      yield(configuration)
+      configuration
     end
 
     # Returns the configuration options set for RABL
@@ -26,6 +33,11 @@ module Rabl
     def configuration
       @_configuration ||= Configuration.new
     end
+
+    # Resets the RABL configuration back to the defaults.
+    def reset_configuration!
+      @_configuration = nil
+    end
   end
 end
 

data/lib/rabl/builder.rb

@@ -25,8 +25,8 @@ module Rabl
         attribute(attribute, :as => name)
       end if @options.has_key?(:attributes)
       # Code
-      @options[:code].each_pair do |name, settings|
-        code(name, settings[:options], &settings[:block])
+      @options[:code].each do |settings|
+        code(settings[:name], settings[:options], &settings[:block])
       end if @options.has_key?(:code)
       # Children
       @options[:child].each do |settings|
@@ -61,7 +61,13 @@ module Rabl
     # code(:foo) { "bar" }
     # code(:foo, :if => lambda { |m| m.foo.present? }) { "bar" }
     def code(name, options={}, &block)
-      @_result[name] = block.call(@_object) if resolve_condition(options)
+      return unless resolve_condition(options)
+      result = block.call(@_object)
+      if name.present?
+        @_result[name] = result
+      else
+        @_result.merge!(result) if result
+      end
     end
     alias_method :node, :code
 
@@ -72,9 +78,10 @@ module Rabl
     def child(data, options={}, &block)
       return false unless data.present?
       name, object = data_name(data), data_object(data)
-      include_root = object.respond_to?(:each) && @options[:child_root] # child @users
+      include_root = is_collection?(object) && @options[:child_root] # child @users
+      engine_options = @options.slice(:child_root).merge(:root => include_root)
       object = { object => name } if data.respond_to?(:each_pair) && object # child :users => :people
-      @_result[name] = self.object_to_hash(object, :root => include_root, &block) if resolve_condition(options)
+      @_result[name] = self.object_to_hash(object, engine_options, &block) if resolve_condition(options)
     end
 
     # Glues data from a child node to the json_output
@@ -89,9 +96,9 @@ module Rabl
     # Extends an existing rabl template with additional attributes in the block
     # extends("users/show") { attribute :full_name }
     def extends(file, options={}, &block)
-      options = options.merge(:object => @_object)
+      options = @options.slice(:child_root).merge(options).merge(:object => @_object)
       result = self.partial(file, options, &block)
       @_result.merge!(result) if result
     end
   end
-end
+end

data/lib/rabl/configuration.rb

@@ -1,22 +1,52 @@
+# We load the msgpack library if it is available.
+begin
+  require 'msgpack'
+rescue LoadError
+end
+
+# Load MultiJSON
+require 'multi_json'
+
 module Rabl
   # Rabl.host
   class Configuration
     attr_accessor :include_json_root
+    attr_accessor :include_msgpack_root
     attr_accessor :include_xml_root
     attr_accessor :enable_json_callbacks
-    attr_accessor :json_engine
+    attr_writer   :msgpack_engine
     attr_writer   :xml_options
 
     DEFAULT_XML_OPTIONS = { :dasherize  => true, :skip_types => false }
 
     def initialize
       @include_json_root     = true
+      @include_msgpack_root  = true
       @include_xml_root      = false
       @enable_json_callbacks = false
       @json_engine           = nil
+      @msgpack_engine        = nil
       @xml_options           = {}
     end
 
+    # @param [Symbol, String, #encode] engine_name The name of a JSON engine,
+    #   or class that responds to `encode`, to use to encode Rabl templates
+    #   into JSON. For more details, see the MultiJson gem.
+    def json_engine=(engine_name_or_class)
+      MultiJson.engine = @engine_name = engine_name_or_class
+    end
+
+    # @return The JSON engine used to encode Rabl templates into JSON
+    def json_engine
+      get_json_engine
+    end
+
+    ##
+    # @return the MessagePack encoder/engine to use.
+    def msgpack_engine
+      @msgpack_engine || ::MessagePack
+    end
+
     # Allows config options to be read like a hash
     #
     # @param [Symbol] option Key for a given attribute
@@ -28,5 +58,15 @@ module Rabl
     def default_xml_options
       @_default_xml_options ||= @xml_options.reverse_merge(DEFAULT_XML_OPTIONS)
     end
+
+    private
+
+    def get_json_engine
+      if !defined?(@engine_name) && defined?(Rails)
+        ActiveSupport::JSON
+      else
+        MultiJson.engine
+      end
+    end
   end
 end

data/lib/rabl/engine.rb

@@ -1,5 +1,3 @@
-require 'multi_json'
-
 module Rabl
   class Engine
     include Rabl::Helpers
@@ -9,10 +7,6 @@ module Rabl
     def initialize(source, options={})
       @_source = source
       @_options = options
-
-      if Rabl.configuration.json_engine
-        MultiJson.engine = Rabl.configuration.json_engine
-      end
     end
 
     # Renders the representation based on source, object, scope and locals
@@ -23,7 +17,11 @@ module Rabl
       @_options[:scope] = @_scope
       @_options[:format] ||= self.request_format
       @_data = locals[:object] || self.default_object
-      instance_eval(@_source) if @_source.present?
+      if @_options[:source_location]
+        instance_eval(@_source, @_options[:source_location]) if @_source.present?
+      else
+        instance_eval(@_source) if @_source.present?
+      end
       instance_eval(&block) if block_given?
       self.send("to_" + @_options[:format].to_s)
     end
@@ -33,9 +31,9 @@ module Rabl
     def to_hash(options={})
       options = options.reverse_merge(@_options)
       data = data_object(@_data)
-      if is_record?(data) || !data # object @user
+      if is_object?(data) || !data # object @user
         Rabl::Builder.new(@_data, options).to_hash(options)
-      elsif data.respond_to?(:each) # collection @users
+      elsif is_collection?(data) # collection @users
         object_name = data_name(@_data).to_s.singularize # @users => :users
         data.map { |object| Rabl::Builder.new({ object => object_name }, options).to_hash(options) }
       end
@@ -46,8 +44,17 @@ module Rabl
     def to_json(options={})
       include_root = Rabl.configuration.include_json_root
       options = options.reverse_merge(:root => include_root, :child_root => include_root)
-      result = @_collection_name ? { @_collection_name => to_hash(options) } : to_hash(options)
-      format_json MultiJson.encode(result)
+      result = defined?(@_collection_name) ? { @_collection_name => to_hash(options) } : to_hash(options)
+      format_json(result)
+    end
+
+    # Returns a msgpack representation of the data object
+    # to_msgpack(:root => true)
+    def to_msgpack(options={})
+      include_root = Rabl.configuration.include_msgpack_root
+      options = options.reverse_merge(:root => include_root, :child_root => include_root)
+      result = defined?(@_collection_name) ? { @_collection_name => to_hash(options) } : to_hash(options)
+      Rabl.configuration.msgpack_engine.pack result
     end
 
     # Returns an xml representation of the data object
@@ -92,9 +99,9 @@ module Rabl
     # Creates an arbitrary code node that is included in the json output
     # code(:foo) { "bar" }
     # code(:foo, :if => lambda { ... }) { "bar" }
-    def code(name, options={}, &block)
-      @_options[:code] ||= {}
-      @_options[:code][name] = { :options => options, :block => block }
+    def code(name = nil, options={}, &block)
+      @_options[:code] ||= []
+      @_options[:code] << { :name => name, :options => options, :block => block }
     end
     alias_method :node, :code
 
@@ -131,9 +138,10 @@ module Rabl
     # Returns a guess at the default object for this template
     # default_object => @user
     def default_object
-      @_scope.respond_to?(:controller) ?
-        instance_variable_get("@#{@_scope.controller.controller_name}") :
-        nil
+      if @_scope.respond_to?(:controller)
+        full_name = @_scope.controller.controller_name
+        instance_variable_get("@#{ full_name.split("::").last }")
+      end
     end
 
     # Returns a guess at the format in this scope
@@ -152,9 +160,11 @@ module Rabl
       @_scope.respond_to?(:params) ? @_scope.params : {}
     end
 
-    # Returns json embraced with callback if appropriate or plain if not
-    # detect_jsonp({ foo : "bar" }) => "test({ foo : 'bar' })"
+    # Returns data as json embraced with callback when detected
+    # format_json({ :foo => "bar" }) => "test({ foo : 'bar' })"
+    # format_json("{ foo : "bar" }") => "test({ foo : 'bar' })"
     def format_json(json_output)
+      json_output = Rabl.configuration.json_engine.encode(json_output) unless json_output.is_a?(String)
       use_callback = Rabl.configuration.enable_json_callbacks && request_params[:callback].present?
       use_callback ? "#{request_params[:callback]}(#{json_output})" : json_output
     end

data/lib/rabl/helpers.rb

@@ -17,10 +17,10 @@ module Rabl
       return nil unless data # nil or false
       return data.values.first if data.is_a?(Hash) # @user => :user
       data = @_object.send(data) if data.is_a?(Symbol) && @_object # :address
-      if data.respond_to?(:first) && data.first.respond_to?(:valid?)
-        data_name(data.first).pluralize
+      if data.respond_to?(:first)
+        data_name(data.first).pluralize if data.first.present?
       else # actual data object
-        object_name = @_collection_name.to_s.singularize if @_collection_name
+        object_name = @_collection_name.to_s.singularize if defined? @_collection_name
         object_name ||= data.class.respond_to?(:model_name) ? data.class.model_name.element : data.class.to_s.downcase
         object_name
       end
@@ -28,17 +28,23 @@ module Rabl
 
     # Renders a partial hash based on another rabl template
     # partial("users/show", :object => @user)
+    # options must have :object
+    # options can have :view_path, :child_root, :root
     def partial(file, options={}, &block)
-      source = self.fetch_source(file, options)
-      self.object_to_hash(options[:object], :source => source, &block)
+      object, view_path = options.delete(:object), options.delete(:view_path)
+      source, location = self.fetch_source(file, :view_path => view_path)
+      engine_options = options.merge(:source => source, :source_location => location)
+      self.object_to_hash(object, engine_options, &block)
     end
 
     # Returns a hash based representation of any data object given ejs template block
     # object_to_hash(@user) { attribute :full_name } => { ... }
     # object_to_hash(@user, :source => "...") { attribute :full_name } => { ... }
+    # options must have :source (rabl file contents)
+    # options can have :source_location (source filename)
     def object_to_hash(object, options={}, &block)
-      return object unless is_record?(object) || object.respond_to?(:each)
-      engine_options = { :format => "hash", :root => (options[:root] || false) }
+      return object unless is_object?(object) || is_collection?(object)
+      engine_options = options.merge(:format => "hash", :root => (options[:root] || false))
       Rabl::Engine.new(options[:source], engine_options).render(@_scope, :object => object, &block)
     end
 
@@ -52,21 +58,42 @@ module Rabl
       result
     end
 
-    # Returns true if item is a ORM record; false otherwise
-    # is_record?(@user) => true
-    # is_record?([]) => false
-    def is_record?(obj)
-      obj && data_object(obj).respond_to?(:valid?)
+    # Returns true if obj is not enumerable
+    # is_object?(@user) => true
+    # is_object?([]) => false
+    # is_object?({}) => false
+    def is_object?(obj)
+      obj && !data_object(obj).is_a?(Enumerable)
+    end
+
+    # Returns true if the obj is a collection of items
+    def is_collection?(obj)
+      obj && data_object(obj).is_a?(Enumerable)
     end
 
     # Returns source for a given relative file
     # fetch_source("show", :view_path => "...") => "...contents..."
     def fetch_source(file, options={})
-      root_path = Rails.root if defined?(Rails)
-      root_path = Padrino.root if defined?(Padrino)
-      view_path = options[:view_path] || File.join(root_path, "app/views/")
-      file_path = Dir[File.join(view_path, file + "*.rabl")].first
-      File.read(file_path) if file_path
+      if defined? Rails
+        root_path = Rails.root
+        view_path = options[:view_path] || File.join(root_path, "app/views/")
+        file_path = Dir[File.join(view_path, file + ".{*.,}rabl")].first
+      elsif defined? Padrino
+        root_path = Padrino.root
+        # use Padrino's own template resolution mechanism
+        file_path, _ = @_scope.instance_eval { resolve_template(file) }
+        # Padrino chops the extension, stitch it back on
+        file_path = File.join(@_scope.settings.views, (file_path.to_s + ".rabl"))
+      elsif defined? Sinatra
+        view_path = options[:view_path] || @_scope.settings.views
+        file_path = Dir[File.join(view_path, file + ".{*.,}rabl")].first
+      end
+
+      if file_path
+        return File.read(file_path.to_s), file_path.to_s
+      else # no file path specified
+        nil
+      end
     end
   end
-end
+end

data/lib/rabl/template.rb

@@ -7,7 +7,7 @@ if defined?(Tilt)
     end
 
     def prepare
-      options = @options.merge(:format => @options[:format])
+      options = @options.merge(:format => @options[:format], :source_location => file)
       @engine = ::Rabl::Engine.new(data, options)
     end
 

data/lib/rabl/version.rb

@@ -1,3 +1,3 @@
 module Rabl
-  VERSION = "0.3.0"
+  VERSION = "0.5.0"
 end

data/rabl.gemspec

@@ -19,12 +19,13 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_dependency 'multi_json', '~> 1.0.3'
+  s.add_dependency 'multi_json',           '~> 1.0.3'
+  s.add_dependency 'activesupport',        '>= 2.3.14'
 
-  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 'riot',     '~> 0.12.3'
+  s.add_development_dependency 'rr',       '~> 1.0.2'
+  s.add_development_dependency 'rake'
   s.add_development_dependency 'tilt'
-  s.add_development_dependency 'bson_ext'
   s.add_development_dependency 'yajl-ruby'
+  s.add_development_dependency 'msgpack', '~> 0.4.5'
 end

data/test/builder_test.rb

@@ -62,10 +62,10 @@ context "Rabl::Builder" do
         get_result(topic)
       end.equivalent_to({:name => 'rabl', :city => 'irvine'})
 
-      denies "that with a non-existent attribute the node" do
+      asserts "that with a non-existent attribute the node" do
         topic.attribute :fake
         get_result(topic)[:fake]
-      end.exists
+      end.nil
 
     end
 
@@ -131,7 +131,7 @@ context "Rabl::Builder" do
     asserts "that it generates with an collection and child_root" do
       b = builder @user, { :child_root => true }
       mock(b).data_name(@users) { :users }
-      mock(b).object_to_hash(@users,{ :root => true }).returns('xyz').subject
+      mock(b).object_to_hash(@users,{ :root => true, :child_root => true }).returns('xyz').subject
 
       b.child(@users) { attribute :name }
       get_result(b)
@@ -140,7 +140,7 @@ context "Rabl::Builder" do
     asserts "that it generates with an collection and no child root" do
       b = builder @user, { :child_root => false }
       mock(b).data_name(@users) { :users }
-      mock(b).object_to_hash(@users,{ :root => false }).returns('xyz').subject
+      mock(b).object_to_hash(@users,{ :root => false, :child_root => false }).returns('xyz').subject
 
       b.child(@users) { attribute :name }
       get_result(b)

data/test/configuration_test.rb

@@ -1,38 +1,23 @@
 require File.expand_path('../teststrap', __FILE__)
 require File.expand_path('../../lib/rabl', __FILE__)
 
-context "Rabl::Configuration" do
-
-  context "with defaults" do
+context 'Rabl::Configuration' do
+  context 'defaults' do
     setup { Rabl.configuration }
 
     asserts(:include_json_root).equals true
     asserts(:include_xml_root).equals false
     asserts(:enable_json_callbacks).equals false
-    asserts(:json_engine).equals nil
+    asserts(:json_engine).equals MultiJson.engine
   end
 
-  context "with configuration" do
+  context 'custom JSON engine' do
     setup do
-      Rabl.configure do |config|
-        config.include_json_root     = false
-        config.include_xml_root      = true
-        config.enable_json_callbacks = true
-        config.json_engine           = :yajl
+      Rabl.configure do |c|
+        c.json_engine = :yajl
       end
-      Rabl.configuration
     end
 
-    asserts(:include_json_root).equals false
-    asserts(:include_xml_root).equals true
-    asserts(:enable_json_callbacks).equals true
-    asserts(:json_engine).equals :yajl
-
-    teardown do
-      Rabl.configure do |config|
-        config.json_engine = MultiJson.default_engine
-      end
-    end
+    asserts('uses a custom JSON engine') { topic.json_engine == MultiJson::Engines::Yajl }
   end
-
 end