rolemodel-rails 2.0.1 → 2.2.0

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

@@ -6,6 +6,7 @@ module Rolemodel
       def add_optics_package
         say 'installing Optics package', :green
 
+        ensure_yarn
         run 'yarn add @rolemodel/optics'
       end
 

data/lib/generators/rolemodel/react/react_generator.rb

@@ -6,6 +6,7 @@ module Rolemodel
       @add_react = yes?('Would you like to add react?')
 
       if @add_react
+        ensure_yarn
         run 'yarn add react react-dom'
       end
     end

data/lib/generators/rolemodel/readme/templates/README.md.erb

@@ -81,12 +81,10 @@ When finished with the feature and the code has been reviewed, the commits shoul
 ## [Staging](http://staging.<applicationname>.com)
 ## [Production](http://app.<applicationname>.com)
 ## External services
-* [HoneyBadger](http://honeybadger.io)
-* [Skylight](http://skylight.io)
+* [Sentry](https://sentry.io)
 * [SendGrid](http://sendgrid.com/RoleModel)
 * [Heroku](http://herokuapp.com)
 
-## [CI](http://semaphoreci.com/RoleModel)
 ## [Core project presentation](http://docs.google.com)
 ## [List of contributors](http://github.com/RoleModel)
 ## [Change log](file://./docs/change_log.md)
@@ -113,4 +111,4 @@ The application is deployed to Heroku. They are also hosting the DNS. We certifi
 * Larry Anderson - 919-555-1213
 
 # Copyright & licensing
-Copyright (c) 2019 Closed Source @CompanyName
+Copyright (c) 2026 Closed Source @CompanyName

data/lib/generators/rolemodel/sentry/README.md

@@ -0,0 +1,25 @@
+# Sentry Generator
+
+## What you get
+
+Error monitoring and performance tracing via [Sentry](https://sentry.io) for both the Ruby and JavaScript sides of the app.
+
+### Ruby
+
+* The `sentry-rails` gem
+* `config/initializers/sentry.rb` with sensible defaults: traces sampling, profiling, PII filtering via Rails' parameter filter, noisy-exception exclusion, and health-check transaction filtering
+* Sentry user context wired into `app/controllers/application_controller.rb` via a `set_sentry_user` before_action (Devise-friendly, gated on `user_signed_in?`)
+
+### JavaScript
+
+* `@sentry/browser` and `@sentry/webpack-plugin` dependencies
+* `app/javascript/initializers/sentry.js`, which initializes Sentry in production and staging only (avoids ad-blocker noise in development) and attaches the current user from a `current-user-id` meta tag
+* The `sentryWebpackPlugin` wired into `webpack.config.js` to upload source maps in production
+
+Depends on the `rolemodel:webpack` generator having already created `webpack.config.js` and `app/javascript/application.js`.
+
+## After running
+
+* Update the `project` and `applicationKey` in `webpack.config.js`, and the matching `filterKeys` in `app/javascript/initializers/sentry.js`, to match your Sentry project.
+* Set the `SENTRY_DSN`, `SENTRY_ENVIRONMENT`, and `SENTRY_AUTH_TOKEN` environment variables.
+* Render a `current-user-id` meta tag in your layout so the browser SDK can attach user context.

data/lib/generators/rolemodel/sentry/USAGE

@@ -0,0 +1,13 @@
+Description:
+    Sets up Sentry error monitoring for both Ruby and JavaScript
+
+Example:
+    rails generate rolemodel:sentry
+
+    This will:
+        Add the sentry-rails gem
+        Create config/initializers/sentry.rb
+        Add Sentry user context to app/controllers/application_controller.rb
+        Add @sentry/browser and @sentry/webpack-plugin JS dependencies
+        Create app/javascript/initializers/sentry.js
+        Wire the Sentry webpack plugin into webpack.config.js

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

@@ -0,0 +1,126 @@
+# frozen_string_literal: true
+
+module Rolemodel
+  class SentryGenerator < GeneratorBase
+    source_root File.expand_path('templates', __dir__)
+
+    JS_DEPS = %w[
+      @sentry/browser
+      @sentry/webpack-plugin
+    ]
+
+    def install_gem
+      say 'Adding sentry-rails gem', :green
+
+      bundle_command 'add sentry-rails'
+    end
+
+    def install_profiler_gem
+      say 'Adding stackprof gem for Sentry profiling', :green
+
+      # 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
+      run_bundle
+    end
+
+    def add_ruby_initializer
+      say 'Setting up Sentry for Ruby error reporting', :green
+
+      copy_file 'config/initializers/sentry.rb'
+    end
+
+    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
+
+    Sentry.set_user(id: current_user.id)
+  end
+        RUBY
+      end
+    end
+
+    def add_js_dependencies
+      say 'Adding Sentry JS dependencies to package.json', :green
+
+      ensure_yarn
+      run "yarn add --dev #{JS_DEPS.join(' ')}"
+    end
+
+    def add_js_initializer
+      say 'Setting up Sentry for JS error reporting', :green
+
+      copy_file 'app/javascript/initializers/sentry.js'
+      append_to_file 'app/javascript/application.js', <<~JS
+        import './initializers/sentry'
+      JS
+    end
+
+    # Wire the Sentry webpack plugin into webpack.config.js. Idempotent and a
+    # no-op if there's no webpack.config.js or it's already wired, so the
+    # webpack generator can safely invoke this generator via its --sentry option.
+    def configure_webpack
+      config = File.expand_path('webpack.config.js', destination_root)
+      return unless File.exist?(config)
+      return if File.read(config).include?('@sentry/webpack-plugin')
+
+      say 'Wiring Sentry into webpack.config.js', :green
+
+      inject_into_file 'webpack.config.js',
+                       "import { sentryWebpackPlugin } from '@sentry/webpack-plugin'\n",
+                       after: "import CssMinimizerPlugin from 'css-minimizer-webpack-plugin'\n"
+
+      inject_into_file 'webpack.config.js', after: "'process.env.RAILS_ENV': JSON.stringify(process.env.RAILS_ENV),\n" do
+        <<-JS
+      'process.env.SENTRY_DSN': JSON.stringify(process.env.SENTRY_DSN),
+      'process.env.SENTRY_ENVIRONMENT': JSON.stringify(process.env.SENTRY_ENVIRONMENT),
+      'process.env.SENTRY_AUTH_TOKEN': JSON.stringify(process.env.SENTRY_AUTH_TOKEN),
+        JS
+      end
+
+      gsub_file 'webpack.config.js', "    })\n  ].filter(Boolean)", <<-JS.chomp
+    }),
+
+    // Upload source maps to Sentry in production for easier debugging
+    mode === 'production' &&
+      !process.env.CI &&
+      sentryWebpackPlugin({
+        authToken: process.env.SENTRY_AUTH_TOKEN,
+        org: 'rolemodel-software',
+        project: '#{sentry_app_name}',
+        telemetry: false,
+        applicationKey: 'app-frontend'
+      })
+  ].filter(Boolean)
+      JS
+    end
+
+    def finishing_notes
+      say <<~NOTES
+
+        *** Update the sentryWebpackPlugin `project` and `applicationKey` in webpack.config.js,
+            and the matching `filterKeys` in app/javascript/initializers/sentry.js, to your Sentry project.
+
+        *** Set the SENTRY_DSN, SENTRY_ENVIRONMENT, and SENTRY_AUTH_TOKEN environment variables.
+      NOTES
+    end
+
+    private
+
+    def sentry_app_name
+      Rails.application.class.module_parent_name.underscore
+    end
+  end
+end

data/lib/generators/rolemodel/sentry/templates/app/javascript/initializers/sentry.js

@@ -0,0 +1,34 @@
+import * as Sentry from '@sentry/browser'
+
+// Only initialize Sentry in production and staging environments
+// This avoids issues with ad blockers during local development
+const environment = process.env.SENTRY_ENVIRONMENT || process.env.RAILS_ENV
+const shouldInitialize = environment === 'production' || environment === 'staging'
+
+if (shouldInitialize) {
+  Sentry.init({
+    dsn: process.env.SENTRY_DSN,
+    environment: environment,
+    sendDefaultPii: false,
+    tracesSampleRate: 0.1,
+    replaysOnErrorSampleRate: 1.0,
+    integrations: [
+      Sentry.thirdPartyErrorFilterIntegration({
+        // Must match the applicationKey in the sentryWebpackPlugin configuration
+        filterKeys: ['app-frontend'],
+        behaviour: 'drop-error-if-exclusively-contains-third-party-frames'
+      })
+    ],
+
+    // Capture user context from meta tags rendered by Rails
+    beforeSend(event) {
+      const userId = document.querySelector('meta[name="current-user-id"]')?.content
+
+      if (userId) {
+        event.user = { id: userId }
+      }
+
+      return event
+    }
+  })
+}

data/lib/generators/rolemodel/sentry/templates/config/initializers/sentry.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+Sentry.init do |config|
+  config.dsn = ENV['SENTRY_DSN']
+  config.enable_logs = true
+  config.debug = Rails.env.local?
+
+  # Traces sampling — 5% for HTTP requests, 10% for other transactions
+  config.traces_sampler = lambda do |sampling_context|
+    transaction_context = sampling_context[:transaction_context]
+
+    case transaction_context[:op]
+    when /^http/
+      0.05
+    else
+      0.10
+    end
+  end
+
+  # Enable profiling at 100% of sampled transactions
+  config.profiles_sample_rate = 1.0
+
+  # Breadcrumbs configuration
+  config.breadcrumbs_logger = [:sentry_logger, :http_logger]
+
+  # Exclude common noisy exceptions
+  config.excluded_exceptions += [
+    'ActiveRecord::RecordNotFound',
+    'ActionController::RoutingError',
+  ]
+
+  # Include local variables for debugging
+  config.include_local_variables = true
+
+  # Filter out health check transactions
+  config.before_send_transaction = lambda do |event, _hint|
+    return nil if event.transaction&.match?(/health|ping|metrics/)
+    event
+  end
+
+  # Filter sensitive data using Rails' parameter filter
+  filter = ActiveSupport::ParameterFilter.new(Rails.application.config.filter_parameters)
+  config.send_default_pii = false
+
+  config.before_send = lambda do |event, _hint|
+    if event.extra
+      event.extra = filter.filter(event.extra)
+    end
+
+    if event.user
+      event.user = filter.filter(event.user)
+    end
+
+    if event.contexts
+      event.contexts = filter.filter(event.contexts)
+    end
+
+    event
+  end
+
+  config.enabled_patches << :logger
+  config.std_lib_logger_filter = proc do |_logger, _message, severity|
+    [:warn, :error, :fatal].include?(severity)
+  end
+
+  config.rails.register_error_subscriber = Rails.env.production?
+  config.rails.structured_logging.subscribers = config.rails.structured_logging.subscribers.slice(:action_controller)
+end

data/lib/generators/rolemodel/simple_form/README.md

@@ -8,3 +8,9 @@
 * SimpleForm scaffold generation template
 
 Adds SimpleForm for simplified and unified styling that automatically wraps inputs with classes
+
+## Custom inputs
+
+All standard custom inputs are included by default. The generator prompts you to
+confirm whether to include the `tailored_select` custom input, since not every
+project uses the tailored-select web component.

data/lib/generators/rolemodel/simple_form/USAGE

@@ -9,3 +9,6 @@ Example:
         config/locales/simple_form.en.yml
         simple_form input wrapper classes
         simple_form template file
+
+    Pass --tailored_select to also install the experimental tailored_select
+    component input (via the rolemodel:tailored_select generator).

data/lib/generators/rolemodel/simple_form/simple_form_generator.rb

@@ -4,6 +4,9 @@ module Rolemodel
   class SimpleFormGenerator < GeneratorBase
     source_root File.expand_path('templates', __dir__)
 
+    class_option :tailored_select, type: :boolean, default: false,
+                                   desc: 'Install the tailored_select experimental component input'
+
     def add_gem
       Bundler.with_unbundled_env do
         bundle_command 'add simple_form'
@@ -16,5 +19,13 @@ module Rolemodel
       copy_file 'config/initializers/simple_form.rb'
       copy_file 'config/locales/simple_form.en.yml'
     end
+
+    def install_tailored_select
+      return unless options.tailored_select?
+
+      # The tailored_select generator owns the input template and installs it
+      # here because simple_form is now present.
+      generate 'rolemodel:tailored_select'
+    end
   end
 end

data/lib/generators/rolemodel/simple_form/templates/app/inputs/switch_checkbox_input.rb

@@ -14,7 +14,7 @@
 # <%= f.input :my_field, as: :switch_checkbox, label_after_input: true %>
 # <%= f.input :my_field, as: :switch_checkbox, wrapper: :switch_wrapper %>
 class SwitchCheckboxInput < SimpleForm::Inputs::BooleanInput
-  def input(wrapper_options = nil)
+  def input(wrapper_options = nil) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
     merged_input_options = merge_wrapper_options(input_html_options, wrapper_options)
 
     switch_group = template.content_tag(:div, class: "switch #{'switch--small' if options[:small]}") do

data/lib/generators/rolemodel/tailored_select/USAGE

@@ -1,5 +1,6 @@
 Description:
-  runs the tailored select generator
+  Installs the @rolemodel/tailored-select package. If the app is using
+  SimpleForm, it also installs the matching tailored_select SimpleForm input.
 
 Example:
   rails generate rolemodel:tailored_select

data/lib/generators/rolemodel/tailored_select/tailored_select_generator.rb

@@ -7,7 +7,22 @@ module Rolemodel
     def add_tailored_select_package
       say 'Installing Tailored Select package', :green
 
+      ensure_yarn
       run 'yarn add @rolemodel/tailored-select'
     end
+
+    def add_simple_form_input
+      return unless simple_form?
+
+      say 'Installing the Tailored Select SimpleForm input', :green
+
+      copy_file 'app/inputs/tailored_select_input.rb'
+    end
+
+    private
+
+    def simple_form?
+      File.exist?(File.expand_path('config/initializers/simple_form.rb', destination_root))
+    end
   end
 end

data/lib/generators/rolemodel/testing/factory_bot/templates/support/factory_bot.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 RSpec.configure do |config|
   config.include FactoryBot::Syntax::Methods
 end

data/lib/generators/rolemodel/testing/jasmine_playwright/jasmine_playwright_generator.rb

@@ -18,8 +18,8 @@ module Rolemodel
         raise Thor::InvocationError, 'a --github_package_token option or GITHUB_PACKAGES_TOKEN environment variable is required' if options[:github_package_token].blank?
       end
 
-      def yarn_init_unless_package_json_exists
-        run 'yarn init' unless File.exist?(File.expand_path('package.json', destination_root))
+      def enable_corepack_and_yarn
+        ensure_yarn
       end
 
       def add_browser_test_script

data/lib/generators/rolemodel/testing/rspec/templates/spec/rails_helper.rb.tt

@@ -70,7 +70,10 @@ RSpec.configure do |config|
       prep_passed = system 'rails spec:prepare'
       ENV['ASSET_PRECOMPILE_SUCCESSFUL'] = 'true'
 
-      abort "\nYour assets didn't compile. Exiting WITHOUT running any tests. Review the output above to resolve any errors." unless prep_passed
+      unless prep_passed
+        abort "\nYour assets didn't compile. Exiting WITHOUT running any tests. " \
+              'Review the output above to resolve any errors.'
+      end
     end
   end
 end

data/lib/generators/rolemodel/testing/rspec/templates/spec/support/capybara_drivers.rb.tt

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 RSpec.configure do |config|
   Capybara.register_driver :playwright_headless do |app|
     create_driver(app)

data/lib/generators/rolemodel/testing/rspec/templates/spec/support/helpers/action_cable_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActionCableHelper
   def wait_for_stream_connection
     expect(page).to have_selector('turbo-cable-stream-source[connected]', visible: false)

data/lib/generators/rolemodel/testing/rspec/templates/spec/support/helpers/test_element_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module TestElementHelper
   include ActionView::RecordIdentifier
 

data/lib/generators/rolemodel/testing/rspec/templates/spec/support/helpers.rb.tt

@@ -1,4 +1,6 @@
-Dir[Rails.root.join('spec', 'support', 'helpers', '**', '*.rb')].each { |f| require f }
+# frozen_string_literal: true
+
+Rails.root.glob('spec/support/helpers/**/*.rb').each { |f| require f }
 
 # this is a place to pull in all your app specific DSL methods.
 

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

@@ -23,6 +23,7 @@ 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/ui_components/modals/modals_generator.rb

@@ -7,6 +7,7 @@ module Rolemodel
       def turbo_confirm
         say 'Installing Turbo Confirm package', :green
 
+        ensure_yarn
         run 'yarn add @rolemodel/turbo-confirm'
       end
 

data/lib/generators/rolemodel/ui_components/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/ui_components/navbar/navbar_generator.rb

@@ -25,6 +25,7 @@ module Rolemodel
       def install_shoelace
         say 'Installing Shoelace package', :green
 
+        ensure_yarn
         run 'yarn add @shoelace-style/shoelace'
       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/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'
 
@@ -73,7 +71,8 @@ export default {
   optimization: {
     minimize: mode === 'production',
     minimizer: [
-      new TerserPlugin(),
+      // '...' keeps webpack 5's built-in JS minimizer (terser)
+      '...',
       new CssMinimizerPlugin()
     ]
   },
@@ -88,17 +87,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

@@ -2,9 +2,10 @@ 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[
-      @honeybadger-io/webpack
-      @honeybadger-io/js
       esbuild
       esbuild-loader
       webpack
@@ -31,6 +32,12 @@ module Rolemodel
       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,15 +57,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
 
@@ -72,5 +70,15 @@ module Rolemodel
       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

@@ -13,5 +13,42 @@ module Rolemodel
     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.
+    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
+    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"
+    end
   end
 end