Add support for fragment context

This commit was missing from the 2.0 release and includes several related
improvements:

1. Adds fragmentContext to allow digging using props_at to find a node, then
considering what fragment it was found in, returns a `found_path` that can
be used in a graft response's `path`. We'll need to replace the generated
files in superglue_rails

2. Modifies `fragments!` to return paths that are relative to the data being
presented. So instead of `data.a.deep.path.in.page` it returns. `data.a.deep.path.in.response`
with the latter being much shorter.

Author: jho406

lib/props_template.rb

@@ -30,11 +30,14 @@ class << self
       :disable_deferments!,
       :set_block_content!,
       :traveled_path!,
+      :fragment_context!,
       to: :builder!
 
     def initialize(context = nil, options = {})
       @builder = BaseWithExtensions.new(self, context, options)
       @context = context
+      @fragment_context = nil
+      @found_path = []
     end
 
     def set!(key, options = {}, &block)
@@ -48,7 +51,9 @@ def set!(key, options = {}, &block)
         options.delete(:dig)
 
         @builder.set!(key, options, &block)
-        found_block, found_options = @builder.found!
+        found_block, found_path, found_options, fragment_context = @builder.found!
+        @found_path = found_path || []
+        @fragment_context = fragment_context
         @builder = prev_builder
 
         if found_block
@@ -59,6 +64,14 @@ def set!(key, options = {}, &block)
       end
     end
 
+    def found_path!
+      @found_path.join(".")
+    end
+
+    def fragment_context!
+      @fragment_context
+    end
+
     def builder!
       @builder
     end

lib/props_template/base_with_extensions.rb

@@ -55,15 +55,16 @@ def set!(key, options = {}, &block)
         options = @em.refine_options(options)
       end
 
-      super(key, options, &block)
+      super
     end
 
     def handle_set_block(key, options)
-      @traveled_path.push(key)
       n = 1
       if (suffix = options[:path_suffix])
         n += suffix.length
         @traveled_path.push(suffix)
+      else
+        @traveled_path.push(key)
       end
 
       super

lib/props_template/extensions/fragment.rb

@@ -7,18 +7,28 @@ def initialize(base, fragments = [])
       @fragments = fragments
     end
 
-    def handle(options)
+    def self.fragment_name_from_options(options)
       return if !options[:partial]
-      _partial_name, partial_opts = options[:partial]
+
+      _, partial_opts = [*options[:partial]]
+      return unless partial_opts
+
       fragment = partial_opts[:fragment]
 
       if String === fragment || Symbol === fragment
-        key = fragment.to_s
-        path = @base.traveled_path.join(".")
-        @name =key 
+        fragment.to_s
+      end
+    end
+
+    def handle(options)
+      fragment_name = self.class.fragment_name_from_options(options)
+      path = @base.traveled_path
+        .map { |item| item.is_a?(Array) ? item[0] : item }
+        .join(".")
 
+      if fragment_name
         @fragments.push(
-          {id: key, path: path}
+          {id: fragment_name, path: path}
         )
       end
     end

lib/props_template/searcher.rb

@@ -11,6 +11,7 @@ def initialize(builder, path = [], context = nil)
       @builder = builder
       @traveled_path = []
       @partialer = Partialer.new(self, context, builder)
+      @fragment_name = nil
     end
 
     def deferred!
@@ -24,12 +25,19 @@ def fragments!
     def found!
       pass_opts = @found_options.clone || {}
       pass_opts.delete(:defer)
-      traveled_path = @traveled_path[1..] || []
+      traveled_path = @traveled_path || []
       if !traveled_path.empty?
         pass_opts[:path_suffix] = traveled_path
       end
 
-      [@found_block, pass_opts]
+      fragment_name = Fragment.fragment_name_from_options(pass_opts)
+      if fragment_name
+        @fragment_name = fragment_name
+        @traveled_path = []
+      end
+
+      fragment_context = @fragment_name
+      [@found_block, @traveled_path, pass_opts, fragment_context]
     end
 
     def set_block_content!(*args)
@@ -50,6 +58,12 @@ def set!(key, options = {}, &block)
 
         @depth += 1
         if options[:partial]
+          fragment_name = Fragment.fragment_name_from_options(options)
+          if fragment_name
+            @fragment_name = fragment_name
+            @traveled_path = []
+          end
+
           @partialer.handle(options)
         else
           yield
@@ -94,6 +108,11 @@ def array!(collection = nil, options = {}, &block)
 
           @depth += 1
           if pass_opts[:partial]
+            fragment_name = Fragment.fragment_name_from_options(pass_opts)
+            if fragment_name
+              @fragment_name = fragment_name
+              @traveled_path = []
+            end
             # todo: what happens when cached: true is passed?
             # would there be any problems with not using the collection_rende?
             @partialer.handle(pass_opts)
@@ -105,7 +124,7 @@ def array!(collection = nil, options = {}, &block)
       end
     end
 
-    def child!(options={}, &block)
+    def child!(options = {}, &block)
       return if @found_block
 
       child_index = @child_index || -1
@@ -128,7 +147,7 @@ def child!(options={}, &block)
         @depth -= 1
       end
 
-      @child_index = child_index    
+      @child_index = child_index
     end
   end
 end

spec/extensions/prop_template_search_spec.rb

@@ -25,7 +25,7 @@
       foo: "bar"
     })
   end
-  
+
   it "aliases dig to search and finds the correct node and merges it to the top" do
     json = render(<<~PROPS)
       json.data(search: ['data', 'comment', 'details']) do
@@ -447,6 +447,106 @@
       })
     end
 
+    context "fragment context" do
+      it "renders the fragment context" do
+        json = render(<<~PROPS)
+          json.data(dig: ['data', 'comment']) do
+            json.comment(partial: ['comment', fragment: 'foobar']) do
+            end
+          end
+          json.fragments json.fragments!
+          json.fragmentContext json.fragment_context!
+          json.path json.traveled_path!
+        PROPS
+
+        expect(json).to eql_json({
+          data: {
+            title: "some title",
+            details: {
+              body: "hello world"
+            }
+          },
+          fragments: [
+            {id: "foobar", path: "data"}
+          ],
+          fragmentContext: "foobar",
+          path: ""
+        })
+      end
+
+      it "renders the fragment context with a grafting path relative to the key" do
+        json = render(<<~PROPS)
+          json.data(dig: ['data', 'comment', 'details']) do
+            json.comment(partial: ['comment', fragment: 'foobar']) do
+            end
+          end
+          json.fragments json.fragments!
+          json.fragmentContext json.fragment_context!
+          json.path json.found_path!
+        PROPS
+
+        expect(json).to eql_json({
+          data: {
+            body: "hello world"
+          },
+          fragments: [],
+          fragmentContext: "foobar",
+          path: "details"
+        })
+      end
+
+      it "renders the fragment context for an array item relative to the key" do
+        json = render(<<~PROPS)
+          json.data(dig: ['data','comment', 0]) do
+            json.comment do
+              json.array! [0], {partial: ['comment', fragment: ->(item){ "foo-"+item.to_s }]} do
+              end
+            end
+          end
+          json.fragments json.fragments!
+          json.fragment_context json.fragment_context!
+          json.path json.found_path!
+        PROPS
+
+        expect(json).to eql_json({
+          data: {
+            title: "some title",
+            details: {
+              body: "hello world"
+            }
+          },
+          fragments: [
+            {id: "foo-0", path: "data"}
+          ],
+          fragment_context: "foo-0",
+          path: ""
+        })
+      end
+
+      it "renders the fragment context for an array item relative to the key" do
+        json = render(<<~PROPS)
+          json.data(dig: ['data','comment', 0, 'details']) do
+            json.comment do
+              json.array! [0], {partial: ['comment', fragment: ->(item){ "foo-"+item.to_s }]} do
+              end
+            end
+          end
+          json.fragments json.fragments!
+          json.fragment_context json.fragment_context!
+          json.path json.found_path!
+        PROPS
+
+        expect(json).to eql_json({
+          data: {
+            body: "hello world"
+          },
+          fragments: [],
+          fragment_context: "foo-0",
+          path: "details"
+        })
+      end
+    end
+
     it "passes the found child obj options back to the parent" do
       json = render(<<~PROPS)
         json.data(dig: ['data', 'comment']) do

spec/searcher_spec.rb

@@ -24,11 +24,12 @@ def member_by(key, value)
       end
     end
 
-    found_block, found_options = json.found!
+    found_block, found_path, found_options = json.found!
     expect(found_block).to eql(target_proc)
+    expect(found_path).to eql ["outer", "inner", "hit"]
     expect(found_options).to eql({
       some_options: 1,
-      path_suffix: ["inner", "hit"]
+      path_suffix: ["outer", "inner", "hit"]
     })
   end
 
@@ -134,8 +135,9 @@ def member_by(key, value)
       end
     end
 
-    found_block, found_options = json.found!
-    expect(found_options).to eql({some_options: 1, path_suffix: [1]})
+    found_block, found_path, found_options = json.found!
+    expect(found_options).to eql({some_options: 1, path_suffix: ["outer", 1]})
+    expect(found_path).to eql(["outer", 1])
     expect(found_block.call).to eql("world")
   end