rabl-rails 0.4.0 → 0.4.1

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## 0.4.1
+  * Make classes that should not be treated as collection configurable
+  * Internal change to determine rendering format
+
 ## 0.4.0
   * Internal cleanup and refactor
   * Remove the `allow_empty_format_in_template` option, since it has become

data/README.md

@@ -99,6 +99,7 @@ RablRails.configure do |config|
   # config.replace_nil_values_with_empty_strings = false
   # config.replace_empty_string_values_with_nil = false
   # config.exclude_nil_values = false
+  # config.non_collection_classes = Set.new(['Struct'])
 end
 ```
 

data/lib/rabl-rails/configuration.rb

@@ -1,3 +1,5 @@
+require 'set'
+
 module RablRails
   class Configuration
     attr_accessor :json_engine, :include_json_root, :enable_jsonp_callbacks
@@ -9,6 +11,7 @@ module RablRails
     attr_accessor :replace_nil_values_with_empty_strings
     attr_accessor :replace_empty_string_values_with_nil
     attr_accessor :exclude_nil_values
+    attr_accessor :non_collection_classes
 
     def initialize
       @json_engine            = defined?(::Oj) ? ::Oj : ::JSON
@@ -20,7 +23,7 @@ module RablRails
       @plist_engine       = defined?(::Plist) ? ::Plist::Emit : nil
       @include_plist_root = false
 
-      @cache_templates                = ActionController::Base.perform_caching
+      @cache_templates    = ActionController::Base.perform_caching
 
       @use_custom_responder       = false
       @responder_default_template = 'show'
@@ -28,6 +31,8 @@ module RablRails
       @replace_nil_values_with_empty_strings  = false
       @replace_empty_string_values_with_nil   = false
       @exclude_nil_values                     = false
+
+      @non_collection_classes = Set.new(['Struct'])
     end
 
     def use_custom_responder=(value)

data/lib/rabl-rails/handler.rb

@@ -3,9 +3,6 @@ require 'active_support/core_ext/class/attribute'
 module RablRails
   module Handlers
     class Rabl
-      class_attribute :default_format
-      self.default_format = 'application/json'
-
       def self.call(template)
         %{
           RablRails::Library.instance.

data/lib/rabl-rails/helpers.rb

@@ -1,7 +1,10 @@
 module RablRails
   module Helpers
     def collection?(resource)
-      resource && resource.respond_to?(:each) && !resource.is_a?(Struct)
+      klass = resource.class
+
+      resource && resource.respond_to?(:each) &&
+        klass.ancestors.none? { |a| RablRails.configuration.non_collection_classes.include? a.name }
     end
   end
 end

data/lib/rabl-rails/library.rb

@@ -6,6 +6,15 @@ module RablRails
   class Library
     include Singleton
 
+    UnknownFormat = Class.new(StandardError)
+
+    RENDERER_MAP = {
+      json:   Renderers::JSON,
+      xml:    Renderers::XML,
+      ruby:   Renderers::Hash,
+      plist:  Renderers::PLIST
+    }.freeze
+
     def initialize
       @cached_templates = ThreadSafe::Cache.new
       @mutex = Monitor.new
@@ -17,8 +26,9 @@ module RablRails
 
     def get_rendered_template(source, view, locals = nil)
       compiled_template = compile_template_from_source(source, view)
-      format = view.params[:format] ? view.params[:format].to_s.upcase : :JSON
-      Renderers.const_get(format).render(compiled_template, view, locals)
+      format = view.lookup_context.rendered_format || :json
+      raise UnknownFormat, "#{format} is not supported in rabl-rails" unless RENDERER_MAP.key?(format)
+      RENDERER_MAP[format].render(compiled_template, view, locals)
     end
 
     def compile_template_from_source(source, view)

data/lib/rabl-rails/renderer.rb

@@ -16,6 +16,10 @@ module RablRails
         @format = format.downcase
       end
 
+      def rendered_format
+        @format.to_sym
+      end
+
       #
       # Manually find given rabl template file with given format.
       # View path can be set via options, otherwise default Rails
@@ -42,7 +46,7 @@ module RablRails
 
       def initialize(path, options)
         @virtual_path = path
-        @format = options.delete(:format) || 'json'
+        @format = options.delete(:format) || :json
         @_assigns = {}
         @options = options
 

data/lib/rabl-rails/version.rb

@@ -1,3 +1,3 @@
 module RablRails
-  VERSION = '0.4.0'
+  VERSION = '0.4.1'
 end

data/test/helper.rb

@@ -46,11 +46,23 @@ module ActionController
 end
 
 class Context
+  class LookupContext
+    def initialize(format)
+      @format = format
+    end
+
+    def rendered_format
+      @format.to_sym
+    end
+  end
+
   attr_writer :virtual_path
+  attr_reader :lookup_context
 
-  def initialize
+  def initialize(format = :json)
     @_assigns = {}
     @virtual_path = nil
+    @lookup_context = LookupContext.new(format)
   end
 
   def assigns

data/test/test_helpers.rb

@@ -0,0 +1,23 @@
+require 'helper'
+require 'set'
+
+class TestHelpers < MINITEST_TEST_CLASS
+  include RablRails::Helpers
+
+  def test_collection_with_default
+    assert collection?(['foo'])
+    refute collection?(User.new(1))
+  end
+
+  NotACollection = Class.new do
+    def each; end
+  end
+
+  def test_collection_with_configuration
+    assert collection?(NotACollection.new)
+
+    with_configuration(:non_collection_classes, Set.new(['Struct', 'TestHelpers::NotACollection'])) do
+      refute collection?(NotACollection.new), 'NotACollection triggers #collection?'
+    end
+  end
+end

data/test/test_library.rb

@@ -13,41 +13,29 @@ class TestLibrary < MINITEST_TEST_CLASS
 
     describe '#get_rendered_template' do
       it 'compiles and renders template' do
-        renderer = MiniTest::Mock.new
-        renderer.expect :render, '{}', [@template, @context, nil]
-
         result = @library.stub :compile_template_from_source, @template do
-          RablRails::Renderers.stub :const_get, renderer do
-            @library.get_rendered_template '', @context
-          end
+          @library.get_rendered_template '', @context
         end
 
         assert_equal '{}', result
-        assert renderer.verify
       end
 
-      it 'accepts format as string' do
+      it 'uses for from lookup context' do
+        context = Context.new(:xml)
         result = @library.stub :compile_template_from_source, @template do
-          @context.stub :params, { format: 'xml' } do
-            RablRails::Renderers::XML.stub :render, '<xml>' do
-              @library.get_rendered_template '', @context
-            end
+          RablRails::Renderers::XML.stub :render, '<xml>' do
+            @library.get_rendered_template '', context
           end
         end
 
         assert_equal '<xml>', result
       end
 
-      it 'accepts format as symbol' do
-        result = @library.stub :compile_template_from_source, @template do
-          @context.stub :params, { format: :plist } do
-            RablRails::Renderers::PLIST.stub :render, '<plist>' do
-              @library.get_rendered_template '', @context
-            end
-          end
+      it 'raises if format is not supported' do
+        context = Context.new(:unsupported)
+        @library.stub :compile_template_from_source, @template do
+          assert_raises(RablRails::Library::UnknownFormat) { @library.get_rendered_template '', context }
         end
-
-        assert_equal '<plist>', result
       end
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rabl-rails
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-12 00:00:00.000000000 Z
+date: 2014-12-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -108,6 +108,7 @@ files:
 - test/test_compiler.rb
 - test/test_configuration.rb
 - test/test_hash_visitor.rb
+- test/test_helpers.rb
 - test/test_library.rb
 - test/test_render.rb
 homepage: https://github.com/ccocchi/rabl-rails
@@ -143,5 +144,6 @@ test_files:
 - test/test_compiler.rb
 - test/test_configuration.rb
 - test/test_hash_visitor.rb
+- test/test_helpers.rb
 - test/test_library.rb
 - test/test_render.rb