turbo_boost-commands 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4a8b3d24673a0244201ee03bedf31a31fefa5bb862b4e642c52ecf83353bb92b
-  data.tar.gz: 95d18d2b3c0dc04f9ca2ded0329c557ce9d11e1c19fc2c8d76788b1574bb6aeb
+  metadata.gz: 278f5591c9be78cac56fb62a3e3bedecd567b5cf72aebe7dafb69356145b40ab
+  data.tar.gz: c71e80af6f7c3a36f2f2b2dede92ebecd114a81011dec4b77b4041743fbb1362
 SHA512:
-  metadata.gz: e2c3c404a309e009b40e27a076dffd8c700cb6a427250e05cf89d5443eafb6c6bfb837b05566d57b6e581e72e31f9ffaed03a57a34636275062a16f1b80670db
-  data.tar.gz: d1a80d66f7cfb7418f5674ac9a36b472574a780827ef477693ad91c433036eef18f967fd3c25ca9274d8cbb1acfdb8b186bd76ee7f35126a3da7c9f2ad0368d0
+  metadata.gz: 7ce066b9f04f16039b13550a1f6b764b0fc117c2c8d80470986ffecf7be765be897bef70f58186ecb85e49b40bb42102ead1153e3feb2127c8ce1647b05361bf
+  data.tar.gz: 7add3bce722083f351de933375e558f81718a6081896c865db66bcd00b2762058c5689519df6ed5caa378b93fd2869e52cb1642dd6e3cbf81fd1febdfc9f4cf6

data/Gemfile.lock

@@ -1,10 +1,10 @@
 PATH
   remote: .
   specs:
-    turbo_boost-commands (0.0.1)
+    turbo_boost-commands (0.0.3)
       rails (>= 6.1)
       turbo-rails (>= 1.1)
-      turbo_boost-streams (>= 0.0.1)
+      turbo_boost-streams (>= 0.0.4)
 
 GEM
   remote: https://rubygems.org/
@@ -126,12 +126,13 @@ GEM
     matrix (0.4.2)
     method_source (1.0.0)
     mini_mime (1.1.2)
-    minitest (5.16.3)
+    minitest (5.17.0)
     minitest-reporters (1.5.0)
       ansi
       builder
       minitest (>= 5.0)
       ruby-progressbar
+    model_probe (1.0.7)
     net-imap (0.3.4)
       date
       net-protocol
@@ -161,10 +162,10 @@ GEM
     pry-rails (0.3.9)
       pry (>= 0.10.4)
     public_suffix (5.0.1)
-    puma (6.0.1)
+    puma (6.0.2)
       nio4r (~> 2.0)
     racc (1.6.2)
-    rack (2.2.4)
+    rack (2.2.5)
     rack-test (2.0.2)
       rack (>= 1.3)
     rails (7.0.4)
@@ -208,7 +209,7 @@ GEM
       rubocop-ast (>= 1.23.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.24.0)
+    rubocop-ast (1.24.1)
       parser (>= 3.1.1.0)
     rubocop-performance (1.15.1)
       rubocop (>= 1.7.0, < 2.0)
@@ -244,10 +245,7 @@ GEM
       actionpack (>= 6.0.0)
       activejob (>= 6.0.0)
       railties (>= 6.0.0)
-    turbo_boost-streams (0.0.1)
-      rails (>= 6.1)
-      turbo-rails (>= 1.1)
-    turbo_ready (0.1.4)
+    turbo_boost-streams (0.0.4)
       rails (>= 6.1)
       turbo-rails (>= 1.1)
     tzinfo (2.0.5)
@@ -284,6 +282,7 @@ DEPENDENCIES
   importmap-rails
   magic_frozen_string_literal
   minitest-reporters
+  model_probe
   net-smtp
   pry-byebug
   pry-doc
@@ -297,7 +296,6 @@ DEPENDENCIES
   standardrb
   tailwindcss-rails
   turbo_boost-commands!
-  turbo_ready
   web-console
   webdrivers
 

data/README.md

@@ -8,7 +8,7 @@
   </h1>
   <p align="center">
     <a href="http://blog.codinghorror.com/the-best-code-is-no-code-at-all/">
-      <img alt="Lines of Code" src="https://img.shields.io/badge/loc-1277-47d299.svg" />
+      <img alt="Lines of Code" src="https://img.shields.io/badge/loc-1401-47d299.svg" />
     </a>
     <a href="https://codeclimate.com/github/hopsoft/turbo_boost-commands/maintainability">
       <img src="https://api.codeclimate.com/v1/badges/fe1162a742fe83a4fdfd/maintainability" />
@@ -37,6 +37,12 @@
     <a href="https://github.com/hopsoft/turbo_boost-commands/actions/workflows/tests.yml">
       <img alt="Tests" src="https://github.com/hopsoft/turbo_boost-commands/actions/workflows/tests.yml/badge.svg" />
     </a>
+    <a href="https://github.com/hopsoft/turbo_boost-commands/discussions" target="_blank">
+      <img alt="GitHub Discussions" src="https://img.shields.io/github/discussions/hopsoft/turbo_boost-commands?color=168AFE&logo=github">
+    </a>
+    <a href="https://github.com/sponsors/hopsoft">
+      <img alt="Sponsors" src="https://img.shields.io/github/sponsors/hopsoft?color=eb4aaa&logo=GitHub%20Sponsors" />
+    </a>
     <a href="https://twitter.com/hopsoft">
       <img alt="Twitter Follow" src="https://img.shields.io/twitter/follow/hopsoft?logo=twitter&style=social">
     </a>
@@ -66,22 +72,24 @@
     - [Putting it All Together](#putting-it-all-together)
       - [Running Locally](#running-locally)
       - [Running in Docker](#running-in-docker)
-  - [License](#license)
-  - [Todos](#todos)
+  - [Community](#community)
+    - [Discussions](#discussions)
+    - [Twitter](#twitter)
   - [Releasing](#releasing)
+  - [About TurboBoost](#about-turboboost)
+  - [License](#license)
 
 <!-- Tocer[finish]: Auto-generated, don't remove. -->
 
 ## Why TurboBoost Commands?
 
-Commands to help you build robust reactive applications with Rails & Hotwire.
-They allow you to declaratively specify server methods that will execute when triggered by users *(think reactive applications)*.
+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.
-You choose.
+__They also work independent of frames.__
 
-They let you *sprinkle* ✨ in reactive functionality and skip the ceremony of the typical
+Commands let you *sprinkle* ✨ in reactive functionality and skip the ceremony of the typical
 [REST semantics](https://en.wikipedia.org/wiki/Representational_state_transfer)
 imposed by Rails conventions and Turbo Frames i.e. boilerplate *(routes, controllers, actions, etc...)*.
 
@@ -100,11 +108,11 @@ Namely,
 
 *The primary distinction being that __state is wholly managed by the server__.*
 
-Commands are executed via Rails a `before_action` which means that reactivity runs over HTTP.
+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.
 
-Also, commands can be tested in isolation or via Rails controller, integration, and system tests.
+Commands can be tested in isolation as well as with standard Rails controller, integration, and system tests.
 
 ## Sponsors
 
@@ -151,7 +159,7 @@ Also, commands can be tested in isolation or via Rails controller, integration,
     +import '@turbo-boost/commands'
     ```
 
-2. Add TurboBoost Commands behavior to the Rails app
+2. Add TurboBoost to your Rails app
 
     ```diff
     # app/views/layouts/application.html.erb
@@ -173,7 +181,7 @@ This example illustrates how to use TurboBoost Commands to manage upvotes on a P
     ```erb
     <!-- app/views/posts/show.html.erb -->
     <%= turbo_frame_tag dom_id(@post) do %>
-      <a href="#" data-command="PostCommand#upvote">Upvote</a>
+      <a href="#" data-turbo-command="PostCommand#upvote">Upvote</a>
       Upvote Count: <%= @post.votes %>
     <% end %>
     ```
@@ -205,14 +213,14 @@ It's possible to override these defaults like so.
 
 ```js
 // restrict `click` monitoring to <a> and <button> elements
-TurboBoost.Commands.registerEventDelegate('click', ['a[data-command]', 'button[data-command]'])
+TurboBoost.Commands.registerEventDelegate('click', ['a[data-turbo-command]', 'button[data-command]'])
 ```
 
 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](https://shoelace.style/).
 
 ```js
-TurboBoost.Commands.registerEventDelegate('sl-change', ['sl-switch[data-command]'])
+TurboBoost.Commands.registerEventDelegate('sl-change', ['sl-switch[data-turbo-command]'])
 ```
 
 ### Lifecycle Events
@@ -232,7 +240,7 @@ but you can also explicitly target other frames just like you normally would wit
 
     ```erb
     <input type="checkbox"
-      data-command="ExampleCommand#work"
+      data-turbo-command="ExampleCommand#work"
       data-turbo-frame="some-frame-id">
     ```
 
@@ -240,44 +248,44 @@ but you can also explicitly target other frames just like you normally would wit
 
     ```erb
     <turbo-frame id="example-frame">
-      <input type="checkbox" data-command="ExampleCommand#work">
+      <input type="checkbox" data-turbo-command="ExampleCommand#work">
     </turbo-frame>
     ```
 
 ### Working with Forms
 
 TurboBoost Commands work great with Rails forms.
-Just specify the `data-command` attribute on the form.
+Just specify the `data-turbo-command` attribute on the form.
 
 ```erb
 # app/views/posts/post.html.erb
 <%= turbo_frame_tag dom_id(@post) do %>
-  <%= form_with model: @post, data: { command: "ExampleCommand#work" } do |form| %>
+  <%= form_with model: @post, data: { turbo_command: "ExampleCommand#work" } do |form| %>
     ...
   <% end %>
 <% end %>
 
 <%= turbo_frame_tag dom_id(@post) do %>
-  <%= form_for @post, remote: true, data: { command: "ExampleCommand#work" } do |form| %>
+  <%= form_for @post, remote: true, data: { turbo_command: "ExampleCommand#work" } do |form| %>
     ...
   <% end %>
 <% end %>
 
 <%= form_with model: @post,
-  data: { turbo_frame: dom_id(@post), command: "ExampleCommand#work" } do |form| %>
+  data: { turbo_frame: dom_id(@post), turbo_command: "ExampleCommand#work" } do |form| %>
   ...
 <% end %>
 ```
 
 ### Server Side Commands
 
-The client side DOM attribute `data-command` indicates what Ruby class and method to invoke.
+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.
 
 ```erb
-<a data-command="DemoCommand#example">
+<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.
@@ -295,18 +303,19 @@ Commands are simple Ruby classes that inherit from `TurboBoost::Commands::Comman
 They expose the following instance methods and properties.
 
 ```ruby
+# * controller .................. The Rails controller processing the HTTP request
+# * css_id_selector ............. Returns a CSS selector for an element `id` i.e. prefixes with `#`
 # * dom_id ...................... The Rails dom_id helper
 # * dom_id_selector ............. Returns a CSS selector for a dom_id
-# * controller .................. The Rails controller processing the HTTP request
 # * element ..................... A struct that represents the DOM element that triggered the command
 # * morph ....................... Appends a Turbo Stream to morph a DOM element
 # * params ...................... Commands specific params (frame_id, element, etc.)
 # * render ...................... Renders Rails templates, partials, etc. (doesn't halt controller request handling)
 # * render_response ............. Renders a full controller response
 # * renderer .................... An ActionController::Renderer
+# * state ....................... An object that stores ephemeral `state`
 # * turbo_stream ................ A Turbo Stream TagBuilder
 # * turbo_streams ............... A list of Turbo Streams to append to the response (also aliased as streams)
-# * state ....................... An object that stores ephemeral `state`
 ```
 
 ```ruby
@@ -356,7 +365,7 @@ Here's an example that shows how to do this.
 ```erb
 <!-- app/views/posts/index.html.erb -->
 <%= turbo_frame_tag dom_id(@posts) do %>
-  <%= check_box_tag :all, :all, @all, data: { command: "PostsCommand#toggle_all" } %>
+  <%= check_box_tag :all, :all, @all, data: { turbo_command: "PostsCommand#toggle_all" } %>
   View All
 
   <% @posts.each do |post| %>
@@ -400,7 +409,7 @@ Here's how to do it.
 ```erb
 <!-- app/views/users/show.html.erb -->
 <%= turbo_frame_tag "user-alt" do %>
-  <%= form_with model: @user, data: { command: "UserCommand#example" } do |form| %>
+  <%= form_with model: @user, data: { turbo_command: "UserCommand#example" } do |form| %>
     ...
   <% end %>
 <% end %>
@@ -473,9 +482,19 @@ docker compose up -d
 You can review the implementation in [`test/dummy/app`](https://github.com/hopsoft/turbo_boost-commands/tree/main/test/dummy).
 *Feel free to add some demos and submit a pull request while you're in there.*
 
-## License
+## Community
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+### Discussions
+
+Feel free to add to the conversation here on [GitHub Discussions](https://github.com/hopsoft/turbo_boost-commands/discussions).
+
+### Twitter
+
+Connect with the core team on Twitter.
+
+<a href="https://twitter.com/hopsoft" target="_blank">
+  <img alt="Twitter Follow" src="https://img.shields.io/twitter/follow/hopsoft?logo=twitter&style=social">
+</a>
 
 ## Releasing
 
@@ -485,7 +504,20 @@ The gem is available as open source under the terms of the [MIT License](https:/
 1. Run `rake build` and `yarn build`
 1. Commit and push changes to GitHub
 1. Run `rake release`
-1. Run `yarn publish --no-git-tag-version`
+1. Run `yarn publish --no-git-tag-version --access public`
 1. Yarn will prompt you for the new version. Pre-release versions use `-preN`
 1. Commit and push any changes to GitHub
 1. Create a new release on GitHub ([here](https://github.com/hopsoft/turbo_boost-commands/releases)) and generate the changelog for the stable release for it
+
+## About TurboBoost
+
+TurboBoost is a suite of projects that enhance Rails and Hotwire to make building server rendered reactive applications simpler and more powerful.
+Be sure to check out all of the various the libraries.
+
+- [Streams](https://github.com/hopsoft/turbo_boost-streams)
+- [Commands](https://github.com/hopsoft/turbo_boost-commands)
+- Coming soon...
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).