suspenders 20240516.0 → 20251219.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8c2709f640163cac9a711d3fbc428db7771bf0082f8052f0e37cf1b60357fcbf
-  data.tar.gz: 8a2d49d93399ead80a3ef658124bd3657fb68bc923b3091bc42f390c22b9abf4
+  metadata.gz: 34fd9221d0876ccf710832f66749e3612ded0cf199b74aa6e7de5f3349a6ee6e
+  data.tar.gz: 21343be6558eb34c36737078c547aefb00d2aa266b2cd4d83c30604f71fe0dbf
 SHA512:
-  metadata.gz: ad3ba6902b12457e407ac81beade17ec912918d64a0e58eb7874c8214f861deead37497e06214fbae8effc30e7dfff02b4c0006a23a7b6bf0a03f4977538a18b
-  data.tar.gz: f3e992788aa0424a1b198ae611a9bed2542d80c12b321946a02fdf17fc05126f6f9b7a86fccbe2470aba77a72bc02612603fcfa072fba621b458e5c3d9981afe
+  metadata.gz: 5bc014a8127e6574d28f2c620a0f6215382fd1adbca4c52bcce575811da459bfefe5b159fdd5468348bc114045e015b4b097370665fa8b5ca0ce45bb1f5c9e1a
+  data.tar.gz: 9ae2e1ea7c7bdac2a9eab343e3228290d53a953baf9514763a422a62072fd41a90b0713b271862f7f064a16cc79e5a9506086f4391c785b415895f1dc100bcf6

data/.ruby-version

@@ -0,0 +1 @@
+3.3.1

data/CODEOWNERS

@@ -0,0 +1,9 @@
+# Lines starting with '#' are comments.
+# Each line is a file pattern followed by one or more owners.
+
+# More details are here: https://help.github.com/articles/about-codeowners/
+
+# The '*' pattern is global owners.
+
+# Global rule:
+*           @stevepolitodesign

data/CONTRIBUTING.md

@@ -0,0 +1,71 @@
+# Contributing
+
+We love contributions from everyone.
+By participating in this project,
+you agree to abide by the thoughtbot [code of conduct].
+
+  [code of conduct]: https://thoughtbot.com/open-source-code-of-conduct
+
+We expect everyone to follow the code of conduct
+anywhere in thoughtbot's project codebases,
+issue trackers, chatrooms, and mailing lists.
+
+## Contributing Code
+
+Fork the repo.
+
+Run the setup script.
+
+```
+./bin/setup
+```
+
+Make sure everything passes:
+
+```
+bundle exec rake
+```
+
+Make your change, with new passing tests.
+
+Mention how your changes affect the project to other developers and users in the
+`NEWS.md` file.
+
+Push to your fork. Write a [good commit message][commit]. Submit a pull request.
+
+  [commit]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
+
+Others will give constructive feedback.
+This is a time for discussion and improvements,
+and making the necessary changes will be required before we can
+merge the contribution.
+
+## Testing the executable Locally
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+From there, you can run `suspenders new <app_name>` to test the current code.
+
+In an effort to help distinguish code generated by `rails new` from code
+generated by the application template, you can run `bin/qa`.
+
+From there you can `cd qa` and run `git diff` to see what changed.
+
+This can be useful for testing Suspenders after a new release of Rails.
+
+## Documenting changes to generated application
+
+Be sure to update `FEATURES.md` and the contents of `update_readme` within
+`web.rb` anytime you add, update or remove a feature to the generated
+application.
+
+## Publishing to RubyGems
+
+When the gem is ready to be shared as a formal release, it can be
+[published][published] to RubyGems.
+
+  [published]: https://guides.rubyonrails.org/plugins.html#publishing-your-gem
+
+1. Bump the version number in `Suspenders::VERSION`
+2. Run `bundle exec rake build`
+3. Run `bundle exec rake install`
+4. Run `bundle exec rake release`

data/FEATURES.md

@@ -0,0 +1,177 @@
+# Features
+
+## Local Development
+
+### Strong Migrations
+
+Uses [Strong Migrations][] to catch unsafe migrations in development.
+
+[Strong Migrations]: https://github.com/ankane/strong_migrations
+
+### Seed Data
+
+Follows [our guidance][seed-data-guide] for managing seed data. Use
+`db/seeds.rb` for data required in **all** environments, and
+`development:db:seed` for data specific to development environments.
+
+Place idempotent seed data in `Development::Seeder`.
+
+To load development seed data:
+
+```bash
+bin/rails development:db:seed
+```
+
+To reset your database and reload seed data:
+
+```bash
+bin/rails development:db:seed:replant
+```
+
+The `replant` command truncates all tables and reloads the seed data, providing
+a clean slate for development.
+
+[seed-data-guide]: https://github.com/thoughtbot/guides/blob/main/rails/how-to/seed-data.md
+
+## Environment Variables
+
+The following environment variables are available in `production`:
+
+- `APPLICATION_HOST` - The domain where your application is hosted (required)
+- `ASSET_HOST` - CDN or asset host URL (optional)
+- `RAILS_MASTER_KEY` - Used for decrypting credentials (required)
+
+## Configuration
+
+### All Environments
+
+- Enables [strict_loading_by_default][].
+- Sets [strict_loading_mode][] to `:n_plus_one`.
+- Enables [require_master_key][].
+
+[strict_loading_by_default]: https://guides.rubyonrails.org/configuring.html#config-active-record-strict-loading-by-default
+[strict_loading_mode]: https://guides.rubyonrails.org/configuring.html#config-active-record-strict-loading-mode
+[require_master_key]: https://guides.rubyonrails.org/configuring.html#config-require-master-key
+
+### Test
+
+- Enables [raise_on_missing_translations][].
+- Sets [action_dispatch.show_exceptions][] to `:none`.
+
+[raise_on_missing_translations]: https://guides.rubyonrails.org/configuring.html#config-i18n-raise-on-missing-translations
+[action_dispatch.show_exceptions]: https://edgeguides.rubyonrails.org/configuring.html#config-action-dispatch-show-exceptions
+
+### Development
+
+- Enables [raise_on_missing_translations][].
+- Enables [i18n_customize_full_message][].
+- Enables [apply_rubocop_autocorrect_after_generate!][].
+
+[raise_on_missing_translations]: https://guides.rubyonrails.org/configuring.html#config-i18n-raise-on-missing-translations
+[i18n_customize_full_message]: https://guides.rubyonrails.org/configuring.html#config-active-model-i18n-customize-full-message
+[apply_rubocop_autocorrect_after_generate!]: https://guides.rubyonrails.org/configuring.html#configuring-generators
+
+### Production
+
+- Enables [sandbox_by_default][].
+- Sets [action_on_strict_loading_violation][] to `:log`.
+
+[sandbox_by_default]: https://guides.rubyonrails.org/configuring.html#config-sandbox-by-default
+[action_on_strict_loading_violation]: https://guides.rubyonrails.org/configuring.html#config-active-record-action-on-strict-loading-violation
+
+## Testing
+
+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/shoulda_matchers.rb
+```
+
+- Uses [action_dispatch-testing-integration-capybara][] to introduce Capybara assertions into Request specs.
+- Uses [shoulda-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
+[shoulda-matchers]: https://github.com/thoughtbot/shoulda-matchers
+[webmock]: https://github.com/bblimke/webmock
+
+### Factories
+
+Uses [FactoryBot][] as an alternative to [Fixtures][] to help you define
+dummy and test data for your test suite. The `create`, `build`, and
+`build_stubbed` class methods are directly available to all tests.
+
+Place FactoryBot definitions in `spec/factories.rb`, at least until it
+grows unwieldy. This helps reduce confusion around circular dependencies and
+makes it easy to jump between definitions.
+
+[FactoryBot]: https://github.com/thoughtbot/factory_bot
+[Fixtures]: https://guides.rubyonrails.org/testing.html#the-low-down-on-fixtures
+
+## Accessibility
+
+Uses [capybara_accessibility_audit][] and
+[capybara_accessible_selectors][] to encourage and enforce accessibility best
+practices.
+
+[capybara_accessibility_audit]: https://github.com/thoughtbot/capybara_accessibility_audit
+[capybara_accessible_selectors]: https://github.com/citizensadvice/capybara_accessible_selectors
+
+## Mailers
+
+[Intercept][] emails in non-production environments by setting `INTERCEPTOR_ADDRESSES`.
+
+```sh
+INTERCEPTOR_ADDRESSES="user_1@example.com,user_2@example.com" bin/rails s
+```
+
+Configuration can be found at `config/initializers/email_interceptor.rb`.
+
+Interceptor can be found at `lib/email_interceptor.rb`.
+
+[Intercept]: https://guides.rubyonrails.org/action_mailer_basics.html#intercepting-emails
+
+## Jobs
+
+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
+
+## Layout and Assets
+
+### Inline SVG
+
+Uses [inline_svg][] for embedding SVG documents into views.
+
+Configuration can be found at `config/initializers/inline_svg.rb`
+
+[inline_svg]: https://github.com/jamesmartin/inline_svg
+
+### Layout
+
+- A [partial][] for [flash messages][] is located in `app/views/application/_flashes.html.erb`.
+- A [partial][] for form errors is located in `app/views/application/_form_errors.html.erb`.
+- Sets [lang][] attribute on `<html>` element to `en` via `I18n.local`.
+- 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

data/GOALS.md

@@ -0,0 +1,65 @@
+# Goals
+
+Suspenders is an opinionated platform for adding functionality to a Rails app.
+It encodes thoughtbot's opinions and decisions in tooling and best practices.
+
+We are transitioning to a library of generators. All new functionality must be
+in the form of a well-tested, self-contained generator that fits within the
+Suspenders framework.
+
+## History and transitions
+
+In the beginning suspenders was a git repo that we would clone then use as a
+template for starting a new Rails app.
+
+It then became a command-line tool that would generate a Rails app then modify
+the files in place. Over time, and with intention, most of the modifications
+were focused on modifying the Gemfile.
+
+This was identified as unscalable and we have been slowing been moving in a new
+direction: a library of generators.
+
+## The future
+
+The problem with a script that adds a bunch of gem requirements to the Gemfile
+is: what if you don't want all those gems? Suspenders adds gem requirements and
+then configures each one. On a typical project we would run Suspenders then
+spend the rest of the day un-doing the parts we don't want.
+
+In 2015, [PR #511], we discussed what we want: a gem that is a library of
+generators that we can run on demand. The ideal future workflow goes like this:
+
+[PR #511]: https://github.com/thoughtbot/suspenders/pull/511
+
+1. `rails new my-cool-project && cd my-cool-project`
+2. `echo "gem 'suspenders', group: :development" >> Gemfile && bundle`
+3. `rails g suspenders:ci`
+4. Repeat with other generators as needed.
+
+In this future you would use `rails new` as normal and instead add Suspenders
+as a development gem. This gives you access to opinionated generators for
+adding (and removing!) whole functionality, but on demand and with your
+knowledge.
+
+The generators are all named to generically describe what functionality they
+add. In this way we can change our opinions on the implementation without
+needing to know new generator names. For example, `suspenders:ci` could
+configure the app for CircleCI now, but down the road we may decide to switch
+everything to Jenkins; we could update the implementation of the generator
+without changing its name.
+
+## From here to there
+
+The transition looks like this:
+
+1. Introduce a `suspenders:all` generator that runs Suspenders against an
+   existing Rails app.
+2. Change the Suspenders program to create a Rails app, add Suspenders to the
+   Gemfile, and run `suspenders:all` inside of it.
+3. Slowly split functionality out from the "all" generator and into smaller,
+   well-tested, self-contained generators. The "all" generator invokes these
+   generators.
+4. Once that is completed -- once "all" _only_ calls other generators -- then
+   remove the Suspenders program and only distribute the gem.
+
+We are on step (3), and it's a big one. Come help out!

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) thoughtbot, inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.