superglue 2.0.0.alpha.1 → 2.0.0.alpha.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ece4f5c86bd486f1c253c62fdbfff95056fb60bbcabc9e951d52945c17b9b1bc
-  data.tar.gz: 665759fb6ce210973e4c49838936161fa685c9e1361432a63745c30e4170c9ce
+  metadata.gz: c623e4cdef9e492b0d0bbf70ff81eaecdf6b87afdd22ff9588ec662c74c5942a
+  data.tar.gz: 85470818c873297c7a119dc0a7370ecedf0ac269082dfef1d663c33b44d695fe
 SHA512:
-  metadata.gz: 9add30dbf5df13ce875abe6510e7ad4f3d9820333341821bbeb8620bfe96c3559168eeff4ea34512ac3210f29e46cf784529f2665720fa25bd24919299e8571c
-  data.tar.gz: 68755c19906211366a20bfc28d56bb68dc47404474071cbf071681cd30093c8315d8895f0be70136beef3c4017658139faf6d601818a0d3f259b1b3c9efdf6b9
+  metadata.gz: 831982e9a9100f6a335b7d4e8f565facff1e65e6bfd3cb53290aeb905e7c60ed7ea6fe00b2975327f9b9fcb46591c556a4a73b90188634eccfd836145d083fa8
+  data.tar.gz: d69bde09f1ed1d9665230104f61d238e4e30c22c3bf9d676d30c80e01274c2ba9a0dad64cbe3592725fa56dc8b6e8798c90b148c6f373924410c439ea497f25f

data/app/channels/superglue/streams/broadcasts.rb

@@ -22,19 +22,19 @@ module Superglue::Streams::Broadcasts
     broadcast_stream_to(*streamables, content: content)
   end
 
-  def broadcast_action_to(*streamables, action:, fragment: nil, fragments: nil, save_as: nil, options: {}, **rendering)
+  def broadcast_action_to(*streamables, action:, target: nil, targets: nil, save_target: nil, options: {}, **rendering)
     locals = rendering[:locals] || {}
-    fragments = (fragment ? [fragment] : fragments)
+    targets = (target ? [target] : targets)
 
-    fragments = fragments.map do |item|
+    targets = targets.map do |item|
       convert_to_superglue_fragment_id(item)
     end
 
-    if save_as
-      options[:saveAs] = convert_to_superglue_fragment_id(save_as)
+    if save_target
+      options[:saveAs] = convert_to_superglue_fragment_id(save_target)
     end
 
-    locals[:broadcast_fragment_keys] = fragments
+    locals[:broadcast_target_keys] = targets
     locals[:broadcast_action] = action
     locals[:broadcast_options] = options
     rendering[:locals] = locals
@@ -69,22 +69,22 @@ module Superglue::Streams::Broadcasts
     end
   end
 
-  def broadcast_action_later_to(*streamables, action:, fragment: nil, fragments: nil, save_as: nil, options: {}, **rendering)
+  def broadcast_action_later_to(*streamables, action:, target: nil, targets: nil, save_target: nil, options: {}, **rendering)
     streamables.flatten!
     streamables.compact_blank!
 
     return unless streamables.present?
 
-    fragments = (fragment ? [fragment] : fragments).map do |item|
+    targets = (target ? [target] : targets).map do |item|
       convert_to_superglue_fragment_id(item)
     end
 
-    if save_as
-      options[:saveAs] = convert_to_superglue_fragment_id(save_as)
+    if save_target
+      options[:saveAs] = convert_to_superglue_fragment_id(save_target)
     end
 
     Superglue::Streams::ActionBroadcastJob.perform_later \
-      stream_name_from(streamables), action: action, fragments: fragments, options: options, **rendering
+      stream_name_from(streamables), action: action, targets: targets, options: options, **rendering
   end
 
   def broadcast_stream_to(*streamables, content:)
@@ -102,12 +102,12 @@ module Superglue::Streams::Broadcasts
 
   private
 
-  def convert_to_superglue_fragment_id(fragment)
-    fragment_array = Array.wrap(fragment)
-    if fragment_array.any? { |value| value.respond_to?(:to_key) }
-      ActionView::RecordIdentifier.dom_id(*fragment_array)
+  def convert_to_superglue_fragment_id(target)
+    target_array = Array.wrap(target)
+    if target_array.any? { |value| value.respond_to?(:to_key) }
+      ActionView::RecordIdentifier.dom_id(*target_array)
     else
-      fragment
+      target
     end
   end
 

data/app/helpers/superglue/streams_helper.rb

@@ -10,40 +10,40 @@ module Superglue::StreamsHelper
   def fragment_id(value)
     if value.respond_to?(:to_key)
       ActionView::RecordIdentifier.dom_id(value)
-    elsif value.respond_to?(:broadcast_fragment_default)
-      value.broadcast_fragment_default
+    elsif value.respond_to?(:broadcast_target_default)
+      value.broadcast_target_default
     else
       value.to_s
     end
   end
 
-  def broadcast_prepend_props(model: nil, fragment: nil, save_as: nil, options: {}, **rendering)
-    if save_as
-      options[:saveAs] ||= fragment_id(save_as)
+  def broadcast_prepend_props(model: nil, target: nil, save_target: nil, options: {}, **rendering)
+    if save_target
+      options[:saveAs] ||= fragment_id(save_target)
     end
 
-    broadcast_action_props(action: "prepend", model:, fragment:, options:, **rendering)
+    broadcast_action_props(action: "prepend", model:, target:, options:, **rendering)
   end
 
-  def broadcast_append_props(model: nil, fragment: nil, save_as: nil, options: {}, **rendering)
-    if save_as
-      options[:saveAs] ||= fragment_id(save_as)
+  def broadcast_append_props(model: nil, target: nil, save_target: nil, options: {}, **rendering)
+    if save_target
+      options[:saveAs] ||= fragment_id(save_target)
     end
 
-    broadcast_action_props(action: "append", model:, fragment:, options:, **rendering)
+    broadcast_action_props(action: "append", model:, target:, options:, **rendering)
   end
 
-  def broadcast_save_props(model: nil, partial: nil, fragment: nil, options: {}, **rendering)
-    if model && !fragment
-      fragment = fragment_id(model)
+  def broadcast_save_props(model: nil, partial: nil, target: nil, options: {}, **rendering)
+    if model && !target
+      target = fragment_id(model)
     end
 
-    broadcast_action_props(action: "save", model:, fragment:, options:, **rendering)
+    broadcast_action_props(action: "save", model:, target:, options:, **rendering)
   end
 
-  def broadcast_action_props(action:, partial: nil, model: nil, fragment: nil, options: {}, **rendering)
+  def broadcast_action_props(action:, partial: nil, model: nil, target: nil, options: {}, **rendering)
     if model
-      fragment = model.broadcast_fragment_default if !fragment
+      target = model.broadcast_target_default if !target
 
       if model.respond_to?(:to_partial_path)
         rendering[:locals] = (rendering[:locals] || {}).reverse_merge(model.model_name.element.to_sym => model).compact
@@ -51,7 +51,7 @@ module Superglue::StreamsHelper
       end
     end
 
-    fragment = fragment_id(fragment)
+    target = fragment_id(target)
 
     if !partial
       raise StandardError, "A partial is needed to render a stream"
@@ -60,7 +60,7 @@ module Superglue::StreamsHelper
     json = instance_variable_get(:@__json)
 
     json.child! do
-      json.fragmentIds [fragment]
+      json.fragmentIds [target]
       json.handler action
       json.options(options)
       json.data(partial: [partial, rendering]) do

data/app/jobs/superglue/streams/action_broadcast_job.rb

@@ -1,7 +1,7 @@
 class Superglue::Streams::ActionBroadcastJob < ActiveJob::Base
   discard_on ActiveJob::DeserializationError
 
-  def perform(stream, action:, fragments:, options: {}, **rendering)
-    Superglue::StreamsChannel.broadcast_action_to stream, action: action, fragments: fragments, options: options, **rendering
+  def perform(stream, action:, targets:, options: {}, **rendering)
+    Superglue::StreamsChannel.broadcast_action_to stream, action: action, targets: targets, options: options, **rendering
   end
 end

data/app/models/concerns/superglue/broadcastable.rb

@@ -7,13 +7,13 @@ module Superglue::Broadcastable
   end
 
   module ClassMethods
-    def broadcasts_to(stream, inserts_by: :append, fragment: broadcast_fragment_default, save_as: nil, **rendering)
-      after_create_commit -> { broadcast_action_later_to(stream.try(:call, self) || send(stream), action: inserts_by, fragment: fragment.try(:call, self) || fragment, save_as: save_as&.try(:call, self), **rendering) }
+    def broadcasts_to(stream, inserts_by: :append, target: broadcast_target_default, save_target: nil, **rendering)
+      after_create_commit -> { broadcast_action_later_to(stream.try(:call, self) || send(stream), action: inserts_by, target: target.try(:call, self) || target, save_target: save_target&.try(:call, self), **rendering) }
       after_update_commit -> { broadcast_save_later_to(stream.try(:call, self) || send(stream), **rendering) }
     end
 
-    def broadcasts(stream = model_name.plural, inserts_by: :append, fragment: broadcast_fragment_default, save_as: nil, **rendering)
-      after_create_commit -> { broadcast_action_later_to(stream, action: inserts_by, fragment: fragment.try(:call, self) || fragment, save_as: save_as&.try(:call, self), **rendering) }
+    def broadcasts(stream = model_name.plural, inserts_by: :append, target: broadcast_target_default, save_target: nil, **rendering)
+      after_create_commit -> { broadcast_action_later_to(stream, action: inserts_by, target: target.try(:call, self) || target, save_target: save_target&.try(:call, self), **rendering) }
       after_update_commit -> { broadcast_save_later(**rendering) }
     end
 
@@ -27,7 +27,7 @@ module Superglue::Broadcastable
       after_destroy_commit -> { broadcast_refresh }
     end
 
-    def broadcast_fragment_default
+    def broadcast_target_default
       model_name.plural
     end
 
@@ -43,30 +43,30 @@ module Superglue::Broadcastable
     end
   end
 
-  # add fragment?
+  # add target?
   def broadcast_save_to(*streamables, **rendering)
-    Superglue::StreamsChannel.broadcast_save_to(*streamables, **extract_options_and_add_fragment(rendering, fragment: self)) unless suppressed_superglue_broadcasts?
+    Superglue::StreamsChannel.broadcast_save_to(*streamables, **extract_options_and_add_target(rendering, target: self)) unless suppressed_superglue_broadcasts?
   end
 
   def broadcast_save(**rendering)
     broadcast_save_to self, **rendering
   end
 
-  # todo save_as: true
-  def broadcast_append_to(*streamables, fragment: broadcast_fragment_default, save_as: nil, **rendering)
-    Superglue::StreamsChannel.broadcast_append_to(*streamables, save_as: save_as, **extract_options_and_add_fragment(rendering, fragment: fragment)) unless suppressed_superglue_broadcasts?
+  # todo save_target: true
+  def broadcast_append_to(*streamables, target: broadcast_target_default, save_target: nil, **rendering)
+    Superglue::StreamsChannel.broadcast_append_to(*streamables, save_target: save_target, **extract_options_and_add_target(rendering, target: target)) unless suppressed_superglue_broadcasts?
   end
 
-  def broadcast_append(fragment: broadcast_fragment_default, save_as: nil, **rendering)
-    broadcast_append_to self, fragment: fragment, save_as: save_as, **rendering
+  def broadcast_append(target: broadcast_target_default, save_target: nil, **rendering)
+    broadcast_append_to self, target: target, save_target: save_target, **rendering
   end
 
-  def broadcast_prepend_to(*streamables, fragment: broadcast_fragment_default, save_as: nil, **rendering)
-    Superglue::StreamsChannel.broadcast_prepend_to(*streamables, save_as: save_as, **extract_options_and_add_fragment(rendering, fragment: fragment)) unless suppressed_superglue_broadcasts?
+  def broadcast_prepend_to(*streamables, target: broadcast_target_default, save_target: nil, **rendering)
+    Superglue::StreamsChannel.broadcast_prepend_to(*streamables, save_target: save_target, **extract_options_and_add_target(rendering, target: target)) unless suppressed_superglue_broadcasts?
   end
 
-  def broadcast_prepend(fragment: broadcast_fragment_default, save_as: nil, **rendering)
-    broadcast_prepend_to self, fragment: fragment, save_as: save_as, **rendering
+  def broadcast_prepend(target: broadcast_target_default, save_target: nil, **rendering)
+    broadcast_prepend_to self, target: target, save_target: save_target, **rendering
   end
 
   def broadcast_refresh_to(*streamables)
@@ -78,36 +78,36 @@ module Superglue::Broadcastable
   end
 
   # todo rename options to js_options
-  def broadcast_action_to(*streamables, action:, fragment: broadcast_fragment_default, options: {}, **rendering)
-    Superglue::StreamsChannel.broadcast_action_to(*streamables, action: action, options: options, **extract_options_and_add_fragment(rendering, fragment: fragment)) unless suppressed_superglue_broadcasts?
+  def broadcast_action_to(*streamables, action:, target: broadcast_target_default, options: {}, **rendering)
+    Superglue::StreamsChannel.broadcast_action_to(*streamables, action: action, options: options, **extract_options_and_add_target(rendering, target: target)) unless suppressed_superglue_broadcasts?
   end
 
-  def broadcast_action(action, fragment: broadcast_fragment_default, options: {}, **rest)
-    broadcast_action_to self, action: action, fragment: fragment, options: options, **rest
+  def broadcast_action(action, target: broadcast_target_default, options: {}, **rest)
+    broadcast_action_to self, action: action, target: target, options: options, **rest
   end
 
   def broadcast_save_later_to(*streamables, **rendering)
-    Superglue::StreamsChannel.broadcast_save_later_to(*streamables, **extract_options_and_add_fragment(rendering, fragment: self)) unless suppressed_superglue_broadcasts?
+    Superglue::StreamsChannel.broadcast_save_later_to(*streamables, **extract_options_and_add_target(rendering, target: self)) unless suppressed_superglue_broadcasts?
   end
 
   def broadcast_save_later(**rendering)
     broadcast_save_later_to self, **rendering
   end
 
-  def broadcast_append_later_to(*streamables, fragment: broadcast_fragment_default, save_as: nil, **rendering)
-    Superglue::StreamsChannel.broadcast_append_later_to(*streamables, save_as: save_as, **extract_options_and_add_fragment(rendering, fragment: fragment)) unless suppressed_superglue_broadcasts?
+  def broadcast_append_later_to(*streamables, target: broadcast_target_default, save_target: nil, **rendering)
+    Superglue::StreamsChannel.broadcast_append_later_to(*streamables, save_target: save_target, **extract_options_and_add_target(rendering, target: target)) unless suppressed_superglue_broadcasts?
   end
 
-  def broadcast_append_later(fragment: broadcast_fragment_default, save_as: nil, **rendering)
-    broadcast_append_later_to self, fragment: fragment, save_as: save_as, **rendering
+  def broadcast_append_later(target: broadcast_target_default, save_target: nil, **rendering)
+    broadcast_append_later_to self, target: target, save_target: save_target, **rendering
   end
 
-  def broadcast_prepend_later_to(*streamables, fragment: broadcast_fragment_default, save_as: nil, **rendering)
-    Superglue::StreamsChannel.broadcast_prepend_later_to(*streamables, save_as: save_as, **extract_options_and_add_fragment(rendering, fragment: fragment)) unless suppressed_superglue_broadcasts?
+  def broadcast_prepend_later_to(*streamables, target: broadcast_target_default, save_target: nil, **rendering)
+    Superglue::StreamsChannel.broadcast_prepend_later_to(*streamables, save_target: save_target, **extract_options_and_add_target(rendering, target: target)) unless suppressed_superglue_broadcasts?
   end
 
-  def broadcast_prepend_later(fragment: broadcast_fragment_default, save_as: nil, **rendering)
-    broadcast_prepend_later_to self, fragment: fragment, save_as: save_as, **rendering
+  def broadcast_prepend_later(target: broadcast_target_default, save_target: nil, **rendering)
+    broadcast_prepend_later_to self, target: target, save_target: save_target, **rendering
   end
 
   def broadcast_refresh_later_to(*streamables)
@@ -118,23 +118,23 @@ module Superglue::Broadcastable
     broadcast_refresh_later_to self
   end
 
-  def broadcast_action_later_to(*streamables, action:, fragment: broadcast_fragment_default, options: {}, **rendering)
-    Superglue::StreamsChannel.broadcast_action_later_to(*streamables, action: action, options: options, **extract_options_and_add_fragment(rendering, fragment: fragment)) unless suppressed_superglue_broadcasts?
+  def broadcast_action_later_to(*streamables, action:, target: broadcast_target_default, options: {}, **rendering)
+    Superglue::StreamsChannel.broadcast_action_later_to(*streamables, action: action, options: options, **extract_options_and_add_target(rendering, target: target)) unless suppressed_superglue_broadcasts?
   end
 
-  def broadcast_action_later(action:, fragment: broadcast_fragment_default, options: {}, **rendering)
-    broadcast_action_later_to self, action: action, fragment: fragment, options: options, **rendering
+  def broadcast_action_later(action:, target: broadcast_target_default, options: {}, **rendering)
+    broadcast_action_later_to self, action: action, target: target, options: options, **rendering
   end
 
-  def broadcast_fragment_default
-    self.class.broadcast_fragment_default
+  def broadcast_target_default
+    self.class.broadcast_target_default
   end
   
   private
 
-  def extract_options_and_add_fragment(rendering = {}, fragment: broadcast_fragment_default)
+  def extract_options_and_add_target(rendering = {}, target: broadcast_target_default)
     broadcast_rendering_with_defaults(rendering).tap do |options|
-      options[:fragment] = fragment if !options.key?(:fragment) && !options.key?(:fragments)
+      options[:target] = target if !options.key?(:target) && !options.key?(:targets)
     end
   end
 

data/app/views/superglue/layouts/_stream_message.json.props

@@ -11,5 +11,5 @@ end
 json.fragments json.fragments!
 json.action "handleStreamMessage"
 json.handler broadcast_action
-json.fragmentIds broadcast_fragment_keys
+json.fragmentIds broadcast_target_keys
 json.options broadcast_options

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

@@ -40,7 +40,7 @@ module Superglue
         insert_jsx_rendering_defaults
 
         say "Installing Superglue and friends"
-        run "yarn add react react-dom @reduxjs/toolkit react-redux @thoughtbot/superglue@2.0.0-alpha.1"
+        run "yarn add react react-dom @reduxjs/toolkit react-redux @thoughtbot/superglue@2.0.0-alpha.2"
 
         if use_typescript
           run "yarn add -D @types/react-dom @types/react @types/node @thoughtbot/candy_wrapper"

data/lib/generators/superglue/install/templates/js/flash.js

@@ -1,5 +1,5 @@
 import { createSlice } from "@reduxjs/toolkit"
-import { saveResponse, beforeVisit } from "@thoughtbot/superglue"
+import { receiveResponse , beforeVisit } from "@thoughtbot/superglue"
 
 const initialState = {}
 
@@ -30,12 +30,16 @@ export const flashSlice = createSlice({
     builder.addCase(beforeVisit, (_state, _action) => {
       return {}
     })
-    builder.addCase(saveResponse, (state, action) => {
-      const { page } = action.payload
+    builder.addCase(receiveResponse , (state, action) => {
+      const { response } = action.payload
 
-      return {
-        ...state,
-        ...page.slices.flash
+      if(response.slices) {
+        return {
+          ...state,
+          ...response.slices.flash
+        }
+      } else {
+        return state
       }
     })
   }

data/lib/generators/superglue/install/templates/stream.json.props

@@ -12,4 +12,8 @@ if protect_against_forgery?
   json.csrfToken form_authenticity_token
 end
 
-json.action "handleStreamResponse"
+json.action "handleStreamResponse"
+
+json.slices do
+  json.flash flash.to_h
+end

data/lib/generators/superglue/install/templates/ts/flash.ts

@@ -1,7 +1,7 @@
 import { createSlice } from "@reduxjs/toolkit";
-import { saveResponse, beforeVisit } from "@thoughtbot/superglue";
+import { receiveResponse, beforeVisit } from "@thoughtbot/superglue";
 
-type FlashState = Record<string, any>
+type FlashState = Record<string, any>;
 
 const initialState: FlashState = {};
 
@@ -32,13 +32,17 @@ export const flashSlice = createSlice({
     builder.addCase(beforeVisit, (_state, _action) => {
       return {};
     });
-    builder.addCase(saveResponse, (state, action) => {
-      const { page } = action.payload;
+    builder.addCase(receiveResponse, (state, action) => {
+      const { response } = action.payload;
 
-      return {
-        ...state,
-        ...(page.slices.flash as FlashState),
-      };
+      if (response.slices) {
+        return {
+          ...state,
+          ...(response.slices.flash as FlashState),
+        };
+      } else {
+        return state;
+      }
     });
   },
 });

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: superglue
 version: !ruby/object:Gem::Version
-  version: 2.0.0.alpha.1
+  version: 2.0.0.alpha.2
 platform: ruby
 authors:
 - Johny Ho
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-07-14 00:00:00.000000000 Z
+date: 2025-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack