rolemodel-rails 2.1.0 → 2.3.0

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,21 +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
-
-        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
 
@@ -26,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
 
@@ -38,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
@@ -47,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
@@ -67,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/{ui_components → turbo}/modals/templates/app/helpers/turbo_frame_link_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module TurboFrameLinkHelper
   def panel_link_to(...)
     link_to_frame('panel', ...)

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
@@ -25,29 +25,26 @@ module Rolemodel
       def install_shoelace
         say 'Installing Shoelace package', :green
 
+        ensure_yarn
         run 'yarn add @shoelace-style/shoelace'
       end
 
       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/README.md

@@ -5,4 +5,5 @@
 * Webpack v5
 * Uses `esbuild-loader` instead of Babel to transpile JS
 * Uses PostCSS to compile CSS and SCSS
-* Honeybadger error monitoring for JS. Run `bundle exec honeybadger install [YOUR API KEY HERE]` to setup Honeybadger for Ruby.
+
+For error monitoring, run the `rolemodel:sentry` generator.

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

@@ -1,7 +1,5 @@
 import path from 'path'
 import webpack from 'webpack'
-import TerserPlugin from 'terser-webpack-plugin'
-import HoneybadgerSourceMapPlugin from '@honeybadger-io/webpack'
 import MiniCssExtractPlugin from 'mini-css-extract-plugin'
 import CssMinimizerPlugin from 'css-minimizer-webpack-plugin'
 
@@ -17,7 +15,7 @@ export default {
   entry: {
     application: [
       './app/javascript/application.js',
-      './app/assets/stylesheets/application.scss'
+      './app/assets/stylesheets/application.css'
     ]
   },
   output: {
@@ -62,9 +60,11 @@ export default {
           {
             loader: 'css-loader',
             options: {
-              url: false
+              url: false,
+              importLoaders: 1
             }
           },
+          'strip-sourcemap-loader',
           'postcss-loader'
         ]
       }
@@ -73,7 +73,8 @@ export default {
   optimization: {
     minimize: mode === 'production',
     minimizer: [
-      new TerserPlugin(),
+      // '...' keeps webpack 5's built-in JS minimizer (terser)
+      '...',
       new CssMinimizerPlugin()
     ]
   },
@@ -88,17 +89,8 @@ export default {
 
     // Replace ENV variables at build time
     new webpack.DefinePlugin({
-      'process.env.HONEYBADGER_API_KEY': JSON.stringify(process.env.HONEYBADGER_API_KEY),
-      'process.env.HONEYBADGER_ENV': JSON.stringify(process.env.HONEYBADGER_ENV),
       'process.env.RAILS_ENV': JSON.stringify(process.env.RAILS_ENV),
       'process.env.SOURCE_VERSION': JSON.stringify(process.env.SOURCE_VERSION)
-    }),
-
-    // Send source maps to HoneyBadger in production for easier debugging
-    (mode === 'production' && !process.env.CI) && new HoneybadgerSourceMapPlugin({
-      apiKey: process.env.HONEYBADGER_API_KEY,
-      assetsUrl: process.env.ASSETS_URL,
-      revision: process.env.SOURCE_VERSION
     })
   ].filter(Boolean)
 }

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

@@ -3,8 +3,6 @@ module Rolemodel
     source_root File.expand_path('templates', __dir__)
 
     DEV_DEPS = %w[
-      @honeybadger-io/webpack
-      @honeybadger-io/js
       esbuild
       esbuild-loader
       webpack
@@ -25,12 +23,30 @@ 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
 
       create_file '.node-version', NODE_VERSION, force: true
     end
 
+    def enable_corepack_and_yarn
+      say 'Enabling Corepack and pinning the project to Yarn 4+', :green
+
+      ensure_yarn
+    end
+
     def force_node_to_use_es_modules
       say 'Configuring project to use ES Modules instead of CommonJS', :green
 
@@ -50,22 +66,6 @@ module Rolemodel
       run "yarn add --dev #{dependencies.join(' ')}"
     end
 
-    def honeybadger_setup
-      say 'Setting up Honeybadger for JS error reporting', :green
-
-      copy_file 'app/javascript/initializers/honeybadger.js'
-      append_to_file 'app/javascript/application.js', <<~JS
-        import './initializers/honeybadger'
-      JS
-    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
 

data/lib/rolemodel/generator_base.rb

@@ -3,15 +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+ 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
+      invoke 'rolemodel:yarn:setup', [], {}
+    end
+
+    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.1.0'
+  VERSION = '2.3.0'
 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,7 +2,6 @@
 
 module Rolemodel
   NODE_VERSION = '24.12.0'
-  RUBY_VERSION = '4.0.1'
 
   GEM_LIB = File.expand_path(__dir__)
 end