Class: Flog

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

Constant Summary collapse

VERSION = 
'2.5.0'
THRESHOLD = 
0.60
SCORES = 
Hash.new 1
BRANCHING = 
[ :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 => 5,
  :yield          => 1,
}
@@no_class = 
:main
@@no_method = 
:none

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(option = {}) ⇒ Flog

Returns a new instance of Flog.



278
279
280
281
282
283
284
285
286
287
288
 
# File 'lib/flog.rb', line 278

def initialize option = {}
  super()
  @option              = option
  @class_stack         = []
  @method_stack        = []
  @method_locations    = {}
  @mass                = {}
  @parser              = RubyParser.new
  self.auto_shift_type = true
  self.reset
end

Instance Attribute Details

#calls ⇒ Object (readonly)

Returns the value of attribute calls.



73
74
75
 
# File 'lib/flog.rb', line 73

def calls
  @calls
end

#class_stack ⇒ Object (readonly)

Returns the value of attribute class_stack.



73
74
75
 
# File 'lib/flog.rb', line 73

def class_stack
  @class_stack
end

#mass ⇒ Object (readonly)

Returns the value of attribute mass.



73
74
75
 
# File 'lib/flog.rb', line 73

def mass
  @mass
end

#method_locations ⇒ Object (readonly)

Returns the value of attribute method_locations.



74
75
76
 
# File 'lib/flog.rb', line 74

def method_locations
  @method_locations
end

#method_stack ⇒ Object (readonly)

Returns the value of attribute method_stack.



73
74
75
 
# File 'lib/flog.rb', line 73

def method_stack
  @method_stack
end

#multiplier ⇒ Object

Returns the value of attribute multiplier.



72
73
74
 
# File 'lib/flog.rb', line 72

def multiplier
  @multiplier
end

#option ⇒ Object (readonly)

Returns the value of attribute option.



73
74
75
 
# File 'lib/flog.rb', line 73

def option
  @option
end

Class Method Details

.expand_dirs_to_files(*dirs) ⇒ Object

REFACTOR: from flay



112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/flog.rb', line 112

def self.expand_dirs_to_files *dirs
  extensions = ['rb']

  dirs.flatten.map { |p|
    if File.directory? p then
      Dir[File.join(p, '**', "*.{#{extensions.join(',')}}")]
    else
      p
    end
  }.flatten.sort
end

.load_plugins ⇒ Object

TODO: I think I want to do this more like hoe’s plugin system. Generalize?



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

def self.load_plugins
  loaded, found = {}, {}

  Gem.find_files("flog/*.rb").reverse.each do |path|
    found[File.basename(path, ".rb").intern] = path
  end

  found.each do |name, plugin|
    next if loaded[name]
    begin
      warn "loading #{plugin}" # if $DEBUG
      loaded[name] = load plugin
    rescue LoadError => e
      warn "error loading #{plugin.inspect}: #{e.message}. skipping..."
    end
  end

  self.plugins.merge loaded

  names = Flog.constants.map {|s| s.to_s}.reject {|n| n =~ /^[A-Z_]+$/}

  names.each do |name|
    # next unless Hoe.plugins.include? name.downcase.intern
    mod = Flog.const_get(name)
    next if Class === mod
    warn "extend #{mod}" if $DEBUG
    # self.extend mod
  end
end

.parse_options(args = ARGV) ⇒ Object 



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

def self.parse_options args = ARGV
  option = {
    :quiet    => true,
    :continue => false,
  }

  OptionParser.new do |opts|
    opts.separator "Standard options:"

    opts.on("-a", "--all", "Display all flog results, not top 60%.") do
      option[:all] = true
    end

    opts.on("-b", "--blame", "Include blame information for methods.") do
      option[:blame] = true
    end

    opts.on("-c", "--continue", "Continue despite syntax errors.") do
      option[:continue] = true
    end

    opts.on("-d", "--details", "Show method details.") do
      option[:details] = true
    end

    opts.on("-g", "--group", "Group and sort by class.") do
      option[:group] = true
    end

    opts.on("-h", "--help", "Show this message.") do
      puts opts
      exit
    end

    opts.on("-I dir1,dir2,dir3", Array, "Add to LOAD_PATH.") do |dirs|
      dirs.each do |dir|
        $: << dir
      end
    end

    opts.on("-m", "--methods-only", "Skip code outside of methods.") do
      option[:methods] = true
    end

    opts.on("-q", "--quiet", "Don't show method details. [default]") do
      option[:quiet] = true
    end

    opts.on("-s", "--score", "Display total score only.") do
      option[:score] = true
    end

    opts.on("-v", "--verbose", "Display progress during processing.") do
      option[:verbose] = true
    end

    next if self.plugins.empty?
    opts.separator "Plugin options:"

    extra = self.methods.grep(/parse_options/) - %w(parse_options)

    extra.sort.each do |msg|
      self.send msg, opts, option
    end

  end.parse! Array(args)

  option
end

.plugins ⇒ Object 



76
77
78
 
# File 'lib/flog.rb', line 76

def self.plugins
  @plugins ||= {}
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!



199
200
201
 
# File 'lib/flog.rb', line 199

def add_to_score name, score = OTHER_SCORES[name]
  @calls[signature][name] += score * @multiplier
end

#alias_method ⇒ Object

Various “magic” usually used for “clever code”



43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/flog.rb', line 43

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?



206
207
208
209
 
# File 'lib/flog.rb', line 206

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

#define_method ⇒ Object

Eval forms



34
35
36
37
38
 
# File 'lib/flog.rb', line 34

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

#each_by_score(max = nil) ⇒ Object

Iterate over the calls sorted (descending) by score.



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

def each_by_score max = nil
  my_totals = totals
  current   = 0

  calls.sort_by { |k,v| -my_totals[k] }.each do |class_method, call_list|
    score = my_totals[class_method]

    yield class_method, score, call_list

    current += score
    break if max and current >= max
  end
end

#flog(*files_or_dirs) ⇒ Object

Flog the given files or directories. Smart. Deals with “-”, syntax errors, and traversing subdirectories intelligently.



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

def flog(*files_or_dirs)
  files = Flog.expand_dirs_to_files(*files_or_dirs)

  files.each do |file|
    begin
      # TODO: replace File.open to deal with "-"
      ruby = file == '-' ? $stdin.read : File.read(file)
      warn "** flogging #{file}" if option[:verbose]

      ast = @parser.process(ruby, file)
      next unless ast
      mass[file] = ast.mass
      process ast
    rescue SyntaxError, Racc::ParseError => e
      if e.inspect =~ /<%|%>/ or ruby =~ /<%|%>/ then
        warn "#{e.inspect} at #{e.backtrace.first(5).join(', ')}"
        warn "\n...stupid lemmings and their bad erb templates... skipping"
      else
        raise e unless option[:continue]
        warn file
        warn "#{e.inspect} at #{e.backtrace.first(5).join(', ')}"
      end
    end
  end
end

#in_klass(name) ⇒ Object

Adds name to the class stack, for the duration of the block



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

def in_klass name
  @class_stack.unshift name
  yield
  @class_stack.shift
end

#in_method(name, file, line) ⇒ Object

Adds name to the method stack, for the duration of the block



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

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

#inject ⇒ Object

Calls that are ALMOST ALWAYS ABUSED!



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

SCORES.merge!(:inject => 2)

#klass_name ⇒ Object

Returns the first class in the list, or @@no_class if there are none.



294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
 
# File 'lib/flog.rb', line 294

def klass_name
  name = @class_stack.first || @@no_class
  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
             name
           end
  end
  name
end

#method_name ⇒ Object

Returns the first method in the list, or “#none” if there are none.



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

def method_name
  m = @method_stack.first || @@no_method
  m = "##{m}" unless m =~ /::/
  m
end

#output_details(io, max = nil) ⇒ Object

Output the report up to a given max or report everything, if nil.



325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
 
# File 'lib/flog.rb', line 325

def output_details io, max = nil
  io.puts

  each_by_score max do |class_method, score, call_list|
    return 0 if option[:methods] and class_method =~ /##{@@no_method}/
    self.print_score io, class_method, score

    if option[:details] then
      call_list.sort_by { |k,v| -v }.each do |call, count|
        io.puts "  %6.1f:   %s" % [count, call]
      end
      io.puts
    end
  end
  # io.puts
end

#output_details_grouped(io, max = nil) ⇒ Object

Output the report, grouped by class/module, up to a given max or report everything, if nil.



346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
 
# File 'lib/flog.rb', line 346

def output_details_grouped io, max = nil
  scores  = Hash.new 0
  methods = Hash.new { |h,k| h[k] = [] }

  each_by_score max do |class_method, score, call_list|
    klass = class_method.split(/#|::/).first

    methods[klass] << [class_method, score]
    scores[klass]  += score
  end

  scores.sort_by { |_, n| -n }.each do |klass, total|
    io.puts

    io.puts "%8.1f: %s" % [total, "#{klass} total"]
    methods[klass].each do |name, score|
      self.print_score io, name, score
    end
  end
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.



373
374
375
376
377
 
# File 'lib/flog.rb', line 373

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

#print_score(io, name, score) ⇒ Object

Print out one formatted score.



382
383
384
385
386
387
388
389
 
# File 'lib/flog.rb', line 382

def print_score io, name, score
  location = @method_locations[name]
  if location then
    io.puts "%8.1f: %-32s %s" % [score, name, location]
  else
    io.puts "%8.1f: %s" % [score, name]
  end
end

#process_alias(exp) ⇒ Object

Process Methods:



474
475
476
477
478
479
 
# File 'lib/flog.rb', line 474

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 



481
482
483
484
485
486
487
488
 
# File 'lib/flog.rb', line 481

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 



491
492
493
494
495
496
497
 
# File 'lib/flog.rb', line 491

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

#process_block(exp) ⇒ Object 



499
500
501
502
503
504
 
# File 'lib/flog.rb', line 499

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

#process_block_pass(exp) ⇒ Object 



506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
 
# File 'lib/flog.rb', line 506

def process_block_pass(exp)
  arg = exp.shift

  add_to_score :block_pass

  case arg.first
  when :lvar, :dvar, :ivar, :cvar, :self, :const, :nil then
    # do nothing
  when :lit, :call then
    add_to_score :to_proc_normal
  when :lasgn then # blah(&l = proc { ... })
    add_to_score :to_proc_lasgn
  when :iter, :dsym, :dstr, *BRANCHING then
    add_to_score :to_proc_icky!
  else
    raise({:block_pass_even_ickier! => arg}.inspect)
  end

  process arg

  s()
end

#process_call(exp) ⇒ Object 



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

def process_call(exp)
  penalize_by 0.2 do
    recv = process exp.shift
  end
  name = exp.shift
  penalize_by 0.2 do
    args = process exp.shift
  end

  add_to_score name, SCORES[name]

  s()
end

#process_case(exp) ⇒ Object 



543
544
545
546
547
548
549
550
 
# File 'lib/flog.rb', line 543

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 



552
553
554
555
556
557
558
559
560
 
# File 'lib/flog.rb', line 552

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

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

FIX: remove



562
563
564
565
566
567
 
# File 'lib/flog.rb', line 562

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

#process_defn(exp) ⇒ Object 



571
572
573
574
575
576
 
# File 'lib/flog.rb', line 571

def process_defn(exp)
  in_method exp.shift, exp.file, exp.line do
    process_until_empty exp
  end
  s()
end

#process_defs(exp) ⇒ Object 



578
579
580
581
582
583
584
 
# File 'lib/flog.rb', line 578

def process_defs(exp)
  recv = process exp.shift
  in_method "::#{exp.shift}", exp.file, exp.line do
    process_until_empty exp
  end
  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.



587
588
589
590
591
592
593
 
# File 'lib/flog.rb', line 587

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

#process_if(exp) ⇒ Object 



597
598
599
600
601
602
603
604
605
 
# File 'lib/flog.rb', line 597

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 



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

def process_iter(exp)
  context = (self.context - [:class, :module, :scope])
  context = context.uniq.sort_by { |s| s.to_s }

  if context == [:block, :iter] or context == [:iter] then
    recv = exp.first

    # DSL w/ names. eg task :name do ... end
    if (recv[0] == :call and recv[1] == nil and recv.arglist[1] and
        [:lit, :str].include? recv.arglist[1][0]) then
      msg = recv[2]
      submsg = recv.arglist[1][1]
      in_klass msg do                           # :task
        in_method submsg, exp.file, exp.line do # :name
          process_until_empty exp
        end
      end
      return s()
    end
  end

  add_to_score :branch

  exp.delete 0 # TODO: what is this?

  process exp.shift # no penalty for LHS

  penalize_by 0.1 do
    process_until_empty exp
  end

  s()
end

#process_lit(exp) ⇒ Object 



641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
 
# File 'lib/flog.rb', line 641

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 



657
658
659
660
661
 
# File 'lib/flog.rb', line 657

def process_masgn(exp)
  add_to_score :assignment
  process_until_empty exp
  s()
end

#process_module(exp) ⇒ Object 



663
664
665
666
667
668
 
# File 'lib/flog.rb', line 663

def process_module(exp)
  in_klass exp.shift do
    process_until_empty exp
  end
  s()
end

#process_sclass(exp) ⇒ Object 



670
671
672
673
674
675
676
677
678
 
# File 'lib/flog.rb', line 670

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

  add_to_score :sclass
  s()
end

#process_super(exp) ⇒ Object 



680
681
682
683
684
 
# File 'lib/flog.rb', line 680

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

#process_until_empty(exp) ⇒ Object

Process each element of #exp in turn.



394
395
396
 
# File 'lib/flog.rb', line 394

def process_until_empty exp
  process exp.shift until exp.empty?
end

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



686
687
688
689
690
691
692
693
694
 
# File 'lib/flog.rb', line 686

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 



697
698
699
700
701
 
# File 'lib/flog.rb', line 697

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

#report(io = $stdout) ⇒ Object

Report results to #io, STDOUT by default.



401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
 
# File 'lib/flog.rb', line 401

def report(io = $stdout)
  io.puts "%8.1f: %s" % [total, "flog total"]
  io.puts "%8.1f: %s" % [average, "flog/method average"]

  return if option[:score]

  max = option[:all] ? nil : total * THRESHOLD
  if option[:group] then
    output_details_grouped io, max
  else
    output_details io, max
  end
ensure
  self.reset
end

#reset ⇒ Object

Reset score data



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

def reset
  @totals     = @total_score = nil
  @multiplier = 1.0
  @calls      = Hash.new { |h,k| h[k] = Hash.new 0 }
end

#score_method(tally) ⇒ Object

Compute the distance formula for a given tally



429
430
431
432
433
434
435
436
437
438
439
 
# File 'lib/flog.rb', line 429

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

#signature ⇒ Object 



441
442
443
 
# File 'lib/flog.rb', line 441

def signature
  "#{klass_name}#{method_name}"
end

#total ⇒ Object

FIX: I hate this indirectness



445
446
447
448
449
 
# File 'lib/flog.rb', line 445

def total # FIX: I hate this indirectness
  totals unless @total_score # calculates total_score as well

  @total_score
end

#totals ⇒ Object

Return the total score and populates @totals.



454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
 
# File 'lib/flog.rb', line 454

def totals
  unless @totals then
    @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

  @totals
end