rabl-rails 0.3.4 → 0.4.0

data/test/test_configuration.rb

@@ -0,0 +1,31 @@
+require 'helper'
+
+class TestConfiguration < MINITEST_TEST_CLASS
+  describe 'Configuration' do
+    it 'has a zero score by default' do
+      config = RablRails::Configuration.new
+      assert_equal 0, config.result_flags
+    end
+
+    it 'sets a bit per option' do
+      config = RablRails::Configuration.new
+      config.replace_nil_values_with_empty_strings = true
+      assert_equal 1, config.result_flags
+
+      config = RablRails::Configuration.new
+      config.replace_empty_string_values_with_nil = true
+      assert_equal 2, config.result_flags
+
+      config = RablRails::Configuration.new
+      config.exclude_nil_values = true
+      assert_equal 4, config.result_flags
+    end
+
+    it 'allows mutiple bits to be set at the same time' do
+      config = RablRails::Configuration.new
+      config.replace_nil_values_with_empty_strings = true
+      config.replace_empty_string_values_with_nil = true
+      assert_equal 3, config.result_flags
+    end
+  end
+end

data/test/test_hash_visitor.rb

@@ -0,0 +1,224 @@
+require 'helper'
+
+class TestHashVisitor < MINITEST_TEST_CLASS
+  describe 'hash visitor' do
+    def visitor_result
+      visitor = Visitors::ToHash.new(@context)
+      visitor.reset_for @resource
+      visitor.visit @nodes
+      visitor.result
+    end
+
+    before do
+      @context  = Context.new
+      @resource = User.new(1, 'Marty')
+      @nodes    = []
+    end
+
+    it 'renders empty nodes list' do
+      assert_equal({}, visitor_result)
+    end
+
+    it 'renders attributes node' do
+      @nodes << RablRails::Nodes::Attribute.new(id: :id)
+      assert_equal({ id: 1 }, visitor_result)
+    end
+
+    it 'renders array of nodes' do
+      @nodes = [
+        RablRails::Nodes::Attribute.new(id: :id),
+        RablRails::Nodes::Attribute.new(name: :name)
+      ]
+      assert_equal({ id: 1, name: 'Marty' }, visitor_result)
+    end
+
+    describe 'with a child node' do
+      Address = Struct.new(:city)
+
+      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
+        def @resource.address; end
+        @resource.stub :address, @address do
+          assert_equal({ address: { city: 'Paris' } }, visitor_result)
+        end
+      end
+
+      it 'renders with arbitrary data source' do
+        @template.data = :@address
+        @context.assigns['address'] = @address
+        assert_equal({ address: { city: 'Paris' } }, visitor_result)
+      end
+
+      it 'renders with local method as data source' do
+        @template.data = :address
+        def @context.address; end
+        @context.stub :address, @address do
+          assert_equal({ address: { city: 'Paris' } }, visitor_result)
+        end
+      end
+
+      it 'renders with a collection as data source' do
+        @template.data = :address
+        def @context.address; end
+        @context.stub :address, [@address, @address] do
+          assert_equal({ address: [
+            { city: 'Paris' },
+            { city: 'Paris' }
+          ]}, visitor_result)
+        end
+      end
+
+      it 'renders if the source is nil' do
+        @template.data = :address
+        def @resource.address; end
+        @resource.stub :address, nil do
+          assert_equal({ address: nil }, visitor_result)
+        end
+      end
+    end
+
+    it 'renders glue nodes' do
+      template = RablRails::CompiledTemplate.new
+      template.add_node(RablRails::Nodes::Attribute.new(name: :name))
+      template.data = :@user
+
+      @nodes << RablRails::Nodes::Glue.new(template)
+      @context.assigns['user'] = @resource
+      assert_equal({ name: 'Marty'}, visitor_result)
+    end
+
+    describe 'with a code node' do
+      before do
+        @proc = ->(object) { object.name }
+      end
+
+      it 'renders the evaluated proc' do
+        @nodes << RablRails::Nodes::Code.new(:name, @proc)
+        assert_equal({ name: 'Marty'}, visitor_result)
+      end
+
+      it 'renders with a true condition' do
+        @nodes << RablRails::Nodes::Code.new(:name, @proc, ->(o) { true })
+        assert_equal({ name: 'Marty'}, visitor_result)
+      end
+
+      it 'renders nothing with a false condition' do
+        @nodes << RablRails::Nodes::Code.new(:name, @proc, ->(o) { false })
+        assert_equal({}, visitor_result)
+      end
+
+      it 'renders method called from context' do
+        @proc = ->(object) { context_method }
+        def @context.context_method; end
+
+        @nodes = [RablRails::Nodes::Code.new(:name, @proc)]
+        @context.stub :context_method, 'Biff' do
+          assert_equal({ name: 'Biff'}, visitor_result)
+        end
+      end
+    end
+
+    describe 'with a condition node' do
+      before do
+        @ns = [RablRails::Nodes::Attribute.new(name: :name)]
+      end
+
+      it 'renders transparently if the condition is met' do
+        @nodes << RablRails::Nodes::Condition.new(->(o) { true }, @ns)
+        assert_equal({ name: 'Marty' }, visitor_result)
+      end
+
+      it 'renders nothing if the condition is not met' do
+        @nodes << RablRails::Nodes::Condition.new(->(o) { false }, @ns)
+        assert_equal({}, visitor_result)
+      end
+    end
+
+    it 'renders a merge node' do
+      proc = ->(c) { { custom: c.name } }
+      @nodes << RablRails::Nodes::Code.new(nil, proc)
+      assert_equal({ custom: 'Marty' }, visitor_result)
+    end
+
+    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 }
+    end
+
+    it 'renders partial defined in code node' do
+      template = RablRails::CompiledTemplate.new
+      template.add_node(RablRails::Nodes::Attribute.new(name: :name))
+      proc = ->(u) { partial('users/base', object: u) }
+
+      library = MiniTest::Mock.new
+      library.expect :compile_template_from_path, template, ['users/base', @context]
+
+      @nodes << RablRails::Nodes::Code.new(:user, proc)
+      RablRails::Library.stub :instance, library do
+        assert_equal({ user: { name: 'Marty' } }, visitor_result)
+      end
+
+      library.verify
+    end
+
+    it 'renders partial with empty target' do
+      proc = ->(u) { partial('users/base', object: []) }
+      @nodes << RablRails::Nodes::Code.new(:users, proc)
+      assert_equal({ users: [] }, visitor_result)
+    end
+
+    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 }
+    end
+
+    describe 'when hash options are set' do
+      before do
+        RablRails.reset_configuration
+        @nodes << RablRails::Nodes::Attribute.new(name: :name)
+      end
+
+      after { RablRails.reset_configuration }
+
+      it 'replaces nil values by strings' do
+        RablRails.configuration.replace_nil_values_with_empty_strings = true
+        @resource = User.new(1, nil)
+
+        assert_equal({ name: '' }, visitor_result)
+      end
+
+      it 'replaces empty string by nil' do
+        RablRails.configuration.replace_empty_string_values_with_nil = true
+        @resource = User.new(1, '')
+
+        assert_equal({ name: nil }, visitor_result)
+      end
+
+      it 'excludes nil values' do
+        RablRails.configuration.exclude_nil_values = true
+        @resource = User.new(1, nil)
+        @nodes << RablRails::Nodes::Attribute.new(id: :id)
+
+        assert_equal({ id: 1 }, visitor_result)
+      end
+
+      it 'excludes nil values and empty strings' do
+        RablRails.configuration.replace_empty_string_values_with_nil = true
+        RablRails.configuration.exclude_nil_values = true
+        @resource = User.new(nil, '')
+        @nodes << RablRails::Nodes::Attribute.new(id: :id)
+
+        assert_equal({}, visitor_result)
+      end
+    end
+  end
+end

data/test/test_library.rb

@@ -0,0 +1,85 @@
+require 'helper'
+
+class TestLibrary < MINITEST_TEST_CLASS
+  RablRails::Library.send(:attr_reader, :cached_templates)
+
+  describe 'library' do
+    before do
+      @library = RablRails::Library.instance
+      @library.reset_cache!
+      @context = Context.new
+      @template = RablRails::CompiledTemplate.new
+    end
+
+    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
+        end
+
+        assert_equal '{}', result
+        assert renderer.verify
+      end
+
+      it 'accepts format as string' do
+        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
+          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
+        end
+
+        assert_equal '<plist>', result
+      end
+    end
+
+    describe '#compile_template_from_source' do
+      it 'compiles a template' do
+        compiler = MiniTest::Mock.new
+        compiler.expect :compile_source, @template, ['attribute :id']
+
+        result = RablRails::Compiler.stub :new, compiler do
+          @library.compile_template_from_source('attribute :id', @context)
+        end
+
+        assert_equal @template, result
+      end
+
+      it 'caches compiled template if option is set' do
+        @context.virtual_path = 'users/base'
+        template = with_configuration :cache_templates, true do
+          @library.compile_template_from_source("attribute :id", @context)
+        end
+
+        assert_equal(template, @library.cached_templates['users/base'])
+      end
+
+      it 'compiles source without caching it if options is not set' do
+        @context.virtual_path = 'users/base'
+        template = with_configuration :cache_templates, false do
+          @library.compile_template_from_source("attribute :id", @context)
+        end
+
+        assert_empty @library.cached_templates
+      end
+    end
+  end
+end

data/test/{render_test.rb → test_render.rb}

@@ -1,15 +1,16 @@
-require 'test_helper'
+require 'helper'
 require 'pathname'
 require 'tmpdir'
 
-class RenderTest < ActiveSupport::TestCase
+class TestRender < MINITEST_TEST_CLASS
+  @@tmp_path = Pathname.new(Dir.mktmpdir)
 
-  setup do
+  def setup
     @user = User.new(1, 'Marty')
-    @tmp_path = Pathname.new(Dir.mktmpdir)
+    @tmp_path = @@tmp_path
   end
 
-  test "allow object to be passed as an option" do
+  def test_object_as_option
     File.open(@tmp_path + "nil.json.rabl", "w") do |f|
       f.puts %q{
         object :@user
@@ -19,7 +20,7 @@ class RenderTest < ActiveSupport::TestCase
     assert_equal %q({"user":{"name":"Marty"}}), RablRails.render(nil, 'nil', locals: { object: @user }, view_path: @tmp_path)
   end
 
-  test "load source from file" do
+  def test_load_source_from_file
     File.open(@tmp_path + "show.json.rabl", "w") do |f|
       f.puts %q{
         object :@user
@@ -29,11 +30,11 @@ class RenderTest < ActiveSupport::TestCase
     assert_equal %q({"user":{"id":1,"name":"Marty"}}), RablRails.render(@user, 'show', view_path: @tmp_path)
   end
 
-  test "raise error if template is not found" do
+  def test_template_not_found
     assert_raises(RablRails::Renderer::TemplateNotFound) { RablRails.render(@user, 'not_found') }
   end
 
-  test "instance variables can be passed via options[:locals]" do
+  def test_with_locals_options
     File.open(@tmp_path + "instance.json.rabl", "w") do |f|
       f.puts %q{
         object false
@@ -43,7 +44,7 @@ class RenderTest < ActiveSupport::TestCase
     assert_equal %q({"username":"Marty"}), RablRails.render(nil, 'instance', view_path: @tmp_path, locals: { user: @user })
   end
 
-  test "handle path for extends" do
+  def test_extend_with_view_path
     File.open(@tmp_path + "extend.json.rabl", "w") do |f|
       f.puts %q{
         object :@user
@@ -60,7 +61,7 @@ class RenderTest < ActiveSupport::TestCase
     assert_equal %q({"user":{"extended_name":"Marty"}}), RablRails.render(@user, 'extend', view_path: @tmp_path)
   end
 
-  test "format can be passed as symbol or a string" do
+  def test_format_as_symbol_or_string
     File.open(@tmp_path + "show.json.rabl", "w") do |f|
       f.puts %q{
         object :@user
@@ -73,20 +74,13 @@ class RenderTest < ActiveSupport::TestCase
     assert_equal %q({"user":{"id":1,"name":"Marty"}}), RablRails.render(@user, 'show', view_path: @tmp_path, format: 'JSON')
   end
 
-  test "format can be omitted if option is set" do
-    begin
-      RablRails.allow_empty_format_in_template = true
-      File.open(@tmp_path + "show.rabl", "w") do |f|
-        f.puts %q{
-          object :@user
-          attributes :id, :name
-        }
-      end
-
-      assert_equal %q({"user":{"id":1,"name":"Marty"}}), RablRails.render(@user, 'show', view_path: @tmp_path)
-    ensure
-      RablRails.allow_empty_format_in_template = false
+  def test_format_omitted
+    File.open(@tmp_path + "show.rabl", "w") do |f|
+      f.puts %q{
+        object :@user
+        attributes :id, :name
+      }
     end
+    assert_equal %q({"user":{"id":1,"name":"Marty"}}), RablRails.render(@user, 'show', view_path: @tmp_path)
   end
-
 end

metadata

@@ -1,83 +1,71 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: rabl-rails
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 3
-  - 4
-  version: 0.3.4
+version: !ruby/object:Gem::Version
+  version: 0.4.0
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Christopher Cocchi-Perrier
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2014-04-02 00:00:00 +02:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2014-10-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: activesupport
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 3
-        - 1
-        version: "3.1"
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.1'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: railties
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 3
-        - 1
-        version: "3.1"
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.1'
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: actionpack
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 3
-        - 1
-        version: "3.1"
-  type: :development
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: rspec-mocks
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: thread_safe
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.3.1
+  type: :runtime
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
-  type: :development
-  version_requirements: *id004
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.3.1
 description: Fast Rails 3+ templating system with JSON, XML and PList support
-email: 
+email:
 - cocchi.c@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - .travis.yml
 - CHANGELOG.md
@@ -87,70 +75,73 @@ files:
 - Rakefile
 - lib/rabl-rails.rb
 - lib/rabl-rails/compiler.rb
-- lib/rabl-rails/condition.rb
+- lib/rabl-rails/configuration.rb
 - lib/rabl-rails/handler.rb
+- lib/rabl-rails/helpers.rb
 - lib/rabl-rails/library.rb
+- lib/rabl-rails/nodes.rb
+- lib/rabl-rails/nodes/attribute.rb
+- lib/rabl-rails/nodes/child.rb
+- lib/rabl-rails/nodes/code.rb
+- lib/rabl-rails/nodes/condition.rb
+- lib/rabl-rails/nodes/glue.rb
+- lib/rabl-rails/nodes/node.rb
 - lib/rabl-rails/railtie.rb
 - lib/rabl-rails/renderer.rb
-- lib/rabl-rails/renderers/base.rb
+- lib/rabl-rails/renderers/hash.rb
 - lib/rabl-rails/renderers/json.rb
 - lib/rabl-rails/renderers/plist.rb
 - lib/rabl-rails/renderers/xml.rb
 - lib/rabl-rails/responder.rb
 - lib/rabl-rails/template.rb
 - lib/rabl-rails/version.rb
+- lib/rabl-rails/visitors.rb
+- lib/rabl-rails/visitors/to_hash.rb
+- lib/rabl-rails/visitors/visitor.rb
 - lib/tasks/rabl-rails.rake
 - rabl-rails.gemspec
-- test/base_renderer_test.rb
-- test/cache_templates_test.rb
-- test/compiler_test.rb
-- test/deep_nesting_test.rb
-- test/keyword_test.rb
-- test/non_restful_response_test.rb
-- test/render_test.rb
-- test/renderers/json_renderer_test.rb
-- test/renderers/plist_renderer_test.rb
-- test/renderers/xml_renderer_test.rb
-- test/test_helper.rb
-has_rdoc: true
+- test/helper.rb
+- test/renderers/test_hash_renderer.rb
+- test/renderers/test_json_renderer.rb
+- test/renderers/test_plist_renderer.rb
+- test/renderers/test_xml_renderer.rb
+- test/test_compiler.rb
+- test/test_configuration.rb
+- test/test_hash_visitor.rb
+- test/test_library.rb
+- test/test_render.rb
 homepage: https://github.com/ccocchi/rabl-rails
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Fast Rails 3+ templating system with JSON, XML and PList support
-test_files: 
-- test/base_renderer_test.rb
-- test/cache_templates_test.rb
-- test/compiler_test.rb
-- test/deep_nesting_test.rb
-- test/keyword_test.rb
-- test/non_restful_response_test.rb
-- test/render_test.rb
-- test/renderers/json_renderer_test.rb
-- test/renderers/plist_renderer_test.rb
-- test/renderers/xml_renderer_test.rb
-- test/test_helper.rb
+test_files:
+- test/helper.rb
+- test/renderers/test_hash_renderer.rb
+- test/renderers/test_json_renderer.rb
+- test/renderers/test_plist_renderer.rb
+- test/renderers/test_xml_renderer.rb
+- test/test_compiler.rb
+- test/test_configuration.rb
+- test/test_hash_visitor.rb
+- test/test_library.rb
+- test/test_render.rb