debride 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5a723b84c9a06468449e24ec4cf6f8911f1cfbc1
-  data.tar.gz: 7a135fd947b6cbd2905f4d4196aa526966f465e6
+  metadata.gz: a6fb60e6abb914cdca253c8f91a87ee9f29b9573
+  data.tar.gz: c277e27c75a4a571e22cc647fe4d98063f944256
 SHA512:
-  metadata.gz: 6b43c1951aac3602c0ec3bbf1bb28e9aa14d976bb6cc4af7073000795dea551e78d58a20b924396cb2e09f5d422eb9af519d394b413964c541a17ddc46d23ac0
-  data.tar.gz: eae873a00409532767de144cea3d1f31249d4083a0823bb96ee38f89db7f4321bd4cbf54a977e4b494a55c4b66f531674a22f98bafdae7e51dbb1220207a7997
+  metadata.gz: dc8279ae3e71097d6b57ade1054d80c596b76e6b47878b8269fd931abca6b497da3780cf85cff3860563b307a2c01f727fe11f1bc03a11287242e3bd376c75d7
+  data.tar.gz: 560722e6f9d07d1dff4bab14e912cec2d9a019046ee4a5dcfc7a6394e98c9f933e0ff1c4c9dc9b85f2cdd1ad2093889acd2926fb05246bfc96c3bd89bbf477a7

data/.autotest

@@ -1,6 +1,7 @@
 # -*- ruby -*-
 
 require "autotest/restart"
+require "autotest/isolate"
 
 Autotest.add_hook :initialize do |at|
   at.testlib = "minitest/autorun"

data/History.rdoc

@@ -1,3 +1,21 @@
+=== 1.4.0 / 2015-05-27
+
+* 1 major enhancement:
+
+  * Added support for analyzing potentially unused constants.
+
+* 5 minor enhancements:
+
+  * Extended process_rb to work with IO/StringIO.
+  * Print file being processed if --verbose.
+  * Print help and exit if no files/dirs specified. (phiggins)
+  * Rescue RubyParser parse errors, warn, and skip.
+  * Use RubyParser.for_current_ruby.
+
+* 1 bug fix:
+
+  * Debride.new will default to proper options.
+
 === 1.3.0 / 2015-04-13
 
 * 4 minor enhancements:

data/README.rdoc

@@ -38,6 +38,11 @@ API), then you can whitelist it:
 
 You can also use regexps in your whitelist by delimiting them with //'s.
 
+== PLUGINS:
+
+debride-erb  :: Extends debride to analyze erb files (via erubis ala rails).
+debride-haml :: Plugin to allow debride to parse Haml files.
+
 == REQUIREMENTS:
 
 * ruby 1.8+

data/Rakefile

@@ -15,10 +15,28 @@ Hoe.spec "debride" do
   dependency "ruby_parser", "~> 3.6"
 end
 
-task :rails do
+def run dir, wl
   ENV["GEM_HOME"] = "tmp/isolate/ruby-2.0.0"
   ENV["GEM_PATH"] = "../../debride-erb/dev/tmp/isolate/ruby-2.0.0"
-  ruby "-Ilib:../../debride-erb/dev/lib bin/debride --rails ~/Work/git/seattlerb.org/{app,lib} --whitelist ~/Work/git/seattlerb.org/whitelist.txt"
+
+  abort "Specify dir to scan with D=<path>" unless dir
+  wl = "--whitelist #{wl}" if wl
+
+  ruby "-Ilib:../../debride-erb/dev/lib bin/debride --rails #{dir} #{wl}"
+end
+
+task :run do
+  run ENV["D"], ENV["W"]
+end
+
+task :rails do
+  d = "~/Work/git/seattlerb.org"
+  run "#{d}/{app,lib,config}", "#{d}/whitelist.txt"
+end
+
+task :debug do
+  f = ENV["F"]
+  run f, nil
 end
 
 # vim: syntax=ruby

data/lib/debride.rb

@@ -5,11 +5,21 @@ require "sexp_processor"
 require "optparse"
 require "set"
 
+# :stopdoc:
+class File
+  RUBY19 = "<3".respond_to? :encoding unless defined? RUBY19 # :nodoc:
+
+  class << self
+    alias :binread :read unless RUBY19
+  end
+end
+# :startdoc:
+
 ##
 # A static code analyzer that points out possible dead methods.
 
 class Debride < MethodBasedSexpProcessor
-  VERSION = "1.3.0" # :nodoc:
+  VERSION = "1.4.0" # :nodoc:
   PROJECT = "debride"
 
   def self.expand_dirs_to_files *dirs # TODO: push back up to sexp_processor
@@ -88,11 +98,25 @@ class Debride < MethodBasedSexpProcessor
     end
   end
 
-  def process_rb file
+  def process_rb path_or_io
     begin
-      RubyParser.new.process(File.binread(file), file, option[:timeout])
+      warn "processing: #{path}" if option[:verbose]
+
+      case path_or_io
+      when String then
+        path, file = path_or_io, File.binread(path_or_io)
+      when IO, StringIO then
+        path, file = "(io)", path_or_io.read
+      else
+        raise "Unhandled type: #{path_or_io.class}:#{path_or_io.inspect}"
+      end
+
+      RubyParser.for_current_ruby.process(file, path, option[:timeout])
+    rescue Racc::ParseError => e
+      warn "Parse Error parsing #{path}. Skipping."
+      warn "  #{e.message}"
     rescue Timeout::Error
-      warn "TIMEOUT parsing #{file}. Skipping."
+      warn "TIMEOUT parsing #{path}. Skipping."
     end
   end
 
@@ -102,7 +126,7 @@ class Debride < MethodBasedSexpProcessor
   def self.parse_options args
     options = {:whitelist => []}
 
-    OptionParser.new do |opts|
+    op = OptionParser.new do |opts|
       opts.banner  = "debride [options] files_or_dirs"
       opts.version = Debride::VERSION
 
@@ -134,6 +158,8 @@ class Debride < MethodBasedSexpProcessor
       opts.parse! args
     end
 
+    abort op.to_s if args.empty?
+
     options
   end
 
@@ -157,7 +183,7 @@ class Debride < MethodBasedSexpProcessor
   # Create a new Debride instance w/ +options+
 
   def initialize options = {}
-    self.option = options
+    self.option = { :whitelist => [] }.merge options
     self.known  = Hash.new { |h,k| h[k] = Set.new }
     self.called = Set.new
     self.map    = Hash.new { |h,k| h[k] = {} }
@@ -172,6 +198,41 @@ class Debride < MethodBasedSexpProcessor
     super.to_s.sub(/^::|#/, "").to_sym
   end
 
+  def process_cdecl exp # :nodoc:
+    _, name, val = exp
+    process val
+
+    map[klass_name][name] = "#{klass_name}::#{name}"
+    known[name] << klass_name
+
+    exp
+  end
+
+  def process_colon2 exp # :nodoc:
+    _, lhs, name = exp
+    process lhs
+
+    called << name
+
+    exp
+  end
+
+  def process_colon3 exp # :nodoc:
+    _, name = exp
+
+    called << name
+
+    exp
+  end
+
+  def process_const exp # :nodoc:
+    _, name = exp
+
+    called << name
+
+    exp
+  end
+
   def process_defn sexp # :nodoc:
     super do
       map[klass_name][method_name] = signature
@@ -256,7 +317,7 @@ class Debride < MethodBasedSexpProcessor
 
     whitelist_regexp = Regexp.union whitelist_regexps
 
-    not_called.reject! { |s| whitelist_regexp =~ s }
+    not_called.reject! { |s| whitelist_regexp =~ s.to_s }
 
     by_class = Hash.new { |h,k| h[k] = [] }
 

data/test/test_debride.rb

@@ -1,8 +1,33 @@
 require "minitest/autorun"
 require "debride"
 
+class SafeDebride < Debride
+  def self.abort s
+    raise s
+  end
+end
+
 class TestDebride < Minitest::Test
+  def assert_option arg, exp_arg, exp_opt
+    opt = SafeDebride.parse_options arg
+
+    exp_opt = {:whitelist => []}.merge exp_opt
+    assert_equal exp_opt, opt
+    assert_equal exp_arg, arg
+  end
+
+  def assert_process exp, ruby, opts = {}
+    io = StringIO.new ruby
+
+    debride = Debride.new opts
+    debride.process debride.process_rb io
+
+    assert_equal exp, debride.missing
+  end
+
   def test_sanity
+    skip "This is slow" unless ENV["SLOW"]
+
     debride = nil
 
     assert_silent do
@@ -15,34 +40,39 @@ class TestDebride < Minitest::Test
     assert_equal exp, debride.missing
   end
 
-  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
+  def test_parse_options
+    assert_option %w[--verbose woot.rb], %w[woot.rb], :verbose => true
+    assert_option %w[-v woot.rb],        %w[woot.rb], :verbose => true
   end
 
-  def test_parse_options
-    assert_option %w[], %w[], {}
+  def test_parse_options_empty
+    e = assert_raises RuntimeError do
+      assert_option %w[], %w[], {}
+    end
+
+    assert_includes e.message, "debride [options] files_or_dirs"
 
-    assert_option %w[--verbose],  %w[],        :verbose => true
-    assert_option %w[-v],         %w[],        :verbose => true
-    assert_option %w[-v woot.rb], %w[woot.rb], :verbose => true
+    e = assert_raises RuntimeError do
+      assert_option %w[-v], %w[], :verbose => true
+    end
+
+    assert_includes e.message, "debride [options] files_or_dirs"
   end
 
   def test_parse_options_exclude
-    assert_option %w[--exclude moot.rb],   %w[],    :exclude => %w[moot.rb]
-    assert_option %w[-e moot lib],         %w[lib], :exclude => %w[moot]
-    assert_option %w[-e moot,moot.rb lib], %w[lib], :exclude => %w[moot moot.rb]
+    assert_option %w[--exclude moot.rb lib], %w[lib], :exclude => %w[moot.rb]
+    assert_option %w[-e moot lib],           %w[lib], :exclude => %w[moot]
+    assert_option %w[-e moot,moot.rb lib],   %w[lib], :exclude => %w[moot moot.rb]
   end
 
   def test_parse_options_whitelist
     exp = File.readlines("Manifest.txt").map(&:chomp) # omg dumb
-    assert_option %w[--whitelist Manifest.txt], %w[], :whitelist => exp
+    assert_option %w[--whitelist Manifest.txt lib], %w[lib], :whitelist => exp
   end
 
   def test_exclude_files
+    skip "This is slow" unless ENV["SLOW"]
+
     debride = Debride.run %w[--exclude test lib]
 
     exp = [["Debride",
@@ -52,28 +82,80 @@ class TestDebride < Minitest::Test
   end
 
   def test_whitelist
-    debride = Debride.run %w[lib]
-    debride.option[:whitelist] = %w[process_defn]
+    ruby = <<-RUBY
+      class Seattle
+        def self.raining?
+          true
+        end
+      end
 
-    exp = [["Debride",
-            [:process_call, :process_defs, :process_rb, :report]]]
+      # Seattle.raining?
+    RUBY
 
-    assert_equal exp, debride.missing
+    exp = [["Seattle", [:raining?]]]
+    assert_process exp, ruby
+
+    exp = []
+    assert_process exp, ruby, :whitelist => %w[raining?]
   end
 
   def test_whitelist_regexp
-    debride = Debride.run %w[lib]
-    debride.option[:whitelist] = %w[/^process_/ run]
+    ruby = <<-RUBY
+      class Seattle
+        def self.raining?
+          true
+        end
+      end
 
-    exp = [["Debride", [:report]]]
+      # Seattle.raining?
+    RUBY
 
-    assert_equal exp, debride.missing
+    exp = [["Seattle", [:raining?]]]
+    assert_process exp, ruby
+
+    exp = []
+    assert_process exp, ruby, :whitelist => %w[/raining/]
   end
 
-  def test_alias_method_chain
+  def test_process_rb_path
     file = Tempfile.new ["debride_test", ".rb"]
 
     file.write <<-RUBY.strip
+      class Seattle
+        def self.raining?
+          true
+        end
+      end
+
+      Seattle.raining?
+    RUBY
+
+    file.flush
+
+    debride = Debride.new
+    debride.process_rb file.path
+
+    exp = []
+
+    assert_equal exp, debride.missing
+  end
+
+  def test_process_rb_io
+    s = <<-RUBY.strip
+      class Seattle
+        def self.raining?
+          true
+        end
+      end
+
+      Seattle.raining?
+    RUBY
+
+    assert_process [], s
+  end
+
+  def test_alias_method_chain
+    ruby = <<-RUBY.strip
       class QuarterPounder
         def royale_with_cheese
           1+1
@@ -83,19 +165,13 @@ class TestDebride < Minitest::Test
       end
     RUBY
 
-    file.flush
-
-    debride = Debride.run [file.path, "--rails"]
-
     exp = [["QuarterPounder", [:royale, :royale_with_cheese]]]
 
-    assert_equal exp, debride.missing
+    assert_process exp, ruby, :rails => true
   end
 
   def test_method_send
-    file = Tempfile.new ["debride_test", ".rb"]
-
-    file.write <<-RUBY.strip
+    ruby = <<-RUBY.strip
       class Seattle
         def self.raining?
           true
@@ -111,19 +187,11 @@ class TestDebride < Minitest::Test
       Seattle.send "\#{foo}_bar"
     RUBY
 
-    file.flush
-
-    debride = Debride.run [file.path]
-
-    exp = []
-
-    assert_equal exp, debride.missing
+    assert_process [], ruby
   end
 
   def test_rails_dsl_methods
-    file = Tempfile.new ["debride_test", ".rb"]
-
-    file.write <<-RUBY.strip
+    ruby = <<-RUBY.strip
       class RailsThing
         def save_callback         ; 1 ; end
         def action_filter         ; 1 ; end
@@ -140,10 +208,26 @@ class TestDebride < Minitest::Test
       end
     RUBY
 
-    file.flush
+    assert_process [], ruby, :rails => true
+  end
 
-    debride = Debride.run [file.path, "--rails"]
+  def test_constants
+    ruby = <<-RUBY.strip
+      class Constants
+        USED = 42
+        ALSO = 314
+        UNUSED = 24
+
+        def something
+          p USED
+        end
+      end
+
+      something
+      Constants::ALSO
+      ::Constants::ALSO
+    RUBY
 
-    assert_equal [], debride.missing.sort
+    assert_process [["Constants", [:UNUSED]]], ruby
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: debride
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Ryan Davis
@@ -29,7 +29,7 @@ cert_chain:
   xJcC6UN6NHMOVMyAXsr2HR0gRRx4ofN1LoP2KhXzSr8UMvQYlwPmE0N5GQv1b5AO
   VpzF30vNaJK6ZT7xlIsIlwmH
   -----END CERTIFICATE-----
-date: 2015-04-13 00:00:00.000000000 Z
+date: 2015-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sexp_processor

metadata.gz.sig

@@ -1 +1 @@
-i�y��`2æ;kd葅��*�籃�W�O��)���/s�5�g�6�=�qbwb]E*���c)μ�VRƼE״����|~�0&�ͦ�ʮ�W��H3Z�yh��0βs�F35»c�̦ϕ_L6֜�|��r��S���)X3B}*N��6��M(a���휹�dQ�℀Ik���L%��uBKҀ���~NH�z�󺣞�c�D(���?������g�C���S�P�#>80�NOH�B�V�K����-xl��
+��S��m=X��?t]���<�8R�I��B�KC?ʓ�g����ʯ���1