rolemodel-rails 2.2.0 → 2.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f1cf52276aac5192b4349379e6f7792232fbdabae218e3d3ac6fbde81cd1ae01
-  data.tar.gz: 3d13d291529c487fb93b8d7c7816acb05e3b686fd4129173208611c0c714558d
+  metadata.gz: c9809271c3cc1c97337717b8d1d79b934a215d343f9b62e4cd6be25d9a906a39
+  data.tar.gz: 7e6493f9b61aaa33adadc0957ca25e897ff36228eeb6a667b07a9f846fadccec
 SHA512:
-  metadata.gz: 2fdd780f5256aac4772e65e9282569956b2b7e8a2fd663caa068d072a720a7905a721953725df5ccf07d671f600e31d7ec781831782128b63182b8cf586af61b
-  data.tar.gz: 453e93d083a80ff9ce7a2b2ea1f02079e334e2a4ae5028ee91d7b67d0c6cb7d7d8f013e9bab777a9da2f77b767f354af38688a2ac101ba8e94dd28c5979e22ee
+  metadata.gz: 25500fd7928c067bc0dd8405fd6140d23b932aa7742e566e008c9f3c8386a74efe44321675147c2951f6cb9dabe5b047445b126b688abf651f8ccfe7b719118e
+  data.tar.gz: 2f1bf50daa539e964159cd300f24022cd6d2614cd19886608f0acc323fbfb16e207c25d40b192a4fc783bb09b9c3272d17d84d08d9429ce07e29becd62adff51

data/README.md

@@ -47,12 +47,6 @@ baseline so the app is ready to push straight to Heroku)
 bin/rails g rolemodel:core_setup
 ```
 
-Or run every generator, including app-specific extras like React, SaaS/Devise, and GoodJob
-
-```shell
-bin/rails g rolemodel:all
-```
-
 Or run a single generator
 
 ```shell
@@ -84,6 +78,11 @@ bin/rails g
 * [Optics](./lib/generators/rolemodel/optics)
   * [Base](./lib/generators/rolemodel/optics/base)
   * [Icons](./lib/generators/rolemodel/optics/icons)
+* [Turbo](./lib/generators/rolemodel/turbo)
+  * [Ready](./lib/generators/rolemodel/turbo/ready)
+  * [Confirm](./lib/generators/rolemodel/turbo/confirm)
+  * [Modals](./lib/generators/rolemodel/turbo/modals)
+  * [Form](./lib/generators/rolemodel/turbo/form)
 * [Testing](./lib/generators/rolemodel/testing)
   * [RSpec](./lib/generators/rolemodel/testing/rspec)
   * [Jasmine Playwright](./lib/generators/rolemodel/testing/jasmine_playwright)
@@ -101,7 +100,6 @@ bin/rails g
   * [ESLint](./lib/generators/rolemodel/linters/eslint)
 * [UI Components](./lib/generators/rolemodel/ui_components)
   * [Flash](./lib/generators/rolemodel/ui_components/flash)
-  * [Modals](./lib/generators/rolemodel/ui_components/modals)
   * [Navbar](./lib/generators/rolemodel/ui_components/navbar)
 * [Source Map](./lib/generators/rolemodel/source_map)
 * [Kaminari](./lib/generators/rolemodel/kaminari)
@@ -248,7 +246,7 @@ e.g.
 
 ```ruby
 RSpec.describe Rolemodel::MyGenerator, type: :generator do
-  before { run_generator_against_test_app }
+  before { run_generators }
 end
 ```
 
@@ -258,19 +256,34 @@ e.g.
 
 ```ruby
 RSpec.describe Rolemodel::Testing::JasminePlaywrightGenerator, type: :generator do
-  before { run_generator_against_test_app(['--github-package-token=123']) }
+  before { run_generators(['--github-package-token=123']) }
+end
+```
+
+If the generator you're testing depends on being run after another generator, you may pass an array to the optional `generators` keyword argument in the order in which they should run.
+
+e.g.
+
+```ruby
+RSpec.describe Rolemodel::MyGenerator, type: :generator do
+  before do
+    run_generators(generators: [::Rolemodel::PrereqGenerator, described_class])
+  end
 end
 ```
 
-If the generator you're testing depends on being run after another generator, you should run that one first.
+If you're testing the standard output produced by your generator, assign the return value of `run_generators` to a variable.
 
 e.g.
 
 ```ruby
 RSpec.describe Rolemodel::MyGenerator, type: :generator do
   before do
-    run_generator_against_test_app(generator: ::Rolemodel::PrereqGenerator)
-    run_generator_against_test_app
+    @stdout = run_generators(generators: [::Rolemodel::PrereqGenerator, described_class])
+  end
+
+  it 'prints something useful' do
+    expect(@stdout[Rolemodel::MyGenerator]).to include('something useful')
   end
 end
 ```

data/Rakefile

@@ -1,6 +1,6 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/lib/generators/rolemodel/core_setup/core_setup_generator.rb

@@ -1,18 +1,22 @@
 module Rolemodel
   class CoreSetupGenerator < ::Rolemodel::GeneratorBase
+    class_option :skip_deployable, type: :boolean, default: false, desc: 'skip generators for app deployment (Heroku, Sentry, Lograge)'
+
     def run_the_core_generators
-      generate 'rolemodel:github'
-      generate 'rolemodel:heroku'
-      generate 'rolemodel:readme'
-      generate 'rolemodel:webpack'
-      generate 'rolemodel:sentry'
       generate 'rolemodel:slim'
+      generate 'rolemodel:webpack'
       generate 'rolemodel:optics:all'
-      generate 'rolemodel:testing:all'
       generate 'rolemodel:simple_form'
-      generate 'rolemodel:linters:all'
+      generate 'rolemodel:testing:all'
+      generate 'rolemodel:turbo:all'
       generate 'rolemodel:ui_components:flash'
-      generate 'rolemodel:ui_components:modals'
+      generate 'rolemodel:github'
+      generate 'rolemodel:readme'
+      generate 'rolemodel:linters:all'
+      return if options.skip_deployable?
+
+      generate 'rolemodel:heroku'
+      generate 'rolemodel:sentry'
       generate 'rolemodel:lograge'
     end
   end

data/lib/generators/rolemodel/good_job/good_job_generator.rb

@@ -16,13 +16,11 @@ module Rolemodel
     def configure_good_job
       say 'Add GoodJob configuration'
 
-      inject_into_file 'config/application.rb', after: "class Application < Rails::Application\n" do
-        optimize_indentation <<~'RUBY', 4
-          # Add GoodJob ActiveJob queue adapter
-          config.active_job.queue_adapter = :good_job
+      inject_into_class 'config/application.rb', 'Application', optimize_indentation(<<~'RUBY', 4)
+        # Add GoodJob ActiveJob queue adapter
+        config.active_job.queue_adapter = :good_job
 
-        RUBY
-      end
+      RUBY
 
       gsub_file 'config/environments/production.rb', 'config.active_job.queue_adapter', '# config.active_job.queue_adapter'
     end
@@ -30,7 +28,7 @@ module Rolemodel
     def configure_good_job_routes
       say 'Add GoodJob routes'
 
-      route_text = <<~RUBY
+      route <<~RUBY
         # Example but update per the authorization strategy of app
         namespace :admin do
           # authenticate :user, ->(user) { user.admin? } do
@@ -38,7 +36,6 @@ module Rolemodel
           # end
         end
       RUBY
-      route route_text
     end
 
     def configure_procfile
@@ -58,12 +55,11 @@ module Rolemodel
     def copy_initializers
       say 'Add GoodJob initializers'
 
-      copy_file 'config/initializers/active_job.rb'
-      copy_file 'config/initializers/good_job.rb'
+      directory 'config/initializers'
     end
 
     def finishing_notes
-      say <<~NOTES
+      say <<~NOTES, :green
         *** Reminder to also update your job classes to include appropriate concurrency controls (enqueue_limit/perform_limit with keys)
       NOTES
     end

data/lib/generators/rolemodel/heroku/heroku_generator.rb

@@ -27,21 +27,6 @@ module Rolemodel
       inject_into_file 'Gemfile', "\nruby file: '.ruby-version'\n", after: /^source .*$/
     end
 
-    def use_database_url_in_production
-      say 'Point the production database at DATABASE_URL for Heroku.', :green
-
-      # Rails' generated production block hardcodes database/username/<APP>_DATABASE_PASSWORD,
-      # none of which exist on Heroku, where the Postgres add-on provides a full DATABASE_URL.
-      # Replace the whole block with a url-based config.
-      gsub_file 'config/database.yml',
-                /^production:\n(?:[ \t]+.*\n?)+/,
-                <<~YAML
-                  production:
-                    <<: *default
-                    url: <%= ENV["DATABASE_URL"] %>
-                YAML
-    end
-
     def force_ssl
       say 'Require SSL for production environment.', :green
 

data/lib/generators/rolemodel/optics/base/base_generator.rb

@@ -13,9 +13,9 @@ module Rolemodel
       def copy_templates
         say 'importing stylesheet', :green
 
-        prepend_to_file Dir.glob('app/assets/stylesheets/application.*').first, <<~SCSS
+        prepend_to_file application_stylesheet_path, <<~CSS
           @import '@rolemodel/optics/dist/css/optics';
-        SCSS
+        CSS
       end
     end
   end

data/lib/generators/rolemodel/saas/devise/devise_generator.rb

@@ -161,11 +161,11 @@ module Rolemodel
         say 'importing login stylesheet', :green
         copy_file 'app/assets/stylesheets/login.css'
 
-        return unless File.exist?(File.join(destination_root, 'app/assets/stylesheets/application.scss'))
+        return unless File.exist?(application_stylesheet_path)
 
-        append_to_file 'app/assets/stylesheets/application.scss', <<~SCSS
+        append_to_file application_stylesheet_path, <<~CSS
           @import 'login';
-        SCSS
+        CSS
       end
     end
   end

data/lib/generators/rolemodel/sentry/sentry_generator.rb

@@ -21,7 +21,7 @@ module Rolemodel
       # config/initializers/sentry.rb sets profiles_sample_rate; without stackprof
       # the SDK logs a warning on every boot and profiling is silently disabled.
       # stackprof is a native MRI extension, so restrict it to compatible platforms.
-      gem 'stackprof', platforms: :ruby
+      bundle_command 'add stackprof --platform ruby'
       run_bundle
     end
 
@@ -34,22 +34,10 @@ module Rolemodel
     def add_user_context
       say 'Adding Sentry user context to ApplicationController', :green
 
-      inject_into_class 'app/controllers/application_controller.rb', 'ApplicationController',
-                        "  before_action :set_sentry_user\n"
-
-      inject_into_file 'app/controllers/application_controller.rb', before: /^end\b/ do
-        <<-RUBY
-
-  private
-
-  # Guarded so it works whether or not an authentication generator has been run.
-  def set_sentry_user
-    return unless respond_to?(:current_user) && current_user
+      directory 'app/controllers/concerns'
 
-    Sentry.set_user(id: current_user.id)
-  end
-        RUBY
-      end
+      inject_into_class 'app/controllers/application_controller.rb', 'ApplicationController',
+                        "  include SentryUser\n"
     end
 
     def add_js_dependencies
@@ -120,7 +108,7 @@ module Rolemodel
     private
 
     def sentry_app_name
-      Rails.application.class.module_parent_name.underscore
+      Rails.application.name.underscore
     end
   end
 end

data/lib/generators/rolemodel/sentry/templates/app/controllers/concerns/sentry_user.rb

@@ -0,0 +1,13 @@
+module SentryUser
+  extend ActiveSupport::Concern
+
+  included { before_action :set_sentry_user }
+
+  private
+
+  def set_sentry_user
+    return unless respond_to?(:current_user) && current_user
+
+    Sentry.set_user(id: current_user.id)
+  end
+end

data/lib/generators/rolemodel/slim/templates/app/views/application/_head.html.slim.tt

@@ -4,10 +4,6 @@ title <%= Rails.application.class.name.deconstantize.titleize %>
 = csp_meta_tag
 
 meta name="viewport" content="width=device-width, initial-scale=1"
-meta name="turbo-refresh-method" content="morph"
-meta name="turbo-refresh-scroll" content="preserve"
 
 = stylesheet_link_tag 'application', 'data-turbo-track': 'reload'
 = javascript_include_tag 'application', 'data-turbo-track': 'reload', defer: true
-
-= yield :head

data/lib/generators/rolemodel/testing/rspec/rspec_generator.rb

@@ -10,26 +10,24 @@ module Rolemodel
       def install_rspec
         say 'Installing RSpec-rails', :green
 
-        gem_group :development, :test do
-          gem 'rspec-rails'
-        end
+        bundle_command('add rspec-rails --group "development, test"')
+      end
 
+      def install_system_test_driver
         say 'Installing capybara-playwright-driver for system tests', :green
 
-        gem_group :test do
-          gem 'capybara-playwright-driver'
+        bundle_command('add capybara-playwright-driver --group "test"')
+        bundle_command('add marsh_grass --group "test"') if options.marsh_grass?
+      end
 
-          if options.marsh_grass?
-            gem 'marsh_grass'
-            gem 'pry'
-          end
-        end
+      def bundle_install
         run_bundle
       end
 
       def install_playwright
         say 'Installing Playwright for system tests', :green
 
+        ensure_yarn
         run 'yarn add --dev playwright'
         run 'yarn run playwright install'
       end

data/lib/generators/rolemodel/testing/vitest/vitest_generator.rb

@@ -16,6 +16,7 @@ module Rolemodel
 
       def update_test_script
         say 'Update yarn test command', :green
+        ensure_yarn
 
         add_package_json_script 'test', TEST_COMMAND
       end
@@ -23,7 +24,6 @@ module Rolemodel
       def add_dev_dependencies
         say 'Adding new dev dependency to package.json', :green
 
-        ensure_yarn
         run "yarn add --dev #{DEV_DEPENDENCIES.join(' ')}"
       end
 

data/lib/generators/rolemodel/turbo/all/README.md

@@ -0,0 +1,16 @@
+# All Generator
+
+Runs all Turbo Generators
+
+## Prerequisites
+
+  - slim
+  - webpack (if using webpack)
+  - optics
+
+## What you get
+
+  - Turbo meta tags in HEAD
+  - TurboConfirm setup
+  - Turbo Frame Modals setup
+  - Turbo-Form stimulus controller

data/lib/generators/rolemodel/turbo/all/USAGE

@@ -0,0 +1,5 @@
+Description:
+  All Turbo Generators
+
+Example:
+  rails generate rolemodel:turbo:all

data/lib/generators/rolemodel/turbo/all/all_generator.rb

@@ -0,0 +1,15 @@
+module Rolemodel
+  module Turbo
+    class AllGenerator < ::Rolemodel::GeneratorBase
+      source_root File.expand_path('templates', __dir__)
+
+      def run_generators
+        generate 'rolemodel:turbo:ready'
+        generate 'rolemodel:turbo:confirm'
+        generate 'rolemodel:turbo:modals'
+        generate 'rolemodel:turbo:form'
+      end
+    end
+  end
+end
+

data/lib/generators/rolemodel/turbo/confirm/README.md

@@ -0,0 +1,25 @@
+# Confirm Generator
+
+Add custom dialog support to `data-turbo-confirm`
+
+## Prerequisites
+
+* `rolmodel:slim`
+* `rolemodel:webpack`
+* `rolemodel:optics:base`
+
+## What you get
+
+* Custom confirm dialogs via `@rolemodel/turbo-confirm` integration
+
+## Example
+
+```slim
+  = button_to "Test Confirm", model, method: :delete, data: { \
+    turbo_confirm: "For real?!?",
+    confirm_details: "You're about to delete #{model.name}, forever. 😱",
+    confirm_button: "YOLO!",
+  }
+```
+
+data attributes other than `turbo-confirm` are optional & customizable.  See [turbo-confirm](https://github.com/RoleModel/turbo-confirm) for more details.

data/lib/generators/rolemodel/turbo/confirm/USAGE

@@ -0,0 +1,5 @@
+Description:
+  Install @rolemodel/turbo-confirm
+
+Example:
+  rails generate rolemodel:turbo:confirm

data/lib/generators/rolemodel/turbo/confirm/confirm_generator.rb

@@ -0,0 +1,35 @@
+module Rolemodel
+  module Turbo
+    class ConfirmGenerator < ::Rolemodel::GeneratorBase
+      source_root File.expand_path('templates', __dir__)
+
+      def add_turbo_confirm_package
+        say 'Installing Turbo Confirm package', :green
+
+        ensure_yarn
+        run 'yarn add @rolemodel/turbo-confirm'
+      end
+
+      def add_initializer
+        template 'app/javascript/initializers/turbo_confirm.js'
+
+        append_to_file 'app/javascript/application.js' do
+          optimize_indentation <<~JS
+            import './initializers/turbo_confirm.js'
+          JS
+        end
+      end
+
+      def add_view_partial
+        template 'app/views/application/_confirm.html.slim'
+
+        inject_into_file 'app/views/layouts/application.html.slim', after: /\bbody.*\n/ do
+          optimize_indentation <<~SLIM, 4
+            = render 'confirm'
+          SLIM
+        end
+      end
+    end
+  end
+end
+

data/lib/generators/rolemodel/turbo/form/README.md

@@ -0,0 +1,8 @@
+# Form Generator
+
+Enable the "turbo-fetch" (now Turbo-Form) pattern in new/existing rails apps.
+
+## What you get
+
+  - turbo-form controller
+  - system spec helper

data/lib/generators/rolemodel/turbo/form/USAGE

@@ -0,0 +1,5 @@
+Description:
+  Enable Dynamic Form Interactions
+
+Example:
+  rails generate rolemodel:turbo:form

data/lib/generators/rolemodel/turbo/form/form_generator.rb

@@ -0,0 +1,29 @@
+module Rolemodel
+  module Turbo
+    class FormGenerator < GeneratorBase
+      source_root File.expand_path('templates', __dir__)
+
+      def add_rails_request_package
+        say 'Installing @rails/request.js package', :green
+
+        ensure_yarn
+        run 'yarn add @rails/request.js'
+      end
+
+      def add_stimulus_controller
+        say 'Adding Turbo Form Stimulus Controller', :green
+
+        directory 'app/javascript/controllers'
+
+        rails_command 'stimulus:manifest:update'
+      end
+
+      def add_system_spec_helper
+        say 'Adding Turbo Form System Spec Helper', :green
+
+        directory 'spec/support/helpers'
+      end
+    end
+  end
+end
+

data/lib/generators/rolemodel/turbo/form/templates/app/javascript/controllers/turbo_form_controller.js

@@ -0,0 +1,15 @@
+import { Controller } from '@hotwired/stimulus'
+import { patch } from '@rails/request.js'
+
+export default class extends Controller {
+  static values = { url: String, count: Number }
+
+  async perform({ params: { url: urlParam, query: queryParams } }) {
+    const body = new FormData(this.element)
+
+    if (queryParams) Object.keys(queryParams).forEach(key => body.append(key, queryParams[key]))
+
+    const response = await patch(urlParam || this.urlValue, { body, responseKind: 'turbo-stream' })
+    if (response.ok) this.countValue += 1
+  }
+}

data/lib/generators/rolemodel/turbo/form/templates/spec/support/helpers/turbo_form_helper.rb

@@ -0,0 +1,8 @@
+module TurboFormHelper
+  def expect_turbo_form_request
+    count_value = find("[data-controller='turbo-form']")['data-turbo-form-count-value'] || 0
+    yield
+    expect(page).to have_selector("[data-turbo-form-count-value='#{count_value.to_i + 1}']"),
+                    'Expected a successful Turbo-Form request, but none was detected'
+  end
+end

data/lib/generators/rolemodel/{ui_components → turbo}/modals/README.md

@@ -9,10 +9,8 @@
 
 ## What you get
 
-* Custom confirm dialogs via `@rolemodel/turbo-confirm` integration
 * RoleModel Modal pattern integration. See Notes below for usage documentation.
 * RoleModel Panel pattern integration, if run with the `--panels` flag.
-* some generally useful, global Turbo before-morph handlers.
 
 > [!IMPORTANT]
 > This generator does not provide RoleModel Panel integration, unless run with the `--panels` flag.

data/lib/generators/rolemodel/turbo/modals/USAGE

@@ -0,0 +1,5 @@
+Description:
+  Enable Turbo Frame Modals/Panels Pattern
+
+Example:
+  rails generate rolemodel:turbo:modals

data/lib/generators/rolemodel/{ui_components → turbo}/modals/modals_generator.rb

@@ -1,22 +1,13 @@
 module Rolemodel
-  module UiComponents
-    class ModalsGenerator < GeneratorBase
+  module Turbo
+    class ModalsGenerator < ::Rolemodel::GeneratorBase
       source_root File.expand_path('templates', __dir__)
       class_option :panels, type: :boolean, default: false, desc: 'Include RoleModel Panel Setup'
 
-      def turbo_confirm
-        say 'Installing Turbo Confirm package', :green
-
-        ensure_yarn
-        run 'yarn add @rolemodel/turbo-confirm'
-      end
-
       def helpers_and_views
         say 'generating views & helpers', :green
 
-        copy_file 'app/helpers/turbo_frame_link_helper.rb'
-
-        directory 'app/views/application'
+        directory 'app/helpers'
         directory 'app/views/layouts'
       end
 
@@ -27,9 +18,7 @@ module Rolemodel
         directory 'app/javascript/initializers'
 
         append_to_file 'app/javascript/application.js', <<~JS
-          import './initializers/turbo_confirm.js'
           import './initializers/frame_missing_handler.js'
-          import './initializers/before_morph_handler.js'
         JS
       end
 
@@ -39,7 +28,6 @@ module Rolemodel
         inject_into_file 'app/views/layouts/application.html.slim', after: /\bbody.*\n/ do
           optimize_indentation <<~SLIM, 4
             = turbo_frame_tag 'modal'
-            = render 'confirm'
           SLIM
         end
       end
@@ -48,18 +36,15 @@ module Rolemodel
         if options.panels?
           say 'Setting Up RoleModel Panel', :green
 
-          inject_into_file 'app/views/layouts/application.html.slim', after: /\bturbo_frame_tag 'modal'\n/ do
+          inject_into_file 'app/views/layouts/application.html.slim', after: /\bturbo_frame_tag 'modal'.*\n/ do
             optimize_indentation <<~SLIM, 4
               = turbo_frame_tag 'panel'
             SLIM
           end
 
-          inject_into_file 'app/assets/stylesheets/application.scss',
-                          after: "@import '@rolemodel/optics/dist/css/optics';\n" do
-            <<~SCSS
-              @import '@rolemodel/optics/dist/css/addons/panel';
-            SCSS
-          end
+          append_to_file application_stylesheet_path, <<~CSS
+            @import '@rolemodel/optics/dist/css/addons/panel';
+          CSS
         else
           remove_file 'app/views/layouts/panel.html.slim'
         end
@@ -68,8 +53,9 @@ module Rolemodel
       def register_stimulus_controller
         say 'updating stimulus manifest', :green
 
-        run 'rails stimulus:manifest:update'
+        rails_command 'stimulus:manifest:update'
       end
     end
   end
 end
+

data/lib/generators/rolemodel/turbo/ready/README.md

@@ -0,0 +1,12 @@
+# Ready Generator
+
+This generator is designed to make your application "Turbo Ready".
+
+That is, "ready" for modern Turbo Features such as "morphing", "scroll preservation" and meta tag injection via Turbo-Rails helpers.
+
+## What you get
+
+- a "head" outlet in your "head" partial (expected by all Turbo-Rails helpers)
+- morphing and scroll preservation meta tags
+- generally useful event handlers.
+- a stimulus controller for skipping specific attribute morphing

data/lib/generators/rolemodel/turbo/ready/USAGE

@@ -0,0 +1,5 @@
+Description:
+  Prepare your application for modern Turbo Integration
+
+Example:
+  rails generate rolemodel:turbo:ready

data/lib/generators/rolemodel/turbo/ready/ready_generator.rb

@@ -0,0 +1,48 @@
+module Rolemodel
+  module Turbo
+    class ReadyGenerator < ::Rolemodel::GeneratorBase
+      source_root File.expand_path('templates', __dir__)
+
+      def add_javascript_initializer
+        say 'generating & importing morph event handlers', :green
+
+        directory 'app/javascript/initializers'
+
+        append_to_file 'app/javascript/application.js', <<~JS
+          import './initializers/before_morph_handler.js'
+        JS
+      end
+
+      def add_stimulus_controller
+        say 'adding prevent-morph controller & updating manifest', :green
+
+        directory 'app/javascript/controllers'
+
+        rails_command 'stimulus:manifest:update'
+      end
+
+      def inject_meta_tags
+        say 'adding meta tags to head partial', :green
+
+        inject_into_file 'app/views/application/_head.html.slim', after: /meta name="viewport".*\n/ do
+          optimize_indentation <<~SLIM
+            meta name="turbo-refresh-method" content="morph"
+            meta name="turbo-refresh-scroll" content="preserve"
+          SLIM
+        end
+      end
+
+      def inject_head_outlet
+        say 'adding head outlet to head partial', :green
+
+        append_to_file 'app/views/application/_head.html.slim' do
+          optimize_indentation <<~SLIM
+
+            = yield :head
+          SLIM
+        end
+      end
+    end
+  end
+end
+

data/lib/generators/rolemodel/turbo/ready/templates/app/javascript/controllers/prevent_morph_controller.js

@@ -0,0 +1,22 @@
+import { Controller } from "@hotwired/stimulus"
+
+export default class extends Controller {
+  static values = {
+    attributeName: String
+  }
+
+  /**
+   * Use this method to prevent morphing of a specific attribute on specific elements. This is useful for attributes that may have changed due to user interaction
+   * NOTE: The "open" attribute is preserved by default in 'app/javascript/initializers/before_morph_handler.js' and does not require this controller to be used.
+   *
+   * Example:
+   *   <details controller="prevent-morph" data-prevent-morph-attribute-name-value="open" data-action="turbo:before-morph-attribute->prevent-morph#onNamedAttribute">
+   *
+   * @param {import("@hotwired/turbo").TurboBeforeMorphAttributeEvent} event
+   */
+  onNamedAttribute(event) {
+    if (event.detail.attributeName === this.attributeNameValue) {
+      event.preventDefault()
+    }
+  }
+}

data/lib/generators/rolemodel/ui_components/navbar/navbar_generator.rb

@@ -8,7 +8,7 @@ module Rolemodel
       def copy_navbar_files
         say 'Copying Navbar files', :green
 
-        copy_file 'app/views/layouts/_navbar.html.slim'
+        directory 'app/views'
       end
 
       def insert_navbar_before_content
@@ -17,7 +17,7 @@ module Rolemodel
         insert_into_file 'app/views/layouts/application.html.slim', before: /\s+\.app__content/ do
           optimize_indentation <<~SLIM, 4
 
-            = render 'layouts/navbar'
+            = render 'navbar'
           SLIM
         end
       end
@@ -32,23 +32,19 @@ module Rolemodel
       def add_shoelace_javascript_imports
         say 'Copying Shoelace JS imports', :green
 
-        copy_file 'app/javascript/lib/shoelace.js'
-        append_to_file 'app/javascript/application.js' do
-          <<~JS
-            import './lib/shoelace.js'
-          JS
-        end
+        directory 'app/javascript/lib'
+        append_to_file 'app/javascript/application.js', <<~JS
+          import './lib/shoelace.js'
+        JS
       end
 
       def copy_shoelace_css_imports
         say 'Copying Shoelace CSS imports', :green
 
-        copy_file 'app/assets/stylesheets/components/shoelace/index.scss'
-        append_to_file 'app/assets/stylesheets/application.scss' do
-          <<~SCSS
-            @import 'components/shoelace/index.scss';
-          SCSS
-        end
+        copy_file 'app/assets/stylesheets/components/shoelace/index.css'
+        append_to_file application_stylesheet_path, <<~CSS
+          @import 'components/shoelace/index.css';
+        CSS
       end
     end
   end

data/lib/generators/rolemodel/webpack/templates/postcss.config.cjs

@@ -1,9 +1,6 @@
 module.exports = {
   syntax: require('postcss-scss'),
   plugins: [
-    require('@csstools/postcss-sass')({
-      includePaths: ['node_modules']
-    }),
     require('postcss-preset-env')({
       autoprefixer: {
         flexbox: 'no-2009'

data/lib/generators/rolemodel/webpack/templates/webpack.config.js

@@ -15,7 +15,7 @@ export default {
   entry: {
     application: [
       './app/javascript/application.js',
-      './app/assets/stylesheets/application.scss'
+      './app/assets/stylesheets/application.css'
     ]
   },
   output: {
@@ -60,9 +60,11 @@ export default {
           {
             loader: 'css-loader',
             options: {
-              url: false
+              url: false,
+              importLoaders: 1
             }
           },
+          'strip-sourcemap-loader',
           'postcss-loader'
         ]
       }

data/lib/generators/rolemodel/webpack/webpack_generator.rb

@@ -2,9 +2,6 @@ module Rolemodel
   class WebpackGenerator < GeneratorBase
     source_root File.expand_path('templates', __dir__)
 
-    class_option :sentry, type: :boolean, default: false,
-                          desc: 'Also run the rolemodel:sentry generator'
-
     DEV_DEPS = %w[
       esbuild
       esbuild-loader
@@ -26,6 +23,18 @@ module Rolemodel
       mini-css-extract-plugin
     ]
 
+    def ensure_no_importmap
+      return unless Rails.root.join(destination_root, 'config/importmap.rb').exist?
+
+      remove_file 'config/importmap.rb'
+      bundle_command 'remove importmap-rails'
+    end
+
+    def ensure_jsbundling
+      bundle_command 'add jsbundling-rails'
+      run_bundle
+    end
+
     def ensure_node_version
       say "Establish development environment Node version of #{set_color(NODE_VERSION, :yellow)}", :green
 
@@ -57,28 +66,11 @@ module Rolemodel
       run "yarn add --dev #{dependencies.join(' ')}"
     end
 
-    def replace_css_entrypoint_with_scss
-      say 'Replacing CSS entrypoint file with SCSS version', :green
-
-      remove_file 'app/assets/stylesheets/application.css'
-      copy_file 'app/assets/stylesheets/application.scss'
-    end
-
     def add_webpack_config
       say 'Copying PostCSS & Webpack config files', :green
 
       copy_file 'postcss.config.cjs', force: true
       copy_file 'webpack.config.js', force: true
     end
-
-    # All Sentry concerns (including wiring its plugin into webpack.config.js)
-    # live in the Sentry generator; this option is a convenience for setting up
-    # both in one run. Runs last so webpack.config.js exists before the Sentry
-    # generator injects into it.
-    def run_sentry_generator
-      return unless options.sentry?
-
-      generate 'rolemodel:sentry'
-    end
   end
 end

data/lib/rolemodel/generator_base.rb

@@ -3,52 +3,30 @@
 require 'rails/generators'
 require 'rails/generators/bundle_helper'
 require_relative 'replace_content_helper'
+require 'rolemodel/yarn'
 
 module Rolemodel
   class GeneratorBase < ::Rails::Generators::Base
     include ::Rails::Generators::BundleHelper, ReplaceContentHelper
 
+
     private
     # based on https://github.com/rails/rails/blob/main/railties/lib/rails/generators/app_base.rb#L713
     def run_bundle
       bundle_command("install --quiet", "BUNDLE_IGNORE_MESSAGES" => "1")
     end
 
-    # Enable Corepack and pin the project to Yarn 4+ (instead of the classic
-    # Yarn 1.22). Idempotent, so any generator can call it before running a
-    # `yarn` command to guarantee the modern toolchain is in place.
+    # Enable Corepack and pin the project to Yarn 4+ before running any `yarn`
+    # command. Empty args/opts are required: without them, Thor forwards this
+    # generator's own CLI args (e.g. the test harness's --skip-bundle
+    # --skip-bootsnap) into Rolemodel::Yarn#setup, which takes none and raises
+    # Thor::InvocationError.
     def ensure_yarn
-      return if @yarn_ensured
-
-      run 'corepack enable'
-
-      unless File.exist?(File.expand_path('package.json', destination_root))
-        create_file 'package.json', JSON.pretty_generate({}) + "\n"
-      end
-
-      # Configure the node-modules linker so webpack, Playwright, and the Rails
-      # asset pipeline keep working (Yarn 4 defaults to Plug'n'Play otherwise).
-      create_file '.yarnrc.yml', "nodeLinker: node-modules\n", force: true
-
-      pin_yarn_version
-      ignore_yarn_install_state
-
-      @yarn_ensured = true
-    end
-
-    def pin_yarn_version
-      modify_json_file('package.json') do |hash|
-        hash['packageManager'] = "yarn@#{YARN_VERSION}"
-        hash
-      end
+      invoke 'rolemodel:yarn:setup', [], {}
     end
 
-    def ignore_yarn_install_state
-      gitignore = File.expand_path('.gitignore', destination_root)
-      return create_file '.gitignore', "/.yarn/install-state.gz\n" unless File.exist?(gitignore)
-      return if File.read(gitignore).include?('/.yarn/install-state.gz')
-
-      append_to_file '.gitignore', "\n/.yarn/install-state.gz\n"
+    def application_stylesheet_path
+      Dir.glob('app/assets/stylesheets/application.*').first
     end
   end
 end

data/lib/rolemodel/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Rolemodel
-  VERSION = '2.2.0'
+  VERSION = '2.3.1'
 end

data/lib/rolemodel/yarn.rb

@@ -0,0 +1,42 @@
+require 'thor'
+require 'thor/actions'
+
+module Rolemodel
+  class Yarn < ::Thor
+    include ::Thor::Actions
+
+    # Enable Corepack and pin the project to Yarn 4+ (instead of the classic
+    # Yarn 1.22). Idempotent, so any generator can call it before running a
+    # `yarn` command to guarantee the modern toolchain is in place.
+    desc 'setup', 'Set the current stable version of Yarn, enable corepack, and initialize a package.json file'
+    def setup
+      # Configure the node-modules linker so webpack, Playwright, and the Rails
+      # asset pipeline keep working (Yarn 4 defaults to Plug'n'Play otherwise).
+      # skip if exists? to avoid overwriting any other existing config
+      create_file '.yarnrc.yml', "nodeLinker: node-modules\n", skip: true
+
+      yes! 'yarn set version stable'
+      yes! 'corepack enable'
+      yes! 'yarn init'
+
+      ignore_yarn_install_state
+    end
+
+    private
+
+    def ignore_yarn_install_state
+      gitignore = File.expand_path('.gitignore', destination_root)
+      return create_file '.gitignore', "/.yarn/install-state.gz\n" unless File.exist?(gitignore)
+      return if File.read(gitignore).include?('/.yarn/install-state.gz')
+
+      append_to_file '.gitignore', "\n/.yarn/install-state.gz\n"
+    end
+
+    def yes!(command)
+      Open3.popen3(command) do |stdin, stdout, stderr, wait_thr|
+        stdin.puts 'y'
+        stdin.close
+      end
+    end
+  end
+end

data/lib/rolemodel-rails.rb

@@ -2,8 +2,6 @@
 
 module Rolemodel
   NODE_VERSION = '24.12.0'
-  YARN_VERSION = '4.13.0'
-  RUBY_VERSION = '4.0.1'
 
   GEM_LIB = File.expand_path(__dir__)
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rolemodel-rails
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.3.1
 platform: ruby
 authors:
 - RoleModel Software Inc
@@ -135,6 +135,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rails-omakase
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: benchmark
   requirement: !ruby/object:Gem::Requirement
@@ -289,6 +303,7 @@ files:
 - lib/generators/rolemodel/sentry/README.md
 - lib/generators/rolemodel/sentry/USAGE
 - lib/generators/rolemodel/sentry/sentry_generator.rb
+- lib/generators/rolemodel/sentry/templates/app/controllers/concerns/sentry_user.rb
 - lib/generators/rolemodel/sentry/templates/app/javascript/initializers/sentry.js
 - lib/generators/rolemodel/sentry/templates/config/initializers/sentry.rb
 - lib/generators/rolemodel/simple_form/README.md
@@ -364,6 +379,32 @@ files:
 - lib/generators/rolemodel/testing/vitest/templates/spec/javascript/test-setup.js
 - lib/generators/rolemodel/testing/vitest/templates/vitest.config.js
 - lib/generators/rolemodel/testing/vitest/vitest_generator.rb
+- lib/generators/rolemodel/turbo/all/README.md
+- lib/generators/rolemodel/turbo/all/USAGE
+- lib/generators/rolemodel/turbo/all/all_generator.rb
+- lib/generators/rolemodel/turbo/confirm/README.md
+- lib/generators/rolemodel/turbo/confirm/USAGE
+- lib/generators/rolemodel/turbo/confirm/confirm_generator.rb
+- lib/generators/rolemodel/turbo/confirm/templates/app/javascript/initializers/turbo_confirm.js.tt
+- lib/generators/rolemodel/turbo/confirm/templates/app/views/application/_confirm.html.slim.tt
+- lib/generators/rolemodel/turbo/form/README.md
+- lib/generators/rolemodel/turbo/form/USAGE
+- lib/generators/rolemodel/turbo/form/form_generator.rb
+- lib/generators/rolemodel/turbo/form/templates/app/javascript/controllers/turbo_form_controller.js
+- lib/generators/rolemodel/turbo/form/templates/spec/support/helpers/turbo_form_helper.rb
+- lib/generators/rolemodel/turbo/modals/README.md
+- lib/generators/rolemodel/turbo/modals/USAGE
+- lib/generators/rolemodel/turbo/modals/modals_generator.rb
+- lib/generators/rolemodel/turbo/modals/templates/app/helpers/turbo_frame_link_helper.rb
+- lib/generators/rolemodel/turbo/modals/templates/app/javascript/controllers/toggle_controller.js
+- lib/generators/rolemodel/turbo/modals/templates/app/javascript/initializers/frame_missing_handler.js
+- lib/generators/rolemodel/turbo/modals/templates/app/views/layouts/modal.html.slim.tt
+- lib/generators/rolemodel/turbo/modals/templates/app/views/layouts/panel.html.slim.tt
+- lib/generators/rolemodel/turbo/ready/README.md
+- lib/generators/rolemodel/turbo/ready/USAGE
+- lib/generators/rolemodel/turbo/ready/ready_generator.rb
+- lib/generators/rolemodel/turbo/ready/templates/app/javascript/controllers/prevent_morph_controller.js
+- lib/generators/rolemodel/turbo/ready/templates/app/javascript/initializers/before_morph_handler.js
 - lib/generators/rolemodel/ui_components/README.md
 - lib/generators/rolemodel/ui_components/USAGE
 - lib/generators/rolemodel/ui_components/all_generator.rb
@@ -372,27 +413,14 @@ files:
 - lib/generators/rolemodel/ui_components/flash/flash_generator.rb
 - lib/generators/rolemodel/ui_components/flash/templates/app/views/application/_flash.html.slim
 - lib/generators/rolemodel/ui_components/flash/templates/spec/support/matchers/flash_matchers.rb
-- lib/generators/rolemodel/ui_components/modals/README.md
-- lib/generators/rolemodel/ui_components/modals/USAGE
-- lib/generators/rolemodel/ui_components/modals/modals_generator.rb
-- lib/generators/rolemodel/ui_components/modals/templates/app/helpers/turbo_frame_link_helper.rb
-- lib/generators/rolemodel/ui_components/modals/templates/app/javascript/controllers/morph_controller.js
-- lib/generators/rolemodel/ui_components/modals/templates/app/javascript/controllers/toggle_controller.js
-- lib/generators/rolemodel/ui_components/modals/templates/app/javascript/initializers/before_morph_handler.js
-- lib/generators/rolemodel/ui_components/modals/templates/app/javascript/initializers/frame_missing_handler.js
-- lib/generators/rolemodel/ui_components/modals/templates/app/javascript/initializers/turbo_confirm.js
-- lib/generators/rolemodel/ui_components/modals/templates/app/views/application/_confirm.html.slim
-- lib/generators/rolemodel/ui_components/modals/templates/app/views/layouts/modal.html.slim.tt
-- lib/generators/rolemodel/ui_components/modals/templates/app/views/layouts/panel.html.slim.tt
 - lib/generators/rolemodel/ui_components/navbar/README.md
 - lib/generators/rolemodel/ui_components/navbar/USAGE
 - lib/generators/rolemodel/ui_components/navbar/navbar_generator.rb
-- lib/generators/rolemodel/ui_components/navbar/templates/app/assets/stylesheets/components/shoelace/index.scss
+- lib/generators/rolemodel/ui_components/navbar/templates/app/assets/stylesheets/components/shoelace/index.css
 - lib/generators/rolemodel/ui_components/navbar/templates/app/javascript/lib/shoelace.js
-- lib/generators/rolemodel/ui_components/navbar/templates/app/views/layouts/_navbar.html.slim
+- lib/generators/rolemodel/ui_components/navbar/templates/app/views/application/_navbar.html.slim
 - lib/generators/rolemodel/webpack/README.md
 - lib/generators/rolemodel/webpack/USAGE
-- lib/generators/rolemodel/webpack/templates/app/assets/stylesheets/application.scss
 - lib/generators/rolemodel/webpack/templates/postcss.config.cjs
 - lib/generators/rolemodel/webpack/templates/webpack.config.js
 - lib/generators/rolemodel/webpack/webpack_generator.rb
@@ -411,6 +439,7 @@ files:
 - lib/rolemodel/utility.rb
 - lib/rolemodel/utility/task_tools.rb
 - lib/rolemodel/version.rb
+- lib/rolemodel/yarn.rb
 homepage: https://github.com/RoleModel/rolemodel_rails
 licenses:
 - MIT
@@ -429,7 +458,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.6
+rubygems_version: 4.0.3
 specification_version: 4
 summary: The RoleModel Way of building Rails apps.
 test_files: []

data/lib/generators/rolemodel/ui_components/modals/USAGE

@@ -1,8 +0,0 @@
-Description:
-  Add Modal, Panel, and Confirmation components
-
-Example:
-  bin/rails generate rolemodel:ui_components:modals
-
-Example including RoleModel Panel Integration:
-  bin/rails generate rolemodel:ui_components:modals --panels

data/lib/generators/rolemodel/ui_components/modals/templates/app/javascript/controllers/morph_controller.js

@@ -1,23 +0,0 @@
-import { Controller } from "@hotwired/stimulus"
-
-export default class extends Controller {
-  static values = {
-    attributeName: String
-  }
-
-  /**
-   * Use this method in conjunction with the turbo:before-morph-attribute event to prevent morphing of a specific
-   * attribute on an element. This is useful for attributes that may change due to user interaction, such as the "open"
-   * attribute on a details element, which can be toggled by the user and should not be overridden by Turbo's morphing process.
-   *
-   * Example:
-   *   <details controller="morph" data-morph-attribute-name-value="open" data-action="turbo:before-morph-attribute->morph#skipMorphAttribute">
-   *
-   * @param {import("@hotwired/turbo").TurboBeforeMorphAttributeEvent} event
-   */
-  skipMorphAttribute(event) {
-    if (event.detail.attributeName === this.attributeNameValue) {
-      event.preventDefault()
-    }
-  }
-}

data/lib/generators/rolemodel/webpack/templates/app/assets/stylesheets/application.scss

@@ -1,5 +0,0 @@
-// This is a manifest file that'll be compiled into application.css, which will include
-// all the files listed below.
-//
-// For example:
-// @import 'components/modal';