props_template 0.16.0 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: abee2de45e7fc076a1edad8c9d3edd9f13b3335e0946d6d227fcc4e5370a9e60
-  data.tar.gz: 20bb87744d490b3cae705a1514a965b07ec04cfdc99c5f7deafb627c00fb7484
+  metadata.gz: 4d36bdd3007d7932d78d70eaa76a69e84caea142098f8bff3a1df72b6c57bba8
+  data.tar.gz: 40f592a3801bc47ad1fe620845813f476df1d25a4ab08d3ae611bff7024af363
 SHA512:
-  metadata.gz: 84b19f30e105c344ea37f0db00524804f998ba01ab84e0cd2f5c47e7c9324061096fd9b089df310a9cfc7a25980b72b01cb2c397649d3ce6ba24e9ca1fc7fd94
-  data.tar.gz: 07257d4609fb4ebbce6621dd804f87abe1b28ab336a41ea1d092611d973d3ea905134b5ad0d690ed9496c62758318825034b1f99b3668b09b3aa7046f49fc9c3
+  metadata.gz: f6ec9ff34ea8fa3a99b243d6ef7c7e87da1c5c6ad5c43c570b311cd73372e70905fa6b84a7a05fe09d53435768261afd7213695a4c508cbcc10cdf7929bb8e5d
+  data.tar.gz: 4a58228230f74446c5c2a449f2c3ce023c47b292a4ed9bb22bae4864bdba441365b3e49e1d02d7fe857497c3dc8534e23c89b19f9ddb5d326357b623c6062f93

data/README.md

@@ -213,7 +213,7 @@ json.posts
 end
 ```
 
-PropsTemplate does not know what the elements are in your collection. The example above will be fine for [traversing](props-template.md#traversing_nodes) by index `\posts?bzq=posts.0`, but will raise a `NotImplementedError` if you traverse by attribute `/posts?bzq=posts.id=1`. You may still need a delegate that implements `member_by`.
+PropsTemplate does not know what the elements are in your collection. The example above will be fine for [traversing](props-template.md#traversing_nodes) by index `\posts?bzq=posts.0`, but will raise a `NotImplementedError` if you query by attribute `/posts?bzq=posts.id=1`. You may still need a delegate that implements `member_by`.
 
 ### json.deferred!
 Returns all deferred nodes used by the [#deferment](#deferment) option.
@@ -233,16 +233,6 @@ json.fragments json.fragments!
 
 This method is normally used in `application.json.props` when first generated by `rails breezy:install:web`
 
-### json.fragment_digest!
-
-Returns the digest of the current partial name and the locals passed. Useful for [optimistic updates](#optimistic-updates).
-
-```ruby
-# _some_partial.json.props
-
-json.digest json.fragment_digest!
-```
-
 ## Options
 Functionality such as Partials, Deferements, and Caching can only be set on a block. It is normal to see empty blocks.
 
@@ -305,42 +295,6 @@ json.header partial: ["profile", fragment: 'me_header'] do
 end
 ```
 
-#### Optimisitc Updates
-Breezy uses the digest generated by `fragment: true` to uniquely identify a partial across the redux state. If you need to optimistically update a fragment, use `json.fragment_digest!` to obtain the identifier in your partial, and `updateFragments` from BreezyJS.
-
-For example:
-
-```ruby
-# _header.js.props
-json.fragment_digest json.fragment_digest!
-```
-
-And in your reducer
-
-```javacript
-import {updateFragments} from 'jho406/Breezy';
-
-switch(action.type) {
-case SOME_ACTION: {
-  const {
-    fragmentDigest,
-    prevNode // <- the content of the _header.js.props
-  } = action.payload
-
-  const nextNode = {
-    ...prevNode,
-    foo: 'bar'
-  }
-
-  return updateFragments(state, {
-    [fragmentDigest]: nextNode
-  })
-}
-default:
-  return state
-}
-```
-
 ### Caching
 Caching is supported on any node.
 
@@ -418,7 +372,7 @@ json.defers json.deferred!
 ```
 
 
-If `:manual` is used, PropsTemplate will no-op the block and will not populate `json.deferred!`. Its up to you to [traverse](props-template.md#traversing_nodes) to fetch the node seperately. A common usecase would be tab content that does not load until you click the tab.
+If `:manual` is used, PropsTemplate will no-op the block and will not populate `json.deferred!`. Its up to you to [query](props-template.md#traversing_nodes) to fetch the node seperately. A common usecase would be tab content that does not load until you click the tab.
 
 #### Working with arrays
 The default behavior for deferements is to use the index of the collection to identify an element. PropsTemplate will generate `?_bzq=a.b.c.0.title` in its metadata.

data/lib/props_template.rb

@@ -16,7 +16,6 @@ module Props
       :deferred!,
       :fragments!,
       :set_block_content!,
-      :fragment_digest!,
       to: :builder!
 
     def initialize(context = nil, options = {})

data/lib/props_template/base_with_extensions.rb

@@ -28,10 +28,6 @@ module Props
       @em.fragments
     end
 
-    def fragment_digest!
-      @em.fragment_digest
-    end
-
     def set_block_content!(options = {})
       return super if !@em.has_extensions(options)
 

data/lib/props_template/extension_manager.rb

@@ -7,7 +7,7 @@ module Props
   class ExtensionManager
     attr_reader :base, :builder, :context
 
-    def initialize(base, defered=[], fragments={})
+    def initialize(base, defered=[], fragments=[])
       @base = base
       @context = base.context
       @builder = base.builder
@@ -36,10 +36,6 @@ module Props
       @deferment.deferred
     end
 
-    def fragment_digest
-      @fragment.name
-    end
-
     def fragments
       @fragment.fragments
     end
@@ -59,10 +55,8 @@ module Props
         handle_cache(options) do
           base.set_block_content! do
             if options[:partial]
-              current_digest = @fragment.name
               @fragment.handle(options)
               @partialer.handle(options)
-              @fragment.name = current_digest
             else
               yield
             end
@@ -104,14 +98,7 @@ module Props
           next_deferred, next_fragments = Oj.load(meta)
           base.stream.push_json(raw_json)
           deferred.push(*next_deferred)
-
-          next_fragments.each do |k, v|
-            if fragments[k]
-              fragments[k].push(*v)
-            else
-              fragments[k] = v
-            end
-          end
+          fragments.push(*next_fragments)
         end
       else
         yield

data/lib/props_template/extensions/cache.rb

@@ -25,12 +25,6 @@ module Props
       @context
     end
 
-    def instrument(name, **options)
-      ActiveSupport::Notifications.instrument(name, options) do |payload|
-        yield payload
-      end
-    end
-
     def multi_fetch(keys, options = {})
       result = {}
       key_to_ckey = {}
@@ -49,7 +43,7 @@ module Props
 
       read_caches = {}
 
-      instrument('read_multi_fragments.action_view', payload) do |payload|
+      ActiveSupport::Notifications.instrument('read_multi_fragments.action_view', payload) do |payload|
         read_caches = ::Rails.cache.read_multi(*ckeys, options)
         payload[:read_caches] = read_caches
       end
@@ -122,7 +116,7 @@ module Props
 
     def cache_key(key, options)
       name_options = options.slice(:skip_digest, :virtual_path)
-      key = fragment_name_with_digest(key, name_options)
+      key = @context.cache_fragment_name(key, **name_options)
 
       if @context.respond_to?(:combined_fragment_cache_key)
         key = @context.combined_fragment_cache_key(key)
@@ -132,19 +126,6 @@ module Props
 
       ::ActiveSupport::Cache.expand_cache_key(key, :props)
     end
-
-    def fragment_name_with_digest(key, options)
-      if @context.respond_to?(:cache_fragment_name)
-        # Current compatibility, fragment_name_with_digest is private again and cache_fragment_name
-        # should be used instead.
-        @context.cache_fragment_name(key, options)
-      elsif @context.respond_to?(:fragment_name_with_digest)
-        # Backwards compatibility for period of time when fragment_name_with_digest was made public.
-        @context.fragment_name_with_digest(key)
-      else
-        key
-      end
-    end
   end
 end
 

data/lib/props_template/extensions/deferment.rb

@@ -34,6 +34,8 @@ module Props
 
       type, rest = options[:defer]
       placeholder = rest[:placeholder]
+      success_action = rest[:success_action]
+      fail_action = rest[:fail_action]
 
       if type.to_sym == :auto && options[:key]
         key, val = options[:key]
@@ -50,11 +52,17 @@ module Props
 
       uri.query = ::URI.encode_www_form(qry)
 
-      @deferred.push(
+      deferral = {
         url: uri.to_s,
         path: path,
-        type: type.to_s
-      )
+        type: type.to_s,
+      }
+
+      # camelize for JS land
+      deferral[:successAction] = success_action if success_action
+      deferral[:failAction] = fail_action if fail_action
+
+      @deferred.push(deferral)
 
       placeholder
     end

data/lib/props_template/extensions/fragment.rb

@@ -1,14 +1,10 @@
-require 'digest'
-
 module Props
   class Fragment
     attr_reader :fragments
-    attr_accessor :name
 
-    def initialize(base, fragments={})
+    def initialize(base, fragments=[])
       @base = base
       @fragments = fragments
-      @digest = Digest::SHA2.new(256)
     end
 
     def handle(options)
@@ -20,30 +16,10 @@ module Props
         fragment_name = fragment.to_s
         path = @base.traveled_path.join('.')
         @name = fragment_name
-        @fragments[fragment_name] ||= []
-        @fragments[fragment_name].push(path)
-      end
-
-      if fragment == true
-        locals = partial_opts[:locals]
 
-        identity = {}
-        locals
-          .clone
-          .tap{|h| h.delete(:json)}
-          .each do |key, value|
-            if value.respond_to?(:to_global_id)
-              identity[key] = value.to_global_id.to_s
-            else
-              identity[key] = value
-            end
-          end
-
-        path = @base.traveled_path.join('.')
-        fragment_name = @digest.hexdigest("#{partial_name}#{identity.to_json}")
-        @name = fragment_name
-        @fragments[fragment_name] ||= []
-        @fragments[fragment_name].push(path)
+        @fragments.push(
+          { type: fragment_name, partial: partial_name, path: path }
+        )
       end
     end
   end

data/lib/props_template/extensions/partial_renderer.rb

@@ -1,22 +1,56 @@
 require 'action_view'
 
 module Props
+  class RenderedTemplate
+    attr_reader :body, :layout, :template
+
+    def initialize(body, layout, template)
+      @body = body
+      @layout = layout
+      @template = template
+    end
+
+    def format
+      template.format
+    end
+  end
+
   class Partialer
+    INVALID_PARTIAL_MESSAGE = "The partial name must be a string, but received (%s)."
+
     def initialize(base, context, builder)
       @context = context
       @builder = builder
       @base = base
     end
 
+    def extract_details(options) # :doc:
+      @context.lookup_context.registered_details.each_with_object({}) do |key, details|
+        value = options[key]
+
+        details[key] = Array(value) if value
+      end
+    end
+
     def find_and_add_template(all_options)
       first_opts = all_options[0]
 
       if first_opts[:partial]
         partial_opts = block_opts_to_render_opts(@builder, first_opts)
-        renderer = PartialRenderer.new(@context, partial_opts)
+          .merge(formats: [:json])
+        partial_opts.delete(:handlers)
+        partial = partial_opts[:partial]
+
+        if !(String === partial)
+          raise ArgumentError.new(INVALID_PARTIAL_MESSAGE % (partial.inspect))
+        end
+
+        template_keys = retrieve_template_keys(partial_opts)
+        details = extract_details(partial_opts)
+        template = find_template(partial, template_keys, details)
 
         all_options.map do |opts|
-          opts[:_template] = renderer.template
+          opts[:_template] = template
           opts
         end
       else
@@ -24,6 +58,17 @@ module Props
       end
     end
 
+    def find_template(path, locals, details)
+      prefixes = path.include?(?/) ? [] : @context.lookup_context.prefixes
+      @context.lookup_context.find_template(path, prefixes, true, locals, details)
+    end
+
+    def retrieve_template_keys(options)
+      template_keys = options[:locals].keys
+      template_keys << options[:as] if options[:as]
+      template_keys
+    end
+
     def block_opts_to_render_opts(builder, options)
       partial, pass_opts = [*options[:partial]]
       pass_opts ||= {}
@@ -45,9 +90,20 @@ module Props
 
       renderer.render(template, pass_opts)
     end
+
+    def render(template, options)
+      view = @context
+      instrument(:partial, identifier: template.identifier) do |payload|
+        locals = options[:locals]
+        content = template.render(view, locals)
+
+        payload[:cache_hit] = view.view_renderer.cache_hits[template.virtual_path]
+        build_rendered_template(content, template)
+      end
+    end
   end
 
-  class PartialRenderer < ActionView::AbstractRenderer
+  class PartialRenderer
     OPTION_AS_ERROR_MESSAGE  = "The value (%s) of the option `as` is not a valid Ruby identifier; " \
                                "make sure it starts with lowercase letter, " \
                                "and is followed by any combination of letters, numbers and underscores."
@@ -56,21 +112,6 @@ module Props
 
     INVALID_PARTIAL_MESSAGE = "The partial name must be a string, but received (%s)."
 
-    def self.find_and_add_template(builder, context, all_options)
-      first_opts = all_options[0]
-
-      if first_opts[:partial]
-        partial_opts = block_opts_to_render_opts(builder, first_opts)
-        renderer = new(context, partial_opts)
-
-        all_options.map do |opts|
-          opts[:_template] = renderer.template
-          opts
-        end
-      else
-        all_options
-      end
-    end
 
     def self.raise_invalid_option_as(as)
       raise ArgumentError.new(OPTION_AS_ERROR_MESSAGE % (as))
@@ -106,8 +147,7 @@ module Props
         locals[as] = item
 
         if fragment_name = rest[:fragment]
-          fragment_name = Proc === fragment_name ? fragment_name.call(item) : fragment_name.to_s
-          rest[:fragment] = fragment_name
+          rest[:fragment] = fragment_name.to_s
         end
       end
 
@@ -121,7 +161,6 @@ module Props
 
     def initialize(context, options)
       @context = context
-      super(@context.lookup_context)
       @options = options.merge(formats: [:json])
       @options.delete(:handlers)
       @details = extract_details(@options)
@@ -133,7 +172,7 @@ module Props
       end
 
       @path = partial
-      @context_prefix = @lookup_context.prefixes.first
+
       template_keys = retrieve_template_keys(@options)
       @template = find_template(@path, template_keys)
     end
@@ -145,6 +184,19 @@ module Props
     end
 
     private
+      def extract_details(options) # :doc:
+        @context.lookup_context.registered_details.each_with_object({}) do |key, details|
+          value = options[key]
+
+          details[key] = Array(value) if value
+        end
+      end
+
+      def instrument(name, **options) # :doc:
+        ActiveSupport::Notifications.instrument("render_#{name}.action_view", options) do |payload|
+          yield payload
+        end
+      end
 
       def render_partial(template, view, options)
         template ||= @template
@@ -159,17 +211,13 @@ module Props
         end
       end
 
-      # Sets up instance variables needed for rendering a partial. This method
-      # finds the options and details and extracts them. The method also contains
-      # logic that handles the type of object passed in as the partial.
-      #
-      # If +options[:partial]+ is a string, then the <tt>@path</tt> instance variable is
-      # set to that string. Otherwise, the +options[:partial]+ object must
-      # respond to +to_partial_path+ in order to setup the path.
+      def build_rendered_template(content, template, layout = nil)
+        RenderedTemplate.new content, layout, template
+      end
 
       def find_template(path, locals)
-        prefixes = path.include?(?/) ? [] : @lookup_context.prefixes
-        @lookup_context.find_template(path, prefixes, true, locals, @details)
+        prefixes = path.include?(?/) ? [] : @context.lookup_context.prefixes
+        @context.lookup_context.find_template(path, prefixes, true, locals, @details)
       end
 
       def retrieve_template_keys(options)

data/lib/props_template/searcher.rb

@@ -23,9 +23,6 @@ module Props
       []
     end
 
-    def fragment_digest!
-    end
-
     def found!
       pass_opts = @found_options.clone || {}
       pass_opts.delete(:defer)

data/spec/layout_spec.rb

@@ -1,16 +1,24 @@
-require_relative './support/helper'
-require_relative './support/rails_helper'
-require 'props_template/layout_patch'
+require_relative "./support/helper"
+require_relative "./support/rails_helper"
+require "props_template/layout_patch"
+require "action_controller"
 
-RSpec.describe 'Props::Template' do
-  it 'uses a layout to render' do
-    view_path = File.join(File.dirname(__FILE__),'./fixtures')
-    controller = ActionView::TestCase::TestController.new
+RSpec.describe "Props::Template" do
+  class TestController < ActionController::Base
+    protect_from_forgery
+
+    def self.controller_path
+      ""
+    end
+  end
+
+  it "uses a layout to render" do
+    view_path = File.join(File.dirname(__FILE__), "./fixtures")
+    controller = TestController.new
     controller.prepend_view_path(view_path)
-    controller.response.headers['Content-Type']='application/json'
-    controller.request.path = '/some_url'
 
-    json = controller.render('200', layout: 'application')
+    json = controller.render_to_string("200", layout: "application")
+
     expect(json.strip).to eql('{"data":{"success":"ok"}}')
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: props_template
 version: !ruby/object:Gem::Version
-  version: 0.16.0
+  version: 0.17.0
 platform: ruby
 authors:
 - Johny Ho
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-07-25 00:00:00.000000000 Z
+date: 2021-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -96,7 +96,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key:
 specification_version: 4
 summary: A JSON builder for your React props