debride 1.10.0 → 1.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 59c8a2f9b5b719c39af3b257881dbc7440f7f1c7000b4e55efdb411120f7cbde
-  data.tar.gz: 398c595e7080ecab2a3c2195f7a5176c4a4f19ecf517543a9fdc6d7b9dfe3eb4
+  metadata.gz: a3d7a09de612d4aa5772fbc3db3e26f51a06331c360c62d359acb8465f3f242a
+  data.tar.gz: 95ce5aff93c1900456ad929a959d60f275feb036ecbb890edd590246d284c5eb
 SHA512:
-  metadata.gz: dce7e6ad57ab80693a10c2292192515ced017a6e944aa12c2fde55f766d818357bdc4e7b9c99ab14348a6039a299e3fecd3d105e3a02e544cabba0e5e03d54e5
-  data.tar.gz: bc1ec0cf4667aedfc5a85fbf076e3442f08d9acfc7ed2b4e480308f59a6301defcab4222f330f53832af693139aa324ab3cc83ad2d8bc80d1fa63c6e1edc0f18
+  metadata.gz: b8c4f5575198e3d8de1c7486cf5b2a6e43e2f2d8ec61af07b3e6d8f5e101cd5343acb108a55468b1e19e8605c3c27acad32918084c4165a666f58e6d367fb72b
+  data.tar.gz: 17dbd73820e02cea048e1cdc61d4811e3d00702f0d2fcc58098e56982205b80e1932cf6358d3692a7647da0de67251c2cab22e274598b420eae48cedeff94726

data/History.rdoc

@@ -1,3 +1,33 @@
+=== 1.11.0 / 2023-03-24
+
+* 6 minor enhancements:
+
+  * Added X.const_get(:Y) support. (TSMMark)
+  * Added f(&block_pass) support. (TSMMark)
+  * Added obj&.safe_call support. (TSMMark)
+  * Added obj.method(:msg) support. (TSMMark)
+  * Added op_asgn2 (eg x &&= y) support. (TSMMark)
+  * Added try(:msg) support. (TSMMark)
+
+=== 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/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.11.0" # :nodoc:
   PROJECT = "debride"
 
   def self.load_plugins proj = PROJECT
@@ -220,6 +220,14 @@ class Debride < MethodBasedSexpProcessor
     sexp
   end
 
+  # handle &&=, ||=, etc
+  def process_op_asgn2(sexp)
+    _, _, method_name, * = sexp
+    called << method_name
+    process_until_empty sexp
+    sexp
+  end
+
   def record_method name, file, line
     signature = "#{klass_name}##{name}"
     method_locations[signature] = "#{file}:#{line}"
@@ -273,7 +281,7 @@ class Debride < MethodBasedSexpProcessor
         end
         record_method name, file, line
       end
-    when :send, :public_send, :__send__ then
+    when :send, :public_send, :__send__, :try, :const_get then
       # s(:call, s(:const, :Seattle), :send, s(:lit, :raining?))
       _, _, _, msg_arg, * = sexp
       if Sexp === msg_arg && [:lit, :str].include?(msg_arg.sexp_type) then
@@ -291,6 +299,12 @@ class Debride < MethodBasedSexpProcessor
           called << val.last.to_sym if val.sexp_type == :str
         end
       end
+    when :method then
+      # s(:call, nil, :method, s(:lit, :foo))
+      _, _, _, msg_arg, * = sexp
+      if Sexp === msg_arg && [:lit, :str].include?(msg_arg.sexp_type) then
+        called << msg_arg.last.to_sym
+      end
     when *RAILS_DSL_METHODS, *RAILS_VALIDATION_METHODS then
       if option[:rails]
         # s(:call, nil, :before_save, s(:lit, :save_callback), s(:hash, ...))
@@ -329,6 +343,21 @@ class Debride < MethodBasedSexpProcessor
     sexp
   end
 
+  def process_block_pass exp # :nodoc:
+    _, name = exp
+
+    case name.sexp_type
+    when :lit then              # eg &:to_sym
+      called << name.last
+    else                        # eg &lvar or &method(:x)
+      # do nothing, body will get processed below
+    end
+
+    process_until_empty exp
+
+    exp
+  end
+
   def process_cdecl exp # :nodoc:
     _, name, val = exp
 
@@ -348,7 +377,7 @@ class Debride < MethodBasedSexpProcessor
 
   def name_to_string exp
     case exp.sexp_type
-    when :const then
+    when :const, :lit, :str then
       exp.last.to_s
     when :colon2 then
       _, lhs, rhs = exp
@@ -402,6 +431,8 @@ class Debride < MethodBasedSexpProcessor
     end
   end
 
+  alias process_safe_call process_call
+
   ##
   # Calculate the difference between known methods and called methods.
 
@@ -532,6 +563,10 @@ class Debride < MethodBasedSexpProcessor
     YAML.dump data, io
   end
 
+  def inspect
+    "Debride[current=%s]" % [signature]
+  end
+
   ##
   # Rails' macro-style methods that setup method calls to happen during a rails
   # app's execution.
@@ -541,7 +576,7 @@ class Debride < MethodBasedSexpProcessor
     :around_action,
     :before_action,
 
-    # http://api.rubyonrails.org/classes/ActiveRecord/Callbacks.html
+    # https://api.rubyonrails.org/classes/ActiveRecord/Callbacks.html
     :after_commit,
     :after_create,
     :after_destroy,
@@ -562,7 +597,7 @@ class Debride < MethodBasedSexpProcessor
     :before_update,
     :before_validation,
 
-    # http://api.rubyonrails.org/classes/ActiveModel/Validations/ClassMethods.html#method-i-validate
+    # https://api.rubyonrails.org/classes/ActiveModel/Validations/ClassMethods.html#method-i-validate
     :validate,
   ]
 

data/test/test_debride.rb

@@ -10,6 +10,7 @@ end
 class TestDebride < Minitest::Test
   EXP_LIST = [["Debride",
                [:process_attrasgn,
+                :process_block_pass,
                 :process_call,
                 :process_cdecl,
                 :process_colon2,
@@ -17,6 +18,7 @@ class TestDebride < Minitest::Test
                 :process_const,
                 :process_defn,
                 :process_defs,
+                :process_op_asgn2,
                 :process_rb,
                 :report,
                 :report_json,
@@ -287,6 +289,83 @@ class TestDebride < Minitest::Test
     assert_process [], ruby
   end
 
+  def test_method_try
+    ruby = <<-RUBY.strip
+      class Seattle
+        def self.raining?
+          true
+        end
+      end
+
+      Seattle.try :raining?
+    RUBY
+
+    assert_process [], ruby
+  end
+
+  def test_block_pass
+    ruby = <<-RUBY.strip
+      class Seattle
+        def self.raining?
+          true
+        end
+      end
+
+      [Seattle].each(&:raining?)
+    RUBY
+
+    assert_process [], ruby
+  end
+
+  def test_block_pass_other
+    ruby = <<-RUBY.strip
+      class Seattle
+        def self.raining?
+          -> { called }
+        end
+
+        def self.uncalled; end
+        def self.called; end
+      end
+
+      f(&Seattle.raining?)
+    RUBY
+
+    assert_process [["Seattle", [:uncalled]]], ruby
+  end
+
+  def test_safe_navigation_operator
+    ruby = <<-RUBY.strip
+      class Seattle
+        def self.raining?
+          true
+        end
+      end
+
+      Seattle&.raining?
+    RUBY
+
+    assert_process [], ruby
+  end
+
+  def test_call_method
+    ruby = <<-RUBY.strip
+      class Seattle
+        def self.raining?
+          true
+        end
+
+        def self.raining_still?
+          method(:raining?)
+        end
+      end
+
+      Seattle.raining_still?
+    RUBY
+
+    assert_process [], ruby
+  end
+
   def test_rails_dsl_methods
     ruby = <<-RUBY.strip
       class RailsThing
@@ -360,6 +439,8 @@ class TestDebride < Minitest::Test
       class Constants
         USED = 42
         ALSO = 314
+        AGAIN = 27
+        MORE = 72
         UNUSED = 24
 
         def something
@@ -370,6 +451,8 @@ class TestDebride < Minitest::Test
       something
       Constants::ALSO
       ::Constants::ALSO
+      Constants.const_get(:AGAIN)
+      ::Constants.const_get("MORE")
     RUBY
 
     assert_process [["Constants", [:UNUSED]]], ruby
@@ -379,11 +462,13 @@ class TestDebride < Minitest::Test
     ruby = <<-RUBY.strip
       class AttributeAccessor
         attr_accessor :a1, :a2, :a3
-        attr_writer :w1, :w2
+        attr_writer :w1, :w2, :w3, :w4
         attr_reader :r1, :r2
         def initialize
           self.a2 = 'Bar'
           self.w1 = 'W'
+          self.w3 ||= 'W3'
+          self.w4 &&= 'W4'
         end
 
         def self.class_method
@@ -397,7 +482,10 @@ class TestDebride < Minitest::Test
       object.a3 = 'Baz'
     RUBY
 
-    d = assert_process [["AttributeAccessor", [:a1=, :a2, :a3, :class_method, :r2, :w2=]]], ruby
+    exp = [["AttributeAccessor",
+            [:a1=, :a2, :a3, :class_method, :r2, :w2=]]]
+
+    d = assert_process exp, ruby
 
     exp = {
            "AttributeAccessor#a1"         => "(io):2",
@@ -408,10 +496,12 @@ class TestDebride < Minitest::Test
            "AttributeAccessor#a3="        => "(io):2",
            "AttributeAccessor#w1="        => "(io):3",
            "AttributeAccessor#w2="        => "(io):3",
+           "AttributeAccessor#w3="        => "(io):3",
+           "AttributeAccessor#w4="        => "(io):3",
            "AttributeAccessor#r1"         => "(io):4",
            "AttributeAccessor#r2"         => "(io):4",
-           "AttributeAccessor#initialize" => "(io):5-7",
-           "AttributeAccessor::class_method" => "(io):10-11"
+           "AttributeAccessor#initialize" => "(io):5-9",
+           "AttributeAccessor::class_method" => "(io):12-13"
           }
 
     assert_equal exp, d.method_locations

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: debride
 version: !ruby/object:Gem::Version
-  version: 1.10.0
+  version: 1.11.0
 platform: ruby
 authors:
 - Ryan Davis
@@ -10,9 +10,9 @@ bindir: bin
 cert_chain:
 - |
   -----BEGIN CERTIFICATE-----
-  MIIDPjCCAiagAwIBAgIBBjANBgkqhkiG9w0BAQsFADBFMRMwEQYDVQQDDApyeWFu
+  MIIDPjCCAiagAwIBAgIBBzANBgkqhkiG9w0BAQsFADBFMRMwEQYDVQQDDApyeWFu
   ZC1ydWJ5MRkwFwYKCZImiZPyLGQBGRYJemVuc3BpZGVyMRMwEQYKCZImiZPyLGQB
-  GRYDY29tMB4XDTIxMTIyMzIzMTkwNFoXDTIyMTIyMzIzMTkwNFowRTETMBEGA1UE
+  GRYDY29tMB4XDTIzMDEwMTA3NTExN1oXDTI0MDEwMTA3NTExN1owRTETMBEGA1UE
   AwwKcnlhbmQtcnVieTEZMBcGCgmSJomT8ixkARkWCXplbnNwaWRlcjETMBEGCgmS
   JomT8ixkARkWA2NvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBALda
   b9DCgK+627gPJkB6XfjZ1itoOQvpqH1EXScSaba9/S2VF22VYQbXU1xQXL/WzCkx
@@ -22,14 +22,14 @@ cert_chain:
   qhtV7HJxNKuPj/JFH0D2cswvzznE/a5FOYO68g+YCuFi5L8wZuuM8zzdwjrWHqSV
   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
+  AQAkg3y+PBnBAPWdxxITm5sPHqdWQgSyCpRA20o4LTuWr8BWhSXBkfQNa7cY6fOn
+  xyM34VPzBFbExv6XOGDfOMFBVaYTHuN9peC/5/umL7kLl+nflXzL2QA7K6LYj5Bg
+  sM574Onr0dZDM6Vn69bzQ7rBIFDfK/OhlPzqKZad4nsdcsVH8ODCiT+ATMIZyz5K
+  WCnNtqlyiWXI8tdTpahDgcUwfcN/oN7v4K8iU5IbLJX6HQ5DKgmKjfb6XyMth16k
+  ROfWo9Uyp8ba/j9eVG14KkYRaLydAY1MNQk2yd3R5CGfeOpD1kttxjoypoUJ2dOG
+  nsNBRuQJ1UfiCG97a6DNm+Fr
   -----END CERTIFICATE-----
-date: 2022-12-03 00:00:00.000000000 Z
+date: 2023-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sexp_processor
@@ -113,14 +113,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.25'
+        version: '4.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.25'
+        version: '4.0'
 description: Analyze code for potentially uncalled / dead methods, now with auto-removal.
 email:
 - ryand-ruby@zenspider.com
@@ -166,7 +166,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.12
+rubygems_version: 3.4.6
 signing_key:
 specification_version: 4
 summary: Analyze code for potentially uncalled / dead methods, now with auto-removal.

metadata.gz.sig

@@ -1,2 +1,3 @@
-�W��e����h��
-�Q�eJ�|{�|��c�>sE�eB@��z�ܓN�Z̞PP�&�T�Z�F�gR��ˀi���%����Tł��x�c�����������זf������_B�n�[�c�o
�lt�xfz,����:7�c̐Ā�&�۩�GX��mM�h������9����X�4u߫�	.m͗i�\��V���dt�q9{{�����V�*M��HĎ��j��%;V�X����.�IV�i?0
+�����=��BV��`L�*�tJ�c�A�
+E��Q�v���!zK��
+���F�`�|��A�Ev<