props_template 0.21.1 → 0.22.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fe0d4afac65f1f86e1adfdcc956cc21d6df96a54e55e1ab26c8fa450c6a2a7be
-  data.tar.gz: ea96579bc3d06512867d4c11ee619051a205d64e814e5fe643debd5085d2b56e
+  metadata.gz: 536af22bcde36c372950f99d9bc6a71ce5767c2a7f2736641554613e71d0e52d
+  data.tar.gz: a271f7be2ba091d137aa10fbae9143b6ec53789cfefe94f9936ad8fc594273b5
 SHA512:
-  metadata.gz: 363ed26b474344ec9e17b328521d10a2e226761272e80f49e72b32e6943f47e3e970d7939e0923548984e96a1cb361ff3e74beebfa058dabe86db4a683e48746
-  data.tar.gz: d99478adad2b0980ce471f992c32d8a8fb0ee4348c469cb7e25b3752c6e44c0181f4beb31bc14a65efafe4d3250588ad8b0d9713eade62ee48107a3072dafbfa
+  metadata.gz: '0038a530eeaeebdcc541cfbd36d807f7b40d4324a04d290971c2dd8f9996daf2d39e8e4f2db226de89bc86f1641ae15902637fc623fe5a6a82dd89ccb88a6313'
+  data.tar.gz: c52fc5c39f851665cf81393d86bed834f3c9c239b2135d887dc6ccc1979437b521443c975250fc911b883959d3558a9fada74ff7a6593712520cdd982a9e1d83

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,14 +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; " \
+    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 initialize(base, context, builder)
       @context = context

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.1".freeze
+  VERSION = "0.22.0".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.1
+  version: 0.22.0
 platform: ruby
 authors:
 - Johny Ho
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-01-06 00:00:00.000000000 Z
+date: 2022-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport