1
0
Fork 0
mirror of https://github.com/pry/pry.git synced 2022-11-09 12:35:05 -05:00
pry--pry/lib/pry/command_base.rb

83 lines
2.5 KiB
Ruby
Raw Normal View History

class Pry
# Basic command functionality. All user-defined commands must
# inherit from this class. It provides the `command` method.
class CommandBase
class << self
attr_accessor :commands
attr_accessor :command_info
attr_accessor :opts
# private because we want to force function style invocation. We require
# that the location where the block is defined has the `opts`
# method in scope.
private
# Defines a new Pry command.
# @param [String, Array] name The name of the command (or array of
# command name aliases).
2011-01-17 22:40:28 -05:00
# @param [String] description A description of the command.
# @yield The action to perform. The parameters in the block
# determines the parameters the command will receive. All
# parameters passed into the block will be strings. Successive
# command parameters are separated by whitespace at the Pry prompt.
# @example
# class MyCommands < Pry::CommandBase
# command "greet", "Greet somebody" do |name|
# puts "Good afternoon #{name.capitalize}!"
# end
# end
#
# # From pry:
# # pry(main)> _pry_.commands = MyCommands
# # pry(main)> greet john
# # Good afternoon John!
# # pry(main)> help greet
# # Greet somebody
def command(name, description="No description.", &block)
@commands ||= {}
@command_info ||= {}
arg_match = '(?:\s+(\S+))?' * 20
if name.is_a?(Array)
matcher = []
name.each do |n|
2011-01-17 22:40:28 -05:00
matcher << /^#{n}(?!\S)#{arg_match}?/
end
else
2011-01-17 22:40:28 -05:00
matcher = /^#{name}(?!\S)#{arg_match}?/
end
commands[matcher] = block
command_info[name] = description
end
end
command "help", "This menu." do |cmd|
out = opts[:output]
command_info = opts[:command_info]
param = cmd
if !param
out.puts "Command list:"
out.puts "--"
command_info.each do |k, v|
out.puts "#{Array(k).first}".ljust(18) + v
end
else
key = command_info.keys.find { |v| Array(v).any? { |k| k === param } }
if key
out.puts command_info[key]
else
out.puts "No info for command: #{param}"
end
end
end
2011-01-17 22:40:28 -05:00
# Ensures that commands can be inherited
def self.inherited(klass)
klass.commands = commands.dup
klass.command_info = command_info.dup
end
end
end