flay 2.2.0 → 2.3.0

data/History.txt

@@ -1,3 +1,14 @@
+=== 2.3.0 / 2013-05-10
+
+* 2 minor enhancements:
+
+  * Refactored n_way_diff into split_and_group, collapse_and_label, and pad_with_empty_strings.
+  * n_way_diff now does leading comments separately from the code, to better align diffs.
+
+* 1 bug fix:
+
+  * Fixed code/home urls in readme/gem.
+
 === 2.2.0 / 2013-04-09
 
 Semantic versioning doesn't take into account how AWESOME a release

data/README.txt

@@ -1,7 +1,7 @@
 = flay
 
 home :: http://ruby.sadi.st/
-repo :: https://github.com/seattlerb/flay
+code :: https://github.com/seattlerb/flay
 rdoc :: http://seattlerb.rubyforge.org/flay
 
 == DESCRIPTION:
@@ -22,10 +22,16 @@ braces vs do/end, etc are all ignored. Making this totally rad.
 * Provides conservative (default) and --liberal pruning options.
 * Provides --fuzzy duplication detection.
 * Language independent: Plugin system allows other languages to be flayed.
-  * Ships with .rb and .erb. javascript and others will be available separately.
+  * Ships with .rb and .erb.
+  * javascript and others will be available separately.
 * Includes FlayTask for Rakefiles.
 * Totally rad.
 
+== KNOWN EXTENSIONS:
+
+* flay-haml        :: Flay your HAML source.
+* flay-persistence :: Persist results across runs. Great for multi-project analysis.
+
 == TODO:
 
 * Editor integration (emacs, textmate, other contributions welcome).
@@ -34,11 +40,11 @@ braces vs do/end, etc are all ignored. Making this totally rad.
 
   % flay -v --diff ~/Work/svn/ruby/ruby_1_8/lib/cgi.rb
   Processing /Users/ryan/Work/svn/ruby/ruby_1_8/lib/cgi.rb...
-  
+
   Matches found in :defn (mass = 184)
     A: /Users/ryan/Work/svn/ruby/ruby_1_8/lib/cgi.rb:1470
     B: /Users/ryan/Work/svn/ruby/ruby_1_8/lib/cgi.rb:1925
-  
+
   A: def checkbox_group(name = "", *values)
   B: def radio_group(name = "", *values)
        if name.kind_of?(Hash) then
@@ -60,11 +66,11 @@ braces vs do/end, etc are all ignored. Making this totally rad.
          end
        end.to_s
      end
-  
+
   IDENTICAL Matches found in :for (mass*2 = 144)
     A: /Users/ryan/Work/svn/ruby/ruby_1_8/lib/cgi.rb:2160
     B: /Users/ryan/Work/svn/ruby/ruby_1_8/lib/cgi.rb:2217
-  
+
      for element in ["HTML", "BODY", "P", "DT", "DD", "LI", "OPTION", "THEAD", "TFOOT", "TBODY", "COLGROUP", "TR", "TH", "TD", "HEAD"] do
        methods = (methods + (("          def #{element.downcase}(attributes = {})\n" + nO_element_def(element)) + "          end\n"))
      end

data/lib/flay.rb

@@ -15,7 +15,7 @@ class File
 end
 
 class Flay
-  VERSION = "2.2.0" # :nodoc:
+  VERSION = "2.3.0" # :nodoc:
 
   ##
   # Returns the default options.
@@ -311,17 +311,17 @@ class Flay
   # subnode element of a node in another bucket.
 
   def prune_conservatively
-    all_hashes = {}
+    hashes_to_prune = {}
 
     # extract all subtree hashes from all nodes
     self.hashes.values.each do |nodes|
       nodes.first.all_structural_subhashes.each do |h|
-        all_hashes[h] = true
+        hashes_to_prune[h] = true
       end
     end
 
     # nuke subtrees so we show the biggest matching tree possible
-    self.hashes.delete_if { |h,_| all_hashes[h] }
+    self.hashes.delete_if { |h,_| hashes_to_prune[h] }
   end
 
   ##
@@ -331,7 +331,7 @@ class Flay
   def prune_liberally
     update_masses
 
-    all_hashes = Hash.new { |h,k| h[k] = [] }
+    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|
@@ -345,14 +345,14 @@ class Flay
 
           next if subscore and subscore > topscore
 
-          all_hashes[subhash] << subnode
+          hashes_to_prune[subhash] << subnode
         end
       end
     end
 
     # nuke only individual items by object identity
     self.hashes.each do |h,v|
-      v.delete_eql all_hashes[h]
+      v.delete_eql hashes_to_prune[h]
     end
 
     # nuke buckets we happened to fully empty
@@ -364,34 +364,48 @@ class Flay
   # given.
 
   def n_way_diff *data
-    data.each_with_index do |s, i|
-      c = (?A.ord + i).chr
-      s.group = c
+    comments = []
+    codes    = []
+
+    split_and_group(data).each do |subdata|
+      n = subdata.find_index { |s| s !~ /^#/ }
+
+      comment, code = subdata[0..n-1], subdata[n..-1]
+
+      comments << comment
+      codes    << code
     end
 
-    max = data.map { |s| s.scan(/^.*/).size }.max
+    comments = collapse_and_label pad_with_empty_strings comments
+    codes    = collapse_and_label pad_with_empty_strings codes
 
-    data.map! { |s| # FIX: this is tarded, but I'm out of brain
-      c = s.group
-      s = s.scan(/^.*/)
-      s.push(*([""] * (max - s.size))) # pad
-      s.each do |o|
-        o.group = c
-      end
-      s
+    (comments + codes).flatten.join("\n")
+  end
+
+  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
+
+  def pad_with_empty_strings ary # :nodoc:
+    max = ary.map { |s| s.size }.max
+
+    ary.map { |a| a + ([""] * (max - a.size)) }
+  end
 
-    groups = data[0].zip(*data[1..-1])
-    groups.map! { |lines|
-      collapsed = lines.uniq
-      if collapsed.size == 1 then
+  def collapse_and_label ary # :nodoc:
+    ary[0].zip(*ary[1..-1]).map { |lines|
+      if lines.uniq.size == 1 then
         "   #{lines.first}"
       else
-        # TODO: make r2r have a canonical mode (doesn't make 1-liners)
         lines.reject { |l| l.empty? }.map { |l| "#{l.group}: #{l}" }
       end
     }
-    groups.flatten.join("\n")
   end
 
   ##

data/test/test_flay.rb

@@ -65,11 +65,21 @@ class TestSexp < MiniTest::Unit::TestCase
   end
 
   DOG_AND_CAT = Ruby18Parser.new.process <<-RUBY
+    ##
+    # I am a dog.
+
     class Dog
       def x
         return "Hello"
       end
     end
+
+    ##
+    # I
+    # am
+    # a
+    # cat.
+
     class Cat
       def y
         return "Hello"
@@ -198,6 +208,38 @@ class TestSexp < MiniTest::Unit::TestCase
   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.process_sexp DOG_AND_CAT.deep_clone
+    flay.analyze
+
+    out, err = capture_io do
+      flay.report nil
+    end
+
+    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 '', err
+    assert_equal exp, out.gsub(/\d+/, "N")
+  end
+
+  def test_report_diff
     # make sure we run through options parser
     $*.clear
     $* << "-d"
@@ -225,6 +267,13 @@ class TestSexp < MiniTest::Unit::TestCase
         A: (string):1
         B: (string):6
 
+         ##
+      A: # I am a dog.
+      B: # I
+      B: # am
+      B: # a
+      B: # cat.
+
       A: class Dog
       B: class Cat
       A:   def x
@@ -235,6 +284,108 @@ class TestSexp < MiniTest::Unit::TestCase
     END
 
     assert_equal '', err
-    assert_equal exp, out.gsub(/\d+/, "N")
+    assert_equal exp, out.gsub(/\d+/, "N").gsub(/^ {3}$/, "")
+  end
+
+  def test_n_way_diff
+    dog_and_cat = ["##\n# I am a dog.\n\nclass Dog\n  def x\n    return \"Hello\"\n  end\nend",
+                   "##\n# I\n#\n# am\n# a\n# cat.\n\nclass Cat\n  def y\n    return \"Hello\"\n  end\nend"]
+
+    flay = Flay.new
+
+    exp = <<-EOM.gsub(/\d+/, "N").gsub(/^ {6}/, "").chomp
+         ##
+      A: # I am a dog.
+      B: # I
+      B: #
+      B: # am
+      B: # a
+      B: # cat.
+
+      A: class Dog
+      B: class Cat
+      A:   def x
+      B:   def y
+             return \"Hello\"
+           end
+         end
+    EOM
+
+    assert_equal exp, flay.n_way_diff(*dog_and_cat).gsub(/^ {3}$/, "")
+  end
+
+  def test_split_and_group
+    flay = Flay.new
+
+    act = flay.split_and_group ["a\nb\nc", "d\ne\nf"]
+    exp = [%w(a b c), %w(d e f)]
+
+    assert_equal exp, act
+    assert_equal [%w(A A A), %w(B B B)], act.map { |a| a.map { |s| s.group } }
+  end
+
+  def test_pad_with_empty_strings
+    flay = Flay.new
+
+    a = %w(a b c)
+    b = %w(d)
+
+    assert_equal [a, ["d", "", ""]], flay.pad_with_empty_strings([a, b])
+  end
+
+  def test_pad_with_empty_strings_same
+    flay = Flay.new
+
+    a = %w(a b c)
+    b = %w(d e f)
+
+    assert_equal [a, b], flay.pad_with_empty_strings([a, b])
+  end
+
+  def test_collapse_and_label
+    flay = Flay.new
+
+    a = %w(a b c).map { |s| s.group = "A"; s }
+    b = %w(d b f).map { |s| s.group = "B"; s }
+
+    exp = [["A: a", "B: d"], "   b", ["A: c", "B: f"]]
+
+    assert_equal exp, flay.collapse_and_label([a, b])
+  end
+
+  def test_collapse_and_label_same
+    flay = Flay.new
+
+    a = %w(a b c).map { |s| s.group = "A"; s }
+    b = %w(a b c).map { |s| s.group = "B"; s }
+
+    exp = ["   a", "   b", "   c"]
+
+    assert_equal exp, flay.collapse_and_label([a, b])
+  end
+
+  def test_n_way_diff_methods
+    dog_and_cat = ["##\n# I am a dog.\n\ndef x\n  return \"Hello\"\nend",
+                   "##\n# I\n#\n# am\n# a\n# cat.\n\ndef y\n  return \"Hello\"\nend"]
+
+    opts = Flay.parse_options
+    flay = Flay.new opts
+
+    exp = <<-EOM.gsub(/\d+/, "N").gsub(/^ {6}/, "").chomp
+         ##
+      A: # I am a dog.
+      B: # I
+      B: #
+      B: # am
+      B: # a
+      B: # cat.
+
+      A: def x
+      B: def y
+           return \"Hello\"
+         end
+    EOM
+
+    assert_equal exp, flay.n_way_diff(*dog_and_cat).gsub(/^ {3}$/, "")
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: flay
 version: !ruby/object:Gem::Version 
-  hash: 7
+  hash: 3
   prerelease: 
   segments: 
   - 2
-  - 2
+  - 3
   - 0
-  version: 2.2.0
+  version: 2.3.0
 platform: ruby
 authors: 
 - Ryan Davis
@@ -36,7 +36,7 @@ cert_chain:
   FBHgymkyj/AOSqKRIpXPhjC6
   -----END CERTIFICATE-----
 
-date: 2013-04-10 00:00:00 Z
+date: 2013-05-10 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: sexp_processor
@@ -76,11 +76,11 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 21
+        hash: 31
         segments: 
-        - 4
-        - 7
-        version: "4.7"
+        - 5
+        - 0
+        version: "5.0"
   type: :development
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
@@ -106,11 +106,11 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 13
+        hash: 11
         segments: 
         - 3
-        - 5
-        version: "3.5"
+        - 6
+        version: "3.6"
   type: :development
   version_requirements: *id005
 description: |-