rolemodel-rails 2.6.0 → 2.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9dec1145653dd0763c5df4ac4f21c6f2f2961ee3776fb30cf100529aacdb061e
-  data.tar.gz: be40ee27b145627cb7945eb8a7f478ef2520c7b0b6f8ab247466cfa45fdd57b4
+  metadata.gz: 54ba8996a84dfe7f2f989442444f039ebd5868a9a3f4800f800223d035f6a9d2
+  data.tar.gz: f79e30570b359cd0dc120b514127d207348589e85eb2f06414b0938aa3cd08d6
 SHA512:
-  metadata.gz: 8be97f77d771928e00785f143c43424d5557b395d2115dcd08c2243814037a830f081e51722a3a4f2318efc6467d7ca9fa4e643c68d31a2ac3af12ddc45e240c
-  data.tar.gz: ad3e144e4d3400e60f443cbe577484dafcb5640af32c803c92cdb9dedb18076b31628b4c801c91615d37e70fb69c99e0665b3de48487a1db2287459186157d9e
+  metadata.gz: 8b08a3d1b935ca08181f45fb948112194888325c6e60971c3c18b279b4cd8e9073dec7f01d8c26373bc9276e54b071c238fbece40ced0bb60da864f2c20b61c2
+  data.tar.gz: 96a5ea26590b5074da86fd3059ca6bb04e49bc3bd82fd4e2b56a3f18415dd80f2a807ef31ab396f6313034394d2e90e591eb75711a50f795744d00636ca2b298

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

@@ -17,7 +17,8 @@ app you can push straight to Heroku right after generation.
   - [Webpack](../webpack) — Webpack v5 for JS and CSS
   - [Sentry](../sentry) — error monitoring for Ruby and JavaScript
   - [Slim](../slim) — Slim templates
-  - [Optics](../optics) — Optics design system
+  - [Optics](../optics) — Optics design system (pass an icon library flag such as
+    `--material` to choose it up front; otherwise the icons generator asks)
   - [Testing](../testing) — RSpec, FactoryBot, parallel_tests, TestProf
     (pass `--js-runner` to include jasmine-playwright-runner)
   - [SimpleForm](../simple_form) — SimpleForm with our configuration

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

@@ -1,11 +1,15 @@
+require_relative '../optics/icons/icon_library_options'
+
 module Rolemodel
   class CoreSetupGenerator < ::Rolemodel::GeneratorBase
+    include Optics::IconLibraryOptions
+
     class_option :skip_deployable, type: :boolean, default: false, desc: 'skip generators for app deployment (Heroku, Sentry, Lograge)'
 
     def run_the_core_generators
       generate 'rolemodel:slim'
       generate 'rolemodel:webpack'
-      generate 'rolemodel:optics:all'
+      generate 'rolemodel:optics:all', *icon_library_flags
       generate 'rolemodel:simple_form'
       generate 'rolemodel:tom_select'
       generate 'rolemodel:testing:all'

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

@@ -16,9 +16,5 @@ It doesn't need to be run first, but the parallel_tests generator must be run in
 - Pull Request Template
   - When you open a Pull Request in Github it will use the Markdown file as a [template](./templates/pull_request_template.md) for the content of the PR.
   - Helpful for reminding collaborators to add specific details to the PR.
-- Copilot Instructions
-  - Installed into `.github/instructions`, these are context-specific instructions for Copilot to help it give more accurate
-  and relevant results. These are a good starting point but they should be tweaked for your project's frameworks and
-  standards.
 - Dependabot Configuration
   - defines a set of rules that dependabot will use to keep your applications dependencies up-to-date on a weekly basis.

data/lib/generators/rolemodel/github/USAGE

@@ -5,7 +5,6 @@ Example:
     rails generate rolemodel:github
 
     This will create:
-        .github/instructions/
         .github/workflows/ci.yml
         .github/pull_request_template.md
         .github/dependabot.yml

data/lib/generators/rolemodel/github/github_generator.rb

@@ -3,10 +3,6 @@
 module Rolemodel
   class GithubGenerator < GeneratorBase
     GITHUB_ACTIONS_REPO = 'https://github.com/RoleModel/actions.git'
-    # Files which are both used by the gem source and copied to the target app without modification
-    # are placed in the `.github` folder at the top level of this repository. This folder is then
-    # symlinked to the `templates` folder relative to this generator so they can still be copied over.
-    # Any files which are significantly different or not used by the gem source are just in `templates`.
     source_root File.expand_path('templates', __dir__)
 
     class_option :playwright, type: :boolean, default: true,
@@ -22,7 +18,6 @@ module Rolemodel
     end
 
     def install_github_config
-      directory 'instructions', '.github/instructions'
       directory 'workflows', '.github/workflows', force: true
       template 'pull_request_template.md', '.github/pull_request_template.md'
     end

data/lib/generators/rolemodel/heroku/templates/deploy-app/SKILL.md

@@ -24,12 +24,16 @@ go. Ask the user questions **one at a time**.
 
 ## Phase 0: Preflight
 
-Run these checks before touching anything. Stop and tell the user how to fix any that
-fail:
-
-1. `git remote get-url origin` — must be a GitHub repo. Derive `REPO_NAME` from
-   `gh repo view --json name -q .name` (fallback: basename of the origin URL).
-2. `gh auth status` — GitHub CLI authenticated.
+Run these checks before touching anything (creating a missing GitHub repo is the one
+exception). Stop and tell the user how to fix any that fail:
+
+1. `gh auth status` — GitHub CLI authenticated.
+2. `git remote get-url origin` — must be a GitHub repo. A brand-new app has no `origin` yet:
+   offer to create one, confirming the name (default: the app directory's name) and that it
+   should be private in the RoleModel org, then
+   `gh repo create RoleModel/<name> --private --source . --remote origin --push`.
+   Derive `REPO_NAME` from `gh repo view --json name -q .name` (fallback: basename of the
+   origin URL).
 3. `heroku auth:whoami` — Heroku CLI installed and logged in.
 4. Sentry MCP tools available (try listing organizations). If no Sentry MCP server is
    connected, ask the user to add/authorize the Sentry MCP server
@@ -41,10 +45,8 @@ fail:
    - reads `Rails.application.credentials...` → **credentials mode**
 7. Deploy-readiness (recent `rolemodel-rails` bakes these in; older apps need the manual
    fixes noted in each phase). Confirm the generated app already has:
-   - `terser-webpack-plugin` in `package.json` (webpack config imports it)
    - custom cops under `.rubocop/cops/`, not `lib/cops/` (the latter crashes prod boot)
    - `config/initializers/lograge.rb` uses `controller.try(:current_user)`
-   - `config/database.yml` `production:` block uses `url: <%= ENV["DATABASE_URL"] %>`
    - a `ruby` directive in the `Gemfile` (so the version reaches `Gemfile.lock`)
    - `stackprof` in the `Gemfile` (Sentry profiling)
    If any are missing, apply the fix inline and note the app predates the generator update.

data/lib/generators/rolemodel/linters/rubocop/templates/.rubocop/cops/form_error_response.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Cops
+  # Custom Cop to Ensure Form Error Response Statuses
+  #
+  # There are three levels of matching here:
+  # Methods (def on_if)
+  # This scans code and only stops on the method specified.
+  # E.G. `on_if` will only move into the below checks when it encounters an if statement.
+  #
+  # Node matcher (def_node_matcher :form_error)
+  # This scans the block of code (in this case, the else branch of the if block)
+  # using AST (Abstract Tree Syntax) to match certain patterns
+  #
+  # Regex
+  # This checks the specific matching line to ensure it meets our expectations
+  class FormErrorResponse < RuboCop::Cop::Base
+    extend RuboCop::Cop::AutoCorrector
+
+    def self.rack_version
+      Gem.loaded_specs['rack'].version
+    end
+
+    def self.http_status
+      if rack_version >= '3.1'
+        :unprocessable_content
+      else
+        :unprocessable_entity
+      end
+    end
+
+    # Match code in the else branch that either: is the only line and looks like `render :something, ...`
+    # or is not the first line and looks like the same.
+    def_node_matcher :form_error, <<~PATTERN
+      {(... $(send nil? :render (:sym _) ...)) | $(send nil? :render (:sym _) ...)}
+    PATTERN
+
+    MSG = "Use status: :#{self.http_status} for invalid form requests."
+
+    # Ensure the render is returning the correct status, otherwise add the offense
+    STATUS_PAIR = /\(pair\s+\(sym :status\)\s+\(sym :#{self.http_status}\)\)/m
+
+    # Only check within if blocks
+    def on_if(node)
+      form_error(node.else_branch) do |name|
+        next if name.to_s.match?(STATUS_PAIR)
+
+        add_offense(name) do |corrector|
+          corrector.insert_after(name, ", status: :#{self.class.http_status}")
+        end
+      end
+    end
+  end
+end

data/lib/generators/rolemodel/linters/rubocop/templates/.rubocop/cops/no_chrome_tag.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require 'rubocop'
+
+module Cops
+  # Detect occurences of the chrome tag in specs, and warn and remove them.
+  class NoChromeTag < RuboCop::Cop::Base
+    include RuboCop::Cop::RangeHelp
+    extend RuboCop::Cop::AutoCorrector
+
+    MSG = 'The :chrome tag is only for testing, and should not be checked into the repository.'
+    RESTRICT_ON_SEND = %i[describe context it feature scenario].freeze
+
+    def on_send(node) # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
+      node.arguments.each do |a|
+        if a.sym_type? && a.value == :chrome
+          range = range_with_surrounding_comma(a.source_range)
+          add_offense(range) do |corrector|
+            corrector.replace(range, '')
+          end
+        end
+
+        next unless a.hash_type?
+
+        a.pairs.each do |pair|
+          next unless pair.key.value == :chrome
+
+          range = range_with_surrounding_comma(pair.source_range)
+          add_offense(range) do |corrector|
+            corrector.replace(range, '')
+          end
+        end
+      end
+    end
+
+    def range_with_surrounding_comma(source_range)
+      buffer = source_range.source_buffer
+      src = buffer.source
+      end_pos = source_range.end_pos
+      comma_index = src[...end_pos].rindex(/\s*,\s*/)
+
+      Parser::Source::Range.new(buffer, comma_index, end_pos)
+    end
+  end
+end

data/lib/generators/rolemodel/linters/rubocop/templates/.rubocop.yml

@@ -0,0 +1,74 @@
+require:
+  - ./.rubocop/cops/form_error_response.rb
+  - ./.rubocop/cops/no_chrome_tag.rb
+plugins:
+  - rubocop-rails
+
+AllCops:
+  Exclude:
+    - bin/**/*
+    - db/**/*
+    - vendor/**/*
+    - config/**/*
+    - node_modules/**/*
+    - tmp/**/*
+  NewCops: enable
+
+Metrics:
+  Severity: refactor
+
+# RSpec tests and rake tasks are expected to have
+# large blocks, so exclude them from this cop.
+Metrics/BlockLength:
+  Exclude:
+    - 'Rakefile'
+    - '**/*.rake'
+    - 'spec/**/*.rb'
+
+# Hard to make this pass always and want to keep flexibility
+Layout/ArrayAlignment:
+  Enabled: false
+
+# Best Practices for readability
+Layout:
+  Severity: refactor
+
+Layout/FirstArrayElementIndentation:
+  EnforcedStyle: consistent
+
+Layout/FirstHashElementIndentation:
+  EnforcedStyle: consistent
+
+Lint/UnusedMethodArgument:
+  Severity: refactor
+  AutoCorrect: false
+
+Lint/UnusedBlockArgument:
+  Severity: refactor
+  AutoCorrect: false
+
+Lint/UselessAssignment:
+  Severity: refactor
+  AutoCorrect: false
+
+Lint/UnderscorePrefixedVariableName:
+  Enabled: false
+
+Lint/Loop:
+  Enabled: false
+
+Lint/SuppressedException:
+  Enabled: false
+
+Style:
+  Severity: refactor
+
+# It is ok to use inject at times
+Style/EachWithObject:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Cops/NoChromeTag:
+  AutoCorrect: contextual

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

@@ -2,6 +2,9 @@
 
 [USAGE](./USAGE)
 
+`rolemodel:optics:all` accepts the icons generator's library flags (`--material`, `--phosphor`,
+`--tabler`, `--feather`, `--lucide`, `--custom`) and passes them along.
+
 ## Sub Generators
 
 * [Base Optics](./base)

data/lib/generators/rolemodel/optics/all_generator.rb

@@ -1,11 +1,15 @@
+require_relative 'icons/icon_library_options'
+
 module Rolemodel
   module Optics
     class AllGenerator < Rolemodel::GeneratorBase
+      include IconLibraryOptions
+
       source_root File.expand_path('templates', __dir__)
 
       def run_all_the_generators
         generate 'rolemodel:optics:base'
-        generate 'rolemodel:optics:icons'
+        generate 'rolemodel:optics:icons', *icon_library_flags
       end
     end
   end

data/lib/generators/rolemodel/optics/icons/icon_library_options.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require_relative 'icons_generator'
+
+module Rolemodel
+  module Optics
+    # For generators that run optics:icons: accept its icon library flag (e.g. --material) and pass
+    # it along, so the icons generator doesn't stop to ask.
+    module IconLibraryOptions
+      LIBRARIES = IconsGenerator::SUPPORTED_LIBRARIES.keys.freeze
+
+      def self.included(base)
+        base.class_exclusive do
+          LIBRARIES.each { base.class_option it, type: :boolean, lazy_default: false, desc: "Use #{it} icon library" }
+        end
+      end
+
+      private
+
+      def icon_library_flags = LIBRARIES.select { options[it] }.map { "--#{it}" }
+    end
+  end
+end

data/lib/generators/rolemodel/optics/icons/icons_generator.rb

@@ -42,7 +42,7 @@ module Rolemodel
     private
 
       def capture_user_selection
-        options.slice(*SUPPORTED_LIBRARIES.keys).invert[true] || ask(
+        options.slice(*SUPPORTED_LIBRARIES.keys).invert[true] || ask_or_default(
           'What icon library would you like to add?',
           default: SUPPORTED_LIBRARIES.keys.first.to_s,
           limited_to: SUPPORTED_LIBRARIES.keys.map(&:to_s)

data/lib/generators/rolemodel/readme/readme_generator.rb

@@ -5,7 +5,7 @@ module Rolemodel
     def install_readme
       @project_name = Rails.application.class.try(:parent_name) || Rails.application.class.module_parent_name
       @project = @project_name.underscore
-      template 'README.md.erb', 'README.md'
+      template 'README.md.erb', 'README.md', force: true
     end
   end
 end

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

@@ -2,7 +2,6 @@
 
 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

data/lib/generators/rolemodel/testing/parallel_tests/templates/.rspec_parallel

@@ -0,0 +1,3 @@
+--format RspecJunitFormatter --out tmp/rspec-<%= ENV['TEST_ENV_NUMBER'] %>.xml
+--format ParallelTests::RSpec::RuntimeLogger --out tmp/turbo_rspec_runtime.log
+--format ParallelTests::RSpec::FailuresLogger

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

@@ -34,6 +34,7 @@ module Rolemodel
       def add_spec_files
         say 'Adding Support Files', :green
 
+        template '.rspec', '.rspec'
         directory 'spec'
 
         append_file '.gitignore', 'spec/examples.txt'

data/lib/generators/rolemodel/testing/rspec/templates/.rspec

@@ -0,0 +1 @@
+--require spec_helper

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

@@ -5,6 +5,7 @@ module Rolemodel
     DEV_DEPS = %w[
       esbuild
       esbuild-loader
+      strip-sourcemap-loader
       webpack
       webpack-cli
     ]

data/lib/rolemodel/generator_base.rb

@@ -10,6 +10,12 @@ module Rolemodel
     include ::Rails::Generators::BundleHelper, ReplaceContentHelper
 
     private
+
+    # Thor's ask loops forever on EOF when limited_to is set, so only prompt when someone can answer.
+    def ask_or_default(statement, default:, **)
+      $stdin.tty? ? ask(statement, default:, **) : default
+    end
+
     # 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")
@@ -22,13 +28,13 @@ module Rolemodel
     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
+    # command. Args/opts are passed explicitly: otherwise 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 Rails.root.join(destination_root, '.yarnrc.yml').exist?
-      invoke 'rolemodel:yarn:setup', [], {}
+      invoke 'rolemodel:yarn:setup', [], options.slice(:pretend)
     end
 
     def application_stylesheet_path

data/lib/rolemodel/version.rb

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

data/lib/rolemodel/yarn.rb

@@ -16,7 +16,8 @@ module Rolemodel
 
       yes! 'yarn set version stable'
       yes! 'corepack enable'
-      yes! 'yarn init'
+      # `yarn init` replaces an existing package.json, dropping the scripts and packages Rails added.
+      yes! 'yarn init' unless File.exist?(File.expand_path('package.json', destination_root))
 
       ignore_yarn_install_state
     end
@@ -32,6 +33,9 @@ module Rolemodel
     end
 
     def yes!(command)
+      say_status :run, command
+      return if options[:pretend]
+
       Open3.popen3(command) do |stdin, stdout, stderr, wait_thr|
         stdin.puts 'y'
         stdin.close

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rolemodel-rails
 version: !ruby/object:Gem::Version
-  version: 2.6.0
+  version: 2.6.1
 platform: ruby
 authors:
 - RoleModel Software Inc
@@ -203,7 +203,6 @@ files:
 - lib/generators/rolemodel/github/github_generator.rb
 - lib/generators/rolemodel/github/templates/CODEOWNERS
 - lib/generators/rolemodel/github/templates/dependabot.yml
-- lib/generators/rolemodel/github/templates/instructions
 - lib/generators/rolemodel/github/templates/pull_request_template.md
 - lib/generators/rolemodel/github/templates/workflows/ci.yml.tt
 - lib/generators/rolemodel/github/templates/workflows/deploy-production.yml
@@ -239,6 +238,9 @@ files:
 - lib/generators/rolemodel/linters/rubocop/README.md
 - lib/generators/rolemodel/linters/rubocop/USAGE
 - lib/generators/rolemodel/linters/rubocop/rubocop_generator.rb
+- lib/generators/rolemodel/linters/rubocop/templates/.rubocop.yml
+- lib/generators/rolemodel/linters/rubocop/templates/.rubocop/cops/form_error_response.rb
+- lib/generators/rolemodel/linters/rubocop/templates/.rubocop/cops/no_chrome_tag.rb
 - lib/generators/rolemodel/lograge/README.md
 - lib/generators/rolemodel/lograge/USAGE
 - lib/generators/rolemodel/lograge/lograge_generator.rb
@@ -262,6 +264,7 @@ files:
 - lib/generators/rolemodel/optics/base/base_generator.rb
 - lib/generators/rolemodel/optics/icons/README.md
 - lib/generators/rolemodel/optics/icons/USAGE
+- lib/generators/rolemodel/optics/icons/icon_library_options.rb
 - lib/generators/rolemodel/optics/icons/icons_generator.rb
 - lib/generators/rolemodel/optics/icons/templates/app/helpers/icon_helper.rb.tt
 - lib/generators/rolemodel/react/README.md
@@ -371,9 +374,11 @@ files:
 - lib/generators/rolemodel/testing/parallel_tests/README.md
 - lib/generators/rolemodel/testing/parallel_tests/USAGE
 - lib/generators/rolemodel/testing/parallel_tests/parallel_tests_generator.rb
+- lib/generators/rolemodel/testing/parallel_tests/templates/.rspec_parallel
 - lib/generators/rolemodel/testing/rspec/README.md
 - lib/generators/rolemodel/testing/rspec/USAGE
 - lib/generators/rolemodel/testing/rspec/rspec_generator.rb
+- lib/generators/rolemodel/testing/rspec/templates/.rspec
 - lib/generators/rolemodel/testing/rspec/templates/spec/rails_helper.rb.tt
 - lib/generators/rolemodel/testing/rspec/templates/spec/spec_helper.rb.tt
 - lib/generators/rolemodel/testing/rspec/templates/spec/support/capybara_config.rb.tt

data/lib/generators/rolemodel/github/templates/instructions

@@ -1 +0,0 @@
-../../../../../.github/instructions