Use form_props active_template_virtual_path (#39)

This reverts an earlier removal of of the method `virtual_path_of_template`. Unfortunately, a combination of `controller_path` and `action_name` caused some unintended consequences of some actions rendering the wrong template. Using `controller_path` and `action_name` would've been a nice way to DRY things up, but we're going to revert for now until we find a better method.
thoughtbot · Dec 10, 2023 · 857fb88 · 857fb88
1 parent 39b8e44
commit 857fb88
Show file tree

Hide file tree

Showing 10 changed files with 12 additions and 64 deletions.
diff --git a/docs/_sidebar.md b/docs/_sidebar.md
@@ -25,7 +25,6 @@
 
 - Recipes
   - [Modals](recipes/modals.md)
-  - [Default HTML template](recipes/default-html-template.md)
   - [Server-Side Rendering](recipes/server-side-rendering.md)
   - [Loading content later](recipes/load-content-later.md)
   - [Loading a tab onClick](recipes/load-tab-onclick.md)

diff --git a/docs/page-response.md b/docs/page-response.md
@@ -29,12 +29,12 @@ merged when [navigating](./react-redux.md#navigateto)
 
 ### `componentIdentifier`
 A `string` to instruct Superglue which component to render. The generated
-`application.json.props` will set this to the `controller_path` and
-`action_name`, but you can customize this to fit your needs.
+`application.json.props` will set this to the `active_template_virtual_path`
+(added by [props_template]), but you can customize this to fit your needs.
 
 ```ruby
 # application.json.props
-json.componentIdentifier "#{controller_path}/#{action_name}"
+json.componentIdentifier active_template_virtual_path
 ```
 
 You can control which `componentIdentifier` will render which component in the
@@ -100,3 +100,5 @@ An object merged with the `initialState` when implementing `buildStore` inside
 of `application.js`. You can use this as the initial state for redux slices.
 Take advantage of the `SAVE_RESPONSE` to continually update your slice everytime
 superglue recieves a new page request.
+
+[props_template]: https://github.com/thoughtbot/props_template
diff --git a/docs/recipes/default-html-template.md b/docs/recipes/default-html-template.md
diff --git a/docs/tutorial.md b/docs/tutorial.md
@@ -140,7 +140,7 @@ superglue knows which component to render with which response by modifying
 <!-- tabs:start -->
 #### **Example greet.json**
 The layout for `show.json.props` is located at `app/views/layouts/application.json.props`. It
-conforms to superglue's [payload] response, and uses the `controller_path` and `action` as the
+conforms to superglue's [payload] response, and uses the `active_template_virtual_path` as the
 `componentIdentifier`.
 
 ```json

diff --git a/superglue_rails/lib/generators/rails/templates/web/edit.html.erb b/superglue_rails/lib/generators/rails/templates/web/edit.html.erb
@@ -1,4 +1,4 @@
-<%% initial_state = controller.render_to_string(formats: [:json], locals: local_assigns, layout: true) %>
+<%% initial_state = controller.render_to_string(active_template_virtual_path, formats: [:json], locals: local_assigns, layout: true) %>
 
 <script type="text/javascript">
   window.SUPERGLUE_INITIAL_PAGE_STATE=<%%= initial_state.html_safe %>;

diff --git a/superglue_rails/lib/generators/rails/templates/web/index.html.erb b/superglue_rails/lib/generators/rails/templates/web/index.html.erb
@@ -1,4 +1,4 @@
-<%% initial_state = controller.render_to_string(formats: [:json], locals: local_assigns, layout: true) %>
+<%% initial_state = controller.render_to_string(active_template_virtual_path, formats: [:json], locals: local_assigns, layout: true) %>
 
 <script type="text/javascript">
   window.SUPERGLUE_INITIAL_PAGE_STATE=<%%= initial_state.html_safe %>;

diff --git a/superglue_rails/lib/generators/rails/templates/web/new.html.erb b/superglue_rails/lib/generators/rails/templates/web/new.html.erb
@@ -1,4 +1,4 @@
-<%% initial_state = controller.render_to_string(formats: [:json], locals: local_assigns, layout: true) %>
+<%% initial_state = controller.render_to_string(active_template_virtual_path, formats: [:json], locals: local_assigns, layout: true) %>
 
 <script type="text/javascript">
   window.SUPERGLUE_INITIAL_PAGE_STATE=<%%= initial_state.html_safe %>;

diff --git a/superglue_rails/lib/generators/rails/templates/web/show.html.erb b/superglue_rails/lib/generators/rails/templates/web/show.html.erb
@@ -1,4 +1,4 @@
-<%% initial_state = controller.render_to_string(formats: [:json], locals: local_assigns, layout: true) %>
+<%% initial_state = controller.render_to_string(active_template_virtual_path, formats: [:json], locals: local_assigns, layout: true) %>
 
 <script type="text/javascript">
   window.SUPERGLUE_INITIAL_PAGE_STATE=<%%= initial_state.html_safe %>;

diff --git a/superglue_rails/lib/install/templates/web/application.json.props b/superglue_rails/lib/install/templates/web/application.json.props
@@ -4,7 +4,7 @@ json.data(search: path) do
   yield json
 end
 
-json.componentIdentifier "#{controller_path}/#{action_name}"
+json.componentIdentifier active_template_virtual_path
 json.defers json.deferred!
 json.fragments json.fragments!
 json.assets [ asset_path('application.js') ]

diff --git a/superglue_rails/superglue.gemspec b/superglue_rails/superglue.gemspec
@@ -12,7 +12,7 @@ Gem::Specification.new do |s|
   s.files = Dir["MIT-LICENSE", "README.md", "lib/**/*", "app/**/*"]
 
   s.add_dependency "actionpack", ">= 7.0.0"
-  s.add_dependency "props_template", ">= 0.31.0"
+  s.add_dependency "props_template", ">= 0.32.0"
   s.add_dependency "form_props", ">= 0.0.5"
 
   s.add_development_dependency "activerecord", ">= 7.0"