debride 1.6.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 82b0f1e06d3647db71770771357949a6b602f2eb
-  data.tar.gz: b8dd7fb4af36fd5742baef9a041763aed58e5ccb
+  metadata.gz: a9e867eaaa0e3d510c124de19d4ea6ab0fa818e5
+  data.tar.gz: 39740af34dbd97eb9e1286ab0a1ca51437aec120
 SHA512:
-  metadata.gz: 24628c05032af7f7f86dcd53ee0f67d73061b80d94c291d794edb3731e9cc2c9e697918d7ee5818358d26b5e13b0082e15e44cf2174bd3fc3c5def8b71aa42d3
-  data.tar.gz: 38725e26ec1f5b696c9f02299e7625e40d009c813cde75a3c634ead60f85d0343310589d0478c618ea4aa038d9ce165605abb9551d0c397bc63965641b0b26a0
+  metadata.gz: ee65c75009da3d4f6c8760c5fe0b493929008d42f81be3db3cb19e6cf3c8e30f89483eb30088c95d1174880e91b9895e72ecf5f31c5c6fa36d9930f374291d72
+  data.tar.gz: ce1b919309e8790d5a320675721ed82116a1312440ff678fb002f00130247ca7369e71358ad3d379749ac2c6048b6e6a7e109b1405d478055daa30e5881f24ff

data/History.rdoc

@@ -1,3 +1,13 @@
+=== 1.7.0 / 2016-11-30
+
+* 1 minor enhancement:
+
+  * Added bin/debride_rm to automatically remove all dead methods!
+
+* 1 bug fix:
+
+  * Remove #map hash in favor of #method_locations (chrisarcand)
+
 === 1.6.0 / 2016-05-15
 
 * 1 minor enhancement:

data/Manifest.txt

@@ -5,5 +5,6 @@ README.rdoc
 Rakefile
 bin/debride
 bin/debride_rails_whitelist
+bin/debride_rm
 lib/debride.rb
 test/test_debride.rb

data/README.rdoc

@@ -5,7 +5,7 @@ rdoc :: http://docs.seattlerb.org/debride
 
 == DESCRIPTION:
 
-Analyze code for potentially uncalled / dead methods.
+Analyze code for potentially uncalled / dead methods, now with auto-removal.
 
 == FEATURES/PROBLEMS:
 
@@ -13,6 +13,7 @@ Analyze code for potentially uncalled / dead methods.
 * As with all static analysis tools of dynamic languages, can't be 100%.
 * Whitelisting known good methods by name or regexp.
 * Use --rails for Rails-specific domain knowledge.
+* Use debride_rm to brazenly remove all unused methods. BE CAREFUL.
 * Use `debride_rails_whitelist` to generate an emperical whitelist from logs.
 * Uses path_expander, so you can use:
   * dir_arg -- expand a directory automatically
@@ -49,6 +50,7 @@ You can also use regexps in your whitelist by delimiting them with //'s.
 debride-erb  :: Extends debride to analyze erb files (via erubis ala rails).
 debride-haml :: Plugin to allow debride to parse Haml files.
 debride-curly :: A plugin for the Curly templating language
+debride-slim :: Extends debride to analyze Slim files
 
 == REQUIREMENTS:
 

data/bin/debride_rm

@@ -0,0 +1,96 @@
+#!/usr/bin/ruby -w
+
+def autoclave nuke
+  skips = 0
+
+  nuke.each do |path, ary|
+    # warn path
+
+    file = File.readlines path
+
+    ary.each do |(line, name)|
+      opener = file[line-1]
+
+      case opener
+      when /^\s*def/
+        # do nothing
+      else # attr_accessor, etc
+        # warn "  unsupported: #{opener.strip}"
+        skips += 1
+        next
+      end
+
+      leader = opener[/^\s+/]
+      end_line = file[line..-1].find_index { |l| l =~ /^#{leader}end/ }
+
+      if end_line then
+        end_line += line + 1
+        end_line += 1 while file[end_line] =~ /^\s*$/
+        end_line += 1 while file[end_line] =~ /^\s*alias.*?\b#{name}$/
+        end_line += 1 while file[end_line] =~ /^\s*$/
+
+        end_line.downto line do |i|
+          file.delete_at(i-1)
+        end
+      else
+        warn "NOT FOUND: ending for #{name} #{path}:#{line}"
+      end
+    end
+
+    File.open path, "w" do |f|
+      f.write file.join
+    end
+  end
+
+  print " skips = %3d" % skips if skips > 0
+end
+
+def read_debride path
+  nuke = Hash.new { |h,k| h[k] = [] }
+
+  count = 0
+
+  File.foreach path do |line|
+    case line
+    when /^  (\S+)\s+(\S+):(\d+)$/ then
+      name, path, line = $1, $2, $3.to_i
+      nuke[path] << [line, name]
+      count += 1
+    when /^[\w:]+$/, "\n", /:$/ then
+      # ignore
+    else
+      warn "unparsed: #{line.chomp}"
+    end
+  end
+
+  nuke.each do |k, ary|
+    nuke[k] = ary.sort.reverse
+  end
+
+  [nuke, count]
+end
+
+iter = 0
+old_count = nil
+
+abort "usage: #{$0} [debride args]+" if ARGV.empty? or ARGV.include? "-h"
+
+cmd = %w[debride] + ARGV + %w[> dummy_for_cmd_below]
+
+loop do
+  iter += 1
+  dead = "dead%02d.txt" % iter
+  cmd[-1] = dead
+
+  Process.wait Process.spawn cmd.join " "
+  abort "debride failed: #{$?}" unless $?.success?
+
+  nuke, count = read_debride dead
+
+  break if old_count == count
+  old_count = count
+
+  print "iter = %2d count = %4d" % [iter, count]
+  autoclave nuke
+  puts
+end

data/lib/debride.rb

@@ -22,7 +22,7 @@ end
 # A static code analyzer that points out possible dead methods.
 
 class Debride < MethodBasedSexpProcessor
-  VERSION = "1.6.0" # :nodoc:
+  VERSION = "1.7.0" # :nodoc:
   PROJECT = "debride"
 
   def self.load_plugins proj = PROJECT
@@ -188,7 +188,6 @@ class Debride < MethodBasedSexpProcessor
   # Command-line options.
 
   attr_accessor :option
-  attr_accessor :map # :nodoc: # TODO: retire and use method_locations
 
   ##
   # Create a new Debride instance w/ +options+
@@ -197,7 +196,6 @@ class Debride < MethodBasedSexpProcessor
     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] = {} }
     super()
   end
 
@@ -220,7 +218,6 @@ class Debride < MethodBasedSexpProcessor
   def record_method name, file, line
     signature = "#{klass_name}##{name}"
     method_locations[signature] = "#{file}:#{line}"
-    map[klass_name][name] = signature
     known[name] << klass_name
   end
 
@@ -304,7 +301,6 @@ class Debride < MethodBasedSexpProcessor
     process val
 
     signature = "#{klass_name}::#{name}"
-    map[klass_name][name] = signature
     known[name] << klass_name
 
     file, line = exp.file, exp.line
@@ -340,7 +336,6 @@ class Debride < MethodBasedSexpProcessor
 
   def process_defn sexp # :nodoc:
     super do
-      map[klass_name][plain_method_name] = signature
       known[plain_method_name] << klass_name
       process_until_empty sexp
     end
@@ -348,7 +343,6 @@ class Debride < MethodBasedSexpProcessor
 
   def process_defs sexp # :nodoc:
     super do
-      map[klass_name][plain_method_name] = signature
       known[plain_method_name] << klass_name
       process_until_empty sexp
     end
@@ -404,7 +398,7 @@ class Debride < MethodBasedSexpProcessor
 
     missing.each do |klass, meths|
       bad = meths.map { |meth|
-        location = method_locations[map[klass][meth]]
+        location = method_locations["#{klass}##{meth}"]
         path = location[/(.+):\d+$/, 1]
 
         next if focus and not File.fnmatch(focus, path)

data/test/test_debride.rb

@@ -269,24 +269,6 @@ class TestDebride < Minitest::Test
 
     d = assert_process [["AttributeAccessor", [:a1=, :a2, :a3, :r2, :w2=]]], ruby
 
-    exp = {
-           "AttributeAccessor" => {
-                                   :a1         => "AttributeAccessor#a1",
-                                   :a1=        => "AttributeAccessor#a1=",
-                                   :a2         => "AttributeAccessor#a2",
-                                   :a2=        => "AttributeAccessor#a2=",
-                                   :a3         => "AttributeAccessor#a3",
-                                   :a3=        => "AttributeAccessor#a3=",
-                                   :w1=        => "AttributeAccessor#w1=",
-                                   :w2=        => "AttributeAccessor#w2=",
-                                   :r1         => "AttributeAccessor#r1",
-                                   :r2         => "AttributeAccessor#r2",
-                                   :initialize => "AttributeAccessor#initialize"
-                                  }
-          }
-
-    assert_equal exp, d.map
-
     exp = {
            "AttributeAccessor#a1"         => "(io):2",
            "AttributeAccessor#a1="        => "(io):2",

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: debride
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.7.0
 platform: ruby
 authors:
 - Ryan Davis
@@ -10,9 +10,9 @@ bindir: bin
 cert_chain:
 - |
   -----BEGIN CERTIFICATE-----
-  MIIDPjCCAiagAwIBAgIBAzANBgkqhkiG9w0BAQUFADBFMRMwEQYDVQQDDApyeWFu
+  MIIDijCCAnKgAwIBAgIBATANBgkqhkiG9w0BAQUFADBFMRMwEQYDVQQDDApyeWFu
   ZC1ydWJ5MRkwFwYKCZImiZPyLGQBGRYJemVuc3BpZGVyMRMwEQYKCZImiZPyLGQB
-  GRYDY29tMB4XDTE1MDkxOTIwNTEyMloXDTE2MDkxODIwNTEyMlowRTETMBEGA1UE
+  GRYDY29tMB4XDTE2MDkyNjAxNTczNVoXDTE3MDkyNjAxNTczNVowRTETMBEGA1UE
   AwwKcnlhbmQtcnVieTEZMBcGCgmSJomT8ixkARkWCXplbnNwaWRlcjETMBEGCgmS
   JomT8ixkARkWA2NvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBALda
   b9DCgK+627gPJkB6XfjZ1itoOQvpqH1EXScSaba9/S2VF22VYQbXU1xQXL/WzCkx
@@ -20,16 +20,17 @@ cert_chain:
   oOvjtt5P8+GSK9zLzxQP0gVLS/D0FmoE44XuDr3iQkVS2ujU5zZL84mMNqNB1znh
   GiadM9GHRaDiaxuX0cIUBj19T01mVE2iymf9I6bEsiayK/n6QujtyCbTWsAS9Rqt
   qhtV7HJxNKuPj/JFH0D2cswvzznE/a5FOYO68g+YCuFi5L8wZuuM8zzdwjrWHqSV
-  gBEfoTEGr7Zii72cx+sCAwEAAaM5MDcwCQYDVR0TBAIwADALBgNVHQ8EBAMCBLAw
-  HQYDVR0OBBYEFEfFe9md/r/tj/Wmwpy+MI8d9k/hMA0GCSqGSIb3DQEBBQUAA4IB
-  AQB+Hx8xUgrpZa4P8H8gR8zme5kISwQrG80MbpqJV6/G3/ZicRFhN5sjwu0uHGue
-  bd9Cymf6oIRwHVarJux2M32T6bL07Hmi07w2QaPc3MnMKB/D46SRZ2JSSGPFRBTc
-  SilobMRoGs/7B15uGFUEnNrCB/ltMqhwwSx1r++UQPfeySHEV9uqu03E5Vb7J37O
-  2Er6PLXHRiYsIycD1LkMi6YnixdITRHmrqJYE2rsjaIfpIehiusVAPHkNf7qbpHq
-  qx3h45R1CAsObX0SQDIT+rRbQrtKz1GHIZTOFYvEJjUY1XmRTZupD3CJ8Q7sDqSy
-  NLq5jm1fq6Y9Uolu3RJbmycf
+  gBEfoTEGr7Zii72cx+sCAwEAAaOBhDCBgTAJBgNVHRMEAjAAMAsGA1UdDwQEAwIE
+  sDAdBgNVHQ4EFgQUR8V72Z3+v+2P9abCnL4wjx32T+EwIwYDVR0RBBwwGoEYcnlh
+  bmQtcnVieUB6ZW5zcGlkZXIuY29tMCMGA1UdEgQcMBqBGHJ5YW5kLXJ1YnlAemVu
+  c3BpZGVyLmNvbTANBgkqhkiG9w0BAQUFAAOCAQEAIGzgp0aZ2W9+v96ujmBcQHoC
+  buy0iU68MVj2VlxMyfr1KPZIh1OyhU4UO4zrkREcH8ML70v9cYHNvOd9oynRHnvC
+  l2tj/fD3YJ0AEkJxGrYwRWQmvMfC4bJ02bC1+rVOUIXXKp3+cUmiN4sTniof8VFo
+  bo/YYP4c7erpERa+9hrqygg6WQbJlk2YRlH3JXPFjmu869i2dcbR5ZLOAeEy+axH
+  E4oJcnPkJAr0rw504JGtlZtONZQblwmRJOIdXzolaE3NRGUzGVOUSptZppAKiavY
+  fO6tdKQc/5RfA8oQEkg8hrxA5PQSz4TOFJGLpFvIapEk6tMruQ0bHgkhr9auXg==
   -----END CERTIFICATE-----
-date: 2016-05-15 00:00:00.000000000 Z
+date: 2016-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sexp_processor
@@ -101,12 +102,13 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '3.15'
-description: Analyze code for potentially uncalled / dead methods.
+description: Analyze code for potentially uncalled / dead methods, now with auto-removal.
 email:
 - ryand-ruby@zenspider.com
 executables:
 - debride
 - debride_rails_whitelist
+- debride_rm
 extensions: []
 extra_rdoc_files:
 - History.rdoc
@@ -120,6 +122,7 @@ files:
 - Rakefile
 - bin/debride
 - bin/debride_rails_whitelist
+- bin/debride_rm
 - lib/debride.rb
 - test/test_debride.rb
 homepage: https://github.com/seattlerb/debride
@@ -147,5 +150,5 @@ rubyforge_project:
 rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
-summary: Analyze code for potentially uncalled / dead methods.
+summary: Analyze code for potentially uncalled / dead methods, now with auto-removal.
 test_files: []

metadata.gz.sig

@@ -1 +1 @@
-*{��Y
4�Dí� ��"諉HC���"����a>�߯5�8����r���F1Ә�|g���'����}���O?�%�^�r�%���L��S��af! �7bnw7̌��[��ry�e�xS�8��b������A��od8���k�uw���|�(kK�܀8g���Qᠬ��^�I1����Q�k�3G^w�𛂴em�2��Ve.�}铡��n�$}Oze��<FxO7
+�e�6������^�@&�e��zC��`W�j�Pqz�Ʌ+�4t��^��e;EU��	P�lKˮ~�-�'r��!z_A�T��|���N�]N2_��O�C�,�>2(�y'�𕙠�h��J��>n��)���C{��S��v�P�m���סA�E��;����L!�|p�*�P0��F��ϙ
���nV���lT��.�v����ZZ8�^d0G��TS�ݴ�A�I��=����:h�9껖����!�n�F(^�W�