rabl 0.7.9 → 0.7.10

data/.travis.yml

@@ -3,7 +3,7 @@ rvm:
   - 1.8.7
   - 1.9.2
   - 1.9.3
-  - rbx
+  # - rbx
 gemfile: Gemfile.ci
 notifications:
   recipients:

data/CHANGELOG.md

@@ -1,6 +1,13 @@
 # CHANGELOG
 
-## 0.7.10 (unreleased)
+## 0.7.11
+
+## 0.7.10
+
+ * Add early support for Rails 4 (Thanks @jopotts)
+ * Add configuration option for raising on missing attributes (Thanks @ReneB)
+ * Allow caching outside the Rails environment (Thanks @flyerhzm)
+ * Fix template lookup on Rails (Thanks @vimutter)
 
 ## 0.7.9
 

data/README.md

@@ -18,7 +18,7 @@ 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.
 
-For a breakdown of common misconceptions about RABL, please check out our guide to 
+For a breakdown of common misconceptions about RABL, please check out our guide to
 [understanding RABL](https://github.com/nesquena/rabl/wiki/Understanding-RABL) which can help clear up any confusion about this project.
 
 ## Breaking Changes ##
@@ -115,6 +115,7 @@ Rabl.configure do |config|
   # 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.perform_caching = false
   # config.escape_all_output = false
   # config.json_engine = nil # Any multi_json engines or a Class with #encode method
   # config.msgpack_engine = nil # Defaults to ::MessagePack
@@ -129,6 +130,7 @@ Rabl.configure do |config|
   # config.enable_json_callbacks = false
   # config.xml_options = { :dasherize  => true, :skip_types => false }
   # config.view_paths = []
+  # config.raise_on_missing_attribute = true # Defaults to false
 end
 ```
 
@@ -141,6 +143,10 @@ a root node by default. This allows you to further fine-tune your desired respon
 
 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 `perform_caching` is set to `true` then it will perform caching. You
+can ignore this option if you are using Rails, it's same to Rails
+`config.action_controller.perform_caching`
+
 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.
 
@@ -154,6 +160,11 @@ Custom nodes will not be escaped, use `ERB::Util.h(value)`.
 If `view_paths` is set to a path, this view path will be checked for every rabl template within your application.
 Add to this path especially when including Rabl in an engine and using view paths within a another Rails app.
 
+If `raise_on_missing_attribute` is set to `true`, a RuntimeError will be raised whenever Rabl
+attempts to render an attribute that does not exist. Otherwise, the attribute will simply be omitted.
+Setting this to true during development may help increase the robustness of your code, but using `true` in
+production code is not recommended.
+
 Note that the `json_engine` option uses [multi_json](http://intridea.com/2010/6/14/multi-json-the-swappable-json-handler) engine
 defaults so that in most cases you **don't need to configure this** directly. For example, if you wish to use [oj](https://github.com/ohler55/oj) as
 the primary JSON encoding engine simply add that to your Gemfile:

data/lib/rabl.rb

@@ -14,7 +14,7 @@ require 'rabl/configuration'
 require 'rabl/renderer'
 require 'rabl/cache_engine'
 require 'rabl/json_engine'
-require 'rabl/railtie' if defined?(Rails) && Rails.version =~ /^3/
+require 'rabl/railtie' if defined?(Rails) && Rails.version =~ /^[34]/
 
 # Rabl.register!
 module Rabl

data/lib/rabl/builder.rb

@@ -65,7 +65,7 @@ module Rabl
     # attribute :foo, :as => "bar"
     # attribute :foo, :as => "bar", :if => lambda { |m| m.foo }
     def attribute(name, options={})
-      if @_object && @_object.respond_to?(name) && resolve_condition(options)
+      if @_object && attribute_present?(name) && resolve_condition(options)
         @_result[options[:as] || name] = data_object_attribute(name)
       end
     end
@@ -127,6 +127,18 @@ module Rabl
 
     private
 
+    # Checks if an attribute is present. If not, check if the configuration specifies that this is an error
+    # attribute_present?(created_at) => true
+    def attribute_present?(name)
+      if @_object.respond_to?(name)
+        return true
+      elsif Rabl.configuration.raise_on_missing_attribute
+        raise "Failed to render missing attribute #{name}"
+      else
+        return false
+      end
+    end
+
     # Returns a guess at the format in this scope
     # request_format => "xml"
     def request_format

data/lib/rabl/configuration.rb

@@ -37,6 +37,8 @@ module Rabl
     attr_accessor :escape_all_output
     attr_accessor :view_paths
     attr_accessor :cache_engine
+    attr_accessor :raise_on_missing_attribute
+    attr_accessor :perform_caching
 
     DEFAULT_XML_OPTIONS = { :dasherize  => true, :skip_types => false }
 
@@ -60,6 +62,7 @@ module Rabl
       @escape_all_output     = false
       @view_paths            = []
       @cache_engine          = Rabl::CacheEngine.new
+      @perform_caching       = false
     end
 
     # @param [Symbol, Class] engine_name The name of a JSON engine,

data/lib/rabl/helpers.rb

@@ -101,7 +101,11 @@ module Rabl
 
     # Returns true if the cache has been enabled for the application
     def template_cache_configured?
-      defined?(Rails) && defined?(ActionController::Base) && ActionController::Base.perform_caching
+      if defined?(Rails)
+        defined?(ActionController::Base) && ActionController::Base.perform_caching
+      else
+        Rabl.configuration.perform_caching
+      end
     end
 
     # Escape output if configured and supported

data/lib/rabl/partials.rb

@@ -76,7 +76,8 @@ module Rabl
             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 = lookup_proc.call(false) rescue nil
+        template ||= lookup_proc.call(true) rescue nil
         template.identifier if template
       elsif source_format && context_scope.respond_to?(:view_paths) # Rails 2
         template = context_scope.view_paths.find_template(file, source_format, false)

data/lib/rabl/template.rb

@@ -41,7 +41,7 @@ if defined?(ActionView) && defined?(Rails) && Rails.version =~ /^2/
 end
 
 # Rails 3.X Template
-if defined?(ActionView) && defined?(Rails) && Rails.version =~ /^3/
+if defined?(ActionView) && defined?(Rails) && Rails.version =~ /^[34]/
   module ActionView
     module Template::Handlers
       class Rabl

data/lib/rabl/version.rb

@@ -1,3 +1,3 @@
 module Rabl
-  VERSION = "0.7.9"
+  VERSION = "0.7.10"
 end

data/test/builder_test.rb

@@ -49,9 +49,23 @@ context "Rabl::Builder" do
       build_hash @user, :attributes => { :name => {}, :city => { :as => :city } }
     end.equivalent_to({:name => 'rabl', :city => 'irvine'})
 
-    asserts "that with a non-existent attribute the node" do
-      build_hash @user, :attributes => { :fake => :fake }
-    end.equals({})
+    context "that with a non-existent attribute" do
+      context "when non-existent attributes are allowed by the configuration" do
+        setup { stub(Rabl.configuration).raise_on_missing_attribute { false } }
+
+        asserts "the node" do
+          build_hash @user, :attributes => { :fake => :fake }
+        end.equals({})
+      end
+
+      context "when non-existent attributes are forbidden by the configuration" do
+        setup { stub(Rabl.configuration).raise_on_missing_attribute { true } }
+
+        asserts "the node" do
+          build_hash @user, :attributes => { :fake => :fake }
+        end.raises(RuntimeError)
+      end
+    end
   end
 
   context "#node" do

data/test/configuration_test.rb

@@ -42,4 +42,14 @@ context 'Rabl::Configuration' do
       end
     }.raises(RuntimeError)
   end # invalid
+
+  context 'raise on missing attributes' do
+    setup do
+      Rabl.configure do |c|
+        c.raise_on_missing_attribute = true
+      end
+    end
+
+    asserts(:raise_on_missing_attribute).equals true
+  end # raise on missing
 end

data/test/partials_test.rb

@@ -88,4 +88,48 @@ context "Rabl::Partials" do
       Rabl.configuration.view_paths = []
     end
   end
+
+  context "fetch source with Rails" do
+    context "and :view_path" do
+      helper(:tmp_path) { @tmp_path ||= Pathname.new(Dir.mktmpdir) }
+
+      setup do
+        ::Rails = stub(Class.new)
+        ::ActionPack = Module.new
+        ::ActionPack::VERSION = Module.new
+        ::ActionPack::VERSION::MAJOR = 3
+        ::ActionPack::VERSION::MINOR = 2
+        @it = TestPartial.new
+
+        def @it.context_scope; @context_scope ||= Object.new; end
+        def @it.request_format; :json; end
+        context_scope = @it.context_scope
+
+        def context_scope.view_paths; []; end
+        def context_scope.lookup_context; @lookup_context ||= Object.new; end
+        lookup_context = context_scope.lookup_context
+
+        def lookup_context.rendered_format; :json; end
+        def lookup_context.find(*args)
+          raise RuntimeError, 'Something happen with Rails lookup'
+        end
+
+        File.open(tmp_path + "test.json.rabl", "w") { |f| f.puts "content" }
+
+        @it
+      end
+
+      asserts('rails lookups dont break manual') do
+        @it.fetch_source('test', :view_path => tmp_path.to_s)
+      end.equals do
+        ["content\n", (tmp_path + "test.json.rabl").to_s ]
+      end
+
+      teardown do
+        Object.send(:remove_const, :Rails)
+        Object.send(:remove_const, :ActionPack)
+        Rabl.configuration.view_paths = []
+      end
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rabl
 version: !ruby/object:Gem::Version
-  version: 0.7.9
+  version: 0.7.10
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-28 00:00:00.000000000 Z
+date: 2013-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport