Class: Flog

Inherits:
MethodBasedSexpProcessor
  • Object
show all
Defined in:
lib/flog.rb

Constant Summary collapse

VERSION =

:nodoc:

"4.2.0"
THRESHOLD =

Cut off point where the report should stop unless –all given.

0.60
SCORES =

The scoring system hash. Maps node type to score.

Hash.new 1
BRANCHING =

Names of nodes that branch.

[ :and, :case, :else, :if, :or, :rescue, :until, :when, :while ]
OTHER_SCORES =

Various non-call constructs

{
  :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 => case RUBY_VERSION
                     when /^1\.8\.7/ then
                       2
                     when /^1\.9/ then
                       1.5
                     when /^2\.[01]/ then
                       1
                     else
                       5
                     end,
  :yield          => 1,
}

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(option = {}) ⇒ Flog

Creates a new Flog instance with options.



230
231
232
233
234
235
236
237
238
 
# File 'lib/flog.rb', line 230

def initialize option = {}
  super()
  @option              = option
  @method_locations    = {}
  @mass                = {}
  @parser              = nil
  self.auto_shift_type = true
  self.reset
end

Instance Attribute Details

#calls ⇒ Object (readonly)

Returns the value of attribute calls.



98
99
100
 
# File 'lib/flog.rb', line 98

def calls
  @calls
end

#mass ⇒ Object (readonly)

Returns the value of attribute mass.



98
99
100
 
# File 'lib/flog.rb', line 98

def mass
  @mass
end

#method_scores ⇒ Object (readonly)

Returns the value of attribute method_scores.



99
100
101
 
# File 'lib/flog.rb', line 99

def method_scores
  @method_scores
end

#multiplier ⇒ Object

:stopdoc:



97
98
99
 
# File 'lib/flog.rb', line 97

def multiplier
  @multiplier
end

#option ⇒ Object (readonly)

Returns the value of attribute option.



98
99
100
 
# File 'lib/flog.rb', line 98

def option
  @option
end

#scores ⇒ Object (readonly)

Returns the value of attribute scores.



99
100
101
 
# File 'lib/flog.rb', line 99

def scores
  @scores
end

#total_score ⇒ Object (readonly)

Returns the value of attribute total_score.



100
101
102
 
# File 'lib/flog.rb', line 100

def total_score
  @total_score
end

#totals ⇒ Object (readonly)

Returns the value of attribute totals.



100
101
102
 
# File 'lib/flog.rb', line 100

def totals
  @totals
end

Instance Method Details

#add_to_score(name, score = ) ⇒ Object

Add a score to the tally. Score can be predetermined or looked up automatically. Uses multiplier for additional spankings. Spankings!



109
110
111
112
 
# File 'lib/flog.rb', line 109

def add_to_score name, score = OTHER_SCORES[name]
  return if option[:methods] and method_stack.empty?
  @calls[signature][name] += score * @multiplier
end

#alias_method ⇒ Object

Various “magic” usually used for “clever code”



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/flog.rb', line 70

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)

#average ⇒ Object

really?



117
118
119
120
 
# File 'lib/flog.rb', line 117

def average
  return 0 if calls.size == 0
  total_score / calls.size
end

#calculate ⇒ Object

Calculates classes and methods scores.



125
126
127
128
129
130
131
132
 
# File 'lib/flog.rb', line 125

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

#calculate_total_scores ⇒ Object

Calculates the total score and populates @totals.



303
304
305
306
307
308
309
310
311
312
313
314
315
 
# File 'lib/flog.rb', line 303

def calculate_total_scores
  return if @totals

  @total_score = 0
  @totals = Hash.new(0)

  calls.each do |meth, tally|
    score = score_method(tally)

    @totals[meth] = score
    @total_score += score
  end
end

#define_method ⇒ Object

Eval forms



61
62
63
64
65
 
# File 'lib/flog.rb', line 61

SCORES.merge!(:define_method => 5,
:eval          => 5,
:module_eval   => 5,
:class_eval    => 5,
:instance_eval => 5)

#dsl_name?(args) ⇒ Boolean

Returns true if the form looks like a “DSL” construct.

task :blah do ... end
=> s(:iter, s(:call, nil, :task, s(:lit, :blah)), ...)

Returns:

  • (Boolean) 


140
141
142
143
144
145
146
147
 
# File 'lib/flog.rb', line 140

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

#each_by_score(max = nil) ⇒ Object

Iterate over the calls sorted (descending) by score.



152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/flog.rb', line 152

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(*files) ⇒ Object

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.



171
172
173
174
175
176
177
178
179
180
181
 
# File 'lib/flog.rb', line 171

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_ruby(ruby, file = "-", timeout = 10) ⇒ Object

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.



188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/flog.rb', line 188

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_ruby!(ruby, file = "-", timeout = 10) ⇒ Object

Flog the given ruby source, optionally using file to provide paths for methods. Does not handle timeouts or syntax errors. See #flog_ruby.



214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/flog.rb', line 214

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

#inject ⇒ Object

Calls that are ALMOST ALWAYS ABUSED!



94
 
# File 'lib/flog.rb', line 94

SCORES.merge!(:inject => 2)

#max_method ⇒ Object

Returns the method/score pair of the maximum score.



243
244
245
 
# File 'lib/flog.rb', line 243

def max_method
  totals.max_by { |_, score| score }
end

#max_score ⇒ Object

Returns the maximum score for a single method. Used for FlogTask.



250
251
252
 
# File 'lib/flog.rb', line 250

def max_score
  max_method.last
end

#no_method ⇒ Object

:nodoc:



317
318
319
 
# File 'lib/flog.rb', line 317

def no_method # :nodoc:
  @@no_method
end

#penalize_by(bonus) ⇒ Object

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.



260
261
262
263
264
 
# File 'lib/flog.rb', line 260

def penalize_by bonus
  @multiplier += bonus
  yield
  @multiplier -= bonus
end

#process_alias(exp) ⇒ Object

:stopdoc:



325
326
327
328
329
330
 
# File 'lib/flog.rb', line 325

def process_alias(exp)
  process exp.shift
  process exp.shift
  add_to_score :alias
  s()
end

#process_and(exp) ⇒ Object Also known as: process_or 



332
333
334
335
336
337
338
339
 
# File 'lib/flog.rb', line 332

def process_and(exp)
  add_to_score :branch
  penalize_by 0.1 do
    process exp.shift # lhs
    process exp.shift # rhs
  end
  s()
end

#process_attrasgn(exp) ⇒ Object 



342
343
344
345
346
347
348
 
# File 'lib/flog.rb', line 342

def process_attrasgn(exp)
  add_to_score :assignment
  process exp.shift # lhs
  exp.shift # name
  process_until_empty exp # rhs
  s()
end

#process_block(exp) ⇒ Object 



350
351
352
353
354
355
 
# File 'lib/flog.rb', line 350

def process_block(exp)
  penalize_by 0.1 do
    process_until_empty exp
  end
  s()
end

#process_block_pass(exp) ⇒ Object 



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
 
# File 'lib/flog.rb', line 357

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

#process_call(exp) ⇒ Object 



384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
 
# File 'lib/flog.rb', line 384

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

#process_case(exp) ⇒ Object 



400
401
402
403
404
405
406
407
 
# File 'lib/flog.rb', line 400

def process_case(exp)
  add_to_score :branch
  process exp.shift # recv
  penalize_by 0.1 do
    process_until_empty exp
  end
  s()
end

#process_class(exp) ⇒ Object 



409
410
411
412
413
414
415
416
 
# File 'lib/flog.rb', line 409

def process_class(exp)
  super do
    penalize_by 1.0 do
      process exp.shift # superclass expression
    end
    process_until_empty exp
  end
end

#process_dasgn_curr(exp) ⇒ Object Also known as: process_iasgn, process_lasgn

FIX: remove



418
419
420
421
422
423
 
# File 'lib/flog.rb', line 418

def process_dasgn_curr(exp) # FIX: remove
  add_to_score :assignment
  exp.shift # name
  process exp.shift # assigment, if any
  s()
end

#process_else(exp) ⇒ Object Also known as: process_rescue, process_when

TODO: it’s not clear to me whether this can be generated at all.



428
429
430
431
432
433
434
 
# File 'lib/flog.rb', line 428

def process_else(exp)
  add_to_score :branch
  penalize_by 0.1 do
    process_until_empty exp
  end
  s()
end

#process_if(exp) ⇒ Object 



438
439
440
441
442
443
444
445
446
 
# File 'lib/flog.rb', line 438

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

#process_iter(exp) ⇒ Object 



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
 
# File 'lib/flog.rb', line 448

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

#process_lit(exp) ⇒ Object 



486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
 
# File 'lib/flog.rb', line 486

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

#process_masgn(exp) ⇒ Object 



502
503
504
505
506
507
508
509
 
# File 'lib/flog.rb', line 502

def process_masgn(exp)
  add_to_score :assignment

  exp.map! { |s| Sexp === s ? s : s(:lasgn, s) }

  process_until_empty exp
  s()
end

#process_sclass(exp) ⇒ Object 



511
512
513
514
515
516
517
518
519
520
521
 
# File 'lib/flog.rb', line 511

def process_sclass(exp)
  super do
    penalize_by 0.5 do
      process exp.shift # recv
      process_until_empty exp
    end
  end

  add_to_score :sclass
  s()
end

#process_super(exp) ⇒ Object 



523
524
525
526
527
 
# File 'lib/flog.rb', line 523

def process_super(exp)
  add_to_score :super
  process_until_empty exp
  s()
end

#process_while(exp) ⇒ Object Also known as: process_until 



529
530
531
532
533
534
535
536
537
 
# File 'lib/flog.rb', line 529

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

#process_yield(exp) ⇒ Object 



540
541
542
543
544
 
# File 'lib/flog.rb', line 540

def process_yield(exp)
  add_to_score :yield
  process_until_empty exp
  s()
end

#reset ⇒ Object

Reset score data



269
270
271
272
273
274
275
276
 
# File 'lib/flog.rb', line 269

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
  method_locations.clear
end

#score_method(tally) ⇒ Object

Compute the distance formula for a given tally



281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/flog.rb', line 281

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

#threshold ⇒ Object

Final threshold that is used for report



296
297
298
 
# File 'lib/flog.rb', line 296

def threshold
  option[:all] ? nil : total_score * THRESHOLD
end