2011-02-19 05:21:13 +00:00
|
|
|
# (C) John Mair (banisterfiend) 2011
|
2010-12-08 13:49:28 +00:00
|
|
|
# MIT License
|
2011-10-08 21:12:25 +00:00
|
|
|
#
|
2010-12-08 13:49:28 +00:00
|
|
|
|
2011-06-08 14:49:35 +00:00
|
|
|
require 'pp'
|
2011-06-11 10:44:30 +00:00
|
|
|
require 'pry/helpers/base_helpers'
|
2011-10-17 01:09:12 +00:00
|
|
|
require 'pry/hooks'
|
|
|
|
|
2011-05-20 14:50:55 +00:00
|
|
|
class Pry
|
|
|
|
# The default hooks - display messages when beginning and ending Pry sessions.
|
2011-11-15 13:49:11 +00:00
|
|
|
DEFAULT_HOOKS = Pry::Hooks.new.add_hook(:before_session, :default) do |out, target, _pry_|
|
2012-03-31 21:18:03 +00:00
|
|
|
next if _pry_.quiet?
|
2012-06-11 06:37:47 +00:00
|
|
|
_pry_.run_command("whereami --quiet", "", target)
|
2011-10-17 01:09:12 +00:00
|
|
|
end
|
2011-05-20 14:50:55 +00:00
|
|
|
|
2011-09-08 02:17:41 +00:00
|
|
|
# The default print
|
2011-05-20 14:50:55 +00:00
|
|
|
DEFAULT_PRINT = proc do |output, value|
|
2011-08-24 08:07:52 +00:00
|
|
|
stringified = begin
|
|
|
|
value.pretty_inspect
|
2011-09-15 09:43:58 +00:00
|
|
|
rescue RescuableException
|
2011-08-24 08:07:52 +00:00
|
|
|
nil
|
|
|
|
end
|
|
|
|
|
|
|
|
unless String === stringified
|
|
|
|
# Read the class name off of the singleton class to provide a default inspect.
|
|
|
|
klass = (class << value; self; end).ancestors.first
|
|
|
|
stringified = "#<#{klass}:0x#{value.__id__.to_s(16)}>"
|
2011-07-25 13:06:57 +00:00
|
|
|
end
|
2011-08-24 08:07:52 +00:00
|
|
|
|
2011-10-19 06:24:37 +00:00
|
|
|
nonce = rand(0x100000000).to_s(16) # whatever
|
|
|
|
|
|
|
|
colorized = Helpers::BaseHelpers.colorize_code(stringified.gsub(/#</, "%<#{nonce}"))
|
|
|
|
|
2011-11-27 06:43:00 +00:00
|
|
|
# avoid colour-leak from CodeRay and any of the users' previous output
|
|
|
|
colorized = colorized.sub(/(\n*)$/, "\e[0m\\1") if Pry.color
|
|
|
|
|
|
|
|
Helpers::BaseHelpers.stagger_output("=> #{colorized.gsub(/%<(.*?)#{nonce}/, '#<\1')}", output)
|
2011-05-20 14:50:55 +00:00
|
|
|
end
|
|
|
|
|
2011-09-07 07:56:23 +00:00
|
|
|
# may be convenient when working with enormous objects and
|
|
|
|
# pretty_print is too slow
|
|
|
|
SIMPLE_PRINT = proc do |output, value|
|
|
|
|
begin
|
|
|
|
output.puts "=> #{value.inspect}"
|
|
|
|
rescue RescuableException
|
|
|
|
output.puts "=> unknown"
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2011-09-08 03:36:24 +00:00
|
|
|
# useful when playing with truly enormous objects
|
|
|
|
CLIPPED_PRINT = proc do |output, value|
|
|
|
|
output.puts "=> #{Pry.view_clip(value)}"
|
|
|
|
end
|
|
|
|
|
2011-05-20 14:50:55 +00:00
|
|
|
# Will only show the first line of the backtrace
|
2011-09-10 16:39:51 +00:00
|
|
|
DEFAULT_EXCEPTION_HANDLER = proc do |output, exception, _|
|
2011-05-20 14:50:55 +00:00
|
|
|
output.puts "#{exception.class}: #{exception.message}"
|
|
|
|
output.puts "from #{exception.backtrace.first}"
|
|
|
|
end
|
|
|
|
|
2011-09-18 01:45:46 +00:00
|
|
|
# Don't catch these exceptions
|
|
|
|
DEFAULT_EXCEPTION_WHITELIST = [SystemExit, SignalException]
|
|
|
|
|
2011-05-20 14:50:55 +00:00
|
|
|
# The default prompt; includes the target and nesting level
|
|
|
|
DEFAULT_PROMPT = [
|
2011-09-27 14:25:09 +00:00
|
|
|
proc { |target_self, nest_level, pry|
|
2011-10-28 03:38:39 +00:00
|
|
|
"[#{pry.input_array.size}] pry(#{Pry.view_clip(target_self)})#{":#{nest_level}" unless nest_level.zero?}> "
|
2011-09-08 03:36:24 +00:00
|
|
|
},
|
|
|
|
|
2011-09-27 14:25:09 +00:00
|
|
|
proc { |target_self, nest_level, pry|
|
2011-10-28 03:38:39 +00:00
|
|
|
"[#{pry.input_array.size}] pry(#{Pry.view_clip(target_self)})#{":#{nest_level}" unless nest_level.zero?}* "
|
2011-09-08 03:36:24 +00:00
|
|
|
}
|
2011-08-29 14:21:51 +00:00
|
|
|
]
|
2011-09-08 03:36:24 +00:00
|
|
|
|
2011-05-20 14:50:55 +00:00
|
|
|
# A simple prompt - doesn't display target or nesting level
|
2011-07-26 17:16:25 +00:00
|
|
|
SIMPLE_PROMPT = [proc { ">> " }, proc { " | " }]
|
2011-05-20 14:50:55 +00:00
|
|
|
|
|
|
|
SHELL_PROMPT = [
|
2011-09-08 03:36:24 +00:00
|
|
|
proc { |target_self, _, _| "pry #{Pry.view_clip(target_self)}:#{Dir.pwd} $ " },
|
|
|
|
proc { |target_self, _, _| "pry #{Pry.view_clip(target_self)}:#{Dir.pwd} * " }
|
2011-09-07 07:56:23 +00:00
|
|
|
]
|
|
|
|
|
|
|
|
# A prompt that includes the full object path as well as
|
|
|
|
# input/output (_in_ and _out_) information. Good for navigation.
|
|
|
|
NAV_PROMPT = [
|
2012-07-12 11:13:13 +00:00
|
|
|
proc do |conf|
|
|
|
|
tree = conf.binding_stack.map { |b| Pry.view_clip(b.eval("self")) }.join " / "
|
2012-07-12 14:58:25 +00:00
|
|
|
"[#{conf.expr_number}] (pry) #{tree}: #{conf.nesting_level}> "
|
2011-09-08 03:36:24 +00:00
|
|
|
end,
|
2012-07-12 11:13:13 +00:00
|
|
|
proc do |conf|
|
|
|
|
tree = conf.binding_stack.map { |b| Pry.view_clip(b.eval("self")) }.join " / "
|
2012-07-12 14:58:25 +00:00
|
|
|
"[#{conf.expr_number}] (pry) #{tree}: #{conf.nesting_level}* "
|
2011-09-08 03:36:24 +00:00
|
|
|
end,
|
|
|
|
]
|
2011-09-07 07:56:23 +00:00
|
|
|
|
2011-09-27 14:25:09 +00:00
|
|
|
# Deal with the ^D key being pressed, different behaviour in
|
|
|
|
# different cases:
|
|
|
|
# 1) In an expression - behave like `!` command (clear input buffer)
|
|
|
|
# 2) At top-level session - behave like `exit command (break out of repl loop)
|
|
|
|
# 3) In a nested session - behave like `cd ..` (pop a binding)
|
|
|
|
DEFAULT_CONTROL_D_HANDLER = proc do |eval_string, _pry_|
|
|
|
|
if !eval_string.empty?
|
2012-06-27 11:54:07 +00:00
|
|
|
# Clear input buffer.
|
2012-06-16 19:59:14 +00:00
|
|
|
eval_string.replace("")
|
2011-09-27 14:25:09 +00:00
|
|
|
elsif _pry_.binding_stack.one?
|
2012-06-27 11:54:07 +00:00
|
|
|
# ^D at top-level breaks out of a REPL loop.
|
2011-09-27 14:25:09 +00:00
|
|
|
_pry_.binding_stack.clear
|
|
|
|
throw(:breakout)
|
|
|
|
else
|
2012-06-27 11:54:07 +00:00
|
|
|
# Otherwise, saves current binding stack as old stack and pops last
|
|
|
|
# binding out of binding stack (the old stack still has that binding).
|
|
|
|
_pry_.command_state["cd"].old_stack = _pry_.binding_stack.dup
|
|
|
|
_pry_.binding_stack.pop
|
2011-09-27 14:25:09 +00:00
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2011-09-17 12:42:29 +00:00
|
|
|
DEFAULT_SYSTEM = proc do |output, cmd, _|
|
2011-09-17 06:35:17 +00:00
|
|
|
if !system(cmd)
|
|
|
|
output.puts "Error: there was a problem executing system command: #{cmd}"
|
|
|
|
end
|
|
|
|
end
|
2011-05-20 14:50:55 +00:00
|
|
|
|
2012-08-13 05:41:28 +00:00
|
|
|
# Store the current working directory. This allows show-source etc. to work if
|
|
|
|
# your process has changed directory since boot. [Issue #675]
|
|
|
|
INITIAL_PWD = Dir.pwd
|
|
|
|
|
2011-08-27 00:44:13 +00:00
|
|
|
# As a REPL, we often want to catch any unexpected exceptions that may have
|
|
|
|
# been raised; however we don't want to go overboard and prevent the user
|
|
|
|
# from exiting Pry when they want to.
|
|
|
|
module RescuableException
|
|
|
|
def self.===(exception)
|
|
|
|
case exception
|
2011-09-08 03:36:24 +00:00
|
|
|
# Catch when the user hits ^C (Interrupt < SignalException), and assume
|
|
|
|
# that they just wanted to stop the in-progress command (just like bash etc.)
|
2011-08-27 00:44:13 +00:00
|
|
|
when Interrupt
|
|
|
|
true
|
2011-09-08 03:36:24 +00:00
|
|
|
# Don't catch signals (particularly not SIGTERM) as these are unlikely to be
|
|
|
|
# intended for pry itself. We should also make sure that Kernel#exit works.
|
2011-09-18 01:45:46 +00:00
|
|
|
when *Pry.config.exception_whitelist
|
2011-08-27 00:44:13 +00:00
|
|
|
false
|
2011-09-08 03:36:24 +00:00
|
|
|
# All other exceptions will be caught.
|
2011-08-27 00:44:13 +00:00
|
|
|
else
|
|
|
|
true
|
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2011-10-01 23:57:39 +00:00
|
|
|
# CommandErrors are caught by the REPL loop and displayed to the user. They
|
|
|
|
# indicate an exceptional condition that's fatal to the current command.
|
2012-01-16 07:45:08 +00:00
|
|
|
class CommandError < StandardError; end
|
2012-07-18 01:55:18 +00:00
|
|
|
class MethodNotFound < CommandError; end
|
2012-01-23 06:33:34 +00:00
|
|
|
|
2012-01-23 12:10:35 +00:00
|
|
|
# indicates obsolete API
|
|
|
|
class ObsoleteError < StandardError; end
|
|
|
|
|
2012-01-23 06:33:34 +00:00
|
|
|
# This is to keep from breaking under Rails 3.2 for people who are doing that
|
|
|
|
# IRB = Pry thing.
|
|
|
|
module ExtendCommandBundle
|
|
|
|
end
|
2011-05-20 14:50:55 +00:00
|
|
|
end
|
|
|
|
|
2012-04-18 06:18:33 +00:00
|
|
|
if Pry::Helpers::BaseHelpers.mri_18?
|
|
|
|
begin
|
|
|
|
require 'ruby18_source_location'
|
|
|
|
rescue LoadError
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2010-12-18 11:21:58 +00:00
|
|
|
require "method_source"
|
2011-03-02 11:18:26 +00:00
|
|
|
require 'shellwords'
|
2011-02-27 23:00:51 +00:00
|
|
|
require "stringio"
|
2011-03-02 11:18:26 +00:00
|
|
|
require "coderay"
|
2011-04-25 20:58:06 +00:00
|
|
|
require "optparse"
|
2012-05-30 20:33:13 +00:00
|
|
|
require "slop"
|
2011-12-26 21:57:40 +00:00
|
|
|
require "rbconfig"
|
2012-08-12 00:22:29 +00:00
|
|
|
require 'tempfile'
|
2011-03-02 11:18:26 +00:00
|
|
|
|
2012-06-05 06:26:38 +00:00
|
|
|
begin
|
|
|
|
require 'readline'
|
|
|
|
rescue LoadError
|
|
|
|
warn "You're running a version of ruby with no Readline support"
|
|
|
|
warn "Please `gem install rb-readline` or recompile ruby --with-readline."
|
|
|
|
exit!
|
|
|
|
end
|
|
|
|
|
2011-12-27 00:48:59 +00:00
|
|
|
if Pry::Helpers::BaseHelpers.jruby?
|
2011-09-11 04:28:31 +00:00
|
|
|
begin
|
|
|
|
require 'ffi'
|
|
|
|
rescue LoadError
|
2012-01-23 03:40:40 +00:00
|
|
|
warn "Need to `gem install ffi`"
|
2011-09-11 04:28:31 +00:00
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2012-06-23 22:06:32 +00:00
|
|
|
if Pry::Helpers::BaseHelpers.windows? && !Pry::Helpers::BaseHelpers.windows_ansi?
|
2011-03-02 11:18:26 +00:00
|
|
|
begin
|
|
|
|
require 'win32console'
|
2012-06-23 22:06:32 +00:00
|
|
|
# The mswin and mingw versions of pry require win32console, so this should
|
|
|
|
# only fail on jruby (where win32console doesn't work).
|
|
|
|
# Instead we'll recommend ansicon, which does.
|
2011-03-02 11:18:26 +00:00
|
|
|
rescue LoadError
|
2012-06-23 22:06:32 +00:00
|
|
|
warn "For a better pry experience, please use ansicon: http://adoxa.3eeweb.com/ansicon/"
|
2011-03-02 11:18:26 +00:00
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2011-04-24 11:56:47 +00:00
|
|
|
require "pry/version"
|
2011-09-19 06:42:31 +00:00
|
|
|
require "pry/rbx_method"
|
2011-09-19 08:18:57 +00:00
|
|
|
require "pry/rbx_path"
|
2011-11-26 05:05:10 +00:00
|
|
|
require "pry/code"
|
2011-09-19 06:42:31 +00:00
|
|
|
require "pry/method"
|
2011-12-02 06:55:48 +00:00
|
|
|
require "pry/wrapped_module"
|
2011-05-15 09:29:14 +00:00
|
|
|
require "pry/history_array"
|
2011-04-25 20:58:06 +00:00
|
|
|
require "pry/helpers"
|
2011-09-05 09:00:14 +00:00
|
|
|
require "pry/history"
|
2011-12-31 11:50:04 +00:00
|
|
|
require "pry/command"
|
2011-04-24 14:25:07 +00:00
|
|
|
require "pry/command_set"
|
2011-04-24 11:56:47 +00:00
|
|
|
require "pry/commands"
|
|
|
|
require "pry/custom_completions"
|
|
|
|
require "pry/completion"
|
2011-05-15 09:58:27 +00:00
|
|
|
require "pry/plugins"
|
2011-04-24 11:56:47 +00:00
|
|
|
require "pry/core_extensions"
|
|
|
|
require "pry/pry_class"
|
|
|
|
require "pry/pry_instance"
|
2011-12-07 02:07:02 +00:00
|
|
|
require "pry/cli"
|
2012-08-08 21:57:19 +00:00
|
|
|
require "pry/pager"
|