rabl 0.5.5.b → 0.5.5.c

data/CHANGELOG.md

@@ -1,9 +1,10 @@
 # CHANGELOG
 
-## 0.5.5.a-b
+## 0.5.5.a-c
 
  * Change engine to only instantiate one builder when rendering a collection
  * Alias to\_msgpack to to\_mpac
+ * Cache template sources for faster partial lookups
 
 ## 0.5.4
 

data/lib/rabl.rb

@@ -6,6 +6,7 @@ require 'active_support/core_ext/hash/slice'
 
 require 'rabl/version'
 require 'rabl/helpers'
+require 'rabl/partials'
 require 'rabl/engine'
 require 'rabl/builder'
 require 'rabl/configuration'
@@ -14,6 +15,7 @@ require 'rabl/railtie' if defined?(Rails) && Rails.version =~ /^3/
 # Rabl.register!
 module Rabl
   class << self
+
     def register!
       require 'rabl/template'
     end
@@ -38,6 +40,25 @@ module Rabl
     def reset_configuration!
       @_configuration = nil
     end
+
+    # Fetches from the source_cache, stores block result in cache if nil
+    # Used to cache the contents and paths to various rabl templates
+    # source_cache("users/index", "path/to/view") { "/full/path/to/template/users/index" }
+    def source_cache(file, view_path, &block)
+      @_source_cache ||= {}
+      cache_key = [file, view_path].compact.join(":")
+      if cached_result = @_source_cache[cache_key]
+        cached_result
+      else # store result of block
+        @_source_cache[cache_key] = yield
+      end
+    end
+
+    # Resets the RABL source cache
+    def reset_source_cache!
+      @_source_cache = {}
+    end
+
   end
 end
 

data/lib/rabl/builder.rb

@@ -1,6 +1,6 @@
 module Rabl
   class Builder
-    include Rabl::Helpers
+    include Rabl::Partials
 
     # Constructs a new rabl hash based on given object and options
     # options = { :format => "json", :attributes, :root => true,
@@ -15,7 +15,6 @@ module Rabl
     def build(data, options={})
       @_data      = data
       @_object    = data_object(data)
-      @_result = {}
       compile_hash(options)
     end
 
@@ -24,6 +23,7 @@ module Rabl
     # Returns a hash representation of the data object
     # compile_hash(:root => true)
     def compile_hash(options={})
+      @_result = {}
       # Extends
       @options[:extends].each do |settings|
         extends(settings[:file], settings[:options], &settings[:block])
@@ -107,5 +107,17 @@ module Rabl
       result = self.partial(file, options, &block)
       @_result.merge!(result) if result
     end
+
+    protected
+
+    # resolve_condition(:if => true) => true
+    # resolve_condition(:if => lambda { |m| false }) => false
+    # resolve_condition(:unless => lambda { |m| true }) => true
+    def resolve_condition(options)
+      return true if options[:if].nil? && options[:unless].nil?
+      result = options[:if] == true || (options[:if].respond_to?(:call) && options[:if].call(@_object)) if options.has_key?(:if)
+      result = options[:unless] == false || (options[:unless].respond_to?(:call) && !options[:unless].call(@_object)) if options.has_key?(:unless)
+      result
+    end
   end
 end

data/lib/rabl/engine.rb

@@ -1,6 +1,6 @@
 module Rabl
   class Engine
-    include Rabl::Helpers
+    include Rabl::Partials
 
     # Constructs a new ejs engine based on given vars, handler and declarations
     # Rabl::Engine.new("...source...", { :format => "xml", :root => true, :view_path => "/path/to/views" })
@@ -193,6 +193,7 @@ module Rabl
     end
 
     private
+
     def clear_compile_state
       @_options.delete(:extends)
       @_options.delete(:attributes)

data/lib/rabl/helpers.rb

@@ -1,5 +1,6 @@
 module Rabl
   module Helpers
+
     # data_object(data) => <AR Object>
     # data_object(@user => :person) => @user
     # data_object(:user => :person) => @_object.send(:user)
@@ -26,38 +27,6 @@ module Rabl
       end
     end
 
-    # 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)
-      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_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
-
-    # resolve_condition(:if => true) => true
-    # resolve_condition(:if => lambda { |m| false }) => false
-    # resolve_condition(:unless => lambda { |m| true }) => true
-    def resolve_condition(options)
-      return true if options[:if].nil? && options[:unless].nil?
-      result = options[:if] == true || (options[:if].respond_to?(:call) && options[:if].call(@_object)) if options.has_key?(:if)
-      result = options[:unless] == false || (options[:unless].respond_to?(:call) && !options[:unless].call(@_object)) if options.has_key?(:unless)
-      result
-    end
-
     # Returns true if obj is not enumerable
     # is_object?(@user) => true
     # is_object?([]) => false
@@ -71,29 +40,5 @@ module Rabl
       obj && data_object(obj).respond_to?(:each)
     end
 
-    # Returns source for a given relative file
-    # fetch_source("show", :view_path => "...") => "...contents..."
-    def fetch_source(file, options={})
-      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

data/lib/rabl/partials.rb

@@ -0,0 +1,51 @@
+module Rabl
+  module Partials
+    include Rabl::Helpers
+
+    # 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)
+      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_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
+
+    # Returns source for a given relative file
+    # fetch_source("show", :view_path => "...") => "...contents..."
+    def fetch_source(file, options={})
+      Rabl.source_cache(file, options[:view_path]) do
+        if 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? 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? Sinatra
+          view_path = options[:view_path] || @_scope.settings.views
+          file_path = Dir[File.join(view_path, file + ".{*.,}rabl")].first
+        end
+
+        [File.read(file_path.to_s), file_path.to_s] if file_path
+      end
+    end
+
+  end # Partials
+end # Rabl

data/lib/rabl/version.rb

@@ -1,3 +1,3 @@
 module Rabl
-  VERSION = "0.5.5.b"
+  VERSION = "0.5.5.c"
 end

data/test/helpers_test.rb

@@ -2,67 +2,10 @@ require 'tmpdir'
 require 'pathname'
 require File.expand_path('../../lib/rabl', __FILE__)
 
-class TestHelper
+class TestPartial
   include Rabl::Helpers
 end
 
 context "Rabl::Helpers" do
-  context "fetch_source" do
-    helper(:tmp_path) { @tmp_path ||= Pathname.new(Dir.mktmpdir) }
-    
-    setup do
-      ::Rails = stub(Class.new)
-      ::Rails.root.returns(tmp_path)
-      File.open(tmp_path + "test.json.rabl", "w") do |f|
-        f.puts "content"
-      end
-      File.open(tmp_path + "test_v1.json.rabl", "w") do |f|
-        f.puts "content_v1"
-      end
-      FileUtils.touch tmp_path + "test_v2.json.rabl"
-      [TestHelper.new.fetch_source('test', :view_path => tmp_path.to_s),
-       TestHelper.new.fetch_source('test_v1', :view_path => tmp_path.to_s)]
-    end
-    
-    asserts(:first).equals {["content\n", (tmp_path + "test.json.rabl").to_s ]}
-    asserts(:last).equals {["content_v1\n", (tmp_path + "test_v1.json.rabl").to_s ]}
-    teardown { Object.send(:remove_const, :Rails) }
-  end
-
-  context "fetch_source" do
-    helper(:tmp_path) { @tmp_path ||= Pathname.new(Dir.mktmpdir) }
-
-    setup do
-      ::Rails = stub(Class.new)
-      ::Rails.root.returns(tmp_path)
-      File.open(tmp_path + "test.rabl", "w") do |f|
-        f.puts "content"
-      end
-      TestHelper.new.fetch_source('test', :view_path => tmp_path.to_s)
-    end
-    asserts('detects file.rabl') { topic }.equals do
-      ["content\n", (tmp_path + 'test.rabl').to_s]
-    end
-    teardown { Object.send(:remove_const, :Rails) }
-  end
-
-  context "fetch_source" do
-    helper(:tmp_path) { @tmp_path ||= Pathname.new(Dir.mktmpdir) }
-
-    setup do
-      ::Rails = stub(Class.new)
-      ::Rails.root.returns(tmp_path)
-      File.open(tmp_path + "test.rabl", "w") do |f|
-        f.puts "content"
-      end
-      File.open(tmp_path + "test.json.rabl", "w") do |f|
-        f.puts "content2"
-      end
-      TestHelper.new.fetch_source('test', :view_path => tmp_path.to_s)
-    end
-    asserts('detects file.json.rabl first') { topic }.equals do
-      ["content2\n", (tmp_path + 'test.json.rabl').to_s]
-    end
-    teardown { Object.send(:remove_const, :Rails) }
-  end
-end
+  # TODO needs tests
+end

data/test/partials_test.rb

@@ -0,0 +1,68 @@
+require 'tmpdir'
+require 'pathname'
+require File.expand_path('../../lib/rabl', __FILE__)
+
+class TestPartial
+  include Rabl::Partials
+end
+
+context "Rabl::Partials" do
+  context "fetch_source" do
+    helper(:tmp_path) { @tmp_path ||= Pathname.new(Dir.mktmpdir) }
+
+    setup do
+      ::Rails = stub(Class.new)
+      ::Rails.root.returns(tmp_path)
+      File.open(tmp_path + "test.json.rabl", "w") do |f|
+        f.puts "content"
+      end
+      File.open(tmp_path + "test_v1.json.rabl", "w") do |f|
+        f.puts "content_v1"
+      end
+      FileUtils.touch tmp_path + "test_v2.json.rabl"
+      [TestPartial.new.fetch_source('test', :view_path => tmp_path.to_s),
+       TestPartial.new.fetch_source('test_v1', :view_path => tmp_path.to_s)]
+    end
+
+    asserts(:first).equals {["content\n", (tmp_path + "test.json.rabl").to_s ]}
+    asserts(:last).equals {["content_v1\n", (tmp_path + "test_v1.json.rabl").to_s ]}
+    teardown { Object.send(:remove_const, :Rails) }
+  end
+
+  context "fetch_source" do
+    helper(:tmp_path) { @tmp_path ||= Pathname.new(Dir.mktmpdir) }
+
+    setup do
+      ::Rails = stub(Class.new)
+      ::Rails.root.returns(tmp_path)
+      File.open(tmp_path + "test.rabl", "w") do |f|
+        f.puts "content"
+      end
+      TestPartial.new.fetch_source('test', :view_path => tmp_path.to_s)
+    end
+    asserts('detects file.rabl') { topic }.equals do
+      ["content\n", (tmp_path + 'test.rabl').to_s]
+    end
+    teardown { Object.send(:remove_const, :Rails) }
+  end
+
+  context "fetch_source" do
+    helper(:tmp_path) { @tmp_path ||= Pathname.new(Dir.mktmpdir) }
+
+    setup do
+      ::Rails = stub(Class.new)
+      ::Rails.root.returns(tmp_path)
+      File.open(tmp_path + "test.rabl", "w") do |f|
+        f.puts "content"
+      end
+      File.open(tmp_path + "test.json.rabl", "w") do |f|
+        f.puts "content2"
+      end
+      TestPartial.new.fetch_source('test', :view_path => tmp_path.to_s)
+    end
+    asserts('detects file.json.rabl first') { topic }.equals do
+      ["content2\n", (tmp_path + 'test.json.rabl').to_s]
+    end
+    teardown { Object.send(:remove_const, :Rails) }
+  end
+end

metadata

@@ -2,7 +2,7 @@
 name: rabl
 version: !ruby/object:Gem::Version 
   prerelease: 6
-  version: 0.5.5.b
+  version: 0.5.5.c
 platform: ruby
 authors: 
 - Nathan Esquenazi
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-02-10 00:00:00 Z
+date: 2012-02-11 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: multi_json
@@ -245,6 +245,7 @@ files:
 - lib/rabl/configuration.rb
 - lib/rabl/engine.rb
 - lib/rabl/helpers.rb
+- lib/rabl/partials.rb
 - lib/rabl/railtie.rb
 - lib/rabl/template.rb
 - lib/rabl/version.rb
@@ -260,6 +261,7 @@ files:
 - test/models/ormless.rb
 - test/models/user.rb
 - test/msgpack_engine_test.rb
+- test/partials_test.rb
 - test/silence.rb
 - test/template_test.rb
 - test/teststrap.rb
@@ -286,7 +288,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: rabl
-rubygems_version: 1.8.12
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: General ruby templating for json or xml
@@ -301,6 +303,7 @@ test_files:
 - test/models/ormless.rb
 - test/models/user.rb
 - test/msgpack_engine_test.rb
+- test/partials_test.rb
 - test/silence.rb
 - test/template_test.rb
 - test/teststrap.rb