Class: Flay

Inherits:
Object
  • Object
show all
Defined in:
lib/flay.rb,
lib/flay_erb.rb

Constant Summary collapse

VERSION =

:nodoc:

"2.4.0"
MAX_NODE_SIZE =

:stopdoc:

10
MAX_AVG_MASS =

prevents exponential blowout

12

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(option = nil) ⇒ Flay

Create a new instance of Flay with options.



160
161
162
163
164
165
166
167
168
 
# File 'lib/flay.rb', line 160

def initialize option = nil
  @option = option || Flay.default_options
  @hashes = Hash.new { |h,k| h[k] = [] }

  self.identical      = {}
  self.masses         = {}
  self.total          = 0
  self.mass_threshold = @option[:mass]
end

Instance Attribute Details

#hashes ⇒ Object (readonly)

Returns the value of attribute hashes.



154
155
156
 
# File 'lib/flay.rb', line 154

def hashes
  @hashes
end

#identical ⇒ Object

:stopdoc:



153
154
155
 
# File 'lib/flay.rb', line 153

def identical
  @identical
end

#mass_threshold ⇒ Object

:stopdoc:



153
154
155
 
# File 'lib/flay.rb', line 153

def mass_threshold
  @mass_threshold
end

#masses ⇒ Object

:stopdoc:



153
154
155
 
# File 'lib/flay.rb', line 153

def masses
  @masses
end

#option ⇒ Object (readonly)

Returns the value of attribute option.



154
155
156
 
# File 'lib/flay.rb', line 154

def option
  @option
end

#total ⇒ Object

:stopdoc:



153
154
155
 
# File 'lib/flay.rb', line 153

def total
  @total
end

Class Method Details

.default_options ⇒ Object

Returns the default options.



23
24
25
26
27
28
29
30
31
32
33
34
 
# File 'lib/flay.rb', line 23

def self.default_options
  {
    :diff    => false,
    :mass    => 16,
    :summary => false,
    :verbose => false,
    :number  => true,
    :timeout => 10,
    :liberal => false,
    :fuzzy   => false,
  }
end

.expand_dirs_to_files(*dirs) ⇒ Object

Expands *dirs to all files within that match ruby and rake extensions. – REFACTOR: from flog



115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/flay.rb', line 115

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

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

.load_plugins ⇒ Object

Loads all flay plugins. Files must be named “flog_*.rb”.



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/flay.rb', line 130

def self.load_plugins
  unless defined? @@plugins then
    @@plugins = []

    plugins = Gem.find_files("flay_*.rb").reject { |p| p =~ /flay_task/ }

    plugins.each do |plugin|
      plugin_name = File.basename(plugin, '.rb').sub(/^flay_/, '')
      next if @@plugins.include? plugin_name
      begin
        load plugin
        @@plugins << plugin_name
      rescue LoadError => e
        warn "error loading #{plugin.inspect}: #{e.message}. skipping..."
      end
    end
  end
  @@plugins
rescue
  # ignore
end

.parse_options(args = ARGV) ⇒ Object

Process options in args, defaulting to ARGV.



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

def self.parse_options args = ARGV
  options = self.default_options

  OptionParser.new do |opts|
    opts.banner  = 'flay [options] files_or_dirs'
    opts.version = Flay::VERSION

    opts.separator ""
    opts.separator "Specific options:"
    opts.separator ""

    opts.on('-h', '--help', 'Display this help.') do
      puts opts
      exit
    end

    opts.on('-f', '--fuzzy [DIFF]', Integer,
            "Detect fuzzy (copy & paste) duplication (default 1).") do |n|
      options[:fuzzy] = n || 1
    end

    opts.on('-l', '--liberal', "Use a more liberal detection method.") do
      options[:liberal] = true
    end

    opts.on('-m', '--mass MASS', Integer,
            "Sets mass threshold (default = #{options[:mass]})") do |m|
      options[:mass] = m.to_i
    end

    opts.on('-#', "Don't number output (helps with diffs)") do |m|
      options[:number] = false
    end

    opts.on('-v', '--verbose', "Verbose. Show progress processing files.") do
      options[:verbose] = true
    end

    opts.on('-d', '--diff', "Diff Mode. Display N-Way diff for ruby.") do
      options[:diff] = true
    end

    opts.on('-s', '--summary', "Summarize. Show flay score per file only.") do
      options[:summary] = true
    end

    opts.on('-t', '--timeout TIME', Integer,
            "Set the timeout. (default = #{options[:timeout]})") do |t|
      options[:timeout] = t.to_i
    end

    extensions = ['rb'] + Flay.load_plugins

    opts.separator ""
    opts.separator "Known extensions: #{extensions.join(', ')}"

    extensions.each do |meth|
      msg = "options_#{meth}"
      send msg, opts, options if self.respond_to?(msg)
    end

    begin
      opts.parse! args
    rescue => e
      abort "#{e}\n\n#{opts}"
    end
  end

  options
end

Instance Method Details

#analyze ⇒ Object

Prune, find identical nodes, and update masses.



207
208
209
210
211
212
213
214
215
 
# File 'lib/flay.rb', line 207

def analyze
  self.prune

  self.hashes.each do |hash,nodes|
    identical[hash] = nodes[1..-1].all? { |n| n == nodes.first }
  end

  update_masses
end

#collapse_and_label(ary) ⇒ Object

:nodoc:



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

def collapse_and_label ary # :nodoc:
  ary[0].zip(*ary[1..-1]).map { |lines|
    if lines.uniq.size == 1 then
      "   #{lines.first}"
    else
      lines.reject { |l| l.empty? }.map { |l| "#{l.group}: #{l}" }
    end
  }
end

#n_way_diff(*data) ⇒ Object

Output an n-way diff from data. This is only used if –diff is given.



364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
 
# File 'lib/flay.rb', line 364

def n_way_diff *data
  comments = []
  codes    = []

  split_and_group(data).each do |subdata|
    n = subdata.find_index { |s| s !~ /^#/ }

    comment, code = subdata[0..n-1], subdata[n..-1]
    comment = [] if n == 0

    comments << comment
    codes    << code
  end

  comments = collapse_and_label pad_with_empty_strings comments
  codes    = collapse_and_label pad_with_empty_strings codes

  (comments + codes).flatten.join("\n")
end

#pad_with_empty_strings(ary) ⇒ Object

:nodoc:



394
395
396
397
398
 
# File 'lib/flay.rb', line 394

def pad_with_empty_strings ary # :nodoc:
  max = ary.map { |s| s.size }.max

  ary.map { |a| a + ([""] * (max - a.size)) }
end

#process(*files) ⇒ Object

Process any number of files.



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

def process(*files) # TODO: rename from process - should act as SexpProcessor
  files.each do |file|
    warn "Processing #{file}" if option[:verbose]

    ext = File.extname(file).sub(/^\./, '')
    ext = "rb" if ext.nil? || ext.empty?
    msg = "process_#{ext}"

    unless respond_to? msg then
      warn "  Unknown file type: #{ext}, defaulting to ruby"
      msg = "process_rb"
    end

    begin
      sexp = begin
               send msg, file
             rescue => e
               warn "  #{e.message.strip}"
               warn "  skipping #{file}"
               nil
             end

      next unless sexp

      process_sexp sexp
    rescue SyntaxError => e
      warn "  skipping #{file}: #{e.message}"
    end
  end
end

#process_erb(file) ⇒ Object

Process erb and parse the result. Returns the sexp of the parsed ruby.



13
14
15
16
17
18
19
20
21
22
23
 
# File 'lib/flay_erb.rb', line 13

def process_erb file
  erb = File.read file

  ruby = ERB.new(erb).src
  begin
    RubyParser.new.process(ruby, file)
  rescue => e
    warn ruby if option[:verbose]
    raise e
  end
end

#process_fuzzy(node, difference) ⇒ Object

Process “fuzzy” matches for node. A fuzzy match is a subset of node up to difference elements less than the original.



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

def process_fuzzy node, difference
  return unless node.has_code?

  avg_mass = node.mass / node.size
  return if node.size > MAX_NODE_SIZE or avg_mass > MAX_AVG_MASS

  tmpl, code = node.split_code
  tmpl.modified = true

  (code.size - 1).downto(code.size - difference) do |n|
    code.combination(n).each do |subcode|
      new_node = tmpl + subcode

      next unless new_node.any? { |sub| Sexp === sub }
      next if new_node.mass < self.mass_threshold

      # they're already structurally similar, don't bother adding another
      next if self.hashes[new_node.structural_hash].any? { |sub|
        sub.file == new_node.file and sub.line == new_node.line
      }

      self.hashes[new_node.structural_hash] << new_node
    end
  end
end

#process_rb(file) ⇒ Object

Parse a ruby file and return the sexp.

– TODO: change the system and rename this to parse_rb.



236
237
238
239
240
241
242
 
# File 'lib/flay.rb', line 236

def process_rb file
  begin
    RubyParser.new.process(File.binread(file), file, option[:timeout])
  rescue Timeout::Error
    warn "TIMEOUT parsing #{file}. Skipping."
  end
end

#process_sexp(pt) ⇒ Object

Process a sexp pt.



247
248
249
250
251
252
253
254
255
256
 
# File 'lib/flay.rb', line 247

def process_sexp pt
  pt.deep_each do |node|
    next unless node.any? { |sub| Sexp === sub }
    next if node.mass < self.mass_threshold

    self.hashes[node.structural_hash] << node

    process_fuzzy node, option[:fuzzy] if option[:fuzzy]
  end
end

#prune ⇒ Object

Prunes nodes that aren’t relevant to analysis or are already covered by another node.



297
298
299
300
301
302
303
304
305
 
# File 'lib/flay.rb', line 297

def prune
  # prune trees that aren't duped at all, or are too small
  self.hashes.delete_if { |_,nodes| nodes.size == 1 }
  self.hashes.delete_if { |_,nodes| nodes.all?(&:modified?) }

  return prune_liberally if option[:liberal]

  prune_conservatively
end

#prune_conservatively ⇒ Object

Conservative prune. Remove any bucket that is known to contain a subnode element of a node in another bucket.



311
312
313
314
315
316
317
318
319
320
321
322
323
 
# File 'lib/flay.rb', line 311

def prune_conservatively
  hashes_to_prune = {}

  # extract all subtree hashes from all nodes
  self.hashes.values.each do |nodes|
    nodes.first.all_structural_subhashes.each do |h|
      hashes_to_prune[h] = true
    end
  end

  # nuke subtrees so we show the biggest matching tree possible
  self.hashes.delete_if { |h,_| hashes_to_prune[h] }
end

#prune_liberally ⇒ Object

Liberal prune. Remove any element from a bucket that is known to be a subnode of another node. Removed by identity.



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

def prune_liberally
  update_masses

  hashes_to_prune = Hash.new { |h,k| h[k] = [] }

  # record each subtree by subhash, but skip if subtree mass > parent mass
  self.hashes.values.each do |nodes|
    nodes.each do |node|
      tophash  = node.structural_hash
      topscore = self.masses[tophash]

      node.deep_each do |subnode|
        subhash  = subnode.structural_hash
        subscore = self.masses[subhash]

        next if subscore and subscore > topscore

        hashes_to_prune[subhash] << subnode
      end
    end
  end

  # nuke only individual items by object identity
  self.hashes.each do |h,v|
    v.delete_eql hashes_to_prune[h]
  end

  # nuke buckets we happened to fully empty
  self.hashes.delete_if { |k,v| v.size <= 1 }
end

#report(prune = nil) ⇒ Object

Output the report. Duh.



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

def report prune = nil
  analyze

  puts "Total score (lower is better) = #{self.total}"

  if option[:summary] then
    puts

    self.summary.sort_by { |_,v| -v }.each do |file, score|
      puts "%8.2f: %s" % [score, file]
    end

    return
  end

  count = 0
  sorted = masses.sort_by { |h,m|
    [-m,
     hashes[h].first.file,
     hashes[h].first.line,
     hashes[h].first.first.to_s]
  }
  sorted.each do |hash, mass|
    nodes = hashes[hash]
    next unless nodes.first.first == prune if prune
    puts

    same = identical[hash]
    node = nodes.first
    n = nodes.size
    match, bonus = if same then
                     ["IDENTICAL", "*#{n}"]
                   else
                     ["Similar",   ""]
                   end

    if option[:number] then
      count += 1

      puts "%d) %s code found in %p (mass%s = %d)" %
       [count, match, node.first, bonus, mass]
    else
      puts "%s code found in %p (mass%s = %d)" %
       [match, node.first, bonus, mass]
    end

    nodes.sort_by { |x| [x.file, x.line] }.each_with_index do |x, i|
      if option[:diff] then
        c = (?A.ord + i).chr
        extra = " (FUZZY)" if x.modified?
        puts "  #{c}: #{x.file}:#{x.line}#{extra}"
      else
        extra = " (FUZZY)" if x.modified?
        puts "  #{x.file}:#{x.line}#{extra}"
      end
    end

    if option[:diff] then
      puts
      sources = nodes.map do |s|
        msg = "sexp_to_#{File.extname(s.file).sub(/./, '')}"
        self.respond_to?(msg) ? self.send(msg, s) : sexp_to_rb(s)
      end
      puts n_way_diff(*sources)
    end
  end
end

#sexp_to_rb(sexp) ⇒ Object 



498
499
500
501
502
503
504
505
506
 
# File 'lib/flay.rb', line 498

def sexp_to_rb sexp
  begin
    require 'ruby2ruby'
  rescue LoadError
    return 'ruby2ruby is required for diff'
  end
  @r2r ||= Ruby2Ruby.new
  @r2r.process sexp.deep_clone
end

#split_and_group(ary) ⇒ Object

:nodoc:



384
385
386
387
388
389
390
391
392
 
# File 'lib/flay.rb', line 384

def split_and_group ary # :nodoc:
  ary.each_with_index.map { |s, i|
    c = (?A.ord + i).chr
    s.scan(/^.*/).map { |s2|
      s2.group = c
      s2
    }
  }
end

#summary ⇒ Object

Calculate summary scores on a per-file basis. For –summary.



413
414
415
416
417
418
419
420
421
422
423
424
425
 
# File 'lib/flay.rb', line 413

def summary
  score = Hash.new 0

  masses.each do |hash, mass|
    sexps = hashes[hash]
    mass_per_file = mass.to_f / sexps.size
    sexps.each do |sexp|
      score[sexp.file] += mass_per_file
    end
  end

  score
end

#update_masses ⇒ Object

Reset total and recalculate the masses for all nodes in hashes.



220
221
222
223
224
225
226
227
228
 
# File 'lib/flay.rb', line 220

def update_masses
  self.total = 0
  masses.clear
  self.hashes.each do |hash, nodes|
    masses[hash] = nodes.first.mass * nodes.size
    masses[hash] *= (nodes.size) if identical[hash]
    self.total += masses[hash]
  end
end