superglue 0.54.0 → 1.0.1

data/lib/superglue/helpers.rb

@@ -14,7 +14,7 @@ module Superglue
       end
     end
 
-    def param_to_search_path(param)
+    def param_to_dig_path(param)
       if param
         param
           .gsub(/[^\da-zA-Z_=.]+/, "")

data/lib/superglue.rb

@@ -1,6 +1,7 @@
 require "superglue/helpers"
 require "superglue/redirection"
 require "props_template"
+require "form_props"
 
 module Superglue
   module Controller
@@ -9,7 +10,7 @@ module Superglue
 
     def self.included(base)
       if base.respond_to?(:helper_method)
-        base.helper_method :param_to_search_path
+        base.helper_method :param_to_dig_path
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: superglue
 version: !ruby/object:Gem::Version
-  version: 0.54.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Johny Ho
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-09 00:00:00.000000000 Z
+date: 2025-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -16,79 +16,100 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 7.0.0
+        version: '7.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 7.0.0
+        version: '7.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
 - !ruby/object:Gem::Dependency
   name: props_template
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.32.0
+        version: '0.37'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.32.0
+        version: '0.37'
 - !ruby/object:Gem::Dependency
   name: form_props
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.5
+        version: '0.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.5
+        version: '0.2'
 description: Rails integration for SuperglueJS
 email: jho406@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/generators/rails/scaffold_controller_generator.rb
-- lib/generators/rails/superglue_generator.rb
-- lib/generators/rails/templates/_form.json.props
-- lib/generators/rails/templates/controller.rb.tt
-- lib/generators/rails/templates/edit.json.props
-- lib/generators/rails/templates/index.json.props
-- lib/generators/rails/templates/new.json.props
-- lib/generators/rails/templates/show.json.props
-- lib/generators/rails/templates/web/edit.html.erb
-- lib/generators/rails/templates/web/edit.js
-- lib/generators/rails/templates/web/index.html.erb
-- lib/generators/rails/templates/web/index.js
-- lib/generators/rails/templates/web/new.html.erb
-- lib/generators/rails/templates/web/new.js
-- lib/generators/rails/templates/web/show.html.erb
-- lib/generators/rails/templates/web/show.js
-- lib/install/templates/web/actions.js
-- lib/install/templates/web/application.js
-- lib/install/templates/web/application.json.props
-- lib/install/templates/web/application_visit.js
-- lib/install/templates/web/flash.js
-- lib/install/templates/web/initializer.rb
-- lib/install/templates/web/page_to_page_mapping.js
-- lib/install/templates/web/pages.js
-- lib/install/templates/web/store.js
-- lib/install/web.rb
+- README.md
+- lib/generators/superglue/install/install_generator.rb
+- lib/generators/superglue/install/templates/application.json.props
+- lib/generators/superglue/install/templates/initializer.rb
+- lib/generators/superglue/install/templates/js/application.jsx
+- lib/generators/superglue/install/templates/js/application_visit.js
+- lib/generators/superglue/install/templates/js/components.js
+- lib/generators/superglue/install/templates/js/flash.js
+- lib/generators/superglue/install/templates/js/inputs.jsx
+- lib/generators/superglue/install/templates/js/jsconfig.json
+- lib/generators/superglue/install/templates/js/layout.jsx
+- lib/generators/superglue/install/templates/js/page_to_page_mapping.js
+- lib/generators/superglue/install/templates/js/store.js
+- lib/generators/superglue/install/templates/ts/application.tsx
+- lib/generators/superglue/install/templates/ts/application_visit.ts
+- lib/generators/superglue/install/templates/ts/components.ts
+- lib/generators/superglue/install/templates/ts/flash.ts
+- lib/generators/superglue/install/templates/ts/inputs.tsx
+- lib/generators/superglue/install/templates/ts/layout.tsx
+- lib/generators/superglue/install/templates/ts/page_to_page_mapping.ts
+- lib/generators/superglue/install/templates/ts/store.ts
+- 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
+- lib/generators/superglue/view_collection/templates/js/show.jsx
+- lib/generators/superglue/view_collection/templates/props/_form.json.props
+- lib/generators/superglue/view_collection/templates/props/edit.json.props
+- lib/generators/superglue/view_collection/templates/props/index.json.props
+- lib/generators/superglue/view_collection/templates/props/new.json.props
+- lib/generators/superglue/view_collection/templates/props/show.json.props
+- lib/generators/superglue/view_collection/templates/ts/edit.tsx
+- lib/generators/superglue/view_collection/templates/ts/index.tsx
+- lib/generators/superglue/view_collection/templates/ts/new.tsx
+- lib/generators/superglue/view_collection/templates/ts/show.tsx
+- lib/generators/superglue/view_collection/view_collection_generator.rb
 - lib/superglue.rb
 - lib/superglue/helpers.rb
 - lib/superglue/redirection.rb
-- lib/tasks/install.rake
-homepage: https://github.com/thoughtbot/superglue/
+homepage: https://github.com/thoughtbot/superglue_rails/
 licenses:
 - MIT
 metadata: {}
@@ -107,7 +128,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.6
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
 summary: Rails integration for SuperglueJS

data/lib/generators/rails/scaffold_controller_generator.rb

@@ -1,12 +0,0 @@
-require "rails/generators"
-require "rails/generators/rails/scaffold_controller/scaffold_controller_generator"
-
-module Rails
-  module Generators
-    class ScaffoldControllerGenerator
-      source_paths << File.expand_path("../templates", __FILE__)
-
-      hook_for :superglue, type: :boolean, default: true
-    end
-  end
-end

data/lib/generators/rails/superglue_generator.rb

@@ -1,98 +0,0 @@
-require "rails/generators/named_base"
-require "rails/generators/resource_helpers"
-
-module Rails
-  module Generators
-    class SuperglueGenerator < NamedBase
-      include Rails::Generators::ResourceHelpers
-
-      source_root File.expand_path("../templates", __FILE__)
-
-      argument :attributes, type: :array, default: [], banner: "field:type field:type"
-
-      def create_root_folder
-        path = File.join("app/views", controller_file_path)
-        empty_directory path unless File.directory?(path)
-      end
-
-      def copy_view_files
-        %w[index show new edit].each do |view|
-          @action_name = view
-          filename = filename_with_extensions(view)
-          template filename, File.join("app/views", controller_file_path, filename)
-        end
-        template "_form.json.props", File.join("app/views", controller_file_path, "_form.json.props")
-
-        %w[index show new edit].each do |view|
-          @action_name = view
-          filename = filename_with_js_extensions(view)
-          template "web/" + filename, File.join("app/views", controller_file_path, filename)
-        end
-
-        %w[index show new edit].each do |view|
-          @action_name = view
-          filename = filename_with_html_extensions(view)
-          template "web/" + filename, File.join("app/views", controller_file_path, filename)
-        end
-
-        %w[index show new edit].each do |view|
-          append_mapping(view)
-        end
-      end
-
-      protected
-
-      def view_path
-        "../views"
-      end
-
-      def app_js_path
-        "app/javascript/"
-      end
-
-      def append_mapping(action)
-        app_js = "#{app_js_path}/page_to_page_mapping.js"
-
-        component_name = [plural_table_name, action].map(&:camelcase).join
-
-        prepend_to_file app_js do
-          "\nimport #{component_name} from '#{view_path}/#{controller_file_path}/#{action}'"
-        end
-
-        inject_into_file app_js, after: "pageIdentifierToPageComponent = {" do
-          "\n  '#{[controller_file_path, action].join("/")}': #{component_name},"
-        end
-      end
-
-      attr_reader :action_name
-
-      def attributes_names
-        [:id] + super
-      end
-
-      def filename_with_extensions(name)
-        [name, :json, :props].join(".")
-      end
-
-      def filename_with_js_extensions(name)
-        [name, :js].join(".")
-      end
-
-      def filename_with_html_extensions(name)
-        [name, :html, :erb].join(".")
-      end
-
-      def attributes_list_with_timestamps
-        attributes_list(attributes_names + %w[created_at updated_at])
-      end
-
-      def attributes_list(attributes = attributes_names)
-        if self.attributes.any? { |attr| attr.name == "password" && attr.type == :digest }
-          attributes = attributes.reject { |name| %w[password password_confirmation].include? name }
-        end
-
-        attributes
-      end
-    end
-  end
-end

data/lib/generators/rails/templates/controller.rb.tt

@@ -1,68 +0,0 @@
-<% if namespaced? -%>
-require_dependency "<%= namespaced_path %>/application_controller"
-
-<% end -%>
-<% module_namespacing do -%>
-class <%= controller_class_name %>Controller < ApplicationController
-  before_action :set_<%= singular_table_name %>, only: [:show, :edit, :update, :destroy]
-
-  # GET <%= route_url %>
-  def index
-    @<%= plural_table_name %> = <%= orm_class.all(class_name) %>
-  end
-
-  # GET <%= route_url %>/1
-  def show
-  end
-
-  # GET <%= route_url %>/new
-  def new
-    @<%= singular_table_name %> = <%= orm_class.build(class_name) %>
-  end
-
-  # GET <%= route_url %>/1/edit
-  def edit
-  end
-
-  # POST <%= route_url %>
-  def create
-    @<%= singular_table_name %> = <%= orm_class.build(class_name, "#{singular_table_name}_params") %>
-
-    if @<%= orm_instance.save %>
-      redirect_to @<%= singular_table_name %>, notice: <%= "'#{human_name} was successfully created.'" %>
-    else
-      render :new
-    end
-  end
-
-  # PATCH/PUT <%= route_url %>/1
-  def update
-    if @<%= orm_instance.update("#{singular_table_name}_params") %>
-      redirect_to @<%= singular_table_name %>, notice: <%= "'#{human_name} was successfully updated.'" %>
-    else
-      render :edit
-    end
-  end
-
-  # DELETE <%= route_url %>/1
-  def destroy
-    @<%= orm_instance.destroy %>
-    redirect_to <%= index_helper %>_url, notice: <%= "'#{human_name} was successfully destroyed.'" %>
-  end
-
-  private
-    # Use callbacks to share common setup or constraints between actions.
-    def set_<%= singular_table_name %>
-      @<%= singular_table_name %> = <%= orm_class.find(class_name, "params[:id]") %>
-    end
-
-    # Only allow a trusted parameter "white list" through.
-    def <%= "#{singular_table_name}_params" %>
-      <%- if attributes_names.empty? -%>
-      params.fetch(:<%= singular_table_name %>, {})
-      <%- else -%>
-      params.require(:<%= singular_table_name %>).permit(<%= attributes_names.map { |name| ":#{name}" }.join(', ') %>)
-      <%- end -%>
-    end
-end
-<% end -%>

data/lib/generators/rails/templates/edit.json.props

@@ -1,12 +0,0 @@
-if @<%= singular_table_name %>.errors.any?
-  json.errors({
-    explanation: "#{pluralize(@<%= singular_table_name %>.errors.count, "error")} prohibited this <%= singular_table_name %> from being saved:",
-    messages: @<%= singular_table_name %>.errors.full_messages.map{|msg| {body: msg}}
-  })
-end
-
-json.form(partial: 'form') do
-end
-
-json.<%= singular_table_name.camelize(:lower)%>Path <%= singular_table_name%>_path(@<%=singular_table_name%>)
-json.<%= plural_table_name.camelize(:lower) %>Path <%= plural_table_name %>_path

data/lib/generators/rails/templates/index.json.props

@@ -1,14 +0,0 @@
-json.<%= plural_table_name.camelize(:lower) %> do
-  json.array! @<%= plural_table_name %> do |<%= singular_table_name %>|
-    <%- attributes_list_with_timestamps.each do |attr| -%>
-    json.<%=attr%> <%= singular_table_name.camelize(:lower) %>.<%=attr%>
-    <%- end -%>
-    json.edit<%=singular_table_name.camelize%>Path edit_<%=singular_table_name%>_path(<%=singular_table_name%>)
-    json.<%=singular_table_name.camelize(:lower)%>Path <%=singular_table_name%>_path(<%=singular_table_name%>)
-    json.deleteForm do
-      form_props(model: <%=singular_table_name%>, method: :delete)
-    end
-  end
-end
-
-json.new<%= singular_table_name.camelize %>Path new_<%= singular_table_name %>_path

data/lib/generators/rails/templates/new.json.props

@@ -1,13 +0,0 @@
-if @<%= singular_table_name %>.errors.any?
-  json.errors({
-    explanation: "#{pluralize(@<%= singular_table_name %>.errors.count, "error")} prohibited this <%= singular_table_name %> from being saved:",
-    messages: @<%= singular_table_name %>.errors.full_messages.map{|msg| {body: msg}}
-  })
-end
-
-json.form(partial: 'form') do
-end
-
-json.<%= plural_table_name.camelize(:lower) %>Path <%= plural_table_name %>_path
-
-

data/lib/generators/rails/templates/show.json.props

@@ -1,6 +0,0 @@
-<%- attributes_list_with_timestamps.each do |attr|-%>
-json.<%=attr.to_s.camelize(:lower)%> @<%= singular_table_name %>.<%=attr%>
-<%- end -%>
-
-json.<%= plural_table_name.camelize(:lower) %>Path <%= plural_table_name %>_path
-json.edit<%= singular_table_name.camelize %>Path edit_<%= singular_table_name %>_path(@<%= singular_table_name %>)

data/lib/generators/rails/templates/web/edit.js

@@ -1,35 +0,0 @@
-import React from 'react'
-// import { useSelector } from 'react-redux'
-
-export default function <%= plural_table_name.camelize %>Edit ({
-  // visit,
-  // remote,
-  form,
-  errors,
-  <%= singular_table_name.camelize(:lower) %>Path,
-  <%= plural_table_name.camelize(:lower) %>Path,
-}) {
-  const messagesEl = errors && (
-    <div id="error_explanation">
-      <h2>{ errors.explanation }</h2>
-      <ul>{ errors.messages.map(({body})=> <li key={body}>{body}</li>) }</ul>
-    </div>
-  )
-
-  return (
-    <div>
-      {messagesEl}
-      <form {...form.props} data-sg-visit>
-        {Object.values(form.extras).map((hiddenProps) => (<input {...hiddenProps} key={hiddenProps.id} type="hidden"/>))}
-        <%- attributes.each do |attr| -%>
-        <input {...form.inputs.<%= attr.column_name %>} type="text"/>
-        <label htmlFor={form.inputs.<%= attr.column_name %>.id}><%= attr.column_name %></label>
-        <%- end -%>
-        <button {...form.inputs.submit} type="submit"> {...form.inputs.submit.text} </button>
-      </form>
-
-      <a href={<%= singular_table_name.camelize(:lower) %>Path} data-sg-visit>Show</a>
-      <a href={<%= plural_table_name.camelize(:lower) %>Path}  data-sg-visit>Back</a>
-    </div>
-  )
-}

data/lib/generators/rails/templates/web/index.js

@@ -1,56 +0,0 @@
-import React from 'react'
-import { useSelector } from 'react-redux'
-
-export default function <%= plural_table_name.camelize %>Index({
-  // visit,
-  // remote,
-  new<%= singular_table_name.camelize %>Path,
-  <%= plural_table_name.camelize(:lower) %> = [],
-}) {
-  const flash = useSelector((state) => state.flash)
-
-  const <%= singular_table_name.camelize(:lower) %>Items = <%= plural_table_name.camelize(:lower) %>.map((<%= singular_table_name.camelize(:lower) %>, key) => {
-    const deleteForm = <%=singular_table_name.camelize(:lower)%>.deleteForm;
-
-    return (
-      <tr key={<%= singular_table_name.camelize(:lower) %>.id}>
-        <%- attributes_list.select{|attr| attr != :id }.each do |attr| -%>
-        <td>{<%=singular_table_name.camelize(:lower)%>.<%=attr.camelize(:lower)%>}</td>
-        <%- end -%>
-        <td><a href={ <%=singular_table_name%>.<%=singular_table_name.camelize(:lower)%>Path } data-sg-visit>Show</a></td>
-        <td><a href={ <%=singular_table_name%>.edit<%=singular_table_name.camelize%>Path } data-sg-visit>Edit</a></td>
-        <td>
-          <form {...deleteForm.props} data-sg-visit>
-            {Object.values(deleteForm.extras).map((hiddenProps) => (<input {...hiddenProps} key={hiddenProps.id} type="hidden"/>))}
-            <button type="submit">Delete</button>
-          </form>
-        </td>
-      </tr>
-    )
-  })
-
-  return (
-    <div>
-      <p id="notice">{flash && flash.notice}</p>
-
-      <h1><%= plural_table_name.capitalize %></h1>
-
-      <table>
-        <thead>
-          <%- attributes_list.select{|attr| attr != :id }.each do |attr| -%>
-          <tr><th><%=attr.capitalize%></th></tr>
-          <%- end -%>
-          <tr>
-            <th colSpan="3"></th>
-          </tr>
-        </thead>
-
-        <tbody>
-          {<%= singular_table_name %>Items}
-        </tbody>
-      </table>
-      <br />
-      <a href={new<%= singular_table_name.camelize %>Path} data-sg-visit>New <%= singular_table_name.capitalize %></a>
-    </div>
-  )
-}

data/lib/generators/rails/templates/web/new.js

@@ -1,33 +0,0 @@
-import React from 'react'
-// import { useSelector } from 'react-redux'
-
-export default function <%= plural_table_name.camelize %>New({
-  // visit,
-  // remote
-  form,
-  errors,
-  <%= plural_table_name.camelize(:lower) %>Path,
-}) {
-  const messagesEl = errors && (
-    <div id="error_explanation">
-      <h2>{ errors.explanation }</h2>
-      <ul>{ errors.messages.map(({body})=> <li key={body}>{body}</li>) }</ul>
-    </div>
-  )
-
-  return (
-    <div>
-      {messagesEl}
-      <form {...form.props} data-sg-visit>
-        {Object.values(form.extras).map((hiddenProps) => (<input {...hiddenProps} key={hiddenProps.id} type="hidden"/>))}
-        <%- attributes.each do |attr| -%>
-        <input {...form.inputs.<%= attr.column_name %>} type="text"/>
-        <label htmlFor={form.inputs.<%= attr.column_name %>.id}><%= attr.column_name %></label>
-        <%- end -%>
-        <button {...form.inputs.submit} type="submit"> {...form.inputs.submit.text} </button>
-      </form>
-
-      <a href={<%= plural_table_name.camelize(:lower) %>Path} data-sg-visit>Back</a>
-    </div>
-  )
-}

data/lib/generators/rails/templates/web/show.js

@@ -1,28 +0,0 @@
-import React from 'react'
-import { useSelector } from 'react-redux'
-
-export default function <%= plural_table_name.camelize %>Show({
-  // visit,
-  // remote,
-  <%- attributes_list_with_timestamps.select{|attr| attr != :id }.each do |attr| -%>
-  <%=attr.camelize(:lower)%>,
-  <%- end -%>
-  edit<%= singular_table_name.camelize %>Path,
-  <%= plural_table_name.camelize(:lower) %>Path
-}) {
-  const flash = useSelector((state) => state.flash)
-
-  return (
-    <div>
-      <p id="notice">{flash && flash.notice}</p>
-      <%- attributes_list_with_timestamps.select{|attr| attr != :id }.each do |attr| -%>
-      <p>
-        <strong><%= attr.capitalize %>:</strong>
-        {<%=attr.camelize(:lower)%>}
-      </p>
-      <%- end -%>
-      <a href={ edit<%= singular_table_name.camelize %>Path } data-sg-visit>Edit</a>
-      <a href={ <%= plural_table_name.camelize(:lower) %>Path } data-sg-visit>Back</a>
-    </div>
-  )
-}

data/lib/install/templates/web/actions.js

@@ -1,6 +0,0 @@
-import { createAction } from '@reduxjs/toolkit'
-import { SAVE_RESPONSE, BEFORE_VISIT, UPDATE_FRAGMENTS } from '@thoughtbot/superglue'
-
-export const saveResponse = createAction(SAVE_RESPONSE)
-export const beforeVisit = createAction(BEFORE_VISIT)
-export const updateFragments = createAction(UPDATE_FRAGMENTS)

data/lib/install/templates/web/application_visit.js

@@ -1,65 +0,0 @@
-import { visit, remote } from '@thoughtbot/superglue/action_creators'
-
-export function buildVisitAndRemote(ref, store) {
-  const appRemote = (...args) => {
-    return store.dispatch(remote(...args))
-  }
-
-  const appVisit = (...args) => {
-    // Do something before
-    // e.g, show loading state, you can access the current pageKey
-    // via store.getState().superglue.currentPageKey
-    let { action } = args
-
-    return store
-      .dispatch(visit(...args))
-      .then((meta) => {
-        // The assets fingerprints changed, instead of transitioning
-        // just go to the URL directly to retrieve new assets
-        if (meta.needsRefresh) {
-          window.location = meta.url
-          return
-        }
-
-        ref.current.navigateTo(meta.pageKey, {
-          action: meta.suggestedAction,
-        })
-
-        // always return meta
-        return meta
-      })
-      .finally(() => {
-        // Do something after
-        // e.g, hide loading state, you can access the changed pageKey
-        // via getState().superglue.currentPageKey
-      })
-      .catch((err) => {
-        const response = err.response
-
-        if (!response) {
-          console.error(err)
-          return
-        }
-
-        if (response.ok) {
-          // err gets thrown, but if the response is ok,
-          // it must be an html body that
-          // superglue can't parse, just go to the location
-          window.location = response.url
-        } else {
-          if (response.status >= 400 && response.status < 500) {
-            window.location = '/400.html'
-            return
-          }
-
-          if (response.status >= 500) {
-            window.location = '/500.html'
-            return
-          }
-        }
-      })
-  }
-
-  return { visit: appVisit, remote: appRemote }
-}
-