/usr/lib/ruby/vendor_ruby/pry/commands/help.rb is in pry 0.10.3-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 | class Pry
class Command::Help < Pry::ClassCommand
match 'help'
group 'Help'
description 'Show a list of commands or information about a specific command.'
banner <<-'BANNER'
Usage: help [COMMAND]
With no arguments, help lists all the available commands along with their
descriptions. When given a command name as an argument, shows the help
for that command.
BANNER
# We only want to show commands that have descriptions, so that the
# easter eggs don't show up.
def visible_commands
visible = {}
commands.each do |key, command|
visible[key] = command if command.description && !command.description.empty?
end
visible
end
# Get a hash of available commands grouped by the "group" name.
def command_groups
visible_commands.values.group_by(&:group)
end
def process
if args.empty?
display_index(command_groups)
else
display_search(args.first)
end
end
# Display the index view, with headings and short descriptions per command.
#
# @param [Hash<String, Array<Commands>>] groups
def display_index(groups)
help_text = []
sorted_group_names(groups).each do |group_name|
commands = sorted_commands(groups[group_name])
if commands.any?
help_text << help_text_for_commands(group_name, commands)
end
end
_pry_.pager.page help_text.join("\n\n")
end
# Given a group name and an array of commands,
# return the help string for those commands.
#
# @param [String] name The group name.
# @param [Array<Pry::Command>] commands
# @return [String] The generated help string.
def help_text_for_commands(name, commands)
"#{text.bold(name.capitalize)}\n" << commands.map do |command|
" #{command.options[:listing].to_s.ljust(18)} #{command.description.capitalize}"
end.join("\n")
end
# @param [Hash] groups
# @return [Array<String>] An array of sorted group names.
def sorted_group_names(groups)
groups.keys.sort_by(&method(:group_sort_key))
end
# Sort an array of commands by their `listing` name.
#
# @param [Array<Pry::Command>] commands The commands to sort
# @return [Array<Pry::Command>] commands sorted by listing name.
def sorted_commands(commands)
commands.sort_by{ |command| command.options[:listing].to_s }
end
# Display help for an individual command or group.
#
# @param [String] search The string to search for.
def display_search(search)
if command = command_set.find_command_for_help(search)
display_command(command)
else
display_filtered_search_results(search)
end
end
# Display help for a searched item, filtered first by group
# and if that fails, filtered by command name.
#
# @param [String] search The string to search for.
def display_filtered_search_results(search)
groups = search_hash(search, command_groups)
if groups.size > 0
display_index(groups)
else
display_filtered_commands(search)
end
end
# Display help for a searched item, filtered by group
#
# @param [String] search The string to search for.
def display_filtered_commands(search)
filtered = search_hash(search, visible_commands)
raise CommandError, "No help found for '#{args.first}'" if filtered.empty?
if filtered.size == 1
display_command(filtered.values.first)
else
display_index({"'#{search}' commands" => filtered.values})
end
end
# Display help for an individual command.
#
# @param [Pry::Command] command
def display_command(command)
_pry_.pager.page command.new.help
end
# Find a subset of a hash that matches the user's search term.
#
# If there's an exact match a Hash of one element will be returned,
# otherwise a sub-Hash with every key that matches the search will
# be returned.
#
# @param [String] search the search term
# @param [Hash] hash the hash to search
def search_hash(search, hash)
matching = {}
hash.each_pair do |key, value|
next unless key.is_a?(String)
if normalize(key) == normalize(search)
return {key => value}
elsif normalize(key).start_with?(normalize(search))
matching[key] = value
end
end
matching
end
# Clean search terms to make it easier to search group names
#
# @param [String] key
# @return [String]
def normalize(key)
key.downcase.gsub(/pry\W+/, '')
end
def group_sort_key(group_name)
[%w(Help Context Editing Introspection Input_and_output Navigating_pry Gems Basic Commands).index(group_name.gsub(' ', '_')) || 99, group_name]
end
end
Pry::Commands.add_command(Pry::Command::Help)
end
|