degem 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 99c4e8766d6d3f8e6f710e2e13c0e0007190617fff3f83d198b469f0aec2ffb9
-  data.tar.gz: 4df2c08f44fc1eb1c694a85ae55d36421f4610bb717f3789eb8b5feb93c726e3
+  metadata.gz: 683ca7f47acea423692062935b4ccd5285e5aa764a12883a4f34237af7be248a
+  data.tar.gz: 1a9a8e898b9f4afcd1668b65a0ebc2b7928a84efa6c31e263c237114fa0a2069
 SHA512:
-  metadata.gz: 26145f7a46f9b9a3152092ba4fa7065261630b66c5edf443d7e90d1eff1c88264814edefc3048d73c39b24cb7a7e9709114baf5959133de351b841967f17fba0
-  data.tar.gz: 5f3d721a7bf24c8541f93d5a67672ca71f8bfa7550a11822af4e214d6e338d905b9a4f8a3324457593de276c88cbb18eaf10af910faa8470a9abca9096787eca
+  metadata.gz: b8e874de8d90b2a2e833b1685938ce9302426c3af5acf8e60bcf26cb0dab994a1520173269a366969018e69fb1abba74f1c4900235a0f7051739073a3962f70d
+  data.tar.gz: 6c19cd8a7e75ef66396e4dc209a14b77765e323804952769cd30a0d9267abb15bf9388ab58ee3f22002320585bb211f80d9d0e86163c7ac0a6b50e992b046cb6

data/lib/degem/cli.rb

@@ -9,33 +9,29 @@ module Degem
     end
 
     def initialize(stderr)
-      @stderr = stderr
+      Degem.stderr = stderr
     end
 
     def call
       unless gemfile_exists?
-        @stderr.puts "Gemfile not found in the current directory"
+        Degem.stderr.puts "Gemfile not found in the current directory"
         return 1
       end
 
       unused = find_unused.call
       decorated = decorate_rubygems.call(unused)
-      Report.new(@stderr).call(decorated)
+      Report.new.call(decorated)
       0
     end
 
     private
 
     def find_unused
-      FindUnused.new(
-        gemfile_path: GEMFILE,
-        gem_specification: Gem::Specification,
-        grep: Grep.new(@stderr)
-      )
+      FindUnused.new(gemfile_path: GEMFILE)
     end
 
     def decorate_rubygems
-      DecorateRubygems.new(
+      DecorateUnusedGems.new(
         gem_specification: Gem::Specification,
         git_adapter: GitAdapter.new
       )

data/lib/degem/{decorate_rubygems.rb → decorate_unused_gems.rb}

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Degem
-  class DecorateRubygems
+  class DecorateUnusedGems
     def initialize(gem_specification:, git_adapter:)
       @gem_specification = gem_specification
       @git_adapter = git_adapter
@@ -11,7 +11,7 @@ module Degem
       rubygems.map do |rubygem|
         gemspec = @gem_specification.find_by_name(rubygem.name)
         git = @git_adapter.call(rubygem.name)
-        Rubygem.new(rubygem, gemspec, git)
+        UnusedGem.new(rubygem, gemspec, git)
       end
     end
   end

data/lib/degem/find_unused.rb

@@ -2,16 +2,16 @@
 
 module Degem
   class FindUnused
-    def initialize(gemfile_path:, gem_specification:, grep: Grep.new, bundle_paths: GitLsFiles.new)
+    def initialize(gemfile_path:, gem_specification: Gem::Specification, bundle_paths: GitLsFiles.new)
       @gemfile_path = gemfile_path
       @gem_specification = gem_specification
-      @grep = grep
-      @bundle_paths = bundle_paths.call(File.dirname(gemfile_path))
+      fallback = Dir.glob(File.join(File.dirname(gemfile_path), "**/*.rb"))
+      @bundle_paths = bundle_paths.call(fallback)
     end
 
     def call
       rubygems = gemfile.rubygems.reject { _1.name == "degem" }
-      rubygems = reject_railties(rubygems) if rails?
+      rubygems = reject_railties(rubygems) if gemfile.rails?
       reject_used(rubygems)
     end
 
@@ -20,162 +20,36 @@ module Degem
     attr_reader :gemfile_path
 
     def reject_railties(rubygems)
-      rubygems
-        .reject { _1.name == "rails" }
-        .reject do |rubygem|
-          gem_path = @gem_specification.find_by_name(rubygem.name).full_gem_path
-          @grep.match?(/(Rails::Railtie|Rails::Engine)/, gem_path)
-        end
+      rubygems.reject(&:rails?).reject(&:railtie?)
     end
 
     def reject_used(rubygems)
-      candidates = rubygems.map { Matcher.new(rubygem: _1, matchers: matchers) }
-      @grep.inverse_many(candidates, @bundle_paths).map(&:rubygem)
-    end
-
-    def matchers
-      [
-        method(:based_on_top_module),
-        method(:based_on_top_composite_module_dash),
-        method(:based_on_top_composite_module_underscore),
-        method(:based_on_top_call),
-        method(:based_on_top_composite_call_dash),
-        method(:based_on_top_composite_call_underscore),
-        method(:based_on_require),
-        method(:based_on_require_prefix_path),
-        method(:based_on_require_path)
-      ].compact
-    end
-
-    def gemfile
-      @gemfile ||= ParseGemfile.new.call(gemfile_path)
-    end
-
-    def rails?
-      @rails ||= gemfile.rails?
-    end
-
-    # gem foo -> Foo:: (but not XFoo:: or X::Foo)
-    def based_on_top_module(rubygem, line)
-      return false if rubygem.name.include?("-")
-
-      regex = %r{
-        (?<!\w::) # Do not match if :: before
-        (?<!\w) # Do not match if \w before
-        #{rubygem.name.capitalize}
-        ::
-      }x
-      regex.match?(line)
-    end
-
-    # gem foo_bar -> FooBar (but not XFooBar or X::FooBar)
-    def based_on_top_composite_module_underscore(rubygem, line)
-      return false unless rubygem.name.include?("_")
-
-      regex = %r{
-        (?<!\w::) # Do not match if :: before
-        (?<!\w) # Do not match if \w before
-        #{rubygem.name.split("_").map(&:capitalize).join}
-        ::
-      }x
-      regex.match?(line)
-    end
-
-    # gem foo-bar -> Foo::Bar (but not XFoo::Bar or X::Foo::Bar)
-    def based_on_top_composite_module_dash(rubygem, line)
-      return false unless rubygem.name.include?("-")
-
-      regex = %r{
-        (?<!\w::) # Do not match if :: before
-        (?<!\w) # Do not match if \w before
-        #{rubygem.name.split("-").map(&:capitalize).join("::")}
-      }x
-      regex.match?(line)
-    end
-
-    # gem foo -> Foo. (but not X::Foo. or XBar.)
-    def based_on_top_call(rubygem, line)
-      return false if rubygem.name.include?("-")
-
-      regex = %r{
-        (?<!\w::) # Do not match if :: before
-        (?<!\w) # Do not match if \w before
-        #{rubygem.name.capitalize}
-        \.
-      }x
-      regex.match?(line)
-    end
-
-    # gem foo-bar -> FooBar. (but not X::FooBar. or XFooBar.)
-    def based_on_top_composite_call_dash(rubygem, line)
-      return false unless rubygem.name.include?("-")
-
-      regex = %r{
-        (?<!\w::) # Do not match if :: before
-        (?<!\w) # Do not match if \w before
-        #{rubygem.name.split("-").map(&:capitalize).join}
-        \.
-      }x
-      regex.match?(line)
+      bundle = ParseRuby.new.call(@bundle_paths)
+      rubygems = reject_required(rubygems, bundle.requires)
+      reject_consts(rubygems, bundle.consts)
     end
 
-    # gem foo_bar -> FooBar. (but not X::FooBar. or XFooBar.)
-    def based_on_top_composite_call_underscore(rubygem, line)
-      return false unless rubygem.name.include?("_")
-
-      regex = %r{
-        (?<!\w::) # Do not match if :: before
-        (?<!\w) # Do not match if \w before
-        #{rubygem.name.split("_").map(&:capitalize).join}
-        \.
-      }x
-      regex.match?(line)
-    end
-
-    # gem foo-bar -> require 'foo-bar'
-    def based_on_require(rubygem, line)
-      regex = %r{
-        ^
-        \s*
-        require
-        \s+
-        ['"]
-        #{rubygem.name}
-        ['"]
-      }x
-      regex.match?(line)
+    def reject_consts(rubygems, bundle_consts)
+      rubygems.reject do |rubygem|
+        rubygem.own_consts.any? do |own_const|
+          bundle_consts.include?(own_const)
+        end
+      end
     end
 
-    # gem foo-bar -> require 'foo/bar'
-    def based_on_require_path(rubygem, line)
-      return false unless rubygem.name.include?("-")
+    def reject_required(rubygems, bundle_requires)
+      rubygems.reject do |rubygem|
+        bundle_requires.any? do |bundle_require|
+          next true if bundle_require == rubygem.name
+          next true if bundle_require == rubygem.name.tr("-", "/")
 
-      regex = %r{
-        ^
-        \s*
-        require
-        \s+
-        ['"]
-        #{rubygem.name.tr("-", "/")} # match foo/bar when rubygem is foo-bar
-        ['"]
-      }x
-      regex.match?(line)
+          bundle_require.start_with?("#{rubygem.name}/")
+        end
+      end
     end
 
-    # gem foo -> require 'foo/'
-    def based_on_require_prefix_path(rubygem, line)
-      return false if rubygem.name.include?("-")
-
-      regex = %r{
-        ^
-        \s*
-        require
-        \s+
-        ['"]
-        #{rubygem.name}
-        /
-      }x
-      regex.match?(line)
+    def gemfile
+      @gemfile ||= ParseGemfile.new(@gem_specification).call(gemfile_path)
     end
   end
 end

data/lib/degem/gemfile.rb

@@ -2,22 +2,28 @@
 
 module Degem
   class Gemfile
-    def initialize(dsl)
+    def initialize(dsl:, gem_specification:)
       @dsl = dsl
+      @gem_specification = gem_specification
     end
 
     def rubygems
-      @rubygems ||= (gemfile_dependencies + gemspec_dependencies).uniq
+      @rubygems ||=
+        (gemfile_dependencies + gemspec_dependencies)
+        .map { Rubygem.new(rubygem: _1, gem_specification: @gem_specification) }
+        .uniq
     end
 
     def rails?
-      @rails ||= rubygems.map(&:name).include?("rails")
+      !!rubygems.find(&:rails?)
     end
 
     private
 
     def gemfile_dependencies
-      @dsl.dependencies.select(&:should_include?)
+      @dsl.dependencies.select(&:should_include?).reject do |dependency|
+        @dsl.gemspecs.flat_map(&:name).include?(dependency.name)
+      end
     end
 
     def gemspec_dependencies

data/lib/degem/parse_gemfile.rb

@@ -2,10 +2,14 @@
 
 module Degem
   class ParseGemfile
+    def initialize(gem_specification = Gem::Specification)
+      @gem_specification = gem_specification
+    end
+
     def call(gemfile_path)
       dsl = Bundler::Dsl.new
       dsl.eval_gemfile(gemfile_path)
-      Gemfile.new(dsl)
+      Gemfile.new(dsl: dsl, gem_specification: @gem_specification)
     end
 
     private

data/lib/degem/parse_ruby.rb

@@ -0,0 +1,117 @@
+# frozen_string_literal: true
+
+module Degem
+  class ParseRuby
+    def initialize(visitor = Visitor)
+      @visitor = visitor
+    end
+
+    def call(path)
+      visitor = @visitor.new
+      Array(path).each do |path|
+        visitor.path = path
+        Prism.parse_file(path).value.accept(visitor)
+        Degem.stderr.putc "."
+      end
+      visitor
+    end
+  end
+
+  require "prism"
+
+  class Visitor < Prism::Visitor
+    def initialize
+      @requires = Set.new
+      @paths = Set.new
+      @classes = Set.new
+      @modules = Set.new
+      @path = nil
+      @stack = []
+      super
+    end
+
+    def requires = @requires.to_a
+    def consts = (@paths.union(@classes).union(@modules)).to_a
+    def paths = @paths.to_a
+    def classes = @classes.to_a
+    def modules = @modules.to_a
+    attr_writer :path
+
+    def visit_call_node(node)
+      visit_require_call_node(node)
+      super
+    end
+
+    def visit_module_node(node)
+      @stack.push(node)
+      super
+      @modules.add(@stack.map(&:name).join("::"))
+      @stack.pop
+    end
+
+    def visit_class_node(node)
+      @stack.push(node)
+      super
+      @stack.pop
+      *modules, klass = node.constant_path.full_name_parts rescue [[], node.name]
+      @modules.add((@stack.map(&:name) + modules).join("::")) if modules.any?
+      @classes.add((@stack.map(&:name) + modules + [klass]).join("::"))
+    end
+
+    def visit_constant_path_node(node)
+      paths_from(node).each { @paths.add(_1) }
+      super
+    end
+
+    def visit_constant_read_node(node)
+      @paths.add(node.name.to_s) unless @stack.find { _1.constant_path == node }
+      super
+    end
+
+    private
+
+    def visit_require_call_node(node)
+      return if node.name.to_s != "require"
+      return if node.receiver
+      return unless node.arguments
+      return unless node.arguments.arguments[0].is_a?(Prism::StringNode)
+
+      required = node.arguments.arguments[0].unescaped
+      @requires.add(required)
+    end
+
+    def from_ancestor_to(node)
+      acc = [node]
+      node = node.respond_to?(:parent) && node.parent
+      while node
+        acc.prepend(node)
+        node = node.respond_to?(:parent) && node.parent
+      end
+      acc
+    end
+
+    def paths_from(node)
+      from_ancestor_to(node)
+        .filter_map { _1.respond_to?(:name) ? _1.name.to_s : nil }
+        .tap { _1.singleton_class.include(Scan) }
+        .scan { |a, b| [a, b].join("::") }
+    end
+  end
+
+  module Scan
+    def scan(init = nil)
+      if init.nil?
+        init = self[0]
+        xs = self[1..] || []
+      else
+        xs = self
+      end
+
+      return self if xs.empty?
+
+      xs.reduce([init]) do |acc, x|
+        acc + [yield(acc.last, x)]
+      end
+    end
+  end
+end

data/lib/degem/report.rb

@@ -2,21 +2,17 @@
 
 module Degem
   class Report
-    def initialize(stderr)
-      @stderr = stderr
-    end
-
     def call(rubygems)
-      @stderr.puts
-      @stderr.puts
-      @stderr.puts "The following gems may be unused:"
-      @stderr.puts
+      Degem.stderr.puts
+      Degem.stderr.puts
+      Degem.stderr.puts "The following gems may be unused (#{rubygems.size}):"
+      Degem.stderr.puts
 
       rubygems.each do |rubygem|
         gem_name(rubygem)
-        @stderr.puts
+        Degem.stderr.puts
         commits(rubygem)
-        @stderr.puts
+        Degem.stderr.puts
       end
     end
 
@@ -30,15 +26,15 @@ module Degem
           "#{rubygem.name}: #{rubygem.source_code_uri}"
         end
 
-      @stderr.puts(heading)
-      @stderr.puts("=" * heading.size)
+      Degem.stderr.puts(heading)
+      Degem.stderr.puts("=" * heading.size)
     end
 
     def commits(rubygem)
       rubygem.commits.each.with_index do |commit, i|
-        @stderr.puts("#{commit.hash[0..6]} (#{commit.date}) #{commit.title}")
-        @stderr.puts(commit.url)
-        @stderr.puts if i + 1 == rubygem.commits.size
+        Degem.stderr.puts("#{commit.hash[0..6]} (#{commit.date}) #{commit.title}")
+        Degem.stderr.puts(commit.url)
+        Degem.stderr.puts if i + 1 == rubygem.commits.size
       end
     end
   end

data/lib/degem/rubygem.rb

@@ -1,16 +1,48 @@
 # frozen_string_literal: true
 
+require "delegate"
+
 module Degem
-  class Rubygem < MultiDelegator
-    attr_reader :commits
+  class Rubygem < SimpleDelegator
+    def initialize(rubygem:, gem_specification:)
+      @gem_specification = gem_specification
+      super(rubygem)
+    end
+
+    def rails?
+      name == "rails"
+    end
 
-    def initialize(_, _, commits)
-      super
-      @commits = commits
+    def railtie?
+      parsed.consts.grep(/Rails::Railtie|Rails::Engine/).any?
     end
 
-    def source_code_uri
-      metadata["source_code_uri"] || homepage
+    def own_consts
+      variations = [
+        name,
+        name.delete("_-"),
+        name.gsub("_", "::"),
+        name.gsub("-", "::"),
+        *name.split("_").each_cons(2).to_a.map { _1.join("::") },
+        *name.split("_").each_cons(2).to_a.map(&:join),
+        *name.split("-").each_cons(2).to_a.map { _1.join("::") },
+        *name.split("-").each_cons(2).to_a.map(&:join)
+      ]
+
+      parsed.classes + (parsed.modules + parsed.paths).filter do |const|
+        variations.any? { |variation| const.downcase == variation.downcase }
+      end
+    end
+
+    private
+
+    def parsed
+      @parsed ||=
+        begin
+          gem_path = @gem_specification.find_by_name(name).full_gem_path
+          paths = Dir.glob(File.join(gem_path, "**", "lib", "**/*.rb"))
+          ParseRuby.new.call(paths)
+        end
     end
   end
 end

data/lib/degem/{decorated.rb → unused_gem.rb}

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Degem
-  class Rubygem < MultiDelegator
+  class UnusedGem < MultiDelegator
     attr_reader :commits
 
     def initialize(_, _, commits)

data/lib/degem/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Degem
-  VERSION = "0.1.0"
+  VERSION = "0.3.0"
 end

data/lib/degem.rb

@@ -2,18 +2,25 @@
 
 require_relative "degem/version"
 require_relative "degem/gemfile"
+require_relative "degem/rubygem"
 require_relative "degem/parse_gemfile"
-require_relative "degem/grep"
 require_relative "degem/git_ls_files"
-require_relative "degem/matcher"
+require_relative "degem/parse_ruby"
 require_relative "degem/find_unused"
 require_relative "degem/multi_delegator"
-require_relative "degem/rubygem"
-require_relative "degem/decorate_rubygems"
+require_relative "degem/unused_gem"
+require_relative "degem/decorate_unused_gems"
 require_relative "degem/commit"
 require_relative "degem/git_adapter"
 require_relative "degem/report"
 require_relative "degem/cli"
 
 module Degem
+  class << self
+    attr_writer :stderr
+
+    def stderr
+      @stderr ||= $stderr
+    end
+  end
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: degem
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - 3v0k4
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-12-05 00:00:00.000000000 Z
-dependencies: []
+date: 2024-12-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: prism
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
 description: Degem finds unused gems in the Ruby bundle (ie, an app with a `Gemfile`
   or a gem with both a `Gemfile` and a gemspec).
 email:
@@ -23,18 +37,17 @@ files:
 - lib/degem.rb
 - lib/degem/cli.rb
 - lib/degem/commit.rb
-- lib/degem/decorate_rubygems.rb
-- lib/degem/decorated.rb
+- lib/degem/decorate_unused_gems.rb
 - lib/degem/find_unused.rb
 - lib/degem/gemfile.rb
 - lib/degem/git_adapter.rb
 - lib/degem/git_ls_files.rb
-- lib/degem/grep.rb
-- lib/degem/matcher.rb
 - lib/degem/multi_delegator.rb
 - lib/degem/parse_gemfile.rb
+- lib/degem/parse_ruby.rb
 - lib/degem/report.rb
 - lib/degem/rubygem.rb
+- lib/degem/unused_gem.rb
 - lib/degem/version.rb
 homepage: https://github.com/3v0k4/degem
 licenses:

data/lib/degem/grep.rb

@@ -1,42 +0,0 @@
-# frozen_string_literal: true
-
-require "find"
-
-module Degem
-  class Grep
-    def initialize(stderr = StringIO.new)
-      @stderr = stderr
-    end
-
-    def match?(matcher, dir)
-      Find.find(File.expand_path(dir)) do |path|
-        next unless File.file?(path)
-        next if File.extname(path) != ".rb"
-
-        @stderr.putc "."
-        File.foreach(path) do |line|
-          next unless matcher.match?(line)
-
-          return true
-        end
-      end
-
-      false
-    end
-
-    def inverse_many(matchers, paths)
-      Find.find(*paths) do |path|
-        next unless File.file?(path)
-
-        @stderr.putc "."
-        File.foreach(path) do |line|
-          matchers = matchers.reject do |matcher|
-            matcher.match?(line)
-          end
-        end
-      end
-
-      matchers
-    end
-  end
-end

data/lib/degem/matcher.rb

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-module Degem
-  class Matcher
-    attr_reader :rubygem
-
-    def initialize(rubygem:, matchers:)
-      @rubygem = rubygem
-      @matchers = matchers
-    end
-
-    def match?(string)
-      @matchers.any? { _1.call(@rubygem, string) }
-    end
-  end
-end