debride 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6abab211f7ada7517c61d2ed301cc1b9762d435d
-  data.tar.gz: c2b904f36e9275028ad3966b74ce9fb53ca9d639
+  metadata.gz: d36c868e7a15b6746112225734bc0d747df00d6e
+  data.tar.gz: 84d0559594fe52021133115507afcea6974b3967
 SHA512:
-  metadata.gz: ba06f6b5951e6094f242191706c9f1fbe6de90ae609bdd869ce0560eb3d7c855f1164cdfc62602feb55e2c87d8596181469eb81c2761350ad65a94c85f08850d
-  data.tar.gz: df82696ec8ffcf55b1b2ad0985a31ab211909ec977ef983329d4cab824ce6164aa3f1b2834085c57f8ad8565868c53bfbdbcc6e5fa0cd83fe69f276a79531890
+  metadata.gz: 427ce5bf52dd04e4060da5c417fbe90cf918e2e39104b72da41ad3335aac76d359501aa33f4dbdb17b664f55391d2372aeafbb814beaf98d2b018593cae9b3e3
+  data.tar.gz: 19e156808348e4a005febc69774523634cbc2fb3798717a8cfe7bc6516544c1786b858867ef8bc83b7fb9dae30c189e86648c9585cfb73a9c358473219488787

data/History.rdoc

@@ -1,3 +1,13 @@
+=== 1.1.0 / 2015-03-18
+
+* 1 minor enhancement:
+
+  * Added --whitelist option to exclude known false positives.
+
+* 1 bug fix:
+
+  * Fixed sexp_processor dependency
+
 === 1.0.0 / 2015-03-09
 
 * 1 major enhancement

data/README.rdoc

@@ -11,17 +11,33 @@ Analyze code for potentially uncalled / dead methods.
 
 * Static analysis of code. Can be easily hooked up to a CI.
 * As with all static analysis tools of dynamic languages, can't be 100%.
+* Whitelisting known good methods by name or regexp.
 
 == SYNOPSIS:
 
-  % debride lib test
+  % debride lib
 
   These methods MIGHT not be called:
 
   MyClass
-    method!                            lib/some/file.rb:16
+    good_method                         lib/some/file.rb:16
+    bad_method                          lib/some/file.rb:20
   ...
 
+But you know that good_method is called (perhaps because it is public
+API), then you can whitelist it:
+
+  % echo good_method > whitelist.txt
+  % debride --whitelist whitelist.txt lib
+
+  These methods MIGHT not be called:
+
+  MyClass
+    bad_method                          lib/some/file.rb:20
+  ...
+
+You can also use regexps in your whitelist by delimiting them with //'s.
+
 == REQUIREMENTS:
 
 * ruby 1.8+

data/Rakefile

@@ -11,7 +11,7 @@ Hoe.spec "debride" do
   developer "Ryan Davis", "ryand-ruby@zenspider.com"
   license "MIT"
 
-  dependency "sexp_processor", "~> 4.4"
+  dependency "sexp_processor", "~> 4.5"
   dependency "ruby_parser", "~> 3.6"
 end
 

data/lib/debride.rb

@@ -1,7 +1,5 @@
 #!/usr/bin/ruby -w
 
-$:.unshift "../../sexp_processor/dev/lib"
-
 require "ruby_parser"
 require "sexp_processor"
 require "optparse"
@@ -11,7 +9,7 @@ require "set"
 # A static code analyzer that points out possible dead methods.
 
 class Debride < MethodBasedSexpProcessor
-  VERSION = "1.0.0" # :nodoc:
+  VERSION = "1.1.0" # :nodoc:
 
   ##
   # Top level runner for bin/debride.
@@ -34,7 +32,7 @@ class Debride < MethodBasedSexpProcessor
   # Parse command line options and return a hash of parsed option values.
 
   def self.parse_options args
-    options = {}
+    options = {:whitelist => []}
 
     OptionParser.new do |opts|
       opts.banner  = "debride [options] files_or_dirs"
@@ -49,9 +47,9 @@ class Debride < MethodBasedSexpProcessor
         exit
       end
 
-      # opts.on("-e", "--exclude FILE", String, "Exclude these messages.") do |s|
-      #   options[:exclude] = s
-      # end
+      opts.on("-w", "--whitelist FILE", String, "Whitelist these messages.") do |s|
+        options[:whitelist] = File.read(s).split(/\n+/) rescue []
+      end
 
       opts.on("-v", "--verbose", "Verbose. Show progress processing files.") do
         options[:verbose] = true
@@ -133,8 +131,21 @@ class Debride < MethodBasedSexpProcessor
   # Calculate the difference between known methods and called methods.
 
   def missing
+    whitelist_regexps = []
+
+    option[:whitelist].each do |s|
+      if s =~ /^\/.+?\/$/ then
+        whitelist_regexps << Regexp.new(s[1..-2])
+      else
+        called << s.to_sym
+      end
+    end
+
     not_called = known.keys - called.to_a
 
+    whitelist_regexp = Regexp.union whitelist_regexps
+    not_called.reject! { |s| whitelist_regexp =~ s }
+
     by_class = Hash.new { |h,k| h[k] = [] }
 
     not_called.each do |meth|

data/test/test_debride.rb

@@ -18,6 +18,7 @@ class TestDebride < Minitest::Test
   def assert_option arg, rest, exp_opt
     opt = Debride.parse_options arg
 
+    exp_opt = {:whitelist => []}.merge exp_opt
     assert_equal exp_opt, opt
     assert_equal rest, arg
   end
@@ -30,9 +31,27 @@ class TestDebride < Minitest::Test
     assert_option %w[-v woot.rb], %w[woot.rb], :verbose => true
   end
 
-  def test_parse_options_exclude
-    skip "not yet"
+  def test_parse_options_whitelist
+    exp = File.readlines("Manifest.txt").map(&:chomp) # omg dumb
+    assert_option %w[--whitelist Manifest.txt], %w[], :whitelist => exp
+  end
+
+  def test_whitelist
+    debride = Debride.run %w[lib]
+    debride.option[:whitelist] = %w[process_defn]
+
+    exp = [["Debride",
+            [:process_call, :process_defs, :report, :run]]]
+
+    assert_equal exp, debride.missing
+  end
+
+  def test_whitelist_regexp
+    debride = Debride.run %w[lib]
+    debride.option[:whitelist] = %w[/^process_/ run]
 
-    assert_option %w[--exclude path], %w[], :exclude => "path"
+    exp = [["Debride", [:report]]]
+
+    assert_equal exp, debride.missing
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: debride
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Ryan Davis
@@ -29,7 +29,7 @@ cert_chain:
   xJcC6UN6NHMOVMyAXsr2HR0gRRx4ofN1LoP2KhXzSr8UMvQYlwPmE0N5GQv1b5AO
   VpzF30vNaJK6ZT7xlIsIlwmH
   -----END CERTIFICATE-----
-date: 2015-03-09 00:00:00.000000000 Z
+date: 2015-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sexp_processor
@@ -37,14 +37,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '4.4'
+        version: '4.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '4.4'
+        version: '4.5'
 - !ruby/object:Gem::Dependency
   name: ruby_parser
   requirement: !ruby/object:Gem::Requirement