Suspenders 3.0.0

[stevepolitodesign]

Rewrite Suspenders as a Rails engine in an effort to achieve our goals while improving the developer experience, reducing technical debt and auditing our existing generators. The goal is to leverage as much of rails new as possible, and only deviate where necesary.

This removes the suspenders system executable in favor of application templates. Moving forwared, there will be two ways to use Suspenders.

With New Applications

rails new <my_app> \
 --skip-test \
 -d=postgresql \
 -m=https://raw.githubusercontent.com/thoughtbot/suspenders/main/lib/install/web.rb

With Existing Applications

group :development, :test do
  gem "suspenders", github: "thoughtbot/suspenders"
end

How to review this pull request

This long running feature branch is built upon a commit for each new generator. For more contenxt, I recommend looking at the commit history. I tried to make each pull request as detailed as possible.

To get a sense if everything works in concert, run the following:

rails new app_name \
 --skip-test \
 -d=postgresql \
 -m=https://raw.githubusercontent.com/thoughtbot/suspenders/suspenders-3-0-0/lib/install/web.rb

cd app_name
bin/setup

bundle exec rake
yarn run lint

Then I recommend scaffolding out a resource and adding a system test too.

bin/rails g scaffold post title
bin/rails suspenders:db:migrate

require "rails_helper"

RSpec.describe "Posts", type: :system do
  it "passes" do
    visit root_path

    expect(page).to have_text "Posts"
  end
end

Contributing

The 3.0.0 release is focused on all generators needed for a new Rails application. Anything that is not necessary for a new application will be added in a subsequent release. Additionally, a future release will need to account for existing applications in a way that does not re-install gems.

This branch will remain as a draft until all to-dos are complete.

1. Branch off of this branch.
2. Run ./bin/seup. Note, this you'll need to use Ruby 3.0.0 or higher.
3. Create and squash and merge pull-request with a generator, updated README, and updated NEWS against this branch.
   • If you're porting over an existing generator, consider using an existing description.
4. Repeat.

If something needs to change about the core branch (CI improvements, setup
improvements, directory structure) commit directly to this branch and rebase

git checkout suspenders-3-0-0
git pull --rebase
git checkout suspenders-3-0-0-feature-branch
git rebase suspenders-3-0-0

Status

Generator	Status
AccessibilityGenerator	Complete
AdvisoriesGenerator	Complete
AnalyticsGenerator	Won't Do
AppGenerator	To Do (See "App Generators" below.)
CiGenerator	Complete
DbOptimizationsGenerator	Won't Do (Consider using strict_loading config instead)
FactoriesGenerator	Complete
FormsGenerator	Won't Do
InlineSvgGenerator	Complete
JobsGenerator	Complete (Needs to conditionally update Procfile.dev. Look at cssbundling-rails for inspiration.)
JsDriverGenerator	Complete (Only for RSpec apps)
JsonGenerator	Won't Do (I think this is only necessary for API only apps)
LintGenerator	Complete (Modify by removing Hound. Could also benefit from ERB linting)
ProfilerGenerator	Won't Do (This ships with Rails, but commented out.)
RunnerGenerator	Won't Do (Procfile.dev depends on several factors, including how you build assets, and what job runner is being used. )
StaticGenerator	Won't Do (Not needed for all apps. Could make for a one-off generator.)
StylelintGenerator	Complete
StylesheetBaseGenerator	Complete
TestingGenerator	Complete (Only for RSpec apps. Consider renaming.)
ViewsGenerator	Complete

App Generators

These were extracted from AppGenerator. Some generators were left out because they are no longer relevant.

Should we break these up into smaller generators, or just consolidate everything into an AppGenerator?

Generator	Status
Development::EnvironmentGenerator	Complete
setup_production_environment	Complete
configure_app	Complete. (Extracted into suspenders:email and lib/tasks/suspenders.rake. We did not do configure_time_formats because that may end up beind dead code, and is not neccersary for new apps.)
copy_miscellaneous_files	Won't Do(config/initializers/errors.rb isn't mission critical, and the JSON encoding for timestamps should probably use the Rails default, which is milliseconds)
setup_database	Needs more work (Except create_database, do we need the database.yml overwrite? It is just for Heroku?)
SingleRedirect	Won't Do (This can be an infrastructure decision.)
CompressionGenerator	Won't Do (This can be an infrastructure decision.)
ForceTlsGenerator	Doing
EmailGenerator	Complete (also take ActionMailer configuration from the existing configure_app

New Generators Worth Considering

These could be added as part of the initial release, or as a subsequent minor release.

Generator	Status
dev:prime	Complete
rake	Complete
setup	Complete
suspenders:db:migrate	Complete
suspenders:json	Needs Work. Maybe this is a good candidated for a future suspenders:install:api.
suspenders:authorization	Needs Work. I think we need to establish an authorization opinion first.
suspenders:prerequisites	Complete
suspenders:templates	Doing

To do

• Update lib/install/web.rb and any references to this branch.
• Ensure intallation script can be copied and executed.
• Update docs {README, CONTRIBUTING}
• Update generator descriptions
• Update suspenders:lint to account for changes in ESlint Lint Generator: Account for breaking changes in ESLint #1192
• PostCSS fonts #1190
• Introduce suspenders:install:web and application template #1152
• Extract and port over generators we want to use for new Rails application (see above)
• Ensure bin/rails and bin/rake works in production
• Explore how we can cleanup the Gemfile, since there's a lot of duplicated groups. Relates to Rails::Generators::Actions#gem_group: Prepend existing gem groups rails/rails#49512
• Consider adding a .ruby-version file for improved developer experience.
• Styles Generator: Drop support for Tailwind #1169
• Disable Turbo's InstantClick #1164
• Investigate suspenders:rake. It does not seem to be invoked when running bundle exec rake.
• Update front-end linting dependencies #1163
• Update documentation.
• Account for vim-test issue

Once all is complete, rebase and merge to keep commit history.

[stevepolitodesign]

Since we're removing the executable, we don't need to be on the latest version of Rails. My thinking was, I don't want to prevent someone not on >= 7.1 to be able to use the gem since it's just generators.

However, the only downside to that is if a generator uses a feature from >= 7.1, that feature won't work.

[mike-burns]

Looks like you've just begun. I'll watch as you commit more!