-
Notifications
You must be signed in to change notification settings - Fork 0
/
ClassTracer.rb
562 lines (503 loc) · 19.1 KB
/
ClassTracer.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
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
module ClassTraceUtils
require 'set'
require 'ostruct'
require 'json'
=begin
variable
- name
- types []
classname
- instance instance_vars []
- methods []
- method name
- calling variables []
- default (can't seem to get ahold of this easily)
- nilable
- returns []
- line variables []
using a ruby set to automatically handle the duplication of types
=end
class ClassTracer
attr_accessor :classes, :archive_path, :date_generated, :date_updated, :times_run, :monitored_classes, :named_like, :start_time, :end_time, :trace_duration, :namespace_list, :times_method_called
def initialize(options = {})
@archive_path = options[:archive_path] || 'json.txt'
@monitored_classes = options[:monitored_classes] || []
@named_like = options[:named_like] || nil
@date_generated = Time.now
@date_updated = Time.now
@times_run = 1
@classes = {}
@trace_point = self.trace_point
@tracer = self.tracer
end
def namespace_list
@namespace_list ||= list_namespaces
end
def list_namespaces
namespaces = []
@classes.each do |c,v|
namespaces << v.namespace_list
end
return namespaces.uniq
end
def times_method_called
@times_method_called ||= method_call_count
end
def method_call_count
calls = 0
@classes.each {|k, v| calls += v.times_method_called }
return calls
end
def trace_point
# configure our TracePoint
# we're going to use this to capture RETURN value types from methods
# let's check out the returns and see if we can figure out the data type
trace_point = TracePoint.new(:return, :call) do |t|
trace_point.disable
#print "."
class_name = "#{t.defined_class}".delete('[#<>]').sub("Class:","")
if monitored_classes.include?(class_name) || (class_name =~ /#{@named_like}/ unless @named_like == nil)
event = "#{t.event}".delete('[:]')
method = "#{t.method_id}"
variable_scope = "#{event}"
variable_name = "return"
if variable_scope == "return"
variable = t.return_value
addClassInfo(class_name, method, event, variable_scope, variable_name, variable)
elsif variable_scope == "call"
#req #required argument
#opt #optional argument with default
#rest #rest of arguments as array
#keyreq #reguired key argument (2.1+)
#key #key argument with default argument
#keyrest #rest of key arguments as Hash
#block #block parameter
o_method = eval("method(:#{t.method_id})", t.binding)
o_method.parameters.each do |k,p|
arg_type = "#{k}"
variable_name = "#{p}"
variable = t.binding.local_variable_get(p)
addClassInfo(class_name, method, event, variable_scope, variable_name, variable, arg_type)
end
updateMethodCount(class_name, method)
end
end
trace_point.enable
end
trace_point
end
def tracer
# configure our tracer
# we're going to use this to capture INSTANCE and LOCAL variables for classes and methods
tracer = lambda do |event, file, line, id, binding, class_name|
#print "."
class_name = "#{class_name}"
if (monitored_classes.include?(class_name) || (class_name =~ /#{@named_like}/ unless @named_like == nil) ) && ["call", "line"].include?(event)
me = binding.eval("self")
binding.eval("instance_variables + local_variables").inject({}) do |vars, name|
variable_scope = "instance"
method = "#{id}"
begin
variable = me.instance_variable_get("#{name}")
variable_scope = "instance"
rescue
variable = binding.local_variable_get("#{name}")
variable_scope = "local"
end
addClassInfo(class_name, method, event, variable_scope, name, variable)
end
end
end
tracer
end
def start
puts "Starting trace"
puts "Tracing."
@start_time = Time.now
@trace_duration = 0
set_trace_func @tracer
@trace_point.enable
end
def stop
set_trace_func nil
@trace_point.disable
@end_time = Time.now
@trace_duration = @end_time - @start_time
puts ""
puts "Trace complete"
end
def last_trace_duration
if @trace_duration != nil
puts Time.at(@trace_duration).utc.strftime("%H:%M:%S") #=> "01:00:00"
else
"No trace record found"
end
end
def updateMethodCount(class_name, method)
if @classes[class_name] != nil
@classes[class_name].updateMethodCount(method)
end
end
def addClassInfo(class_name, method, event, variable_scope, variable_name, variable, optional = nil)
variable_type = get_var_type(variable)
if @classes[class_name] == nil
@classes[class_name] = ClassProfile.new(class_name, method, event, variable_scope, variable_name, variable_type, optional)
else
@classes[class_name].addMethodSignature(method, event, variable_scope, variable_name, variable_type, optional)
end
end
def self.restoreFromArchive(file)
begin
json = File.read(file)
from_json(json)
rescue
puts "Unable to find file #{file}. Please check file path/name. Creating new Class Tracker."
ClassTracer.new(archive_path: file)
end
end
def archive(archive_path = nil)
archive_path ||= @archive_path
archive_path ||= "json.txt"
File.open(archive_path, "w") do |f|
f.puts self.to_json
end
puts "Archived profile to '#{@archive_path}'"
end
def self.from_json(json)
json = JSON.parse(json)
archive = json["archive"]
archive_path = json["archive_path"]
ct = ClassTracer.new(archive_path: archive_path)
ct.date_generated = json["date_generated"] if json["date_generated"]
ct.date_generated ||= Time.now
ct.date_updated = json["date_updated"] if json["date_updated"]
ct.times_run = json["times_run"] if json["times_run"]
ct.monitored_classes = json["monitored_classes"] if json["monitored_classes"]
ct.named_like = json["named_like"] if json["named_like"]
ct.start_time = json["start_time"] if json["start_time"]
ct.end_time = json["end_time"] if json["end_time"]
ct.trace_duration = json["trace_duration"] if json["trace_duration"]
ct.namespace_list = json["namespace_list"] if json["namespace_list"]
json["classes"].each do |c|
class_name = c[1]["class_name"] if c[1]["class_name"]
if class_name != nil
aclass = ClassProfile.new(class_name)
aclass.namespace_list = c[1]["namespace_list"] if c[1]["namespace_list"]
c[1]["instance_vars"].each do |k,i|
variable_name = k
variable_scope = "instance"
i["types"].each do |t|
variable_type = t
aclass.addMethodSignature(nil, nil, variable_scope, variable_name, variable_type)
end
end
c[1]["methods"].each do |mk,m|
method = mk
m["local_vars"].each do |mvk, mv|
variable_name = mvk
variable_scope = "local"
event = "local"
mv["types"].each do |t|
variable_type = t
aclass.addMethodSignature(method, event, variable_scope, variable_name, variable_type)
end
end
m["calling_vars"].each do |mvk, mv|
variable_name = mvk
variable_scope = "call"
event = "call"
required = mv["required"]
arg_type = mv["arg_type"]
mv["types"].each do |t|
variable_type = t
aclass.addMethodSignature(method, event, variable_scope, variable_name, variable_type, arg_type)
end
end
m["return_types"].each do |t|
variable_name = "return"
variable_scope = "return"
event = "return"
variable_type = t
aclass.addMethodSignature(method, event, variable_scope, variable_name, variable_type)
end
aclass.methods[method].times_method_called = m["times_method_called"] || 0
end
ct.classes[class_name] = aclass
end
end
ct
end
def to_json(options={})
# I have no clue why, but ... lazy-loaded variables don't seem to load correctly in the HQMF example.
# They work find in just pure ruby tests, but... not for the HQMF example. If you actually "touch" the lazy
# variable it's populated, so the process sees it and loads it into the JSON. But what's interesting is this works fine
# w/o this approach (no touching) with the pure Simpsons example. There's some difference, but I certainly can't
# figure it out. It appears that in the Simpsons example, the child to_json methods are called. But - in the HQMF
# example, the child to_json methods are NOT called. I spent a while trying to sort that out, but... can't figure it out.
# I'm wondering if it has something to do with the unit test framework when I run this in a rake task
classes = {}
@classes.each do |k,v|
classes[k] = {
"class_name" => v.class_name,
"instance_vars" => v.instance_vars,
"methods" => v.methods,
"referenced_types" => v.referenced_types,
"namespace_list" => v.namespace_list
}
end
#and again here...lazy properties + json = bad?
all_namespaces = list_namespaces
sum_times_method_called = method_call_count
{
"json_class" => self.class.name,
"archive_path" => @archive_path,
"classes" => @classes,
"date_generated" => @date_generated,
"date_updated" => Time.now,
"times_run" => @times_run + 1,
"monitored_classes" => @monitored_classes,
"named_like" => @named_like,
"start_time" => @start_time,
"end_time" => @end_time,
"trace_duration" => @trace_duration,
"namespace_list" => all_namespaces,
"times_method_called" => sum_times_method_called
}.to_json(options)
end
def report
class_list = @classes
puts "=========================="
class_list.each do |c_name, c_val|
puts "--------------------------"
puts "CLASS: #{c_val.class_name}"
puts "--------------------------"
if !c_val.instance_vars.empty?
puts " Instance Variables:"
c_val.instance_vars.each do |i_name, i_val|
types = i_val.types.collect{|t| t }.join(", ")
nilable = i_val.nilable ? " (NILABLE)" : ""
puts " - #{i_name} : #{types}#{nilable}"
end
end
if !c_val.methods.empty?
puts " Methods:"
c_val.methods.each do |m_name, m_val|
return_types = m_val.return_types.collect{|t| t }.join(", ")
return_types = return_types.empty? ? return_types : "RETURNS: (#{return_types})"
return_nilable = ""
puts " - #{m_name} : #{return_types}#{return_nilable}"
if !m_val.calling_vars.empty?
puts " - Calling Variables : "
m_val.calling_vars.each do |c_name, c_val|
types = c_val.types.collect{|t| t }.join(", ")
nilable = c_val.nilable ? " (NILABLE)" : ""
arg_type = c_val.arg_type ? " [#{c_val.arg_type}] " : ""
puts " #{c_name} : #{types}#{nilable}#{arg_type}"
end
end
if !m_val.local_vars.empty?
puts " - Local Variables : "
m_val.local_vars.each do |l_name, l_val|
types = l_val.types.collect{|t| t }.join(", ")
nilable = l_val.nilable ? " (NILABLE)" : ""
arg_type = l_val.arg_type ? " [#{l_val.arg_type}] " : ""
puts " #{l_name} : #{types}#{nilable}#{arg_type}"
end
end
end
end
end
puts "=========================="
end
private
#NOTE: intentionally NOT making this smart and recursive
# I don't want this iterating forever for things that have json, etc.
# I just need some basic high-level type information
def get_var_type(var)
className = var.class.name
if className == "Array"
classNames = var.collect{|x|
if x.class.name == "Hash"
vnames = x.collect{|k2,v2| v2.class.name}.uniq.join(",")
"Hash:'#{vnames}'"
else
x.class.name
end
}.uniq.join(",")
className = "Array[#{classNames}]"
elsif className == "Hash"
var.each do |key, val|
val_class = val.class.name
if val_class == "Array"
val_class = val.collect{|x| x.class.name }.uniq.join(",")
val_class = "Array[#{val_class}]"
end
className = "Hash:[#{val_class}]"
end
end
className
end
class VariableProfile
attr_accessor :name, :types, :nilable, :arg_type
def initialize(name, type, arg_type = nil)
@name = name
@types = Set.new [type]
@arg_type = arg_type
if type == "NilClass"
@nilable = true
else
@nilable = false
end
end
def addType(type)
@types << type
if type == "NilClass"
@nilable = true
end
end
def to_json(*a)
{
"name" => @name,
"nilable" => @nilable,
"types" => @types.to_a,
"required" => @required,
"arg_type" => @arg_type
}.to_json(*a)
end
end
class MethodProfile
attr_accessor :name, :local_vars, :return_types, :calling_vars, :times_method_called
def initialize(name, variable_scope, variable_type, variable_name, arg_type = nil)
@name = name
@local_vars = {}
@calling_vars = {}
@return_types = Set.new []
@times_method_called = 0
addVariable(variable_scope, variable_type, variable_name, arg_type)
end
def addVariable(variable_scope, variable_type, variable_name, arg_type = nil)
if variable_scope == "local"
if @local_vars[variable_name] == nil
@local_vars[variable_name] = VariableProfile.new(variable_name, variable_type, arg_type)
else
@local_vars[variable_name].addType(variable_type)
end
elsif variable_scope == "call"
if @calling_vars[variable_name] == nil
@calling_vars[variable_name] = VariableProfile.new(variable_name, variable_type, arg_type)
else
@calling_vars[variable_name].addType(variable_type)
end
elsif variable_scope == "return"
@return_types << variable_type
end
end
def to_json(options)
{
"name" => @name,
"local_vars" => @local_vars,
"calling_vars" => @calling_vars,
"return_types" => @return_types.to_a,
"times_method_called" => @times_method_called
}.to_json(options)
end
end
class ClassProfile
attr_accessor :class_name, :instance_vars, :methods, :referenced_types, :namespace_list, :times_method_called
def initialize(class_name, method = nil, event = nil, variable_scope = nil, variable_name = nil, variable_type = nil, arg_type = nil)
@class_name = class_name
@instance_vars = {}
@methods = {}
if class_name && method && event && variable_scope && variable_name && variable_type
addMethodSignature(method, event, variable_scope, variable_name, variable_type, arg_type)
end
end
def namespace_list
@namespace_list ||= list_namespaces
end
def list_namespaces
return @class_name.split("::")
end
def referenced_types
@referenced_types ||= types
end
def times_method_called
@times_method_called ||= method_call_count
end
def method_call_count
calls = 0
@methods.each {|k, v| calls += v.times_method_called }
return calls
end
def types(options = {})
named_like = options[:named_like] || nil
collapse_types = options[:collapse_types] || true
_types = []
@instance_vars.collect{|k,v| _types.concat v.types.to_a}
@methods.each {|mn,mv| mv.local_vars.collect{|k2,v2| _types.concat v2.types.to_a} }
@methods.each {|mn,mv| mv.calling_vars.collect{|k2,v2| _types.concat v2.types.to_a} }
@methods.each {|mn,mv| _types.concat mv.return_types.to_a }
_types.uniq!
_typesOut = []
_types.each { |t|
t = t.gsub("'", "")
if collapse_types == true
#puts "collapsing types"
#we're going to "collapse" types found in arrays and hashes - remove them from the container and split them
#m = t.scan(/(?:Array|Hash:)(?:\[)(.*?)(?:\])/)
t = t.gsub("Array[", "")
t = t.gsub("Hash:[", "")
t = t.gsub("\]", "")
t = t.gsub("\[", "")
m = t.split(",")
if m.count > 0
m.each{|t2| _typesOut << t2 }
else
_typesOut << t
end
else
_typesOut << t
end
}
_out = []
_typesOut.uniq.select{|t| t != class_name }.each {|v|
if (v =~ /#{named_like}/ || named_like == nil) && !v.empty?
#_out << {"name" => v}
_out << v
end
}
_out.sort
end
def updateMethodCount(method)
if @methods[method] != nil
@methods[method].times_method_called += 1
end
end
def addMethodSignature(method, event, variable_scope, variable_name, variable_type, arg_type = nil)
if variable_scope == "instance"
if @instance_vars[variable_name] == nil
@instance_vars[variable_name] = VariableProfile.new(variable_name, variable_type, arg_type)
else
@instance_vars[variable_name].addType(variable_type)
end
elsif ["local", "return", "call"].include?(variable_scope)
if @methods[method] == nil
@methods[method] = MethodProfile.new(method, variable_scope, variable_type, variable_name, arg_type)
else
@methods[method].addVariable(variable_scope, variable_type, variable_name, arg_type)
end
end
end
def to_json(options={})
{
"class_name" => @class_name,
"instance_vars" => @instance_vars,
"methods" => @methods,
"referenced_types" => @referenced_types,
"namespace_list" => @namespace_list,
"times_method_called" => @times_method_called
}.to_json(options)
end
end
end
end