flay 2.5.0 → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a86b433cd154d84be7076b6172db4ef1cc399472
-  data.tar.gz: d5443415472f22efc31f9fc91c5c40d144f8aedc
+  metadata.gz: f618784f99890722c0400a5d9bb2724fd2b07758
+  data.tar.gz: 40359e7d4fb354939fb424d03b90ae16f8b2624a
 SHA512:
-  metadata.gz: d258e0487193665da980125c5245ed86415dfdaf4f51f4453044a3e851d0ee619ddf65a607debd07f4f7cd48af0d62697556c53620aa4060de5ce91be806c320
-  data.tar.gz: e578e44ec8118ce4e3dac841910356ed5e344259f47dd08c094734a2d8a1676c4ba2d04b2e9fbf391371ad7ddefc9f5602391b343722f50fc7c2e688ec8ccfe3
+  metadata.gz: 3bc71abbe2ed73ec4ef380e8441587fe601560a88571330500db0bda26e786708abedb8aa376cde0b977a87ab71d71fb7bf839d7d7aac877f4675c3f55f928e8
+  data.tar.gz: 5962022a8e28b9fbd06455663c34dd8973e1d1c87c7ac4e3282dd4edf178b5bdd3f4cf2cfbfd27cadfc4184bc13f8610c6fca5ce904dba89d56213c60ea8cc0c

checksums.yaml.gz.sig

@@ -1 +1,2 @@
-q}���y`��)sI� �f�ٟw�n��T ƍW�$�%�M�w�/]x��	�Ԗ�q�o�
+�,v��e���2N�o'L㵵�� �@4!z���ʘ���фu2㤂G��SYC�i��0r��H[F
+R��IwjH��?��jQ�����Eh�h�H�����رy�k��;V���vP�V?>s3]ˇ+™Wm�*8N��Ql2���v�6X �H������<Y�==t�M���<,�(3JM��]Ah�TVp͖X�_���?�?_�o0�o~����8�޹�B�N�t��~\�U|�����/Ys�ѯ
�~A�z���F�����

data/History.txt

@@ -1,3 +1,10 @@
+=== 2.6.0 / 2015-01-09
+
+* 2 minor enhancements:
+
+  * Added support for .flayignore files. (kcdragon)
+  * Added Flay.filter_files(files, ignore_path_or_io).
+
 === 2.5.0 / 2014-05-29
 
 * 6 minor enhancements:

data/README.txt

@@ -25,6 +25,7 @@ braces vs do/end, etc are all ignored. Making this totally rad.
   * Ships with .rb and .erb.
   * javascript and others will be available separately.
 * Includes FlayTask for Rakefiles.
+* Skips files matched via patterns in .flayignore (subset format of .gitignore).
 * Totally rad.
 
 == KNOWN EXTENSIONS:
@@ -38,6 +39,9 @@ braces vs do/end, etc are all ignored. Making this totally rad.
 
 * Editor integration (emacs, textmate, other contributions welcome).
 
+* Vim integration started (https://github.com/prophittcorey/vim-flay)
+    - Flays the current file on save, load, or on command
+
 == SYNOPSIS:
 
   % flay -v --diff ~/Work/svn/ruby/ruby_1_8/lib/cgi.rb

data/Rakefile

@@ -28,11 +28,13 @@ task :debug do
   mass = ENV["M"]
   diff = ENV["D"]
   libr = ENV["L"]
+  ver  = ENV["V"]
 
   opts = Flay.parse_options
   opts[:mass] = mass.to_i if mass
   opts[:diff] = diff.to_i if diff
   opts[:liberal] = true if libr
+  opts[:verbose] = true if ver
 
   flay = Flay.new opts
   flay.process(*Flay.expand_dirs_to_files(file))

data/bin/flay

@@ -4,7 +4,7 @@ require 'flay'
 
 flay = Flay.new Flay.parse_options
 
-files = Flay.expand_dirs_to_files(*ARGV)
+files = Flay.filter_files Flay.expand_dirs_to_files(*ARGV)
 
 flay.process(*files)
 flay.report

data/lib/flay.rb

@@ -1,10 +1,10 @@
 #!/usr/bin/env ruby -w
 
-require 'optparse'
-require 'rubygems'
-require 'sexp_processor'
-require 'ruby_parser'
-require 'timeout'
+require "optparse"
+require "rubygems"
+require "sexp_processor"
+require "ruby_parser"
+require "timeout"
 
 class File
   RUBY19 = "<3".respond_to? :encoding unless defined? RUBY19 # :nodoc:
@@ -15,7 +15,7 @@ class File
 end
 
 class Flay
-  VERSION = "2.5.0" # :nodoc:
+  VERSION = "2.6.0" # :nodoc:
 
   class Item < Struct.new(:structural_hash, :name, :bonus, :mass, :locations)
     alias identical? bonus
@@ -49,61 +49,61 @@ class Flay
     options = self.default_options
 
     OptionParser.new do |opts|
-      opts.banner  = 'flay [options] files_or_dirs'
+      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
+      opts.on("-h", "--help", "Display this help.") do
         puts opts
         exit
       end
 
-      opts.on('-f', '--fuzzy [DIFF]', Integer,
+      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
+      opts.on("-l", "--liberal", "Use a more liberal detection method.") do
         options[:liberal] = true
       end
 
-      opts.on('-m', '--mass MASS', Integer,
+      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|
+      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
+      opts.on("-v", "--verbose", "Verbose. Show progress processing files.") do
         options[:verbose] = true
       end
 
-      opts.on('-o', '--only NODE', String, "Only show matches on NODE type.") do |s|
+      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
+      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
+      opts.on("-s", "--summary", "Summarize. Show flay score per file only.") do
         options[:summary] = true
       end
 
-      opts.on('-t', '--timeout TIME', Integer,
+      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
+      extensions = ["rb"] + Flay.load_plugins
 
       opts.separator ""
-      opts.separator "Known extensions: #{extensions.join(', ')}"
+      opts.separator "Known extensions: #{extensions.join(", ")}"
 
       extensions.each do |meth|
         msg = "options_#{meth}"
@@ -126,15 +126,51 @@ class Flay
   # REFACTOR: from flog
 
   def self.expand_dirs_to_files *dirs
-    extensions = ['rb'] + Flay.load_plugins
+    extensions = ["rb"] + Flay.load_plugins
 
     dirs.flatten.map { |p|
       if File.directory? p then
-        Dir[File.join(p, '**', "*.{#{extensions.join(',')}}")]
+        Dir[File.join(p, "**", "*.{#{extensions.join(",")}}")]
       else
         p
       end
-    }.flatten
+    }.flatten.map { |s| s[/^(\.\/)?/] = ""; s } # strip "./" from paths
+  end
+
+  # so I can move this to flog wholesale
+  DEFAULT_IGNORE = ".flayignore" # :nodoc:
+
+  ##
+  # A file filter mechanism similar to, but not as extensive as,
+  # .gitignore files:
+  #
+  # + If a pattern does not contain a slash, it is treated as a shell glob.
+  # + If a pattern ends in a slash, it matches on directories (and contents).
+  # + Otherwise, it matches on relative paths.
+  #
+  # File.fnmatch is used throughout, so glob patterns work for all 3 types.
+
+  def self.filter_files files, ignore = DEFAULT_IGNORE
+    ignore_paths = if ignore.respond_to? :read then
+                     ignore.read
+                   elsif File.exists? ignore then
+                     File.read ignore
+                   end
+
+    if ignore_paths then
+      nonglobs, globs = ignore_paths.split("\n").partition { |p| p.include? "/" }
+      dirs, ifiles    = nonglobs.partition { |p| p.end_with? "/" }
+      dirs            = dirs.map { |s| s.chomp "/" }
+
+      only_paths = File::FNM_PATHNAME
+      files = files.reject { |f|
+        dirs.any?     { |i| File.fnmatch?(i, File.dirname(f), only_paths) } ||
+          globs.any?  { |i| File.fnmatch?(i, f) } ||
+          ifiles.any? { |i| File.fnmatch?(i, f, only_paths) }
+      }
+    end
+
+    files
   end
 
   ##
@@ -147,7 +183,7 @@ class Flay
       plugins = Gem.find_files("flay_*.rb").reject { |p| p =~ /flay_task/ }
 
       plugins.each do |plugin|
-        plugin_name = File.basename(plugin, '.rb').sub(/^flay_/, '')
+        plugin_name = File.basename(plugin, ".rb").sub(/^flay_/, "")
         next if @@plugins.include? plugin_name
         begin
           load plugin
@@ -187,7 +223,7 @@ class Flay
     files.each do |file|
       warn "Processing #{file}" if option[:verbose]
 
-      ext = File.extname(file).sub(/^\./, '')
+      ext = File.extname(file).sub(/^\./, "")
       ext = "rb" if ext.nil? || ext.empty?
       msg = "process_#{ext}"
 
@@ -318,7 +354,7 @@ class Flay
         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
+        # 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
         }
@@ -503,7 +539,7 @@ class Flay
         nodes = hashes[item.structural_hash]
 
         sources = nodes.map do |s|
-          msg = "sexp_to_#{File.extname(s.file).sub(/./, '')}"
+          msg = "sexp_to_#{File.extname(s.file).sub(/./, "")}"
           self.respond_to?(msg) ? self.send(msg, s) : sexp_to_rb(s)
         end
 
@@ -514,9 +550,9 @@ class Flay
 
   def sexp_to_rb sexp
     begin
-      require 'ruby2ruby'
+      require "ruby2ruby"
     rescue LoadError
-      return 'ruby2ruby is required for diff'
+      return "ruby2ruby is required for diff"
     end
     @r2r ||= Ruby2Ruby.new
     @r2r.process sexp.deep_clone

data/lib/flay_erb.rb

@@ -1,8 +1,8 @@
 #!/usr/bin/ruby
 
-require 'rubygems'
-require 'flay'
-require 'erb'
+require "rubygems"
+require "flay"
+require "erb"
 
 class Flay
 

data/lib/flay_task.rb

@@ -40,11 +40,12 @@ class FlayTask < Rake::TaskLib
   # Defines the flay task.
 
   def define
-    desc "Analyze for code duplication in: #{dirs.join(', ')}"
+    desc "Analyze for code duplication in: #{dirs.join(", ")}"
     task name do
       require "flay"
       flay = Flay.new
-      flay.process(*Flay.expand_dirs_to_files(dirs))
+      files = Flay.filter_files Flay.expand_dirs_to_files dirs
+      flay.process(*files)
       flay.report if verbose
 
       raise "Flay total too high! #{flay.total} > #{threshold}" if

data/lib/gauntlet_flay.rb

@@ -1,24 +1,24 @@
 #!/usr/bin/ruby -ws
 
-$: << 'lib' << '../../ParseTree/dev/lib' << '../../flay/dev/lib'
+$: << "lib" << "../../ParseTree/dev/lib" << "../../flay/dev/lib"
 
 $v ||= false # HACK
 
-require 'rubygems'
-require 'flay'
+require "rubygems"
+require "flay"
 
-require 'gauntlet'
-require 'pp'
+require "gauntlet"
+require "pp"
 
 # :stopdoc:
 class FlayGauntlet < Gauntlet
   $owners       = {}
-  $score_file   = 'flay-scores.yml'
+  $score_file   = "flay-scores.yml"
   $misc_error   = {:total => -1, :average => -1, :methods => {}}
   $syntax_error = {:total => -2, :average => -2, :methods => {}}
   $no_gem       = {:total => -4, :average => -4, :methods => {}}
 
-  # copied straight from hoedown.rb 
+  # copied straight from hoedown.rb
   my_projects = %w[InlineFortran ParseTree RubyInline RubyToC
                    ZenHacks ZenTest bfts box_layout
                    change_class flay flog gauntlet heckle
@@ -31,7 +31,7 @@ class FlayGauntlet < Gauntlet
 
   def run name
     warn name
-    self.data[name] = score_for '.'
+    self.data[name] = score_for "."
     self.dirty = true
   end
 

data/test/test_flay.rb

@@ -1,7 +1,8 @@
 #!/usr/bin/ruby -w
 
-require 'minitest/autorun'
-require 'flay'
+require "minitest/autorun"
+require "flay"
+require "tmpdir"
 
 $: << "../../sexp_processor/dev/lib"
 
@@ -225,7 +226,7 @@ class TestSexp < Minitest::Test
         (string):6
     END
 
-    assert_equal '', err
+    assert_equal "", err
     assert_equal exp, out.gsub(/\d+/, "N")
   end
 
@@ -281,7 +282,7 @@ class TestSexp < Minitest::Test
          end
     END
 
-    assert_equal '', err
+    assert_equal "", err
     assert_equal exp, out.gsub(/\d+/, "N").gsub(/^ {3}$/, "")
   end
 
@@ -311,7 +312,7 @@ class TestSexp < Minitest::Test
       B: source code 6
     END
 
-    assert_equal '', err
+    assert_equal "", err
     assert_equal exp, out.gsub(/\d+/, "N").gsub(/^ {3}$/, "")
   end
 
@@ -435,4 +436,46 @@ class TestSexp < Minitest::Test
 
     assert_equal exp, flay.n_way_diff(*dog_and_cat).gsub(/^ {3}$/, "")
   end
+
+  def test_cls_expand_dirs_to_files
+    Dir.mktmpdir do |dir|
+      Dir.chdir dir do
+        FileUtils.touch "dog_and_cat.rb"
+
+        files = Flay.expand_dirs_to_files "."
+        assert_equal %w[dog_and_cat.rb], files
+      end
+    end
+  end
+
+  def assert_filter_files exp, filter, files = %w[test/dog_and_cat.rb]
+    ignore = StringIO.new filter
+    act = Flay.filter_files files, ignore
+    assert_equal exp, act
+  end
+
+  def test_cls_filter_files_dir
+    assert_filter_files [], "test/"
+  end
+
+  def test_cls_filter_files_files
+    assert_filter_files [], "test/*.rb"
+
+    example = %w[test/file.rb test/sub/file.rb top/test/perf.rb]
+
+    assert_filter_files example[1..-1], "test/*.rb", example
+  end
+
+  def test_cls_filter_files_glob
+    assert_filter_files [], "test*"
+    assert_filter_files [], "test*", ["test/lib/woot.rb"]
+    assert_filter_files [], "*.rb"
+    assert_filter_files [], "*dog*.rb"
+  end
+
+  def test_cls_filter_files_glob_miss
+    miss = %w[test/dog_and_cat.rb]
+    assert_filter_files miss, "test"
+    assert_filter_files miss, "nope"
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: flay
 version: !ruby/object:Gem::Version
-  version: 2.5.0
+  version: 2.6.0
 platform: ruby
 authors:
 - Ryan Davis
@@ -10,9 +10,9 @@ bindir: bin
 cert_chain:
 - |
   -----BEGIN CERTIFICATE-----
-  MIIDPjCCAiagAwIBAgIBATANBgkqhkiG9w0BAQUFADBFMRMwEQYDVQQDDApyeWFu
+  MIIDPjCCAiagAwIBAgIBAjANBgkqhkiG9w0BAQUFADBFMRMwEQYDVQQDDApyeWFu
   ZC1ydWJ5MRkwFwYKCZImiZPyLGQBGRYJemVuc3BpZGVyMRMwEQYKCZImiZPyLGQB
-  GRYDY29tMB4XDTEzMDkxNjIzMDQxMloXDTE0MDkxNjIzMDQxMlowRTETMBEGA1UE
+  GRYDY29tMB4XDTE0MDkxNzIzMDcwN1oXDTE1MDkxNzIzMDcwN1owRTETMBEGA1UE
   AwwKcnlhbmQtcnVieTEZMBcGCgmSJomT8ixkARkWCXplbnNwaWRlcjETMBEGCgmS
   JomT8ixkARkWA2NvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBALda
   b9DCgK+627gPJkB6XfjZ1itoOQvpqH1EXScSaba9/S2VF22VYQbXU1xQXL/WzCkx
@@ -22,14 +22,14 @@ cert_chain:
   qhtV7HJxNKuPj/JFH0D2cswvzznE/a5FOYO68g+YCuFi5L8wZuuM8zzdwjrWHqSV
   gBEfoTEGr7Zii72cx+sCAwEAAaM5MDcwCQYDVR0TBAIwADALBgNVHQ8EBAMCBLAw
   HQYDVR0OBBYEFEfFe9md/r/tj/Wmwpy+MI8d9k/hMA0GCSqGSIb3DQEBBQUAA4IB
-  AQCFZ7JTzoy1gcG4d8A6dmOJy7ygtO5MFpRIz8HuKCF5566nOvpy7aHhDDzFmQuu
-  FX3zDU6ghx5cQIueDhf2SGOncyBmmJRRYawm3wI0o1MeN6LZJ/3cRaOTjSFy6+S6
-  zqDmHBp8fVA2TGJtO0BLNkbGVrBJjh0UPmSoGzWlRhEVnYC33TpDAbNA+u39UrQI
-  ynwhNN7YbnmSR7+JU2cUjBFv2iPBO+TGuWC+9L2zn3NHjuc6tnmSYipA9y8Hv+As
-  Y4evBVezr3SjXz08vPqRO5YRdO3zfeMT8gBjRqZjWJGMZ2lD4XNfrs7eky74CyZw
-  xx3n58i0lQkBE1EpKE0lFu/y
+  AQAFoDJRokCQdxFfOrmsKX41KOFlU/zjrbDVM9hgB/Ur999M6OXGSi8FitXNtMwY
+  FVjsiAPeU7HaWVVcZkj6IhINelTkXsxgGz/qCzjHy3iUMuZWw36cS0fiWJ5rvH+e
+  hD7uXxJSFuyf1riDGI1aeWbQ74WMwvNstOxLUMiV5a1fzBhlxPqb537ubDjq/M/h
+  zPUFPVYeL5KjDHLCqI2FwIk2sEMOQgjpXHzl+3NlD2LUgUhHDMevmgVua0e2GT1B
+  xJcC6UN6NHMOVMyAXsr2HR0gRRx4ofN1LoP2KhXzSr8UMvQYlwPmE0N5GQv1b5AO
+  VpzF30vNaJK6ZT7xlIsIlwmH
   -----END CERTIFICATE-----
-date: 2014-05-30 00:00:00.000000000 Z
+date: 2015-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sexp_processor
@@ -65,14 +65,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '5.3'
+        version: '5.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '5.3'
+        version: '5.5'
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
@@ -93,14 +93,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: '3.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: '3.13'
 description: |-
   Flay analyzes code for structural similarities. Differences in literal
   values, variable, class, method names, whitespace, programming style,
@@ -148,7 +148,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.1
+rubygems_version: 2.4.1
 signing_key: 
 specification_version: 4
 summary: Flay analyzes code for structural similarities