rabl-rails 0.4.1 → 0.4.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2874d3a8bc282b5f68501b4b20a238a764a7a50e
+  data.tar.gz: 84d6d590864951016038bee486096ef7637efc5f
+SHA512:
+  metadata.gz: 6022f49acacdc484fc278c2e770db3f418f89602c17821d83e06339c824228fe4990e37aa9e197cf402155caad62fd35474ac522d2b13aff71e537e13708ed8e
+  data.tar.gz: cfbc8c2ae6a2f39a1202ec502c6a4fa1d7d0a39952633ac6f27375865ef764f974cfa438168c49d623833816ca71b33dcfe583b482542a0e4d6679f5c71380d8

data/.travis.yml

@@ -3,6 +3,7 @@ env:
   - "RAILS_VERSION=3.2.0"
   - "RAILS_VERSION=4.0.0"
   - "RAILS_VERSION=4.1.0"
+  - "RAILS_VERSION=4.2.0"
 rvm:
   - 1.9.3
   - jruby-19mode

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## 0.4.2
+  * Allow to pass locals to partials
+  * Add condition to `attributes`
+
 ## 0.4.1
   * Make classes that should not be treated as collection configurable
   * Internal change to determine rendering format

data/Gemfile

@@ -8,7 +8,7 @@ rails = case rails_version
 when 'master'
   { github: 'rails/rails' }
 when "default"
-  '~> 3.2.0'
+  '~> 4.2.0'
 else
   "~> #{rails_version}"
 end
@@ -35,4 +35,3 @@ end
 platforms :jruby do
   gem 'nokogiri'
 end
-

data/README.md

@@ -168,6 +168,11 @@ attributes title: :foo, to_s: :bar
 # => { "foo" : <title value>, "bar" : <to_s value> }
 ```
 
+or show attributes only if a condition is true
+```ruby
+attributes :published_at, :anchor, if: ->(post) { post.published? }
+```
+
 ### Child nodes
 
 You can include informations from data associated with the parent model or arbitrary data. These informations can be grouped under a node or directly merged into current node.
@@ -242,8 +247,11 @@ Often objects have a basic representation that is shared accross different views
 attributes :id, :name
 
 # app/views/users/private.json.rabl
-extends 'users/base'
 attributes :super_secret_attribute
+
+extends 'users/base'
+# or using partial instead of extends
+# merge { |u| partial('users/base', object: u) }
 ```
 
 You can also extends template in child nodes using `partial` option (this is the same as using `extends` in the child block)
@@ -262,6 +270,17 @@ node(:location) do |user|
 end
 ```
 
+When used within `node`, partials can take locals variables that can be accessed in the included template.
+```ruby
+# base.json.rabl
+node(:credit_card, if: ->(u) { locals[:display_credit_card] }) do |user|
+  user.credit_card_info
+end
+
+# user.json.rabl
+merge { |u| partial('users/base', object: u, locals: { display_credit_card: true }) }
+
+
 ### Nesting
 
 Rabl allow you to define easily your templates, even with hierarchy of 2 or 3 levels. Let's suppose your have a `thread` model that has many `posts` and that each post has many `comments`. We can display a full thread in a few lines

data/lib/rabl-rails/compiler.rb

@@ -51,6 +51,7 @@ module RablRails
           key = options[:as] || name
           node[key] = name
         }
+        node.condition = options[:if]
       end
 
       @template.add_node node
@@ -172,4 +173,4 @@ module RablRails
       @template = old_template
     end
   end
-end
+end

data/lib/rabl-rails/nodes/attribute.rb

@@ -7,11 +7,12 @@ module RablRails
       extend Forwardable
 
       def_delegators :@hash, :[]=, :each
-      attr_reader :hash
+      attr_reader   :hash
+      attr_accessor :condition
 
       def initialize(hash = {})
         @hash = hash
       end
     end
   end
-end
+end

data/lib/rabl-rails/version.rb

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

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

@@ -8,6 +8,7 @@ module Visitors
       @_context  = view_context
       @_result   = {}
       @_resource = resource
+      @_locals   = {}
 
       copy_instance_variables_from_context
     end
@@ -22,7 +23,9 @@ module Visitors
     end
 
     def visit_Attribute n
-      n.each { |k, v| @_result[k] = _resource.send(v) }
+      if !n.condition || instance_exec(_resource, &(n.condition))
+        n.each { |k, v| @_result[k] = _resource.send(v) }
+      end
     end
 
     def visit_Child n
@@ -83,6 +86,10 @@ module Visitors
       @_context.respond_to?(name) ? @_context.send(name, *args, &block) : super
     end
 
+    def locals
+      @_locals
+    end
+
     #
     # Allow to use partial inside of node blocks (they are evaluated at
     # rendering time).
@@ -90,6 +97,7 @@ module Visitors
     def partial(template_path, options = {})
       raise RablRails::Renderer::PartialError.new("No object was given to partial #{template_path}") unless options[:object]
       object = options[:object]
+      @_locals = options[:locals].freeze
 
       return [] if object.respond_to?(:empty?) && object.empty?
 
@@ -99,6 +107,8 @@ module Visitors
       else
         sub_visit object, template.nodes
       end
+    ensure
+      @_locals = {}
     end
 
     private
@@ -128,4 +138,4 @@ module Visitors
       end
     end
   end
-end
+end

data/test/test_compiler.rb

@@ -113,6 +113,12 @@ class TestCompiler < MINITEST_TEST_CLASS
       assert_equal([{ :bar => :foo, :uid => :id }], extract_attributes(t.nodes))
     end
 
+    it "compiles attribtues with a condition" do
+      t = @compiler.compile_source(%( attributes :id, if: ->(o) { false } ))
+      assert_equal([{ id: :id }], extract_attributes(t.nodes))
+      refute_nil t.nodes.first.condition
+    end
+
     it "compiles child with record association" do
       t = @compiler.compile_source(%{ child :address do attributes :foo end})
 
@@ -280,4 +286,4 @@ class TestCompiler < MINITEST_TEST_CLASS
       end
     end
   end
-end
+end

data/test/test_hash_visitor.rb

@@ -24,6 +24,13 @@ class TestHashVisitor < MINITEST_TEST_CLASS
       assert_equal({ id: 1 }, visitor_result)
     end
 
+    it 'renders attributes with a condition' do
+      n = RablRails::Nodes::Attribute.new(id: :id)
+      n.condition = lambda { |o| false }
+      @nodes << n
+      assert_equal({}, visitor_result)
+    end
+
     it 'renders array of nodes' do
       @nodes = [
         RablRails::Nodes::Attribute.new(id: :id),
@@ -153,7 +160,7 @@ class TestHashVisitor < MINITEST_TEST_CLASS
       assert_raises(RablRails::Renderer::PartialError) { visitor_result }
     end
 
-    it 'renders partial defined in code node' do
+    it 'renders partial defined in node' do
       template = RablRails::CompiledTemplate.new
       template.add_node(RablRails::Nodes::Attribute.new(name: :name))
       proc = ->(u) { partial('users/base', object: u) }
@@ -169,6 +176,22 @@ class TestHashVisitor < MINITEST_TEST_CLASS
       library.verify
     end
 
+    it 'allows uses of locals variables with partials' do
+      template = RablRails::CompiledTemplate.new
+      template.add_node(RablRails::Nodes::Code.new(:hide_comments, ->(u) { locals[:hide_comments] }, ->(u) { locals.key?(:hide_comments) }))
+      proc = ->(u) { partial('users/locals', object: u, locals: { hide_comments: true }) }
+
+      library = MiniTest::Mock.new
+      library.expect :compile_template_from_path, template, ['users/locals', @context]
+
+      @nodes << RablRails::Nodes::Code.new(:user, proc)
+      RablRails::Library.stub :instance, library do
+        assert_equal({ user: { hide_comments: true } }, 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)
@@ -221,4 +244,4 @@ class TestHashVisitor < MINITEST_TEST_CLASS
       end
     end
   end
-end
+end

metadata

@@ -1,62 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: rabl-rails
 version: !ruby/object:Gem::Version
-  version: 0.4.1
-  prerelease: 
+  version: 0.4.2
 platform: ruby
 authors:
 - Christopher Cocchi-Perrier
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-28 00:00:00.000000000 Z
+date: 2016-01-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.1'
   type: :runtime
   prerelease: false
   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
   prerelease: false
   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
   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
@@ -66,8 +59,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - MIT-LICENSE
@@ -113,27 +106,26 @@ files:
 - test/test_render.rb
 homepage: https://github.com/ccocchi/rabl-rails
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 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.8.23
+rubygems_version: 2.4.5
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Fast Rails 3+ templating system with JSON, XML and PList support
 test_files:
 - test/helper.rb
@@ -147,3 +139,4 @@ test_files:
 - test/test_helpers.rb
 - test/test_library.rb
 - test/test_render.rb
+has_rdoc: