omg-railties 8.0.0.alpha3

data/lib/rails/generators/rails/credentials/credentials_generator.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require "rails/generators/base"
+require "rails/generators/rails/master_key/master_key_generator"
+require "active_support/encrypted_configuration"
+
+module Rails
+  module Generators
+    class CredentialsGenerator < Base # :nodoc:
+      argument :content_path, default: "config/credentials.yml.enc"
+      argument :key_path, default: "config/master.key"
+      class_option :skip_secret_key_base, type: :boolean
+
+      def add_credentials_file
+        in_root do
+          return if File.exist?(content_path)
+
+          say "Adding #{content_path} to store encrypted credentials."
+          say ""
+
+          content = render_template_to_encrypted_file
+
+          say "The following content has been encrypted with the Rails master key:"
+          say ""
+          say content, :on_green
+          say ""
+          say "You can edit encrypted credentials with `bin/rails credentials:edit`."
+          say ""
+        end
+      end
+
+      private
+        def encrypted_file
+          ActiveSupport::EncryptedConfiguration.new(
+            config_path: content_path,
+            key_path: key_path,
+            env_key: "RAILS_MASTER_KEY",
+            raise_if_missing_key: true
+          )
+        end
+
+        def secret_key_base
+          @secret_key_base ||= SecureRandom.hex(64)
+        end
+
+        def render_template_to_encrypted_file
+          empty_directory File.dirname(content_path)
+
+          content = nil
+
+          encrypted_file.change do |tmp_path|
+            template("credentials.yml", tmp_path, force: true, verbose: false) do |rendered|
+              content = rendered
+            end
+          end
+
+          content
+        end
+    end
+  end
+end

data/lib/rails/generators/rails/credentials/templates/credentials.yml.tt

@@ -0,0 +1,12 @@
+# smtp:
+#   user_name: my-smtp-user
+#   password: my-smtp-password
+#
+# aws:
+#   access_key_id: 123
+#   secret_access_key: 345
+<% unless options.skip_secret_key_base? -%>
+
+# Used as the base secret for all MessageVerifiers in Rails, including the one protecting cookies.
+secret_key_base: <%= secret_key_base %>
+<% end -%>

data/lib/rails/generators/rails/db/system/change/change_generator.rb

@@ -0,0 +1,206 @@
+# frozen_string_literal: true
+
+require "rails/generators/base"
+require "yaml"
+require "json"
+
+module Rails
+  module Generators
+    module Db
+      module System
+        class ChangeGenerator < Base # :nodoc:
+          include AppName
+
+          BASE_PACKAGES = %w( curl libvips )
+          BUILD_PACKAGES = %w( build-essential git )
+
+          class_option :to, required: true,
+            desc: "The database system to switch to."
+
+          def self.default_generator_root
+            path = File.expand_path(File.join(base_name, "app"), base_root)
+            path if File.exist?(path)
+          end
+
+          def initialize(*)
+            super
+
+            unless Database::DATABASES.include?(options[:to])
+              raise Error, "Invalid value for --to option. Supported preconfigurations are: #{Database::DATABASES.join(", ")}."
+            end
+
+            opt = options.dup
+            opt[:database] ||= opt[:to]
+            self.options = opt.freeze
+          end
+
+          def edit_database_config
+            template(database.template, "config/database.yml")
+          end
+
+          def edit_gemfile
+            name, version = database.gem
+            gsub_file("Gemfile", all_database_gems_regex, name)
+            gsub_file("Gemfile", gem_entry_regex_for(name), gem_entry_for(name, *version))
+          end
+
+          def edit_dockerfile
+            dockerfile_path = File.expand_path("Dockerfile", destination_root)
+            return unless File.exist?(dockerfile_path)
+
+            gsub_file("Dockerfile", all_docker_bases_regex, docker_base_packages(database.base_package))
+            gsub_file("Dockerfile", all_docker_builds_regex, docker_build_packages(database.build_package))
+          end
+
+          def edit_devcontainer_files
+            return unless devcontainer?
+
+            edit_devcontainer_json
+            edit_compose_yaml
+          end
+
+          private
+            def all_database_gems
+              Database.all.map { |database| database.gem }
+            end
+
+            def all_docker_bases
+              Database.all.map { |database| docker_base_packages(database.base_package) }.uniq
+            end
+
+            def docker_base_packages(database_package)
+              if database_package
+                [database_package].concat(BASE_PACKAGES).sort
+              else
+                BASE_PACKAGES
+              end.join("\s")
+            end
+
+            def all_docker_builds
+              Database.all.map { |database| docker_build_packages(database.build_package) }.uniq
+            end
+
+            def docker_build_packages(database_package)
+              if database_package
+                [database_package].concat(BUILD_PACKAGES).sort
+              else
+                BUILD_PACKAGES
+              end.join("\s")
+            end
+
+            def all_database_gems_regex
+              all_database_gem_names = all_database_gems.map(&:first)
+              /(\b#{all_database_gem_names.join('\b|\b')}\b)/
+            end
+
+            def all_docker_bases_regex
+              /(\b#{all_docker_bases.join('\b|\b')}\b)/
+            end
+
+            def all_docker_builds_regex
+              /(\b#{all_docker_builds.join('\b|\b')}\b)/
+            end
+
+            def gem_entry_regex_for(gem_name)
+              /^gem.*\b#{gem_name}\b.*/
+            end
+
+            def gem_entry_for(*gem_name_and_version)
+              gem_name_and_version.map! { |segment| "\"#{segment}\"" }
+              "gem #{gem_name_and_version.join(", ")}"
+            end
+
+            def edit_devcontainer_json
+              return unless devcontainer_json
+
+              update_devcontainer_db_host
+              update_devcontainer_db_feature
+            end
+
+            def edit_compose_yaml
+              compose_yaml_path = File.expand_path(".devcontainer/compose.yaml", destination_root)
+              return unless File.exist?(compose_yaml_path)
+
+              compose_config = YAML.load_file(compose_yaml_path)
+
+              Database.all.each do |database|
+                compose_config["services"].delete(database.name)
+                compose_config["volumes"]&.delete(database.volume)
+                compose_config["services"]["rails-app"]["depends_on"]&.delete(database.name)
+              end
+
+              if database.service
+                compose_config["services"][database.name] = database.service
+                compose_config["volumes"] = { database.volume => nil }.merge(compose_config["volumes"] || {})
+                compose_config["services"]["rails-app"]["depends_on"] = [
+                  database.name,
+                  compose_config["services"]["rails-app"]["depends_on"]
+                ].flatten.compact
+              end
+
+              compose_config.delete("volumes") unless compose_config["volumes"]&.any?
+              compose_config["services"]["rails-app"].delete("depends_on") unless compose_config["services"]["rails-app"]["depends_on"]&.any?
+
+              File.write(compose_yaml_path, compose_config.to_yaml)
+            end
+
+            def update_devcontainer_db_host
+              container_env = devcontainer_json["containerEnv"]
+              db_name = database.name
+
+              if container_env["DB_HOST"]
+                if database.service
+                  container_env["DB_HOST"] = db_name
+                else
+                  container_env.delete("DB_HOST")
+                end
+              else
+                if database.service
+                  container_env["DB_HOST"] = db_name
+                end
+              end
+
+              new_json = JSON.pretty_generate(container_env, indent: "  ", object_nl: "\n  ")
+
+              gsub_file(".devcontainer/devcontainer.json", /("containerEnv"\s*:\s*)(.|\n)*?(^\s{2}})/, "\\1#{new_json}")
+            end
+
+            def update_devcontainer_db_feature
+              features = devcontainer_json["features"]
+              db_feature = database.feature
+
+              Database.all.each do |database|
+                features.delete(database.feature_name)
+              end
+
+              features.merge!(db_feature) if db_feature
+
+              new_json = JSON.pretty_generate(features, indent: "  ", object_nl: "\n  ")
+
+              gsub_file(".devcontainer/devcontainer.json", /("features"\s*:\s*)(.|\n)*?(^\s{2}})/, "\\1#{new_json}")
+            end
+
+            def devcontainer_json
+              return unless File.exist?(devcontainer_json_path)
+
+              @devcontainer_json ||= JSON.parse(File.read(devcontainer_json_path))
+            end
+
+            def devcontainer_json_path
+              File.expand_path(".devcontainer/devcontainer.json", destination_root)
+            end
+
+            def database
+              @database ||= Database.build(options[:database])
+            end
+
+            def devcontainer?
+              return @devcontainer if defined?(@devcontainer)
+
+              @devcontainer = File.exist?(File.expand_path(".devcontainer", destination_root))
+            end
+        end
+      end
+    end
+  end
+end

data/lib/rails/generators/rails/devcontainer/devcontainer_generator.rb

@@ -0,0 +1,168 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+
+module Rails
+  module Generators
+    class DevcontainerGenerator < Base # :nodoc:
+      class_option :app_name, type: :string, default: "rails_app",
+                   desc: "Name of the app"
+
+      class_option :database, enum: Database::DATABASES, type: :string, default: "sqlite3",
+                   desc: "Include configuration for selected database"
+
+      class_option :redis, type: :boolean, default: true,
+                   desc: "Include configuration for Redis"
+
+      class_option :system_test, type: :boolean, default: true,
+                   desc: "Include configuration for System Tests"
+
+      class_option :active_storage, type: :boolean, default: true,
+                   desc: "Include configuration for Active Storage"
+
+      class_option :node, type: :boolean, default: false,
+                   desc: "Include configuration for Node"
+
+      class_option :dev, type: :boolean, default: false,
+                    desc: "For applications pointing to a local Rails checkout"
+
+      source_paths << File.expand_path(File.join(base_name, "app", "templates"), base_root)
+
+      def create_devcontainer
+        empty_directory ".devcontainer"
+
+        template "devcontainer/devcontainer.json", ".devcontainer/devcontainer.json"
+        template "devcontainer/Dockerfile", ".devcontainer/Dockerfile"
+        template "devcontainer/compose.yaml", ".devcontainer/compose.yaml"
+      end
+
+      def update_application_system_test_case
+        return unless options[:system_test]
+
+        system_test_case_path = File.expand_path "test/application_system_test_case.rb", destination_root
+        return unless File.exist? system_test_case_path
+
+        gsub_file(system_test_case_path, /^\s*driven_by\b.*/, system_test_configuration)
+      end
+
+      def update_database_yml
+        # Only postgresql has devcontainer specific configuration, so only update database.yml if we are using postgres
+        return unless options[:database] == "postgresql"
+
+        template("config/databases/#{options[:database]}.yml", "config/database.yml")
+      end
+
+      private
+        def devcontainer?
+          true
+        end
+
+        def app_name
+          options[:app_name]
+        end
+
+        def dependencies
+          return @dependencies if @dependencies
+
+          @dependencies = []
+
+          @dependencies << "selenium" if options[:system_test]
+          @dependencies << "redis" if options[:redis]
+          @dependencies << database.name if database.service
+          @dependencies
+        end
+
+        def container_env
+          return @container_env if @container_env
+
+          @container_env = {}
+
+          @container_env["CAPYBARA_SERVER_PORT"] = "45678" if options[:system_test]
+          @container_env["SELENIUM_HOST"] = "selenium" if options[:system_test]
+          @container_env["REDIS_URL"] = "redis://redis:6379/1" if options[:redis]
+          @container_env["DB_HOST"] = database.name if database.service
+
+          @container_env
+        end
+
+        def volumes
+          return @volumes if @volumes
+
+          @volumes = []
+
+          @volumes << "redis-data" if options[:redis]
+          @volumes << database.volume if database.volume
+
+          @volumes
+        end
+
+        def features
+          return @features if @features
+
+          @features = {
+            "ghcr.io/devcontainers/features/github-cli:1" => {}
+          }
+
+          @features["ghcr.io/rails/devcontainer/features/activestorage"] = {} if options[:active_storage]
+          @features["ghcr.io/devcontainers/features/node:1"] = {} if options[:node]
+
+          @features.merge!(database.feature) if database.feature
+
+          @features
+        end
+
+        def mounts
+          return @mounts if @mounts
+
+          @mounts = []
+
+          @mounts << local_rails_mount if options[:dev]
+
+          @mounts
+        end
+
+        def forward_ports
+          return @forward_ports if @forward_ports
+
+          @forward_ports = [3000]
+          @forward_ports << database.port if database.port
+          @forward_ports << 6379 if options[:redis]
+
+          @forward_ports
+        end
+
+        def database
+          @database ||= Database.build(options[:database])
+        end
+
+        def devcontainer_db_service_yaml(**options)
+          return unless service = database.service
+
+          { database.name => service }.to_yaml(**options)[4..-1]
+        end
+
+        def local_rails_mount
+          {
+            type: "bind",
+            source: Rails::Generators::RAILS_DEV_PATH,
+            target: Rails::Generators::RAILS_DEV_PATH
+          }
+        end
+
+        def system_test_configuration
+          optimize_indentation(<<-'RUBY', 2).chomp
+            if ENV["CAPYBARA_SERVER_PORT"]
+              served_by host: "rails-app", port: ENV["CAPYBARA_SERVER_PORT"]
+
+              driven_by :selenium, using: :headless_chrome, screen_size: [ 1400, 1400 ], options: {
+                browser: :remote,
+                url: "http://#{ENV["SELENIUM_HOST"]}:4444"
+              }
+            else
+              driven_by :selenium, using: :headless_chrome, screen_size: [ 1400, 1400 ]
+            end
+          RUBY
+        end
+    end
+  end
+end

data/lib/rails/generators/rails/devcontainer/templates/devcontainer/Dockerfile.tt

@@ -0,0 +1,3 @@
+# Make sure RUBY_VERSION matches the Ruby version in .ruby-version
+ARG RUBY_VERSION=<%= gem_ruby_version %>
+FROM ghcr.io/rails/devcontainer/images/ruby:$RUBY_VERSION

data/lib/rails/generators/rails/devcontainer/templates/devcontainer/compose.yaml.tt

@@ -0,0 +1,47 @@
+name: "<%= options[:app_name] %>"
+
+services:
+  rails-app:
+    build:
+      context: ..
+      dockerfile: .devcontainer/Dockerfile
+
+    volumes:
+    - ../..:/workspaces:cached
+
+    # Overrides default command so things don't shut down after the process ends.
+    command: sleep infinity
+
+    # Uncomment the next line to use a non-root user for all processes.
+    # user: vscode
+
+    # Use "forwardPorts" in **devcontainer.json** to forward an app port locally.
+    # (Adding the "ports" property to this file will not forward from a Codespace.)
+<%- if !dependencies.empty? -%>
+    depends_on:
+<%- dependencies.each do |dependency| -%>
+    - <%= dependency %>
+<%- end -%>
+<%- end -%>
+<%- if options[:system_test] -%>
+
+  selenium:
+    image: selenium/standalone-chromium
+    restart: unless-stopped
+<%- end -%>
+
+<%- if options[:redis] -%>
+  redis:
+    image: redis:7.2
+    restart: unless-stopped
+    volumes:
+    - redis-data:/data
+
+<%- end -%>
+  <%= devcontainer_db_service_yaml(indentation: 4) %>
+<%- if !volumes.empty? -%>
+volumes:
+<%- volumes.each do |volume| -%>
+  <%= volume %>:
+<%- end -%>
+<%- end -%>

data/lib/rails/generators/rails/devcontainer/templates/devcontainer/devcontainer.json.tt

@@ -0,0 +1,37 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the
+// README at: https://github.com/devcontainers/templates/tree/main/src/ruby
+{
+  "name": "<%= options[:app_name] %>",
+  "dockerComposeFile": "compose.yaml",
+  "service": "rails-app",
+  "workspaceFolder": "/workspaces/${localWorkspaceFolderBasename}",
+
+  // Features to add to the dev container. More info: https://containers.dev/features.
+  "features": {
+    <%= features.map { |key, value| "\"#{key}\": #{value.as_json}" }.join(",\n    ") %>
+  },
+
+<%- if !container_env.empty? -%>
+  "containerEnv": {
+    <%= container_env.map { |key, value| "\"#{key}\": \"#{value}\"" }.join(",\n    ") %>
+  },
+<%- end -%>
+
+  // Use 'forwardPorts' to make a list of ports inside the container available locally.
+  "forwardPorts": <%= forward_ports.as_json %>,
+
+  // Configure tool-specific properties.
+  // "customizations": {},
+
+  // Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
+  // "remoteUser": "root",
+
+<%- if !mounts.empty? -%>
+  "mounts": [
+    <%= mounts.map { |mount| "{\n      " + mount.map { |key, value| "\"#{key}\": \"#{value}\"" }.join(",\n      ") + "\n    }" }.join(",\n    ") %>
+  ],
+<%- end -%>
+
+  // Use 'postCreateCommand' to run commands after the container is created.
+  "postCreateCommand": "bin/setup --skip-server"
+}

data/lib/rails/generators/rails/encrypted_file/encrypted_file_generator.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require "rails/generators/base"
+require "active_support/encrypted_file"
+
+module Rails
+  module Generators
+    class EncryptedFileGenerator < Base # :nodoc:
+      def add_encrypted_file_silently(file_path, key_path, template = encrypted_file_template)
+        unless File.exist?(file_path)
+          ActiveSupport::EncryptedFile.new(
+            content_path: file_path,
+            key_path: key_path,
+            env_key: "RAILS_MASTER_KEY",
+            raise_if_missing_key: true
+          ).write(template)
+        end
+      end
+
+      private
+        def encrypted_file_template
+          <<~YAML
+            # aws:
+            #   access_key_id: 123
+            #   secret_access_key: 345
+
+          YAML
+        end
+    end
+  end
+end

data/lib/rails/generators/rails/encryption_key_file/encryption_key_file_generator.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require "pathname"
+require "rails/generators/base"
+require "active_support/encrypted_file"
+
+module Rails
+  module Generators
+    class EncryptionKeyFileGenerator < Base # :nodoc:
+      def add_key_file(key_path)
+        key_path = Pathname.new(key_path)
+
+        unless key_path.exist?
+          key = ActiveSupport::EncryptedFile.generate_key
+
+          log "Adding #{key_path} to store the encryption key: #{key}"
+          log ""
+          log "Save this in a password manager your team can access."
+          log ""
+          log "If you lose the key, no one, including you, can access anything encrypted with it."
+
+          log ""
+          add_key_file_silently(key_path, key)
+          log ""
+        end
+      end
+
+      def add_key_file_silently(key_path, key = nil)
+        create_file key_path, key || ActiveSupport::EncryptedFile.generate_key, perm: 0600
+      end
+
+      def ignore_key_file(key_path, ignore: key_ignore(key_path))
+        if File.exist?(".gitignore")
+          unless File.read(".gitignore").include?(ignore)
+            log "Ignoring #{key_path} so it won't end up in Git history:"
+            log ""
+            append_to_file ".gitignore", ignore
+            log ""
+          end
+        else
+          log "IMPORTANT: Don't commit #{key_path}. Add this to your ignore file:"
+          log ignore, :on_green
+          log ""
+        end
+      end
+
+      def ignore_key_file_silently(key_path, ignore: key_ignore(key_path))
+        append_to_file ".gitignore", ignore if File.exist?(".gitignore")
+      end
+
+      private
+        def key_ignore(key_path)
+          [ "", "/#{key_path}", "" ].join("\n")
+        end
+    end
+  end
+end

data/lib/rails/generators/rails/generator/USAGE

@@ -0,0 +1,13 @@
+Description:
+    Generates a new generator at lib/generators. Pass the generator name as an argument,
+    either CamelCased or snake_cased.
+
+Example:
+    `bin/rails generate generator Awesome`
+
+    creates a standard awesome generator:
+        lib/generators/awesome/
+        lib/generators/awesome/awesome_generator.rb
+        lib/generators/awesome/USAGE
+        lib/generators/awesome/templates/
+        test/lib/generators/awesome_generator_test.rb

data/lib/rails/generators/rails/generator/generator_generator.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Rails
+  module Generators
+    class GeneratorGenerator < NamedBase # :nodoc:
+      check_class_collision suffix: "Generator"
+
+      class_option :namespace, type: :boolean, default: true,
+                               desc: "Namespace generator under lib/generators/name"
+
+      def create_generator_files
+        directory ".", generator_dir
+      end
+
+      hook_for :test_framework
+
+      private
+        def generator_dir
+          if options[:namespace]
+            File.join("lib", "generators", regular_class_path, file_name)
+          else
+            File.join("lib", "generators", regular_class_path)
+          end
+        end
+    end
+  end
+end

data/lib/rails/generators/rails/generator/templates/%file_name%_generator.rb.tt

@@ -0,0 +1,3 @@
+class <%= class_name %>Generator < Rails::Generators::NamedBase
+  source_root File.expand_path("templates", __dir__)
+end

data/lib/rails/generators/rails/generator/templates/USAGE.tt

@@ -0,0 +1,8 @@
+Description:
+    Explain the generator
+
+Example:
+    bin/rails generate <%= file_name %> Thing
+
+    This will create:
+        what/will/it/create