debride 1.11.0 → 1.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a3d7a09de612d4aa5772fbc3db3e26f51a06331c360c62d359acb8465f3f242a
-  data.tar.gz: 95ce5aff93c1900456ad929a959d60f275feb036ecbb890edd590246d284c5eb
+  metadata.gz: 31ff20d8c8b7d749e113ffd4eac634fa13c52e9c84461e52e92c07bbd98a40f1
+  data.tar.gz: dbeb5f7cc0129cc46f38f2a0b68d4b30d5b70d9f0dd7e3581a006e82adfcf2de
 SHA512:
-  metadata.gz: b8c4f5575198e3d8de1c7486cf5b2a6e43e2f2d8ec61af07b3e6d8f5e101cd5343acb108a55468b1e19e8605c3c27acad32918084c4165a666f58e6d367fb72b
-  data.tar.gz: 17dbd73820e02cea048e1cdc61d4811e3d00702f0d2fcc58098e56982205b80e1932cf6358d3692a7647da0de67251c2cab22e274598b420eae48cedeff94726
+  metadata.gz: 293fc6a6d550e86d05a8d4784956fd1a886fea928b9b562a06502a0732e4f34af79aaebbd4f85ebe7aa9bc31fdb7281ec66487a73a2ef2853df467888197eac7
+  data.tar.gz: 9de34932869d721f0f2b98fd719ad0ef07d632d8588542cd4c1d4c3d5f7a57539dad80d858acfd2fb37b3a94b7d26f36ee8204e92a7cefeefd37e11653b9fe30

data/History.rdoc

@@ -1,3 +1,34 @@
+=== 1.13.0 / 2025-06-10
+
+* 2 minor enhancements:
+
+  * Added -y to debride_rm to opt-in to running autoclave.
+  * Print command for autoclave to help see what's happening.
+
+* 1 bug fix:
+
+  * Fixed shebangs on all bin/* files, added -w for all.
+
+=== 1.12.0 / 2023-05-18
+
+* 1 major enhancement:
+
+  * Massive overhaul of bin/debride_rm: faster, cleaner, can run a command between each deletion.
+
+* 2 minor enhancements:
+
+  * Added alias_method and alias as pseudo-calls to source method.
+  * Whitelist extended/included/prepended etc by default.
+
+* 6 bug fixes:
+
+  * Added missing rails validation.
+  * Bumped sexp_processor and ruby_parser dependencies.
+  * Fix --exclude <dir> to properly exclude whole tree.
+  * Fixed --exclude option to make it repeatable.
+  * Fixed bug on anonymous block forwarding (eg fn(&)). (afuno)
+  * Use RubyParser.new instead of RubyParser.for_current_ruby.
+
 === 1.11.0 / 2023-03-24
 
 * 6 minor enhancements:

data/README.rdoc

@@ -42,7 +42,7 @@ API), then you can whitelist it:
   MyClass
     bad_method                          lib/some/file.rb:20
   ...
-  
+
 Usage example for a typical rails application:
   # dump rake routes into a file
   % rake routes > routes.txt
@@ -53,13 +53,48 @@ Usage example for a typical rails application:
   % echo down >> whitelist.txt
   % echo change >> whitelist.txt
   # output debride report co standard output with the following options:
-  # ignore typical rails methods, 
+  # ignore typical rails methods,
   # specify generated whitelist,
   # run in current directory (".")
   % debride --rails --whitelist whitelist.txt .
 
 You can also use regexps in your whitelist by delimiting them with //'s.
 
+To generate a whitelist for the last 28 days worth of logs on papertrail:
+
+  % seq 2 29 | xargs -I {} date -u -v-{}d +%Y-%m-%d | \
+    xargs -I {} curl --progress-bar -f --no-include -L -H "X-Papertrail-Token: $PAPERTRAIL_APIKEY" https://papertrailapp.com/api/v1/archives/{}/download | \
+    gzip -dc | grep production.log | cut -f 10- | \
+    debride_rails_whitelist routes.txt - | sort -u > whitelist.txt
+
+== debride_rm
+
+debride_rm will automatically remove dead code and optionally run a
+command in between each removal. The command will automatically
+substitute "NAME" and "PATH" with the name and path of the thing being
+removed. Eg:
+
+  % debride_rm -C="git commit -m 'debride NAME in PATH' ." \
+      --rails \
+      --whitelist whitelist.txt \
+      --exclude test \
+      --exclude script \
+      --exclude bin \
+      --minimum 30
+
+This command will:
+
+1. run with rails extensions on
+2. treat anything named in whitelist.txt as "called"
+3. exclude directories that shouldn't be scanned or mutated
+4. exclude anything under 30 lines long
+
+One thing to note, debride_rm doesn't do terribly well with things
+like attr_accessor lists, so running debride_rm with --minimum 2 (or
+more) is wise.
+
+Strategy: start large (40+) and work your way down.
+
 == PLUGINS:
 
 debride-erb  :: Extends debride to analyze erb files (via erubis ala rails).
@@ -69,7 +104,7 @@ debride-slim :: Extends debride to analyze Slim files
 
 == EDITOR INTEGRATION:
 
-TextMate 2 :: * {Debride-Rails.tmbundle}[https://github.com/jjuliano/Debride-Rails.tmbundle] - Debride with Rails support 
+TextMate 2 :: * {Debride-Rails.tmbundle}[https://github.com/jjuliano/Debride-Rails.tmbundle] - Debride with Rails support
               * {Debride.tmbundle}[https://github.com/jjuliano/Debride-Rails.tmbundle] - Debride for Ruby
 
 == REQUIREMENTS:

data/Rakefile

@@ -7,6 +7,7 @@ Hoe::add_include_dirs("../../sexp_processor/dev/lib",
                       "../../ruby_parser/dev/lib",
                       "../../ruby2ruby/dev/lib",
                       "../../ZenTest/dev/lib",
+                      "../../debride-erb/dev/lib",
                       "../../path_expander/dev/lib",
                       "lib")
 
@@ -19,8 +20,8 @@ Hoe.spec "debride" do
   developer "Ryan Davis", "ryand-ruby@zenspider.com"
   license "MIT"
 
-  dependency "sexp_processor", "~> 4.5"
-  dependency "ruby_parser", "~> 3.6"
+  dependency "sexp_processor", "~> 4.17"
+  dependency "ruby_parser", "~> 3.20"
   dependency "path_expander",  "~> 1.0"
 end
 
@@ -28,7 +29,9 @@ def run dir, whitelist
   abort "Specify dir to scan with D=<path>" unless dir
 
   ENV["GEM_HOME"] = "tmp/isolate"
-  ENV["GEM_PATH"] = "../../debride-erb/dev/tmp/isolate"
+  ENV["GEM_PATH"] = "#{Gem.paths.path.join ":"}:../../debride-erb/dev/tmp/isolate"
+
+  Gem.paths = ENV
 
   whitelist = whitelist && ["--whitelist", whitelist]
   verbose   = ENV["V"]  && "-v"

data/bin/debride

@@ -1,4 +1,4 @@
-#!/usr/bin/env ruby
+#!/usr/bin/env -S ruby -w
 
 require "debride"
 

data/bin/debride_rails_whitelist

@@ -1,4 +1,4 @@
-#!/usr/bin/ruby -w
+#!/usr/bin/env -S ruby -w
 
 route  = ARGV.shift
 routes = {}

data/bin/debride_rm

@@ -1,96 +1,66 @@
-#!/usr/bin/ruby -w
+#!/usr/bin/env -S ruby -ws
 
-def autoclave nuke
-  skips = 0
+$C ||= false # command to run between deletions
+$y ||= false # yes, actually execute autoclave
 
-  nuke.each do |path, ary|
-    # warn path
+require "set"
+require_relative "../lib/debride"
 
-    file = File.readlines path
+def autoclave nuke, cmd
+  nuke.each do |path, lines_to_remove, klass, name|
+    warn "#{path} #{lines_to_remove} #{klass}##{name}"
 
-    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 = File.foreach(path).with_index.map { |l, i| [i+1, l] }
 
     File.open path, "w" do |f|
-      f.write file.join
+      file.each do |idx, line|
+        # skip empty line after a removed line
+        next if line.chomp.empty? && lines_to_remove.include?(idx-1)
+        f.write line unless lines_to_remove.include? idx
+      end
     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}"
+    if cmd then
+      expanded = cmd.gsub(/\bNAME\b/, "#{klass}##{name}").gsub(/\bPATH\b/, path)
+      warn "CMD = %p" % [expanded]
+      `#{expanded}` if $y
     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"
+abort "usage: #{$0} [-y] [-C=cmd] [debride args]+" if ARGV.empty? or ARGV.include? "-h"
 
-cmd = %w[debride] + ARGV + %w[> dummy_for_cmd_below]
+warn "NOT running commands, use -y to execute" unless $y
 
 loop do
   iter += 1
-  dead = "dead%02d.txt" % iter
-  cmd[-1] = dead
 
-  Process.wait Process.spawn cmd.join " "
-  abort "debride failed: #{$?}" unless $?.success?
+  debride = Debride.run ARGV.dup
+
+  min = debride.option[:minimum] || 0
+
+  nuke = debride.missing_locations
+    .flat_map { |klass, meths|
+      meths
+        .reject { |(meth, loc)| !loc }
+        .map { |(meth, loc)|
+          path, start, finish = /^(.+):(\d+)(?:-(\d+))?$/.match(loc).captures
+          finish ||= start
+          [path, start.to_i..finish.to_i, klass, meth]
+        }
+        .reject { |p,r,k,m| r.size <= min }
+    }
+    .sort_by { |p,r,k,m| [p, -r.begin, m] }
 
-  nuke, count = read_debride dead
+  count = nuke.size
 
-  break if old_count == count
+  break if count.zero? || old_count == count
   old_count = count
 
-  print "iter = %2d count = %4d" % [iter, count]
-  autoclave nuke
+  puts "iter = %2d count = %4d" % [iter, count]
+  autoclave nuke, $C
   puts
 end

data/lib/debride.rb

@@ -12,7 +12,7 @@ require "path_expander"
 # A static code analyzer that points out possible dead methods.
 
 class Debride < MethodBasedSexpProcessor
-  VERSION = "1.11.0" # :nodoc:
+  VERSION = "1.13.0" # :nodoc:
   PROJECT = "debride"
 
   def self.load_plugins proj = PROJECT
@@ -56,7 +56,7 @@ class Debride < MethodBasedSexpProcessor
     expander = PathExpander.new(args, glob)
     files = expander.process
     excl  = debride.option[:exclude]
-    excl.map! { |fd| File.directory?(fd) ? "#{fd}/" : fd } if excl
+    excl.map! { |fd| File.directory?(fd) ? "#{fd}/**/*" : fd } if excl
 
     files = expander.filter_files files, StringIO.new(excl.join "\n") if excl
 
@@ -97,8 +97,7 @@ class Debride < MethodBasedSexpProcessor
       raise "Unhandled type: #{path_or_io.class}:#{path_or_io.inspect}"
     end
 
-    rp = RubyParser.for_current_ruby rescue RubyParser.new
-    rp.process(file, path, option[:timeout])
+    RubyParser.new.process(file, path, option[:timeout])
   rescue Racc::ParseError, RegexpError => e
     warn "Parse Error parsing #{path}. Skipping."
     warn "  #{e.message}"
@@ -111,7 +110,15 @@ class Debride < MethodBasedSexpProcessor
 
   def self.parse_options args
     options = {
-      :whitelist => [],
+      :whitelist => %i[
+                       extended
+                       included
+                       inherited
+                       method_added
+                       method_missing
+                       prepended
+                      ],
+      :exclude => [],
       :format => :text,
     }
 
@@ -129,7 +136,7 @@ class Debride < MethodBasedSexpProcessor
       end
 
       opts.on("-e", "--exclude FILE1,FILE2,ETC", Array, "Exclude files or directories in comma-separated list.") do |list|
-        options[:exclude] = list
+        options[:exclude].concat list
       end
 
       opts.on("-w", "--whitelist FILE", String, "Whitelist these messages.") do |s|
@@ -334,6 +341,17 @@ class Debride < MethodBasedSexpProcessor
       method_name = method_name.to_s.delete_suffix("_path").to_sym if option[:rails]
     when /^deliver_/ then
       method_name = method_name.to_s.delete_prefix("deliver_").to_sym if option[:rails]
+    when :alias_method then
+      _, _, _, lhs, rhs = sexp
+
+      if Sexp === lhs and Sexp === rhs then
+        lhs = lhs.last
+        rhs = rhs.last
+
+        record_method lhs, sexp.file, sexp.line
+
+        called << rhs
+      end
     end
 
     called << method_name
@@ -343,9 +361,21 @@ class Debride < MethodBasedSexpProcessor
     sexp
   end
 
+  def process_alias exp
+    _, (_, lhs), (_, rhs) = exp
+
+    record_method lhs, exp.file, exp.line
+
+    called << rhs
+
+    exp
+  end
+
   def process_block_pass exp # :nodoc:
     _, name = exp
 
+    return exp unless name
+
     case name.sexp_type
     when :lit then              # eg &:to_sym
       called << name.last
@@ -576,7 +606,7 @@ class Debride < MethodBasedSexpProcessor
     :around_action,
     :before_action,
 
-    # https://api.rubyonrails.org/classes/ActiveRecord/Callbacks.html
+    # https://api.rubyonrails.org/classes/ActiveRecord/Callbacks.html (at bottom)
     :after_commit,
     :after_create,
     :after_destroy,
@@ -610,6 +640,7 @@ class Debride < MethodBasedSexpProcessor
     :validates,
     :validates_absence_of,
     :validates_acceptance_of,
+    :validates_comparison_of,
     :validates_confirmation_of,
     :validates_exclusion_of,
     :validates_format_of,

data/test/test_debride.rb

@@ -1,6 +1,8 @@
 require "minitest/autorun"
 require "debride"
 
+$: << "../../debride-erb/dev/tmp/isolate"
+
 class SafeDebride < Debride
   def self.abort s
     raise s
@@ -9,9 +11,9 @@ end
 
 class TestDebride < Minitest::Test
   EXP_LIST = [["Debride",
-               [:process_attrasgn,
+               [:process_alias,
+                :process_attrasgn,
                 :process_block_pass,
-                :process_call,
                 :process_cdecl,
                 :process_colon2,
                 :process_colon3,
@@ -20,6 +22,7 @@ class TestDebride < Minitest::Test
                 :process_defs,
                 :process_op_asgn2,
                 :process_rb,
+                :process_safe_call,
                 :report,
                 :report_json,
                 :report_text,
@@ -31,10 +34,14 @@ class TestDebride < Minitest::Test
 
   EXP_FORMATTED = { :missing => formatted_vals }
 
+  make_my_diffs_pretty!
+
   def assert_option arg, exp_arg, exp_opt
     opt = SafeDebride.parse_options arg
 
-    exp_opt = {:whitelist => [], :format => :text}.merge exp_opt
+    wl = [:extended, :included, :inherited, :method_added, :method_missing, :prepended]
+
+    exp_opt = {:whitelist => wl, :exclude => [], :format => :text}.merge exp_opt
     assert_equal exp_opt, opt
     assert_equal exp_arg, arg
   end
@@ -143,7 +150,7 @@ class TestDebride < Minitest::Test
     debride.report(io)
 
     exp  = JSON.load JSON.dump EXP_FORMATTED # force stringify
-    data = JSON.load io.string.gsub(/\d+-\d+/, "###")
+    data = JSON.load io.string.gsub(/:\d+(-\d+)?/, ":###")
 
     assert_equal exp, data
   end
@@ -155,7 +162,7 @@ class TestDebride < Minitest::Test
     debride.report(io)
 
     exp  = EXP_FORMATTED
-    data = YAML.load io.string.gsub(/\d+-\d+/, "###")
+    data = YAML.load io.string.gsub(/:\d+(-\d+)?/, ":###")
 
     assert_equal exp, data
   end
@@ -334,6 +341,14 @@ class TestDebride < Minitest::Test
     assert_process [["Seattle", [:uncalled]]], ruby
   end
 
+  def test_block_pass_empty
+    ruby = <<-RUBY.strip
+      f(&) # block forwarding
+    RUBY
+
+    assert_process [], ruby
+  end
+
   def test_safe_navigation_operator
     ruby = <<-RUBY.strip
       class Seattle
@@ -500,8 +515,8 @@ class TestDebride < Minitest::Test
            "AttributeAccessor#w4="        => "(io):3",
            "AttributeAccessor#r1"         => "(io):4",
            "AttributeAccessor#r2"         => "(io):4",
-           "AttributeAccessor#initialize" => "(io):5-9",
-           "AttributeAccessor::class_method" => "(io):12-13"
+           "AttributeAccessor#initialize" => "(io):5-10",
+           "AttributeAccessor::class_method" => "(io):12-14"
           }
 
     assert_equal exp, d.method_locations

metadata

@@ -1,18 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: debride
 version: !ruby/object:Gem::Version
-  version: 1.11.0
+  version: 1.13.0
 platform: ruby
 authors:
 - Ryan Davis
-autorequire:
 bindir: bin
 cert_chain:
 - |
   -----BEGIN CERTIFICATE-----
-  MIIDPjCCAiagAwIBAgIBBzANBgkqhkiG9w0BAQsFADBFMRMwEQYDVQQDDApyeWFu
+  MIIDPjCCAiagAwIBAgIBCTANBgkqhkiG9w0BAQsFADBFMRMwEQYDVQQDDApyeWFu
   ZC1ydWJ5MRkwFwYKCZImiZPyLGQBGRYJemVuc3BpZGVyMRMwEQYKCZImiZPyLGQB
-  GRYDY29tMB4XDTIzMDEwMTA3NTExN1oXDTI0MDEwMTA3NTExN1owRTETMBEGA1UE
+  GRYDY29tMB4XDTI1MDEwNjIzMjcwMVoXDTI2MDEwNjIzMjcwMVowRTETMBEGA1UE
   AwwKcnlhbmQtcnVieTEZMBcGCgmSJomT8ixkARkWCXplbnNwaWRlcjETMBEGCgmS
   JomT8ixkARkWA2NvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBALda
   b9DCgK+627gPJkB6XfjZ1itoOQvpqH1EXScSaba9/S2VF22VYQbXU1xQXL/WzCkx
@@ -22,14 +21,14 @@ cert_chain:
   qhtV7HJxNKuPj/JFH0D2cswvzznE/a5FOYO68g+YCuFi5L8wZuuM8zzdwjrWHqSV
   gBEfoTEGr7Zii72cx+sCAwEAAaM5MDcwCQYDVR0TBAIwADALBgNVHQ8EBAMCBLAw
   HQYDVR0OBBYEFEfFe9md/r/tj/Wmwpy+MI8d9k/hMA0GCSqGSIb3DQEBCwUAA4IB
-  AQAkg3y+PBnBAPWdxxITm5sPHqdWQgSyCpRA20o4LTuWr8BWhSXBkfQNa7cY6fOn
-  xyM34VPzBFbExv6XOGDfOMFBVaYTHuN9peC/5/umL7kLl+nflXzL2QA7K6LYj5Bg
-  sM574Onr0dZDM6Vn69bzQ7rBIFDfK/OhlPzqKZad4nsdcsVH8ODCiT+ATMIZyz5K
-  WCnNtqlyiWXI8tdTpahDgcUwfcN/oN7v4K8iU5IbLJX6HQ5DKgmKjfb6XyMth16k
-  ROfWo9Uyp8ba/j9eVG14KkYRaLydAY1MNQk2yd3R5CGfeOpD1kttxjoypoUJ2dOG
-  nsNBRuQJ1UfiCG97a6DNm+Fr
+  AQAC0WQJcPOWPFwkojhzweilRVjTJ19UiLhiBTw3C1wJO3LVdBkWDmnnhAmKuX4D
+  r7vjQvESlABGIPdutI1Yl7mrHQzTkfLfXvNN6MT0nLChPyIYauT6SZZxubwJrUfA
+  7R0c2CJTIboZ0XaGpLsXqHEF1c29H7TV1QvVuqKAN2mCjh4N82QVn+ZKtys28AwT
+  6GfQX2fqLoi4KSc7xIzHKaNzqxeOICmJofk9w5VZ2rRN6yes8jvFYwz9HR41wdj8
+  bwfinv7Yp5fA6AysuZLhCykyfDuZVRrUp0Vb68YCKsLjJly/Theak+euNTxvHsB+
+  al9oSgPPHICMEX65qvLywitx
   -----END CERTIFICATE-----
-date: 2023-03-24 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sexp_processor
@@ -37,28 +36,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.5'
+        version: '4.17'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.5'
+        version: '4.17'
 - !ruby/object:Gem::Dependency
   name: ruby_parser
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.6'
+        version: '3.20'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.6'
+        version: '3.20'
 - !ruby/object:Gem::Dependency
   name: path_expander
   requirement: !ruby/object:Gem::Requirement
@@ -113,14 +112,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '4.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '4.2'
 description: Analyze code for potentially uncalled / dead methods, now with auto-removal.
 email:
 - ryand-ruby@zenspider.com
@@ -149,7 +148,6 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/seattlerb/debride
-post_install_message:
 rdoc_options:
 - "--main"
 - README.rdoc
@@ -166,8 +164,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.6
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Analyze code for potentially uncalled / dead methods, now with auto-removal.
 test_files: []