From 20f2a40c4102d380ef59cfd0e695e1519225f079 Mon Sep 17 00:00:00 2001 From: Stan Lo Date: Sat, 22 Jul 2023 16:24:37 +0100 Subject: [PATCH] Deprecate multi-irb commands - Print deprecated message when any of the commands are used - Put related commands under `Multi-irb` category with a deprecated label --- lib/irb/cmd/subirb.rb | 19 +++++++++++++++---- 1 file changed, 15 insertions(+), 4 deletions(-) diff --git a/lib/irb/cmd/subirb.rb b/lib/irb/cmd/subirb.rb index 5f3e02c98..3018ab277 100644 --- a/lib/irb/cmd/subirb.rb +++ b/lib/irb/cmd/subirb.rb @@ -18,6 +18,13 @@ def initialize(conf) private + def print_deprecated_warning + warn <<~MSG + Multi-irb commands are deprecated and will be removed in IRB 2.0.0. Please use workspace commands instead. + If you have any use case for multi-irb, please leave a comment at https://github.com/ruby/irb/issues/653 + MSG + end + def extend_irb_context # this extension patches IRB context like IRB.CurrentContext require_relative "../ext/multi-irb" @@ -25,38 +32,42 @@ def extend_irb_context end class IrbCommand < MultiIRBCommand - category "IRB" + category "Multi-irb (DEPRECATED)" description "Start a child IRB." def execute(*obj) + print_deprecated_warning IRB.irb(nil, *obj) end end class Jobs < MultiIRBCommand - category "IRB" + category "Multi-irb (DEPRECATED)" description "List of current sessions." def execute + print_deprecated_warning IRB.JobManager end end class Foreground < MultiIRBCommand - category "IRB" + category "Multi-irb (DEPRECATED)" description "Switches to the session of the given number." def execute(key = nil) + print_deprecated_warning raise CommandArgumentError.new("Please specify the id of target IRB job (listed in the `jobs` command).") unless key IRB.JobManager.switch(key) end end class Kill < MultiIRBCommand - category "IRB" + category "Multi-irb (DEPRECATED)" description "Kills the session with the given number." def execute(*keys) + print_deprecated_warning IRB.JobManager.kill(*keys) end end