debride 1.13.0 → 1.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 31ff20d8c8b7d749e113ffd4eac634fa13c52e9c84461e52e92c07bbd98a40f1
-  data.tar.gz: dbeb5f7cc0129cc46f38f2a0b68d4b30d5b70d9f0dd7e3581a006e82adfcf2de
+  metadata.gz: 77baff9dbc4bab278d0e6b6fe16772ecdce26b00c4c7b24469e0680f0d608c41
+  data.tar.gz: 885b6274f63f3d76c6a106543d28be50f177fcc6fa6adad7cf642c0b3ef7f0d8
 SHA512:
-  metadata.gz: 293fc6a6d550e86d05a8d4784956fd1a886fea928b9b562a06502a0732e4f34af79aaebbd4f85ebe7aa9bc31fdb7281ec66487a73a2ef2853df467888197eac7
-  data.tar.gz: 9de34932869d721f0f2b98fd719ad0ef07d632d8588542cd4c1d4c3d5f7a57539dad80d858acfd2fb37b3a94b7d26f36ee8204e92a7cefeefd37e11653b9fe30
+  metadata.gz: 421c0cb4b4aa45ed2e7897254549def50af4f4491a029676bcc7671aa026e8cda45b9774073eef8d3bffa15665f7df0466e1b6a68f236fc0b0c2ee12806461a5
+  data.tar.gz: 2cc4e04095596764513090fffe356835d3af36c192395dbe7753470801e623f826bf72c54371de30bf1d9006d4cf109809cffc1419e887607914623cc8a1bb82

data/History.rdoc

@@ -1,3 +1,25 @@
+=== 1.15.0 / 2026-01-02
+
+* 1 minor enhancement:
+
+  * Added process_hash to handle hash shortcut syntax in case it is a call. (TSMMark)
+
+* 6 bug fixes:
+
+  * Bump prism dependency to 1.7+.
+  * Load debride with require_relative in bin/debride.
+  * Minor fixes for prism 1.7 and ruby 4.0.
+  * Oops! Fixed --legacy option definition.
+  * Properly handle scope/alias_method with interoplation. (alagos)
+  * Removed prism patches now that they've been upstreamed.
+
+=== 1.14.0 / 2025-12-11
+
+* 2 minor enhancements:
+
+  * Bumped path_expander to 2.0.0.
+  * Switched to prism for ruby parsing. Use --legacy for RubyParser.
+
 === 1.13.0 / 2025-06-10
 
 * 2 minor enhancements:

data/Rakefile

@@ -11,7 +11,7 @@ Hoe::add_include_dirs("../../sexp_processor/dev/lib",
                       "../../path_expander/dev/lib",
                       "lib")
 
-Hoe.plugin :isolate
+Hoe.plugin :isolate_binaries
 Hoe.plugin :seattlerb
 Hoe.plugin :rdoc
 Hoe.plugin :cov
@@ -21,8 +21,8 @@ Hoe.spec "debride" do
   license "MIT"
 
   dependency "sexp_processor", "~> 4.17"
-  dependency "ruby_parser", "~> 3.20"
-  dependency "path_expander",  "~> 1.0"
+  dependency "prism",          "~> 1.7"
+  dependency "path_expander",  "~> 2.0"
 end
 
 def run dir, whitelist

data/bin/debride

@@ -1,5 +1,5 @@
 #!/usr/bin/env -S ruby -w
 
-require "debride"
+require_relative "../lib/debride"
 
 Debride.run(ARGV).report

data/lib/debride.rb

@@ -3,16 +3,22 @@
 require "optparse"
 require "set"
 require "stringio"
+require "timeout"
 
-require "ruby_parser"
 require "sexp_processor"
 require "path_expander"
 
+require "prism"
+require "prism/translation/ruby_parser"
+
+class NotRubyParser < Prism::Translation::RubyParser # compatibility layer
+end
+
 ##
 # A static code analyzer that points out possible dead methods.
 
 class Debride < MethodBasedSexpProcessor
-  VERSION = "1.13.0" # :nodoc:
+  VERSION = "1.15.0" # :nodoc:
   PROJECT = "debride"
 
   def self.load_plugins proj = PROJECT
@@ -47,14 +53,12 @@ class Debride < MethodBasedSexpProcessor
   # Top level runner for bin/debride.
 
   def self.run args
-    opt = parse_options args
-
-    debride = Debride.new opt
+    debride = Debride.new parse_options args
 
     extensions = self.file_extensions
     glob = "**/*.{#{extensions.join(",")}}"
     expander = PathExpander.new(args, glob)
-    files = expander.process
+    files = expander.process.to_a
     excl  = debride.option[:exclude]
     excl.map! { |fd| File.directory?(fd) ? "#{fd}/**/*" : fd } if excl
 
@@ -97,8 +101,9 @@ class Debride < MethodBasedSexpProcessor
       raise "Unhandled type: #{path_or_io.class}:#{path_or_io.inspect}"
     end
 
-    RubyParser.new.process(file, path, option[:timeout])
-  rescue Racc::ParseError, RegexpError => e
+    parser = option[:parser].new
+    parser.process file, path, option[:timeout]
+  rescue RubyParser::SyntaxError, RegexpError => e
     warn "Parse Error parsing #{path}. Skipping."
     warn "  #{e.message}"
   rescue Timeout::Error
@@ -161,6 +166,11 @@ class Debride < MethodBasedSexpProcessor
         options[:minimum] = n
       end
 
+      opts.on "--legacy", "Use RubyParser for parsing." do
+        require "ruby_parser"
+        option[:parser] = RubyParser
+      end
+
       opts.on("-v", "--verbose", "Verbose. Show progress processing files.") do
         options[:verbose] = true
       end
@@ -208,6 +218,9 @@ class Debride < MethodBasedSexpProcessor
     self.option = { :whitelist => [] }.merge options
     self.known  = Hash.new { |h,k| h[k] = Set.new }
     self.called = Set.new
+
+    option[:parser] ||= NotRubyParser
+
     super()
   end
 
@@ -330,27 +343,30 @@ class Debride < MethodBasedSexpProcessor
       end
     when *RAILS_MACRO_METHODS
       # s(:call, nil, :has_one, s(:lit, :has_one_relation), ...)
-      _, _, _, (_, name), * = sexp
+      _, _, _, name, * = sexp
 
       # 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
+        if string_like? name then
+          file, line = sexp.file, sexp.line
+          record_method name.last, file, line
+        end
       end
     when /_path$/ then
       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
+      # s(:call, nil, :alias_method, lhs, rhs)
       _, _, _, lhs, rhs = sexp
 
-      if Sexp === lhs and Sexp === rhs then
-        lhs = lhs.last
-        rhs = rhs.last
+      if string_like? lhs and string_like? rhs then
+        lhs = lhs.last.to_sym
+        rhs = rhs.last.to_sym
 
         record_method lhs, sexp.file, sexp.line
 
-        called << rhs
+        called << rhs # TODO: why?
       end
     end
 
@@ -361,6 +377,10 @@ class Debride < MethodBasedSexpProcessor
     sexp
   end
 
+  def string_like? s
+    Sexp === s and %i[lit str].include?(s.sexp_type)
+  end
+
   def process_alias exp
     _, (_, lhs), (_, rhs) = exp
 
@@ -463,6 +483,21 @@ class Debride < MethodBasedSexpProcessor
 
   alias process_safe_call process_call
 
+  def process_hash sexp
+    _, *pairs = sexp
+
+    pairs.each_slice 2 do |k, v|
+      if v.nil? && k.sexp_type == :lit then
+        called << k.last
+      else
+        process k
+        process v
+      end
+    end
+
+    sexp
+  end
+
   ##
   # Calculate the difference between known methods and called methods.
 

data/test/test_debride.rb

@@ -20,6 +20,7 @@ class TestDebride < Minitest::Test
                 :process_const,
                 :process_defn,
                 :process_defs,
+                :process_hash,
                 :process_op_asgn2,
                 :process_rb,
                 :process_safe_call,
@@ -46,13 +47,15 @@ class TestDebride < Minitest::Test
     assert_equal exp_arg, arg
   end
 
-  def assert_process exp, ruby, opts = {}
+  def assert_process exp, ruby, called:nil, **opts
     io = StringIO.new ruby
 
     debride = Debride.new opts
     debride.process debride.process_rb io
 
     assert_equal exp, debride.missing
+    assert_equal Set[*called], debride.called if called
+
     debride
   end
 
@@ -240,6 +243,40 @@ class TestDebride < Minitest::Test
     assert_process [], s
   end
 
+  def test_call__alias_method__symbol
+    ruby = <<~'RUBY'
+      class QuarterPounder
+        alias_method :get_x, :x
+      end
+    RUBY
+
+    exp = [["QuarterPounder", [:get_x]]]
+
+    assert_process exp, ruby, called:%i[x alias_method]
+  end
+
+  def test_call__alias_method__string
+    ruby = <<~'RUBY'
+      class QuarterPounder
+        alias_method "get_x", "x"
+      end
+    RUBY
+
+    exp = [["QuarterPounder", [:get_x]]]
+
+    assert_process exp, ruby, called:%i[x alias_method]
+  end
+
+  def test_call__alias_method__interpolated
+    ruby = <<~'RUBY'
+      class QuarterPounder
+        alias_method "get_#{integr}", integr
+      end
+    RUBY
+
+    assert_process [], ruby, called:%i[integr alias_method]
+  end
+
   def test_alias_method_chain
     ruby = <<-RUBY.strip
       class QuarterPounder
@@ -342,13 +379,52 @@ class TestDebride < Minitest::Test
   end
 
   def test_block_pass_empty
+    ruby = <<~RUBY
+      def g(&)
+        f(&) # block forwarding
+      end
+      g
+    RUBY
+
+    assert_process [], ruby
+  end
+
+  def test_hash__shorthand
     ruby = <<-RUBY.strip
-      f(&) # block forwarding
+      class Seattle
+        def self.status
+          { raining: }
+        end
+
+        def self.raining
+          true
+        end
+      end
+
+      Seattle.status
     RUBY
 
     assert_process [], ruby
   end
 
+  def test_hash__not_shorthand
+    ruby = <<-RUBY.strip
+      class Seattle
+        def self.status
+          { missing: }
+        end
+
+        def self.raining
+          true
+        end
+      end
+
+      Seattle.status
+    RUBY
+
+    assert_process [["Seattle", [:raining]]], ruby
+  end
+
   def test_safe_navigation_operator
     ruby = <<-RUBY.strip
       class Seattle
@@ -409,7 +485,7 @@ class TestDebride < Minitest::Test
   end
 
   def test_rails_dsl_macro_definitions
-    ruby = <<-RUBY.strip
+    ruby = <<~'RUBY'
       class RailsModel
         has_one :has_one_relation
         has_one :uncalled_has_one_relation
@@ -421,6 +497,9 @@ class TestDebride < Minitest::Test
         has_and_belongs_to_many :uncalled_has_and_belongs_to_many_relation
         scope :scope_method
         scope :uncalled_scope_method
+        scope :"interpolated_#{method}"
+        scope "another_#{method}"
+        scope "yet_another_#{method}".to_sym
 
         def instance_method_caller
           has_one_relation

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: debride
 version: !ruby/object:Gem::Version
-  version: 1.13.0
+  version: 1.15.0
 platform: ruby
 authors:
 - Ryan Davis
@@ -45,53 +45,53 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '4.17'
 - !ruby/object:Gem::Dependency
-  name: ruby_parser
+  name: prism
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.20'
+        version: '1.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.20'
+        version: '1.7'
 - !ruby/object:Gem::Dependency
   name: path_expander
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '6.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7'
+        version: '8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '6.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7'
+        version: '8'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -112,14 +112,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '4.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '4.5'
 description: Analyze code for potentially uncalled / dead methods, now with auto-removal.
 email:
 - ryand-ruby@zenspider.com
@@ -164,7 +164,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 3.7.2
 specification_version: 4
 summary: Analyze code for potentially uncalled / dead methods, now with auto-removal.
 test_files: []