/
show_info.rb
147 lines (125 loc) · 4.74 KB
/
show_info.rb
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
class Pry
class Command::ShowInfo < Pry::ClassCommand
extend Pry::Helpers::BaseHelpers
command_options :shellwords => false
command_options :requires_gem => "ruby18_source_location" if mri_18?
def setup
require 'ruby18_source_location' if mri_18?
end
def options(opt)
opt.on :s, :super, "Select the 'super' method. Can be repeated to traverse the ancestors", :as => :count
opt.on :l, "line-numbers", "Show line numbers"
opt.on :b, "base-one", "Show line numbers but start numbering at 1 (useful for `amend-line` and `play` commands)"
opt.on :f, :flood, "Do not use a pager to view text longer than one screen"
opt.on :a, :all, "Show all definitions and monkeypatches of the module/class"
end
def process
code_object = Pry::CodeObject.lookup(obj_name, _pry_, :super => opts[:super])
raise Pry::CommandError, "Couldn't locate #{obj_name}!" if !code_object
if show_all_modules?(code_object)
# show all monkey patches for a module
@all_modules = true
result = content_and_headers_for_all_module_candidates(code_object)
else
# show a specific code object
@all_modules = false
result = content_and_header_for_code_object(code_object)
end
set_file_and_dir_locals(code_object.source_file)
stagger_output result
end
def content_and_header_for_code_object(code_object)
header(code_object) + content_for(code_object)
end
def content_and_headers_for_all_module_candidates(mod)
result = "Found #{mod.number_of_candidates} candidates for `#{mod.name}` definition:\n"
mod.number_of_candidates.times do |v|
candidate = mod.candidate(v)
begin
result << "\nCandidate #{v+1}/#{mod.number_of_candidates}: #{candidate.source_file} @ line #{candidate.source_line}:\n"
content = content_for(candidate)
result << "Number of lines: #{content.lines.count}\n\n" << content
rescue Pry::RescuableException
result << "\nNo content found.\n"
next
end
end
result
end
# Generate a header (meta-data information) for all the code
# object types: methods, modules, commands, procs...
def header(code_object)
file_name, line_num = file_and_line_for(code_object)
h = "\n#{Pry::Helpers::Text.bold('From:')} #{file_name} "
h << method_header(code_object, line_num) if code_object.real_method_object?
h << "\n#{Pry::Helpers::Text.bold('Number of lines:')} " <<
"#{content_for(code_object).lines.count}\n\n"
end
def method_header(code_object, line_num)
h = ""
h << (code_object.c_method? ? "(C Method):" : "@ line #{line_num}:")
h << method_sections(code_object)[:owner]
h << method_sections(code_object)[:visibility]
h << method_sections(code_object)[:signature]
h
end
def method_sections(code_object)
{
:owner => "\n#{text.bold("Owner:")} #{code_object.owner || "N/A"}\n",
:visibility => "#{text.bold("Visibility:")} #{code_object.visibility}",
:signature => "\n#{text.bold("Signature:")} #{code_object.signature}"
}.merge(header_options) { |key, old, new| (new && old).to_s }
end
def header_options
{
:owner => true,
:visibility => true,
:signature => nil
}
end
def show_all_modules?(code_object)
code_object.is_a?(Pry::WrappedModule) && opts.present?(:all)
end
def obj_name
@obj_name ||= args.empty? ? nil : args.join(" ")
end
def use_line_numbers?
opts.present?(:b) || opts.present?(:l)
end
def start_line_for(code_object)
if opts.present?(:'base-one')
1
else
code_object.source_line || 1
end
end
# takes into account possible yard docs, and returns yard_file / yard_line
# Also adjusts for start line of comments (using start_line_for), which it has to infer
# by subtracting number of lines of comment from start line of code_object
def file_and_line_for(code_object)
if code_object.module_with_yard_docs?
[code_object.yard_file, code_object.yard_line]
else
[code_object.source_file, start_line_for(code_object)]
end
end
def all_modules?
@all_modules
end
def complete(input)
if input =~ /([^ ]*)#([a-z0-9_]*)\z/
prefix, search = [$1, $2]
methods = begin
Pry::Method.all_from_class(binding.eval(prefix))
rescue RescuableException => e
return super
end
methods.map do |method|
[prefix, method.name].join('#') if method.name.start_with?(search)
end.compact
else
super
end
end
end
end