bundler-why-plugin 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e6e84117a1e8c9c8e87564646be2035584aee1d907a283fa353f56079e7fa81a
+  data.tar.gz: 8491724b3eea6c326131ec854063daee113b032a5a62b81201e35e8ad5520e9f
+SHA512:
+  metadata.gz: 5d7f2c7e89d464d29f8bb7d471d63debd45137c71fc26d4f9f8b5dfca2366053c9b540e498a4df7393c393f4a2499cdd2e868f6e1d5a29802067684994c7ea20
+  data.tar.gz: 140c8a23e42241cb808fa8056c52cecfb59853f31cf5765b2e1db0a5d2bad2736491fa494324a194bcae490c7d49e8069893fbe51cf0320282c0091e2f677651

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2026 Hiroshi SHIBATA
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,73 @@
+# Bundler Why
+
+A Bundler plugin that shows why a specific package is installed in your Ruby project, similar to `yarn why` in Yarn/npm.
+
+This gem is a Bundler plugin that helps you understand the dependency tree of your gems and why a particular gem is required by your project.
+
+## Installation
+
+Install this plugin by running:
+
+```bash
+bundle plugin install bundler-why-plugin
+```
+
+To install from a local path during development:
+
+```bash
+bundle plugin install bundler-why-plugin --source /path/to/bundler-why-plugin
+```
+
+## Usage
+
+To see why a specific package is installed:
+
+```bash
+bundle why <package_name>
+```
+
+### Example
+
+```bash
+$ bundle why json
+json (2.7.0)
+
+Directly required by:
+  bundler (2.5.0) [>= 0]
+
+Location: /Users/hsbt/.gem/ruby/3.3.0/gems/json-2.7.0/lib/json.rb
+```
+
+## How It Works
+
+The `bundle why` command performs the following:
+
+1. **Parses your Gemfile.lock**: Loads the current bundle configuration
+2. **Analyzes dependencies**: Traces which gems depend on the specified package
+3. **Displays results**: Shows:
+   - The gem's version number
+   - Direct dependents (gems that directly require it)
+   - All dependents (both direct and indirect)
+   - The gem's installation location
+
+## Features
+
+- Shows direct dependents of a package
+- Traces the full dependency chain
+- Displays gem versions and requirement specifiers
+- Handles both direct and transitive dependencies
+- Clear, Yarn-like output format
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/hsbt/bundler-why-plugin.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+task default: :test

data/lib/bundler/why/cli.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require "thor"
+require "bundler/why/dependency_resolver"
+
+module Bundler
+  module Why
+    class CLI < Thor
+      desc "why PACKAGE", "Show why a specific package is installed"
+      def why(package_name = nil)
+        if package_name.nil?
+          Bundler.ui.error("Error: Please specify a package name")
+          Bundler.ui.error("Usage: bundle why <package_name>")
+          exit 1
+        end
+
+        resolver = DependencyResolver.new
+        result = resolver.analyze(package_name)
+
+        unless result
+          Bundler.ui.error("Error: Package '#{package_name}' not found in Gemfile.lock")
+          exit 1
+        end
+
+        display_result(result, resolver)
+      end
+
+      def self.exit_on_failure?
+        true
+      end
+
+      private
+
+      def display_result(result, resolver)
+        Bundler.ui.info("#{result[:name]} (#{result[:version]})")
+        Bundler.ui.info("")
+
+        # 依存関係チェーンを表示
+        chains = resolver.find_dependency_chain(result[:name])
+        
+        if chains.any?
+          Bundler.ui.info("Used by:")
+          chains.each do |chain|
+            chain_str = chain.join(" > ")
+            Bundler.ui.info("  #{chain_str}")
+          end
+        else
+          # 直接の依存元を表示
+          direct_dependents = result[:direct_dependents]
+          if direct_dependents.any?
+            Bundler.ui.info("Directly required by:")
+            direct_dependents.each do |dependent|
+              Bundler.ui.info("  #{dependent[:name]} (#{dependent[:version]}) [#{dependent[:requirement]}]")
+            end
+          else
+            Bundler.ui.info("Required by:")
+            all_dependents = result[:all_dependents]
+            if all_dependents.any?
+              all_dependents.each do |dependent|
+                Bundler.ui.info("  #{dependent[:name]} (#{dependent[:version]})")
+              end
+            else
+              Bundler.ui.warn("Not required by any other packages (may be a direct dependency)")
+            end
+          end
+        end
+
+        Bundler.ui.info("")
+        if result[:path]
+          Bundler.ui.info("Location: #{result[:path]}")
+        end
+      end
+    end
+  end
+end

data/lib/bundler/why/dependency_resolver.rb

@@ -0,0 +1,127 @@
+# frozen_string_literal: true
+
+require "bundler"
+
+module Bundler
+  module Why
+    class DependencyResolver
+      def initialize
+        @definition = Bundler.definition
+        @specs = @definition.specs
+      end
+
+      # 指定されたパッケージがなぜ必要かを分析
+      def analyze(package_name)
+        spec = find_spec(package_name)
+        return nil unless spec
+
+        {
+          name: spec.name,
+          version: spec.version.to_s,
+          direct_dependents: find_direct_dependents(spec),
+          all_dependents: find_all_dependents(spec),
+          path: spec.loaded_from
+        }
+      end
+
+      # 指定されたパッケージを検索
+      def find_spec(package_name)
+        @specs.find { |spec| spec.name == package_name || spec.name.downcase == package_name.downcase }
+      end
+
+      # 直接的な依存元（親）を取得
+      def find_direct_dependents(spec)
+        dependents = []
+        
+        @specs.each do |other_spec|
+          other_spec.dependencies.each do |dep|
+            if dep.name == spec.name
+              dependents << {
+                name: other_spec.name,
+                version: other_spec.version.to_s,
+                requirement: dep.requirement.to_s
+              }
+            end
+          end
+        end
+        
+        dependents
+      end
+
+      # すべての依存元（直接・間接）を取得
+      def find_all_dependents(spec)
+        dependents = Set.new
+        queue = [spec.name]
+        visited = Set.new
+
+        while queue.any?
+          current_name = queue.shift
+          next if visited.include?(current_name)
+          visited.add(current_name)
+
+          @specs.each do |other_spec|
+            other_spec.dependencies.each do |dep|
+              if dep.name == current_name
+                dependents.add(other_spec.name)
+                queue << other_spec.name unless visited.include?(other_spec.name)
+              end
+            end
+          end
+        end
+
+        dependents.map do |name|
+          dep_spec = find_spec(name)
+          {
+            name: name,
+            version: dep_spec&.version.to_s
+          }
+        end
+      end
+
+      # 依存関係チェーンを取得
+      def find_dependency_chain(target_name)
+        spec = find_spec(target_name)
+        return nil unless spec
+
+        chains = []
+        
+        # Gemfileの直接の依存関係を確認
+        @definition.dependencies.each do |dep|
+          if is_dependency_of?(target_name, dep.name)
+            chain = trace_chain(dep.name, target_name, [dep.name])
+            chains << chain if chain
+          end
+        end
+
+        chains
+      end
+
+      private
+
+      # targetが sourceの依存関係にあるかチェック
+      def is_dependency_of?(target, source)
+        source_spec = find_spec(source)
+        return false unless source_spec
+
+        source_spec.dependencies.any? { |dep| dep.name == target }
+      end
+
+      # 依存関係チェーンをトレース
+      def trace_chain(current, target, path)
+        current_spec = find_spec(current)
+        return nil unless current_spec
+
+        return path if current == target
+
+        current_spec.dependencies.each do |dep|
+          if is_dependency_of?(target, dep.name)
+            chain = trace_chain(dep.name, target, path + [dep.name])
+            return chain if chain
+          end
+        end
+
+        nil
+      end
+    end
+  end
+end

data/lib/bundler/why/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Bundler
+  module Why
+    VERSION = "0.1.0"
+  end
+end

data/lib/bundler/why.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler"
+require_relative "why/version"
+require_relative "why/cli"
+require_relative "why/dependency_resolver"
+
+module Bundler
+  module Why
+    class Error < StandardError; end
+  end
+end

data/plugins.rb

@@ -0,0 +1,14 @@
+require "bundler"
+require "bundler/why"
+
+module Bundler
+  module Why
+    class Plugin < ::Bundler::Plugin::API
+      command "why"
+
+      def exec(command_name, args)
+        ::Bundler::Why::CLI.start(args)
+      end
+    end
+  end
+end

data/sig/bundler/why.rbs

@@ -0,0 +1,25 @@
+module Bundler
+  module Why
+    VERSION: String
+
+    class Error < StandardError
+    end
+
+    class DependencyResolver
+      def initialize: () -> void
+      def analyze: (String package_name) -> { name: String, version: String, direct_dependents: Array[Hash[String, String]], all_dependents: Array[Hash[String, String]], path: String }?
+      def find_spec: (String package_name) -> ::Gem::Specification?
+      def find_direct_dependents: (::Gem::Specification spec) -> Array[Hash[String, String]]
+      def find_all_dependents: (::Gem::Specification spec) -> Array[Hash[String, String]]
+      def find_dependency_chain: (String target_name) -> Array[Array[String]]
+    end
+
+    class CLI < Thor
+      def why: (String? package_name) -> void
+    end
+
+    class Plugin < ::Bundler::Plugin::API
+      def exec: (String command_name, Array[String] args) -> void
+    end
+  end
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: bundler-why-plugin
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Hiroshi SHIBATA
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: A Bundler plugin that shows the dependency tree for a specific package,
+  similar to 'yarn why' in Yarn.
+email:
+- hsbt@ruby-lang.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/bundler/why.rb
+- lib/bundler/why/cli.rb
+- lib/bundler/why/dependency_resolver.rb
+- lib/bundler/why/version.rb
+- plugins.rb
+- sig/bundler/why.rbs
+homepage: https://github.com/hsbt/bundler-why-plugin
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/hsbt/bundler-why-plugin
+  source_code_uri: https://github.com/hsbt/bundler-why-plugin
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.1.0.dev
+specification_version: 4
+summary: Bundler plugin to show why a package is installed
+test_files: []