-
-
Notifications
You must be signed in to change notification settings - Fork 74
/
flog.rb
640 lines (515 loc) · 14.3 KB
/
flog.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
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
require "sexp_processor"
require "ruby_parser"
require "timeout"
class File
RUBY19 = "<3".respond_to? :encoding unless defined? RUBY19 # :nodoc:
class << self
alias :binread :read unless RUBY19
end
end
class Flog < SexpProcessor
VERSION = "4.0.0" # :nodoc:
##
# Cut off point where the report should stop unless --all given.
THRESHOLD = 0.60
##
# The scoring system hash. Maps node type to score.
SCORES = Hash.new 1
##
# Names of nodes that branch.
BRANCHING = [ :and, :case, :else, :if, :or, :rescue, :until, :when, :while ]
##
# Various non-call constructs
OTHER_SCORES = {
:alias => 2,
:assignment => 1,
:block => 1,
:block_pass => 1,
:branch => 1,
:lit_fixnum => 0.25,
:sclass => 5,
:super => 1,
:to_proc_icky! => 10,
:to_proc_lasgn => 15,
:to_proc_normal => 5,
:yield => 1,
}
##
# Eval forms
SCORES.merge!(:define_method => 5,
:eval => 5,
:module_eval => 5,
:class_eval => 5,
:instance_eval => 5)
##
# Various "magic" usually used for "clever code"
SCORES.merge!(:alias_method => 2,
:extend => 2,
:include => 2,
:instance_method => 2,
:instance_methods => 2,
:method_added => 2,
:method_defined? => 2,
:method_removed => 2,
:method_undefined => 2,
:private_class_method => 2,
:private_instance_methods => 2,
:private_method_defined? => 2,
:protected_instance_methods => 2,
:protected_method_defined? => 2,
:public_class_method => 2,
:public_instance_methods => 2,
:public_method_defined? => 2,
:remove_method => 2,
:send => 3,
:undef_method => 2)
##
# Calls that are ALMOST ALWAYS ABUSED!
SCORES.merge!(:inject => 2)
@@no_class = :main
@@no_method = :none
# :stopdoc:
attr_accessor :multiplier
attr_reader :calls, :option, :class_stack, :method_stack, :mass, :sclass
attr_reader :method_locations, :method_scores, :scores
attr_reader :total_score, :totals
# :startdoc:
##
# Add a score to the tally. Score can be predetermined or looked up
# automatically. Uses multiplier for additional spankings.
# Spankings!
def add_to_score name, score = OTHER_SCORES[name]
@calls[signature][name] += score * @multiplier
end
##
# really?
def average
return 0 if calls.size == 0
total_score / calls.size
end
##
# Calculates classes and methods scores.
def calculate
each_by_score threshold do |class_method, score, call_list|
klass = class_method.split(/#|::/).first
method_scores[klass] << [class_method, score]
scores[klass] += score
end
end
##
# Returns true if the form looks like a "DSL" construct.
#
# task :blah do ... end
# => s(:iter, s(:call, nil, :task, s(:lit, :blah)), ...)
def dsl_name? args
return false unless args and not args.empty?
first_arg = args.first
first_arg = first_arg[1] if first_arg[0] == :hash
[:lit, :str].include? first_arg[0] and first_arg[1]
end
##
# Iterate over the calls sorted (descending) by score.
def each_by_score max = nil
current = 0
calls.sort_by { |k,v| -totals[k] }.each do |class_method, call_list|
score = totals[class_method]
yield class_method, score, call_list
current += score
break if max and current >= max
end
end
##
# Flog the given files. Deals with "-", and syntax errors.
#
# Not as smart as FlogCLI's #flog method as it doesn't traverse
# dirs. Use FlogCLI.expand_dirs_to_files or see FlogCLI#flog.
def flog(*files)
files.each do |file|
next unless file == '-' or File.readable? file
ruby = file == '-' ? $stdin.read : File.binread(file)
flog_ruby ruby, file
end
calculate_total_scores
end
##
# Flog the given ruby source, optionally using file to provide paths
# for methods. Smart. Handles syntax errors and timeouts so you
# don't have to.
def flog_ruby ruby, file="-", timeout = 10
flog_ruby! ruby, file, timeout
rescue Timeout::Error
warn "TIMEOUT parsing #{file}. Skipping."
rescue RubyParser::SyntaxError, Racc::ParseError => e
q = option[:quiet]
if e.inspect =~ /<\%|%\>/ or ruby =~ /<\%|%\>/ then
return if q
warn "#{e.inspect} at #{e.backtrace.first(5).join(', ')}"
warn "\n...stupid lemmings and their bad erb templates... skipping"
else
warn "ERROR: parsing ruby file #{file}" unless q
unless option[:continue] then
warn "ERROR! Aborting. You may want to run with --continue."
raise e
end
return if q
warn "%s: %s at:\n %s" % [e.class, e.message.strip,
e.backtrace.first(5).join("\n ")]
end
end
##
# Flog the given ruby source, optionally using file to provide paths for
# methods. Does not handle timeouts or syntax errors. See #flog_ruby.
def flog_ruby! ruby, file="-", timeout = 10
@parser = (option[:parser] || RubyParser).new
warn "** flogging #{file}" if option[:verbose]
ast = @parser.process ruby, file, timeout
return unless ast
mass[file] = ast.mass
process ast
end
##
# Adds name to the class stack, for the duration of the block
def in_klass name
if Sexp === name then
name = case name.first
when :colon2 then
name = name.flatten
name.delete :const
name.delete :colon2
name.join("::")
when :colon3 then
name.last.to_s
else
raise "unknown type #{name.inspect}"
end
end
@class_stack.unshift name
yield
@class_stack.shift
end
##
# Adds name to the method stack, for the duration of the block
def in_method(name, file, line)
method_name = Regexp === name ? name.inspect : name.to_s
@method_stack.unshift method_name
@method_locations[signature] = "#{file}:#{line}"
yield
@method_stack.shift
end
##
# Creates a new Flog instance with +options+.
def initialize option = {}
super()
@option = option
@sclass = []
@class_stack = []
@method_stack = []
@method_locations = {}
@mass = {}
@parser = nil
self.auto_shift_type = true
self.reset
end
##
# Returns the first class in the list, or @@no_class if there are
# none.
def klass_name
name = @class_stack.first
if Sexp === name then
raise "you shouldn't see me"
elsif @class_stack.any?
@class_stack.reverse.join("::").sub(/\([^\)]+\)$/, '')
else
@@no_class
end
end
##
# Returns the method/score pair of the maximum score.
def max_method
totals.max_by { |_, score| score }
end
##
# Returns the maximum score for a single method. Used for FlogTask.
def max_score
max_method.last
end
##
# Returns the first method in the list, or "#none" if there are
# none.
def method_name
m = @method_stack.first || @@no_method
m = "##{m}" unless m =~ /::/
m
end
##
# For the duration of the block the complexity factor is increased
# by #bonus This allows the complexity of sub-expressions to be
# influenced by the expressions in which they are found. Yields 42
# to the supplied block.
def penalize_by bonus
@multiplier += bonus
yield
@multiplier -= bonus
end
##
# Process each element of #exp in turn.
def process_until_empty exp
process exp.shift until exp.empty?
end
##
# Reset score data
def reset
@totals = @total_score = nil
@multiplier = 1.0
@calls = Hash.new { |h,k| h[k] = Hash.new 0 }
@method_scores = Hash.new { |h,k| h[k] = [] }
@scores = Hash.new 0
end
##
# Compute the distance formula for a given tally
def score_method(tally)
a, b, c = 0, 0, 0
tally.each do |cat, score|
case cat
when :assignment then a += score
when :branch then b += score
else c += score
end
end
Math.sqrt(a*a + b*b + c*c)
end
##
# Returns the method signature for the current method.
def signature
"#{klass_name}#{method_name}"
end
##
# Final threshold that is used for report
def threshold
option[:all] ? nil : total_score * THRESHOLD
end
##
# Calculates the total score and populates @totals.
def calculate_total_scores
return if @totals
@total_score = 0
@totals = Hash.new(0)
calls.each do |meth, tally|
next if option[:methods] and meth =~ /##{@@no_method}$/
score = score_method(tally)
@totals[meth] = score
@total_score += score
end
end
def no_method # :nodoc:
@@no_method
end
############################################################
# Process Methods:
# :stopdoc:
def process_alias(exp)
process exp.shift
process exp.shift
add_to_score :alias
s()
end
def process_and(exp)
add_to_score :branch
penalize_by 0.1 do
process exp.shift # lhs
process exp.shift # rhs
end
s()
end
alias :process_or :process_and
def process_attrasgn(exp)
add_to_score :assignment
process exp.shift # lhs
exp.shift # name
process_until_empty exp # rhs
s()
end
def process_block(exp)
penalize_by 0.1 do
process_until_empty exp
end
s()
end
def process_block_pass(exp)
arg = exp.shift
add_to_score :block_pass
case arg.first
when :lvar, :dvar, :ivar, :cvar, :self, :const, :colon2, :nil then # f(&b)
# do nothing
when :lit, :call then # f(&:b)
add_to_score :to_proc_normal
when :lasgn then # f(&l=b)
add_to_score :to_proc_lasgn
when :iter, :dsym, :dstr, *BRANCHING then # below
# f(&proc { ... })
# f(&"#{...}")
# f(&:"#{...}")
# f(&if ... then ... end") and all other branching forms
add_to_score :to_proc_icky!
else
raise({:block_pass_even_ickier! => arg}.inspect)
end
process arg
s()
end
def process_call(exp)
penalize_by 0.2 do
process exp.shift # recv
end
name = exp.shift
penalize_by 0.2 do
process_until_empty exp
end
add_to_score name, SCORES[name]
s()
end
def process_case(exp)
add_to_score :branch
process exp.shift # recv
penalize_by 0.1 do
process_until_empty exp
end
s()
end
def process_class(exp)
in_klass exp.shift do
penalize_by 1.0 do
process exp.shift # superclass expression
end
process_until_empty exp
end
s()
end
def process_dasgn_curr(exp) # FIX: remove
add_to_score :assignment
exp.shift # name
process exp.shift # assigment, if any
s()
end
alias :process_iasgn :process_dasgn_curr
alias :process_lasgn :process_dasgn_curr
def process_defn(exp)
name = @sclass.empty? ? exp.shift : "::#{exp.shift}"
in_method name, exp.file, exp.line do
process_until_empty exp
end
s()
end
def process_defs(exp)
process exp.shift # recv
in_method "::#{exp.shift}", exp.file, exp.line do
process_until_empty exp
end
s()
end
# TODO: it's not clear to me whether this can be generated at all.
def process_else(exp)
add_to_score :branch
penalize_by 0.1 do
process_until_empty exp
end
s()
end
alias :process_rescue :process_else
alias :process_when :process_else
def process_if(exp)
add_to_score :branch
process exp.shift # cond
penalize_by 0.1 do
process exp.shift # true
process exp.shift # false
end
s()
end
def process_iter(exp)
context = (self.context - [:class, :module, :scope])
context = context.uniq.sort_by { |s| s.to_s }
exp.delete 0 # { || ... } has 0 in arg slot
if context == [:block, :iter] or context == [:iter] then
recv = exp.first
# DSL w/ names. eg task :name do ... end
# looks like s(:call, nil, :task, s(:lit, :name))
# or s(:call, nil, :task, s(:str, "name"))
# or s(:call, nil, :task, s(:hash, s(:lit, :name) ...))
t, r, m, *a = recv
if t == :call and r == nil and submsg = dsl_name?(a) then
m = "#{m}(#{submsg})" if m and [String, Symbol].include?(submsg.class)
in_klass m do # :task/namespace
in_method submsg, exp.file, exp.line do # :name
process_until_empty exp
end
end
return s()
end
end
add_to_score :branch
process exp.shift # no penalty for LHS
penalize_by 0.1 do
process_until_empty exp
end
s()
end
def process_lit(exp)
value = exp.shift
case value
when 0, -1 then
# ignore those because they're used as array indicies instead of
# first/last
when Integer then
add_to_score :lit_fixnum
when Float, Symbol, Regexp, Range then
# do nothing
else
raise value.inspect
end
s()
end
def process_masgn(exp)
add_to_score :assignment
exp.map! { |s| Sexp === s ? s : s(:lasgn, s) }
process_until_empty exp
s()
end
def process_module(exp)
in_klass exp.shift do
process_until_empty exp
end
s()
end
def process_sclass(exp)
@sclass.push(true)
penalize_by 0.5 do
process exp.shift # recv
process_until_empty exp
end
@sclass.pop
add_to_score :sclass
s()
end
def process_super(exp)
add_to_score :super
process_until_empty exp
s()
end
def process_while(exp)
add_to_score :branch
penalize_by 0.1 do
process exp.shift # cond
process exp.shift # body
end
exp.shift # pre/post
s()
end
alias :process_until :process_while
def process_yield(exp)
add_to_score :yield
process_until_empty exp
s()
end
# :startdoc:
end