debride 1.9.0 → 1.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1c2b2a4fb03bd2f6f8a5406f0b413e3159b49ac6a9b0c3641bedc7a6e724a548
-  data.tar.gz: cdeb2dc596fe5e496ed940a989fe84f482480c2a2cc7436228e1c4b07755ccbf
+  metadata.gz: 6967abff5ba6b28f0e9883d615830a93e7fcb2dbeb2eaafa665ececa1fed39ce
+  data.tar.gz: b52412f613a2149775cd552e08f44f616ad1c5c89d0ae3fa1dca6f3ce0ffabeb
 SHA512:
-  metadata.gz: a11b67c7d6a82313be67dbb1680c54ab9f9db3e0f769ab2ce96980ebfb696cc5dd607d6107cb0cc00c9a5c966553439deea89fa0acd13be83707e6393b52070b
-  data.tar.gz: f2f4eb04d9c348109b88fcca245233554bae0febe496ead9c08622653add4a2cdd10bb4405b7bff9cc308972d5cc46f46241aa56162976d2f89cf03c4ba9e2d4
+  metadata.gz: fc77db06b93e7401cb6a723b1db1532e6c75fba1216301bb4037ae5c6516fcc577931186f1a9ebc9a4fb452403b92f984ab7dca1abcb312cfb0c921d400f32fd
+  data.tar.gz: 48a62586d3131f682447f5855276ab43e9de334ea791c8d2afa6e9bd49e3ff77007b3be10c00c03f934648f97f62a71871db69169060be3b4a92d432d364495b

data/History.rdoc

@@ -1,3 +1,22 @@
+=== 1.10.1 / 2022-12-03
+
+* 4 minor enhancements:
+
+  * Added --minimum <Nloc> flag to filter out smaller suspects.
+  * Added line count to suspects in report and total line count to end of report.
+  * Added processing of `delegate xs to: target` as a call to target.
+  * Added processing of rails deliver_X -> X calls.
+
+* 3 bug fixes:
+
+  * Fixed processing of colon2 (X::Y::Z) names.
+  * Fixed processing of var splatted attr_* methods.
+  * Possibly fixed conflation between rails route scopes and model scopes.
+
+=== 1.10.0 / 2022-12-03
+
+* See above... something went wrong with the release process.
+
 === 1.9.0 / 2022-05-23
 
 * 3 minor enhancements:

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"
@@ -32,10 +33,11 @@ def run dir, whitelist
   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, exclude, dir].flatten.compact
+  args = ["--rails", verbose, minimum, whitelist, exclude, dir].flatten.compact
 
   Debride.run(args).report
 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.9.0" # :nodoc:
+  VERSION = "1.10.1" # :nodoc:
   PROJECT = "debride"
 
   def self.load_plugins proj = PROJECT
@@ -150,6 +150,10 @@ 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
@@ -240,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
@@ -248,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
@@ -255,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
@@ -263,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, ...))
@@ -282,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
@@ -303,6 +337,7 @@ class Debride < MethodBasedSexpProcessor
     process val
 
     signature = "#{klass_name}::#{name}"
+
     known[name] << klass_name
 
     file, line = exp.file, exp.line
@@ -313,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
@@ -440,13 +479,33 @@ class Debride < MethodBasedSexpProcessor
 
     io.puts "These methods MIGHT not be called:"
 
+    total = 0
+
     missing.each do |klass, meths|
-      bad = meths.map { |(meth, location)| "  %-35s %s" % [meth, location] }
+      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
+
+        "  %-35s %s (%d)" % [meth, location, loc]
+      }.compact
+
+      next if bad.empty?
 
       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

data.tar.gz.sig

@@ -1,2 +1 @@
-^$	ߦ��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
+\�0��M�$3�T�)����Ô��2����@T�qc��	p�g�N��]��)��}i��l��FB��/�������Ⱦ�Uzd,�c�b�*�6d�q��߄�{���k��D>SɁ���u`�"TWg5�Y+���ȑ��/D���;v�%��} �U'�z����{���z�7ht��LJ��bU�V)��qA��GC���\�D�ȊD�a�F��6fk�G����U�~*�(]��j�xci7�j���A���9���

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: debride
 version: !ruby/object:Gem::Version
-  version: 1.9.0
+  version: 1.10.1
 platform: ruby
 authors:
 - Ryan Davis
@@ -29,7 +29,7 @@ cert_chain:
   JFmxn4h9YO/pVdB962BdBNNDia0kgIjI3ENnkLq0dKpYU3+F3KhEuTksLO0L6X/V
   YsuyUzsMz6GQA4khyaMgKNSD
   -----END CERTIFICATE-----
-date: 2022-05-23 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.23'
+        version: '3.25'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.23'
+        version: '3.25'
 description: Analyze code for potentially uncalled / dead methods, now with auto-removal.
 email:
 - ryand-ruby@zenspider.com