suspenders 20240516.0 → 20251219.0

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

@@ -1,94 +0,0 @@
-# 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

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

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

@@ -1,9 +0,0 @@
-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

@@ -1,63 +0,0 @@
----
-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

@@ -1,47 +0,0 @@
-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

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

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

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

data/lib/generators/templates/lint/prettierignore

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

data/lib/generators/templates/lint/prettierrc

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

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

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

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

@@ -1,3 +0,0 @@
-{
-  "extends": "@thoughtbot/stylelint-config"
-}

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

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

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

@@ -1,39 +0,0 @@
-#!/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

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

data/lib/generators/templates/tasks/dev.rake

@@ -1,12 +0,0 @@
-if Rails.env.development? || Rails.env.test?
-  require "factory_bot"
-
-  namespace :dev do
-    desc "Sample data for local development environment"
-    task prime: "db:setup" do
-      include FactoryBot::Syntax::Methods
-
-      # create(:user, email: "user@example.com", password: "password")
-    end
-  end
-end

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

@@ -1,5 +0,0 @@
-RSpec.configure do |config|
-  config.before(:each) do
-    ActionMailer::Base.deliveries.clear
-  end
-end

data/lib/install/web.rb

@@ -1,54 +0,0 @@
-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]
-    after_bundle do
-      gem_group :development, :test do
-        gem "suspenders", github: "thoughtbot/suspenders"
-      end
-
-      run "bundle install"
-
-      generate "suspenders:install:web"
-      rails_command "db:prepare"
-
-      say "\nCongratulations! You just pulled our suspenders."
-    end
-  else
-    message = <<~ERROR
-
-
-      === Please use the correct options ===
-
-      rails new <app_name> \\
-      --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!

data/lib/suspenders/cleanup/generate_readme.rb

@@ -1,165 +0,0 @@
-require "rails/generators"
-require_relative "../../generators/suspenders/environments/development_generator"
-require_relative "../../generators/suspenders/environments/test_generator"
-require_relative "../../generators/suspenders/environments/production_generator"
-require_relative "../../generators/suspenders/accessibility_generator"
-require_relative "../../generators/suspenders/advisories_generator"
-require_relative "../../generators/suspenders/email_generator"
-require_relative "../../generators/suspenders/factories_generator"
-require_relative "../../generators/suspenders/inline_svg_generator"
-require_relative "../../generators/suspenders/jobs_generator"
-require_relative "../../generators/suspenders/lint_generator"
-require_relative "../../generators/suspenders/styles_generator"
-require_relative "../../generators/suspenders/testing_generator"
-require_relative "../../generators/suspenders/views_generator"
-
-module Suspenders
-  module Cleanup
-    class GenerateReadme
-      include Suspenders::Generators::Helpers
-
-      def self.perform(readme, app_name)
-        new(readme, app_name).perform
-      end
-
-      attr_reader :readme, :app_name
-
-      def initialize(readme, app_name)
-        @readme = readme
-        @app_name = app_name
-      end
-
-      def perform
-        File.open(readme, "w+") do |file|
-          @file = file
-
-          heading app_name.titleize, level: 1
-
-          prerequisites
-
-          local_development
-
-          heading "Configuration", level: 2
-
-          heading "Test", level: 3
-          description_for Suspenders::Generators::Environments::TestGenerator
-
-          heading "Development", level: 3
-          description_for Suspenders::Generators::Environments::DevelopmentGenerator
-
-          heading "Production", level: 3
-          description_for Suspenders::Generators::Environments::ProductionGenerator
-
-          heading "Linting", level: 3
-          description_for Suspenders::Generators::LintGenerator
-
-          heading "Testing", level: 2
-          description_for Suspenders::Generators::TestingGenerator
-
-          heading "Factories", level: 3
-          description_for Suspenders::Generators::FactoriesGenerator
-
-          heading "Accessibility", level: 2
-          description_for Suspenders::Generators::AccessibilityGenerator
-          content <<~MARKDOWN
-            For more information, review the [Accessibility Tooling][] section in 
-            the [CONTRIBUTING][] guide.
-
-            [Accessibility Tooling]: ./CONTRIBUTING.md#accessibility-tooling
-            [CONTRIBUTING]: ./CONTRIBUTING.md
-          MARKDOWN
-          new_line
-
-          heading "Advisories", level: 2
-          description_for Suspenders::Generators::AdvisoriesGenerator
-
-          heading "Mailers", level: 2
-          description_for Suspenders::Generators::EmailGenerator
-
-          heading "Jobs", level: 2
-          description_for Suspenders::Generators::JobsGenerator
-
-          heading "Layout and Assets", level: 2
-
-          heading "Stylesheets", level: 3
-          description_for Suspenders::Generators::StylesGenerator
-
-          heading "Inline SVG", level: 3
-          description_for Suspenders::Generators::InlineSvgGenerator
-
-          heading "Layout", level: 3
-          description_for Suspenders::Generators::ViewsGenerator
-        end
-      end
-
-      private
-
-      def content(text)
-        @file.write text
-      end
-
-      def new_line
-        @file.write "\n"
-      end
-
-      def heading(text, level:)
-        @file.write "#{"#" * level} #{text}\n"
-        new_line
-      end
-
-      def description_for(generator)
-        @file.write generator.desc
-        new_line
-      end
-
-      def local_development
-        @file.write <<~MARKDOWN
-          ## Local Development
-
-          ### Initial Setup
-
-          ```
-          bin/setup
-          ```
-
-          ### Running the Development Server
-
-          ```
-          bin/rails dev
-          ```
-
-          ### Seed Data
-
-          - Use `db/seeds.rb` to create records that need to exist in all environments.
-          - Use `lib/tasks/dev.rake` to create records that only need to exist in development.
-
-          Running `bin/setup` will run `dev:prime`.
-
-          ### Tasks
-
-          - Use `bin/rails suspenders:db:migrate` to run [database migrations][]. This script ensures they are [reversible][].
-          - Use `bin/rails suspenders:cleanup:organize_gemfile` to automatically organize the project's Gemfile.
-          - Use `bin/rails default` to run the default Rake task. This will do the following:
-            - Run the test suite.
-            - Run a Ruby and ERB linter.
-            - Scan the Ruby codebase for any dependency vulnerabilities.
-
-          [database migrations]: https://edgeguides.rubyonrails.org/active_record_migrations.html#running-migrations
-          [reversible]: https://edgeguides.rubyonrails.org/active_record_migrations.html#making-the-irreversible-possible
-
-        MARKDOWN
-      end
-
-      def prerequisites
-        heading "Prerequisites", level: 2
-
-        @file.write <<~MARKDOWN
-          Ruby: `#{Suspenders::MINIMUM_RUBY_VERSION}`
-          Node: `#{node_version}`
-        MARKDOWN
-
-        new_line
-      end
-    end
-  end
-end