Skip to content

Commit

Permalink
Update show_cmds's output when in irb:rdbg session
Browse files Browse the repository at this point in the history
  • Loading branch information
st0012 committed Aug 23, 2023
1 parent 8e52da5 commit f07eb5f
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 0 deletions.
15 changes: 15 additions & 0 deletions lib/irb/cmd/show_cmds.rb
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,16 @@ class ShowCmds < Nop
def execute(*args)
commands_info = IRB::ExtendCommandBundle.all_commands_info
commands_grouped_by_categories = commands_info.group_by { |cmd| cmd[:category] }

if irb_context.with_debugger
# Remove the original "Debugging" category
commands_grouped_by_categories.delete("Debugging")
# Remove the `help` command as it's delegated to the debugger
commands_grouped_by_categories["Context"].delete_if { |cmd| cmd[:display_name] == :help }
# Add an empty "Debugging (from debug.gem)" category at the end
commands_grouped_by_categories["Debugging (from debug.gem)"] = []
end

longest_cmd_name_length = commands_info.map { |c| c[:display_name].length }.max

output = StringIO.new
Expand All @@ -29,6 +39,11 @@ def execute(*args)
output.puts
end

# Append the debugger help at the end
if irb_context.with_debugger
output.puts DEBUGGER__.help
end

Pager.page_content(output.string)
end
end
Expand Down
19 changes: 19 additions & 0 deletions test/irb/test_debug_cmd.rb
Original file line number Diff line number Diff line change
Expand Up @@ -345,6 +345,25 @@ def test_help_command_is_delegated_to_the_debugger
assert_include(output, "### Frame control")
end

def test_show_cmds_display_different_content_when_debugger_is_enabled
write_ruby <<~'ruby'
# disable pager
STDIN.singleton_class.define_method(:tty?) { false }
binding.irb
ruby

output = run_ruby_file do
type "debug"
type "show_cmds"
type "continue"
end

# IRB's commands should still be listed
assert_match(/show_cmds\s+List all available commands and their description\./, output)
# debug gem's commands should be appended at the end
assert_match(/Debugging \(from debug\.gem\)\s+### Control flow/, output)
end

def test_input_is_evaluated_in_the_context_of_the_current_thread
write_ruby <<~'ruby'
current_thread = Thread.current
Expand Down

0 comments on commit f07eb5f

Please sign in to comment.