suspenders 20240516.0 → 20251219.0

data/lib/generators/suspenders/jobs_generator.rb

@@ -1,34 +0,0 @@
-module Suspenders
-  module Generators
-    class JobsGenerator < Rails::Generators::Base
-      desc <<~MARKDOWN
-        Uses [Sidekiq][] for [background job][] processing.
-
-        Configures the `test` environment to use the [inline][] adapter.
-
-        [Sidekiq]: https://github.com/sidekiq/sidekiq
-        [background job]: https://guides.rubyonrails.org/active_job_basics.html
-        [inline]: https://api.rubyonrails.org/classes/ActiveJob/QueueAdapters/InlineAdapter.html
-      MARKDOWN
-
-      def add_sidekiq_gem
-        gem "sidekiq"
-        Bundler.with_unbundled_env { run "bundle install" }
-      end
-
-      def configure_active_job
-        environment "config.active_job.queue_adapter = :sidekiq"
-        environment "config.active_job.queue_adapter = :inline", env: "test"
-      end
-
-      def configure_procfile
-        if Rails.root.join("Procfile.dev").exist?
-          append_to_file "Procfile.dev", "worker: bundle exec sidekiq"
-        else
-          say "Add default Procfile.dev"
-          create_file "Procfile.dev", "worker: bundle exec sidekiq"
-        end
-      end
-    end
-  end
-end

data/lib/generators/suspenders/lint_generator.rb

@@ -1,94 +0,0 @@
-module Suspenders
-  module Generators
-    class LintGenerator < Rails::Generators::Base
-      include Suspenders::Generators::Helpers
-
-      source_root File.expand_path("../../templates/lint", __FILE__)
-      desc <<~MARKDOWN
-        - Uses [@thoughtbot/eslint-config][] for JavaScript linting.
-        - Uses [@thoughtbot/stylelint-config][] for CSS linting.
-        - Uses [prettier][] for additional linting.
-        - Uses [better_html][], [erb_lint][], and [erblint-github][] for ERB linting.
-        - Uses [standard][] for Ruby linting.
-
-        **Available Commands**
-
-        - Run `yarn lint` to lint front-end code.
-        - Run `yarn fix:prettier` to automatically fix prettier violations.
-        - Run `bin/rails standard` to lint ERB and Ruby code.
-        - Run `bundle exec standardrb --fix` to fix standard violations.
-
-        [@thoughtbot/eslint-config]: https://github.com/thoughtbot/eslint-config
-        [@thoughtbot/stylelint-config]: https://github.com/thoughtbot/stylelint-config
-        [prettier]: https://prettier.io
-        [better_html]: https://github.com/Shopify/better-html
-        [erb_lint]: https://github.com/Shopify/erb-lint
-        [erblint-github]: https://github.com/github/erblint-github
-        [standard]: https://github.com/standardrb/standard
-      MARKDOWN
-
-      def check_package_json
-        unless File.exist? Rails.root.join("package.json")
-          copy_file "package.json", "package.json"
-        end
-      end
-
-      # TODO: Remove eslint version pin once the follownig is solved
-      # https://github.com/thoughtbot/eslint-config/issues/10
-      def install_dependencies
-        run "yarn add stylelint eslint@^8.9.0 @thoughtbot/stylelint-config @thoughtbot/eslint-config npm-run-all prettier --dev"
-      end
-
-      def install_gems
-        gem_group :development, :test do
-          gem "better_html", require: false
-          gem "erb_lint", require: false
-          gem "erblint-github", require: false
-          gem "standard"
-        end
-        Bundler.with_unbundled_env { run "bundle install" }
-      end
-
-      def configure_stylelint
-        copy_file "stylelintrc.json", ".stylelintrc.json"
-      end
-
-      def configure_eslint
-        copy_file "eslintrc.json", ".eslintrc.json"
-      end
-
-      def configure_prettier
-        copy_file "prettierrc", ".prettierrc"
-        copy_file "prettierignore", ".prettierignore"
-      end
-
-      def configure_erb_lint
-        copy_file "erb-lint.yml", ".erb-lint.yml"
-        copy_file "config_better_html.yml", "config/better_html.yml"
-        copy_file "config_initializers_better_html.rb", "config/initializers/better_html.rb"
-        copy_file "erblint.rake", "lib/tasks/erblint.rake"
-        template "rubocop.yml.tt", ".rubocop.yml"
-      end
-
-      def update_package_json
-        content = File.read package_json
-        json = JSON.parse content
-        json["scripts"] ||= {}
-
-        json["scripts"]["lint"] = "run-p lint:eslint lint:stylelint lint:prettier"
-        json["scripts"]["lint:eslint"] = "eslint --max-warnings=0 --no-error-on-unmatched-pattern 'app/javascript/**/*.js'"
-        json["scripts"]["lint:stylelint"] = "stylelint 'app/assets/stylesheets/**/*.css'"
-        json["scripts"]["lint:prettier"] = "prettier --check '**/*' --ignore-unknown"
-        json["scripts"]["fix:prettier"] = "prettier --write '**/*' --ignore-unknown"
-
-        File.write package_json, JSON.pretty_generate(json)
-      end
-
-      private
-
-      def package_json
-        Rails.root.join("package.json")
-      end
-    end
-  end
-end

data/lib/generators/suspenders/prerequisites_generator.rb

@@ -1,19 +0,0 @@
-module Suspenders
-  module Generators
-    class PrerequisitesGenerator < Rails::Generators::Base
-      include Suspenders::Generators::Helpers
-      include Suspenders::Generators::NodeNotInstalled
-      include Suspenders::Generators::NodeVersionUnsupported
-
-      source_root File.expand_path("../../templates/prerequisites", __FILE__)
-
-      desc <<~MARKDOWN
-        Creates `.node-version` file set to the current LTS version.
-      MARKDOWN
-
-      def set_node_version
-        template "node-version", ".node-version"
-      end
-    end
-  end
-end

data/lib/generators/suspenders/rake_generator.rb

@@ -1,25 +0,0 @@
-module Suspenders
-  module Generators
-    class RakeGenerator < Rails::Generators::Base
-      source_root File.expand_path("../../templates/rake", __FILE__)
-      desc <<~MARKDOWN
-        Adds default Raketask wich is a wrapper for `suspenders:rake`.
-
-        This will do the following:
-
-          - Run the test suite.
-          - Run a Ruby and ERB linter.
-          - Scan the Ruby codebase for any dependency vulnerabilities.
-      MARKDOWN
-
-      def configure_default_rake_task
-        append_to_file "Rakefile", <<~RUBY
-
-          if Rails.env.local?
-            task default: "suspenders:rake"
-          end
-        RUBY
-      end
-    end
-  end
-end

data/lib/generators/suspenders/setup_generator.rb

@@ -1,14 +0,0 @@
-module Suspenders
-  module Generators
-    class SetupGenerator < Rails::Generators::Base
-      source_root File.expand_path("../../templates/setup", __FILE__)
-      desc <<~MARKDOWN
-        Run `bin/setup` to install dependencies and seed development data.
-      MARKDOWN
-
-      def replace_bin_setup
-        copy_file "bin_setup.rb", "bin/setup", force: true
-      end
-    end
-  end
-end

data/lib/generators/suspenders/styles_generator.rb

@@ -1,84 +0,0 @@
-module Suspenders
-  module Generators
-    class StylesGenerator < Rails::Generators::Base
-      include Suspenders::Generators::APIAppUnsupported
-
-      source_root File.expand_path("../../templates/styles", __FILE__)
-      desc <<~MARKDOWN
-        - Uses [PostCSS][] via [cssbundling-rails][].
-        - Uses [modern-normalize][] to normalize browsers' default style.
-
-        Configuration can be found at `postcss.config.js`.
-
-        Adds the following stylesheet structure.
-
-        ```
-        app/assets/stylesheets/base.css
-        app/assets/stylesheets/components.css
-        app/assets/stylesheets/utilities.css
-        ```
-
-        Adds `app/assets/static` so that [postcss-url][] has a directory to copy
-        assets to.
-
-        [PostCSS]: https://postcss.org
-        [cssbundling-rails]: https://github.com/rails/cssbundling-rails
-        [modern-normalize]: https://github.com/sindresorhus/modern-normalize
-        [postcss-url]: https://github.com/postcss/postcss-url
-      MARKDOWN
-
-      def add_cssbundling_rails_gem
-        gem "cssbundling-rails"
-
-        Bundler.with_unbundled_env { run "bundle install" }
-        run "bin/rails css:install:postcss"
-      end
-
-      def build_directory_structure
-        create_file "app/assets/stylesheets/base.css"
-        append_to_file "app/assets/stylesheets/base.css", "/* Base Styles */"
-
-        create_file "app/assets/stylesheets/components.css"
-        append_to_file "app/assets/stylesheets/components.css", "/* Component Styles */"
-
-        create_file "app/assets/stylesheets/utilities.css"
-        append_to_file "app/assets/stylesheets/utilities.css", "/* Utility Styles */"
-      end
-
-      def configure_application_stylesheet
-        run "yarn add modern-normalize"
-
-        append_to_file "app/assets/stylesheets/application.postcss.css" do
-          <<~TEXT
-            @import "modern-normalize";
-            @import "base.css";
-            @import "components.css";
-            @import "utilities.css";
-          TEXT
-        end
-      end
-
-      def install_postcss_url
-        run "yarn add postcss-url"
-      end
-
-      def configures_postcss
-        begin
-          File.delete(postcss_config)
-        rescue Errno::ENOENT
-        end
-
-        empty_directory "app/assets/static"
-        create_file "app/assets/static/.gitkeep"
-
-        copy_file "postcss.config.js", "postcss.config.js"
-      end
-
-      private
-
-      def postcss_config
-        Rails.root.join("postcss.config.js")
-      end
-    end
-  end
-end

data/lib/generators/suspenders/tasks_generator.rb

@@ -1,20 +0,0 @@
-module Suspenders
-  module Generators
-    class TasksGenerator < Rails::Generators::Base
-      source_root File.expand_path("../../templates/tasks", __FILE__)
-      desc <<~MARKDOWN
-        Creates `lib/tasks/dev.rake` which contains the following tasks:
-
-        `bin/rails dev:prime` which loads sample data for local development.
-      MARKDOWN
-
-      def create_dev_rake
-        if Bundler.rubygems.find_name("factory_bot").any?
-          copy_file "dev.rake", "lib/tasks/dev.rake"
-        else
-          say "This generator requires Factory Bot"
-        end
-      end
-    end
-  end
-end

data/lib/generators/suspenders/testing_generator.rb

@@ -1,113 +0,0 @@
-module Suspenders
-  module Generators
-    class TestingGenerator < Rails::Generators::Base
-      source_root File.expand_path("../../templates/testing", __FILE__)
-      desc <<~MARKDOWN
-        Uses [RSpec][] and [RSpec Rails][] in favor of the [default test suite][].
-
-        The test suite can be run with `bin/rails spec`.
-
-        Configuration can be found in the following files:
-
-        ```
-        spec/rails_helper.rb
-        spec/spec_helper.rb
-        spec/support/action_mailer.rb
-        spec/support/driver.rb
-        spec/support/i18n.rb
-        spec/support/should_matchers.rb
-        ```
-
-        - Uses [action_dispatch-testing-integration-capybara][] to introduce Capybara assertions into Request specs.
-        - Uses [should-matchers][] for simple one-liner tests for common Rails functionality.
-        - Uses [webmock][] for stubbing and setting expectations on HTTP requests in Ruby.
-
-        [RSpec]: http://rspec.info
-        [RSpec Rails]: https://github.com/rspec/rspec-rails
-        [default test suite]: https://guides.rubyonrails.org/testing.html
-        [action_dispatch-testing-integration-capybara]: https://github.com/thoughtbot/action_dispatch-testing-integration-capybara
-        [should-matchers]: https://github.com/thoughtbot/shoulda-matchers
-        [webmock]: https://github.com/bblimke/webmock
-      MARKDOWN
-
-      def add_gems
-        gem_group :development, :test do
-          gem "rspec-rails", "~> 6.1.0"
-        end
-
-        gem_group :test do
-          gem "capybara"
-          gem "action_dispatch-testing-integration-capybara",
-            github: "thoughtbot/action_dispatch-testing-integration-capybara", tag: "v0.1.1",
-            require: "action_dispatch/testing/integration/capybara/rspec"
-          gem "selenium-webdriver"
-          gem "shoulda-matchers", "~> 6.0"
-          gem "webmock"
-        end
-
-        Bundler.with_unbundled_env { run "bundle install" }
-      end
-
-      def run_rspec_installation_script
-        rails_command "generate rspec:install"
-      end
-
-      def modify_rails_helper
-        insert_into_file "spec/rails_helper.rb",
-          "\s\sconfig.infer_base_class_for_anonymous_controllers = false\n",
-          after: "RSpec.configure do |config|\n"
-
-        uncomment_lines "spec/rails_helper.rb", /Rails\.root\.glob/
-      end
-
-      def modify_spec_helper
-        persistence_file_path = "\s\sconfig.example_status_persistence_file_path = \"tmp/rspec_examples.txt\"\n"
-        order = "\s\sconfig.order = :random\n\n"
-        webmock_config = <<~RUBY
-
-          WebMock.disable_net_connect!(
-            allow_localhost: true,
-            allow: [
-              /(chromedriver|storage).googleapis.com/,
-              "googlechromelabs.github.io"
-            ]
-          )
-        RUBY
-
-        insert_into_file "spec/spec_helper.rb",
-          persistence_file_path + order,
-          after: "RSpec.configure do |config|\n"
-
-        insert_into_file "spec/spec_helper.rb", "require \"webmock/rspec\"\n\n", before: "RSpec.configure do |config|"
-        insert_into_file "spec/spec_helper.rb", webmock_config
-      end
-
-      def create_system_spec_dir
-        empty_directory "spec/system"
-        create_file "spec/system/.gitkeep"
-      end
-
-      def configure_chromedriver
-        copy_file "driver.rb", "spec/support/driver.rb"
-      end
-
-      def configure_i18n_helper
-        copy_file "i18n.rb", "spec/support/i18n.rb"
-      end
-
-      def configure_shoulda_matchers
-        copy_file "shoulda_matchers.rb", "spec/support/shoulda_matchers.rb"
-      end
-
-      def configure_action_mailer_helpers
-        # https://guides.rubyonrails.org/testing.html#the-basic-test-case
-        #
-        # The ActionMailer::Base.deliveries array is only reset automatically in
-        # ActionMailer::TestCase and ActionDispatch::IntegrationTest tests. If
-        # you want to have a clean slate outside these test cases, you can reset
-        # it manually with: ActionMailer::Base.deliveries.clear
-        copy_file "action_mailer.rb", "spec/support/action_mailer.rb"
-      end
-    end
-  end
-end

data/lib/generators/suspenders/views_generator.rb

@@ -1,38 +0,0 @@
-module Suspenders
-  module Generators
-    class ViewsGenerator < Rails::Generators::Base
-      include Suspenders::Generators::APIAppUnsupported
-
-      source_root File.expand_path("../../templates/views", __FILE__)
-      desc <<~MARKDOWN
-        - A [partial][] for [flash messages][] is located in `app/views/application/_flashes.html.erb`.
-        - Sets [lang][] attribute on `<html>` element to `en` via `I18n.local`.
-        - Dynamically sets `<title>` via the [title][] gem.
-        - Disables Turbo's [Prefetch][] in an effort to reduce unnecessary network requests.
-
-        [partial]: https://guides.rubyonrails.org/layouts_and_rendering.html#using-partials
-        [flash messages]: https://guides.rubyonrails.org/action_controller_overview.html#the-flash
-        [lang]: https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/lang
-        [title]: https://github.com/calebhearth/title
-        [Prefetch]: https://turbo.hotwired.dev/handbook/drive#prefetching-links-on-hover
-      MARKDOWN
-
-      def install_gems
-        gem "title"
-
-        Bundler.with_unbundled_env { run "bundle install" }
-      end
-
-      def create_views
-        copy_file "flashes.html.erb", "app/views/application/_flashes.html.erb"
-      end
-
-      def update_application_layout
-        insert_into_file "app/views/layouts/application.html.erb", "    <%= render \"flashes\" -%>\n", after: "<body>\n"
-        gsub_file "app/views/layouts/application.html.erb", /<html>/, "<html lang=\"<%= I18n.locale %>\">"
-        gsub_file "app/views/layouts/application.html.erb", /<title>.*<\/title>/, "<title><%= title %></title>"
-        insert_into_file "app/views/layouts/application.html.erb", "    <meta name=\"turbo-prefetch\" content=\"false\">\n", after: "</title>"
-      end
-    end
-  end
-end

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

@@ -1,148 +0,0 @@
-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/ci/dependabot.yml

@@ -1,7 +0,0 @@
-version: 2
-updates:
-  - package-ecosystem: bundler
-    directory: '/'
-    schedule:
-      interval: daily
-    open-pull-requests-limit: 10

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

@@ -1,11 +0,0 @@
-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.rb

@@ -1,2 +0,0 @@
-FactoryBot.define do
-end

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

@@ -1,9 +0,0 @@
-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/inline_svg/inline_svg.rb

@@ -1,3 +0,0 @@
-InlineSvg.configure do |config|
-  config.raise_on_file_not_found = true
-end