bundler_install_stats 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5085ef61f5eac19c41432cf624de7530ed466c3cbaef0cc6e53351520d83bed0
+  data.tar.gz: d24f40026afecc95efe83c01e595026a3d4b7f66861b11154babaa3bf3472320
+SHA512:
+  metadata.gz: 465211566c3c62f032fb936a0419006b1f9ebfeb5c0d409be6a226e14fb4f3ec5a96765d46488943796093778d1bbaac5e8f08859b2681143923811d830dc95f
+  data.tar.gz: 9800905769e64d9183cf52d05fd48e791d25ee82a5191c49d35f05f7891fe1a57c94db0f93a2436130e7fbcc1050d65e9d403d45b4a29682fbb226f7081399fa

data/.github/workflows/ci.yml

@@ -0,0 +1,25 @@
+name: CI
+on: [push, pull_request]
+jobs:
+  rubocop:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: '3.2'
+        bundler-cache: true
+    - run: bundle exec rake rubocop
+  tests:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: ['2.7', '3.0', '3.1', '3.2']
+    name: Ruby ${{ matrix.ruby }}
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+    - run: bundle exec rake test

data/.github/workflows/cla.yml

@@ -0,0 +1,22 @@
+name: Contributor License Agreement (CLA)
+
+on:
+  pull_request_target:
+    types: [opened, synchronize]
+  issue_comment:
+    types: [created]
+
+jobs:
+  cla:
+    runs-on: ubuntu-latest
+    if: |
+      (github.event.issue.pull_request 
+        && !github.event.issue.pull_request.merged_at
+        && contains(github.event.comment.body, 'signed')
+      ) 
+      || (github.event.pull_request && !github.event.pull_request.merged)
+    steps:
+      - uses: Shopify/shopify-cla-action@v1
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          cla-token: ${{ secrets.CLA_TOKEN }}

data/.github/workflows/release.yml

@@ -0,0 +1,24 @@
+name: Release
+on:
+  workflow_dispatch:
+    branches: [ main ]
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: '3.1'
+        bundler-cache: true
+    - name: Install dependencies
+      run: if [[ $(uname) == "Darwin" ]]; then brew install graphviz; else sudo apt-get install graphviz; fi
+    - name: Test
+      run: bundle exec rake
+    - name: Build
+      run: gem build seafoam.gemspec
+    - name: Upload
+      uses: actions/upload-artifact@v3
+      with:
+        name: release-build
+        path: 'seafoam-*.gem'

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rubocop.yml

@@ -0,0 +1,7 @@
+inherit_gem:
+  rubocop-shopify: rubocop.yml
+
+AllCops:
+  TargetRubyVersion: 2.7
+  SuggestExtensions: false
+  NewCops: disable

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+opensource@shopify.com.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

data/CONTRIBUTING.md

@@ -0,0 +1,5 @@
+# Contribution
+
+Contributions welcome. Please discuss big ideas in an issue first.
+
+You'll need to sign the Shopify Contributor License Agreement (CLA) https://cla.shopify.com/.

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's runtime dependencies in the gemspec
+gemspec
+
+# Specify development dependencies here
+gem "bundler"
+gem "rake", "~> 13.0"
+gem "minitest", "~> 5.0", require: false
+gem "rubocop-shopify", require: false

data/Gemfile.lock

@@ -0,0 +1,50 @@
+PATH
+  remote: .
+  specs:
+    bundler_install_stats (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    json (2.6.3)
+    minitest (5.17.0)
+    parallel (1.22.1)
+    parser (3.2.0.0)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.6.2)
+    rexml (3.2.5)
+    rubocop (1.44.1)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.24.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.24.1)
+      parser (>= 3.1.1.0)
+    rubocop-shopify (2.11.1)
+      rubocop (~> 1.42)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (2.4.2)
+
+PLATFORMS
+  arm64-darwin-21
+  arm64-darwin-22
+  x86_64-darwin-20
+  x86_64-linux
+
+DEPENDENCIES
+  bundler
+  bundler_install_stats!
+  minitest (~> 5.0)
+  rake (~> 13.0)
+  rubocop-shopify
+
+BUNDLED WITH
+   2.4.6

data/LICENSE.md

@@ -0,0 +1,7 @@
+Copyright 2019-present, Shopify Inc.
+
+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,32 @@
+# Bundler Install Stats
+
+## Introduction
+
+This a plugin for Bundler that records and reports how long it takes to install each gem. It may be helpful in the
+following situations:
+
+  * Diagnosing a slow CI run
+  * Tracking the install cost of dependencies over time
+  * Evaluating the impact of pure Ruby vs native extensions
+  * Evaluating the impact of pre-compiled native extensions vs those compiled on demand
+
+## Installation
+
+In order to use this plugin, you must install it via Bundler:
+
+```bash
+bundle plugin install bundle-install-stats
+```
+
+If you're working on the plugin locally, you can install with:
+
+```bash
+bundle plugin uninstall bundler_install_stats
+bundle plugin install --git $PWD bundler_install_stats
+```
+
+Then you should see the plugin list when you run:
+
+```bash
+bundle plugin list
+```

data/Rakefile

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.ruby_opts = ["-W0", "-W:deprecated"]
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: [:test, :rubocop]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "bundler_install_stats"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/rake

@@ -0,0 +1,31 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path(
+  "../../Gemfile",
+  Pathname.new(__FILE__).realpath,
+)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rake", "rake")

data/bin/rubocop

@@ -0,0 +1,31 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rubocop' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path(
+  "../../Gemfile",
+  Pathname.new(__FILE__).realpath,
+)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rubocop", "rubocop")

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/bundler-install-stats.gemspec

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative "lib/bundler_install_stats/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "bundler_install_stats"
+  spec.version       = BundlerInstallStats::VERSION
+  spec.authors       = ["Shopify Engineering"]
+  spec.email         = ["gems@shopify.com"]
+
+  spec.summary       = "A Bundler plugin for measuring gem installation stats."
+  spec.description   = "A plugin for measuring gem installation stats. Discover which are your slowest gems to install."
+  spec.homepage      = "https://github.com/Shopify/bundler-install-stats"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/releases"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    %x(git ls-files -z).split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

data/dev.yml

@@ -0,0 +1,30 @@
+name: bundler-install-stats
+
+type: ruby
+
+up:
+  - ruby: '3.2.1'
+  - bundler
+
+commands:
+  console:
+    desc: Open console with the gem loaded
+    run: bin/console
+  build:
+    desc: Build the gem using rake build
+    run: bin/rake build
+  test:
+    desc: Run tests
+    syntax:
+      argument: file
+      optional: args...
+    run:  |
+      if [[ $# -eq 0 ]]; then
+        bin/rake test
+      else
+        bin/rake -I test "$@"
+      fi
+  style:
+    desc: Run rubocop
+    aliases: [rubocop, lint]
+    run: bin/rubocop

data/lib/bundler_install_stats/gem_installation_hook.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+require "bundler/plugin/events"
+
+module BundlerInstallStats
+  class GemInstallationHook
+    class << self
+      def register
+        @private_gem_times = {}
+        @public_gem_times = {}
+        @mutex = Mutex.new
+
+        #   A hook called before each individual gem is installed
+        #   Includes a Bundler::ParallelInstaller::SpecInstallation.
+        #   No state, error, post_install_message will be present as nothing has installed yet
+        #   GEM_BEFORE_INSTALL = "before-install"
+        Bundler::Plugin.add_hook(Bundler::Plugin::Events::GEM_BEFORE_INSTALL) do |gem_spec|
+          now = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+          public_gem = public_gem?(gem_spec.spec)
+
+          unless public_gem
+            puts "\n\n"
+            puts "*" * 20
+            pp(gem_spec.spec.source.remotes.collect(&:host))
+            puts "*" * 20
+            puts "\n\n"
+          end
+
+          @mutex.synchronize do
+            if public_gem
+              @public_gem_times[gem_spec.full_name] = now
+            else
+              @private_gem_times[gem_spec.full_name] = now
+            end
+          end
+        end
+
+        #   A hook called after each individual gem is installed
+        #   Includes a Bundler::ParallelInstaller::SpecInstallation.
+        #     - If state is failed, an error will be present.
+        #     - If state is success, a post_install_message may be present.
+        #   GEM_AFTER_INSTALL = "after-install"
+        Bundler::Plugin.add_hook(Bundler::Plugin::Events::GEM_AFTER_INSTALL) do |gem_spec|
+          now = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+          public_gem = public_gem?(gem_spec.spec)
+
+          diff = @mutex.synchronize do
+            if public_gem
+              @public_gem_times[gem_spec.full_name] = now - @public_gem_times[gem_spec.full_name]
+            else
+              @private_gem_times[gem_spec.full_name] = now - @private_gem_times[gem_spec.full_name]
+            end
+          end
+
+          puts "#{gem_spec.full_name} took #{diff}s to install"
+        end
+
+        #   A hook called before any gems install
+        #   Includes an Array of Bundler::Dependency objects
+        #   GEM_BEFORE_INSTALL_ALL = "before-install-all"
+        Bundler::Plugin.add_hook(Bundler::Plugin::Events::GEM_BEFORE_INSTALL_ALL) do |_dependencies|
+          puts "Before all gem installation"
+        end
+
+        #   A hook called after any gems install
+        #   Includes an Array of Bundler::Dependency objects
+        #   GEM_AFTER_INSTALL_ALL = "after-install-all"
+        Bundler::Plugin.add_hook(Bundler::Plugin::Events::GEM_AFTER_INSTALL_ALL) do |_dependencies|
+          puts "After all gem installation (times in seconds)"
+
+          @mutex.synchronize do
+            puts "Private gems:"
+            pp(@private_gem_times.sort_by { |_k, v| v }.to_h)
+
+            puts "\n\nPublic gems:"
+            pp(@public_gem_times.sort_by { |_k, v| v }.to_h)
+          end
+        end
+      end
+
+      def public_gem?(gem_spec)
+        if gem_spec.is_a?(Bundler::Source::Metadata)
+          puts "*" * 10
+          pp(gem_spec)
+          puts "*" * 10
+
+          raise "bad"
+        end
+
+        remotes = begin
+          gem_spec.source.remotes
+        rescue
+          []
+        end
+        remotes.all? do |r|
+          r.host == "rubygems.org"
+        rescue
+          false
+        end
+      end
+    end
+  end
+end

data/lib/bundler_install_stats/version.rb

@@ -0,0 +1,6 @@
+# typed: false
+# frozen_string_literal: true
+
+module BundlerInstallStats
+  VERSION = "0.1.0"
+end

data/lib/bundler_install_stats.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "sorbet-runtime"
+require_relative "bundler_install_stats/gem_installation_hook"
+require_relative "bundler_install_stats/version"
+
+module BundlerInstallStats
+end

data/plugins.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler_install_stats"
+BundlerInstallStats::GemInstallationHook.register

data/service.yml

@@ -0,0 +1 @@
+classification: library

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: bundler_install_stats
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Shopify Engineering
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2023-03-23 00:00:00.000000000 Z
+dependencies: []
+description: A plugin for measuring gem installation stats. Discover which are your
+  slowest gems to install.
+email:
+- gems@shopify.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ci.yml"
+- ".github/workflows/cla.yml"
+- ".github/workflows/release.yml"
+- ".gitignore"
+- ".rubocop.yml"
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.md
+- README.md
+- Rakefile
+- bin/console
+- bin/rake
+- bin/rubocop
+- bin/setup
+- bundler-install-stats.gemspec
+- dev.yml
+- lib/bundler_install_stats.rb
+- lib/bundler_install_stats/gem_installation_hook.rb
+- lib/bundler_install_stats/version.rb
+- plugins.rb
+- service.yml
+- shipit.rubygems.yml
+homepage: https://github.com/Shopify/bundler-install-stats
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/Shopify/bundler-install-stats
+  source_code_uri: https://github.com/Shopify/bundler-install-stats
+  changelog_uri: https://github.com/Shopify/bundler-install-stats/releases
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.9
+signing_key: 
+specification_version: 4
+summary: A Bundler plugin for measuring gem installation stats.
+test_files: []