omg-railties 8.0.0.alpha3

data/lib/rails/command/behavior.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+require "active_support"
+
+module Rails
+  module Command
+    module Behavior # :nodoc:
+      extend ActiveSupport::Concern
+
+      class_methods do
+        # Remove the color from output.
+        def no_color!
+          Thor::Base.shell = Thor::Shell::Basic
+        end
+
+        # Track all command subclasses.
+        def subclasses
+          @subclasses ||= []
+        end
+
+        private
+          # Prints a list of generators.
+          def print_list(base, namespaces)
+            return if namespaces.empty?
+            puts "#{base.camelize}:"
+
+            namespaces.each do |namespace|
+              puts("  #{namespace}")
+            end
+
+            puts
+          end
+
+          # Receives namespaces in an array and tries to find matching generators
+          # in the load path.
+          def lookup(namespaces)
+            paths = namespaces_to_paths(namespaces)
+
+            paths.each do |raw_path|
+              lookup_paths.each do |base|
+                path = "#{base}/#{raw_path}_#{command_type}"
+
+                begin
+                  require path
+                  return
+                rescue LoadError => e
+                  raise unless /#{Regexp.escape(path)}$/.match?(e.message)
+                rescue Exception => e
+                  warn "[WARNING] Could not load #{command_type} #{path.inspect}. Error: #{e.message}.\n#{e.backtrace.join("\n")}"
+                end
+              end
+            end
+          end
+
+          # This will try to load any command in the load path to show in help.
+          def lookup!
+            $LOAD_PATH.each do |base|
+              Dir[File.join(base, *file_lookup_paths)].each do |path|
+                path = path.delete_prefix("#{base}/")
+                require path
+              rescue Exception
+                # No problem
+              end
+            end
+          end
+
+          # Convert namespaces to paths by replacing ":" for "/" and adding
+          # an extra lookup. For example, "rails:model" should be searched
+          # in both: "rails/model/model_generator" and "rails/model_generator".
+          def namespaces_to_paths(namespaces)
+            paths = []
+            namespaces.each do |namespace|
+              pieces = namespace.split(":")
+              path = pieces.join("/")
+              paths << "#{path}/#{pieces.last}"
+              paths << path
+            end
+            paths.uniq!
+            paths
+          end
+      end
+    end
+  end
+end

data/lib/rails/command/environment_argument.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require "active_support"
+require "active_support/core_ext/class/attribute"
+
+module Rails
+  module Command
+    module EnvironmentArgument # :nodoc:
+      extend ActiveSupport::Concern
+
+      included do
+        class_option :environment, aliases: "-e", type: :string,
+          desc: "The environment to run `#{self.command_name}` in (e.g. test / development / production)."
+      end
+
+      def initialize(...)
+        super
+
+        @environment_specified = options[:environment].present?
+
+        if !@environment_specified
+          self.options = options.merge(environment: Rails::Command.environment)
+        elsif !available_environments.include?(options[:environment])
+          self.options = options.merge(environment: expand_environment_name(options[:environment]))
+        end
+      end
+
+      private
+        def require_application!
+          ENV["RAILS_ENV"] = environment
+          super
+        end
+
+        def environment
+          @environment ||= options[:environment]
+        end
+
+        def environment=(environment)
+          @environment = environment
+        end
+
+        def environment_specified?
+          @environment_specified
+        end
+
+        def available_environments
+          @available_environments ||=
+            Dir["config/environments/*.rb"].map { |filename| File.basename(filename, ".*") }
+        end
+
+        def expand_environment_name(name)
+          %w[production development test].find { |full_name| full_name.start_with?(name) } || name
+        end
+    end
+  end
+end

data/lib/rails/command/helpers/editor.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require "shellwords"
+require "active_support/encrypted_file"
+
+module Rails
+  module Command
+    module Helpers
+      module Editor
+        private
+          def editor
+            ENV["VISUAL"].to_s.empty? ? ENV["EDITOR"] : ENV["VISUAL"]
+          end
+
+          def display_hint_if_system_editor_not_specified
+            if editor.to_s.empty?
+              say "No $VISUAL or $EDITOR to open file in. Assign one like this:"
+              say ""
+              say %(VISUAL="code --wait" #{executable(current_subcommand)})
+              say ""
+              say "For editors that fork and exit immediately, it's important to pass a wait flag;"
+              say "otherwise, the file will be saved immediately with no chance to edit."
+
+              true
+            end
+          end
+
+          def system_editor(file_path)
+            system(*Shellwords.split(editor), file_path.to_s)
+          end
+
+          def using_system_editor
+            display_hint_if_system_editor_not_specified || yield
+          rescue Interrupt
+            say "Aborted changing file: nothing saved."
+          end
+      end
+    end
+  end
+end

data/lib/rails/command.rb

@@ -0,0 +1,172 @@
+# frozen_string_literal: true
+
+require "active_support"
+require "active_support/core_ext/enumerable"
+require "active_support/core_ext/object/blank"
+require "rails/deprecator"
+
+require "thor"
+
+module Rails
+  module Command
+    extend ActiveSupport::Autoload
+
+    autoload :Behavior
+    autoload :Base
+
+    class CorrectableNameError < StandardError # :nodoc:
+      attr_reader :name
+
+      def initialize(message, name, alternatives)
+        @name = name
+        @alternatives = alternatives
+        super(message)
+      end
+
+      if !Exception.method_defined?(:detailed_message) # Ruby 3.2+
+        def detailed_message(...)
+          message
+        end
+      end
+
+      if defined?(DidYouMean::Correctable) && defined?(DidYouMean::SpellChecker)
+        include DidYouMean::Correctable
+
+        def corrections
+          @corrections ||= DidYouMean::SpellChecker.new(dictionary: @alternatives).correct(name)
+        end
+      end
+    end
+
+    class UnrecognizedCommandError < CorrectableNameError # :nodoc:
+      def initialize(name)
+        super("Unrecognized command #{name.inspect}", name, Command.printing_commands.map(&:first))
+      end
+    end
+
+    include Behavior
+
+    HELP_MAPPINGS = %w(-h -? --help).to_set
+    VERSION_MAPPINGS = %w(-v --version).to_set
+
+    class << self
+      def hidden_commands # :nodoc:
+        @hidden_commands ||= []
+      end
+
+      def environment # :nodoc:
+        ENV["RAILS_ENV"].presence || ENV["RACK_ENV"].presence || "development"
+      end
+
+      # Receives a namespace, arguments, and the behavior to invoke the command.
+      def invoke(full_namespace, args = [], **config)
+        args = ["--help"] if rails_new_with_no_path?(args)
+
+        full_namespace = full_namespace.to_s
+        namespace, command_name = split_namespace(full_namespace)
+        command = find_by_namespace(namespace, command_name)
+
+        with_argv(args) do
+          if command && command.all_commands[command_name]
+            command.perform(command_name, args, config)
+          else
+            invoke_rake(full_namespace, args, config)
+          end
+        end
+      rescue UnrecognizedCommandError => error
+        if error.name == full_namespace && command && command_name == full_namespace
+          command.perform("help", [], config)
+        else
+          puts error.detailed_message
+        end
+        exit(1)
+      end
+
+      # Rails finds namespaces similar to Thor, it only adds one rule:
+      #
+      # Command names must end with "_command.rb". This is required because Rails
+      # looks in load paths and loads the command just before it's going to be used.
+      #
+      #   find_by_namespace :webrat, :integration
+      #
+      # Will search for the following commands:
+      #
+      #   "webrat", "webrat:integration", "rails:webrat", "rails:webrat:integration"
+      #
+      def find_by_namespace(namespace, command_name = nil) # :nodoc:
+        lookups = [ namespace ]
+        lookups << "#{namespace}:#{command_name}" if command_name
+        lookups.concat lookups.map { |lookup| "rails:#{lookup}" }
+
+        lookup(lookups)
+
+        namespaces = subclasses.index_by(&:namespace)
+        namespaces[(lookups & namespaces.keys).first]
+      end
+
+      # Returns the root of the \Rails engine or app running the command.
+      def root
+        if defined?(ENGINE_ROOT)
+          Pathname.new(ENGINE_ROOT)
+        else
+          application_root
+        end
+      end
+
+      def application_root # :nodoc:
+        Pathname.new(File.expand_path("../..", APP_PATH)) if defined?(APP_PATH)
+      end
+
+      def printing_commands # :nodoc:
+        lookup!
+
+        (subclasses - hidden_commands).flat_map(&:printing_commands)
+      end
+
+      private
+        def rails_new_with_no_path?(args)
+          args == ["new"]
+        end
+
+        def split_namespace(namespace)
+          case namespace
+          when /^(.+):(\w+)$/
+            [$1, $2]
+          when ""
+            ["help", "help"]
+          when HELP_MAPPINGS, "help"
+            ["help", "help_extended"]
+          when VERSION_MAPPINGS
+            ["version", "version"]
+          else
+            [namespace, namespace]
+          end
+        end
+
+        def with_argv(argv)
+          original_argv = ARGV.dup
+          ARGV.replace(argv)
+          yield
+        ensure
+          ARGV.replace(original_argv)
+        end
+
+        def invoke_rake(task, args, config)
+          args = ["--describe", task] if HELP_MAPPINGS.include?(args[0])
+          find_by_namespace("rake").perform(task, args, config)
+        end
+
+        def command_type # :doc:
+          @command_type ||= "command"
+        end
+
+        def lookup_paths # :doc:
+          @lookup_paths ||= %w( rails/commands commands )
+        end
+
+        def file_lookup_paths # :doc:
+          @file_lookup_paths ||= [ "{#{lookup_paths.join(',')}}", "**", "*_command.rb" ]
+        end
+    end
+  end
+end

data/lib/rails/commands/about/about_command.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Rails
+  module Command
+    class AboutCommand < Base # :nodoc:
+      desc "about", "List versions of all Rails frameworks and the environment"
+      def perform
+        boot_application!
+
+        say Rails::Info
+      end
+    end
+  end
+end

data/lib/rails/commands/app/update_command.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+require "rails/generators/rails/app/app_generator"
+
+module Rails
+  module Command
+    module App
+      class UpdateCommand < Base # :nodoc:
+        include Thor::Actions
+        add_runtime_options!
+
+        desc "update", "Update configs and some other initially generated files (or use just update:configs or update:bin)"
+        def perform
+          configs
+          bin
+          public_directory
+          active_storage
+          display_upgrade_guide_info
+        end
+
+        desc "configs", "Update config files in the application config/ directory", hide: true
+        def configs
+          require_application!
+          app_generator.create_boot_file
+          app_generator.update_config_files
+        end
+
+        desc "bin", "Add or update executables in the application bin/ directory", hide: true
+        def bin
+          require_application!
+          app_generator.update_bin_files
+        end
+
+        desc "public_directory", "Add or update files in the application public/ directory", hide: true
+        def public_directory
+          require_application!
+          app_generator.create_public_files
+        end
+
+        desc "active_storage", "Run the active_storage:update command", hide: true
+        def active_storage
+          require_application!
+          app_generator.update_active_storage
+        end
+
+        private
+          def display_upgrade_guide_info
+            say "\nAfter this, check Rails upgrade guide at https://guides.rubyonrails.org/upgrading_ruby_on_rails.html for more details about upgrading your app."
+          end
+
+          def app_generator
+            @app_generator ||= begin
+              gen = Rails::Generators::AppGenerator.new(["rails"], generator_options, destination_root: Rails.root)
+              gen.send(:valid_const?) unless File.exist?(Rails.root.join("config", "application.rb"))
+              gen
+            end
+          end
+
+          def generator_options
+            {
+              api:                 !!Rails.application.config.api_only,
+              update:              true,
+              name:                Rails.application.class.name.chomp("::Application").underscore,
+              skip_active_job:     !defined?(ActiveJob::Railtie),
+              skip_active_record:  !defined?(ActiveRecord::Railtie),
+              skip_active_storage: !defined?(ActiveStorage::Engine),
+              skip_action_mailer:  !defined?(ActionMailer::Railtie),
+              skip_action_mailbox: !defined?(ActionMailbox::Engine),
+              skip_action_text:    !defined?(ActionText::Engine),
+              skip_action_cable:   !defined?(ActionCable::Engine),
+              skip_brakeman:       skip_gem?("brakeman"),
+              skip_rubocop:        skip_gem?("rubocop"),
+              skip_test:           !defined?(Rails::TestUnitRailtie),
+              skip_system_test:    Rails.application.config.generators.system_tests.nil?,
+              skip_asset_pipeline: asset_pipeline.nil?,
+              skip_bootsnap:       !defined?(Bootsnap),
+            }.merge(options)
+          end
+
+          def asset_pipeline
+            "propshaft" if defined?(Propshaft::Railtie)
+          end
+
+          def skip_gem?(gem_name)
+            gem gem_name
+            false
+          rescue LoadError
+            true
+          end
+      end
+    end
+  end
+end

data/lib/rails/commands/application/application_command.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+require "rails/generators/rails/app/app_generator"
+
+module Rails
+  module Generators
+    class AppGenerator # :nodoc:
+      # We want to exit on failure to be kind to other libraries
+      # This is only when accessing via CLI
+      def self.exit_on_failure?
+        true
+      end
+    end
+  end
+
+  module Command
+    class ApplicationCommand < Base # :nodoc:
+      hide_command!
+
+      self.bin = "rails"
+
+      def help
+        perform # Punt help output to the generator.
+      end
+
+      def perform(*args)
+        Rails::Generators::AppGenerator.start \
+          Rails::Generators::ARGVScrubber.new(args).prepare!
+      end
+    end
+  end
+end

data/lib/rails/commands/boot/boot_command.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "rails/command/environment_argument"
+
+module Rails
+  module Command
+    class BootCommand < Base # :nodoc:
+      include EnvironmentArgument
+
+      desc "boot", "Boot the application and exit"
+      def perform(*) = boot_application!
+    end
+  end
+end

data/lib/rails/commands/console/console_command.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+require "rails/command/environment_argument"
+
+module Rails
+  class Console
+    def self.start(*args)
+      new(*args).start
+    end
+
+    attr_reader :options, :app, :console
+
+    def initialize(app, options = {})
+      @app     = app
+      @options = options
+
+      app.sandbox = sandbox?
+
+      if sandbox? && app.config.disable_sandbox
+        puts "Error: Unable to start console in sandbox mode as sandbox mode is disabled (config.disable_sandbox is true)."
+        exit 1
+      end
+
+      app.load_console
+
+      @console = app.config.console || begin
+        require "rails/commands/console/irb_console"
+        IRBConsole.new(app)
+      end
+    end
+
+    def sandbox?
+      return options[:sandbox] if !options[:sandbox].nil?
+
+      return false if Rails.env.local?
+
+      app.config.sandbox_by_default
+    end
+
+    def environment
+      options[:environment]
+    end
+    alias_method :environment?, :environment
+
+    def set_environment!
+      Rails.env = environment
+    end
+
+    def start
+      set_environment! if environment?
+
+      if sandbox?
+        puts "Loading #{Rails.env} environment in sandbox (Rails #{Rails.version})"
+        puts "Any modifications you make will be rolled back on exit"
+      else
+        puts "Loading #{Rails.env} environment (Rails #{Rails.version})"
+      end
+
+      console.start
+    end
+  end
+
+  module Command
+    class ConsoleCommand < Base # :nodoc:
+      include EnvironmentArgument
+
+      class_option :sandbox, aliases: "-s", type: :boolean, default: nil,
+        desc: "Rollback database modifications on exit."
+
+      def initialize(args = [], local_options = {}, config = {})
+        console_options = []
+
+        # For the same behavior as OptionParser, leave only options after "--" in ARGV.
+        termination = local_options.find_index("--")
+        if termination
+          console_options = local_options[termination + 1..-1]
+          local_options = local_options[0...termination]
+        end
+
+        ARGV.replace(console_options)
+        super(args, local_options, config)
+      end
+
+      desc "console", "Start the Rails console"
+      def perform
+        boot_application!
+        Rails::Console.start(Rails.application, options)
+      end
+    end
+  end
+end