From 5433da296cee1a5dc18c50dac66ff03fd1b91ed8 Mon Sep 17 00:00:00 2001 From: Steve Polito Date: Fri, 19 Apr 2024 19:30:53 -0400 Subject: [PATCH] Test Cleanup: Remove generator description tests (#1194) I no longer thing it's valuable to test if a generator has a custom description, because contributors would have to know to add these tests in the first place. --- .../accessibility_generator_test.rb | 6 ------ .../suspenders/advisories_generator_test.rb | 11 ----------- .../suspenders/email_generator_test.rb | 4 ---- .../suspenders/factories_generator_test.rb | 19 ------------------- .../suspenders/inline_svg_generator_test.rb | 6 ------ .../suspenders/jobs_generator_test.rb | 6 ------ .../suspenders/lint_generator_test.rb | 6 ------ .../prerequisites_generator_test.rb | 4 ---- .../suspenders/rake_generator_test.rb | 9 --------- .../suspenders/setup_generator_test.rb | 4 ---- .../suspenders/styles_generator_test.rb | 4 ---- .../suspenders/tasks_generator_test.rb | 4 ---- .../suspenders/testing_generator_test.rb | 4 ---- .../suspenders/views_generator_test.rb | 4 ---- 14 files changed, 91 deletions(-) diff --git a/test/generators/suspenders/accessibility_generator_test.rb b/test/generators/suspenders/accessibility_generator_test.rb index 167ee5617..bf55abdf1 100644 --- a/test/generators/suspenders/accessibility_generator_test.rb +++ b/test/generators/suspenders/accessibility_generator_test.rb @@ -56,12 +56,6 @@ class AccessibilityGeneratorTest < Rails::Generators::TestCase assert_match(/bundle install/, output) end - test "generator has a description" do - description = "Installs capybara_accessibility_audit and capybara_accessible_selectors" - - assert_match description, Suspenders::Generators::AccessibilityGenerator.desc - end - private def prepare_destination diff --git a/test/generators/suspenders/advisories_generator_test.rb b/test/generators/suspenders/advisories_generator_test.rb index 63a40b04b..dc6b79352 100644 --- a/test/generators/suspenders/advisories_generator_test.rb +++ b/test/generators/suspenders/advisories_generator_test.rb @@ -31,17 +31,6 @@ class AdvisoriesGeneratorTest < Rails::Generators::TestCase assert_match(/bundle install/, output) end - test "generator has a description" do - description = <<~TEXT - Show security advisories during development. - - Uses the `bundler-audit` gem to update the local security database and - show any relevant issues with the app's dependencies via a Rake task. - TEXT - - assert_equal description, Suspenders::Generators::AdvisoriesGenerator.desc - end - test "modifies Rakefile" do touch "Rakefile", content: <<~TEXT require_relative "config/application" diff --git a/test/generators/suspenders/email_generator_test.rb b/test/generators/suspenders/email_generator_test.rb index 995d0fa82..56fd93139 100644 --- a/test/generators/suspenders/email_generator_test.rb +++ b/test/generators/suspenders/email_generator_test.rb @@ -49,10 +49,6 @@ class EmailGeneratorTest < Rails::Generators::TestCase assert_file app_root("config/environments/test.rb"), /config\.action_mailer\.default_url_options\s*=\s*{\s*host:\s*"www\.example\.com"\s*}/ end - test "has custom description" do - assert_no_match(/Description/, generator_class.desc) - end - private def prepare_destination diff --git a/test/generators/suspenders/factories_generator_test.rb b/test/generators/suspenders/factories_generator_test.rb index ed203c8fc..9b6797fab 100644 --- a/test/generators/suspenders/factories_generator_test.rb +++ b/test/generators/suspenders/factories_generator_test.rb @@ -11,25 +11,6 @@ class FactoriesGenerator::DefaultTest < Rails::Generators::TestCase setup :prepare_destination teardown :restore_destination - test "generator has a description" do - description = <<~TEXT - Build test data with clarity and ease. - - This uses FactoryBot 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. - - We recommend putting FactoryBot definitions in one `spec/factories.rb` (or - `test/factories`) file, at least until it grows unwieldy. This helps reduce - confusion around circular dependencies and makes it easy to jump between - definitions. - - Supports the default test suite and RSpec. - TEXT - - assert_equal description, FactoriesGenerator.desc - end - test "installs gem with Bundler" do with_test_suite :minitest do output = run_generator diff --git a/test/generators/suspenders/inline_svg_generator_test.rb b/test/generators/suspenders/inline_svg_generator_test.rb index b59492aa4..b50fd5539 100644 --- a/test/generators/suspenders/inline_svg_generator_test.rb +++ b/test/generators/suspenders/inline_svg_generator_test.rb @@ -51,12 +51,6 @@ class InlinveSvgGeneratorTest < Rails::Generators::TestCase assert_match(/bundle install/, output) end - test "generator has a description" do - description = "Render SVG images inline, as a potential performance improvement for the viewer." - - assert_match description, Suspenders::Generators::InlineSvgGenerator.desc - end - test "configures raising an error when an SVG file is not found" do expected_configuration = file_fixture("inline_svg.rb").read diff --git a/test/generators/suspenders/jobs_generator_test.rb b/test/generators/suspenders/jobs_generator_test.rb index 7b2bd3cc5..ef76ecf14 100644 --- a/test/generators/suspenders/jobs_generator_test.rb +++ b/test/generators/suspenders/jobs_generator_test.rb @@ -29,12 +29,6 @@ class JobsGeneratorTest < Rails::Generators::TestCase assert_match(/bundle install/, output) end - test "generator has a description" do - description = "Installs Sidekiq for background job processing." - - assert_match description, Suspenders::Generators::JobsGenerator.desc - end - test "configures ActiveJob logging" do expected_configuration = file_fixture("active_job.rb").read diff --git a/test/generators/suspenders/lint_generator_test.rb b/test/generators/suspenders/lint_generator_test.rb index e6364e84e..ea0738e74 100644 --- a/test/generators/suspenders/lint_generator_test.rb +++ b/test/generators/suspenders/lint_generator_test.rb @@ -141,12 +141,6 @@ class LintGeneratorTest < Rails::Generators::TestCase end end - test "description" do - desc = "Creates a holistic linting solution that covers JavaScript, CSS, Ruby and ERB." - - assert_match desc, generator_class.desc - end - test "created package.json if one does not exist" do remove_file_if_exists "package.json" diff --git a/test/generators/suspenders/prerequisites_generator_test.rb b/test/generators/suspenders/prerequisites_generator_test.rb index c41536bbd..70d065dd5 100644 --- a/test/generators/suspenders/prerequisites_generator_test.rb +++ b/test/generators/suspenders/prerequisites_generator_test.rb @@ -18,10 +18,6 @@ class PrerequisitesGeneratorTest < Rails::Generators::TestCase end end - test "has custom description" do - assert_no_match(/Description/, generator.class.desc) - end - private def restore_destination diff --git a/test/generators/suspenders/rake_generator_test.rb b/test/generators/suspenders/rake_generator_test.rb index 4f72ab990..d098c0118 100644 --- a/test/generators/suspenders/rake_generator_test.rb +++ b/test/generators/suspenders/rake_generator_test.rb @@ -21,15 +21,6 @@ class RakeGeneratorTest < Rails::Generators::TestCase end end - test "generator has a description" do - description = <<~TEXT - Configures the default Rake task to audit and lint the codebase with - `bundler-audit` and `standard`, in addition to running the test suite. - TEXT - - assert_equal description, generator_class.desc - end - private def prepare_destination diff --git a/test/generators/suspenders/setup_generator_test.rb b/test/generators/suspenders/setup_generator_test.rb index c8db00da3..0fff4136a 100644 --- a/test/generators/suspenders/setup_generator_test.rb +++ b/test/generators/suspenders/setup_generator_test.rb @@ -21,10 +21,6 @@ class SetupGeneratorTest < Rails::Generators::TestCase end end - test "has a custom description" do - assert_no_match(/Description:/, generator_class.desc) - end - private def prepare_destination diff --git a/test/generators/suspenders/styles_generator_test.rb b/test/generators/suspenders/styles_generator_test.rb index 6647643d6..114b1e6d0 100644 --- a/test/generators/suspenders/styles_generator_test.rb +++ b/test/generators/suspenders/styles_generator_test.rb @@ -108,10 +108,6 @@ class StylesGeneratorTest < Rails::Generators::TestCase assert_file app_root("app/assets/static/.gitkeep") end - test "generator has a custom description" do - assert_no_match(/Description/, generator_class.desc) - end - private def prepare_destination diff --git a/test/generators/suspenders/tasks_generator_test.rb b/test/generators/suspenders/tasks_generator_test.rb index e3289b17f..0f2e1d1f0 100644 --- a/test/generators/suspenders/tasks_generator_test.rb +++ b/test/generators/suspenders/tasks_generator_test.rb @@ -29,10 +29,6 @@ class TasksGeneratorTest < Rails::Generators::TestCase assert_no_file app_root("lib/tasks/dev.rake") end - test "has a custom description" do - assert_no_match(/Description:/, generator_class.desc) - end - private def dev_rake diff --git a/test/generators/suspenders/testing_generator_test.rb b/test/generators/suspenders/testing_generator_test.rb index d574f789d..8b4b06ae6 100644 --- a/test/generators/suspenders/testing_generator_test.rb +++ b/test/generators/suspenders/testing_generator_test.rb @@ -114,10 +114,6 @@ class TestingGeneratorTest < Rails::Generators::TestCase end end - test "has custom description" do - assert_no_match(/Description/, generator_class.desc) - end - private def prepare_destination diff --git a/test/generators/suspenders/views_generator_test.rb b/test/generators/suspenders/views_generator_test.rb index 3ac7b3e01..ddd26554e 100644 --- a/test/generators/suspenders/views_generator_test.rb +++ b/test/generators/suspenders/views_generator_test.rb @@ -75,10 +75,6 @@ class ViewsGeneratorTest < Rails::Generators::TestCase end end - test "has a custom description" do - assert_no_match(/Description:\n/, generator_class.desc) - end - test "disables InstantClick" do run_generator