railties 7.1.5.1 → 7.2.2.1

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

@@ -1,15 +1,19 @@
 # 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 Database
           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."
 
@@ -21,8 +25,8 @@ module Rails
           def initialize(*)
             super
 
-            unless DATABASES.include?(options[:to])
-              raise Error, "Invalid value for --to option. Supported preconfigurations are: #{DATABASES.join(", ")}."
+            unless Database::DATABASES.include?(options[:to])
+              raise Error, "Invalid value for --to option. Supported preconfigurations are: #{Database::DATABASES.join(", ")}."
             end
 
             opt = options.dup
@@ -35,7 +39,7 @@ module Rails
           end
 
           def edit_gemfile
-            name, version = gem_for_database
+            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
@@ -44,27 +48,44 @@ module Rails
             dockerfile_path = File.expand_path("Dockerfile", destination_root)
             return unless File.exist?(dockerfile_path)
 
-            build_name = docker_for_database_build
-            deploy_name = docker_for_database_deploy
-            if build_name
-              gsub_file("Dockerfile", all_docker_builds_regex, build_name)
-            end
-            if deploy_name
-              gsub_file("Dockerfile", all_docker_deploys_regex, deploy_name)
-            end
+            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
-              DATABASES.map { |database| gem_for_database(database) }
+              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
-              DATABASES.map { |database| docker_for_database_build(database).nil? ? nil : docker_for_database_build(database) }.compact!
+              Database.all.map { |database| docker_build_packages(database.build_package) }.uniq
             end
 
-            def all_docker_deploys
-              DATABASES.map { |database| docker_for_database_deploy(database).nil? ? nil : docker_for_database_deploy(database) }.compact!
+            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
@@ -72,12 +93,12 @@ module Rails
               /(\b#{all_database_gem_names.join('\b|\b')}\b)/
             end
 
-            def all_docker_builds_regex
-              /(\b#{all_docker_builds.join('\b|\b')}\b)/
+            def all_docker_bases_regex
+              /(\b#{all_docker_bases.join('\b|\b')}\b)/
             end
 
-            def all_docker_deploys_regex
-              /(\b#{all_docker_deploys.join('\b|\b')}\b)/
+            def all_docker_builds_regex
+              /(\b#{all_docker_builds.join('\b|\b')}\b)/
             end
 
             def gem_entry_regex_for(gem_name)
@@ -88,6 +109,96 @@ module Rails
               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

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

@@ -0,0 +1,166 @@
+# 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]
+        return unless File.exist?("test/application_system_test_case.rb")
+
+        gsub_file("test/application_system_test_case.rb", /^\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"
+}

data/lib/rails/generators/rails/migration/migration_generator.rb

@@ -5,6 +5,10 @@ module Rails
     class MigrationGenerator < NamedBase # :nodoc:
       argument :attributes, type: :array, default: [], banner: "field[:type][:index] field[:type][:index]"
       hook_for :orm, required: true, desc: "ORM to be invoked"
+
+      def self.exit_on_failure? # :nodoc:
+        true
+      end
     end
   end
 end

data/lib/rails/generators/rails/plugin/plugin_generator.rb

@@ -66,6 +66,16 @@ module Rails
       template "gitignore", ".gitignore"
     end
 
+    def cifiles
+      empty_directory ".github/workflows"
+      template "github/ci.yml", ".github/workflows/ci.yml"
+      template "github/dependabot.yml", ".github/dependabot.yml"
+    end
+
+    def rubocop
+      template "rubocop.yml", ".rubocop.yml"
+    end
+
     def version_control
       if !options[:skip_git] && !options[:pretend]
         run git_init_command, capture: options[:quiet], abort_on_failure: false
@@ -112,9 +122,12 @@ module Rails
     def generate_test_dummy(force = false)
       opts = options.transform_keys(&:to_sym).except(*DUMMY_IGNORE_OPTIONS)
       opts[:force] = force
+      opts[:skip_brakeman] = true
       opts[:skip_bundle] = true
+      opts[:skip_ci] = true
       opts[:skip_git] = true
       opts[:skip_hotwire] = true
+      opts[:skip_rubocop] = true
       opts[:dummy_app] = true
 
       invoke Rails::Generators::AppGenerator,
@@ -144,7 +157,7 @@ module Rails
     def test_dummy_clean
       inside dummy_path do
         remove_file ".ruby-version"
-        remove_file "db/seeds.rb"
+        remove_dir "db"
         remove_file "Gemfile"
         remove_file "lib/tasks"
         remove_file "public/robots.txt"
@@ -167,12 +180,12 @@ module Rails
       end
     end
 
-    def bin(force = false)
-      bin_file = engine? ? "bin/rails.tt" : "bin/test.tt"
-      template bin_file, force: force do |content|
+    def bin
+      exclude_pattern = Regexp.union([(engine? ? /test\.tt/ : /rails\.tt/), (/rubocop/ if skip_rubocop?)].compact)
+      directory "bin", { exclude_pattern: exclude_pattern } do |content|
         "#{shebang}\n" + content
       end
-      chmod "bin", 0755, verbose: false
+      chmod "bin", 0755 & ~File.umask, verbose: false
     end
 
     def gemfile_entry
@@ -180,7 +193,7 @@ module Rails
 
       gemfile_in_app_path = File.join(rails_app_path, "Gemfile")
       if File.exist? gemfile_in_app_path
-        entry = "\ngem '#{name}', path: '#{relative_path}'"
+        entry = %{\ngem "#{name}", path: "#{relative_path}"}
         append_file gemfile_in_app_path, entry
       end
     end
@@ -243,6 +256,16 @@ module Rails
         build(:app)
       end
 
+      def create_rubocop_file
+        return if skip_rubocop?
+        build(:rubocop)
+      end
+
+      def create_cifiles
+        return if skip_ci?
+        build(:cifiles)
+      end
+
       def create_config_files
         build(:config)
       end
@@ -341,7 +364,7 @@ module Rails
           build(:test_dummy_sprocket_assets) unless skip_sprockets?
           build(:test_dummy_clean)
           # ensure that bin/rails has proper dummy_path
-          build(:bin, true)
+          build(:bin)
         end
       end
 
@@ -465,6 +488,16 @@ module Rails
         return unless inside_application?
         app_path.delete_prefix("#{rails_app_path}/")
       end
+
+      def test_command
+        if engine? && !options[:skip_active_record] && with_dummy_app?
+          "bin/rails db:test:prepare test"
+        elsif engine?
+          "bin/rails test"
+        else
+          "bin/test"
+        end
+      end
     end
   end
 end

data/lib/rails/generators/rails/plugin/templates/%name%.gemspec.tt

@@ -3,8 +3,8 @@ require_relative "lib/<%= namespaced_name %>/version"
 Gem::Specification.new do |spec|
   spec.name        = <%= name.inspect %>
   spec.version     = <%= camelized_modules %>::VERSION
-  spec.authors     = [<%= author.inspect %>]
-  spec.email       = [<%= email.inspect %>]
+  spec.authors     = [ <%= author.inspect %> ]
+  spec.email       = [ <%= email.inspect %> ]
   spec.homepage    = "TODO"
   spec.summary     = "TODO: Summary of <%= camelized_modules %>."
   spec.description = "TODO: Description of <%= camelized_modules %>."

data/lib/rails/generators/rails/plugin/templates/Gemfile.tt

@@ -1,5 +1,4 @@
 source "https://rubygems.org"
-git_source(:github) { |repo| "https://github.com/#{repo}.git" }
 <% unless options[:skip_gemspec] -%>
 
 # Specify your gem's dependencies in <%= name %>.gemspec.
@@ -8,6 +7,11 @@ gemspec
 <% gemfile_entries.each do |gemfile_entry| %>
 <%= gemfile_entry %>
 <% end -%>
+<%- unless options.skip_rubocop? -%>
+
+# Omakase Ruby styling [https://github.com/rails/rubocop-rails-omakase/]
+gem "rubocop-rails-omakase", require: false
+<%- end -%>
 <% if RUBY_ENGINE == "ruby" -%>
 
 # Start debugger with binding.b [https://github.com/ruby/debug]

data/lib/rails/generators/rails/plugin/templates/app/views/layouts/%namespaced_name%/application.html.erb.tt

@@ -5,6 +5,8 @@
   <%%= csrf_meta_tags %>
   <%%= csp_meta_tag %>
 
+  <%%= yield :head %>
+
   <%%= stylesheet_link_tag    "<%= namespaced_name %>/application", media: "all" %>
 </head>
 <body>

data/lib/rails/generators/rails/plugin/templates/bin/rubocop.tt

@@ -0,0 +1,7 @@
+require "rubygems"
+require "bundler/setup"
+
+# explicit rubocop config increases performance slightly while avoiding config confusion.
+ARGV.unshift("--config", File.expand_path("../.rubocop.yml", __dir__))
+
+load Gem.bin_path("rubocop", "rubocop")