degem 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 99c4e8766d6d3f8e6f710e2e13c0e0007190617fff3f83d198b469f0aec2ffb9
+  data.tar.gz: 4df2c08f44fc1eb1c694a85ae55d36421f4610bb717f3789eb8b5feb93c726e3
+SHA512:
+  metadata.gz: 26145f7a46f9b9a3152092ba4fa7065261630b66c5edf443d7e90d1eff1c88264814edefc3048d73c39b24cb7a7e9709114baf5959133de351b841967f17fba0
+  data.tar.gz: 5f3d721a7bf24c8541f93d5a67672ca71f8bfa7550a11822af4e214d6e338d905b9a4f8a3324457593de276c88cbb18eaf10af910faa8470a9abca9096787eca

data/exe/degem

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "degem"
+Degem::Cli.call

data/lib/degem/cli.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Degem
+  class Cli
+    GEMFILE = "Gemfile"
+
+    def self.call
+      exit new($stderr).call
+    end
+
+    def initialize(stderr)
+      @stderr = stderr
+    end
+
+    def call
+      unless gemfile_exists?
+        @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)
+      0
+    end
+
+    private
+
+    def find_unused
+      FindUnused.new(
+        gemfile_path: GEMFILE,
+        gem_specification: Gem::Specification,
+        grep: Grep.new(@stderr)
+      )
+    end
+
+    def decorate_rubygems
+      DecorateRubygems.new(
+        gem_specification: Gem::Specification,
+        git_adapter: GitAdapter.new
+      )
+    end
+
+    def gemfile_exists?
+      File.file?(GEMFILE)
+    end
+  end
+end

data/lib/degem/commit.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+Commit = Data.define(:hash, :date, :title, :url)

data/lib/degem/decorate_rubygems.rb

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

data/lib/degem/decorated.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Degem
+  class Rubygem < MultiDelegator
+    attr_reader :commits
+
+    def initialize(_, _, commits)
+      super
+      @commits = commits
+    end
+
+    def source_code_uri
+      metadata["source_code_uri"] || homepage
+    end
+  end
+end

data/lib/degem/find_unused.rb

@@ -0,0 +1,181 @@
+# frozen_string_literal: true
+
+module Degem
+  class FindUnused
+    def initialize(gemfile_path:, gem_specification:, grep: Grep.new, bundle_paths: GitLsFiles.new)
+      @gemfile_path = gemfile_path
+      @gem_specification = gem_specification
+      @grep = grep
+      @bundle_paths = bundle_paths.call(File.dirname(gemfile_path))
+    end
+
+    def call
+      rubygems = gemfile.rubygems.reject { _1.name == "degem" }
+      rubygems = reject_railties(rubygems) if rails?
+      reject_used(rubygems)
+    end
+
+    private
+
+    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
+    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)
+    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)
+    end
+
+    # gem foo-bar -> require 'foo/bar'
+    def based_on_require_path(rubygem, line)
+      return false unless rubygem.name.include?("-")
+
+      regex = %r{
+        ^
+        \s*
+        require
+        \s+
+        ['"]
+        #{rubygem.name.tr("-", "/")} # match foo/bar when rubygem is foo-bar
+        ['"]
+      }x
+      regex.match?(line)
+    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)
+    end
+  end
+end

data/lib/degem/gemfile.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Degem
+  class Gemfile
+    def initialize(dsl)
+      @dsl = dsl
+    end
+
+    def rubygems
+      @rubygems ||= (gemfile_dependencies + gemspec_dependencies).uniq
+    end
+
+    def rails?
+      @rails ||= rubygems.map(&:name).include?("rails")
+    end
+
+    private
+
+    def gemfile_dependencies
+      @dsl.dependencies.select(&:should_include?)
+    end
+
+    def gemspec_dependencies
+      @dsl.gemspecs.flat_map(&:dependencies)
+    end
+  end
+end

data/lib/degem/git_adapter.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "open3"
+
+module Degem
+  class GitAdapter
+    def call(gem_name)
+      out, _err, status = git_log(gem_name)
+      return [] unless status.zero?
+
+      out.split("\n").map do |commit|
+        hash, date, title = commit.split("\t")
+        Commit.new(hash:, date:, title:, url: to_commit_url(hash))
+      end
+    end
+
+    private
+
+    def git_remote_origin_url
+      out, err, status = Open3.capture3("git remote get-url origin")
+      [out, err, status.exitstatus]
+    end
+
+    def git_log(gem_name)
+      out1, err1, status1 = git_log_gemfile(gem_name)
+      out2, err2, status2 = git_log_gemspec(gem_name)
+
+      [
+        [out1.to_s, out2.to_s].join,
+        [err1.to_s, err2.to_s].join,
+        (status1 + status2) < 2 ? 0 : 1
+      ]
+    end
+
+    def git_log_gemfile(gem_name)
+      out, err, status = Open3.capture3([
+        "git log",
+        "--pretty=format:'%H%x09%cs%x09%s'",
+        "--pickaxe-regex",
+        "--follow",
+        "-S \"gem\\s*['\\\"]#{gem_name}['\\\"]\"",
+        "--",
+        "Gemfile",
+        "|",
+        "cat"
+      ].join(" "))
+
+      [out, err, status.exitstatus]
+    end
+
+    def git_log_gemspec(gem_name)
+      out, err, status = Open3.capture3([
+        "git log",
+        "--pretty=format:'%H%x09%cs%x09%s'",
+        "--pickaxe-regex",
+        "--follow",
+        "-S \"spec\\.add_(development_)?dependency\\s*['\\\"]#{gem_name}['\\\"]\"",
+        "--",
+        "*.gemspec",
+        "|",
+        "cat"
+      ].join(" "))
+
+      [out, err, status.exitstatus]
+    end
+
+    def to_commit_url(commit_hash)
+      remote, _, status = git_remote_origin_url
+      return "" unless status.zero?
+
+      repository = (remote.match(%r{github\.com[:/](.+?)(\.git)}) || [])[1]
+      return "" if repository.nil?
+
+      "https://github.com/#{repository}/commit/#{commit_hash}"
+    end
+  end
+end

data/lib/degem/git_ls_files.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require "open3"
+
+module Degem
+  class GitLsFiles
+    def call(fallback)
+      out, _err, status = git_ls
+      return fallback unless status.zero?
+
+      out.split("\x0").select { _1.end_with?(".rb") }.map { File.expand_path(_1) }
+    end
+
+    private
+
+    def git_ls
+      out, err, status = Open3.capture3("git ls-files -z")
+      [out, err, status.exitstatus]
+    end
+  end
+end

data/lib/degem/grep.rb

@@ -0,0 +1,42 @@
+# 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

@@ -0,0 +1,16 @@
+# 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

data/lib/degem/multi_delegator.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Degem
+  class MultiDelegator
+    def initialize(*delegates)
+      @delegates = delegates
+    end
+
+    def method_missing(method, *args)
+      delegate = @delegates.find { _1.respond_to?(method) }
+      return delegate.public_send(method, *args) if delegate
+
+      super
+    end
+
+    def respond_to_missing?(method, include_private = false)
+      @delegates.any? { _1.respond_to?(method, include_private) } || super
+    end
+  end
+end

data/lib/degem/parse_gemfile.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Degem
+  class ParseGemfile
+    def call(gemfile_path)
+      dsl = Bundler::Dsl.new
+      dsl.eval_gemfile(gemfile_path)
+      Gemfile.new(dsl)
+    end
+
+    private
+
+    def definition(gemfile_path)
+      Bundler::Dsl.evaluate(gemfile_path, nil, {})
+    end
+  end
+end

data/lib/degem/report.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+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
+
+      rubygems.each do |rubygem|
+        gem_name(rubygem)
+        @stderr.puts
+        commits(rubygem)
+        @stderr.puts
+      end
+    end
+
+    private
+
+    def gem_name(rubygem)
+      heading =
+        if rubygem.source_code_uri.nil?
+          rubygem.name
+        else
+          "#{rubygem.name}: #{rubygem.source_code_uri}"
+        end
+
+      @stderr.puts(heading)
+      @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
+      end
+    end
+  end
+end

data/lib/degem/rubygem.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Degem
+  class Rubygem < MultiDelegator
+    attr_reader :commits
+
+    def initialize(_, _, commits)
+      super
+      @commits = commits
+    end
+
+    def source_code_uri
+      metadata["source_code_uri"] || homepage
+    end
+  end
+end

data/lib/degem/version.rb

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

data/lib/degem.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require_relative "degem/version"
+require_relative "degem/gemfile"
+require_relative "degem/parse_gemfile"
+require_relative "degem/grep"
+require_relative "degem/git_ls_files"
+require_relative "degem/matcher"
+require_relative "degem/find_unused"
+require_relative "degem/multi_delegator"
+require_relative "degem/rubygem"
+require_relative "degem/decorate_rubygems"
+require_relative "degem/commit"
+require_relative "degem/git_adapter"
+require_relative "degem/report"
+require_relative "degem/cli"
+
+module Degem
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: degem
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- 3v0k4
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-12-05 00:00:00.000000000 Z
+dependencies: []
+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:
+- riccardo.odone@gmail.com
+executables:
+- degem
+extensions: []
+extra_rdoc_files: []
+files:
+- exe/degem
+- lib/degem.rb
+- lib/degem/cli.rb
+- lib/degem/commit.rb
+- lib/degem/decorate_rubygems.rb
+- lib/degem/decorated.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/report.rb
+- lib/degem/rubygem.rb
+- lib/degem/version.rb
+homepage: https://github.com/3v0k4/degem
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/3v0k4/degem
+  source_code_uri: https://github.com/3v0k4/degem
+  changelog_uri: https://github.com/3v0k4/degem/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.23
+signing_key:
+specification_version: 4
+summary: Find unused gems in the Ruby bundle
+test_files: []