turbo_form 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 69e93adb63b8efad18d18aa5009294ecf46dff732a835677016787a498a359fe
-  data.tar.gz: 8058b55a07707691cd9bb2770339f2685ca4c13f104cd97db01aeeef184326bd
+  metadata.gz: cb59d187ec74c47b4ed52d8067f54faa85997be5e5551d22771b12c4224017fe
+  data.tar.gz: 376442d6aaf5c3d403355bc2ba1f4c653d4794fdd5b22288aa3650c0a132e3b2
 SHA512:
-  metadata.gz: 641956f04889ecb24a6744d65f9a397e75dfa97ac5fcf57847dab4c41c06bf641268b0e620f4b9e8e1cdf865e23eaf97606a286b7db8eabc1d27d31a02707381
-  data.tar.gz: 36036dda2b7c129b9a4d704695d849049bcafbe4f5fec2b3690b2709e2e98dcaaaf2ffab4ce8c438712df1b6ea78bec0d29b08d25a9024c56ccd9d98c299d18e
+  metadata.gz: 344e3f436b6fa24fcbbcd6f65e04a0212ff588b77766f121e7941decfa4ad4bcaa2ef181cc295c60a4eb80af1b7f14390387c74ced7c8ac106c67de1ffca7bdb
+  data.tar.gz: 5eb9d4403823fe67d7eaaf438d429e46d28c33e6163fd144b8f7aecd4a3e4ea478bd9c59ce066196da8bb2b5c67c40588000361b271339ea50c3d4dbf9b9e7ec

data/README.md

@@ -36,21 +36,12 @@ Then run the installer:
 rails generate turbo_form:install
 ```
 
-It includes `TurboForm::Controller` in your ApplicationController and declares
-the route concern:
-
-```ruby
-class ApplicationController < ActionController::Base
-  include TurboForm::Controller
-end
-```
-
-```ruby
-concern :turbo_form, TurboForm::Routes
-```
+It imports the script into `app/javascript/application.js`, adding the npm
+package first if your app bundles with esbuild, Vite, Bun or webpack; see
+[JavaScript](#javascript) for doing that by hand.
 
-Draw the concern on each resource with a dynamic form — the installer leaves
-which ones to you:
+The engine does the rest. Draw the `:turbo_form` route concern on each resource
+with a dynamic form:
 
 ```ruby
 resources :widgets, concerns: :turbo_form
@@ -58,11 +49,8 @@ resources :widgets, concerns: :turbo_form
 
 It draws a PATCH beside whichever of `new` and `edit` the resource has, so
 `resources :widgets, only: %i[new create], concerns: :turbo_form` gets only the
-one for `new`.
-
-It also imports the script into `app/javascript/application.js`, adding the npm
-package first if your app bundles with esbuild, Vite, Bun or webpack; see
-[JavaScript](#javascript) for doing that by hand.
+one for `new`. Every controller inheriting from `ActionController::Base` already
+knows how to answer it.
 
 ## The options
 
@@ -70,7 +58,7 @@ package first if your app bundles with esbuild, Vite, Bun or webpack; see
 
 `dynamic: true` makes the form dynamic: a trigger sends it to the `new` or `edit`
 page of its model — `edit` once the record is saved — which is where
-`TurboForm::Routes` listens.
+the route concern listens.
 
 ### `dynamic_trigger:` on a field
 

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

@@ -2,9 +2,8 @@ require 'rails/generators'
 
 module TurboForm
   module Generators
-    # Every app gets TurboForm::Controller, the route concern its resources opt
-    # into and an import of the script. On importmap-rails the engine pins the
-    # script itself; bundled apps get the npm package to import instead.
+    # Every app gets an import of the script. On importmap-rails the engine pins
+    # the script itself; bundled apps get the npm package to import instead.
     class InstallGenerator < Rails::Generators::Base
       LOCKFILES = {
         'yarn.lock' => 'yarn add', 'pnpm-lock.yaml' => 'pnpm add',
@@ -14,23 +13,11 @@ module TurboForm
       ENTRYPOINT = 'app/javascript/application.js'
 
       def install
-        include_controller
-        declare_route_concern
         install_package unless importmap?
         import_script
       end
 
       private
-      def include_controller
-        inject_into_class 'app/controllers/application_controller.rb', 'ApplicationController', "  include TurboForm::Controller\n"
-      end
-
-      # Declared once, drawn on no resource: which forms are dynamic is the
-      # app's call, one `concerns: :turbo_form` at a time.
-      def declare_route_concern
-        route 'concern :turbo_form, TurboForm::Routes'
-      end
-
       def importmap? = Rails.root.join('config/importmap.rb').exist?
 
       def install_package

data/lib/turbo_form/controller.rb

@@ -1,5 +1,5 @@
 module TurboForm
-  # Included into the host's ApplicationController. A request that
+  # Included into ActionController::Base by the engine. A request that
   # TurboForm::Routes marks runs `new` or `edit` as usual, callbacks and all,
   # then assigns the form to what the action built just before it renders --
   # implicitly, or with its own `render layout: 'panel'`.

data/lib/turbo_form/engine.rb

@@ -1,6 +1,7 @@
 require 'turbo-rails'
 require 'turbo_form/form_helper'
 require 'turbo_form/form_builder'
+require 'turbo_form/select_renderer'
 require 'turbo_form/routes'
 require 'turbo_form/controller'
 
@@ -50,6 +51,14 @@ module TurboForm
       end
     end
 
+    initializer 'turbo_form.controller' do
+      ActiveSupport.on_load(:action_controller_base) { include TurboForm::Controller }
+    end
+
+    initializer 'turbo_form.routes' do
+      ActionDispatch::Routing::Mapper.prepend(TurboForm::Routes::Declared)
+    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
@@ -59,6 +68,7 @@ module TurboForm
 
       ActionView::Helpers::FormHelper.prepend(TurboForm::FormHelper)
       ActionView::Helpers::FormBuilder.prepend(TurboForm::FormBuilder)
+      ActionView::Helpers::Tags::SelectRenderer.prepend(TurboForm::SelectRenderer)
     end
   end
 end

data/lib/turbo_form/form_builder.rb

@@ -78,9 +78,11 @@ module TurboForm
       [ options.except(*DYNAMIC_OPTIONS), absorb_trigger(html_options.merge(options.slice(*DYNAMIC_OPTIONS))) ]
     end
 
+    def absorb_trigger(attributes) = FormBuilder.absorb_trigger(attributes, @template)
+
     # `dynamic_action:` makes a trigger of its own, on the default event unless
     # `dynamic_trigger:` names one. It takes whatever `url_for` does.
-    def absorb_trigger(attributes)
+    def self.absorb_trigger(attributes, template)
       return attributes unless attributes.keys.intersect?(DYNAMIC_OPTIONS)
 
       trigger, action = attributes.values_at(*DYNAMIC_OPTIONS)
@@ -88,12 +90,12 @@ module TurboForm
       trigger ||= action.present?
       return attributes unless trigger
 
-      attributes.merge(data: { **attributes[:data].to_h, turbo_form_trigger: trigger_event(trigger), turbo_form_action: (@template.url_for(action) if action) })
+      attributes.merge(data: { **attributes[:data].to_h, turbo_form_trigger: trigger_event(trigger), turbo_form_action: (template.url_for(action) if action) })
     end
 
     # Left blank for `true`, which the script reads as the element's own
     # default: `change` for a select, `input` for a text field, `click` for a
     # button.
-    def trigger_event(trigger) = trigger == true ? '' : trigger.to_s
+    def self.trigger_event(trigger) = trigger == true ? '' : trigger.to_s
   end
 end

data/lib/turbo_form/routes.rb

@@ -3,7 +3,6 @@ module TurboForm
   # and `edit` it has, at the same paths and onto the same actions, marked so the
   # controller renders them from what the form currently holds.
   #
-  #   concern :turbo_form, TurboForm::Routes
   #   resources :widgets, concerns: :turbo_form
   module Routes
     def self.call(mapper, _options = {})
@@ -12,5 +11,15 @@ module TurboForm
       mapper.new { mapper.patch :new, as: nil, defaults: { dynamic_form: true } } if actions.include?(:new)
       mapper.patch :edit, on: :member, as: nil, defaults: { dynamic_form: true } if actions.include?(:edit)
     end
+
+    # Rails keeps concerns per Mapper, and builds a fresh one for every `draw`,
+    # `prepend` and `append`, so declaring it once from the engine can't reach
+    # them all. An app's own `concern :turbo_form` still replaces this one.
+    module Declared
+      def initialize(...)
+        super
+        concern :turbo_form, TurboForm::Routes
+      end
+    end
   end
 end

data/lib/turbo_form/select_renderer.rb

@@ -0,0 +1,11 @@
+module TurboForm
+  # Prepended onto ActionView::Helpers::Tags::SelectRenderer, which every select
+  # tag renders through -- including those of builder methods other gems add,
+  # like country_select's, which hand their html_options straight to the tag.
+  module SelectRenderer
+    private
+    def select_content_tag(option_tags, options, html_options)
+      super(option_tags, options, FormBuilder.absorb_trigger(html_options.symbolize_keys, @template_object))
+    end
+  end
+end

data/lib/turbo_form/system_test_helper.rb

@@ -1,13 +1,14 @@
 module TurboForm::SystemTestHelper
-  # Waits for a dynamic form to finish reloading the page.
+  # Waits for a dynamic form to finish reloading the page. Reads <html> from the
+  # document, so it works inside `within` too.
   #
   #   expect_dynamic_form_request { select "Bourbon", from: "Category" }
   #   select "Barrel Aged", from: "Flavor"
   def expect_dynamic_form_request
-    completed = page.find('html')['data-turbo-form-visits'].to_i + 1
+    completed = page.document.find('html')['data-turbo-form-visits'].to_i + 1
 
     yield
 
-    page.assert_selector "html[data-turbo-form-visits='#{completed}']"
+    page.document.assert_selector "html[data-turbo-form-visits='#{completed}']"
   end
 end

data/lib/turbo_form/version.rb

@@ -1,3 +1,3 @@
 module TurboForm
-  VERSION = '0.8.0'
+  VERSION = '0.9.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: turbo_form
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.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/routes.rb
+- lib/turbo_form/select_renderer.rb
 - lib/turbo_form/system_test_helper.rb
 - lib/turbo_form/version.rb
 homepage: https://github.com/outlawandy/turbo_form
@@ -108,7 +109,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.20
+rubygems_version: 4.0.16
 specification_version: 4
 summary: Turbo-Stream backed dynamic forms, by convention.
 test_files: []