Welcome to TurboBoost Commands 👋

TurboBoost Commands enhance the reactive programming model for Rails/Hotwire applications.

Table of Contents

• Why TurboBoost Commands?
• Sponsors
  • Open Source projects like TurboBoost rely on your support
• Dependencies
• Setup
• Configuration
• Usage
  • Event Delegates
  • Lifecycle Events
  • Targeting Frames
  • Working with Forms
  • Server Side Commands
  • Appending Turbo Streams
  • Setting Instance Variables
  • Prevent Controller Action
  • Broadcasting Turbo Streams
• State
  • Server-State
  • Now-State
  • Client-State
  • Page-State
  • State Resolution
• Community
• Developing
  • Notable Files
• Deploying
  • Notable Files
  • How to Deploy
• Releasing
• About TurboBoost
• License

Why TurboBoost Commands?

Commands help you build robust reactive applications with Rails & Hotwire. They allow you to declaratively specify server methods that will execute whenever client side events are triggered by users.

TurboBoost Commands work with Hotwire's Turbo Frames. They also work independent of frames.

Commands let you sprinkle ✨ in reactive functionality and skip the ceremony of the typical REST semantics imposed by Rails conventions and Turbo Frames i.e. boilerplate (routes, controllers, actions, etc...).

Commands are great for features adjacent to traditional RESTful resources. Things like making selections, toggling switches, adding filters, etc... Basically for any feature where you've been tempted to create a non-RESTful action in a controller.

Commands improve the developer experience (DX) of creating modern reactive applications. They share the same mental model as React and other client side frameworks. Namely,

1. Trigger an event
2. Change state
3. (Re)render to reflect the new state
4. repeat...

Commands are executed via a Rails before_action which means that reactivity runs over HTTP. Web sockets are NOT used for the reactive critical path! 🎉 This also means that standard Rails mechanics drive their behavior.

Commands can be tested in isolation as well as with standard Rails controller, integration, and system tests.

Sponsors

Open Source projects like TurboBoost rely on your support

Please consider a one-time donation to ensure the continued growth and maintenance of this project. Your contribution will help drive the evolution of TurboBoost, enabling new features, enhancements, and bug fixes that benefit the entire community.

[!TIP] Every contribution makes a difference, no matter the amount.
_{You will receive a receipt for your financial records and accounting purposes.}

---

_{Proudly sponsored by}

Dependencies

• rails >= 6.1
• turbo-rails >= 1.1
• @hotwired/turbo-rails >= 7.2
• turbo_boost-streams >= 0.1.10
• @turbo-boost/streams >= 0.1.10

Setup

Complete the steps below, or use this RailsByte:

1rails app:template LOCATION='https://railsbytes.com/script/xkjsbB'

1. Add TurboBoost Commands dependencies

   1# Gemfile
   2gem "turbo-rails", ">= 1.1", "< 2"
   3+gem "turbo_boost-commands", "~> VERSION"

   1# package.json
   2"dependencies": {
   3  "@hotwired/turbo-rails": ">=7.2",
   4+  "@turbo-boost/commands": "^VERSION"

   Be sure to install the same version of the Ruby and JavaScript libraries.

2. Import TurboBoost Commands in your JavaScript app

   1# app/javascript/application.js
   2import '@hotwired/turbo-rails'
   3+import '@turbo-boost/commands'

Configuration

TurboBoost Commands can be configured via Rails initializer.

1# config/initializers/turbo_boost_commands.rb
2TurboBoost::Commands.config.tap do |config|
3  # opt-[in/out] of alerting on abort (true, *false, "development", "test", "production")
4  config.alert_on_abort = "development"
5
6  # opt-[in/out] of alerting on error (true, *false, "development", "test", "production")
7  config.alert_on_error = "development"
8
9  # opt-[in/out] of precompiling TurboBoost assets (*true, false)
10  config.precompile_assets = true
11
12  # opt-[in/out] of forgery protection (*true, false)
13  config.protect_from_forgery = true
14
15  # opt-[in/out] of raising an error when an invalid command is invoked (true, false, *"development", "test", "production")
16  config.raise_on_invalid_command = "development"
17
18  # opt-[in/out] of state resolution (true, *false)
19  config.resolve_state = true
20
21  # opt-[in/out] of verifying the client browser (*true, false)
22  config.verify_client = true
23end

Usage

This example illustrates how to use TurboBoost Commands to manage upvotes on a Post.

1. Trigger an event - register an element to listen for client side events that trigger server side commands

   1<!-- app/views/posts/show.html.erb -->
   2<%= turbo_frame_tag dom_id(@post) do %>
   3  <a href="#" data-turbo-command="PostCommand#upvote">Upvote</a>
   4  Upvote Count: <%= @post.votes %>
   5<% end %>

2. Change state - create a server side command that modifies state

   1# app/commands/post_command.rb
   2class PostCommand < TurboBoost::Commands::Command
   3  def upvote
   4    Post.find(controller.params[:id]).increment! :votes
   5  end
   6end

3. (Re)render to reflect the new state - normal Rails / Turbo Frame behavior runs and (re)renders the frame

Event Delegates

TurboBoost Commands use event delegation to capture client side events that invoke server side commands.

Here is the list of default event delegates (DOM event name + CSS selectors) that TurboBoost Commands monitors.

• change - input[data-turbo-command],select[data-turbo-command],textarea[data-turbo-command]
• submit - form[data-turbo-command]
• click - [data-turbo-command]

Note that the list of event delegates is ordinal. Matches are identified by scanning the list of delegates top to bottom (first match wins).

It's possible to override the default event delegates. Just note that registered events are required to bubble up through the DOM tree.

IMPORTANT: New entries and overrides are prepended to the list of delegates and will match before defaults.

1// restrict `click` monitoring to <a> and <button> elements
2TurboBoost.Commands.registerEventDelegate('click', [
3  'a[data-turbo-command]',
4  'button[data-turbo-command]'
5])

1// append selectors to the `change` event
2const delegate = TurboBoost.Commands.eventDelegates.find(
3  e => e.name === 'change'
4)
5const selectors = [...delegate.selectors, '.example[data-turbo-command]']
6TurboBoost.Commands.registerEventDelegate('change', selectors)

You can also register custom events and elements. Here's an example that sets up monitoring for the sl-change event on the sl-switch element from the Shoelace web component library.

1TurboBoost.Commands.registerEventDelegate('sl-change', [
2  'sl-switch[data-turbo-command]'
3])

Lifecycle Events

TurboBoost Commands support the following lifecycle events.

• turbo-boost:command:start - fires before the command is sent to the server
• turbo-boost:command:finish - fires after the server has executed the command and responded
• turbo-boost:command:error - fires if an unexpected error occurs

Targeting Frames

TurboBoost Commands target the closest <turbo-frame> element by default, but you can also explicitly target other frames just like you normally would with Turbo Frames.

1. Look for data-turbo-frame on the command element

   1<input type="checkbox"
   2  data-turbo-command="ExampleCommand#work"
   3  data-turbo-frame="some-frame-id">

2. Find the closest <turbo-frame> to the command element

   1<turbo-frame id="example-frame">
   2  <input type="checkbox" data-turbo-command="ExampleCommand#work">
   3</turbo-frame>

Working with Forms

TurboBoost Commands work great with Rails forms. Just specify the data-turbo-command attribute on the form.

1# app/views/posts/post.html.erb
2<%= turbo_frame_tag dom_id(@post) do %>
3  <%= form_with model: @post, data: { turbo_command: "ExampleCommand#work" } do |form| %>
4    ...
5  <% end %>
6<% end %>
7
8<%= turbo_frame_tag dom_id(@post) do %>
9  <%= form_for @post, remote: true, data: { turbo_command: "ExampleCommand#work" } do |form| %>
10    ...
11  <% end %>
12<% end %>
13
14<%= form_with model: @post,
15  data: { turbo_frame: dom_id(@post), turbo_command: "ExampleCommand#work" } do |form| %>
16  ...
17<% end %>

Server Side Commands

The client side DOM attribute data-turbo-command indicates what Ruby class and method to invoke. The attribute value is specified with RDoc notation. i.e. ClassName#method_name

Here's an example.

1<a data-turbo-command="DemoCommand#example">

Server side commands can live anywhere in your app; however, we recommend you keep them in the app/commands directory.

1 |- app
2 |  |- ...
3+|  |- commands
4 |  |- controllers
5 |  |- helpers
6 |  |- ...

Commands are simple Ruby classes that inherit from TurboBoost::Commands::Command. They expose the following instance methods and properties.

1# * controller ...................... The Rails controller processing the HTTP request
2# * convert_to_instance_variables ... Converts a Hash to instance variables
3# * css_id_selector ................. Returns a CSS selector for an element `id` i.e. prefixes with `#`
4# * dom_id .......................... The Rails dom_id helper
5# * dom_id_selector ................. Returns a CSS selector for a dom_id
6# * element ......................... A struct that represents the DOM element that triggered the command
7# * morph ........................... Appends a Turbo Stream to morph a DOM element
8# * params .......................... Commands specific params (frame_id, element, etc.)
9# * render .......................... Renders Rails templates, partials, etc. (doesn't halt controller request handling)
10# * renderer ........................ An ActionController::Renderer
11# * state ........................... An object that stores ephemeral `state`
12# * transfer_instance_variables ..... Transfers all instance variables to another object
13# * turbo_stream .................... A Turbo Stream TagBuilder
14# * turbo_streams ................... A list of Turbo Streams to append to the response (also aliased as streams)

They also have access to the following class methods:

1# * prevent_controller_action ... Prevents the rails controller/action from running (i.e. the command handles the response entirely)

Here's an example command.

1# app/commands/demo_command.rb
2class DemoCommand < TurboBoost::Commands::Command
3  # The command method `perform` is invoked by an ActionController `before_action`.
4  def perform
5    # - execute business logic
6    # - update state
7    # - append additional Turbo Streams
8  end
9end

Appending Turbo Streams

It's possible to append additional Turbo Streams to the response from within a command. Appended streams are added to the response body after the Rails controller action has completed and rendered the view template.

1# app/commands/demo_command.rb
2class DemoCommand < TurboBoost::Commands::Command
3  def example
4    # logic...
5    turbo_streams << turbo_stream.append("dom_id", "CONTENT")
6    turbo_streams << turbo_stream.prepend("dom_id", "CONTENT")
7    turbo_streams << turbo_stream.replace("dom_id", "CONTENT")
8    turbo_streams << turbo_stream.update("dom_id", "CONTENT")
9    turbo_streams << turbo_stream.remove("dom_id")
10    turbo_streams << turbo_stream.before("dom_id", "CONTENT")
11    turbo_streams << turbo_stream.after("dom_id", "CONTENT")
12    turbo_streams << turbo_stream.invoke("console.log", args: ["Whoa! 🤯"])
13  end
14end

This proves especially powerful when paired with TurboBoost Streams.

[!NOTE] turbo_stream.invoke is a TurboBoost Streams feature.

Setting Instance Variables

It can be useful to set instance variables on the Rails controller from within a command.

Here's an example that shows how to do this.

1<!-- app/views/posts/index.html.erb -->
2<%= turbo_frame_tag dom_id(@posts) do %>
3  <%= check_box_tag :all, :all, @all, data: { turbo_command: "PostsCommand#toggle_all" } %>
4  View All
5
6  <% @posts.each do |post| %>
7    ...
8  <% end %>
9<% end %>

1# app/commands/posts_command.rb
2class PostsCommand < TurboBoost::Commands::Command
3  def toggle_all
4    posts = element.checked ? Post.all : Post.unread
5    controller.instance_variable_set(:@all, element.checked)
6    controller.instance_variable_set(:@posts, posts)
7  end
8end

1# app/controllers/posts_controller.rb
2class PostsController < ApplicationController
3  def index
4    @posts ||= Post.unread
5  end
6end

Prevent Controller Action

Sometimes you may want to prevent normal response handling.

For example, consider the need for a related but separate form that updates a subset of user attributes. We'd like to avoid creating a non RESTful route but aren't thrilled at the prospect of adding REST boilerplate for a new route, controller, action, etc...

In that scenario we can reuse an existing route and prevent normal response handling with a command.

Here's how to do it.

1<!-- app/views/users/show.html.erb -->
2<%= turbo_frame_tag "user-alt" do %>
3  <%= form_with model: @user, data: { turbo_command: "UserCommand#example" } do |form| %>
4    ...
5  <% end %>
6<% end %>

The form above will send a PATCH request to users#update, but we'll prevent normal request handling in the command to prevent running users#update in the controller.

1# app/commands/user_command.html.erb
2class UserCommand < TurboBoost::Commands::Command
3  def example
4    # business logic, save record, etc...
5    controller.render html: "<turbo-frame id='user-alt'>We prevented the normal response!</turbo-frame>".html_safe
6  end
7end

Remember that commands are invoked by a controller before action filter. That means controller rendering from inside a command halts the standard request cycle.

Broadcasting Turbo Streams

You can also broadcast Turbo Streams to subscribed users from a command.

1# app/commands/demo_command.rb
2class DemoCommand < TurboBoost::Commands::Command
3  def example
4    # logic...
5    Turbo::StreamsChannel
6      .broadcast_invoke_later_to "some-subscription", "console.log", args: ["Whoa! 🤯"]
7  end
8end

Learn more about Turbo Stream broadcasting by reading through the hotwired/turbo-rails source code.

[!NOTE] broadcast_invoke_later_to is a TurboBoost Streams feature.

State

TurboBoost manages various forms of state to provide a terrific reactive user experience.

Here’s a breakdown of each type:

Server-State

Server-State is the persistent state that the server used for the most recent render. This state is signed, ensuring data integrity and security.

The client includes this signed state along with its own optimistic changes whenever a Command is invoked. The server can then compute the difference between the Client-State and the Server-State, allowing you to accept or reject the client's optimistic changes.

This ensures the server remains the single source of truth.

Server-State can be accessed within Commands like so.

1state[:key] = "value"
2state[:key]
3#=> "value"

Server-State is also accessible in controllers and views.

1# controller
2turbo_boost.state[:key] = "value"
3turbo_boost.state[:key]
4#=> "value"

1<%
2  # view
3  turbo_boost.state[:key] = "value"
4  turbo_boost.state[:key]
5  #=> "value"
6%>

Now-State

Now-State is ephemeral server side state that only exists for the current render cycle. Similar to flash.now in Rails, this state is discarded after rendering.

It’s useful for managing temporary data that doesn’t need to persist beyond the current request.

Now-State can be accessed within Commands like so.

1state.now[:key] = "value"
2state.now[:key]
3#=> "value"

Now-State is also accessible in controllers and views.

1# controller
2turbo_boost.state.now[:key] = "value"
3turbo_boost.state.now[:key]
4#=> "value"

1<%
2  # view
3  turbo_boost.state.now[:key] = "value"
4  turbo_boost.state.now[:key]
5  #=> "value"
6%>

Client-State

Client-State is a mutable version of the signed Server-State, wrapped in an observable JavaScript proxy. This allows for sophisticated techniques like data binding via custom JavaScript, Stimulus controllers, or web components.

Client-State enables immediate UI updates, providing a fast and smooth user experience while the server resolves state differences whenever Commands are invoked.

Client-State can be accessed on the client like so.

1TurboBoost.State.current['key'] = 'value'
2TurboBoost.State.current['key']
3//=> 'value'

Page-State

Page-State is managed by the client and used to remember element attribute values between server renders. It’s best for tracking transient user interactions, such as - which elements are visible, open/closed, their position, etc.

This enhances the user experience by maintaining the state of UI elements between renders. When invoking commands, the client sends the Page-State to the server, allowing it to preserve element attributes when rendering. The client also checks and restores Page-State whenever the DOM changes if needed.

You can opt-in to remember Page-State with Rails tag helpers via the turbo_boost[:remember] option.

1<%= tag.details id: "page-state-example", open: "open", turbo_boost: { remember: [:open] } do %>
2  <summary>Page-State Example</summary>
3  Content...
4<% end %>

This will remember whether the details element is open or closed.

That's it! You're done.

[!NOTE] Page-State tracking works with all element attributes, including aria, data, and even custom attributes. Elements must have a unique id to participate in Page-State tracking.

State Resolution

Commands can perform state resolution by implementing the resolve_state method.

The Command has access to all forms of state, so you should use explicit access during resolution.

You can access both the signed Server-State and the optimistc Client-State from within the Command like so.

1class ExampleCommand < TurboBoost::Commands::Command
2
3  def resolve_state
4    state.signed #=> the Server-State (from the last render)
5    state.unsigned #=> the optimistic Client-State
6    # compare and resolve the delta
7  end
8end

[!TIP] State resolution can involve data lookups, updates to persistent data stores, calls to 3rd party APIs, etc.

You can opt-in to state resolution with the following config option.

1# config/initializers/turbo_boost.rb
2TurboBoost::Commands.config.tap do |config|
3  config.resolve_state = true
4end

[!TIP] TurboBoost State mechanics can also be used independent of Commands with standard Hotwire techniques.

Community

Come join the party with over 2200+ like-minded friendly Rails/Hotwire enthusiasts on our Discord server.

Developing

This project supports a fully Dockerized development experience.

1. Simply run the following commands to get started.

   1git clone -o github https://github.com/hopsoft/turbo_boost-streams.git
   2cd turbo_boost-streams

   1docker compose up -d # start the envionment (will take a few minutes on 1st run)
   2docker exec -it turbo_boost-streams-web rake # run the test suite
   3open http://localhost:3000 # open the `test/dummy` app in a browser

   And, if you're using the containers gem (WIP).

   1containers up # start the envionment (will take a few minutes on 1st run)
   2containers rake # run the test suite
   3open http://localhost:3000 # open the `test/dummy` app in a browser

2. Edit files using your preferred tools on the host machine.

3. That's it!

Notable Files

• Dockerfile
• docker-compose.yml
• bin/docker/run/local

Deploying

This project supports Dockerized deployment via the same configurtation used for development, and... it actually runs the test/dummy application in "production". 🤯

The test/dummy app serves the following purposes.

• Test app for the Rails engine
• Documentation and marketing site with interactive demos

You can see it in action here. How's that for innovative simplicity?

Notable Files

• Dockerfile
• fly.toml
• bin/docker/run/remote

How to Deploy

1fly deploy

Releasing

[!TIP] Run these commands on the host machine (i.e. not inside the dev container)

1. Run npm update and bundle update to pick up the latest dependencies
2. Update the version number consistently in the following files:
   • lib/turbo_boost/commands/version.rb - pre-release versions should use .preN
   • app/javascript/version.js - pre-release versions use -preN
   • package.json - pre-release versions use -preN
3. Run bin/standardize
4. Run rake build
5. Run npm run build
6. Commit and push any changes to GitHub
7. Run rake release
8. Run npm publish --access public
9. Create a new release on GitHub (here)

About TurboBoost

TurboBoost is a suite of libraries that enhance Rails, Hotwire, and Turbo... making them even more powerful and boosing your productivity. Be sure to check out all of the various the libraries.

• Streams
• Commands
• Elements
• Devtools
• Coming soon...

License

The gem is available as open source under the terms of the MIT License.