debride 1.8.2 → 1.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1b16bea89c5bac1de568f81f4403fc92146971a327298add5127d6d8ef1bd55c
-  data.tar.gz: 6c2fc0d65c1115038ba58779410a078ff5f070222683221c5bb604420afc803d
+  metadata.gz: 59c8a2f9b5b719c39af3b257881dbc7440f7f1c7000b4e55efdb411120f7cbde
+  data.tar.gz: 398c595e7080ecab2a3c2195f7a5176c4a4f19ecf517543a9fdc6d7b9dfe3eb4
 SHA512:
-  metadata.gz: '099d5cd9f89fe640524ae7c95acd3f24afdefad7f03914c35abe7676bed3e9509ba4bd6cd73cf760fc0805bda07b7da995a2431d33340feed9f5c7fbf2501b36'
-  data.tar.gz: bc8ed6323a86bfd4f386b81195e2d9d919f4d484a0515c599fa2d1a53d3318650e71fffd2e87683d83603f3ce5e84fb3b4e90a21e4777d782d4d0699c414e448
+  metadata.gz: dce7e6ad57ab80693a10c2292192515ced017a6e944aa12c2fde55f766d818357bdc4e7b9c99ab14348a6039a299e3fecd3d105e3a02e544cabba0e5e03d54e5
+  data.tar.gz: bc1ec0cf4667aedfc5a85fbf076e3442f08d9acfc7ed2b4e480308f59a6301defcab4222f330f53832af693139aa324ab3cc83ad2d8bc80d1fa63c6e1edc0f18

data/History.rdoc

@@ -1,3 +1,15 @@
+=== 1.9.0 / 2022-05-23
+
+* 3 minor enhancements:
+
+  * Added --json and --yaml output options.
+  * Added io argument to #report, added tests for #report.
+  * Improved processing of --exclude with directories (adds trailing slash).
+
+* 1 bug fix:
+
+  * Fixed exception thrown in #report when using --focus. (cbillen)
+
 === 1.8.2 / 2019-09-24
 
 * 1 bug fix:

data/Rakefile

@@ -13,6 +13,7 @@ Hoe::add_include_dirs("../../sexp_processor/dev/lib",
 Hoe.plugin :isolate
 Hoe.plugin :seattlerb
 Hoe.plugin :rdoc
+Hoe.plugin :cov
 
 Hoe.spec "debride" do
   developer "Ryan Davis", "ryand-ruby@zenspider.com"
@@ -26,15 +27,17 @@ end
 def run dir, whitelist
   abort "Specify dir to scan with D=<path>" unless dir
 
-  ENV["GEM_HOME"] = "tmp/isolate/ruby-2.0.0"
-  ENV["GEM_PATH"] = "../../debride-erb/dev/tmp/isolate/ruby-2.0.0"
+  ENV["GEM_HOME"] = "tmp/isolate"
+  ENV["GEM_PATH"] = "../../debride-erb/dev/tmp/isolate"
 
   whitelist = whitelist && ["--whitelist", whitelist]
   verbose   = ENV["V"]  && "-v"
+  exclude   = ENV["E"]  && ["--exclude", ENV["E"]]
+  minimum   = ENV["M"]  && ["--minimum", ENV["M"]]
 
   require "debride"
 
-  args = ["--rails", verbose, whitelist, dir].flatten.compact
+  args = ["--rails", verbose, minimum, whitelist, exclude, dir].flatten.compact
 
   Debride.run(args).report
 end

data/lib/debride.rb

@@ -8,21 +8,11 @@ require "ruby_parser"
 require "sexp_processor"
 require "path_expander"
 
-# :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.8.2" # :nodoc:
+  VERSION = "1.9.0" # :nodoc:
   PROJECT = "debride"
 
   def self.load_plugins proj = PROJECT
@@ -66,6 +56,8 @@ 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
+
     files = expander.filter_files files, StringIO.new(excl.join "\n") if excl
 
     debride.run(files)
@@ -94,33 +86,34 @@ class Debride < MethodBasedSexpProcessor
   end
 
   def process_rb path_or_io
-    begin
-      warn "Processing ruby: #{path_or_io}" 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
+    warn "Processing ruby: #{path_or_io}" if option[:verbose]
 
-      rp = RubyParser.for_current_ruby rescue RubyParser.new
-      rp.process(file, path, option[:timeout])
-    rescue Racc::ParseError, RegexpError => e
-      warn "Parse Error parsing #{path}. Skipping."
-      warn "  #{e.message}"
-    rescue Timeout::Error
-      warn "TIMEOUT parsing #{path}. Skipping."
+    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
+
+    rp = RubyParser.for_current_ruby rescue RubyParser.new
+    rp.process(file, path, option[:timeout])
+  rescue Racc::ParseError, RegexpError => e
+    warn "Parse Error parsing #{path}. Skipping."
+    warn "  #{e.message}"
+  rescue Timeout::Error
+    warn "TIMEOUT parsing #{path}. Skipping."
   end
 
   ##
   # Parse command line options and return a hash of parsed option values.
 
   def self.parse_options args
-    options = {:whitelist => []}
+    options = {
+      :whitelist => [],
+      :format => :text,
+    }
 
     op = OptionParser.new do |opts|
       opts.banner  = "debride [options] files_or_dirs"
@@ -157,9 +150,21 @@ class Debride < MethodBasedSexpProcessor
         options[:rails] = true
       end
 
+      opts.on("-m", "--minimum N", Integer, "Don't show hits less than N locs.") do |n|
+        options[:minimum] = n
+      end
+
       opts.on("-v", "--verbose", "Verbose. Show progress processing files.") do
         options[:verbose] = true
       end
+
+      opts.on "--json" do
+        options[:format] = :json
+      end
+
+      opts.on "--yaml" do
+        options[:format] = :yaml
+      end
     end
 
     op.parse! args
@@ -239,6 +244,10 @@ class Debride < MethodBasedSexpProcessor
       _, _, _, *args = sexp
       file, line = sexp.file, sexp.line
       args.each do |(_, name)|
+        if Sexp === name then
+          process name
+          next
+        end
         record_method name, file, line
         record_method "#{name}=".to_sym, file, line
       end
@@ -247,6 +256,10 @@ class Debride < MethodBasedSexpProcessor
       _, _, _, *args = sexp
       file, line = sexp.file, sexp.line
       args.each do |(_, name)|
+        if Sexp === name then
+          process name
+          next
+        end
         record_method "#{name}=".to_sym, file, line
       end
     when :attr_reader then
@@ -254,6 +267,10 @@ class Debride < MethodBasedSexpProcessor
       _, _, _, *args = sexp
       file, line = sexp.file, sexp.line
       args.each do |(_, name)|
+        if Sexp === name then
+          process name
+          next
+        end
         record_method name, file, line
       end
     when :send, :public_send, :__send__ then
@@ -262,6 +279,18 @@ class Debride < MethodBasedSexpProcessor
       if Sexp === msg_arg && [:lit, :str].include?(msg_arg.sexp_type) then
         called << msg_arg.last.to_sym
       end
+    when :delegate then
+      # s(:call, nil, :delegate, ..., s(:hash, s(:lit, :to), s(:lit, :delegator)))
+      possible_hash = sexp.last
+      if Sexp === possible_hash && possible_hash.sexp_type == :hash
+        possible_hash.sexp_body.each_slice(2) do |key, val|
+          next unless key == s(:lit, :to)
+          next unless Sexp === val
+
+          called << val.last        if val.sexp_type == :lit
+          called << val.last.to_sym if val.sexp_type == :str
+        end
+      end
     when *RAILS_DSL_METHODS, *RAILS_VALIDATION_METHODS then
       if option[:rails]
         # s(:call, nil, :before_save, s(:lit, :save_callback), s(:hash, ...))
@@ -281,10 +310,16 @@ class Debride < MethodBasedSexpProcessor
     when *RAILS_MACRO_METHODS
       # s(:call, nil, :has_one, s(:lit, :has_one_relation), ...)
       _, _, _, (_, name), * = sexp
-      file, line = sexp.file, sexp.line
-      record_method name, file, line
+
+      # try to detect route scope vs model scope
+      if context.include? :module or context.include? :class then
+        file, line = sexp.file, sexp.line
+        record_method name, file, line
+      end
     when /_path$/ then
-      method_name = method_name.to_s[0..-6].to_sym if option[:rails]
+      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]
     end
 
     called << method_name
@@ -302,6 +337,7 @@ class Debride < MethodBasedSexpProcessor
     process val
 
     signature = "#{klass_name}::#{name}"
+
     known[name] << klass_name
 
     file, line = exp.file, exp.line
@@ -312,12 +348,16 @@ class Debride < MethodBasedSexpProcessor
 
   def name_to_string exp
     case exp.sexp_type
+    when :const then
+      exp.last.to_s
     when :colon2 then
-      _, (_, lhs), rhs = exp
-      "#{lhs}::#{rhs}"
+      _, lhs, rhs = exp
+      "#{name_to_string lhs}::#{rhs}"
     when :colon3 then
       _, rhs = exp
       "::#{rhs}"
+    when :self then # wtf?
+      "self"
     else
       raise "Not handled: #{exp.inspect}"
     end
@@ -397,37 +437,99 @@ class Debride < MethodBasedSexpProcessor
     by_class.sort_by { |k,v| k }
   end
 
+  def missing_locations
+    focus = option[:focus]
+
+    missing.map { |klass, meths|
+      bad = meths.map { |meth|
+        location =
+          method_locations["#{klass}##{meth}"] ||
+          method_locations["#{klass}::#{meth}"]
+
+        if focus then
+          path = location[/(.+):\d+/, 1]
+
+          next unless File.fnmatch(focus, path)
+        end
+
+        [meth, location]
+      }.compact
+
+      [klass, bad]
+    }
+      .to_h
+      .reject { |k,v| v.empty? }
+  end
+
   ##
   # Print out a report of suspects.
 
-  def report
+  def report io = $stdout
     focus = option[:focus]
+    type  = option[:format] || :text
+
+    send "report_#{type}", io, focus, missing_locations
+  end
 
+  def report_text io, focus, missing
     if focus then
-      puts "Focusing on #{focus}"
-      puts
+      io.puts "Focusing on #{focus}"
+      io.puts
     end
 
-    puts "These methods MIGHT not be called:"
+    io.puts "These methods MIGHT not be called:"
+
+    total = 0
 
     missing.each do |klass, meths|
-      bad = meths.map { |meth|
-        location =
-          method_locations["#{klass}##{meth}"] ||
-          method_locations["#{klass}::#{meth}"]
-        path = location[/(.+):\d+$/, 1]
+      bad = meths.map { |(meth, location)|
+        loc = if location then
+                l0, l1 = location.split(/:/).last.scan(/\d+/).flatten.map(&:to_i)
+                l1 ||= l0
+                l1 - l0 + 1
+              else
+                1
+              end
+
+        next if option[:minimum] && loc < option[:minimum]
+
+        total += loc
 
-        next if focus and not File.fnmatch(focus, path)
+        "  %-35s %s (%d)" % [meth, location, loc]
+      }.compact
 
-        "  %-35s %s" % [meth, location]
-      }
-      bad.compact!
       next if bad.empty?
 
-      puts
-      puts klass
-      puts bad.join "\n"
+      io.puts
+      io.puts klass
+      io.puts bad.join "\n"
     end
+    io.puts
+    io.puts "Total suspect LOC: %d" % [total]
+  end
+
+  def report_json io, focus, missing
+    require "json"
+
+    data = {
+      :missing => missing
+    }
+
+    data[:focus] = focus if focus
+
+    JSON.dump data, io
+  end
+
+  def report_yaml io, focus, missing
+    require "yaml"
+
+    data = {
+      :missing => missing
+    }
+
+    data[:focus] = focus if focus
+
+    YAML.dump data, io
   end
 
   ##

data/test/test_debride.rb

@@ -8,10 +8,31 @@ class SafeDebride < Debride
 end
 
 class TestDebride < Minitest::Test
+  EXP_LIST = [["Debride",
+               [:process_attrasgn,
+                :process_call,
+                :process_cdecl,
+                :process_colon2,
+                :process_colon3,
+                :process_const,
+                :process_defn,
+                :process_defs,
+                :process_rb,
+                :report,
+                :report_json,
+                :report_text,
+                :report_yaml]]]
+
+  formatted_vals = EXP_LIST.map { |k,vs|
+    [k, vs.map { |v| [v, "lib/debride.rb:###"] } ]
+  }.to_h
+
+  EXP_FORMATTED = { :missing => formatted_vals }
+
   def assert_option arg, exp_arg, exp_opt
     opt = SafeDebride.parse_options arg
 
-    exp_opt = {:whitelist => []}.merge exp_opt
+    exp_opt = {:whitelist => [], :format => :text}.merge exp_opt
     assert_equal exp_opt, opt
     assert_equal exp_arg, arg
   end
@@ -27,20 +48,13 @@ class TestDebride < Minitest::Test
   end
 
   def test_sanity
-    skip "This is slow" unless ENV["SLOW"]
-
     debride = nil
 
     assert_silent do
       debride = Debride.run %w[lib]
     end
 
-    exp = [["Debride",
-            [:process_attrasgn, :process_call, :process_cdecl, :process_colon2,
-             :process_colon3, :process_const, :process_defn, :process_defs,
-             :process_rb, :report]]]
-
-    assert_equal exp, debride.missing
+    assert_equal EXP_LIST, debride.missing
   end
 
   def test_parse_options
@@ -85,16 +99,63 @@ class TestDebride < Minitest::Test
   end
 
   def test_exclude_files
-    skip "This is slow" unless ENV["SLOW"]
+    debride = Debride.run %w[--exclude test/ lib test]
 
-    debride = Debride.run %w[--exclude test lib]
+    assert_equal EXP_LIST, debride.missing
+  end
 
-    exp = [["Debride",
-            [:process_attrasgn, :process_call, :process_cdecl, :process_colon2,
-             :process_colon3, :process_const, :process_defn, :process_defs,
-             :process_rb, :report]]]
+  def test_exclude_files__multiple
+    debride = Debride.run %w[--exclude test,lib lib test]
 
-    assert_equal exp, debride.missing
+    assert_empty debride.missing
+  end
+
+  def test_exclude_files__dir_without_slash
+    debride = Debride.run %w[--exclude test lib test]
+
+    assert_equal EXP_LIST, debride.missing
+  end
+
+  def test_focus
+    debride = Debride.run %w[--focus lib/debride.rb lib test]
+    io      = StringIO.new
+
+    debride.report(io)
+
+    assert_includes io.string, "Focusing on lib/debride.rb"
+  end
+
+  def test_format__plain
+    debride = Debride.run %w[lib]
+    io      = StringIO.new
+
+    debride.report(io)
+
+    assert_match %r%process_attrasgn\s+lib/debride.rb:\d+-\d+%, io.string
+  end
+
+  def test_format__json
+    debride = Debride.run %w[lib --json]
+    io      = StringIO.new
+
+    debride.report(io)
+
+    exp  = JSON.load JSON.dump EXP_FORMATTED # force stringify
+    data = JSON.load io.string.gsub(/\d+-\d+/, "###")
+
+    assert_equal exp, data
+  end
+
+  def test_format__yaml
+    debride = Debride.run %w[lib --yaml]
+    io      = StringIO.new
+
+    debride.report(io)
+
+    exp  = EXP_FORMATTED
+    data = YAML.load io.string.gsub(/\d+-\d+/, "###")
+
+    assert_equal exp, data
   end
 
   def test_whitelist

metadata

@@ -1,18 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: debride
 version: !ruby/object:Gem::Version
-  version: 1.8.2
+  version: 1.10.0
 platform: ruby
 authors:
 - Ryan Davis
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain:
 - |
   -----BEGIN CERTIFICATE-----
-  MIIDPjCCAiagAwIBAgIBAzANBgkqhkiG9w0BAQsFADBFMRMwEQYDVQQDDApyeWFu
+  MIIDPjCCAiagAwIBAgIBBjANBgkqhkiG9w0BAQsFADBFMRMwEQYDVQQDDApyeWFu
   ZC1ydWJ5MRkwFwYKCZImiZPyLGQBGRYJemVuc3BpZGVyMRMwEQYKCZImiZPyLGQB
-  GRYDY29tMB4XDTE4MTIwNDIxMzAxNFoXDTE5MTIwNDIxMzAxNFowRTETMBEGA1UE
+  GRYDY29tMB4XDTIxMTIyMzIzMTkwNFoXDTIyMTIyMzIzMTkwNFowRTETMBEGA1UE
   AwwKcnlhbmQtcnVieTEZMBcGCgmSJomT8ixkARkWCXplbnNwaWRlcjETMBEGCgmS
   JomT8ixkARkWA2NvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBALda
   b9DCgK+627gPJkB6XfjZ1itoOQvpqH1EXScSaba9/S2VF22VYQbXU1xQXL/WzCkx
@@ -22,14 +22,14 @@ cert_chain:
   qhtV7HJxNKuPj/JFH0D2cswvzznE/a5FOYO68g+YCuFi5L8wZuuM8zzdwjrWHqSV
   gBEfoTEGr7Zii72cx+sCAwEAAaM5MDcwCQYDVR0TBAIwADALBgNVHQ8EBAMCBLAw
   HQYDVR0OBBYEFEfFe9md/r/tj/Wmwpy+MI8d9k/hMA0GCSqGSIb3DQEBCwUAA4IB
-  AQCbJwLmpJR2PomLU+Zzw3KRzH/hbyUWc/ftru71AopZ1fy4iY9J/BW5QYKVYwbP
-  V0FSBWtvfI/RdwfKGtuGhPKECZgmLieGuZ3XCc09qPu1bdg7i/tu1p0t0c6163ku
-  nDMDIC/t/DAFK0TY9I3HswuyZGbLW7rgF0DmiuZdN/RPhHq2pOLMLXJmFclCb/im
-  9yToml/06TJdUJ5p64mkBs0TzaK66DIB1Smd3PdtfZqoRV+EwaXMdx0Hb3zdR1JR
-  Em82dBUFsipwMLCYj39kcyHWAxyl6Ae1Cn9r/ItVBCxoeFdrHjfavnrIEoXUt4bU
-  UfBugfLD19bu3nvL+zTAGx/U
+  AQCKB5jfsuSnKb+t/Wrh3UpdkmX7TrEsjVmERC0pPqzQ5GQJgmEXDD7oMgaKXaAq
+  x2m+KSZDrqk7c8uho5OX6YMqg4KdxehfSLqqTZGoeV78qwf/jpPQZKTf+W9gUSJh
+  zsWpo4K50MP+QtdSbKXZwjAafpQ8hK0MnnZ/aeCsW9ov5vdXpYbf3dpg6ADXRGE7
+  lQY2y1tJ5/chqu6h7dQmnm2ABUqx9O+JcN9hbCYoA5i/EeubUEtFIh2w3SpO6YfB
+  JFmxn4h9YO/pVdB962BdBNNDia0kgIjI3ENnkLq0dKpYU3+F3KhEuTksLO0L6X/V
+  YsuyUzsMz6GQA4khyaMgKNSD
   -----END CERTIFICATE-----
-date: 2019-09-25 00:00:00.000000000 Z
+date: 2022-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sexp_processor
@@ -93,20 +93,34 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '7'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
 - !ruby/object:Gem::Dependency
   name: hoe
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.18'
+        version: '3.25'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.18'
+        version: '3.25'
 description: Analyze code for potentially uncalled / dead methods, now with auto-removal.
 email:
 - ryand-ruby@zenspider.com
@@ -133,8 +147,9 @@ files:
 homepage: https://github.com/seattlerb/debride
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  homepage_uri: https://github.com/seattlerb/debride
+post_install_message:
 rdoc_options:
 - "--main"
 - README.rdoc
@@ -151,8 +166,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.3.12
+signing_key:
 specification_version: 4
 summary: Analyze code for potentially uncalled / dead methods, now with auto-removal.
 test_files: []