rabl 0.6.14 → 0.7.0

data/CHANGELOG.md

@@ -1,6 +1,13 @@
 # CHANGELOG
 
-## 0.6.15 (unreleased)
+## 0.7.1 (Unreleased)
+
+## 0.7.0
+
+  * Use source_format when looking up partials (Thanks @databyte)
+  * Add README note about render_views (Thanks @databyte)
+  * Add support for Rails 3.2+ sending custom mime types (Thanks @databyte)
+  * Add option to define his own cache_engine (Thanks @shingara)
 
 ## 0.6.14
 

data/README.md

@@ -15,6 +15,12 @@ I wanted a simple and flexible system for generating my APIs. In particular, I w
 Anyone who has tried the 'to_json' method used in ActiveRecord for generating a JSON response has felt the pain of this restrictive approach.
 RABL is a general templating system created to solve these problems in an entirely new way.
 
+## Breaking Changes ##
+
+ * v0.6.14 (released June 28, 2012) requires the use of render_views
+   with RSpec to test templates. Otherwise, the controller will simply
+   pass through the render command as it does with ERB templates.
+
 ## Installation ##
 
 Install RABL as a gem:
@@ -101,6 +107,7 @@ Rabl.configure do |config|
   # Commented as these are defaults
   # config.cache_all_output = false
   # config.cache_sources = Rails.env != 'development' # Defaults to false
+  # config.cache_engine = Rabl::CacheEngine.new # Defaults to Rails cache
   # config.escape_all_output = false
   # config.json_engine = nil # Any multi\_json engines
   # config.msgpack_engine = nil # Defaults to ::MessagePack
@@ -125,6 +132,8 @@ output if the incoming request has a 'callback' parameter.
 If `include_child_root` is set to false then child objects in the response will not include
 a root node by default. This allows you to further fine-tune your desired response structure.
 
+If `cache_engine` is set, you should assign it to a class with a `fetch` method. See the [default engine](https://github.com/nesquena/rabl/blob/master/lib/rabl/cache_engine.rb) for an example.
+
 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.
 
@@ -234,6 +243,12 @@ attributes :bar => :baz, :dog => :animal
 # => # { baz : <bar value>, animal : <dog value> }
 ```
 
+This currently does not work:
+
+```ruby
+attributes :foo, :bar => :baz # throws exception
+```
+
 ### Child Nodes ###
 
 Often a response requires including nested information from data associated with the parent model:
@@ -353,6 +368,8 @@ end
 
 Using partials and inheritance can significantly reduce code duplication in your templates.
 
+You can see more examples on the [Reusing Templates wiki page](https://github.com/nesquena/rabl/wiki/Reusing-templates).
+
 ### Template Scope ###
 
 In RABL, you have access to everything you need to build an API response. Each RABL template has full access to the controllers
@@ -515,6 +532,7 @@ Thanks to [Miso](http://gomiso.com) for allowing me to create this for our appli
 * [Alli Witheford](https://github.com/alzeih) - Added Plist format support
 * [Ryan Bigg](https://github.com/radar) - Improved template resolution code
 * [Ivan Vanderbyl](https://github.com/ivanvanderbyl) - Added general purpose renderer
+* [Cyril Mougel](https://github.com/shingara) - Added cache_engine pluggable support
 
 and many more contributors listed in the [CHANGELOG](https://github.com/nesquena/rabl/blob/master/CHANGELOG.md).
 

data/fixtures/ashared/views_rails_3/posts/show.rabl_test_v1.rabl

@@ -0,0 +1,7 @@
+object @post
+
+attribute :title => :title_v1
+
+child :user do
+  extends "users/show"
+end

data/fixtures/ashared/views_rails_3/users/phone_number.xml.rabl

@@ -0,0 +1,6 @@
+attributes :prefix, :suffix, :area_code
+attributes :is_primary => :primary
+
+node :formatted do |n|
+  n.formatted
+end

data/fixtures/ashared/views_rails_3/users/show.rabl_test_v1.rabl

@@ -0,0 +1,3 @@
+object @user => :person
+
+attribute :username => :username_v1

data/fixtures/rails3_2/app/controllers/posts_controller.rb

@@ -1,5 +1,5 @@
 class PostsController < ApplicationController
-  respond_to :json, :xml, :html
+  respond_to :json, :xml, :html, :rabl_test_v1
 
   def index
     @posts = Post.all(:order => "id ASC")

data/fixtures/rails3_2/config/initializers/mime_types.rb

@@ -3,3 +3,5 @@
 # Add new mime types for use in respond_to blocks:
 # Mime::Type.register "text/richtext", :rtf
 # Mime::Type.register_alias "text/html", :iphone
+
+Mime::Type.register 'application/vnd.rabl-test_v1+json', :rabl_test_v1

data/fixtures/rails3_2/test/functional/posts_controller_test.rb

@@ -154,6 +154,15 @@ context "PostsController" do
     asserts(:body).includes { "<html>" }
   end # show action, html
 
+  context "mime_type" do
+    setup do
+      get "/posts/#{@post1.id}", format: :rabl_test_v1
+    end
+
+    asserts("contains post title") { json_output['post']['title_v1'] }.equals { @post1.title }
+    asserts("contains username") { json_output['post']['user']['username_v1'] }.equals { @post1.user.username }
+  end
+
   context "caching" do
     helper(:cache_hit) do |key|
       Rails.cache.read(ActiveSupport::Cache.expand_cache_key(key, :rabl))

data/lib/rabl.rb

@@ -11,6 +11,7 @@ require 'rabl/engine'
 require 'rabl/builder'
 require 'rabl/configuration'
 require 'rabl/renderer'
+require 'rabl/cache_engine'
 require 'rabl/railtie' if defined?(Rails) && Rails.version =~ /^3/
 
 # Rabl.register!

data/lib/rabl/cache_engine.rb

@@ -0,0 +1,25 @@
+# Defines the default cache engine for RABL when caching is invoked for a template.
+# You can define your own caching engines by creating an object that responds to fetch and
+# setting the configuration option:
+#
+#     config.cache_engine = AdvancedCacheEngine.new
+#
+
+module Rabl
+  class CacheEngine
+
+    # Fetch given a key and options and a fallback block attempts to find the key in the cache
+    # and stores the block result in there if no key is found.
+    #
+    # cache = Rabl::CacheEngine.new; cache.fetch("some_key") { "fallback data" }
+    #
+    def fetch(key, cache_options, &block)
+      if defined?(Rails)
+        Rails.cache.fetch(key, cache_options, &block)
+      else
+        yield
+      end
+    end
+
+  end
+end

data/lib/rabl/configuration.rb

@@ -39,6 +39,7 @@ module Rabl
     attr_accessor :cache_all_output
     attr_accessor :escape_all_output
     attr_accessor :view_paths
+    attr_accessor :cache_engine
 
     DEFAULT_XML_OPTIONS = { :dasherize  => true, :skip_types => false }
 
@@ -61,6 +62,7 @@ module Rabl
       @cache_all_output      = false
       @escape_all_output     = false
       @view_paths            = []
+      @cache_engine          = Rabl::CacheEngine.new
     end
 
     # @param [Symbol, String, #encode] engine_name The name of a JSON engine,

data/lib/rabl/helpers.rb

@@ -87,7 +87,7 @@ module Rabl
     # fetch_from_cache('some_key') { ...rabl template result... }
     def fetch_result_from_cache(cache_key, cache_options=nil, &block)
       expanded_cache_key = ActiveSupport::Cache.expand_cache_key(cache_key, :rabl)
-      Rails.cache.fetch(expanded_cache_key, cache_options, &block) if defined?(Rails)
+      Rabl.configuration.cache_engine.fetch(expanded_cache_key, cache_options, &block)
     end
 
     # Returns true if the cache has been enabled for the application

data/lib/rabl/partials.rb

@@ -71,7 +71,10 @@ module Rabl
           if ActionPack::VERSION::MAJOR == 3 && ActionPack::VERSION::MINOR < 2
             context_scope.lookup_context.find(file, [], partial)
           else # Rails 3.2 and higher
-            context_scope.lookup_context.find(file, [], partial, [], {:formats => [:json]})
+            # pull format directly from rails unless it is html
+            rendered_format = context_scope.lookup_context.rendered_format
+            source_format = rendered_format unless rendered_format == :html
+            context_scope.lookup_context.find(file, [], partial, [], {:formats => [source_format]})
           end }
         template = lookup_proc.call(false) rescue lookup_proc.call(true)
         template.identifier if template

data/lib/rabl/version.rb

@@ -1,3 +1,3 @@
 module Rabl
-  VERSION = "0.6.14"
+  VERSION = "0.7.0"
 end

data/test/configuration_test.rb

@@ -13,6 +13,7 @@ context 'Rabl::Configuration' do
     asserts(:enable_json_callbacks).equals false
     asserts(:view_paths).equals []
     asserts(:json_engine).equals { json_engine }
+    asserts(:cache_engine).is_a?(Rabl::CacheEngine)
   end
 
   context 'custom JSON engine' do

data/test/integration/rails3_2/posts_controller_test.rb

@@ -154,6 +154,15 @@ context "PostsController" do
     asserts(:body).includes { "<html>" }
   end # show action, html
 
+  context "mime_type" do
+    setup do
+      get "/posts/#{@post1.id}", format: :rabl_test_v1
+    end
+
+    asserts("contains post title") { json_output['post']['title_v1'] }.equals { @post1.title }
+    asserts("contains username") { json_output['post']['user']['username_v1'] }.equals { @post1.user.username }
+  end
+
   context "caching" do
     helper(:cache_hit) do |key|
       Rails.cache.read(ActiveSupport::Cache.expand_cache_key(key, :rabl))

data/test/partials_test.rb

@@ -84,6 +84,9 @@ context "Rabl::Partials" do
     asserts('detects file.json.rabl first') { topic }.equals do
       ["content2\n", (tmp_path + 'test.json.rabl').to_s]
     end
-    teardown { Object.send(:remove_const, :Sinatra) }
+    teardown do
+      Object.send(:remove_const, :Sinatra)
+      Rabl.configuration.view_paths = []
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rabl
 version: !ruby/object:Gem::Version
-  version: 0.6.14
+  version: 0.7.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-28 00:00:00.000000000 Z
+date: 2012-07-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -213,9 +213,12 @@ files:
 - fixtures/ashared/views_rails_3/posts/index.rabl
 - fixtures/ashared/views_rails_3/posts/show.html.erb
 - fixtures/ashared/views_rails_3/posts/show.rabl
+- fixtures/ashared/views_rails_3/posts/show.rabl_test_v1.rabl
 - fixtures/ashared/views_rails_3/users/index.json.rabl
 - fixtures/ashared/views_rails_3/users/phone_number.json.rabl
+- fixtures/ashared/views_rails_3/users/phone_number.xml.rabl
 - fixtures/ashared/views_rails_3/users/show.json.rabl
+- fixtures/ashared/views_rails_3/users/show.rabl_test_v1.rabl
 - fixtures/padrino_test/.components
 - fixtures/padrino_test/.gitignore
 - fixtures/padrino_test/Gemfile
@@ -391,6 +394,7 @@ files:
 - fixtures/sinatra_test/test/test_helper.rb
 - lib/rabl.rb
 - lib/rabl/builder.rb
+- lib/rabl/cache_engine.rb
 - lib/rabl/configuration.rb
 - lib/rabl/engine.rb
 - lib/rabl/helpers.rb