rabl-rails 0.4.3 → 0.5.0

data/lib/rabl-rails/railtie.rb

@@ -4,10 +4,21 @@ module RablRails
       ActiveSupport.on_load(:action_view) do
         ActionView::Template.register_template_handler :rabl, RablRails::Handlers::Rabl
       end
-    end
 
-    config.after_initialize do
-      ActionController::Base.responder = RablRails::Responder if RablRails.configuration.use_custom_responder
+      if Rails::VERSION::MAJOR >= 5
+        module ::ActionController
+          module ApiRendering
+            include ActionView::Rendering
+          end
+        end
+
+        ActiveSupport.on_load :action_controller do
+          if self == ActionController::API
+            include ActionController::Helpers
+            include ActionController::ImplicitRender
+          end
+        end
+      end
     end
   end
 end

data/lib/rabl-rails/renderers/hash.rb

@@ -20,7 +20,6 @@ module RablRails
             visitor.instance_variable_get(template.data)
           end
         end
-        collection_or_resource ||= locals[:resource] if locals
 
         render_with_cache(template.cache_key, collection_or_resource) do
           output_hash = if collection?(collection_or_resource)
@@ -82,4 +81,4 @@ module RablRails
       end
     end
   end
-end
+end

data/lib/rabl-rails/template.rb

@@ -3,8 +3,9 @@ module RablRails
     attr_accessor :nodes, :data, :root_name, :cache_key
 
     def initialize
-      @nodes = []
-      @cache_key = false
+      @nodes      = []
+      @data       = nil
+      @cache_key  = false
     end
 
     def initialize_dup(other)
@@ -20,4 +21,4 @@ module RablRails
       @nodes.concat template.nodes
     end
   end
-end
+end

data/lib/rabl-rails/version.rb

@@ -1,3 +1,3 @@
 module RablRails
-  VERSION = '0.4.3'
+  VERSION = '0.5.0'
 end

data/lib/rabl-rails/visitors/to_hash.rb

@@ -18,10 +18,6 @@ module Visitors
       @_result = {}
     end
 
-    def visit_Array n
-      n.each { |i| visit i }
-    end
-
     def visit_Attribute n
       if !n.condition || instance_exec(_resource, &(n.condition))
         n.each { |k, v| @_result[k] = _resource.send(v) }
@@ -29,7 +25,7 @@ module Visitors
     end
 
     def visit_Child n
-      object = object_from_data(_resource, n.data, n.instance_variable_data?)
+      object = object_from_data(_resource, n)
 
       @_result[n.name] = if object
         collection?(object) ? object.map { |o| sub_visit(o, n.nodes) } : sub_visit(object, n.nodes)
@@ -38,12 +34,17 @@ module Visitors
       end
     end
 
+    def visit_Glue n
+      object = object_from_data(_resource, n)
+      @_result.merge!(sub_visit(object, n.nodes)) if object
+    end
+
     def visit_Code n
       if !n.condition || instance_exec(_resource, &(n.condition))
         result = instance_exec _resource, &(n.block)
 
         if n.merge?
-          raise RablRails::Renderer::PartialError, '`merge` block should return a hash' unless result.is_a?(Hash)
+          raise RablRails::PartialError, '`merge` block should return a hash' unless result.is_a?(Hash)
           @_result.merge!(result)
         else
           @_result[n.name] = result
@@ -55,9 +56,11 @@ module Visitors
       @_result.merge!(sub_visit(_resource, n.nodes)) if instance_exec _resource, &(n.condition)
     end
 
-    def visit_Glue n
-      object = object_from_data(_resource, n.data, n.instance_variable_data?)
-      @_result.merge! sub_visit(object, n.template.nodes)
+    def visit_Extend n
+      @_locals = n.locals
+      @_result.merge!(sub_visit(_resource, n.nodes))
+    ensure
+      @_locals = {}
     end
 
     def result
@@ -65,13 +68,13 @@ module Visitors
       when 0
         @_result
       when 1
-        @_result.each { |k, v| @_result[k] = '' if v == nil }
+        @_result.each { |k, v| @_result[k] = ''.freeze if v == nil }
       when 2, 3
-        @_result.each { |k, v| @_result[k] = nil if v == '' }
+        @_result.each { |k, v| @_result[k] = nil if v == ''.freeze }
       when 4, 5
         @_result.delete_if { |_, v| v == nil }
       when 6
-        @_result.delete_if { |_, v| v == nil || v == '' }
+        @_result.delete_if { |_, v| v == nil || v == ''.freeze }
       end
     end
 
@@ -95,7 +98,7 @@ module Visitors
     # rendering time).
     #
     def partial(template_path, options = {})
-      raise RablRails::Renderer::PartialError.new("No object was given to partial #{template_path}") unless options[:object]
+      raise RablRails::PartialError.new("No object was given to partial #{template_path}") unless options[:object]
       object = options[:object]
       @_locals = options[:locals].freeze
 
@@ -115,7 +118,7 @@ module Visitors
 
     def copy_instance_variables_from_context
       @_context.instance_variable_get(:@_assigns).each_pair { |k, v|
-        instance_variable_set("@#{k}", v) unless k.to_s.start_with?('_')
+        instance_variable_set("@#{k}", v) unless k.to_s.start_with?('_'.freeze)
       }
     end
 
@@ -128,10 +131,11 @@ module Visitors
       @_result, @_resource = old_result, old_resource
     end
 
-    def object_from_data(resource, symbol, is_variable)
-      return resource if symbol == nil
+    def object_from_data(resource, node)
+      return resource if node.data == nil
 
-      if is_variable
+      symbol = node.data
+      if node.instance_variable_data?
         instance_variable_get(symbol)
       else
         resource.respond_to?(symbol) ? resource.send(symbol) : @_context.send(symbol)

data/lib/rabl-rails/visitors/visitor.rb

@@ -1,7 +1,11 @@
 module Visitors
   class Visitor
     def visit(node)
-      dispatch node
+      dispatch(node)
+    end
+
+    def visit_Array a
+      a.each { |n| dispatch(n) }
     end
 
     private
@@ -14,4 +18,4 @@ module Visitors
       send DISPATCH[node.class], node
     end
   end
-end
+end

data/rabl-rails.gemspec

@@ -8,17 +8,20 @@ Gem::Specification.new do |s|
   s.authors     = ["Christopher Cocchi-Perrier"]
   s.email       = ["cocchi.c@gmail.com"]
   s.homepage    = "https://github.com/ccocchi/rabl-rails"
-  s.summary     = "Fast Rails 3+ templating system with JSON, XML and PList support"
-  s.description = "Fast Rails 3+ templating system with JSON, XML and PList support"
+  s.summary     = "Fast Rails 4+ templating system with JSON, XML and PList support"
+  s.description = "Fast Rails 4+ templating system with JSON, XML and PList support"
   s.license     = 'MIT'
 
+  s.required_ruby_version     = '>= 2.2.0'
+
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- test/*`.split("\n")
   s.require_paths = ["lib"]
 
-  s.add_dependency 'activesupport', '>= 3.1'
-  s.add_dependency 'railties', '>= 3.1'
-  s.add_dependency 'thread_safe', '~> 0.3.1'
+  s.add_dependency 'activesupport', '>= 4.2'
+  s.add_dependency 'railties', '>= 4.2'
+  s.add_dependency 'concurrent-ruby', '~> 1.0.0'
 
-  s.add_development_dependency 'actionpack', '>= 3.1'
+  s.add_development_dependency 'actionpack', '>= 4.2'
+  s.add_development_dependency 'actionview', '>= 4.2'
 end

data/test/helper.rb

@@ -9,7 +9,6 @@ require 'rabl-rails'
 require 'plist'
 require 'action_dispatch/http/mime_type'
 require 'action_view'
-require 'active_support/core_ext/string/starts_ends_with'
 
 if RUBY_ENGINE == 'jruby'
   require 'nokogiri'
@@ -17,12 +16,6 @@ elsif RUBY_ENGINE == 'ruby'
   require 'libxml'
 end
 
-MINITEST_TEST_CLASS = if defined?(Minitest::Test)
-  Minitest::Test
-else
-  Minitest::Unit::TestCase
-end
-
 ActionView::Template.register_template_handler :rabl, RablRails::Handlers::Rabl
 
 module Configurable
@@ -35,7 +28,7 @@ module Configurable
     RablRails.configuration.send(accessor, old_value)
   end
 end
-MINITEST_TEST_CLASS.send(:include, Configurable)
+Minitest::Test.send(:include, Configurable)
 
 module Rails
   def self.cache

data/test/renderers/test_hash_renderer.rb

@@ -1,9 +1,9 @@
 require 'helper'
 
-class TestHashRenderer < MINITEST_TEST_CLASS
+class TestHashRenderer < Minitest::Test
   describe 'hash renderer' do
-    def render(locals = nil)
-      RablRails::Renderers::Hash.render(@template, @context, locals)
+    def render
+      RablRails::Renderers::Hash.render(@template, @context, {})
     end
 
     def with_cache
@@ -71,12 +71,6 @@ class TestHashRenderer < MINITEST_TEST_CLASS
       assert_equal({ name: 'Marty' }, render)
     end
 
-    it "uses resource passed in locals if template don't have data" do
-      @template.data = nil
-      resource = User.new(2, 'Biff')
-      assert_equal({ name: 'Biff' }, render(resource: resource))
-    end
-
     it 'uses template root_name option' do
       @template.root_name = :user
       assert_equal({ user: { name: 'Marty' } }, render)
@@ -87,4 +81,4 @@ class TestHashRenderer < MINITEST_TEST_CLASS
       assert_equal([{ name: 'Marty' }], render)
     end
   end
-end
+end

data/test/renderers/test_json_renderer.rb

@@ -1,6 +1,6 @@
 require 'helper'
 
-class TestJSONRenderer < MINITEST_TEST_CLASS
+class TestJSONRenderer < Minitest::Test
   describe 'JSON renderer' do
     def render
       RablRails::Renderers::JSON.render(@template, @context)

data/test/renderers/test_plist_renderer.rb

@@ -1,6 +1,6 @@
 require 'helper'
 
-class TestPListRenderer < MINITEST_TEST_CLASS
+class TestPListRenderer < Minitest::Test
   INDENT_REGEXP = /\n(\s)*/
   HEADER_REGEXP = /<\?[^>]+><![^>]+>/
 

data/test/renderers/test_xml_renderer.rb

@@ -1,6 +1,6 @@
 require 'helper'
 
-class TestXMLRenderer < MINITEST_TEST_CLASS
+class TestXMLRenderer < Minitest::Test
   INDENT_REGEXP = /\n(\s)*/
   HEADER_REGEXP = /<[^>]+>/
 

data/test/test_compiler.rb

@@ -2,9 +2,15 @@ require 'helper'
 require 'pathname'
 require 'tmpdir'
 
-class TestCompiler < MINITEST_TEST_CLASS
+class TestCompiler < Minitest::Test
   @@tmp_path = Pathname.new(Dir.mktmpdir)
 
+  File.open(@@tmp_path + 'user.rabl', 'w') do |f|
+    f.puts %q{
+      attributes :id
+    }
+  end
+
   describe 'compiler' do
     def extract_attributes(nodes)
       nodes.map(&:hash)
@@ -159,11 +165,7 @@ class TestCompiler < MINITEST_TEST_CLASS
     end
 
     it "compiles child with inline partial notation" do
-      File.open(@@tmp_path + 'user.rabl', 'w') do |f|
-        f.puts %q{
-          attributes :id
-        }
-      end
+
 
       t = @compiler.compile_source(%{child(:user, :partial => 'user') })
       child_node = t.nodes.first
@@ -205,12 +207,17 @@ class TestCompiler < MINITEST_TEST_CLASS
       assert_equal(:foo, code_node.name)
     end
 
+    it "compiles glue with a partial" do
+      t = @compiler.compile_source(%{
+        glue(:@user, partial: 'user')
+      })
+
+      glue_node = t.nodes.first
+      assert_equal(1, glue_node.nodes.size)
+      assert_equal([{ :id => :id }], extract_attributes(glue_node.nodes))
+    end
+
     it "extends other template" do
-      File.open(@@tmp_path + 'user.rabl', 'w') do |f|
-        f.puts %q{
-          attributes :id
-        }
-      end
       t = @compiler.compile_source(%{ extends 'user' })
       assert_equal([{ :id => :id }], extract_attributes(t.nodes))
     end
@@ -229,17 +236,21 @@ class TestCompiler < MINITEST_TEST_CLASS
     end
 
     it "extends template that has been compiled previously by ActionView" do
-      File.open(@@tmp_path + 'user.rabl', 'w') do |f|
-        f.puts %q{
-          attributes :id
-        }
-      end
       t = @view.lookup_context.find_template('user')
       t.send(:compile!, @view)
       t = @compiler.compile_source(%{ extends 'user' })
       assert_equal([{ :id => :id }], extract_attributes(t.nodes))
     end
 
+    it "compiles extends with locals" do
+      t    = @compiler.compile_source(%{ extends 'user', locals: { display_credit_card: false } })
+      node = t.nodes.first
+
+      assert_instance_of RablRails::Nodes::Extend, node
+      assert_equal([{ :id => :id }], extract_attributes(node.nodes))
+      assert_equal({ display_credit_card: false }, node.locals)
+    end
+
     it "compiles node" do
       t = @compiler.compile_source(%{ node(:foo) { bar } })
 
@@ -262,13 +273,19 @@ class TestCompiler < MINITEST_TEST_CLASS
       assert_nil node.name
     end
 
-    it "compiles merge like a node but with a reserved keyword as name" do
+    it "compiles merge like a node" do
       t = @compiler.compile_source(%{ merge do |m| m.foo end })
       node = t.nodes.first
       assert_instance_of RablRails::Nodes::Code, node
       assert_nil node.name
     end
 
+    it "compiles merge with options" do
+      t = @compiler.compile_source(%{ merge(->(m) { true }) do |m| m.foo end })
+      node = t.nodes.first
+      refute_nil node.condition
+    end
+
     it "compiles condition" do
       t = @compiler.compile_source(%{ condition(->(u) {}) do attributes :secret end })
 

data/test/test_configuration.rb

@@ -1,6 +1,6 @@
 require 'helper'
 
-class TestConfiguration < MINITEST_TEST_CLASS
+class TestConfiguration < Minitest::Test
   describe 'Configuration' do
     it 'has a zero score by default' do
       config = RablRails::Configuration.new
@@ -28,4 +28,4 @@ class TestConfiguration < MINITEST_TEST_CLASS
       assert_equal 3, config.result_flags
     end
   end
-end
+end

data/test/test_hash_visitor.rb

@@ -1,6 +1,6 @@
 require 'helper'
 
-class TestHashVisitor < MINITEST_TEST_CLASS
+class TestHashVisitor < Minitest::Test
   describe 'hash visitor' do
     def visitor_result
       visitor = Visitors::ToHash.new(@context)
@@ -45,12 +45,12 @@ class TestHashVisitor < MINITEST_TEST_CLASS
       before do
         @template = RablRails::CompiledTemplate.new
         @template.add_node(RablRails::Nodes::Attribute.new(city: :city))
-        @nodes << RablRails::Nodes::Child.new(:address, @template)
         @address = Address.new('Paris')
       end
 
       it 'renders with resource association as data source' do
         @template.data = :address
+        @nodes << RablRails::Nodes::Child.new(:address, @template)
         def @resource.address; end
         @resource.stub :address, @address do
           assert_equal({ address: { city: 'Paris' } }, visitor_result)
@@ -59,12 +59,14 @@ class TestHashVisitor < MINITEST_TEST_CLASS
 
       it 'renders with arbitrary data source' do
         @template.data = :@address
+        @nodes = [RablRails::Nodes::Child.new(:address, @template)]
         @context.assigns['address'] = @address
         assert_equal({ address: { city: 'Paris' } }, visitor_result)
       end
 
       it 'renders with local method as data source' do
         @template.data = :address
+        @nodes << RablRails::Nodes::Child.new(:address, @template)
         def @context.address; end
         @context.stub :address, @address do
           assert_equal({ address: { city: 'Paris' } }, visitor_result)
@@ -73,6 +75,7 @@ class TestHashVisitor < MINITEST_TEST_CLASS
 
       it 'renders with a collection as data source' do
         @template.data = :address
+        @nodes << RablRails::Nodes::Child.new(:address, @template)
         def @context.address; end
         @context.stub :address, [@address, @address] do
           assert_equal({ address: [
@@ -84,6 +87,7 @@ class TestHashVisitor < MINITEST_TEST_CLASS
 
       it 'renders if the source is nil' do
         @template.data = :address
+        @nodes << RablRails::Nodes::Child.new(:address, @template)
         def @resource.address; end
         @resource.stub :address, nil do
           assert_equal({ address: nil }, visitor_result)
@@ -157,7 +161,7 @@ class TestHashVisitor < MINITEST_TEST_CLASS
     it 'raises an exception when trying to merge a non hash object' do
       proc = ->(c) { c.name }
       @nodes << RablRails::Nodes::Code.new(nil, proc)
-      assert_raises(RablRails::Renderer::PartialError) { visitor_result }
+      assert_raises(RablRails::PartialError) { visitor_result }
     end
 
     it 'renders partial defined in node' do
@@ -192,6 +196,17 @@ class TestHashVisitor < MINITEST_TEST_CLASS
       library.verify
     end
 
+    it 'renders extend with locals' do
+      n = RablRails::Nodes::Attribute.new(id: :id)
+      n.condition = lambda { |_| locals[:display_id] }
+
+      @nodes << RablRails::Nodes::Extend.new(n, display_id: true)
+      assert_equal({ id: 1 }, visitor_result)
+
+      @nodes.first.locals[:display_id] = false
+      assert_equal({}, visitor_result)
+    end
+
     it 'renders partial with empty target' do
       proc = ->(u) { partial('users/base', object: []) }
       @nodes << RablRails::Nodes::Code.new(:users, proc)
@@ -201,7 +216,7 @@ class TestHashVisitor < MINITEST_TEST_CLASS
     it 'raises an exception when calling a partial without a target' do
       proc = ->(u) { partial('users/base') }
       @nodes << RablRails::Nodes::Code.new(:user, proc)
-      assert_raises(RablRails::Renderer::PartialError) { visitor_result }
+      assert_raises(RablRails::PartialError) { visitor_result }
     end
 
     describe 'when hash options are set' do