suspenders 20230113.0 → 20250317.0

data/lib/generators/templates/ci/ci.yml.tt

@@ -0,0 +1,148 @@
+name: CI
+
+on:
+  pull_request:
+  push:
+    branches: [main]
+
+jobs:
+<%- if scan_ruby? -%>
+  scan_ruby:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: .ruby-version
+          bundler-cache: true
+
+      - name: Scan for security vulnerabilities in Ruby dependencies
+        run: |
+          bin/rails bundle:audit:update
+          bin/rails bundle:audit
+<% end -%>
+
+<%- if scan_js? -%>
+  scan_js:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: .ruby-version
+          bundler-cache: true
+
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version-file: .node-version
+
+      - name: Install modules
+        run: yarn install
+
+      - name: Scan for security vulnerabilities in JavaScript dependencies
+        run: |
+          bin/importmap audit
+          yarn audit
+<% end -%>
+
+<%- if lint? -%>
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: .ruby-version
+          bundler-cache: true
+
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version-file: .node-version
+
+      - name: Install modules
+        run: yarn install
+
+      - name: Lint Ruby code for consistent style
+        run: bin/rails standard
+
+      - name: Lint front-end code for consistent style
+        run: yarn lint
+<% end -%>
+
+  test:
+    runs-on: ubuntu-latest
+
+    services:
+      postgres:
+        image: postgres
+        env:
+          POSTGRES_USER: postgres
+          POSTGRES_PASSWORD: postgres
+        ports:
+          - 5432:5432
+        options: --health-cmd="pg_isready" --health-interval=10s --health-timeout=5s --health-retries=3
+
+      # redis:
+      #   image: redis
+      #   ports:
+      #     - 6379:6379
+      #   options: --health-cmd "redis-cli ping" --health-interval 10s --health-timeout 5s --health-retries 5
+
+    steps:
+      - name: Install packages
+        run: sudo apt-get update && sudo apt-get install --no-install-recommends -y google-chrome-stable curl libjemalloc2 libvips postgresql-client libpq-dev
+
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: .ruby-version
+          bundler-cache: true
+
+      <%- if using_node? -%>
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version-file: .node-version
+
+      - name: Install modules
+        run: yarn install
+      <%- end -%>
+
+      - name: Run tests
+        env:
+          RAILS_ENV: test
+          DATABASE_URL: postgres://postgres:postgres@localhost:5432
+          # REDIS_URL: redis://localhost:6379/0
+        <%- if using_rspec? -%>
+        run: bin/rails db:setup spec
+        <%- else -%>
+        run: bin/rails db:setup test test:system
+        <%- end -%>
+
+      - name: Keep screenshots from failed system tests
+        uses: actions/upload-artifact@v4
+        if: failure()
+        with:
+          name: screenshots
+        <%- if using_rspec? -%>
+          path: ${{ github.workspace }}/tmp/capybara
+        <%- else -%>
+          path: ${{ github.workspace }}/tmp/screenshots
+        <%- end -%>
+          if-no-files-found: ignore

data/lib/generators/templates/email/email_interceptor.rb

@@ -0,0 +1,11 @@
+class EmailInterceptor
+  include ActiveSupport::Configurable
+
+  config_accessor :interceptor_addresses, default: []
+
+  def self.delivering_email(message)
+    to = interceptor_addresses
+
+    message.to = to if to.any?
+  end
+end

data/lib/generators/templates/factories/factories_spec.rb

@@ -0,0 +1,7 @@
+require "rails_helper"
+
+RSpec.describe "Factories" do
+  it "has valid factoties" do
+    FactoryBot.lint traits: true
+  end
+end

data/lib/generators/templates/factories/factories_test.rb

@@ -0,0 +1,9 @@
+require "test_helper"
+
+class FactoryBotsTest < ActiveSupport::TestCase
+  class FactoryLintingTest < FactoryBotsTest
+    test "linting of factories" do
+      FactoryBot.lint traits: true
+    end
+  end
+end

data/lib/generators/templates/install/web/CONTRIBUTING.md

@@ -0,0 +1,94 @@
+# Contributing
+
+## Accessibility Tooling
+
+Building accessible applications is a complex, multi-faceted, and mission critical endeavor. While tooling cannot guarantee an accessible experience, it can help raise the bar for the baseline experience in important ways.
+
+In addition to the W3C's [WAI Overview][], [WAI Authoring Practices Guide][], and [WAI-ARIA Specification][], along with MDN's [Accessibility Documentation][], the [thoughtbot handbook][] includes some high-level technical guidance.
+
+[WAI Overview]: https://www.w3.org/WAI/standards-guidelines/aria/
+[WAI Authoring Practices Guide]: https://www.w3.org/WAI/ARIA/apg/
+[WAI-ARIA Specification]: https://www.w3.org/TR/wai-aria/
+[Accessibility Documentation]: https://developer.mozilla.org/en-US/docs/Web/Accessibility
+[thoughtbot guides]: https://github.com/thoughtbot/guides/blob/main/accessibility/README.md#development
+
+### Capybara and the System Test Suite
+
+[Capybara][] is responsible for driving the application's [System Test][] suite through Real Life browser sessions.
+
+Capybara drives the page and makes assertions about its state and content through utilities called [Selectors][]. They're a layer of abstraction that's a blend of HTML tag names and ARIA role semantics. For example, Capybara uses the `:link` selector whether it needs to locate and click on an `<a>` element through a call to [click_link][] or make an assertion about the presence and content of an `<a>` element through a call to [assert_link][].
+
+Out of the box, Capybara provides a wide range of [built-in selectors][] that cover the majority of a System Test harness' needs. In addition to the out of the box selectors, this project also depends on the [capybara_accessible_selectors][] gem to expand Capybara's set of selectors.
+
+If you find yourself in a situation where you're reaching for CSS selectors or other means of resolving nodes, you might benefit from a built-in selector or one provided by `capybara_accessible_selectors`. Take this test block, for example:
+
+```ruby
+# <fieldset class="some-css selector-chain">
+#   <legend>Some fields</legend>
+#
+#   <button class="my-button">Click me</button>
+#
+#   <label>
+#     Fill me in
+#     <input class=".my-text-field">
+#   </label>
+# </fieldset>
+
+# BEFORE
+within ".some-css .selector-chain" do
+  find(".my-button").click
+  find(".my-text-field").set "Hello, world"
+end
+
+# AFTER
+within :fieldset, "Some field" do
+  click_button "Click me"
+  fill_in "Fill me in", with: "Hello, world"
+end
+```
+
+The [Testing RSpec][] section of the `thoughtbot/guides` provides some general guidance for automated Acceptance Testing.
+
+[Capybara]: https://rubydoc.info/github/teamcapybara/capybara/master/
+[System Test]: https://guides.rubyonrails.org/testing.html#system-testing
+[Selectors]: https://rubydoc.info/github/teamcapybara/capybara/master#selectors
+[click_link]: https://rubydoc.info/github/teamcapybara/capybara/master/Capybara/Node/Actions:click_link
+[assert_link]: https://rubydoc.info/github/teamcapybara/capybara/master/Capybara/Minitest/Assertions:assert_link
+[built-in selectors]: https://rubydoc.info/github/teamcapybara/capybara/master/Capybara/Selector#built-in-selectors
+[capybara_accessible_selectors]: https://github.com/citizensadvice/capybara_accessible_selectors
+[Testing RSpec]: https://github.com/thoughtbot/guides/blob/main/testing-rspec/README.md#acceptance-tests
+
+### `capybara_accessibility_audit` and `axe.js`
+
+This project depends on the [capybara_accessibility_audit][] gem to enhance the application's System Test suite to audit the browser's DOM for statically detectable accessibility violations. Under the hood, `capybara_accessibility_audit` utilizes [axe.js][] for auditing.
+
+The categories of violation that `capybara_accessibility_audit` can detect span a wide range from insufficient [color contrast][] to invalid or insufficient [landmark-based information hierarchy][landmark], to [unnamed form controls][] and beyond.
+
+Out of the box, `capybara_accessibility_audit` will extend Capybara to conduct an accessibility audit after a variety of actions like `visit` and `click_link`. That project can [be configured to suit this application's needs][capybara_accessibility_audit-configuration].
+
+If you can integrate `capybara_accessibility_audit` from the project's inception, you can start with (and maintain!) accessibility violation bankruptcy.
+
+[capybara_accessibility_audit]: https://github.com/thoughtbot/capybara_accessibility_audit
+[capybara_accessibility_audit-configuration]: https://github.com/thoughtbot/capybara_accessibility_audit?tab=readme-ov-file#frequently-asked-questions
+[axe.js]: https://www.deque.com/axe/
+[color contrast]: https://developer.mozilla.org/en-US/docs/Web/Accessibility/Understanding_WCAG/Perceivable/Color_contrast
+[landmark]: https://developer.mozilla.org/en-US/blog/aria-accessibility-html-landmark-roles/
+[unnamed form controls]: https://developer.mozilla.org/en-US/docs/Web/Accessibility/Understanding_WCAG/Text_labels_and_names#form_elements_must_be_labeled
+
+### VoiceOver on macos
+
+VoiceOver is a screen reader integrated directly into the macOS operating system. You can learn more from [Apple's Accessibility Support][].
+
+VoiceOver and Safari are tightly integrated. If you're developing this
+application on a Mac, you should familiarize yourself with how to navigate in
+Safari using VoiceOver. You can learn more about how to use VoiceOver from the
+[Get started with VoiceOver on Mac][]. You might also enjoy [Screen Reader
+Basics: VoiceOver][] in the A11ycasts series of videos from the "Chrome for Developers" YouTube channel.
+
+[![Watch Screen Reader Basics: VoiceOver](https://img.youtube.com/vi/5R-6WvAihms/maxresdefault.jpg)](https://www.youtube.com/watch?v=5R-6WvAihms)
+
+After you've written a System Test or have completed a feature, it can be **extremely** valuable to navigate to that part of the application and try your best to recreate the experience based on keyboard navigation and screen reader announcements alone.
+
+[Apple's Accessibility Support]: https://support.apple.com/accessibility
+[Get started with VoiceOver on Mac]: https://support.apple.com/guide/voiceover/get-started-vo4be8816d70/10/mac/14.0
+[Screen Reader Basics: VoiceOver]: https://www.youtube.com/watch?v=5R-6WvAihms

data/lib/generators/templates/lint/config_better_html.yml

@@ -0,0 +1,2 @@
+---
+allow_single_quoted_attributes: false

data/lib/generators/templates/lint/config_initializers_better_html.rb

@@ -0,0 +1,9 @@
+Rails.configuration.to_prepare do
+  if Rails.env.test?
+    require "better_html"
+
+    BetterHtml.config = BetterHtml::Config.new(Rails.configuration.x.better_html)
+
+    BetterHtml.config.template_exclusion_filter = proc { |filename| !filename.start_with?(Rails.root.to_s) }
+  end
+end

data/lib/generators/templates/lint/erb-lint.yml

@@ -0,0 +1,63 @@
+---
+glob: "app/views/**/*.{html,turbo_stream}{+*,}.erb"
+
+linters:
+  AllowedScriptType:
+    enabled: true
+    allowed_types:
+      - "module"
+      - "text/javascript"
+  ErbSafety:
+    enabled: true
+    better_html_config: "config/better_html.yml"
+  GitHub::Accessibility::AvoidBothDisabledAndAriaDisabledCounter:
+    enabled: true
+  GitHub::Accessibility::AvoidGenericLinkTextCounter:
+    enabled: true
+  GitHub::Accessibility::DisabledAttributeCounter:
+    enabled: true
+  GitHub::Accessibility::IframeHasTitleCounter:
+    enabled: true
+  GitHub::Accessibility::ImageHasAltCounter:
+    enabled: true
+  GitHub::Accessibility::LandmarkHasLabelCounter:
+    enabled: true
+  GitHub::Accessibility::LinkHasHrefCounter:
+    enabled: true
+  GitHub::Accessibility::NestedInteractiveElementsCounter:
+    enabled: true
+  GitHub::Accessibility::NoAriaLabelMisuseCounter:
+    enabled: true
+  GitHub::Accessibility::NoPositiveTabIndexCounter:
+    enabled: true
+  GitHub::Accessibility::NoRedundantImageAltCounter:
+    enabled: true
+  GitHub::Accessibility::NoTitleAttributeCounter:
+    enabled: true
+  GitHub::Accessibility::SvgHasAccessibleTextCounter:
+    enabled: true
+  Rubocop:
+    enabled: true
+    rubocop_config:
+      inherit_from:
+        - .rubocop.yml
+
+      Lint/EmptyBlock:
+        Enabled: false
+      Layout/InitialIndentation:
+        Enabled: false
+      Layout/TrailingEmptyLines:
+        Enabled: false
+      Layout/TrailingWhitespace:
+        Enabled: false
+      Layout/LeadingEmptyLines:
+        Enabled: false
+      Style/FrozenStringLiteralComment:
+        Enabled: false
+      Style/MultilineTernaryOperator:
+        Enabled: false
+      Lint/UselessAssignment:
+        Exclude:
+          - "app/views/**/*"
+
+EnableDefaultLinters: true

data/lib/generators/templates/lint/erblint.rake

@@ -0,0 +1,47 @@
+module ERBLint
+  module RakeSupport
+    # Allow command line flags set in STANDARDOPTS (like MiniTest's TESTOPTS)
+    def self.argvify
+      if ENV["ERBLINTOPTS"]
+        ENV["ERBLINTOPTS"].split(/\s+/)
+      else
+        []
+      end
+    end
+
+    # DELETE THIS FILE AFTER MERGE:
+    #
+    #   * https://github.com/Shopify/better-html/pull/95
+    #
+    def self.backport!
+      BetterHtml::TestHelper::SafeErb::AllowedScriptType::VALID_JAVASCRIPT_TAG_TYPES.push("module")
+    end
+  end
+end
+
+desc "Lint templates with erb_lint"
+task "erblint" do
+  require "erb_lint/cli"
+  require "erblint-github/linters"
+
+  ERBLint::RakeSupport.backport!
+
+  cli = ERBLint::CLI.new
+  success = cli.run(ERBLint::RakeSupport.argvify + ["--lint-all", "--format=compact"])
+  fail unless success
+end
+
+desc "Lint and automatically fix templates with erb_lint"
+task "erblint:autocorrect" do
+  require "erb_lint/cli"
+  require "erblint-github/linters"
+
+  ERBLint::RakeSupport.backport!
+
+  cli = ERBLint::CLI.new
+  success = cli.run(ERBLint::RakeSupport.argvify + ["--lint-all", "--autocorrect"])
+  fail unless success
+end
+
+task "standard" => "erblint"
+task "standard:fix" => "erblint:autocorrect"

data/lib/generators/templates/lint/eslintrc.json

@@ -0,0 +1,7 @@
+{
+  "extends": ["@thoughtbot/eslint-config/prettier"],
+  "parserOptions": {
+    "ecmaVersion": "latest",
+    "sourceType": "module"
+  }
+}

data/lib/generators/templates/lint/package.json

@@ -0,0 +1,4 @@
+{
+  "name": "app",
+  "private": "true"
+}

data/lib/generators/templates/lint/prettierignore

@@ -0,0 +1 @@
+vendor/bundle/**

data/lib/generators/templates/lint/prettierrc

@@ -0,0 +1,11 @@
+{
+  "singleQuote": true,
+  "overrides": [
+    {
+      "files": ["**/*.css", "**/*.scss", "**/*.html"],
+      "options": {
+        "singleQuote": false
+      }
+    }
+  ]
+}

data/lib/generators/templates/lint/rubocop.yml.tt

@@ -0,0 +1,7 @@
+AllCops:
+  TargetRubyVersion: <%= RUBY_VERSION %>
+
+require: standard
+
+inherit_gem:
+  standard: config/base.yml

data/lib/generators/templates/prerequisites/node-version.tt

@@ -0,0 +1 @@
+<%= node_version %>

data/lib/generators/templates/setup/bin_setup.rb

@@ -0,0 +1,39 @@
+#!/usr/bin/env ruby
+require "fileutils"
+require "bundler"
+
+# path to your application root.
+APP_ROOT = File.expand_path("..", __dir__)
+
+def system!(*args)
+  system(*args, exception: true)
+end
+
+def using_node?
+  File.exist? "package.json"
+end
+
+FileUtils.chdir APP_ROOT do
+  puts "== Installing dependencies =="
+  system! "gem install bundler --conservative"
+  system("bundle check") || system!("bundle install")
+  system("yarn install --check-files") if using_node?
+
+  puts "\n== Preparing database and adding development seed data =="
+  if File.exist? "lib/tasks/dev.rake"
+    system! "bin/rails dev:prime"
+  else
+    system! "bin/rails db:prepare"
+  end
+
+  if Bundler.rubygems.find_name("sprockets")
+    puts "\n== Generating assets =="
+    system! "bin/rails assets:clobber assets:precompile"
+  end
+
+  puts "\n== Removing old logs and tempfiles =="
+  system! "bin/rails log:clear tmp:clear"
+
+  puts "\n== Restarting application server =="
+  system! "bin/rails restart"
+end

data/lib/generators/templates/styles/postcss.config.js

@@ -0,0 +1,11 @@
+module.exports = {
+  plugins: [
+    require('postcss-import'),
+    require('postcss-nesting'),
+    require('autoprefixer'),
+    require('postcss-url')({
+      url: 'copy',
+      assetsPath: 'app/assets/static'
+    })
+  ],
+}

data/lib/generators/templates/testing/driver.rb

@@ -0,0 +1,5 @@
+RSpec.configure do |config|
+  config.before(:each, type: :system) do
+    driven_by :selenium, using: :headless_chrome, screen_size: [1400, 1400]
+  end
+end

data/lib/generators/templates/views/flashes.html.erb

@@ -0,0 +1,7 @@
+<% if flash.any? %>
+  <div class="flashes">
+    <% flash.each do |type, message| -%>
+      <div class="flash-<%= type %>"><%= message %></div>
+    <% end -%>
+  </div>
+<% end %>

data/lib/install/web.rb

@@ -0,0 +1,70 @@
+def node_version
+  ENV["NODE_VERSION"] || `node --version`[/\d+\.\d+\.\d+/]
+end
+
+def node_not_installed?
+  !node_version.present?
+end
+
+def node_version_unsupported?
+  node_version < "20.0.0"
+end
+
+def apply_template!
+  if node_not_installed? || node_version_unsupported?
+    message = <<~ERROR
+
+
+      === Node version unsupported ===
+
+      Suspenders requires Node >= 20.0.0
+    ERROR
+
+    fail Rails::Generators::Error, message
+  end
+  if options[:database] == "postgresql" && options[:skip_test] && options[:skip_rubocop]
+    after_bundle do
+      gem_group :development, :test do
+        if ARGV.include?("--suspenders-main")
+          gem "suspenders", github: "thoughtbot/suspenders", branch: "main"
+        else
+          gem "suspenders"
+        end
+      end
+
+      run "bundle install"
+
+      generate "suspenders:install:web"
+      rails_command "db:prepare"
+      rails_command "db:migrate"
+
+      say "\nCongratulations! You just pulled our suspenders."
+    end
+  else
+    message = <<~ERROR
+
+
+      === Please use the correct options ===
+
+      # Use the latest suspenders release:
+      rails new <app_name> \\
+      --skip-rubocop \\
+      --skip-test \\
+      -d=postgresql \\
+      -m=https://raw.githubusercontent.com/thoughtbot/suspenders/main/lib/install/web.rb
+
+      # OR use the current (possibly unreleased) `main` branch of suspenders:
+      rails new <app_name> \\
+      --suspenders-main \\
+      --skip-rubocop \\
+      --skip-test \\
+      -d=postgresql \\
+      -m=https://raw.githubusercontent.com/thoughtbot/suspenders/main/lib/install/web.rb
+
+    ERROR
+
+    fail Rails::Generators::Error, message
+  end
+end
+
+apply_template!