suspenders 20230113.0 → 20240516.0

data/lib/suspenders/cleanup/generate_readme.rb

@@ -0,0 +1,165 @@
+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
+      include Suspenders::Generators::Helpers
+
+      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.titleize, 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
+          content <<~MARKDOWN
+            For more information, review the [Accessibility Tooling][] section in 
+            the [CONTRIBUTING][] guide.
+
+            [Accessibility Tooling]: ./CONTRIBUTING.md#accessibility-tooling
+            [CONTRIBUTING]: ./CONTRIBUTING.md
+          MARKDOWN
+          new_line
+
+          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 content(text)
+        @file.write text
+      end
+
+      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 dependency 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: `#{node_version}`
+        MARKDOWN
+
+        new_line
+      end
+    end
+  end
+end

data/lib/suspenders/cleanup/organize_gemfile.rb

@@ -0,0 +1,134 @@
+module Suspenders
+  module Cleanup
+    class OrganizeGemfile
+      def self.perform(gemfile)
+        new(gemfile).perform
+      end
+
+      attr_reader :gemfile, :current_lines, :new_lines, :new_line_markers,
+        :current_group, :gem_groups
+
+      def initialize(gemfile)
+        @gemfile = gemfile
+
+        @current_lines = File.read(gemfile).lines
+        @new_lines = []
+        @new_line_markers = []
+
+        @current_group = nil
+        @gem_groups = {}
+      end
+
+      def perform
+        remove_line_breaks
+        sort_gems_and_groups
+        add_gem_groups_to_gemfile
+        add_line_breaks
+        cleanup
+
+        File.open(gemfile, "w+") { _1.write new_lines.join }
+      end
+
+      private
+
+      def remove_line_breaks
+        current_lines.delete("\n")
+      end
+
+      def sort_gems_and_groups
+        current_lines.each do |line|
+          if line.starts_with?(/group/)
+            @current_group = line
+          end
+
+          # Consolidate gem groups
+          if current_group
+            if line.starts_with?(/end/)
+              @current_group = nil
+            elsif !line.starts_with?(/group/)
+              gem_groups[current_group] ||= []
+              gem_groups[current_group] << line
+            end
+          # Add non-grouped gems
+          elsif !line.starts_with?(/\n/)
+            new_lines << line
+            @current_group = nil
+          end
+        end
+      end
+
+      def add_gem_groups_to_gemfile
+        gem_groups.keys.each do |group|
+          gems = gem_groups[group]
+
+          gems.each_with_index do |gem, index|
+            if index == 0
+              new_lines << group
+            end
+
+            new_lines << gem
+
+            if gems.size == (index + 1)
+              new_lines << "end\n"
+            end
+          end
+        end
+      end
+
+      def add_line_breaks
+        new_lines.each_with_index do |line, index|
+          previous_line = new_lines[index - 1] if index > 0
+          next_line = new_lines[index + 1]
+          marker = index + 1
+
+          # Add line break if it's a gem and the next line is commented out
+          if (line.starts_with?(/\s*gem/) || line.starts_with?(/\s*\#\s*gem/)) && next_line&.starts_with?(/\s*\#/)
+            new_line_markers << marker
+          end
+
+          # Add line break if it's a commented out gem and the next line is a gem
+          if line.starts_with?(/\s*\#\s*gem/) && next_line&.starts_with?(/\s*gem/)
+            new_line_markers << marker
+          end
+
+          # Add line break if it's a gem with a comment and the next line is a gem
+          if previous_line&.starts_with?(/\s*\#/) \
+              && line.starts_with?(/\s*gem/) \
+              && next_line&.starts_with?(/\s*gem/) \
+              && !previous_line.starts_with?(/\s*\#\s*gem/)
+            new_line_markers << marker
+          end
+
+          # Add a line break if it's /end/
+          if line.starts_with?(/end/)
+            new_line_markers << marker
+          end
+
+          # Add a line break if it's a gem and the next line is a group
+          if line.starts_with?(/gem/) && next_line&.starts_with?(/group/)
+            new_line_markers << marker
+          end
+
+          # Add line break if it's /source/ or /ruby/
+          if line.starts_with?(/\w/) && !line.starts_with?(/\s*(gem|group|end)/)
+            new_line_markers << marker
+          end
+        end
+
+        new_line_markers.each_with_index do |marker, index|
+          # Each time we insert, the original marker if off by 1
+          marker_offset = marker + index
+
+          new_lines.insert(marker_offset, "\n")
+        end
+      end
+
+      def cleanup
+        # Remove last line
+        if /\n/.match?(new_lines.last)
+          new_lines.pop
+        end
+      end
+    end
+  end
+end

data/lib/suspenders/engine.rb

@@ -0,0 +1,5 @@
+module Suspenders
+  class Engine < ::Rails::Engine
+    isolate_namespace Suspenders
+  end
+end

data/lib/suspenders/generators.rb

@@ -0,0 +1,126 @@
+require "active_support/concern"
+
+module Suspenders
+  module Generators
+    module Helpers
+      def default_test_suite?
+        File.exist? Rails.root.join("test")
+      end
+
+      def rspec_test_suite?
+        File.exist? Rails.root.join("spec/spec_helper.rb")
+      end
+
+      def default_test_helper_present?
+        File.exist? Rails.root.join("test/test_helper.rb")
+      end
+
+      def rspec_test_helper_present?
+        File.exist? Rails.root.join("spec/rails_helper.rb")
+      end
+
+      def node_version
+        ENV["NODE_VERSION"] || `node --version`[/\d+\.\d+\.\d+/]
+      end
+
+      def node_not_installed?
+        !node_version.present?
+      end
+
+      def node_version_unsupported?
+        node_version < Suspenders::MINIMUM_NODE_VERSION
+      end
+    end
+
+    module APIAppUnsupported
+      class Error < StandardError
+        def message
+          "This generator cannot be used on API only applications."
+        end
+      end
+
+      extend ActiveSupport::Concern
+
+      included do
+        def raise_if_api_only_app
+          if api_only_app?
+            raise Suspenders::Generators::APIAppUnsupported::Error
+          end
+        end
+      end
+
+      private
+
+      def api_only_app?
+        File.read(Rails.root.join("config/application.rb"))
+          .match?(/^\s*config\.api_only\s*=\s*true/i)
+      end
+    end
+
+    module DatabaseUnsupported
+      include Helpers
+
+      class Error < StandardError
+        def message
+          "This generator requires PostgreSQL"
+        end
+      end
+
+      extend ActiveSupport::Concern
+
+      included do
+        def raise_if_database_unsupported
+          if database_unsupported?
+            raise Suspenders::Generators::DatabaseUnsupported::Error
+          end
+        end
+
+        private
+
+        def database_unsupported?
+          configuration = File.read(Rails.root.join("config/database.yml"))
+          configuration = YAML.safe_load(configuration, aliases: true)
+          adapter = configuration["default"]["adapter"]
+
+          adapter != "postgresql"
+        end
+      end
+    end
+
+    module NodeNotInstalled
+      class Error < StandardError
+        def message
+          "This generator requires Node"
+        end
+      end
+
+      extend ActiveSupport::Concern
+
+      included do
+        def raise_if_node_not_installed
+          if node_not_installed?
+            raise Suspenders::Generators::NodeNotInstalled::Error
+          end
+        end
+      end
+    end
+
+    module NodeVersionUnsupported
+      class Error < StandardError
+        def message
+          "This generator requires Node >= #{Suspenders::MINIMUM_NODE_VERSION}"
+        end
+      end
+
+      extend ActiveSupport::Concern
+
+      included do
+        def raise_if_node_version_unsupported
+          if node_version_unsupported?
+            raise Suspenders::Generators::NodeVersionUnsupported::Error
+          end
+        end
+      end
+    end
+  end
+end

data/lib/suspenders/railtie.rb

@@ -0,0 +1,4 @@
+module Suspenders
+  class Railtie < ::Rails::Railtie
+  end
+end

data/lib/suspenders/version.rb

@@ -1,8 +1,6 @@
 module Suspenders
-  RAILS_VERSION = "~> 7.0.0".freeze
-  RUBY_VERSION = IO
-    .read("#{File.dirname(__FILE__)}/../../.ruby-version")
-    .strip
-    .freeze
-  VERSION = "20230113.0".freeze
+  VERSION = "20240516.0".freeze
+  RAILS_VERSION = "~> 7.0".freeze
+  MINIMUM_RUBY_VERSION = ">= 3.1".freeze
+  MINIMUM_NODE_VERSION = "20.0.0".freeze
 end

data/lib/suspenders.rb

@@ -1,34 +1,10 @@
 require "suspenders/version"
-require "suspenders/exit_on_failure"
-require "suspenders/generators/accessibility_generator"
-require "suspenders/generators/advisories_generator"
-require "suspenders/generators/app_generator"
-require "suspenders/generators/static_generator"
-require "suspenders/generators/stylesheet_base_generator"
-require "suspenders/generators/stylelint_generator"
-require "suspenders/generators/forms_generator"
-require "suspenders/generators/ci_generator"
-require "suspenders/generators/db_optimizations_generator"
-require "suspenders/generators/factories_generator"
-require "suspenders/generators/lint_generator"
-require "suspenders/generators/jobs_generator"
-require "suspenders/generators/analytics_generator"
-require "suspenders/generators/views_generator"
-require "suspenders/generators/js_driver_generator"
-require "suspenders/generators/json_generator"
-require "suspenders/generators/testing_generator"
-require "suspenders/generators/inline_svg_generator"
-require "suspenders/generators/profiler_generator"
-require "suspenders/generators/runner_generator"
-require "suspenders/generators/production/force_tls_generator"
-require "suspenders/generators/production/compression_generator"
-require "suspenders/generators/production/email_generator"
-require "suspenders/generators/production/timeout_generator"
-require "suspenders/generators/production/deployment_generator"
-require "suspenders/generators/production/manifest_generator"
-require "suspenders/generators/production/single_redirect"
-require "suspenders/generators/staging/pull_requests_generator"
-require "suspenders/actions"
-require "suspenders/actions/strip_comments_action"
-require "suspenders/adapters/heroku"
-require "suspenders/app_builder"
+require "suspenders/engine"
+require "suspenders/railtie"
+require "suspenders/generators"
+require "suspenders/cleanup/organize_gemfile"
+require "suspenders/cleanup/generate_readme"
+
+module Suspenders
+  # Your code goes here...
+end

data/lib/tasks/suspenders.rake

@@ -0,0 +1,37 @@
+namespace :suspenders do
+  desc "Extend the default Rails Rake task"
+  task :rake do
+    if Bundler.rubygems.find_name("bundler-audit").any?
+      Rake::Task[:"bundle:audit"].invoke
+    end
+
+    if Bundler.rubygems.find_name("standard").any?
+      Rake::Task[:standard].invoke
+    end
+  end
+
+  desc "Ensure a migration is reversible"
+  namespace :db do
+    task :migrate do
+      Rake::Task["db:migrate"].invoke
+      Rake::Task["db:rollback"].invoke
+
+      Rake::Task["db:migrate"].reenable
+      Rake::Task["db:migrate"].invoke
+
+      Rake::Task["db:test:prepare"].invoke
+    end
+  end
+
+  namespace :cleanup do
+    desc "Organizes Gemfile"
+    task organize_gemfile: :environment do
+      Suspenders::Cleanup::OrganizeGemfile.perform(Rails.root.join("Gemfile"))
+    end
+
+    desc "Generate README"
+    task :generate_readme do
+      Suspenders::Cleanup::GenerateReadme.perform(Rails.root.join("README.md"), Rails.application.class.module_parent_name)
+    end
+  end
+end