superglue 1.0.1 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8e9624774c0133d0a9d8aac0d8b5d47bbb95862eea0bb1a26ffe3ce373c5e922
-  data.tar.gz: 8c69fd808df13768c9036981ca27d2a0b24eb9ce8ab8d890c88b666cc9bd5798
+  metadata.gz: 1a1ecd4f618637e57a20279cf0ccf2b4cfc51abee634c6f9e6fab5f2e334f94f
+  data.tar.gz: ad15a0fbed3e89f2df027d0fcf35a92c2ff74ce347b5c637d246f49802d2cce7
 SHA512:
-  metadata.gz: 17522e020054291483b60953d3fa31e60d6b95de4316ce7469ed71e7f397fa15b07533051b4a4266d5263313a947e7b3eb82621d1d0f8dd45088b9db77295cdf
-  data.tar.gz: 97e27d5f9330ac515cd1636af3c9974584476a324d142573176187dd3cf18a7e6db696cec11ba473f8b5f7fc3d8849fa9fbc49d14f359ef9373d5ec75b763d56
+  metadata.gz: 1aa8dc1714f3d23f223a4ac647b8e28fb500cab716c7669597a2b10837f2d320872bc9c23223d654872223006a32863217fb91d64c007b833380facd795dd0cf
+  data.tar.gz: '009249d735d62c2737eb9b39e67c01368c2ec2345932061e2bada5f086ca9a9db33a842bd7572b5546fc561cecedd0d46c98448c9fbf61b17843d1a41e26ad90'

data/lib/generators/superglue/install/install_generator.rb

@@ -16,6 +16,8 @@ module Superglue
         remove_file "#{app_js_path}/application.js"
 
         use_typescript = options["typescript"]
+        copy_erb_files
+
         if use_typescript
           copy_ts_files
         else
@@ -31,6 +33,9 @@ module Superglue
         say "Adding required member methods to ApplicationRecord"
         add_member_methods
 
+        say "Enabling jsx rendering defaults"
+        insert_jsx_rendering_defaults
+
         say "Installing Superglue and friends"
         run "yarn add react react-dom @reduxjs/toolkit react-redux @thoughtbot/superglue"
 
@@ -43,6 +48,45 @@ module Superglue
 
       private
 
+      def insert_jsx_rendering_defaults
+        inject_into_file "app/controllers/application_controller.rb", after: "class ApplicationController < ActionController::Base\n" do
+          <<-RUBY
+  # Enables Superglue rendering defaults for sensible view directories.
+  #
+  # without `use_jsx_rendering_defaults`:
+  #
+  # ```
+  # app/views/posts/
+  #  - index.jsx
+  #  - index.json.props
+  #  - index.html.erb
+  # ```
+  #
+  # with `use_jsx_rendering_defaults`:
+  #
+  # ```
+  # app/views/posts/
+  #   - index.jsx
+  #   - index.json.props
+  # ```
+  #
+  # before_action :use_jsx_rendering_defaults
+  #
+  #
+  # The html template used when `use_jsx_rendering_defaults` is enabled.
+  # Defaults to "application/superglue".
+  #
+  # superglue_template "application/superglue"
+
+          RUBY
+        end
+      end
+
+      def copy_erb_files
+        say "Copying superglue.html.erb file to app/views/application/"
+        copy_file "#{__dir__}/templates/erb/superglue.html.erb", "app/views/application/superglue.html.erb"
+      end
+
       def copy_ts_files
         say "Copying application.tsx file to #{app_js_path}"
         copy_file "#{__dir__}/templates/ts/application.tsx", "#{app_js_path}/application.tsx"

data/lib/generators/superglue/install/templates/erb/superglue.html.erb

@@ -0,0 +1,5 @@
+<script type="text/javascript">
+  window.SUPERGLUE_INITIAL_PAGE_STATE=<%= render_props %>;<%# erblint:disable ErbSafety %>
+</script>
+
+<div id="app"></div>

data/lib/generators/superglue/scaffold_controller/scaffold_controller_generator.rb

@@ -25,7 +25,11 @@ module Superglue
       argument :attributes, type: :array, default: [], banner: "field:type field:type"
 
       def create_controller_files
-        template "controller.rb", File.join("app/controllers", controller_class_path, "#{controller_file_name}_controller.rb")
+        controller_file = File.join("app/controllers", controller_class_path, "#{controller_file_name}_controller.rb")
+        template "controller.rb", controller_file
+        inject_into_file controller_file, after: /ApplicationController$/ do
+          "\n  before_action :use_jsx_rendering_defaults"
+        end
       end
 
       # Replaces template_engine (and its default erb), with view_collection

data/lib/generators/superglue/view_collection/view_collection_generator.rb

@@ -21,14 +21,6 @@ module Superglue
         empty_directory path unless File.directory?(path)
       end
 
-      def copy_erb_files
-        available_views.each do |view|
-          @action_name = view
-          filename = filename_with_html_extensions(view)
-          template "erb/" + filename, File.join("app/views", controller_file_path, filename)
-        end
-      end
-
       def copy_prop_files
         available_views.each do |view|
           @action_name = view

data/lib/superglue/rendering.rb

@@ -0,0 +1,88 @@
+require "active_support/concern"
+
+module Superglue
+  module Rendering
+    class UnsupportedOption < StandardError; end
+
+    extend ActiveSupport::Concern
+
+    included do |base|
+      base.class_attribute :_superglue_template, instance_accessor: true, default: "application/superglue"
+    end
+
+    class_methods do
+      def superglue_template(template)
+        self._superglue_template = template
+      end
+    end
+
+    def _render_template(options = {})
+      if @_capture_options_before_render
+        @_capture_options_before_render = false
+
+        if options.keys.intersect? [:file, :partial, :body, :plain, :html, :inline]
+          raise UnsupportedOption.new("`template:` and `action:` are the only options supported with `use_jsx_rendering_defaults`")
+        end
+
+        @_render_options = options
+        _ensure_react_page!(options[:template], options[:prefixes])
+
+        html_template_exist = template_exists?(options[:template], options[:prefixes], false)
+        if !html_template_exist
+          super(options.merge(
+            template: _superglue_template,
+            prefixes: []
+          ))
+        else
+          super
+        end
+      else
+        super
+      end
+    end
+
+    def render(...)
+      if _jsx_defaults
+        @_capture_options_before_render = true
+      end
+
+      super
+    end
+
+    def use_jsx_rendering_defaults
+      @_use_jsx_rendering_defaults = true
+    end
+
+    def _jsx_defaults
+      @_use_jsx_rendering_defaults && request.format.html?
+    end
+
+    def _ensure_react_page!(template, prefixes)
+      lookup_context.find(template, prefixes, false, [], formats: [], handlers: [], variants: [], locale: [])
+    end
+
+    def default_render
+      if _jsx_defaults
+        render
+      else
+        super
+      end
+    end
+
+    def render_props
+      if @_render_options
+        options = @_render_options
+
+        if template_exists?(options[:template], options[:prefixes], formats: [:json])
+          _render_template(options.merge({formats: [:json], layout: _layout_for_option(true)})).strip.html_safe
+        else
+          options.delete(:template)
+          options.delete(:action)
+          _render_template(options.merge({inline: "", formats: [:json], layout: _layout_for_option(true)})).strip.html_safe
+        end
+      else
+        ""
+      end
+    end
+  end
+end

data/lib/superglue/resolver.rb

@@ -0,0 +1,58 @@
+require 'action_view'
+
+module Superglue
+  class Resolver < ActionView::FileSystemResolver
+    class JsxPathParser < ActionView::Resolver::PathParser
+      REACT_FORMATS = [:tsx, :jsx]
+
+      def build_path_regex
+        formats = Regexp.union(REACT_FORMATS.map(&:to_s))
+
+        %r{
+          \A
+          (?:(?<prefix>.*)/)?
+          (?<action>.*?)
+          (?:\.(?<format>#{formats}))??
+          \z
+        }x
+      end
+
+      def parse(path)
+        @regex ||= build_path_regex
+        match = @regex.match(path)
+        path = ActionView::TemplatePath.build(match[:action], match[:prefix] || "", false)
+        details = ActionView::TemplateDetails.new(
+          nil,
+          nil,
+          match[:format]&.to_sym,
+          nil
+        )
+        ParsedPath.new(path, details)
+      end
+    end
+
+    def initialize(path)
+      raise ArgumentError, "path already is a Resolver class" if path.is_a?(ActionView::Resolver)
+      @unbound_templates = Concurrent::Map.new
+      @path_parser = JsxPathParser.new
+      @path = File.expand_path(path)
+    end
+
+    def clear_cache
+      @unbound_templates.clear
+      @path_parser = JsxPathParser.new
+    end
+
+    def source_for_template(template)
+      "''"
+    end
+
+    def filter_and_sort_by_details(templates, requested_details)
+      if requested_details.formats.empty?
+        templates
+      else
+        []
+      end
+    end
+  end
+end

data/lib/superglue.rb

@@ -1,5 +1,7 @@
 require "superglue/helpers"
 require "superglue/redirection"
+require "superglue/rendering"
+require "superglue/resolver"
 require "props_template"
 require "form_props"
 
@@ -9,8 +11,10 @@ module Superglue
     include Helpers
 
     def self.included(base)
+      base.include ::Superglue::Rendering
       if base.respond_to?(:helper_method)
         base.helper_method :param_to_dig_path
+        base.helper_method :render_props
       end
     end
   end
@@ -19,18 +23,16 @@ module Superglue
     config.superglue = ActiveSupport::OrderedOptions.new
     config.superglue.auto_include = true
 
-    generators do |app|
-      Rails::Generators.configure! app.config.generators
-      Rails::Generators.hidden_namespaces.uniq!
-      require "generators/rails/scaffold_controller_generator"
-    end
-
     initializer :superglue do |app|
       ActiveSupport.on_load(:action_controller) do
         next if self != ActionController::Base
 
         if app.config.superglue.auto_include
           include Controller
+
+          prepend_view_path(
+            Superglue::Resolver.new(Rails.root.join("app/views"))
+          )
         end
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: superglue
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.1
 platform: ruby
 authors:
 - Johny Ho
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-01-13 00:00:00.000000000 Z
+date: 2025-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -67,6 +67,7 @@ files:
 - README.md
 - lib/generators/superglue/install/install_generator.rb
 - lib/generators/superglue/install/templates/application.json.props
+- lib/generators/superglue/install/templates/erb/superglue.html.erb
 - lib/generators/superglue/install/templates/initializer.rb
 - lib/generators/superglue/install/templates/js/application.jsx
 - lib/generators/superglue/install/templates/js/application_visit.js
@@ -88,10 +89,6 @@ files:
 - lib/generators/superglue/install/templates/ts/tsconfig.json
 - lib/generators/superglue/scaffold/scaffold_generator.rb
 - lib/generators/superglue/scaffold_controller/scaffold_controller_generator.rb
-- lib/generators/superglue/view_collection/templates/erb/edit.html.erb
-- lib/generators/superglue/view_collection/templates/erb/index.html.erb
-- lib/generators/superglue/view_collection/templates/erb/new.html.erb
-- lib/generators/superglue/view_collection/templates/erb/show.html.erb
 - lib/generators/superglue/view_collection/templates/js/edit.jsx
 - lib/generators/superglue/view_collection/templates/js/index.jsx
 - lib/generators/superglue/view_collection/templates/js/new.jsx
@@ -109,6 +106,8 @@ files:
 - lib/superglue.rb
 - lib/superglue/helpers.rb
 - lib/superglue/redirection.rb
+- lib/superglue/rendering.rb
+- lib/superglue/resolver.rb
 homepage: https://github.com/thoughtbot/superglue_rails/
 licenses:
 - MIT

data/lib/generators/superglue/view_collection/templates/erb/edit.html.erb

@@ -1,10 +0,0 @@
-<%% 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 %>;<%%# erblint:disable ErbSafety %>
-</script>
-
-<%%# If you need SSR follow instructions at %>
-<%%# https://github.com/thoughtbot/superglue/blob/main/docs/recipes/server-side-rendering.md %>
-<div id="app"></div>
-

data/lib/generators/superglue/view_collection/templates/erb/index.html.erb

@@ -1,9 +0,0 @@
-<%% 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 %>;<%%# erblint:disable ErbSafety %>
-</script>
-
-<%%# If you need SSR follow instructions at %>
-<%%# https://github.com/thoughtbot/superglue/blob/main/docs/recipes/server-side-rendering.md %>
-<div id="app"></div>

data/lib/generators/superglue/view_collection/templates/erb/new.html.erb

@@ -1,9 +0,0 @@
-<%% 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 %>;<%%# erblint:disable ErbSafety %>
-</script>
-
-<%%# If you need SSR follow instructions at %>
-<%%# https://github.com/thoughtbot/superglue/blob/main/docs/recipes/server-side-rendering.md %>
-<div id="app"></div>

data/lib/generators/superglue/view_collection/templates/erb/show.html.erb

@@ -1,9 +0,0 @@
-<%% 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 %>;<%%# erblint:disable ErbSafety %>
-</script>
-
-<%%# If you need SSR follow instructions at %>
-<%%# https://github.com/thoughtbot/superglue/blob/main/docs/recipes/server-side-rendering.md %>
-<div id="app"></div>