RubyGems - turbo-rails - Versions diffs - 0.7.2 → 0.7.7 - Mend

turbo-rails 0.7.2 → 0.7.7

Files changed (13) hide show

checksums.yaml +4 -4
data/README.md +11 -0
data/app/assets/javascripts/turbo.js +180 -99
data/app/channels/turbo/streams/broadcasts.rb +30 -32
data/app/helpers/turbo/streams/action_helper.rb +2 -3
data/app/models/turbo/streams/tag_builder.rb +2 -12
data/lib/install/turbo_needs_redis.rb +9 -0
data/lib/install/turbo_with_asset_pipeline.rb +20 -12
data/lib/install/turbo_with_webpacker.rb +3 -23
data/lib/tasks/turbo_tasks.rake +5 -0
data/lib/turbo/engine.rb +0 -6
data/lib/turbo/version.rb +1 -1
metadata +3 -2

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e401e540c8c64780f9984ed0d5120511777c47ca3b5d4c023f980469e10085e8
-  data.tar.gz: 44d76bd4452ec01a2580d58e828616f2b634d8cb29a4470f082dd1c4ece899b5
+  metadata.gz: 4f96104fa6d1282a5f3845a119e748b04a819078840d3750604ebebeac081871
+  data.tar.gz: 0fdbf552964ff5ada90d746a32ec5575181c010471f4dcd921c2b443bfc732af
 SHA512:
-  metadata.gz: 5ff10bfdaecd3c50008a3f9ac63976be979b5a1208c0f2cf39b786889156bdaef33e863ad5e6cdb45e2cf2e61acb8672e42a177326d8b0155e7da7d0bd559006
-  data.tar.gz: 77413a732f4014a257f724c117d47b07ebb3190dc70802348462a9bcd19c6a525e9d18a22c5342bab6f74b70f0f461b871e4c92a5650b5ec10ced95304c6e472
+  metadata.gz: 662af2c0c6187537aafc70747ed3f66215bc65bde320475d12d10aeb30d2aca17ed1a3fa1403033a73f51323969782e3e482d5c145a3d0382921045eff22f2cb
+  data.tar.gz: 23a86030ac88022ba35c3b9369e1cf73bc2803e3c6106abb22ac9b179bb170b78e732fbab873eb56698f7a4c262298f2ab962f89359bd2369ac71820205df513

data/README.md CHANGED Viewed

@@ -15,6 +15,15 @@ During rendering, Turbo replaces the current `<body>` element outright and merge
 Whereas Turbolinks previously just dealt with links, Turbo can now also process form submissions and responses. This means the entire flow in the web application is wrapped into Turbo, making all the parts fast. No more need for `data-remote=true`.
+Turbo Drive can be disabled on a per-element basis by annotating the element or any of its ancestors with `data-turbo="false"`. If you want Turbo Drive to be disabled by default, then you can adjust your import like this:
+```js
+import { Turbo } from "@hotwired/turbo-rails"
+Turbo.session.drive = false
+```
+Then you can use `data-turbo="true"` to enable Drive on a per-element basis.
 ## Turbo Frames
@@ -37,6 +46,7 @@ The JavaScript for Turbo can either be run through the asset pipeline, which is
 1. Add the `turbo-rails` gem to your Gemfile: `gem 'turbo-rails'`
 2. Run `./bin/bundle install`
 3. Run `./bin/rails turbo:install`
+4. Run `./bin/rails turbo:install:redis` to change the development Action Cable adapter from Async (the default one) to Redis. The Async adapter does not support Turbo Stream broadcasting.
 Running `turbo:install` will install through NPM if Webpacker is installed in the application. Otherwise the asset pipeline version is used. To use the asset pipeline version, you must have `importmap-rails` installed first and listed higher in the Gemfile.
@@ -48,6 +58,7 @@ The `Turbo` instance is automatically assigned to `window.Turbo` upon import:
 import "@hotwired/turbo-rails"
 ```
 ## Usage
 You can watch [the video introduction to Hotwire](https://hotwired.dev/#screencast), which focuses extensively on demonstration Turbo in a Rails demo. Then you should familiarize yourself with [Turbo handbook](https://turbo.hotwired.dev/handbook/introduction) to understand Drive, Frames, and Streams in-depth. Finally, dive into the code documentation by starting with [`Turbo::FramesHelper`](https://github.com/hotwired/turbo-rails/blob/main/app/helpers/turbo/frames_helper.rb), [`Turbo::StreamsHelper`](https://github.com/hotwired/turbo-rails/blob/main/app/helpers/turbo/streams_helper.rb), [`Turbo::Streams::TagBuilder`](https://github.com/hotwired/turbo-rails/blob/main/app/models/turbo/streams/tag_builder.rb), and [`Turbo::Broadcastable`](https://github.com/hotwired/turbo-rails/blob/main/app/models/concerns/turbo/broadcastable.rb).

data/app/assets/javascripts/turbo.js CHANGED Viewed

@@ -361,8 +361,10 @@ class FetchRequest {
       const response = await fetch(this.url.href, fetchOptions);
       return await this.receive(response);
     } catch (error) {
-      this.delegate.requestErrored(this, error);
-      throw error;
+      if (error.name !== "AbortError") {
+        this.delegate.requestErrored(this, error);
+        throw error;
+      }
     } finally {
       this.delegate.requestFinished(this);
     }
@@ -385,13 +387,15 @@ class FetchRequest {
     return fetchResponse;
   }
   get fetchOptions() {
+    var _a;
     return {
       method: FetchMethod[this.method].toUpperCase(),
       credentials: "same-origin",
       headers: this.headers,
       redirect: "follow",
       body: this.body,
-      signal: this.abortSignal
+      signal: this.abortSignal,
+      referrer: (_a = this.delegate.referrer) === null || _a === void 0 ? void 0 : _a.href
     };
   }
   get defaultHeaders() {
@@ -544,7 +548,8 @@ class FormSubmission {
   }
   get action() {
     var _a;
-    return ((_a = this.submitter) === null || _a === void 0 ? void 0 : _a.getAttribute("formaction")) || this.formElement.action;
+    const formElementAction = typeof this.formElement.action === "string" ? this.formElement.action : null;
+    return ((_a = this.submitter) === null || _a === void 0 ? void 0 : _a.getAttribute("formaction")) || this.formElement.getAttribute("action") || formElementAction || "";
   }
   get location() {
     return expandURL(this.action);
@@ -691,11 +696,7 @@ class Snapshot {
     return this.getElementForAnchor(anchor) != null;
   }
   getElementForAnchor(anchor) {
-    try {
-      return this.element.querySelector(`[id='${anchor}'], a[name='${anchor}']`);
-    } catch (_a) {
-      return null;
-    }
+    return anchor ? this.element.querySelector(`[id='${anchor}'], a[name='${anchor}']`) : null;
   }
   get isConnected() {
     return this.element.isConnected;
@@ -785,6 +786,12 @@ class View {
   scrollToPosition({x: x, y: y}) {
     this.scrollRoot.scrollTo(x, y);
   }
+  scrollToTop() {
+    this.scrollToPosition({
+      x: 0,
+      y: 0
+    });
+  }
   get scrollRoot() {
     return window;
   }
@@ -1354,6 +1361,9 @@ class Visit {
   get restorationData() {
     return this.history.getRestorationDataForIdentifier(this.restorationIdentifier);
   }
+  get silent() {
+    return this.isSamePage;
+  }
   start() {
     if (this.state == VisitState.initialized) {
       this.recordTimingMetric(TimingMetric.visitStart);
@@ -1377,6 +1387,7 @@ class Visit {
       this.state = VisitState.completed;
       this.adapter.visitCompleted(this);
       this.delegate.visitCompleted(this);
+      this.followRedirect();
     }
   }
   fail() {
@@ -1483,8 +1494,10 @@ class Visit {
   }
   followRedirect() {
     if (this.redirectedToLocation && !this.followedRedirect) {
-      this.location = this.redirectedToLocation;
-      this.history.replace(this.redirectedToLocation, this.restorationIdentifier);
+      this.adapter.visitProposedToLocation(this.redirectedToLocation, {
+        action: "replace",
+        response: this.response
+      });
       this.followedRedirect = true;
     }
   }
@@ -1538,9 +1551,9 @@ class Visit {
   performScroll() {
     if (!this.scrolled) {
       if (this.action == "restore") {
-        this.scrollToRestoredPosition() || this.scrollToAnchor() || this.scrollToTop();
+        this.scrollToRestoredPosition() || this.scrollToAnchor() || this.view.scrollToTop();
       } else {
-        this.scrollToAnchor() || this.scrollToTop();
+        this.scrollToAnchor() || this.view.scrollToTop();
       }
       if (this.isSamePage) {
         this.delegate.visitScrolledToSamePageLocation(this.view.lastRenderedLocation, this.location);
@@ -1562,12 +1575,6 @@ class Visit {
       return true;
     }
   }
-  scrollToTop() {
-    this.view.scrollToPosition({
-      x: 0,
-      y: 0
-    });
-  }
   recordTimingMetric(metric) {
     this.timingMetrics[metric] = (new Date).getTime();
   }
@@ -1666,14 +1673,20 @@ class BrowserAdapter {
     this.progressBar.setValue(1);
     this.hideProgressBar();
   }
-  visitCompleted(visit) {
-    visit.followRedirect();
-  }
+  visitCompleted(visit) {}
   pageInvalidated() {
     this.reload();
   }
   visitFailed(visit) {}
   visitRendered(visit) {}
+  formSubmissionStarted(formSubmission) {
+    this.progressBar.setValue(0);
+    this.showProgressBarAfterDelay();
+  }
+  formSubmissionFinished(formSubmission) {
+    this.progressBar.setValue(1);
+    this.hideProgressBar();
+  }
   showProgressBarAfterDelay() {
     this.progressBarTimeout = window.setTimeout(this.showProgressBar, this.session.progressBarDelay);
   }
@@ -1891,7 +1904,8 @@ class LinkClickObserver {
     };
     this.clickBubbled = event => {
       if (this.clickEventIsSignificant(event)) {
-        const link = this.findLinkFromClickTarget(event.target);
+        const target = event.composedPath && event.composedPath()[0] || event.target;
+        const link = this.findLinkFromClickTarget(target);
         if (link) {
           const location = this.getLocationForLink(link);
           if (this.delegate.willFollowLinkToLocation(link, location)) {
@@ -1937,7 +1951,7 @@ class Navigator {
     this.delegate = delegate;
   }
   proposeVisit(location, options = {}) {
-    if (this.delegate.allowsVisitingLocation(location)) {
+    if (this.delegate.allowsVisitingLocationWithAction(location, options.action)) {
       this.delegate.visitProposedToLocation(location, options);
     }
   }
@@ -1978,7 +1992,11 @@ class Navigator {
   get history() {
     return this.delegate.history;
   }
-  formSubmissionStarted(formSubmission) {}
+  formSubmissionStarted(formSubmission) {
+    if (typeof this.adapter.formSubmissionStarted === "function") {
+      this.adapter.formSubmissionStarted(formSubmission);
+    }
+  }
   async formSubmissionSucceededWithResponse(formSubmission, fetchResponse) {
     if (formSubmission == this.formSubmission) {
       const responseHTML = await fetchResponse.responseHTML;
@@ -2001,14 +2019,23 @@ class Navigator {
     const responseHTML = await fetchResponse.responseHTML;
     if (responseHTML) {
       const snapshot = PageSnapshot.fromHTMLString(responseHTML);
-      await this.view.renderPage(snapshot);
+      if (fetchResponse.serverError) {
+        await this.view.renderError(snapshot);
+      } else {
+        await this.view.renderPage(snapshot);
+      }
+      this.view.scrollToTop();
       this.view.clearSnapshotCache();
     }
   }
   formSubmissionErrored(formSubmission, error) {
     console.error(error);
   }
-  formSubmissionFinished(formSubmission) {}
+  formSubmissionFinished(formSubmission) {
+    if (typeof this.adapter.formSubmissionFinished === "function") {
+      this.adapter.formSubmissionFinished(formSubmission);
+    }
+  }
   visitStarted(visit) {
     this.delegate.visitStarted(visit);
   }
@@ -2016,7 +2043,10 @@ class Navigator {
     this.delegate.visitCompleted(visit);
   }
   locationWithActionIsSamePage(location, action) {
-    return getRequestURL(location) === getRequestURL(this.view.lastRenderedLocation) && (getAnchor(location) != null || action == "restore");
+    const anchor = getAnchor(location);
+    const currentAnchor = getAnchor(this.view.lastRenderedLocation);
+    const isRestorationToTop = action === "restore" && typeof anchor === "undefined";
+    return action !== "replace" && getRequestURL(location) === getRequestURL(this.view.lastRenderedLocation) && (isRestorationToTop || anchor != null && anchor !== currentAnchor);
   }
   visitScrolledToSamePageLocation(oldURL, newURL) {
     this.delegate.visitScrolledToSamePageLocation(oldURL, newURL);
@@ -2408,6 +2438,7 @@ class Session {
     this.scrollObserver = new ScrollObserver(this);
     this.streamObserver = new StreamObserver(this);
     this.frameRedirector = new FrameRedirector(document.documentElement);
+    this.drive = true;
     this.enabled = true;
     this.progressBarDelay = 500;
     this.started = false;
@@ -2485,7 +2516,7 @@ class Session {
     });
   }
   willFollowLinkToLocation(link, location) {
-    return elementIsNavigable(link) && this.locationIsVisitable(location) && this.applicationAllowsFollowingLinkToLocation(link, location);
+    return this.elementDriveEnabled(link) && this.locationIsVisitable(location) && this.applicationAllowsFollowingLinkToLocation(link, location);
   }
   followedLinkToLocation(link, location) {
     const action = this.getActionForLink(link);
@@ -2494,13 +2525,12 @@ class Session {
     });
   }
   convertLinkWithMethodClickToFormSubmission(link) {
-    var _a;
     const linkMethod = link.getAttribute("data-turbo-method");
     if (linkMethod) {
       const form = document.createElement("form");
       form.method = linkMethod;
       form.action = link.getAttribute("href") || "undefined";
-      (_a = link.parentNode) === null || _a === void 0 ? void 0 : _a.insertBefore(form, link);
+      document.body.appendChild(form);
       return dispatch("submit", {
         cancelable: true,
         target: form
@@ -2509,8 +2539,8 @@ class Session {
       return false;
     }
   }
-  allowsVisitingLocation(location) {
-    return this.applicationAllowsVisitingLocation(location);
+  allowsVisitingLocationWithAction(location, action) {
+    return this.locationWithActionIsSamePage(location, action) || this.applicationAllowsVisitingLocation(location);
   }
   visitProposedToLocation(location, options) {
     extendURLWithDeprecatedProperties(location);
@@ -2518,7 +2548,9 @@ class Session {
   }
   visitStarted(visit) {
     extendURLWithDeprecatedProperties(visit.location);
-    this.notifyApplicationAfterVisitingLocation(visit.location, visit.action);
+    if (!visit.silent) {
+      this.notifyApplicationAfterVisitingLocation(visit.location, visit.action);
+    }
   }
   visitCompleted(visit) {
     this.notifyApplicationAfterPageLoad(visit.getTimingMetrics());
@@ -2530,7 +2562,7 @@ class Session {
     this.notifyApplicationAfterVisitingSamePageLocation(oldURL, newURL);
   }
   willSubmitForm(form, submitter) {
-    return elementIsNavigable(form) && elementIsNavigable(submitter);
+    return this.elementDriveEnabled(form) && this.elementDriveEnabled(submitter);
   }
   formSubmitted(form, submitter) {
     this.navigator.submitForm(form, submitter);
@@ -2549,7 +2581,10 @@ class Session {
     this.renderStreamMessage(message);
   }
   viewWillCacheSnapshot() {
-    this.notifyApplicationBeforeCachingSnapshot();
+    var _a;
+    if (!((_a = this.navigator.currentVisit) === null || _a === void 0 ? void 0 : _a.silent)) {
+      this.notifyApplicationBeforeCachingSnapshot();
+    }
   }
   allowsImmediateRender({element: element}, resume) {
     const event = this.notifyApplicationBeforeRender(element, resume);
@@ -2562,6 +2597,12 @@ class Session {
   viewInvalidated() {
     this.adapter.pageInvalidated();
   }
+  frameLoaded(frame) {
+    this.notifyApplicationAfterFrameLoad(frame);
+  }
+  frameRendered(fetchResponse, frame) {
+    this.notifyApplicationAfterFrameRender(fetchResponse, frame);
+  }
   applicationAllowsFollowingLinkToLocation(link, location) {
     const event = this.notifyApplicationAfterClickingLinkToLocation(link, location);
     return !event.defaultPrevented;
@@ -2624,6 +2665,36 @@ class Session {
       newURL: newURL.toString()
     }));
   }
+  notifyApplicationAfterFrameLoad(frame) {
+    return dispatch("turbo:frame-load", {
+      target: frame
+    });
+  }
+  notifyApplicationAfterFrameRender(fetchResponse, frame) {
+    return dispatch("turbo:frame-render", {
+      detail: {
+        fetchResponse: fetchResponse
+      },
+      target: frame,
+      cancelable: true
+    });
+  }
+  elementDriveEnabled(element) {
+    const container = element === null || element === void 0 ? void 0 : element.closest("[data-turbo]");
+    if (this.drive) {
+      if (container) {
+        return container.getAttribute("data-turbo") != "false";
+      } else {
+        return true;
+      }
+    } else {
+      if (container) {
+        return container.getAttribute("data-turbo") == "true";
+      } else {
+        return false;
+      }
+    }
+  }
   getActionForLink(link) {
     const action = link.getAttribute("data-turbo-action");
     return isAction(action) ? action : "advance";
@@ -2636,15 +2707,6 @@ class Session {
   }
 }
-function elementIsNavigable(element) {
-  const container = element === null || element === void 0 ? void 0 : element.closest("[data-turbo]");
-  if (container) {
-    return container.getAttribute("data-turbo") != "false";
-  } else {
-    return true;
-  }
-}
 function extendURLWithDeprecatedProperties(url) {
   Object.defineProperties(url, deprecatedLocationPropertyDescriptors);
 }
@@ -2657,6 +2719,58 @@ const deprecatedLocationPropertyDescriptors = {
   }
 };
+const session = new Session;
+const {navigator: navigator} = session;
+function start() {
+  session.start();
+}
+function registerAdapter(adapter) {
+  session.registerAdapter(adapter);
+}
+function visit(location, options) {
+  session.visit(location, options);
+}
+function connectStreamSource(source) {
+  session.connectStreamSource(source);
+}
+function disconnectStreamSource(source) {
+  session.disconnectStreamSource(source);
+}
+function renderStreamMessage(message) {
+  session.renderStreamMessage(message);
+}
+function clearCache() {
+  session.clearCache();
+}
+function setProgressBarDelay(delay) {
+  session.setProgressBarDelay(delay);
+}
+var Turbo = Object.freeze({
+  __proto__: null,
+  navigator: navigator,
+  session: session,
+  PageRenderer: PageRenderer,
+  PageSnapshot: PageSnapshot,
+  start: start,
+  registerAdapter: registerAdapter,
+  visit: visit,
+  connectStreamSource: connectStreamSource,
+  disconnectStreamSource: disconnectStreamSource,
+  renderStreamMessage: renderStreamMessage,
+  clearCache: clearCache,
+  setProgressBarDelay: setProgressBarDelay
+});
 class FrameController {
   constructor(element) {
     this.resolveVisitPromise = () => {};
@@ -2672,6 +2786,7 @@ class FrameController {
   connect() {
     if (!this.connected) {
       this.connected = true;
+      this.reloadable = false;
       if (this.loadingStyle == FrameLoadingStyle.lazy) {
         this.appearanceObserver.start();
       }
@@ -2707,7 +2822,7 @@ class FrameController {
     }
   }
   async loadSourceURL() {
-    if (!this.settingSourceURL && this.enabled && this.isActive && this.sourceURL != this.currentURL) {
+    if (!this.settingSourceURL && this.enabled && this.isActive && (this.reloadable || this.sourceURL != this.currentURL)) {
       const previousURL = this.currentURL;
       this.currentURL = this.sourceURL;
       if (this.sourceURL) {
@@ -2716,6 +2831,7 @@ class FrameController {
           this.appearanceObserver.stop();
           await this.element.loaded;
           this.hasBeenLoaded = true;
+          session.frameLoaded(this.element);
         } catch (error) {
           this.currentURL = previousURL;
           throw error;
@@ -2735,6 +2851,7 @@ class FrameController {
         const renderer = new FrameRenderer(this.view.snapshot, snapshot, false);
         if (this.view.renderPromise) await this.view.renderPromise;
         await this.view.render(renderer);
+        session.frameRendered(fetchResponse, this.element);
       }
     } catch (error) {
       console.error(error);
@@ -2752,6 +2869,7 @@ class FrameController {
     }
   }
   linkClickIntercepted(element, url) {
+    this.reloadable = true;
     this.navigateFrame(element, url);
   }
   shouldInterceptFormSubmission(element, submitter) {
@@ -2761,6 +2879,7 @@ class FrameController {
     if (this.formSubmission) {
       this.formSubmission.stop();
     }
+    this.reloadable = false;
     this.formSubmission = new FormSubmission(this, element, submitter);
     if (this.formSubmission.fetchRequest.isIdempotent) {
       this.navigateFrame(element, this.formSubmission.fetchRequest.url.href);
@@ -2864,10 +2983,10 @@ class FrameController {
         return !frameElement.disabled;
       }
     }
-    if (!elementIsNavigable(element)) {
+    if (!session.elementDriveEnabled(element)) {
       return false;
     }
-    if (submitter && !elementIsNavigable(submitter)) {
+    if (submitter && !session.elementDriveEnabled(submitter)) {
       return false;
     }
     return true;
@@ -2883,6 +3002,18 @@ class FrameController {
       return this.element.src;
     }
   }
+  get reloadable() {
+    const frame = this.findFrameElement(this.element);
+    return frame.hasAttribute("reloadable");
+  }
+  set reloadable(value) {
+    const frame = this.findFrameElement(this.element);
+    if (value) {
+      frame.setAttribute("reloadable", "");
+    } else {
+      frame.removeAttribute("reloadable");
+    }
+  }
   set sourceURL(sourceURL) {
     this.settingSourceURL = true;
     this.element.src = sourceURL !== null && sourceURL !== void 0 ? sourceURL : null;
@@ -3089,57 +3220,6 @@ customElements.define("turbo-stream", StreamElement);
   }
 })();
-const session = new Session;
-const {navigator: navigator} = session;
-function start() {
-  session.start();
-}
-function registerAdapter(adapter) {
-  session.registerAdapter(adapter);
-}
-function visit(location, options) {
-  session.visit(location, options);
-}
-function connectStreamSource(source) {
-  session.connectStreamSource(source);
-}
-function disconnectStreamSource(source) {
-  session.disconnectStreamSource(source);
-}
-function renderStreamMessage(message) {
-  session.renderStreamMessage(message);
-}
-function clearCache() {
-  session.clearCache();
-}
-function setProgressBarDelay(delay) {
-  session.setProgressBarDelay(delay);
-}
-var Turbo = Object.freeze({
-  __proto__: null,
-  navigator: navigator,
-  PageRenderer: PageRenderer,
-  PageSnapshot: PageSnapshot,
-  start: start,
-  registerAdapter: registerAdapter,
-  visit: visit,
-  connectStreamSource: connectStreamSource,
-  disconnectStreamSource: disconnectStreamSource,
-  renderStreamMessage: renderStreamMessage,
-  clearCache: clearCache,
-  setProgressBarDelay: setProgressBarDelay
-});
 window.Turbo = Turbo;
 start();
@@ -3154,6 +3234,7 @@ var turbo_es2017Esm = Object.freeze({
   navigator: navigator,
   registerAdapter: registerAdapter,
   renderStreamMessage: renderStreamMessage,
+  session: session,
   setProgressBarDelay: setProgressBarDelay,
   start: start,
   visit: visit

data/app/channels/turbo/streams/broadcasts.rb CHANGED Viewed

@@ -5,71 +5,69 @@
 module Turbo::Streams::Broadcasts
   include Turbo::Streams::ActionHelper
-  def broadcast_remove_to(*streamables, target:)
-    broadcast_action_to *streamables, action: :remove, target: target
+  def broadcast_remove_to(*streamables, **opts)
+    broadcast_action_to *streamables, action: :remove, **opts
   end
-  def broadcast_replace_to(*streamables, target:, **rendering)
-    broadcast_action_to *streamables, action: :replace, target: target, **rendering
+  def broadcast_replace_to(*streamables, **opts)
+    broadcast_action_to *streamables, action: :replace, **opts
   end
-  def broadcast_update_to(*streamables, target:, **rendering)
-    broadcast_action_to *streamables, action: :update, target: target, **rendering
+  def broadcast_update_to(*streamables, **opts)
+    broadcast_action_to *streamables, action: :update, **opts
   end
-  def broadcast_before_to(*streamables, target:, **rendering)
-    broadcast_action_to *streamables, action: :before, target: target, **rendering
+  def broadcast_before_to(*streamables, **opts)
+    broadcast_action_to *streamables, action: :before, **opts
   end
-  def broadcast_after_to(*streamables, target:, **rendering)
-    broadcast_action_to *streamables, action: :after, target: target, **rendering
+  def broadcast_after_to(*streamables, **opts)
+    broadcast_action_to *streamables, action: :after, **opts
   end
-  def broadcast_append_to(*streamables, target:, **rendering)
-    broadcast_action_to *streamables, action: :append, target: target, **rendering
+  def broadcast_append_to(*streamables, **opts)
+    broadcast_action_to *streamables, action: :append, **opts
   end
-  def broadcast_prepend_to(*streamables, target:, **rendering)
-    broadcast_action_to *streamables, action: :prepend, target: target, **rendering
+  def broadcast_prepend_to(*streamables, **opts)
+    broadcast_action_to *streamables, action: :prepend, **opts
   end
-  def broadcast_action_to(*streamables, action:, target:, **rendering)
-    broadcast_stream_to *streamables, content: turbo_stream_action_tag(action, target: target, template:
+  def broadcast_action_to(*streamables, action:, target: nil, targets: nil, **rendering)
+    broadcast_stream_to *streamables, content: turbo_stream_action_tag(action, target: target, targets: targets, template:
       rendering.delete(:content) || (rendering.any? ? render_format(:html, **rendering) : nil)
     )
   end
-  def broadcast_replace_later_to(*streamables, target:, **rendering)
-    broadcast_action_later_to *streamables, action: :replace, target: target, **rendering
+  def broadcast_replace_later_to(*streamables, **opts)
+    broadcast_action_later_to *streamables, action: :replace, **opts
   end
-  def broadcast_update_later_to(*streamables, target:, **rendering)
-    broadcast_action_later_to *streamables, action: :update, target: target, **rendering
+  def broadcast_update_later_to(*streamables, **opts)
+    broadcast_action_later_to *streamables, action: :update, **opts
   end
-  def broadcast_before_later_to(*streamables, target:, **rendering)
-    broadcast_action_later_to *streamables, action: :before, target: target, **rendering
+  def broadcast_before_later_to(*streamables, **opts)
+    broadcast_action_later_to *streamables, action: :before, **opts
   end
-  def broadcast_after_later_to(*streamables, target:, **rendering)
-    broadcast_action_later_to *streamables, action: :after, target: target, **rendering
+  def broadcast_after_later_to(*streamables, **opts)
+    broadcast_action_later_to *streamables, action: :after, **opts
   end
-  def broadcast_append_later_to(*streamables, target:, **rendering)
-    broadcast_action_later_to *streamables, action: :append, target: target, **rendering
+  def broadcast_append_later_to(*streamables, **opts)
+    broadcast_action_later_to *streamables, action: :append, **opts
   end
-  def broadcast_prepend_later_to(*streamables, target:, **rendering)
-    broadcast_action_later_to *streamables, action: :prepend, target: target, **rendering
+  def broadcast_prepend_later_to(*streamables, **opts)
+    broadcast_action_later_to *streamables, action: :prepend, **opts
   end
-  def broadcast_action_later_to(*streamables, action:, target:, **rendering)
+  def broadcast_action_later_to(*streamables, action:, target: nil, targets: nil, **rendering)
     Turbo::Streams::ActionBroadcastJob.perform_later \
-      stream_name_from(streamables), action: action, target: target, **rendering
+      stream_name_from(streamables), action: action, target: target, targets: targets, **rendering
   end
   def broadcast_render_to(*streamables, **rendering)
     broadcast_stream_to *streamables, content: render_format(:turbo_stream, **rendering)
   end

data/app/helpers/turbo/streams/action_helper.rb CHANGED Viewed

@@ -12,10 +12,9 @@ module Turbo::Streams::ActionHelper
   def turbo_stream_action_tag(action, target: nil, targets: nil, template: nil)
     template = action.to_sym == :remove ? "" : "<template>#{template}</template>"
-    if target
-      target = convert_to_turbo_stream_dom_id(target)
+    if target = convert_to_turbo_stream_dom_id(target)
       %(<turbo-stream action="#{action}" target="#{target}">#{template}</turbo-stream>).html_safe
-    elsif targets
+    elsif targets = convert_to_turbo_stream_dom_id(targets)
       %(<turbo-stream action="#{action}" targets="#{targets}">#{template}</turbo-stream>).html_safe
     else
       raise ArgumentError, "target or targets must be supplied"

data/app/models/turbo/streams/tag_builder.rb CHANGED Viewed

@@ -212,29 +212,19 @@ class Turbo::Streams::TagBuilder
   # Send an action of the type <tt>name</tt> to <tt>target</tt>. Options described in the concrete methods.
   def action(name, target, content = nil, allow_inferred_rendering: true, **rendering, &block)
-    target_name = extract_target_name_from(target)
     template = render_template(target, content, allow_inferred_rendering: allow_inferred_rendering, **rendering, &block)
-    turbo_stream_action_tag name, target: target_name, template: template
+    turbo_stream_action_tag name, target: target, template: template
   end
   # Send an action of the type <tt>name</tt> to <tt>targets</tt>. Options described in the concrete methods.
   def action_all(name, targets, content = nil, allow_inferred_rendering: true, **rendering, &block)
-    targets_name = extract_target_name_from(targets)
     template = render_template(targets, content, allow_inferred_rendering: allow_inferred_rendering, **rendering, &block)
-    turbo_stream_action_tag name, targets: targets_name, template: template
+    turbo_stream_action_tag name, targets: targets, template: template
   end
   private
-    def extract_target_name_from(target)
-      if target.respond_to?(:to_key)
-        ActionView::RecordIdentifier.dom_id(target)
-      else
-        target
-      end
-    end
     def render_template(target, content = nil, allow_inferred_rendering: true, **rendering, &block)
       case
       when content

data/lib/install/turbo_needs_redis.rb ADDED Viewed

@@ -0,0 +1,9 @@
+if (cable_config_path = Rails.root.join("config/cable.yml")).exist?
+  say "Enable redis in bundle"
+  uncomment_lines "Gemfile", %(gem 'redis')
+  say "Switch development cable to use redis"
+  gsub_file cable_config_path.to_s, /development:\n\s+adapter: async/, "development:\n  adapter: redis\n  url: redis://localhost:6379/1"
+else
+  say 'ActionCable config file (config/cable.yml) is missing. Uncomment "gem \'redis\'" in your Gemfile and create config/cable.yml to use the Turbo Streams broadcast feature.'
+end

data/lib/install/turbo_with_asset_pipeline.rb CHANGED Viewed

@@ -1,15 +1,23 @@
-APP_JS_ROOT = Rails.root.join("app/assets/javascripts")
-CABLE_CONFIG_PATH = Rails.root.join("config/cable.yml")
-say "Import turbo-rails in existing app/assets/javascripts/application.js"
-append_to_file APP_JS_ROOT.join("application.js"), %(import "@hotwired/turbo-rails"\n)
-if CABLE_CONFIG_PATH.exist?
-  say "Enable redis in bundle"
-  uncomment_lines "Gemfile", %(gem 'redis')
+if (app_js_path = Rails.root.join("app/javascript/application.js")).exist?
+  say "Import turbo-rails in existing app/javascript/application.js"
+  append_to_file app_js_path, %(import "@hotwired/turbo-rails"\n)
+else
+  say <<~INSTRUCTIONS, :red
+    You must import @hotwired/turbo-rails in your application.js.
+  INSTRUCTIONS
+end
-  say "Switch development cable to use redis"
-  gsub_file CABLE_CONFIG_PATH.to_s, /development:\n\s+adapter: async/, "development:\n  adapter: redis\n  url: redis://localhost:6379/1"
+if (importmap_path = Rails.root.join("config/importmap.rb")).exist?
+  say "Pin @hotwired/turbo-rails in config/importmap.rb"
+  insert_into_file \
+    importmap_path.to_s,
+    %(  pin "@hotwired/turbo-rails", to: "turbo.js"\n\n),
+    after: "Rails.application.config.importmap.draw do\n"
 else
-  say 'ActionCable config file (config/cable.yml) is missing. Uncomment "gem \'redis\'" in your Gemfile and create config/cable.yml to use the Turbo Streams broadcast feature.'
+  say <<~INSTRUCTIONS, :red
+    You must add @hotwired/turbo-rails to your importmap to reference them via ESM.
+    Example: pin "@hotwired/turbo-rails", to: "turbo.js"
+  INSTRUCTIONS
 end
+say "Run turbo:install:redis to switch on Redis and use it in development for turbo streams", :red

data/lib/install/turbo_with_webpacker.rb CHANGED Viewed

@@ -1,27 +1,7 @@
-# Some Rails versions use commonJS(require) others use ESM(import).
-TURBOLINKS_REGEX = /(import .* from "turbolinks".*\n|require\("turbolinks"\).*\n)/.freeze
-ACTIVE_STORAGE_REGEX = /(import.*ActiveStorage|require.*@rails\/activestorage.*)/.freeze
-CABLE_CONFIG_PATH = Rails.root.join("config/cable.yml")
-abort "❌ Webpacker not found. Exiting." unless defined?(Webpacker::Engine)
+say "Appending Turbo setup code to #{Webpacker.config.source_entry_path}/application.js"
+append_to_file "#{Webpacker.config.source_entry_path}/application.js", %(\nimport "@hotwired/turbo-rails"\n)
 say "Install Turbo"
 run "yarn add @hotwired/turbo-rails"
-insert_into_file "#{Webpacker.config.source_entry_path}/application.js", "import \"@hotwired/turbo-rails\"\n", before: ACTIVE_STORAGE_REGEX
-say "Remove Turbolinks"
-run "#{RbConfig.ruby} bin/bundle remove turbolinks"
-run "#{RbConfig.ruby} bin/bundle", capture: true
-run "#{RbConfig.ruby} bin/yarn remove turbolinks"
-gsub_file "#{Webpacker.config.source_entry_path}/application.js", TURBOLINKS_REGEX, ''
-gsub_file "#{Webpacker.config.source_entry_path}/application.js", /Turbolinks.start.*\n/, ''
-if CABLE_CONFIG_PATH.exist?
-  say "Enable redis in bundle"
-  uncomment_lines "Gemfile", %(gem 'redis')
-  say "Switch development cable to use redis"
-  gsub_file CABLE_CONFIG_PATH.to_s, /development:\n\s+adapter: async/, "development:\n  adapter: redis\n  url: redis://localhost:6379/1"
-else
-  say 'ActionCable config file (config/cable.yml) is missing. Uncomment "gem \'redis\'" in your Gemfile and create config/cable.yml to use the Turbo Streams broadcast feature.'
-end
+say "Run turbo:install:redis to switch on Redis and use it in development for turbo streams"

data/lib/tasks/turbo_tasks.rake CHANGED Viewed

@@ -20,5 +20,10 @@ namespace :turbo do
     task :webpacker do
       run_turbo_install_template "turbo_with_webpacker"
     end
+    desc "Switch on Redis and use it in development"
+    task :redis do
+      run_turbo_install_template "turbo_needs_redis"
+    end
   end
 end

data/lib/turbo/engine.rb CHANGED Viewed

@@ -26,12 +26,6 @@ module Turbo
       end
     end
-    initializer "turbo.importmap" do
-      if Rails.application.config.respond_to?(:importmap)
-        Rails.application.config.importmap.pin "@hotwired/turbo-rails", to: "turbo.js"
-      end
-    end
     initializer "turbo.helpers", before: :load_config_initializers do
       ActiveSupport.on_load(:action_controller_base) do
         include Turbo::Streams::TurboStreamsTagBuilder, Turbo::Frames::FrameRequest, Turbo::Native::Navigation

data/lib/turbo/version.rb CHANGED Viewed

@@ -1,3 +1,3 @@
 module Turbo
-  VERSION = "0.7.2"
+  VERSION = "0.7.7"
 end

metadata CHANGED Viewed

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: turbo-rails
 version: !ruby/object:Gem::Version
-  version: 0.7.2
+  version: 0.7.7
 platform: ruby
 authors:
 - Sam Stephenson
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-08-14 00:00:00.000000000 Z
+date: 2021-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -56,6 +56,7 @@ files:
 - app/models/concerns/turbo/broadcastable.rb
 - app/models/turbo/streams/tag_builder.rb
 - config/routes.rb
+- lib/install/turbo_needs_redis.rb
 - lib/install/turbo_with_asset_pipeline.rb
 - lib/install/turbo_with_webpacker.rb
 - lib/tasks/turbo_tasks.rake