suspenders 20230113.0 → 20250317.0

data/lib/suspenders/app_builder.rb

@@ -1,267 +0,0 @@
-require "forwardable"
-
-module Suspenders
-  class AppBuilder < Rails::AppBuilder
-    include Suspenders::Actions
-    extend Forwardable
-
-    def_delegators(
-      :heroku_adapter,
-      :create_heroku_pipeline,
-      :create_production_heroku_app,
-      :create_staging_heroku_app,
-      :set_heroku_application_host,
-      :set_heroku_backup_schedule,
-      :set_heroku_honeybadger_env,
-      :set_heroku_rails_secrets,
-      :set_heroku_remotes,
-      :set_heroku_buildpacks
-    )
-
-    def readme
-      template "README.md.erb", "README.md"
-    end
-
-    def gitignore
-      copy_file "suspenders_gitignore", ".gitignore"
-    end
-
-    def gemfile
-      template "Gemfile.erb", "Gemfile"
-    end
-
-    def setup_rack_mini_profiler
-      copy_file(
-        "rack_mini_profiler.rb",
-        "config/initializers/rack_mini_profiler.rb"
-      )
-    end
-
-    def raise_on_missing_assets_in_test
-      configure_environment "test", "config.assets.raise_runtime_errors = true"
-    end
-
-    def raise_on_delivery_errors
-      replace_in_file "config/environments/development.rb",
-        "raise_delivery_errors = false", "raise_delivery_errors = true"
-    end
-
-    def set_test_delivery_method
-      inject_into_file(
-        "config/environments/development.rb",
-        "\n  config.action_mailer.delivery_method = :file",
-        after: "config.action_mailer.raise_delivery_errors = true"
-      )
-    end
-
-    def raise_on_unpermitted_parameters
-      config = <<-RUBY
-    config.action_controller.action_on_unpermitted_parameters = :raise
-      RUBY
-
-      inject_into_class "config/application.rb", "Application", config
-    end
-
-    def configure_quiet_assets
-      config = <<-RUBY
-    config.assets.quiet = true
-      RUBY
-
-      inject_into_class "config/application.rb", "Application", config
-    end
-
-    def provide_setup_script
-      template "bin_setup", "bin/setup", force: true
-      run "chmod a+x bin/setup"
-    end
-
-    def provide_yarn_script
-      template "bin_yarn", "bin/yarn", force: true
-      run "chmod a+x bin/yarn"
-    end
-
-    def configure_generators
-      config = <<-RUBY
-
-    config.generators do |generate|
-      generate.helper false
-      generate.javascripts false
-      generate.controller_specs false
-      generate.request_specs true
-      generate.routing_specs false
-      generate.stylesheets false
-      generate.test_framework :rspec
-      generate.view_specs false
-    end
-
-      RUBY
-
-      inject_into_class "config/application.rb", "Application", config
-    end
-
-    def configure_local_mail
-      copy_file "email.rb", "config/initializers/email.rb"
-    end
-
-    def setup_asset_host
-      replace_in_file "config/environments/production.rb",
-        %(# config.asset_host = "http://assets.example.com"),
-        'config.asset_host = ENV.fetch("ASSET_HOST", ENV.fetch("APPLICATION_HOST"))'
-
-      if File.exist?("config/initializers/assets.rb")
-        replace_in_file "config/initializers/assets.rb",
-          %(Rails.application.config.assets.version = "1.0"),
-          'Rails.application.config.assets.version = (ENV["ASSETS_VERSION"] || "1.0")'
-      end
-
-      config = <<~EOD
-        config.public_file_server.headers = {
-            "Cache-Control" => "public, max-age=31557600",
-          }
-      EOD
-
-      configure_environment("production", config)
-    end
-
-    def setup_secret_token
-      template "secrets.yml", "config/secrets.yml", force: true
-    end
-
-    def disallow_wrapping_parameters
-      remove_file "config/initializers/wrap_parameters.rb"
-    end
-
-    def use_postgres_config_template
-      template "postgresql_database.yml.erb", "config/database.yml",
-        force: true
-    end
-
-    def create_database
-      bundle_command "exec rails db:create db:migrate"
-    end
-
-    def run_database_migrations
-      bundle_command "exec rails db:migrate"
-    end
-
-    def replace_gemfile
-      template "Gemfile.erb", "Gemfile", force: true do |content|
-        if development_env?
-          content.gsub(%r{gem .suspenders.}) { |s| %(#{s}, path: "#{root_path}") }
-        else
-          content
-        end
-      end
-    end
-
-    def ruby_version
-      create_file ".ruby-version", "#{Suspenders::RUBY_VERSION}\n"
-    end
-
-    def configure_i18n_for_missing_translations
-      raise_on_missing_translations_in("development")
-      raise_on_missing_translations_in("test")
-    end
-
-    def configure_action_mailer_in_specs
-      copy_file "action_mailer.rb", "spec/support/action_mailer.rb"
-    end
-
-    def configure_time_formats
-      remove_file "config/locales/en.yml"
-      template "config_locales_en.yml.erb", "config/locales/en.yml"
-    end
-
-    def configure_action_mailer
-      action_mailer_host "development", %("localhost:3000")
-      action_mailer_asset_host "development", %("http://localhost:3000")
-      action_mailer_host "test", %("www.example.com")
-      action_mailer_asset_host "test", %("http://www.example.com")
-      action_mailer_host "production", %{ENV.fetch("APPLICATION_HOST")}
-      # rubocop:disable Lint/InterpolationCheck
-      action_mailer_asset_host(
-        "production",
-        %q{"https://#{ENV.fetch("ASSET_HOST", ENV.fetch("APPLICATION_HOST"))}"}
-      )
-      # rubocop:enable Lint/InterpolationCheck
-    end
-
-    def create_heroku_apps(flags)
-      create_staging_heroku_app(flags)
-      create_production_heroku_app(flags)
-    end
-
-    def configure_automatic_deployment
-      append_file "Procfile", "release: bin/auto_migrate\n"
-      copy_file "bin_auto_migrate", "bin/auto_migrate"
-    end
-
-    def create_github_repo(repo_name)
-      run "hub create #{repo_name}"
-    end
-
-    def copy_miscellaneous_files
-      copy_file "errors.rb", "config/initializers/errors.rb"
-      copy_file "json_encoding.rb", "config/initializers/json_encoding.rb"
-    end
-
-    def remove_config_comment_lines
-      config_files = [
-        "application.rb",
-        "environment.rb",
-        "environments/development.rb",
-        "environments/production.rb",
-        "environments/test.rb"
-      ]
-
-      config_files.each do |config_file|
-        path = Pathname(destination_root).join("config", config_file)
-        source = Actions::StripCommentsAction.call(path.read)
-
-        path.write(source)
-      end
-    end
-
-    def remove_routes_comment_lines
-      replace_in_file "config/routes.rb",
-        /Rails\.application\.routes\.draw do.*end/m,
-        "Rails.application.routes.draw do\nend"
-    end
-
-    def setup_default_rake_task
-      append_file "Rakefile" do
-        <<~EOS
-          task(:default).clear
-          task default: [:spec]
-
-          if defined? RSpec
-            task(:spec).clear
-            RSpec::Core::RakeTask.new(:spec) do |t|
-              t.verbose = false
-            end
-          end
-        EOS
-      end
-    end
-
-    private
-
-    def root_path
-      @root_path ||= Pathname(__dir__).join("..", "..").expand_path
-    end
-
-    def development_env?
-      root_path.join("suspenders.gemspec").exist?
-    end
-
-    def raise_on_missing_translations_in(environment)
-      config = "config.i18n.raise_on_missing_translations = true"
-
-      uncomment_lines("config/environments/#{environment}.rb", config)
-    end
-
-    def heroku_adapter
-      @heroku_adapter ||= Adapters::Heroku.new(self)
-    end
-  end
-end

data/lib/suspenders/exit_on_failure.rb

@@ -1,19 +0,0 @@
-require "active_support/concern"
-require "English"
-
-module Suspenders
-  module ExitOnFailure
-    extend ActiveSupport::Concern
-
-    def bundle_command(*)
-      super
-      exit(false) if $CHILD_STATUS.exitstatus.nonzero?
-    end
-
-    module ClassMethods
-      def exit_on_failure?
-        true
-      end
-    end
-  end
-end

data/lib/suspenders/generators/accessibility_generator.rb

@@ -1,12 +0,0 @@
-require_relative "base"
-
-module Suspenders
-  class AccessibilityGenerator < Generators::Base
-    def capybara_gems
-      gem "capybara_accessibility_audit", group: [:test]
-      gem "capybara_accessible_selectors", group: [:test],
-        github: "citizensadvice/capybara_accessible_selectors"
-      Bundler.with_unbundled_env { run "bundle install" }
-    end
-  end
-end

data/lib/suspenders/generators/advisories_generator.rb

@@ -1,15 +0,0 @@
-require_relative "base"
-
-module Suspenders
-  class AdvisoriesGenerator < Generators::Base
-    def bundler_audit_gem
-      gem "bundler-audit", ">= 0.7.0", require: false, group: [:development, :test]
-      Bundler.with_unbundled_env { run "bundle install" }
-    end
-
-    def rake_task
-      copy_file "bundler_audit.rake", "lib/tasks/bundler_audit.rake"
-      append_file "Rakefile", %(\ntask default: "bundle:audit"\n)
-    end
-  end
-end

data/lib/suspenders/generators/analytics_generator.rb

@@ -1,24 +0,0 @@
-require_relative "base"
-
-module Suspenders
-  class AnalyticsGenerator < Generators::Base
-    def install_partial
-      copy_file "_analytics.html.erb",
-        "app/views/application/_analytics.html.erb"
-    end
-
-    def render_partial
-      if File.exist?(js_partial)
-        inject_into_file js_partial,
-          %(\n\n<%= render "analytics" %>),
-          after: "<%= yield :javascript %>"
-      end
-    end
-
-    private
-
-    def js_partial
-      "app/views/application/_javascript.html.erb"
-    end
-  end
-end

data/lib/suspenders/generators/app_generator.rb

@@ -1,215 +0,0 @@
-require "rails/generators"
-require "rails/generators/rails/app/app_generator"
-
-module Suspenders
-  class AppGenerator < Rails::Generators::AppGenerator
-    include ExitOnFailure
-
-    hide!
-
-    class_option :database, type: :string, aliases: "-d", default: "postgresql",
-      desc: "Configure for selected database (options: #{DATABASES.join("/")})"
-
-    class_option :heroku, type: :boolean, aliases: "-H", default: false,
-      desc: "Create staging and production Heroku apps"
-
-    class_option :heroku_flags, type: :string, default: "",
-      desc: "Set extra Heroku flags"
-
-    class_option :github, type: :string, default: nil,
-      desc: "Create Github repository and add remote origin pointed to repo"
-
-    class_option :version, type: :boolean, aliases: "-v", group: :suspenders,
-      desc: "Show Suspenders version number and quit"
-
-    class_option :help, type: :boolean, aliases: "-h", group: :suspenders,
-      desc: "Show this help message and quit"
-
-    class_option :skip_test, type: :boolean, default: true,
-      desc: "Skip Test Unit"
-
-    class_option :skip_system_test,
-      type: :boolean, default: true, desc: "Skip system test files"
-
-    class_option :css,
-      type: :string, default: "postcss", aliases: "-c", desc: "Choose CSS processor"
-
-    def finish_template
-      invoke :suspenders_customization
-      super
-    end
-
-    def leftovers
-      generate("suspenders:stylesheet_base") unless options[:api] || options[:css] != "postcss"
-      invoke :outro
-    end
-
-    def suspenders_customization
-      invoke :customize_gemfile
-      invoke :setup_development_environment
-      invoke :setup_production_environment
-      invoke :setup_secret_token
-      invoke :configure_app
-      invoke :copy_miscellaneous_files
-      invoke :setup_database
-      invoke :create_github_repo
-      invoke :generate_default
-      invoke :create_heroku_apps
-      invoke :generate_deployment_default
-      invoke :remove_config_comment_lines
-      invoke :remove_routes_comment_lines
-      invoke :run_database_migrations
-      invoke :generate_views
-    end
-
-    def customize_gemfile
-      build :replace_gemfile
-      bundle_command "install"
-    end
-
-    def setup_database
-      say "Setting up database"
-
-      if options[:database] == "postgresql"
-        build :use_postgres_config_template
-      end
-
-      build :create_database
-    end
-
-    def setup_development_environment
-      say "Setting up the development environment"
-      build :configure_local_mail
-      build :raise_on_missing_assets_in_test
-      build :raise_on_delivery_errors
-      build :set_test_delivery_method
-      build :raise_on_unpermitted_parameters
-      build :provide_setup_script
-      build :provide_yarn_script
-      build :configure_generators
-      build :configure_i18n_for_missing_translations
-      build :configure_quiet_assets
-    end
-
-    def setup_production_environment
-      say "Setting up the production environment"
-      build :setup_asset_host
-    end
-
-    def setup_secret_token
-      say "Moving secret token out of version control"
-      build :setup_secret_token
-    end
-
-    def configure_app
-      say "Configuring app"
-      build :configure_action_mailer
-      build :configure_time_formats
-      build :setup_default_rake_task
-    end
-
-    def create_heroku_apps
-      if options[:heroku]
-        say "Creating Heroku apps"
-        build :create_heroku_apps, options[:heroku_flags]
-        build :set_heroku_remotes
-        build :set_heroku_rails_secrets
-        build :set_heroku_application_host
-        build :set_heroku_honeybadger_env
-        build :set_heroku_backup_schedule
-        build :set_heroku_buildpacks
-        build :create_heroku_pipeline
-        build :configure_automatic_deployment
-      end
-    end
-
-    def create_github_repo
-      if !options[:skip_git] && options[:github]
-        say "Creating Github repo"
-        build :create_github_repo, options[:github]
-      end
-    end
-
-    def copy_miscellaneous_files
-      say "Copying miscellaneous support files"
-      build :copy_miscellaneous_files
-    end
-
-    def remove_config_comment_lines
-      build :remove_config_comment_lines
-    end
-
-    def remove_routes_comment_lines
-      build :remove_routes_comment_lines
-    end
-
-    def run_database_migrations
-      build :run_database_migrations
-    end
-
-    def generate_default
-      run("spring stop > /dev/null 2>&1 || true")
-      generate("suspenders:runner")
-      generate("suspenders:profiler")
-      generate("suspenders:json")
-      generate("suspenders:static")
-      generate("suspenders:testing")
-      generate("suspenders:ci")
-      generate("suspenders:js_driver")
-      generate("suspenders:forms") unless options[:api]
-      generate("suspenders:db_optimizations")
-      generate("suspenders:factories")
-      generate("suspenders:lint")
-      generate("suspenders:jobs")
-      generate("suspenders:analytics")
-      generate("suspenders:inline_svg")
-      generate("suspenders:advisories")
-    end
-
-    def generate_deployment_default
-      generate("suspenders:staging:pull_requests")
-      generate("suspenders:production:single_redirect")
-      generate("suspenders:production:compression")
-      generate("suspenders:production:force_tls")
-      generate("suspenders:production:email")
-      generate("suspenders:production:timeout")
-      generate("suspenders:production:deployment")
-      generate("suspenders:production:manifest")
-    end
-
-    def generate_views
-      generate("suspenders:views")
-    end
-
-    def outro
-      say "\nCongratulations! You just pulled our suspenders."
-      say honeybadger_outro
-    end
-
-    def self.banner
-      "suspenders #{arguments.map(&:usage).join(" ")} [options]"
-    end
-
-    protected
-
-    def get_builder_class
-      Suspenders::AppBuilder
-    end
-
-    def using_active_record?
-      !options[:skip_active_record]
-    end
-
-    private
-
-    def honeybadger_outro
-      "Run 'bundle exec honeybadger heroku install' with your API key#{honeybadger_message_suffix}."
-    end
-
-    def honeybadger_message_suffix
-      if options[:heroku]
-        " unless you're using the Heroku Honeybadger add-on"
-      end
-    end
-  end
-end

data/lib/suspenders/generators/base.rb

@@ -1,60 +0,0 @@
-require "rails/generators"
-require_relative "../actions"
-
-module Suspenders
-  module Generators
-    class Base < Rails::Generators::Base
-      include Suspenders::Actions
-      include ExitOnFailure
-
-      def self.default_source_root
-        File.expand_path(File.join("..", "..", "..", "templates"), __dir__)
-      end
-
-      def self.inherited(subclass)
-        super
-
-        description_file = File.expand_path(
-          File.join(
-            default_source_root,
-            "descriptions",
-            "#{subclass.generator_name}.md"
-          )
-        )
-
-        subclass.desc File.read(description_file)
-      rescue Errno::ENOENT
-      end
-
-      private
-
-      def app_name
-        Rails.app_class.module_parent_name.demodulize.underscore.dasherize
-      end
-
-      def empty_directory_with_keep_file(destination)
-        empty_directory(destination, {})
-        keep_file(destination)
-      end
-
-      def keep_file(destination)
-        create_file(File.join(destination, ".keep"))
-      end
-
-      def append_template_to_file(destination, source, *args)
-        partial = File.expand_path(find_in_source_paths(source))
-        append_to_file(destination, File.read(partial, *args))
-      end
-
-      def prepend_template_to_file(destination, source, *args)
-        partial = File.expand_path(find_in_source_paths(source))
-        prepend_to_file(destination, File.read(partial, *args))
-      end
-
-      def inject_template_into_file(destination, source, *args)
-        partial = File.expand_path(find_in_source_paths(source))
-        inject_into_file(destination, File.read(partial), *args)
-      end
-    end
-  end
-end

data/lib/suspenders/generators/ci_generator.rb

@@ -1,32 +0,0 @@
-require_relative "base"
-
-module Suspenders
-  class CiGenerator < Generators::Base
-    def simplecov_gem
-      gem "simplecov", require: false, group: [:test]
-      Bundler.with_unbundled_env { run "bundle install" }
-    end
-
-    def simplecov_test_integration
-      prepend_template_to_file(test_helper_file, "partials/ci_simplecov.rb")
-    end
-
-    def configure_ci
-      template "circle.yml.erb", "circle.yml"
-    end
-
-    private
-
-    def test_helper_file
-      if using_rspec?
-        "spec/spec_helper.rb"
-      else
-        "test/test_helper.rb"
-      end
-    end
-
-    def using_rspec?
-      File.exist?("spec/spec_helper.rb")
-    end
-  end
-end

data/lib/suspenders/generators/db_optimizations_generator.rb

@@ -1,18 +0,0 @@
-require_relative "base"
-
-module Suspenders
-  class DbOptimizationsGenerator < Generators::Base
-    def add_bullet
-      gem "bullet", group: %i[development test]
-      Bundler.with_unbundled_env { run "bundle install" }
-    end
-
-    def configure_bullet
-      inject_template_into_file(
-        "config/environments/development.rb",
-        "partials/db_optimizations_configuration.rb",
-        after: /config.action_mailer.raise_delivery_errors = .*/
-      )
-    end
-  end
-end

data/lib/suspenders/generators/factories_generator.rb

@@ -1,22 +0,0 @@
-require_relative "base"
-
-module Suspenders
-  class FactoriesGenerator < Generators::Base
-    def add_factory_bot
-      gem "factory_bot_rails", group: %i[development test]
-      Bundler.with_unbundled_env { run "bundle install" }
-    end
-
-    def set_up_factory_bot_for_rspec
-      copy_file "factory_bot_rspec.rb", "spec/support/factory_bot.rb"
-    end
-
-    def generate_empty_factories_file
-      copy_file "factories.rb", "spec/factories.rb"
-    end
-
-    def provide_dev_prime_task
-      copy_file "dev.rake", "lib/tasks/dev.rake"
-    end
-  end
-end