flay 2.4.0 → 2.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a86b433cd154d84be7076b6172db4ef1cc399472
+  data.tar.gz: d5443415472f22efc31f9fc91c5c40d144f8aedc
+SHA512:
+  metadata.gz: d258e0487193665da980125c5245ed86415dfdaf4f51f4453044a3e851d0ee619ddf65a607debd07f4f7cd48af0d62697556c53620aa4060de5ce91be806c320
+  data.tar.gz: e578e44ec8118ce4e3dac841910356ed5e344259f47dd08c094734a2d8a1676c4ba2d04b2e9fbf391371ad7ddefc9f5602391b343722f50fc7c2e688ec8ccfe3

checksums.yaml.gz.sig

@@ -0,0 +1 @@
+q}���y`��)sI� �f�ٟw�n��T ƍW�$�%�M�w�/]x��	�Ԗ�q�o�

data/History.txt

@@ -1,3 +1,14 @@
+=== 2.5.0 / 2014-05-29
+
+* 6 minor enhancements:
+
+  * Added Flay::Item and Flay::Location to encapsulate analysis.
+  * Added `--only nodetype` filter flag.
+  * Flay#analyze now returns a nice data structure you can walk over.
+  * Flay#report is now much more dumb. :)
+  * Flay#report now takes an optional IO object.
+  * Removed unused prune arg in Flay#report.
+
 === 2.4.0 / 2013-07-24
 
 * 1 minor enhancement:

data/README.txt

@@ -30,6 +30,7 @@ braces vs do/end, etc are all ignored. Making this totally rad.
 == KNOWN EXTENSIONS:
 
 * flay-actionpack  :: Use Rails ERB handler.
+* flay-js          :: Process JavaScript files.
 * flay-haml        :: Flay your HAML source.
 * flay-persistence :: Persist results across runs. Great for multi-project analysis.
 

data/Rakefile

@@ -1,7 +1,7 @@
 # -*- ruby -*-
 
-require 'rubygems'
-require 'hoe'
+require "rubygems"
+require "hoe"
 
 Hoe::add_include_dirs("../../sexp_processor/dev/lib",
                       "../../ruby_parser/dev/lib",
@@ -11,14 +11,14 @@ Hoe::add_include_dirs("../../sexp_processor/dev/lib",
 
 Hoe.plugin :seattlerb
 
-Hoe.spec 'flay' do
-  developer 'Ryan Davis', 'ryand-ruby@zenspider.com'
+Hoe.spec "flay" do
+  developer "Ryan Davis", "ryand-ruby@zenspider.com"
+  license "MIT"
 
-  self.rubyforge_name = 'seattlerb'
-  self.flay_threshold = 250
+  dependency "sexp_processor", "~> 4.0"
+  dependency "ruby_parser",    "~> 3.0"
 
-  dependency 'sexp_processor', '~> 4.0'
-  dependency 'ruby_parser',    '~> 3.0'
+  self.flay_threshold = 250
 end
 
 task :debug do

data/lib/flay.rb

@@ -15,7 +15,15 @@ class File
 end
 
 class Flay
-  VERSION = "2.4.0" # :nodoc:
+  VERSION = "2.5.0" # :nodoc:
+
+  class Item < Struct.new(:structural_hash, :name, :bonus, :mass, :locations)
+    alias identical? bonus
+  end
+
+  class Location < Struct.new(:file, :line, :fuzzy)
+    alias fuzzy? fuzzy
+  end
 
   ##
   # Returns the default options.
@@ -30,6 +38,7 @@ class Flay
       :timeout => 10,
       :liberal => false,
       :fuzzy   => false,
+      :only   => nil,
     }
   end
 
@@ -74,6 +83,10 @@ class Flay
         options[:verbose] = true
       end
 
+      opts.on('-o', '--only NODE', String, "Only show matches on NODE type.") do |s|
+        options[:only] = s.to_sym
+      end
+
       opts.on('-d', '--diff', "Diff Mode. Display N-Way diff for ruby.") do
         options[:diff] = true
       end
@@ -204,7 +217,7 @@ class Flay
   ##
   # Prune, find identical nodes, and update masses.
 
-  def analyze
+  def analyze filter = nil
     self.prune
 
     self.hashes.each do |hash,nodes|
@@ -212,6 +225,31 @@ class Flay
     end
 
     update_masses
+
+    sorted = masses.sort_by { |h,m|
+      [-m,
+       hashes[h].first.file,
+       hashes[h].first.line,
+       hashes[h].first.first.to_s]
+    }
+
+    sorted.map { |hash, mass|
+      nodes = hashes[hash]
+
+      next unless nodes.first.first == filter if filter
+
+      same  = identical[hash]
+      node  = nodes.first
+      n     = nodes.size
+      bonus = "*#{n}" if same
+
+      locs = nodes.sort_by { |x| [x.file, x.line] }.each_with_index.map { |x, i|
+        extra = :fuzzy if x.modified?
+        Location[x.file, x.line, extra]
+      }
+
+      Item[hash, node.first, bonus, mass, locs]
+    }.compact
   end
 
   ##
@@ -427,70 +465,49 @@ class Flay
   ##
   # Output the report. Duh.
 
-  def report prune = nil
-    analyze
+  def report io = $stdout
+    only = option[:only]
+
+    data = analyze only
 
-    puts "Total score (lower is better) = #{self.total}"
+    io.puts "Total score (lower is better) = #{self.total}"
 
     if option[:summary] then
-      puts
+      io.puts
 
       self.summary.sort_by { |_,v| -v }.each do |file, score|
-        puts "%8.2f: %s" % [score, file]
+        io.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
+    data.each_with_index do |item, count|
+      prefix = "%d) " % (count + 1) if option[:number]
 
-      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
+      match = item.identical? ? "IDENTICAL" : "Similar"
+
+      io.puts
+      io.puts "%s%s code found in %p (mass%s = %d)" %
+        [prefix, match, item.name, item.bonus, item.mass]
+
+      item.locations.each_with_index do |loc, i|
+        loc_prefix = "%s: " % (?A.ord + i).chr if option[:diff]
+        extra = " (FUZZY)" if loc.fuzzy?
+        io.puts "  %s%s:%d%s" % [loc_prefix, loc.file, loc.line, extra]
       end
 
       if option[:diff] then
-        puts
+        io.puts
+
+        nodes = hashes[item.structural_hash]
+
         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)
+
+        io.puts n_way_diff(*sources)
       end
     end
   end

data/test/test_flay.rb

@@ -20,8 +20,8 @@ class TestSexp < Minitest::Test
              s(:lasgn),
              s(:call, s(:arglist))).hash
 
-    assert_equal hash, @s.structural_hash
     assert_equal hash, @s.deep_clone.structural_hash
+    assert_equal hash, @s.structural_hash
   end
 
   def test_delete_eql
@@ -208,23 +208,13 @@ class TestSexp < Minitest::Test
   end
 
   def test_report
-    # make sure we run through options parser
-    $*.clear
-    $* << "--mass=1"
-    $* << "-v"
-
-    opts = nil
-    capture_io do # ignored
-      opts = Flay.parse_options
-    end
-
-    flay = Flay.new opts
+    flay = Flay.new Flay.parse_options %w[--mass=1 -v]
 
     flay.process_sexp DOG_AND_CAT.deep_clone
     flay.analyze
 
     out, err = capture_io do
-      flay.report nil
+      flay.report
     end
 
     exp = <<-END.gsub(/\d+/, "N").gsub(/^ {6}/, "")
@@ -239,25 +229,33 @@ class TestSexp < Minitest::Test
     assert_equal exp, out.gsub(/\d+/, "N")
   end
 
-  def test_report_diff
-    # make sure we run through options parser
-    $*.clear
-    $* << "-d"
-    $* << "--mass=1"
-    $* << "-v"
-
-    opts = nil
-    capture_io do # ignored
-      opts = Flay.parse_options
-    end
+  def test_report_io
+    out = StringIO.new
+    flay = Flay.new Flay.parse_options %w[--mass=1 -v]
 
-    flay = Flay.new opts
+    flay.process_sexp DOG_AND_CAT.deep_clone
+    flay.analyze
+    flay.report out
+
+    exp = <<-END.gsub(/\d+/, "N").gsub(/^ {6}/, "")
+      Total score (lower is better) = 16
+
+      1) Similar code found in :class (mass = 16)
+        (string):1
+        (string):6
+    END
+
+    assert_equal exp, out.string.gsub(/\d+/, "N")
+  end
+
+  def test_report_diff
+    flay = Flay.new Flay.parse_options %w[-d --mass=1 -v]
 
     flay.process_sexp DOG_AND_CAT.deep_clone
     flay.analyze
 
     out, err = capture_io do
-      flay.report nil
+      flay.report
     end
 
     exp = <<-END.gsub(/\d+/, "N").gsub(/^ {6}/, "")
@@ -288,18 +286,7 @@ class TestSexp < Minitest::Test
   end
 
   def test_report_diff_plugin_converter
-    # make sure we run through options parser
-    $*.clear
-    $* << "-d"
-    $* << "--mass=1"
-    $* << "-v"
-
-    opts = nil
-    capture_io do # ignored
-      opts = Flay.parse_options
-    end
-
-    flay = Flay.new opts
+    flay = Flay.new Flay.parse_options %w[-d --mass=1 -v]
 
     flay.process_sexp DOG_AND_CAT.deep_clone
     flay.analyze
@@ -308,7 +295,7 @@ class TestSexp < Minitest::Test
     Flay.send(:define_method, :sexp_to_){|s| "source code #{s.line}"}
 
     out, err = capture_io do
-      flay.report nil
+      flay.report
     end
 
     Flay.send(:remove_method, :sexp_to_)

metadata

@@ -1,24 +1,18 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: flay
-version: !ruby/object:Gem::Version 
-  hash: 31
-  prerelease: 
-  segments: 
-  - 2
-  - 4
-  - 0
-  version: 2.4.0
+version: !ruby/object:Gem::Version
+  version: 2.5.0
 platform: ruby
-authors: 
+authors:
 - Ryan Davis
 autorequire: 
 bindir: bin
-cert_chain: 
+cert_chain:
 - |
   -----BEGIN CERTIFICATE-----
-  MIIDPjCCAiagAwIBAgIBADANBgkqhkiG9w0BAQUFADBFMRMwEQYDVQQDDApyeWFu
+  MIIDPjCCAiagAwIBAgIBATANBgkqhkiG9w0BAQUFADBFMRMwEQYDVQQDDApyeWFu
   ZC1ydWJ5MRkwFwYKCZImiZPyLGQBGRYJemVuc3BpZGVyMRMwEQYKCZImiZPyLGQB
-  GRYDY29tMB4XDTA5MDMwNjE4NTMxNVoXDTEwMDMwNjE4NTMxNVowRTETMBEGA1UE
+  GRYDY29tMB4XDTEzMDkxNjIzMDQxMloXDTE0MDkxNjIzMDQxMlowRTETMBEGA1UE
   AwwKcnlhbmQtcnVieTEZMBcGCgmSJomT8ixkARkWCXplbnNwaWRlcjETMBEGCgmS
   JomT8ixkARkWA2NvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBALda
   b9DCgK+627gPJkB6XfjZ1itoOQvpqH1EXScSaba9/S2VF22VYQbXU1xQXL/WzCkx
@@ -28,106 +22,100 @@ cert_chain:
   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
+  AQCFZ7JTzoy1gcG4d8A6dmOJy7ygtO5MFpRIz8HuKCF5566nOvpy7aHhDDzFmQuu
+  FX3zDU6ghx5cQIueDhf2SGOncyBmmJRRYawm3wI0o1MeN6LZJ/3cRaOTjSFy6+S6
+  zqDmHBp8fVA2TGJtO0BLNkbGVrBJjh0UPmSoGzWlRhEVnYC33TpDAbNA+u39UrQI
+  ynwhNN7YbnmSR7+JU2cUjBFv2iPBO+TGuWC+9L2zn3NHjuc6tnmSYipA9y8Hv+As
+  Y4evBVezr3SjXz08vPqRO5YRdO3zfeMT8gBjRqZjWJGMZ2lD4XNfrs7eky74CyZw
+  xx3n58i0lQkBE1EpKE0lFu/y
   -----END CERTIFICATE-----
-
-date: 2013-07-24 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2014-05-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: sexp_processor
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 27
-        segments: 
-        - 4
-        - 0
-        version: "4.0"
+      - !ruby/object:Gem::Version
+        version: '4.0'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: ruby_parser
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 7
-        segments: 
-        - 3
-        - 0
-        version: "3.0"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: ruby_parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: minitest
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 31
-        segments: 
-        - 5
-        - 0
-        version: "5.0"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '5.3'
   type: :development
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: rdoc
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 27
-        segments: 
-        - 4
-        - 0
-        version: "4.0"
+      - !ruby/object:Gem::Version
+        version: '5.3'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
   type: :development
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  name: hoe
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: hoe
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 9
-        segments: 
-        - 3
-        - 7
-        version: "3.7"
+      - !ruby/object:Gem::Version
+        version: '3.12'
   type: :development
-  version_requirements: *id005
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
 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: 
+email:
 - ryand-ruby@zenspider.com
-executables: 
+executables:
 - flay
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - History.txt
 - Manifest.txt
 - README.txt
-files: 
+files:
+- .gemtest
 - History.txt
 - Manifest.txt
 - README.txt
@@ -138,40 +126,31 @@ files:
 - lib/flay_task.rb
 - lib/gauntlet_flay.rb
 - test/test_flay.rb
-- .gemtest
 homepage: http://ruby.sadi.st/
-licenses: 
+licenses:
 - MIT
+metadata: {}
 post_install_message: 
-rdoc_options: 
+rdoc_options:
 - --main
 - README.txt
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
-rubyforge_project: seattlerb
-rubygems_version: 1.8.25
+rubyforge_project: 
+rubygems_version: 2.2.1
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Flay analyzes code for structural similarities
-test_files: 
+test_files:
 - test/test_flay.rb