-
-
Save thiagoa/7f534600e027e31b14f55749ec20a4a9 to your computer and use it in GitHub Desktop.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
# Using these pry gems -- copy to your Gemfile | |
# group :development, :test do | |
# gem 'pry', '>= 0.14.1' # Console with powerful introspection capabilities | |
# # Need to use master of pry-byebug to use latest pry version | |
# gem 'pry-byebug', github: 'deivid-rodriguez/pry-byebug' # Integrates pry with byebug | |
# gem 'pry-doc' # Provide MRI Core documentation | |
# gem 'pry-rails' # Causes rails console to open pry. `DISABLE_PRY_RAILS=1 rails c` can still open with IRB | |
# gem 'pry-rescue' # Start a pry session whenever something goes wrong. | |
# gem 'pry-theme' # An easy way to customize Pry colors via theme files | |
# | |
# gem 'awesome_print' # pretty print ruby objects | |
# end | |
# === EDITOR === | |
# Use Vi | |
# Pry.editor = 'vi' | |
# Or RubyMine or other | |
Pry.config.editor = proc { |file, line| "rubymine --line #{line} #{file}" } | |
unless defined?(Pry::Prompt) | |
Pry.config.prompt = Pry::NAV_PROMPT | |
end | |
# In case you want to see the project and the env plus the nav | |
# IMHO, too wide. | |
# if Pry::Prompt[:rails] | |
# Pry.config.prompt = Pry::Prompt[:rails] | |
# end | |
# === COLORS === | |
unless ENV['PRY_BW'] | |
Pry.color = true | |
Pry.config.theme = "railscasts" | |
Pry.config.prompt = PryRails::RAILS_PROMPT if defined?(PryRails::RAILS_PROMPT) | |
Pry.config.prompt ||= Pry.prompt | |
end | |
# === HISTORY === | |
Pry::Commands.command /^$/, "repeat last command" do | |
_pry_.run_command Pry.history.to_a.last | |
end | |
# == Pry-Nav - Using pry as a debugger == | |
# Shortcut for calling pry_debug | |
def pd | |
Pry.commands.alias_command 't', 'backtrace' | |
Pry.commands.alias_command 's', 'step' | |
Pry.commands.alias_command 'n', 'next' | |
Pry.commands.alias_command 'c', 'continue' | |
Pry.commands.alias_command 'f', 'finish' | |
Pry.commands.alias_command 'ff', 'frame' | |
Pry.commands.alias_command 'u', 'up' | |
Pry.commands.alias_command 'd', 'down' | |
Pry.commands.alias_command 'b', 'break' | |
Pry.commands.alias_command 'w', 'whereami' | |
display_shortcuts | |
end | |
Pry.config.commands.alias_command "h", "hist -T 20", desc: "Last 20 commands" | |
Pry.config.commands.alias_command "hg", "hist -T 20 -G", desc: "Up to 20 commands matching expression" | |
Pry.config.commands.alias_command "hG", "hist -G", desc: "Commands matching expression ever used" | |
Pry.config.commands.alias_command "hr", "hist -r", desc: "hist -r <command number> to run a command" | |
# Fix deprecation warning, so override default for now. | |
# Remember to eventually remove this! | |
# WARNING: the show-doc command is deprecated. It will be removed from future Pry versions. | |
# Please use 'show-source' with the -d (or --doc) switch instead | |
Pry.commands.alias_command '?', 'show-source -d' | |
if defined?(PryByebug) | |
def pry_debug | |
puts "You can also call 'pd' to save typing!" | |
pd | |
end | |
def pp(obj) | |
Pry::ColorPrinter.pp(obj) | |
end | |
end | |
# Use awesome_print (or amazing_print) | |
begin | |
require 'awesome_print' | |
AwesomePrint.pry! | |
rescue LoadError => err | |
begin | |
puts "no awesome_print :( #{err}" | |
puts "trying amazing_print" | |
require 'amazing_print' | |
AmazingPrint.pry! | |
rescue LoadError => err2 | |
puts "no awesome_print :( #{err2}" | |
end | |
end | |
# Hit Enter to repeat last command | |
Pry::Commands.command /^$/, "repeat last command" do | |
pry_instance.run_command Pry.history.to_a.last | |
end | |
before_session_hook = Pry::Hooks.new.add_hook(:before_session, :add_dirs_to_load_path) do | |
# adds the directories /spec and /test directories to the path if they exist and not already included | |
current_dir = `pwd`.chomp | |
dirs_added = %w(spec test presenters lib). | |
map{ |d| "#{current_dir}/#{d}" }. | |
map do |path| | |
if File.exist?(path) && !$:.include?(path) | |
i$: << path | |
path | |
end | |
end.compact | |
puts "Added #{ dirs_added.join(", ") } to load path per hook in ~/.pryrc." unless dirs_added.empty? | |
end | |
before_session_hook.exec_hook(:before_session) | |
def more_help | |
puts "Helpful shortcuts:" | |
puts "hh : hist -T 20 Last 20 commands" | |
puts "hg : hist -T 20 -G Up to 20 commands matching expression" | |
puts "hG : hist -G Commands matching expression ever used" | |
puts "hr : hist -r hist -r <command number> to run a command" | |
puts | |
puts "Samples variables" | |
puts "a_array : [1, 2, 3, 4, 5, 6]" | |
puts "a_hash : { hello: \"world\", free: \"of charge\" }" | |
puts | |
puts "helper : Access Rails helpers" | |
puts "app : Access url_helpers" | |
puts | |
puts "require \"rails_helper\" : To include Factory Girl Syntax" | |
puts "include FactoryGirl::Syntax::Methods : To include Factory Girl Syntax" | |
puts | |
puts "or if you defined one..." | |
puts "require \"pry_helper\"" | |
puts | |
puts "Sidekiq::Queue.new.clear : To clear sidekiq" | |
puts "Sidekiq.redis { |r| puts r.flushall } : Another clear of sidekiq" | |
puts | |
puts "Run `require 'factory_bot'; FactoryBot.find_definitions` for FactoryBot" | |
puts | |
display_shortcuts | |
puts "Debugging Shortcuts" | |
puts | |
puts | |
"" | |
end | |
def display_shortcuts | |
puts "Installed debugging Shortcuts" | |
puts 'w : whereami' | |
puts 's : step' | |
puts 'n : next' | |
puts 'c : continue' | |
puts 'f : finish' | |
puts 'pp(obj) : pretty print object' | |
puts '' | |
puts 'Stack movement' | |
puts 't : backtrace' | |
puts 'ff : frame' | |
puts 'u : up' | |
puts 'd : down' | |
puts 'b : break' | |
puts | |
puts "Introspection" | |
puts '$ : show whole method of current context' | |
puts '$ foo: show definition of foo' | |
puts '? foo: show docs for for' | |
puts | |
puts "Be careful not to use shortcuts for temp vars, like 'u = User.first`" | |
puts "Run `help` to see all the pry commands that would conflict (and lots good info)" | |
"" | |
end | |
# Utility global methods for convenience | |
def a_array | |
(1..6).to_a | |
end | |
def a_hash | |
{ hello: "world", free: "of charge" } | |
end | |
def do_time(repetitions = 100, &block) | |
require 'benchmark' | |
Benchmark.bm{|b| b.report{repetitions.times(&block)}} | |
end | |
# by default, set up the debug shortcuts | |
pd |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment