debride 1.8.0 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 9997dcf31c73430147cd74d4365cacc011a9ddf9
-  data.tar.gz: 0d52faa989d72642bfc90eb59efe69c1eb29bd85
+SHA256:
+  metadata.gz: 1c2b2a4fb03bd2f6f8a5406f0b413e3159b49ac6a9b0c3641bedc7a6e724a548
+  data.tar.gz: cdeb2dc596fe5e496ed940a989fe84f482480c2a2cc7436228e1c4b07755ccbf
 SHA512:
-  metadata.gz: '090808da18149228a64261245d549cb50fa78141b73428a913fe606b61f700bec4ada3de220c5b9ff01e48b1f15f94daa93a4296f570d8da65f6cea7bf53e124'
-  data.tar.gz: 73af8d47c93780a568590bc7bf34b4ff4df80dd6ce9e877d01347b232ca2907274b7d1cb4b090481a5aaab13e23f2e3575324a02e9f49c10bffb513c7817086b
+  metadata.gz: a11b67c7d6a82313be67dbb1680c54ab9f9db3e0f769ab2ce96980ebfb696cc5dd607d6107cb0cc00c9a5c966553439deea89fa0acd13be83707e6393b52070b
+  data.tar.gz: f2f4eb04d9c348109b88fcca245233554bae0febe496ead9c08622653add4a2cdd10bb4405b7bff9cc308972d5cc46f46241aa56162976d2f89cf03c4ba9e2d4

checksums.yaml.gz.sig

@@ -1,2 +1 @@
-����⫤MdW�r
-�ߖ�t�!N��
+�1��oLoϩ}�

data/History.rdoc

@@ -1,3 +1,33 @@
+=== 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:
+
+  * Fixed some sexp access under STRICT_SEXP=1.
+
+=== 1.8.1 / 2017-11-29
+
+* 2 minor enhancements:
+
+  * Add basic support for jbuilder files. (d-mato)
+  * Added rails & whitelist example to readme. (TheRusskiy)
+
+* 2 bug fixes:
+
+  * Capture RegexpError and skip file. (mrdShinse)
+  * Fixed reporting of cdecl+const2 (eg X::Y = 42). (herwinw)
+
 === 1.8.0 / 2017-05-09
 
 * 1 minor enhancement:

data/README.rdoc

@@ -42,6 +42,21 @@ 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
+  # generate whitelist based on routes and usages from production log
+  % debride_rails_whitelist routes.txt log/production.log | sort -u > whitelist.txt
+  # add migration methods
+  % echo up >> whitelist.txt
+  % echo down >> whitelist.txt
+  % echo change >> whitelist.txt
+  # output debride report co standard output with the following options:
+  # 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.
 

data/Rakefile

@@ -26,15 +26,16 @@ 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"]]
 
   require "debride"
 
-  args = ["--rails", verbose, whitelist, dir].flatten.compact
+  args = ["--rails", verbose, 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.0" # :nodoc:
+  VERSION = "1.9.0" # :nodoc:
   PROJECT = "debride"
 
   def self.load_plugins proj = PROJECT
@@ -50,7 +40,7 @@ class Debride < MethodBasedSexpProcessor
   end
 
   def self.file_extensions
-    %w[rb rake] + load_plugins
+    %w[rb rake jbuilder] + load_plugins
   end
 
   ##
@@ -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
-
-      rp = RubyParser.for_current_ruby rescue RubyParser.new
-      rp.process(file, path, option[:timeout])
-    rescue Racc::ParseError => e
-      warn "Parse Error parsing #{path}. Skipping."
-      warn "  #{e.message}"
-    rescue Timeout::Error
-      warn "TIMEOUT parsing #{path}. Skipping."
+    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
+
+    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"
@@ -160,6 +153,14 @@ class Debride < MethodBasedSexpProcessor
       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
@@ -208,7 +209,7 @@ class Debride < MethodBasedSexpProcessor
   end
 
   def process_attrasgn(sexp)
-    method_name = sexp[2]
+    _, _, method_name, * = sexp
     method_name = method_name.last if Sexp === method_name
     called << method_name
     process_until_empty sexp
@@ -222,7 +223,7 @@ class Debride < MethodBasedSexpProcessor
   end
 
   def process_call sexp # :nodoc:
-    method_name = sexp[2]
+    _, _, method_name, * = sexp
 
     case method_name
     when :new then
@@ -273,8 +274,8 @@ class Debride < MethodBasedSexpProcessor
         if Sexp === possible_hash && possible_hash.sexp_type == :hash
           possible_hash.sexp_body.each_slice(2) do |key, val|
             next unless Sexp === val
-            called << val.last        if val.first == :lit
-            called << val.last.to_sym if val.first == :str
+            called << val.last        if val.sexp_type == :lit
+            called << val.last.to_sym if val.sexp_type == :str
           end
         end
       end
@@ -296,6 +297,9 @@ class Debride < MethodBasedSexpProcessor
 
   def process_cdecl exp # :nodoc:
     _, name, val = exp
+
+    name = name_to_string process name if Sexp === name
+
     process val
 
     signature = "#{klass_name}::#{name}"
@@ -307,6 +311,19 @@ class Debride < MethodBasedSexpProcessor
     exp
   end
 
+  def name_to_string exp
+    case exp.sexp_type
+    when :colon2 then
+      _, (_, lhs), rhs = exp
+      "#{lhs}::#{rhs}"
+    when :colon3 then
+      _, rhs = exp
+      "::#{rhs}"
+    else
+      raise "Not handled: #{exp.inspect}"
+    end
+  end
+
   def process_colon2 exp # :nodoc:
     _, lhs, name = exp
     process lhs
@@ -381,37 +398,79 @@ 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:"
 
     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)| "  %-35s %s" % [meth, location] }
+
+      io.puts
+      io.puts klass
+      io.puts bad.join "\n"
+    end
+  end
 
-        next if focus and not File.fnmatch(focus, path)
+  def report_json io, focus, missing
+    require "json"
 
-        "  %-35s %s" % [meth, location]
-      }
-      bad.compact!
-      next if bad.empty?
+    data = {
+      :missing => missing
+    }
 
-      puts
-      puts klass
-      puts bad.join "\n"
-    end
+    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]
+
+    assert_equal EXP_LIST, debride.missing
+  end
 
-    debride = Debride.run %w[--exclude test lib]
+  def test_exclude_files__multiple
+    debride = Debride.run %w[--exclude test,lib lib test]
 
-    exp = [["Debride",
-            [:process_attrasgn, :process_call, :process_cdecl, :process_colon2,
-             :process_colon3, :process_const, :process_defn, :process_defs,
-             :process_rb, :report]]]
+    assert_empty debride.missing
+  end
 
-    assert_equal exp, debride.missing
+  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
@@ -186,6 +247,26 @@ class TestDebride < Minitest::Test
     assert_process exp, ruby, :rails => true
   end
 
+  def test_cdecl_const2
+    ruby = <<-RUBY.strip
+      class Z
+        X::Y = 42
+      end
+    RUBY
+
+    assert_process [["Z", ["X::Y"]]], ruby
+  end
+
+  def test_cdecl_const3
+    ruby = <<-RUBY.strip
+      class Z
+        ::Y = 42
+      end
+    RUBY
+
+    assert_process [["Z", ["::Y"]]], ruby
+  end
+
   def test_method_send
     ruby = <<-RUBY.strip
       class Seattle

data.tar.gz.sig

@@ -1,2 +1,2 @@
-����v�|	$����c������>�D{=�\�U��\���V�!�*�譡#߂��$�&W���9�фIt~�}����q�.�A�Vճ`RK��N�S�s
-tW������M�4�r&�pv�ZK�f�G�
=�����0x�K��Q!���	uz�(8�`�eE@�}8���S��u/-,��]LjJ�xn଑q�|#
+^$	ߦ��jhB>��!F"Bvu�m���f�*��:�\q�Ӫ�bjF�<����]2�Iv��� �_��J<c�U�P�J<�lq��ФŮ�G�[�҄�&��tÆ��Q�z�̌c���6Ey�`Vșa�Ƅ��"
+:��܎6������C��{��[�ݿ}�IYš�|��Y���8��w.d���9�z�$��~u�l𝋀�E���s;)�Z��Q+��w($��<m�Qq����PZ%�e$�\Nx�Nrn�Z

metadata

@@ -1,18 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: debride
 version: !ruby/object:Gem::Version
-  version: 1.8.0
+  version: 1.9.0
 platform: ruby
 authors:
 - Ryan Davis
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain:
 - |
   -----BEGIN CERTIFICATE-----
-  MIIDijCCAnKgAwIBAgIBATANBgkqhkiG9w0BAQUFADBFMRMwEQYDVQQDDApyeWFu
+  MIIDPjCCAiagAwIBAgIBBjANBgkqhkiG9w0BAQsFADBFMRMwEQYDVQQDDApyeWFu
   ZC1ydWJ5MRkwFwYKCZImiZPyLGQBGRYJemVuc3BpZGVyMRMwEQYKCZImiZPyLGQB
-  GRYDY29tMB4XDTE2MDkyNjAxNTczNVoXDTE3MDkyNjAxNTczNVowRTETMBEGA1UE
+  GRYDY29tMB4XDTIxMTIyMzIzMTkwNFoXDTIyMTIyMzIzMTkwNFowRTETMBEGA1UE
   AwwKcnlhbmQtcnVieTEZMBcGCgmSJomT8ixkARkWCXplbnNwaWRlcjETMBEGCgmS
   JomT8ixkARkWA2NvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBALda
   b9DCgK+627gPJkB6XfjZ1itoOQvpqH1EXScSaba9/S2VF22VYQbXU1xQXL/WzCkx
@@ -20,17 +20,16 @@ cert_chain:
   oOvjtt5P8+GSK9zLzxQP0gVLS/D0FmoE44XuDr3iQkVS2ujU5zZL84mMNqNB1znh
   GiadM9GHRaDiaxuX0cIUBj19T01mVE2iymf9I6bEsiayK/n6QujtyCbTWsAS9Rqt
   qhtV7HJxNKuPj/JFH0D2cswvzznE/a5FOYO68g+YCuFi5L8wZuuM8zzdwjrWHqSV
-  gBEfoTEGr7Zii72cx+sCAwEAAaOBhDCBgTAJBgNVHRMEAjAAMAsGA1UdDwQEAwIE
-  sDAdBgNVHQ4EFgQUR8V72Z3+v+2P9abCnL4wjx32T+EwIwYDVR0RBBwwGoEYcnlh
-  bmQtcnVieUB6ZW5zcGlkZXIuY29tMCMGA1UdEgQcMBqBGHJ5YW5kLXJ1YnlAemVu
-  c3BpZGVyLmNvbTANBgkqhkiG9w0BAQUFAAOCAQEAIGzgp0aZ2W9+v96ujmBcQHoC
-  buy0iU68MVj2VlxMyfr1KPZIh1OyhU4UO4zrkREcH8ML70v9cYHNvOd9oynRHnvC
-  l2tj/fD3YJ0AEkJxGrYwRWQmvMfC4bJ02bC1+rVOUIXXKp3+cUmiN4sTniof8VFo
-  bo/YYP4c7erpERa+9hrqygg6WQbJlk2YRlH3JXPFjmu869i2dcbR5ZLOAeEy+axH
-  E4oJcnPkJAr0rw504JGtlZtONZQblwmRJOIdXzolaE3NRGUzGVOUSptZppAKiavY
-  fO6tdKQc/5RfA8oQEkg8hrxA5PQSz4TOFJGLpFvIapEk6tMruQ0bHgkhr9auXg==
+  gBEfoTEGr7Zii72cx+sCAwEAAaM5MDcwCQYDVR0TBAIwADALBgNVHQ8EBAMCBLAw
+  HQYDVR0OBBYEFEfFe9md/r/tj/Wmwpy+MI8d9k/hMA0GCSqGSIb3DQEBCwUAA4IB
+  AQCKB5jfsuSnKb+t/Wrh3UpdkmX7TrEsjVmERC0pPqzQ5GQJgmEXDD7oMgaKXaAq
+  x2m+KSZDrqk7c8uho5OX6YMqg4KdxehfSLqqTZGoeV78qwf/jpPQZKTf+W9gUSJh
+  zsWpo4K50MP+QtdSbKXZwjAafpQ8hK0MnnZ/aeCsW9ov5vdXpYbf3dpg6ADXRGE7
+  lQY2y1tJ5/chqu6h7dQmnm2ABUqx9O+JcN9hbCYoA5i/EeubUEtFIh2w3SpO6YfB
+  JFmxn4h9YO/pVdB962BdBNNDia0kgIjI3ENnkLq0dKpYU3+F3KhEuTksLO0L6X/V
+  YsuyUzsMz6GQA4khyaMgKNSD
   -----END CERTIFICATE-----
-date: 2017-05-09 00:00:00.000000000 Z
+date: 2022-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sexp_processor
@@ -78,30 +77,36 @@ dependencies:
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
 - !ruby/object:Gem::Dependency
   name: hoe
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.16'
+        version: '3.23'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.16'
+        version: '3.23'
 description: Analyze code for potentially uncalled / dead methods, now with auto-removal.
 email:
 - ryand-ruby@zenspider.com
@@ -128,8 +133,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
@@ -146,9 +152,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.8
-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: []