rabl 0.5.5.c → 0.5.5.d

data/CHANGELOG.md

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

data/README.md

@@ -97,7 +97,8 @@ RABL is intended to require little to no configuration to get working. This is t
 ```ruby
 # config/initializers/rabl_init.rb
 Rabl.configure do |config|
-  # Commented as these are the defaults
+  # Commented as these are defaults
+  # config.cache_sources = false
   # config.json_engine = nil # Any multi\_json engines
   # config.msgpack_engine = nil # Defaults to ::MessagePack
   # config.include_json_root = true
@@ -108,9 +109,16 @@ Rabl.configure do |config|
 end
 ```
 
-Each option specifies behavior related to RABL's output. If `include_json_root` is disabled that removes the root node for each child in the output, and `enable_json_callbacks` enables support for 'jsonp' style callback output if the incoming request has a 'callback' parameter.
+Each option specifies behavior related to RABL's output. If `include_json_root` is disabled that removes the
+root node for each child in the output, and `enable_json_callbacks` enables support for 'jsonp' style callback
+output if the incoming request has a 'callback' parameter.
 
-Note that the `json_engine` option uses the [multi_json](http://intridea.com/2010/6/14/multi-json-the-swappable-json-handler) intelligent engine defaults so in most cases you **don't need to configure this** directly. If you wish to use yajl as the primary JSON encoding engine simply add that to your Gemfile:
+If `cache_sources` is set to `true`, template lookups will be cached for improved performance.
+The cache can be reset manually by running `Rabl.reset_source_cache!` within your application.
+
+Note that the `json_engine` option uses the [multi_json](http://intridea.com/2010/6/14/multi-json-the-swappable-json-handler) intelligent engine
+defaults so in most cases you **don't need to configure this** directly. If you wish to use yajl as
+the primary JSON encoding engine simply add that to your Gemfile:
 
 ```ruby
 # Gemfile

data/lib/rabl.rb

@@ -45,6 +45,8 @@ module Rabl
     # 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)
+      return yield unless Rabl.configuration.cache_sources
+
       @_source_cache ||= {}
       cache_key = [file, view_path].compact.join(":")
       if cached_result = @_source_cache[cache_key]

data/lib/rabl/configuration.rb

@@ -16,6 +16,7 @@ module Rabl
     attr_accessor :enable_json_callbacks
     attr_writer   :msgpack_engine
     attr_writer   :xml_options
+    attr_accessor :cache_sources
 
     DEFAULT_XML_OPTIONS = { :dasherize  => true, :skip_types => false }
 
@@ -27,6 +28,7 @@ module Rabl
       @json_engine           = nil
       @msgpack_engine        = nil
       @xml_options           = {}
+      @cache_sources         = false
     end
 
     # @param [Symbol, String, #encode] engine_name The name of a JSON engine,

data/lib/rabl/engine.rb

@@ -7,21 +7,20 @@ module Rabl
     def initialize(source, options={})
       @_source = source
       @_options = options
-      @_compiled = false
     end
 
     # Renders the representation based on source, object, scope and locals
     # Rabl::Engine.new("...source...", { :format => "xml" }).render(scope, { :foo => "bar", :object => @user })
     def render(scope, locals, &block)
+      clear_options!
       @_locals, @_scope = locals, scope
       self.copy_instance_variables_from(@_scope, [:@assigns, :@helpers])
-      clear_compile_state
       @_options[:scope] = @_scope
       @_options[:format] ||= self.request_format
       @_data = locals[:object] || self.default_object
       if @_options[:source_location]
         instance_eval(@_source, @_options[:source_location]) if @_source.present?
-      else
+      else # without source location
         instance_eval(@_source) if @_source.present?
       end
       instance_eval(&block) if block_given?
@@ -194,7 +193,7 @@ module Rabl
 
     private
 
-    def clear_compile_state
+    def clear_options!
       @_options.delete(:extends)
       @_options.delete(:attributes)
       @_options.delete(:node)

data/lib/rabl/railtie.rb

@@ -6,5 +6,6 @@ module Rabl
         Rabl.register!
       end
     end
-  end
-end
+
+  end # Railtie
+end # Rabl

data/lib/rabl/version.rb

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

metadata

@@ -2,7 +2,7 @@
 name: rabl
 version: !ruby/object:Gem::Version 
   prerelease: 6
-  version: 0.5.5.c
+  version: 0.5.5.d
 platform: ruby
 authors: 
 - Nathan Esquenazi