suspenders 20240516.0 → 20251219.0

data/README.md

@@ -2,103 +2,114 @@
 
 [![CI](https://github.com/thoughtbot/suspenders/actions/workflows/main.yml/badge.svg)](https://github.com/thoughtbot/suspenders/actions/workflows/main.yml)
 
-Suspenders is a [Rails Engine][] containing generators for configuring Rails
-applications with these [features][].
+Suspenders is intended to create a new Rails applications with these
+[features][], and is optimised for deployment on Heroku. 
 
-It is used by thoughtbot to get a jump start on a new or existing app. Use
-Suspenders if you're in a rush to build something amazing; don't use it if you
-like missing deadlines.
+It is used by thoughtbot to get a jump start on new apps. Use Suspenders if
+you're in a rush to build something amazing; don't use it if you like missing
+deadlines.
 
-[Rails Engine]: https://guides.rubyonrails.org/engines.html
 [features]: ./FEATURES.md
 
 ![Suspenders boy](https://media.tumblr.com/1TEAMALpseh5xzf0Jt6bcwSMo1_400.png)
 
-## Requirements
+## Prerequisites 
 
-- Rails `~> 7.0`
-- Ruby `>= 3.1`
-- Node `>= 20.0.0`
+Suspenders requires the **latest** version of [Rails][] and its dependencies.
+
+Additionally, Suspenders requires [PostgreSQL][] and [Redis][].
+
+[Rails]: https://guides.rubyonrails.org/install_ruby_on_rails.html
+[PostgreSQL]: https://formulae.brew.sh/formula/postgresql@17
+[Redis]: https://formulae.brew.sh/formula/redis
+
+## Installation
+
+```
+gem install suspenders
+```
 
 ## Usage
 
-Suspenders can be used to create a new Rails application, or to enhance an
-existing Rails application.
+First, make sure you're on the latest version of Rails.
 
-### With New Rails Applications
+```
+gem update rails
+```
 
-This approach uses an [application template][] to generate a new Rails
-application with Suspenders.
+Then, create a new application with Suspenders.
 
-We skip the [default test framework][] in favor of [RSpec][], and [prefer
-PostgreSQL][] as our database.
+```
+suspenders new <app_name>
+```
+
+Under the hood, Suspenders uses an [application template][] to generate a new Rails
+application like so:
 
 ```
-rails new app_name \
- --skip-test \
+rails new <app_name> \
  -d=postgresql \
- -m=https://raw.githubusercontent.com/thoughtbot/suspenders/main/lib/install/web.rb
+ --skip-test \
+ --skip-solid \
+ --m=~/path/to/template.rb
 ```
 
-Then run `bin/setup` within the newly generated application.
+We skip the [default test framework][] in favor of [RSpec][], and [prefer
+PostgreSQL][] as our database. We skip the Solid ecosystem since we prefer
+[Sidekiq][], and because Solid Queue has [performance issues][] on Heroku.
 
-Alternatively, if you're using our [dotfiles][], then you can just run `rails new
-app_name`, or create your own [railsrc][] file with the following configuration:
+> [!IMPORTANT]
+> Since Suspenders generates an application that enables `require_master_key`,
+> you'll need to add it to GitHub as a [secret][] in order for GitHub Actions to
+> work.
 
 ```
---skip-test
---database=postgresql
--m=https://raw.githubusercontent.com/thoughtbot/suspenders/main/lib/install/web.rb
+cd <app_name>
+
+gh secret set RAILS_MASTER_KEY value-from-config-master.key
 ```
 
 [application template]: https://guides.rubyonrails.org/rails_application_templates.html
 [default test framework]: https://guides.rubyonrails.org/testing.html
 [RSpec]: http://rspec.info
 [prefer PostgreSQL]: https://github.com/thoughtbot/dotfiles/pull/728
-[dotfiles]: https://github.com/thoughtbot/dotfiles
-[railsrc]: https://github.com/rails/rails/blob/7f7f9df8641e35a076fe26bd097f6a1b22cb4e2d/railties/lib/rails/generators/rails/app/USAGE#L5C1-L7
+[Sidekiq]: https://github.com/sidekiq/sidekiq/
+[performance issues]: https://github.com/rails/solid_queue/issues/330
+[secret]: https://docs.github.com/en/actions/how-tos/write-workflows/choose-what-workflows-do/use-secrets
 
-### With Existing Rails Applications
+## Initial deployment to Heroku
 
-Suspenders can be used on an existing Rails application by adding it to the
-`:development` and `:test` group.
+Once your application is generated, you can deploy to Heroku with [Heroku CLI][cli].
 
-```ruby
-group :development, :test do
-  gem "suspenders"
-end
-```
 
-Once installed, you can invoke the web installation generator, which will
-invoke all generators.
-
-```
-bin/rails g suspenders:install:web
 ```
+cd <app_name>
 
-Or, you can invoke generators individually. To see a list of available
-generators run:
+heroku apps:create
 
-```
-bin/rails g | grep suspenders
+heroku buildpacks:set heroku/ruby
+
+heroku addons:create heroku-postgresql:essential-0
+heroku addons:create heroku-redis:mini
 ```
 
-To learn more about a generator, run:
+Once the application is provisioned, you'll want to set the following required
+environment variables.
 
 ```
-bin/rails g suspenders:[generator_name] --help
+heroku config:set \
+ APPLICATION_HOST=value-from-heroku
+ RAILS_MASTER_KEY=value-from-config-master.key
 ```
 
-### Available Tasks
-
-Suspenders ships with several custom Rake tasks.
+Finally, don't forget to enable the `worker`.
 
 ```
-bin/rails suspenders:rake
-bin/rails suspenders:db:migrate
-bin/rails suspenders:cleanup:organize_gemfile
+heroku ps:scale worker=1
 ```
 
+[cli]: https://devcenter.heroku.com/articles/heroku-cli
+
 ## Contributing
 
 See the [CONTRIBUTING] document.
@@ -115,18 +126,20 @@ under the terms specified in the [LICENSE] file.
 
 [LICENSE]: /LICENSE
 
-## About
+<!-- START /templates/footer.md -->
+## About thoughtbot
 
-Suspenders is maintained by [thoughtbot].
+![thoughtbot](https://thoughtbot.com/thoughtbot-logo-for-readmes.svg)
 
-![thoughtbot](https://thoughtbot.com/brand_assets/93:44.svg)
-
-Suspenders is maintained and funded by thoughtbot, inc.
+This repo is maintained and funded by thoughtbot, inc.
 The names and logos for thoughtbot are trademarks of thoughtbot, inc.
 
 We love open source software!
-See [our other projects][community]
-or [hire us][hire] to help build your product.
+See [our other projects][community].
+We are [available for hire][hire].
 
 [community]: https://thoughtbot.com/community?utm_source=github
 [hire]: https://thoughtbot.com/hire-us?utm_source=github
+
+
+<!-- END /templates/footer.md -->

data/RELEASING.md

@@ -0,0 +1,18 @@
+# Releasing
+
+1. Update `NEWS.md` to reflect the changes since last release.
+2. Update `lib/suspenders/version.rb` file accordingly.
+3. Commit changes. There shouldn't be code changes, and thus CI doesn't need to
+   run; you can add `[ci skip]` to the commit message.
+4. Tag the release: `git tag vVERSION -a -s`. The tag message should contain the
+   appropriate `NEWS.md` subsection.
+5. Push changes: `git push --tags`
+6. Build and publish to rubygems:
+   ```sh
+   gem build suspenders.gemspec
+   gem push suspenders-*.gem
+   ```
+7. Add a new GitHub release:
+   https://github.com/thoughtbot/suspenders/releases/new?tag=vVERSION
+8. Announce the new release, making sure to thank the contributors who helped
+   shape this version!

data/Rakefile

@@ -1,13 +1,10 @@
-require "bundler/setup"
+# frozen_string_literal: true
+
 require "bundler/gem_tasks"
-require "minitest/test_task"
-require "standard/rake"
+require "rspec/core/rake_task"
 
-Minitest::TestTask.create(:test) do |t|
-  t.libs << "test"
-  t.libs << "lib"
-  t.warning = false
-  t.test_globs = ["test/**/*_test.rb"]
-end
+RSpec::Core::RakeTask.new(:spec)
+
+require "standard/rake"
 
-task default: %i[test standard]
+task default: %i[spec standard]

data/SECURITY.md

@@ -0,0 +1,19 @@
+<!-- START /templates/security.md -->
+# Security Policy
+
+## Supported Versions
+
+Only the the latest version of this project is supported at a given time. If
+you find a security issue with an older version, please try updating to the
+latest version first.
+
+If for some reason you can't update to the latest version, please let us know
+your reasons so that we can have a better understanding of your situation.
+
+## Reporting a Vulnerability
+
+For security inquiries or vulnerability reports, visit
+<https://thoughtbot.com/security>.
+
+If you have any suggestions to improve this policy, visit <https://thoughtbot.com/security>.
+<!-- END /templates/security.md -->

data/exe/suspenders

@@ -0,0 +1,38 @@
+#!/usr/bin/env ruby
+
+require_relative "../lib/suspenders"
+
+if ARGV.length > 2 || ARGV.length == 0
+  puts "Error: Invalid command"
+  puts "Available commands are"
+  puts "suspenders new APP_NAME"
+  puts "suspenders -v"
+  exit 1
+end
+
+command = ARGV[0]
+app_name = ARGV[1]
+
+if ["-v", "--version"].include?(command)
+  puts Suspenders::VERSION
+  exit 0
+elsif ["new"].include?(command)
+  if app_name.nil? || app_name.empty?
+    puts "Error: Application name required"
+    puts "Usage: suspenders new APP_NAME"
+    exit 1
+  end
+else
+  puts "Error: Invalid command"
+  puts "Available commands are"
+  puts "suspenders new APP_NAME"
+  puts "suspenders -v"
+  exit 1
+end
+
+begin
+  Suspenders::CLI.run(app_name)
+  exit 0
+rescue Suspenders::Error => e
+  abort "Error: #{e.message}"
+end

data/lib/suspenders/cli.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module Suspenders
+  # Command-line interface for generating Rails applications with Suspenders.
+  # This class handles the creation of new Rails apps using a custom template
+  # and predefined configuration options.
+  class CLI
+    # Base options passed to the Rails generator for all new applications.
+    # These options configure PostgreSQL as the database, skip test setup,
+    # and skip Solid-related features.
+    BASE_OPTIONS = [
+      "-d=postgresql",
+      "--skip-test",
+      "--skip-solid"
+    ]
+
+    # Initializes a new CLI instance.
+    #
+    # @param app_name [String] the name of the Rails application to create
+    def initialize(app_name)
+      @app_name = app_name
+    end
+
+    # Creates and runs a new CLI instance for the given application name.
+    #
+    # @param app_name [String] the name of the Rails application to create
+    # @return [Boolean] true if the Rails app was created successfully
+    # @raise [Error] if Rails is not installed or app creation fails
+    def self.run(app_name)
+      new(app_name).run
+    end
+
+    # Executes the CLI workflow to generate a new Rails application.
+    # Verifies Rails installation and generates the app with Suspenders template.
+    #
+    # @return [Boolean] true if the Rails app was created successfully
+    # @raise [Error] if Rails is not installed or app creation fails
+    def run
+      verify_rails_exists!
+      generate_new_rails_app
+    end
+
+    private
+
+    attr_reader :app_name
+
+    def verify_rails_exists!
+      unless system("which", "rails", out: File::NULL, err: File::NULL)
+        raise Error, "Rails not found. Install with: gem install rails"
+      end
+    end
+
+    def generate_new_rails_app
+      template_path = File.expand_path("../templates/web.rb", __dir__)
+      options = BASE_OPTIONS + ["-m=#{template_path}"]
+
+      if system("rails", "new", app_name, *options)
+        true
+      else
+        raise Error, "Failed to create Rails app"
+      end
+    end
+  end
+end

data/lib/suspenders/version.rb

@@ -1,6 +1,6 @@
+# frozen_string_literal: true
+
 module Suspenders
-  VERSION = "20240516.0".freeze
-  RAILS_VERSION = "~> 7.0".freeze
-  MINIMUM_RUBY_VERSION = ">= 3.1".freeze
-  MINIMUM_NODE_VERSION = "20.0.0".freeze
+  VERSION = "20251219.0"
+  MINIMUM_RUBY_VERSION = ">= 3.2.0"
 end

data/lib/suspenders.rb

@@ -1,10 +1,9 @@
-require "suspenders/version"
-require "suspenders/engine"
-require "suspenders/railtie"
-require "suspenders/generators"
-require "suspenders/cleanup/organize_gemfile"
-require "suspenders/cleanup/generate_readme"
+# frozen_string_literal: true
+
+require_relative "suspenders/version"
+require_relative "suspenders/cli"
 
 module Suspenders
+  class Error < StandardError; end
   # Your code goes here...
 end

data/lib/templates/Procfile

@@ -0,0 +1,3 @@
+release: bundle exec rails db:migrate; bundle exec rails db:seed
+web: bundle exec puma -C config/puma.rb
+worker: bundle exec sidekiq -c 10

data/lib/templates/Procfile.dev

@@ -0,0 +1,2 @@
+web: env RUBY_DEBUG_OPEN=true bin/rails server
+worker: bundle exec sidekiq

data/lib/{generators/templates/views/flashes.html.erb → templates/app/views/application/_flashes.html.erb}

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

data/lib/templates/app/views/application/_form_errors.html.erb

@@ -0,0 +1,11 @@
+<%# locals: (resource: ) %>
+
+<% if resource.errors.any? %>
+  <div id="error_explanation" role="alert" data-turbo-cache="false">
+    <ul>
+      <% resource.errors.full_messages.each do |message| %>
+        <li><%= message %></li>
+      <% end %>
+    </ul>
+  </div>
+<% end %>

data/lib/templates/config/initializers/sidekiq.rb

@@ -0,0 +1,14 @@
+# https://github.com/sidekiq/sidekiq/wiki/Heroku
+
+SIDEKIQ_REDIS_CONFIGURATION = {
+  url: ENV.fetch(ENV.fetch("REDIS_PROVIDER", "REDIS_URL"), nil), # use REDIS_PROVIDER for Redis environment variable name, defaulting to REDIS_URL
+  ssl_params: {verify_mode: OpenSSL::SSL::VERIFY_NONE} # we must trust Heroku and AWS here
+}
+
+Sidekiq.configure_server do |config|
+  config.redis = SIDEKIQ_REDIS_CONFIGURATION
+end
+
+Sidekiq.configure_client do |config|
+  config.redis = SIDEKIQ_REDIS_CONFIGURATION
+end

data/lib/templates/lib/development/seeder.rb

@@ -0,0 +1,21 @@
+# This file should ensure the existence of records required to run the application in development.
+# The code here should be idempotent so that it can be executed at any point in development.
+# The data can then be loaded with the bin/rails development:db:seed command.
+
+module Development
+  class Seeder
+    def self.load_seeds
+      if Rails.env.development?
+        new.load_seeds
+      else
+        raise "Development::Seeder can only be run in a development environment."
+      end
+    end
+
+    def load_seeds
+      #   ["Ruby", "Ralph"].each do |name|
+      #     User.find_or_create_by!(name:)
+      #   end
+    end
+  end
+end

data/lib/templates/lib/tasks/development.rake

@@ -0,0 +1,15 @@
+if Rails.env.development?
+  namespace :development do
+    namespace :db do
+      desc "Loads seed data into development."
+      task seed: ["environment", "db:seed"] do
+        Development::Seeder.load_seeds
+      end
+
+      namespace :seed do
+        desc "Truncate tables of each database for development and loads seed data."
+        task replant: ["environment", "db:truncate_all", "development:db:seed"]
+      end
+    end
+  end
+end

data/lib/templates/spec/support/action_mailer.rb

@@ -0,0 +1,11 @@
+RSpec.configure do |config|
+  # 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
+  config.before(:each) do
+    ActionMailer::Base.deliveries.clear
+  end
+end

data/lib/{generators/templates/factories/factory_bot_rspec.rb → templates/spec/support/factory_bot.rb}

@@ -1,5 +1,3 @@
-FactoryBot.use_parent_strategy = true
-
 RSpec.configure do |config|
   config.include FactoryBot::Syntax::Methods
 end