turbo_form 0.0.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f7a0e172eb5fd1fceae6c061a577eb424636d03b818b4ac5468e2d917e40955b
-  data.tar.gz: 82872425eec773e4ed97db3e91c8935a6c125eeca95fd6f6214303ce86ddb0dd
+  metadata.gz: 887edabc903374a74393c5a9f2b04e70c78d421a17e893355f9b2f985404a7da
+  data.tar.gz: 11cbdfb726a72675d6980e373001ca40de5a9258f2329b2391992779a5eebfa7
 SHA512:
-  metadata.gz: ede619403754616875c64b0cd57f3a56b6bea8f4d2f4a4844ebecacef86fdce3ae16ea2f21022e0ea146c2f092ba69b43783a39ec0c8cba3f25e393b5dad97cd
-  data.tar.gz: 2a236bdc2ce28e7fbb0f7005b65b1472954d90a2581619bb311b2bf1b059e7d595afdcdbf2eefe38d3bb79cf4429104b994f6c0ded268499f86897ffa9cf4b17
+  metadata.gz: 0431310fcc0bb70e96b71336275a63889b7746b79d4ba4ca64fb36358beff818d56d5b7b05f50663875371771a8e33c85fdb6b1a68e60228a7fcfeaf8a0760e9
+  data.tar.gz: 56831a247fe03fd5bc540a2a44c6fde0a8a4dc2ac64a4f8b8a9dca712ba5134fd8ac79cced5b8e12e78e93e7daa7f427bad683fa56e1729bd59fbe212eb55197

data/README.md

@@ -139,27 +139,29 @@ application.register("turbo-form", TurboFormController)
 the same version, and register it:
 
 ```bash
-yarn add turbo_form
+yarn add @rolemodel/turbo_form
 ```
 ```js
-import TurboFormController from "turbo_form"
+import TurboFormController from "@rolemodel/turbo_form"
 application.register("turbo-form", TurboFormController)
 ```
 
 ### Testing against it
 
-The controller counts completed round trips, so a system test can wait on one
-instead of sleeping:
+A re-render is a round trip, so the line after a trigger is racing it. Wrap the
+trigger and the wait comes with it:
 
 ```ruby
-def expect_dynamic_form_request
-  form = find("[data-controller~='turbo-form']")
-  before = form["data-turbo-form-requests-value"].to_i
-  yield
-  assert_selector "[data-turbo-form-requests-value='#{before + 1}']"
-end
+expect_dynamic_form_request { select "Bourbon", from: "Category" }
+select "Barrel Aged", from: "Flavor"
 ```
 
+`expect_dynamic_form_request` is available in system tests with nothing to
+require or include — Minitest and RSpec both. It waits on the controller's
+count of completed round trips rather than on the fields that came back, so it
+doesn't care what the response changed. Scope it with Capybara's `within` when
+a page carries more than one dynamic form.
+
 ## What this deliberately doesn't do
 
 It handles the common case well and gets out of the way otherwise. There is no

data/app/assets/javascripts/turbo_form.js

@@ -9,7 +9,8 @@ import { Turbo } from "@hotwired/turbo-rails"
 export default class extends Controller {
   static values = { url: String, requests: Number }
 
-  async submit() {
+  async perform() {
+    this.trigger
     const response = await fetch(this.urlValue, {
       method: "PATCH",
       headers: this.#headers,

data/lib/turbo_form/engine.rb

@@ -30,6 +30,29 @@ module TurboForm
       app.config.assets.precompile << "turbo_form.js"
     end
 
+    # Minitest's system tests descend from ActionDispatch::SystemTestCase, so
+    # the load hook reaches them. RSpec's don't -- RSpec::Rails::SystemExampleGroup
+    # assembles itself from Action Dispatch's parts instead of inheriting the
+    # case -- so they need telling separately, once RSpec is loaded but before
+    # any example group has been defined.
+    initializer "turbo_form.system_test_helper" do
+      ActiveSupport.on_load(:action_dispatch_system_test_case) do
+        require "turbo_form/system_test_helper"
+
+        include TurboForm::SystemTestHelper
+      end
+    end
+
+    config.after_initialize do
+      next unless defined?(RSpec.configure)
+
+      require "turbo_form/system_test_helper"
+
+      RSpec.configure do |config|
+        config.include TurboForm::SystemTestHelper, type: :system
+      end
+    end
+
     # Deliberately eager rather than `ActiveSupport.on_load(:action_view)`: that
     # hook doesn't fire until Action View is first loaded, which in an app that
     # isn't eager loading is partway through rendering the first view -- late

data/lib/turbo_form/form_builder.rb

@@ -84,7 +84,7 @@ module TurboForm
       # own default: `change` for a select, `input` for a text field, `click` for
       # a button. Anything else is taken as the event name.
       def stimulus_action_for(trigger)
-        trigger == true ? "turbo-form#submit" : "#{trigger}->turbo-form#submit"
+        trigger == true ? "turbo-form#perform" : "#{trigger}->turbo-form#perform"
       end
   end
 end

data/lib/turbo_form/system_test_helper.rb

@@ -0,0 +1,23 @@
+module TurboForm::SystemTestHelper
+  # Waits for a dynamic form to finish re-rendering itself.
+  #
+  # A trigger sends the form to the server and swaps part of it out when the
+  # response lands, so anything a test does on the next line is racing that
+  # response -- and loses often enough to be flaky rather than broken. The
+  # Stimulus controller counts completed round trips; waiting on that count is
+  # both cheaper and steadier than waiting on whichever field came back.
+  #
+  #   expect_dynamic_form_request { select "Bourbon", from: "Category" }
+  #   select "Barrel Aged", from: "Flavor"
+  #
+  # Scope it with Capybara's own `within` when a page carries more than one
+  # dynamic form.
+  def expect_dynamic_form_request
+    form = page.find("[data-controller~='turbo-form']")
+    completed = form["data-turbo-form-requests-value"].to_i + 1
+
+    yield
+
+    page.assert_selector "[data-turbo-form-requests-value='#{completed}']"
+  end
+end

data/lib/turbo_form/version.rb

@@ -1,3 +1,3 @@
 module TurboForm
-  VERSION = "0.0.1"
+  VERSION = "0.2.0"
 end

data/lib/turbo_form.rb

@@ -12,6 +12,7 @@ module TurboForm
   # Set to false to keep the engine out of the host's route set and draw its
   # route yourself.
   mattr_accessor :draw_routes, default: true
+  # mattr_accessor :authorize, default: ->(controller) { true }
 
   class << self
     attr_writer :verifier

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: turbo_form
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Andy Cohen
@@ -85,6 +85,7 @@ files:
 - lib/turbo_form/form_builder.rb
 - lib/turbo_form/form_helper.rb
 - lib/turbo_form/signature.rb
+- lib/turbo_form/system_test_helper.rb
 - lib/turbo_form/version.rb
 homepage: https://github.com/outlawandy/turbo_form
 licenses: