flay 1.1.0 → 1.2.0

data/History.txt

@@ -1,13 +1,26 @@
+=== 1.2.0 / 2009-03-09
+
+* 2 major enhancements:
+
+  * Added flay_task.rb
+  * Added plugin system (any flay_(c,java,js,etc).rb files).
+
+* 4 minor enhancements:
+
+  * Added expand_dirs_to_files and made dirs valid arguments.
+  * Added flay_erb.rb plugin.
+  * Added optparse option processing.
+  * Refactored to make using w/in rake and other CI systems clean and easy.
+
 === 1.1.0 / 2009-01-20
 
-* 8 minor enhancement:
+* 7 minor enhancement:
 
   * Added -v verbose mode to print out N-way diff of the detected code.
   * Added identical node scoring and reporting.
-  * Added the start of copy/paste+edit detection, not even close yet
+  * Added the start of copy/paste+edit detection, not even close yet.
   * Added more tests.
   * Added rcov tasks
-  * Added the start of copy/paste+edit detection
   * Clarified output a bit
   * Refactored process_sexps to make doing other languages/systems easier.
 
@@ -16,4 +29,3 @@
 * 1 major enhancement
 
   * Birthday!
-

data/Manifest.txt

@@ -4,4 +4,6 @@ README.txt
 Rakefile
 bin/flay
 lib/flay.rb
-test/test_flay.rb
+lib/flay_erb.rb
+lib/flay_task.rb
+test/test_flay.rb

data/README.txt

@@ -5,23 +5,26 @@
 
 == DESCRIPTION:
 
-Flay analyzes ruby code for structural similarities. Differences in
-literal values, variable, class, method names, whitespace, programming
-style, braces vs do/end, etc are all ignored. Making this totally rad.
+Flay analyzes code for structural similarities. Differences in literal
+values, variable, class, method names, whitespace, programming style,
+braces vs do/end, etc are all ignored. Making this totally rad.
 
 == FEATURES/PROBLEMS:
 
+* Plugin system allows other languages to be flayed.
+  * Ships with .rb and .erb. javascript and others will be available separately.
+* Includes FlayTask for Rakefiles.
 * Differences in literal values, variable, class, and method names are ignored.
 * Differences in whitespace, programming style, braces vs do/end, etc are ignored.
 * Works across files.
 * Reports differences at any level of code.
+* Totally rad.
 * Adds a score multiplier to identical nodes.
 * Run verbose to see an N-way diff of the code.
 
 == TODO:
 
 * Editor integration (emacs, textmate, other contributions welcome).
-* UI improvement suggestions welcome. :)
 * Score sequence fragments (a;b;c;d;e) vs (b;c;d) etc.
 
 == SYNOPSIS:
@@ -77,7 +80,7 @@ style, braces vs do/end, etc are all ignored. Making this totally rad.
 
 (The MIT License)
 
-Copyright (c) 2008 Ryan Davis, Seattle.rb
+Copyright (c) 2008-2009 Ryan Davis, Seattle.rb
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/Rakefile

@@ -12,6 +12,8 @@ Hoe.new('flay', Flay::VERSION) do |flay|
   flay.rubyforge_name = 'seattlerb'
   flay.developer('Ryan Davis', 'ryand-ruby@zenspider.com')
 
+  flay.flay_threshold = 250
+
   flay.extra_deps << ['sexp_processor', '>= 3.0.0']
   flay.extra_deps << ['ruby_parser',    '>= 1.1.0']
 end

data/bin/flay

@@ -1,7 +1,11 @@
-#!/usr/bin/ruby -s
+#!/usr/bin/ruby
 
 require 'flay'
 
-flay = Flay.new($m.to_i)
-flay.process(*ARGV)
+flay = Flay.new Flay.parse_options
+
+ARGV << '.' if ARGV.empty?
+files = Flay.expand_dirs_to_files(*ARGV)
+
+flay.process(*files)
 flay.report

data/lib/flay.rb

@@ -1,44 +1,144 @@
 #!/usr/bin/env ruby -w
 
 $: << "../../ruby_parser/dev/lib"
+$: << "../../ruby2ruby/dev/lib"
 
+require 'optparse'
 require 'rubygems'
 require 'sexp_processor'
 require 'ruby_parser'
-require 'pp' # TODO: remove
 
-$m ||= 16
-$v ||= false
-$f ||= false
-
-if $v then
-  $: << "../../ruby2ruby/dev/lib"
-  require 'ruby2ruby'
-  require 'tempfile'
-end
+abort "update rubygems to >= 1.3.1" unless  Gem.respond_to? :find_files
 
 class Flay
-  VERSION = '1.1.0'
+  VERSION = '1.2.0'
+
+  def self.default_options
+    {
+      :fuzzy   => false,
+      :verbose => false,
+      :mass    => 16,
+    }
+  end
+
+  def self.parse_options
+    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', "Attempt to do fuzzy similarities. (SLOW)") do
+        options[:fuzzy] = true
+      end
+
+      opts.on('-m', '--mass MASS', Integer, "Sets mass threshold") do |m|
+        options[:mass] = m.to_i
+      end
 
-  attr_accessor :mass_threshold
-  attr_reader :hashes
+      opts.on('-v', '--verbose', "Verbose. Display N-Way diff for ruby.") do
+        options[:verbose] = true
+      end
+
+      extensions = ['rb'] + Flay.load_plugins
+
+      opts.separator ""
+      opts.separator "Known extensions: #{extensions.join(', ')}"
+    end.parse!
+
+    options
+  end
+
+  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
+
+  def self.load_plugins
+    plugins = Gem.find_files("flay_*.rb").reject { |path| path =~ /flay_task/ }
+
+    plugins.each do |plugin|
+      begin
+        load plugin
+      rescue LoadError => e
+        warn "error loading #{plugin.inspect}: #{e.message}. skipping..."
+      end
+    end
 
-  def initialize(mass = 16)
+    plugins.map { |f| File.basename(f, '.rb').sub(/^flay_/, '') }
+  end
+
+  attr_accessor :mass_threshold, :total, :identical, :masses
+  attr_reader :hashes, :option
+
+  def initialize option = nil
+    @option = option || Flay.default_options
     @hashes = Hash.new { |h,k| h[k] = [] }
-    @mass_threshold = mass
+
+    self.identical      = {}
+    self.masses         = {}
+    self.total          = 0
+    self.mass_threshold = @option[:mass]
+
+    require 'ruby2ruby' if @option[:verbose]
   end
 
   def process(*files)
     files.each do |file|
       warn "Processing #{file}"
 
-      pt = RubyParser.new.process(File.read(file), file)
-      next unless pt # empty files... hahaha, suck.
+      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
+
+      sexp = begin
+               send msg, file
+             rescue => e
+               warn "  #{e.message.strip}"
+               warn "  skipping #{file}"
+               nil
+             end
+
+      next unless sexp
 
-      process_sexp pt
+      process_sexp sexp
     end
 
-    process_fuzzy_similarities if $f
+    process_fuzzy_similarities if option[:fuzzy]
+
+    self.prune
+
+    self.hashes.each do |hash,nodes|
+      identical[hash] = nodes[1..-1].all? { |n| n == nodes.first }
+      masses[hash] = nodes.first.mass * nodes.size
+      masses[hash] *= (nodes.size) if identical[hash]
+      self.total += masses[hash]
+    end
+  end
+
+  def process_rb file
+    RubyParser.new.process(File.read(file), file)
   end
 
   def process_sexp pt
@@ -136,19 +236,11 @@ class Flay
   end
 
   def report prune = nil
-    self.prune
-
-    identical = {}
-    masses = {}
-
-    self.hashes.each do |hash,nodes|
-      identical[hash] = nodes[1..-1].all? { |n| n == nodes.first }
-      masses[hash] = nodes.first.mass * nodes.size
-      masses[hash] *= (nodes.size) if identical[hash]
-    end
+    puts "Total score (lower is better) = #{self.total}"
+    puts
 
     count = 0
-    masses.sort_by { |h,m| [-m, hashes[h].first.file] }.each do |hash,mass|
+    masses.sort_by { |h,m| [-m, hashes[h].first.file] }.each do |hash, mass|
       nodes = hashes[hash]
       next unless nodes.first.first == prune if prune
       puts
@@ -167,7 +259,7 @@ class Flay
         [count, match, node.first, bonus, mass]
 
       nodes.each_with_index do |node, i|
-        if $v then
+        if option[:verbose] then
           c = (?A + i).chr
           puts "  #{c}: #{node.file}:#{node.line}"
         else
@@ -175,7 +267,7 @@ class Flay
         end
       end
 
-      if $v then
+      if option[:verbose] then
         puts
         r2r = Ruby2Ruby.new
         puts n_way_diff(*nodes.map { |s| r2r.process(s.deep_clone) })

data/lib/flay_erb.rb

@@ -0,0 +1,14 @@
+#!/usr/bin/ruby
+
+require 'rubygems'
+require 'flay'
+require 'erb'
+
+class Flay
+  def process_erb file
+    erb = File.read file
+
+    src = ERB.new(erb).src
+    RubyParser.new.process(src, file)
+  end
+end

data/lib/flay_task.rb

@@ -0,0 +1,31 @@
+class FlayTask < Rake::TaskLib
+  attr_accessor :name
+  attr_accessor :dirs
+  attr_accessor :threshold
+  attr_accessor :verbose
+
+  def initialize name = :flay, threshold = 200, dirs = nil
+    @name      = name
+    @dirs      = dirs || %w(app lib test spec)
+    @threshold = threshold
+    @verbose   = Rake.application.options.trace
+
+    yield self if block_given?
+
+    @dirs.reject! { |f| ! File.directory? f }
+
+    define
+  end
+
+  def define
+    desc "Analyze for code duplication in: #{dirs.join(', ')}"
+    task name do
+      flay = Flay.new
+      flay.process(*Flay.expand_dirs_to_files(dirs))
+      flay.report if verbose
+
+      raise "Flay total too high! #{flay.total} > #{threshold}" if flay.total > threshold
+    end
+    self
+  end
+end

data/test/test_flay.rb

@@ -107,7 +107,7 @@ class TestSexp < Test::Unit::TestCase
   end
 
   def test_process_sexp_full
-    flay = Flay.new(1)
+    flay = Flay.new(:mass => 1)
 
     s = RubyParser.new.process <<-RUBY
       def x(n)
@@ -137,14 +137,14 @@ class TestSexp < Test::Unit::TestCase
   end
 
   def test_process_sexp_no_structure
-    flay = Flay.new(1)
+    flay = Flay.new(:mass => 1)
     flay.process_sexp s(:lit, 1)
 
     assert flay.hashes.empty?
   end
 
   def test_process_fuzzy_similarities
-    flay = Flay.new 7
+    flay = Flay.new :mass => 7
 
     s1 = RubyParser.new.process("def w(n); a; b; c; d; e; end")
     s2 = RubyParser.new.process("def x(n); a;    c;    e; end")
@@ -161,7 +161,7 @@ class TestSexp < Test::Unit::TestCase
   end
 
   def test_process_fuzzy_similarities_2
-    flay = Flay.new 7
+    flay = Flay.new :mass => 7
 
     s1 = RubyParser.new.process("def w(n); a; b; c; d; e; end")
     s2 = RubyParser.new.process("def x(n); a;    c;    e; end")
@@ -181,7 +181,7 @@ class TestSexp < Test::Unit::TestCase
   end
 
   def test_process_fuzzy_similarities_3
-    flay = Flay.new 7
+    flay = Flay.new :mass => 7
 
     s1 = RubyParser.new.process("def w (n); a; b;      c; d;      e; end")
     s2 = RubyParser.new.process("def x (n); a;         c;         e; end")

metadata

@@ -1,15 +1,36 @@
 --- !ruby/object:Gem::Specification 
 name: flay
 version: !ruby/object:Gem::Version 
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors: 
 - Ryan Davis
 autorequire: 
 bindir: bin
-cert_chain: []
+cert_chain: 
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIDPjCCAiagAwIBAgIBADANBgkqhkiG9w0BAQUFADBFMRMwEQYDVQQDDApyeWFu
+  ZC1ydWJ5MRkwFwYKCZImiZPyLGQBGRYJemVuc3BpZGVyMRMwEQYKCZImiZPyLGQB
+  GRYDY29tMB4XDTA5MDMwNjE4NTMxNVoXDTEwMDMwNjE4NTMxNVowRTETMBEGA1UE
+  AwwKcnlhbmQtcnVieTEZMBcGCgmSJomT8ixkARkWCXplbnNwaWRlcjETMBEGCgmS
+  JomT8ixkARkWA2NvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBALda
+  b9DCgK+627gPJkB6XfjZ1itoOQvpqH1EXScSaba9/S2VF22VYQbXU1xQXL/WzCkx
+  taCPaLmfYIaFcHHCSY4hYDJijRQkLxPeB3xbOfzfLoBDbjvx5JxgJxUjmGa7xhcT
+  oOvjtt5P8+GSK9zLzxQP0gVLS/D0FmoE44XuDr3iQkVS2ujU5zZL84mMNqNB1znh
+  GiadM9GHRaDiaxuX0cIUBj19T01mVE2iymf9I6bEsiayK/n6QujtyCbTWsAS9Rqt
+  qhtV7HJxNKuPj/JFH0D2cswvzznE/a5FOYO68g+YCuFi5L8wZuuM8zzdwjrWHqSV
+  gBEfoTEGr7Zii72cx+sCAwEAAaM5MDcwCQYDVR0TBAIwADALBgNVHQ8EBAMCBLAw
+  HQYDVR0OBBYEFEfFe9md/r/tj/Wmwpy+MI8d9k/hMA0GCSqGSIb3DQEBBQUAA4IB
+  AQAY59gYvDxqSqgC92nAP9P8dnGgfZgLxP237xS6XxFGJSghdz/nI6pusfCWKM8m
+  vzjjH2wUMSSf3tNudQ3rCGLf2epkcU13/rguI88wO6MrE0wi4ZqLQX+eZQFskJb/
+  w6x9W1ur8eR01s397LSMexySDBrJOh34cm2AlfKr/jokKCTwcM0OvVZnAutaovC0
+  l1SVZ0ecg88bsWHA0Yhh7NFxK1utWoIhtB6AFC/+trM0FQEB/jZkIS8SaNzn96Rl
+  n0sZEf77FLf5peR8TP/PtmIg7Cyqz23sLM4mCOoTGIy5OcZ8TdyiyINUHtb5ej/T
+  FBHgymkyj/AOSqKRIpXPhjC6
+  -----END CERTIFICATE-----
 
-date: 2009-01-20 00:00:00 -08:00
+date: 2009-03-09 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -40,9 +61,9 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.8.2
+        version: 1.10.0
     version: 
-description: Flay analyzes ruby code for structural similarities. Differences in literal values, variable, class, method names, whitespace, programming style, braces vs do/end, etc are all ignored. Making this totally rad.
+description: Flay analyzes code for structural similarities. Differences in literal values, variable, class, method names, whitespace, programming style, braces vs do/end, etc are all ignored. Making this totally rad.
 email: 
 - ryand-ruby@zenspider.com
 executables: 
@@ -60,6 +81,8 @@ files:
 - Rakefile
 - bin/flay
 - lib/flay.rb
+- lib/flay_erb.rb
+- lib/flay_task.rb
 - test/test_flay.rb
 has_rdoc: true
 homepage: http://ruby.sadi.st/
@@ -87,6 +110,6 @@ rubyforge_project: seattlerb
 rubygems_version: 1.3.1
 signing_key: 
 specification_version: 2
-summary: Flay analyzes ruby code for structural similarities
+summary: Flay analyzes code for structural similarities
 test_files: 
 - test/test_flay.rb

metadata.gz.sig

@@ -0,0 +1 @@
+�B�쑊 �u�4`. �,�*s�O