-
-
Notifications
You must be signed in to change notification settings - Fork 529
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Create README based off the `desc` of the generators. We chose to create a custom class instead of a traditional generator because this script is intended to be run in the [application template][] as a Rake task. It is not intended to be run as a standalone generator, since it only makes sense to be run on concert with `suspenders:install:web`. Updates all generator descriptions to use Herdoc syntax to ensure consistent line breaks. A follow-up commit will update the descriptions to work better in a README. [application template]: https://guides.rubyonrails.org/rails_application_templates.html
- Loading branch information
1 parent
473e483
commit 5780f69
Showing
23 changed files
with
277 additions
and
26 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -2,15 +2,15 @@ module Suspenders | |
module Generators | ||
class EmailGenerator < Rails::Generators::Base | ||
source_root File.expand_path("../../templates/email", __FILE__) | ||
desc <<~TEXT | ||
desc <<~MARKDOWN | ||
Intercepts emails in non-production environments by setting `INTERCEPTOR_ADDRESSES`. | ||
```sh | ||
INTERCEPTOR_ADDRESSES="[email protected],[email protected]" bin/rails s | ||
``` | ||
Configures `default_url_options` in `test` and `development`. | ||
TEXT | ||
MARKDOWN | ||
|
||
def create_email_interceptor | ||
copy_file "email_interceptor.rb", "app/mailers/email_interceptor.rb" | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,151 @@ | ||
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 | ||
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, 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 | ||
|
||
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 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 dependecy 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: `#{Suspenders::NODE_LTS_VERSION}` | ||
MARKDOWN | ||
|
||
new_line | ||
end | ||
end | ||
end | ||
end |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.