bundler-timing-plugin 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 32dbf1bb3290b1c2a33914de2a2fc1ddc1372e5d52abb4ed6a4b4810561ceb0d
+  data.tar.gz: 61a59426465d4f5a4cd63f549cd81c799a55fd58477511b2accff0c0011ffb77
+SHA512:
+  metadata.gz: 004a16474d5516ae225c6368fa4bba47f66c91bf71dd8982e2498e849fb8c0c14cbd849859a3ec7a5b06d9da2b3508400a632433dd206605df0b32289939627b
+  data.tar.gz: c06940750df9ff93a709a03e2606a75c1c7a91871d018a7cd368d8f5215c626a153486be9269540521cc691069bed9a5890fe0a4e2b73b608f8e1eb3216666f3

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,53 @@
+# bundler-timing-plugin
+
+Bundler plugin that displays the elapsed time of each gem fetch and install during `bundle install`. It also prints the elapsed time of git source fetches.
+
+## Requirements
+
+Bundler 4.1.0.dev or higher. Earlier Bundler versions do not emit the `before-fetch`/`after-fetch`/`before-git-fetch`/`after-git-fetch` hooks this plugin relies on.
+
+## Installation
+
+Install the plugin globally:
+
+```
+$ bundler plugin install bundler-timing-plugin
+```
+
+Or declare it in your `Gemfile`:
+
+```ruby
+plugin "bundler-timing-plugin"
+```
+
+## Usage
+
+Once installed, the plugin is fully automatic. Running `bundle install` will print one line per gem download, install, and git source fetch:
+
+```
+$ bundle install
+Fetching gem metadata from https://rubygems.org/...
+Downloaded rails in: 0.482s
+Installed rails in: 0.137s
+Downloaded rake in: 0.094s
+Installed rake in: 0.066s
+Fetched https://github.com/example/my_gem.git in: 1.203s
+```
+
+Gems that are already fully cached and skip the download step only emit the install line. If a gem install fails, the timing line for that gem is omitted.
+
+## How it works
+
+The plugin registers six Bundler plugin hooks and uses `Process::CLOCK_MONOTONIC` to measure elapsed time:
+
+| Hook | Use |
+|---|---|
+| `before-fetch` / `after-fetch` | Time `Source::Rubygems#download_gem` |
+| `before-install` / `after-install` | Time `ParallelInstaller` install per gem |
+| `before-git-fetch` / `after-git-fetch` | Time `Source::Git` fetch and checkout |
+
+State is held in a `Mutex`-protected hash so the plugin is safe under Bundler's parallel installer.
+
+## License
+
+[MIT](LICENSE.txt)

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/timing/tracker.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+require "bundler"
+
+module Bundler
+  module Timing
+    class Tracker
+      def initialize(ui: nil)
+        @ui = ui
+        @mutex = Mutex.new
+        @starts = {}
+      end
+
+      def start_fetch(spec)
+        record(fetch_key(spec))
+      end
+
+      def finish_fetch(spec)
+        elapsed = pop(fetch_key(spec))
+        return unless elapsed
+        ui.confirm(format("Downloaded %s in: %.3fs", spec.name, elapsed))
+        @mutex.synchronize { @starts[install_key(spec)] = now }
+      end
+
+      def start_install(spec_install)
+        @mutex.synchronize { @starts[install_key(spec_install)] ||= now }
+      end
+
+      def finish_install(spec_install)
+        elapsed = pop(install_key(spec_install))
+        return unless elapsed
+        ui.confirm(format("Installed %s in: %.3fs", spec_install.name, elapsed))
+      end
+
+      def start_git_fetch(source)
+        record(git_key(source))
+      end
+
+      def finish_git_fetch(source)
+        elapsed = pop(git_key(source))
+        return unless elapsed
+        ui.confirm(format("Fetched %s in: %.3fs", git_label(source), elapsed))
+      end
+
+      private
+
+      def ui
+        @ui || Bundler.ui
+      end
+
+      def now
+        Process.clock_gettime(Process::CLOCK_MONOTONIC)
+      end
+
+      def record(key)
+        @mutex.synchronize { @starts[key] = now }
+      end
+
+      def pop(key)
+        t0 = @mutex.synchronize { @starts.delete(key) }
+        return nil unless t0
+        now - t0
+      end
+
+      def fetch_key(spec)
+        [:fetch, spec.full_name]
+      end
+
+      def install_key(obj)
+        [:install, obj.full_name]
+      end
+
+      def git_key(source)
+        [:git, source.object_id]
+      end
+
+      def git_label(source)
+        if source.respond_to?(:uri) && source.uri
+          source.uri
+        elsif source.respond_to?(:name) && source.name
+          source.name
+        else
+          source.to_s
+        end
+      end
+    end
+  end
+end

data/lib/bundler/timing/version.rb

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

data/lib/bundler/timing.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require_relative "timing/version"
+require_relative "timing/tracker"
+
+module Bundler
+  module Timing
+  end
+end

data/plugins.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "bundler"
+require "bundler/timing"
+
+tracker = Bundler::Timing::Tracker.new
+
+Bundler::Plugin.add_hook("before-fetch")     { |spec|   tracker.start_fetch(spec) }
+Bundler::Plugin.add_hook("after-fetch")      { |spec|   tracker.finish_fetch(spec) }
+Bundler::Plugin.add_hook("before-install")   { |si|     tracker.start_install(si) }
+Bundler::Plugin.add_hook("after-install")    { |si|     tracker.finish_install(si) }
+Bundler::Plugin.add_hook("before-git-fetch") { |source| tracker.start_git_fetch(source) }
+Bundler::Plugin.add_hook("after-git-fetch")  { |source| tracker.finish_git_fetch(source) }

data/sig/bundler/timing.rbs

@@ -0,0 +1,5 @@
+module Bundler
+  module Timing
+    VERSION: String
+  end
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: bundler-timing-plugin
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+  - Hiroshi SHIBATA
+bindir: bin
+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: 4.1.0.dev
+    type: :runtime
+    prerelease: true
+    version_requirements: !ruby/object:Gem::Requirement
+      requirements:
+        -
+          - ">="
+          - !ruby/object:Gem::Version
+            version: 4.1.0.dev
+description: "Bundler plugin that prints the elapsed time of each gem download, install, and git source fetch via Bundler plugin hooks."
+email:
+  - hsbt@ruby-lang.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+  - LICENSE.txt
+  - README.md
+  - Rakefile
+  - lib/bundler/timing.rb
+  - lib/bundler/timing/tracker.rb
+  - lib/bundler/timing/version.rb
+  - plugins.rb
+  - sig/bundler/timing.rbs
+homepage: "https://github.com/hsbt/bundler-timing-plugin"
+licenses:
+  - MIT
+metadata:
+  homepage_uri: "https://github.com/hsbt/bundler-timing-plugin"
+  source_code_uri: "https://github.com/hsbt/bundler-timing-plugin"
+  rubygems_mfa_required: "true"
+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: Display elapsed time of each gem fetch and install during bundle install.
+test_files: []