rabl-rails 0.6.1 → 0.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4fc57874aa491be7a0c8cc778a9d4e0a307740cf4648c3733d5e49f855eb1cc4
-  data.tar.gz: d4024078d1b780d66a297fb0a2aef0a7e37e6c4db392fa577afa1f16686c595c
+  metadata.gz: ac2d0bc8954f6b27e54002015d71ed0d00f4264c8c1d57411dc789216c627e44
+  data.tar.gz: 98757a9fe142bafb324782725e56e85e3ba83d5a018e76a75cda00c37c73ebf4
 SHA512:
-  metadata.gz: 6b80cd63b8e17d97833f5696d04e82535c154d69b830ea291c7db344c485dead0ffb355cb75a83b1d155b992801f67815a142aa6da2657a4f7ce65820dd7d929
-  data.tar.gz: 05f604364890ce38ab76e311d76c51ce328b2f5bcf1c389b2837f95f17b89c31b7529dcadd42e52d745d11ce1be2e74f8a5a83d2a13e3e9478185a69c5e47d23
+  metadata.gz: d55bc5c73b2add30025cfb41a1735548a236928ca0372c4cbc2aeec731cfbb1db60376c9498570b0ea0a40e9e4c6f79caf32cc474698ad48163845fed5da5d3a
+  data.tar.gz: 4bb4b91c9f4045f94dca99ec126e8fb64389736f675af3ec85466f6c92b75844e1ddc30a8b61633ddce8531ed68d2a7e3b0abf0072a61b48c803f847c6084d28

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 # CHANGELOG
 
+## 0.6.2
+  * Add `fetch` node
+
 ## 0.6.1
   * Fix bug when template contains double quotes
 

data/README.md

@@ -196,6 +196,23 @@ end
 # => { "custom_data": [...] }
 ```
 
+You can use a Hash-like data source, as long as keys match a method or attribute of your main resource, using the `fetch` keyword:
+
+```ruby
+# assuming you have something similar in your controller
+# @users_hash = { 1 => User.new(pseudo: 'Batman') }
+
+# in the view
+object :@post
+
+fetch(:@users_hash, as: :user, field: :user_id) do
+  attributes :pseudo
+end
+# => { user: { pseudo: 'Batman' } }
+```
+
+This comes very handy when adding attributes from external queries not really bound to a relation, like statistics.
+
 ### Constants
 
 Adds a new field to the response using an immutable value.

data/lib/rabl-rails/compiler.rb

@@ -85,6 +85,21 @@ module RablRails
       @template.add_node Nodes::Glue.new(template)
     end
 
+    #
+    # Creates a node to be added to the output by fetching an object using
+    # current resource's field as key to the data, and appliying given
+    # template to said object
+    # Example:
+    #   fetch(:@stats, field: :id) { attributes :total }
+    #
+    def fetch(name_or_data, options = {})
+      data, name  = extract_data_and_name(name_or_data)
+      name        = options[:as] if options.key?(:as)
+      field       = options.fetch(:field, :id)
+      template    = partial_or_block(data, options) { yield }
+      @template.add_node Nodes::Fetch.new(name, template, field)
+    end
+
     #
     # Creates an arbitrary node in the json output.
     # It accepts :if option to create conditionnal nodes. The current data will
@@ -171,7 +186,7 @@ module RablRails
     protected
 
     def partial_or_block(data, options)
-      if options.key?(:partial)
+      if options&.key?(:partial)
         template = Library.instance.compile_template_from_path(options[:partial], @view)
         template.data = data
         template

data/lib/rabl-rails/nodes.rb

@@ -7,3 +7,4 @@ require 'rabl-rails/nodes/condition'
 require 'rabl-rails/nodes/extend'
 require 'rabl-rails/nodes/polymorphic'
 require 'rabl-rails/nodes/lookup'
+require 'rabl-rails/nodes/fetch'

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

@@ -0,0 +1,12 @@
+module RablRails
+  module Nodes
+    class Fetch < Child
+      attr_reader :field
+
+      def initialize(name, template, field)
+        super(name, template)
+        @field = field
+      end
+    end
+  end
+end

data/lib/rabl-rails/version.rb

@@ -1,3 +1,3 @@
 module RablRails
-  VERSION = '0.6.1'
+  VERSION = '0.6.2'
 end

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

@@ -39,6 +39,18 @@ module Visitors
       @_result.merge!(sub_visit(object, n.nodes)) if object
     end
 
+    def visit_Fetch n
+      hash   = object_from_data(_resource, n)
+      key    = _resource.public_send(n.field)
+      object = hash[key]
+
+      @_result[n.name] = if object
+        collection?(object) ? object.map { |o| sub_visit(o, n.nodes) } : sub_visit(object, n.nodes)
+      else
+        nil
+      end
+    end
+
     def visit_Code n
       if !n.condition || instance_exec(_resource, &(n.condition))
         result = instance_exec _resource, &(n.block)

data/test/test_compiler.rb

@@ -180,8 +180,6 @@ class TestCompiler < Minitest::Test
     end
 
     it "compiles child with inline partial notation" do
-
-
       t = @compiler.compile_source(%{child(:user, :partial => 'user') })
       child_node = t.nodes.first
 
@@ -232,6 +230,29 @@ class TestCompiler < Minitest::Test
       assert_equal([{ :id => :id }], extract_attributes(glue_node.nodes))
     end
 
+    it "compiles fetch with record association" do
+      t = @compiler.compile_source(%{ fetch :address do attributes :foo end})
+
+      assert_equal(1, t.nodes.size)
+      fetch_node = t.nodes.first
+
+      assert_equal(:address, fetch_node.name)
+      assert_equal(:address, fetch_node.data)
+      assert_equal(:id, fetch_node.field)
+      assert_equal([{ foo: :foo }], extract_attributes(fetch_node.nodes))
+    end
+
+    it "compiles fetch with options" do
+      t = @compiler.compile_source(%{
+        fetch(:user, as: :author, field: :uid) do attributes :foo end
+      })
+
+      fetch_node = t.nodes.first
+      assert_equal(:author, fetch_node.name)
+      assert_equal(:user, fetch_node.data)
+      assert_equal(:uid, fetch_node.field)
+    end
+
     it "compiles constant node" do
       t = @compiler.compile_source(%{
         const(:locale, 'fr_FR')

data/test/test_hash_visitor.rb

@@ -105,6 +105,17 @@ class TestHashVisitor < Minitest::Test
       assert_equal({ name: 'Marty'}, visitor_result)
     end
 
+    it 'renders fetch node' do
+      template = RablRails::CompiledTemplate.new
+      template.add_node(RablRails::Nodes::Attribute.new(name: :name))
+      template.data = :@users_hash
+
+      @nodes << RablRails::Nodes::Fetch.new(:user, template, :id)
+      @context.assigns['users_hash'] = { @resource.id => @resource }
+
+      assert_equal({ user: { name: 'Marty' } }, visitor_result)
+    end
+
     describe 'with a code node' do
       before do
         @proc = ->(object) { object.name }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rabl-rails
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.6.2
 platform: ruby
 authors:
 - Christopher Cocchi-Perrier
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-05 00:00:00.000000000 Z
+date: 2021-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -114,6 +114,7 @@ files:
 - lib/rabl-rails/nodes/condition.rb
 - lib/rabl-rails/nodes/const.rb
 - lib/rabl-rails/nodes/extend.rb
+- lib/rabl-rails/nodes/fetch.rb
 - lib/rabl-rails/nodes/glue.rb
 - lib/rabl-rails/nodes/lookup.rb
 - lib/rabl-rails/nodes/polymorphic.rb
@@ -158,7 +159,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Fast Rails 4+ templating system with JSON, XML and PList support