props_template 0.21.0 → 0.22.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 23e014144b689057bd6e6cc96a007b17263a2eab2a84890dd822056c2a4e258d
-  data.tar.gz: bba7578e983913d2eeeb15fc12026bb66b25c6da5a8df52c4d2003e8615a2eba
+  metadata.gz: 18da6492527680c8726d4b774e411bda247f6e49d2a992c2d9b9fa1bd9555633
+  data.tar.gz: 391d5b171c9816593f74a681c581075cd426a8eb29827a6a522dc21908e82875
 SHA512:
-  metadata.gz: d1adee8973b67e46c8c2169a7664ec92c0ee52e21451108b449888b8a8dd89221b46d2918da2ace75e016530a7654ce03a513f4f761cb2f6fa938dd76d4a18ed
-  data.tar.gz: 2bc87b68c92e21f4755bf4a41c8ea1290bbfcd94f570fa2cf98b86fc2eecaa9ae83eae0f58042c3ae18cfd9c9f0d0c54caa23b5cff4c92814dfd81b3e306baa0
+  metadata.gz: 8f3d71ec0398e27c05ca134e5dedb0fb96d6c6d5e725b271863bacf9fc907bca4a5b723416305c3051a38d1ec6ee692a9896d1698cf8278191b9804d4e8918c9
+  data.tar.gz: f691118fb075e94b68462652d296ac0e7b2d294a44fe5abc088b3bdac8ef0aa9c4233a84e57a22c5274e10b3ef7f5e8b98d850db4d7cf4054580a96d152bb0a8

data/README.md

@@ -257,8 +257,8 @@ may still need to implement `member_by`.
 ### json.deferred!
 Returns all deferred nodes used by the [deferment](#deferment) option.
 
-**Note** This is a [BreezyJS][1] specific functionality and is used in
-`application.json.props` when first running `rails breezy:install:web`
+**Note** This is a [SuperglueJS][1] specific functionality and is used in
+`application.json.props` when first running `rails superglue:install:web`
 
 
 ```ruby
@@ -267,7 +267,7 @@ json.deferred json.deferred!
 # => [{url: '/some_url?props_at=outer.inner', path: 'outer.inner', type: 'auto'}]
 ```
 
-This method provides metadata about deferred nodes to the frontend ([BreezyJS][1])
+This method provides metadata about deferred nodes to the frontend ([SuperglueJS][1])
 to fetch missing data in a second round trip.
 
 ### json.fragments!
@@ -276,8 +276,8 @@ option.
 
 ```ruby json.fragments json.fragments!  ```
 
-**Note** This is a [BreezyJS][1] specific functionality and is used in
-`application.json.props` when first running `rails breezy:install:web`
+**Note** This is a [SuperglueJS][1] specific functionality and is used in
+`application.json.props` when first running `rails superglue:install:web`
 
 ## Options
 Options Functionality such as Partials, Deferements, and Caching can only be
@@ -311,7 +311,7 @@ end
 ```
 
 ### Partial Fragments
-**Note** This is a [BreezyJS][1] specific functionality.
+**Note** This is a [SuperglueJS][1] specific functionality.
 
 A fragment identifies a partial output across multiple pages. It can be used to
 update cross cutting concerns like a header bar.
@@ -393,7 +393,7 @@ tabbed content that does not load until you click the tab.
 When your client receives the payload, you may issue a second request to the
 same endpoint to fetch any missing nodes. See [traversing nodes](#traversing)
 
-There is also an `defer: :auto` option that you can use with [BreezyJS][1]. [BreezyJS][1]
+There is also an `defer: :auto` option that you can use with [SuperglueJS][1]. [SuperglueJS][1]
 will use the metadata from `json.deferred!` to issue a `remote` dispatch to fetch
 the missing node and immutably graft it at the appropriate keypath in your Redux
 store.
@@ -417,7 +417,7 @@ end
 
 A auto option is available:
 
-**Note** This is a [BreezyJS][1] specific functionality.
+**Note** This is a [SuperglueJS][1] specific functionality.
 
 ```ruby
 json.dashboard(defer: :auto) do
@@ -436,14 +436,14 @@ json.defers json.deferred!
 The default behavior for deferements is to use the index of the collection to
 identify an element.
 
-**Note** If you are using this library with [BreezyJS][1], the `:auto` options will
+**Note** If you are using this library with [SuperglueJS][1], the `:auto` options will
 generate `?props_at=a.b.c.0.title` for `json.deferred!`.
 
 If you wish to use an attribute to identify the element. You must:
 
 1. Use the `:key` option on `json.array!`. This key refers to an attribute on
 your collection item, and is used for `defer: :auto` to generate a keypath for
-[BreezyJS][1]. If you are NOT using BreezyJS, you do not need to do this.
+[SuperglueJS][1]. If you are NOT using SuperglueJS, you do not need to do this.
 
 2. Implement `member_at`, on the [collection](#jsonarray). This will be called
 by PropsTemplate to when [searching nodes](#traversing)
@@ -469,7 +469,7 @@ json.posts
 end
 ```
 
-If you are using [BreezyJS][1], BreezyJS will, it will automatically kick off
+If you are using [SuperglueJS][1], SuperglueJS will, it will automatically kick off
 `remote(?props_at=posts.some_id=1.contact)` and `remote(?props_at=posts.some_id=2.contact)`.
 
 ## Traversing
@@ -596,4 +596,4 @@ See the [CONTRIBUTING] document. Thank you, [contributors]!
 Thanks to [turbostreamer](https://github.com/malomalo/turbostreamer) for the
 inspiration.
 
-[1]: https://github.com/thoughtbot/breezy
+[1]: https://github.com/thoughtbot/superglue

data/lib/props_template/base_with_extensions.rb

@@ -1,11 +1,3 @@
-require 'props_template/base'
-require 'props_template/extensions/partial_renderer'
-require 'props_template/extensions/cache'
-require 'props_template/extensions/deferment'
-require 'props_template/extension_manager'
-require 'active_support/core_ext/string/output_safety'
-require 'active_support/core_ext/array'
-
 module Props
   class BaseWithExtensions < Base
     attr_reader :builder, :context, :fragments, :traveled_path, :deferred, :stream
@@ -28,6 +20,10 @@ module Props
       @em.fragments
     end
 
+    def traveled_path!
+      @traveled_path.join(".")
+    end
+
     def set_block_content!(options = {})
       return super if !@em.has_extensions(options)
 

data/lib/props_template/extension_manager.rb

@@ -1,8 +1,3 @@
-require 'props_template/extensions/partial_renderer'
-require 'props_template/extensions/cache'
-require 'props_template/extensions/deferment'
-require 'props_template/extensions/fragment'
-
 module Props
   class ExtensionManager
     attr_reader :base, :builder, :context

data/lib/props_template/extensions/partial_renderer.rb

@@ -17,6 +17,12 @@ module Props
 
   class Partialer
     INVALID_PARTIAL_MESSAGE = "The partial name must be a string, but received (%s)."
+    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."
+    IDENTIFIER_ERROR_MESSAGE = "The partial name (%s) is not a valid Ruby identifier; " \
+                               "make sure your partial name starts with underscore."
+
 
     def initialize(base, context, builder)
       @context = context
@@ -24,30 +30,28 @@ module Props
       @base = base
     end
 
-    def extract_details(options) # :doc:
-      @context.lookup_context.registered_details.each_with_object({}) do |key, details|
+    def extract_details(options)
+      registered_details.each_with_object({}) do |key, details|
         value = options[key]
 
         details[key] = Array(value) if value
       end
     end
 
+    def registered_details
+      if ActionView.version.to_s >= "7"
+        ActionView::LookupContext.registered_details
+      else
+        @context.lookup_context.registered_details
+      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)
-          .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)
+        template = find_template(partial_opts)
 
         all_options.map do |opts|
           opts[:_template] = template
@@ -58,9 +62,13 @@ 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)
+    def find_template(partial_opts)
+      partial = partial_opts[:partial]
+      template_keys = retrieve_template_keys(partial_opts)
+      details = extract_details(partial_opts)
+
+      prefixes = partial.include?(?/) ? [] : @context.lookup_context.prefixes
+      @context.lookup_context.find_template(partial, prefixes, true, template_keys, details)
     end
 
     def retrieve_template_keys(options)
@@ -75,24 +83,24 @@ module Props
       pass_opts[:locals] ||= {}
       pass_opts[:locals][:json] = @builder
       pass_opts[:partial] = partial
+      pass_opts[:formats] = [:json]
+      pass_opts.delete(:handlers)
 
-      pass_opts
-    end
+      if !(String === partial)
+        raise ArgumentError.new(INVALID_PARTIAL_MESSAGE % (partial.inspect))
+      end
 
-    def refine_options(options, item = nil)
-      PartialRenderer.refine_options(options, item)
+      pass_opts
     end
 
     def handle(options)
-      pass_opts = block_opts_to_render_opts(@builder, options)
-      renderer = PartialRenderer.new(@context, pass_opts)
-      template = options[:_template] || renderer.template
+      partial_opts = block_opts_to_render_opts(@builder, options)
+      template = options[:_template] || find_template(partial_opts)
 
-      renderer.render(template, pass_opts)
+      render_partial(template, @context, partial_opts)
     end
 
-    def render(template, options)
-      view = @context
+    def render_partial(template, view, options)
       instrument(:partial, identifier: template.identifier) do |payload|
         locals = options[:locals]
         content = template.render(view, locals)
@@ -101,33 +109,32 @@ module Props
         build_rendered_template(content, template)
       end
     end
-  end
-
-  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."
-    IDENTIFIER_ERROR_MESSAGE = "The partial name (%s) is not a valid Ruby identifier; " \
-                               "make sure your partial name starts with underscore."
 
-    INVALID_PARTIAL_MESSAGE = "The partial name must be a string, but received (%s)."
+    def build_rendered_template(content, template, layout = nil)
+      RenderedTemplate.new content, layout, template
+    end
 
+    def instrument(name, **options) # :doc:
+      ActiveSupport::Notifications.instrument("render_#{name}.action_view", options) do |payload|
+        yield payload
+      end
+    end
 
-    def self.raise_invalid_option_as(as)
+    def raise_invalid_option_as(as)
       raise ArgumentError.new(OPTION_AS_ERROR_MESSAGE % (as))
     end
 
-    def self.raise_invalid_identifier(path)
+    def raise_invalid_identifier(path)
       raise ArgumentError.new(IDENTIFIER_ERROR_MESSAGE % (path))
     end
 
-    def self.retrieve_variable(path)
+    def retrieve_variable(path)
       base = path[-1] == "/" ? "" : File.basename(path)
       raise_invalid_identifier(path) unless base =~ /\A_?(.*?)(?:\.\w+)*\z/
       $1.to_sym
     end
 
-    def self.refine_options(options, item = nil)
+    def refine_options(options, item = nil)
       return options if !options[:partial]
 
       partial, rest = [*options[:partial]]
@@ -156,78 +163,5 @@ module Props
 
       pass_opts
     end
-
-    attr_reader :template
-
-    def initialize(context, options)
-      @context = context
-      @options = options.merge(formats: [:json])
-      @options.delete(:handlers)
-      @details = extract_details(@options)
-
-      partial = @options[:partial]
-
-      if !(String === partial)
-        raise_invalid_partial(partial.inspect)
-      end
-
-      @path = partial
-
-      template_keys = retrieve_template_keys(@options)
-      @template = find_template(@path, template_keys)
-    end
-
-    def render(template, options)
-      #remove this later
-
-      render_partial(template, @context, @options)
-    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
-        # @variable ||= template.variable
-
-        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
-
-      def build_rendered_template(content, template, layout = nil)
-        RenderedTemplate.new content, layout, template
-      end
-
-      def find_template(path, locals)
-        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 raise_invalid_partial(path)
-        raise ArgumentError.new(INVALID_PARTIAL_MESSAGE % (path))
-      end
   end
 end

data/lib/props_template/searcher.rb

@@ -1,5 +1,3 @@
-require 'props_template/extensions/partial_renderer'
-
 module Props
   class Searcher
     attr_reader :builder, :context, :fragments, :traveled_path

data/lib/props_template/version.rb

@@ -1,3 +1,3 @@
 module Props
-  VERSION = "0.21.0".freeze
+  VERSION = "0.22.1".freeze
 end

data/lib/props_template.rb

@@ -1,4 +1,12 @@
+require 'props_template/base'
+require 'props_template/extensions/partial_renderer'
+require 'props_template/extensions/cache'
+require 'props_template/extensions/deferment'
+require 'props_template/extensions/fragment'
 require 'props_template/base_with_extensions'
+require 'props_template/extension_manager'
+require 'active_support/core_ext/string/output_safety'
+require 'active_support/core_ext/array'
 require 'props_template/searcher'
 require 'props_template/handler'
 require 'props_template/version'
@@ -17,6 +25,7 @@ module Props
       :deferred!,
       :fragments!,
       :set_block_content!,
+      :traveled_path!,
       to: :builder!
 
     def initialize(context = nil, options = {})

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: props_template
 version: !ruby/object:Gem::Version
-  version: 0.21.0
+  version: 0.22.1
 platform: ruby
 authors:
 - Johny Ho
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-01-04 00:00:00.000000000 Z
+date: 2022-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport