💎 RequireBench

if ci_badges.map(&:color).detect { it != "green"} ☝️ let me know on Discord or RubyForum, as I may have missed the notification.

if ci_badges.map(&:color).all? { it == "green"} 👇️ send money so I can do more of this. FLOSS maintenance is now my full-time job.

Tokens to Remember
Works with JRuby
Works with Truffle Ruby
Works with MRI Ruby 4
Works with MRI Ruby 3
Works with MRI Ruby 2
Support & Community
Source
Documentation
Compliance
Style
Maintainer 🎖️
... 💖	🧊 🐙 🛖 🧪

Compatible with MRI Ruby 2.2.0+, JRuby, and TruffleRuby. CI workflows and Appraisals are generated for MRI Ruby 2.4+. This test floor is configured by ruby.test_minimum in .kettle-jem.yml and may be higher than the gem's runtime compatibility floor when legacy Rubies are not practical for the current toolchain.

The amazing test matrix is powered by the kettle-dev stack.

How kettle-dev manages complexity in tests

Gem	Source	Role	Total downloads
appraisal2	GitHub	multi-dependency Appraisal matrix generation
appraisal2-rubocop	GitHub	RuboCop Appraisal generator integration
kettle-dev	GitHub	development, release, and CI workflow tooling
kettle-jem	GitHub	Appraisals & CI workflow templates
kettle-soup-cover	GitHub	SimpleCov coverage policy and reporting
kettle-test	GitHub	standard test runner and coverage harness
rubocop-lts	GitHub	Ruby-version-aware linting
turbo_tests2	GitHub	parallel test execution

Available as part of the Tidelift Subscription.

Install the gem and add to the application's Gemfile by executing:

bundle add require_bench

If bundler is not being used to manage dependencies, install the gem by executing:

gem install require_bench

RequireBench is disabled unless REQUIRE_BENCH is exactly "true". When enabled, require require_bench/tasks near the top of the Rakefile and use its task options to select ignored libraries and output behavior.

Require the library where it will be loaded prior to any other requires you want to benchmark.

require "require_bench"

By default this gem does nothing, hacks nothing, and has zero effects.

Add an environment variable, however you normally do such things, so that in Ruby:

ENV["REQUIRE_BENCH"] == "true"

Any value other than 'true' means RequireBench is still turned off.

Require in Rakefile:

require "bundler/setup"
require "require_bench/tasks" # Near the top, just below require 'bundler/setup'!

Require in Rakefile:

require_relative "config/application"
require "require_bench/tasks" if ENV["REQUIRE_BENCH"] == "true" # Near the top, just below require_relative 'config/application'!

When running from command line, you will see output as the Rails app boots. In the case below it ignores all gem libraries, and only tracks Rails. The output at the top shows the config being used.

$ REQUIRE_BENCH=true bundle exec rake require_bench:hello
[RequireBench] Using skip pattern: (?-mix:gems)
[RequireBench] Using include pattern: (?-mix:my_app)
[RequireBench] Using no group pattern: (?-mix:ext|config)
🚥 [RequireBench-r] ☑️   0.005564 /Volumes/🐉🩸/src/apps/my_app/lib/middleware/omniauth_bypass.rb 🚥
🚥 [RequireBench-r] ☑️   0.001099 /Volumes/🐉🩸/src/apps/my_app/lib/middleware/sidekiq/match_deployment_rules.rb 🚥
🚥 [RequireBench-r] ☑️   0.001121 /Volumes/🐉🩸/src/apps/my_app/lib/middleware/sidekiq/request_store.rb 🚥
🚥 [RequireBench-r] ☑️   0.000989 /Volumes/🐉🩸/src/apps/my_app/lib/middleware/sidekiq/clear_active_record_connections.rb 🚥
🚥 [RequireBench-r] ☑️   0.006890 /Volumes/🐉🩸/src/apps/my_app/lib/middleware/sidekiq/worker_killer.rb 🚥
🚥 [RequireBench-r] ☑️   0.001990 /Volumes/🐉🩸/src/apps/my_app/lib/parsers/pku_parser.rb 🚥

[RequireBench] Slowest Loads by Library, in order
 1.   0.017653 my_app
==========
  0.017653 TOTAL

If the output is too noisy from deep libraries you can add a regex to skip benchmarking of files that match.

export REQUIRE_BENCH_SKIP_PATTERN=activesupport,rspec

ENV['REQUIRE_BENCH_SKIP_PATTERN'] must be one of:

• a string, to be split by comma (,), then joined by pipe (|) with Regexp.union
• a string, to be split by pipe (|), then joined by pipe (|) with Regexp.union

ENV["REQUIRE_BENCH_SKIP_PATTERN"] = "activesupport,rspec"
# or
ENV["REQUIRE_BENCH_SKIP_PATTERN"] = "activesupport|rspec"

Any file being required that matches the pattern will use the standard, rather than the benchmarked, require.

Fully qualified paths, or any portion thereof, are fine, because the strings are always Regexp escaped.

• wrap/log load in addition to require
  • ENV['REQUIRE_BENCH_TRACKED_METHODS']
• rescue errors
  • ENV['REQUIRE_BENCH_RESCUED_CLASSES']
• log start
  • ENV['REQUIRE_BENCH_LOG_START']
• load/require timeout
  • ENV['REQUIRE_BENCH_TIMEOUT']
• A pattern for paths that should be included/tracked
  • ENV['REQUIRE_BENCH_INCLUDE_PATTERN']
• Should grouping be by basename or by path?
  • ENV['REQUIRE_BENCH_GROUP_PRECEDENCE']
• Prefer to not group some pattern (i.e. some libraries)
  • ENV['REQUIRE_BENCH_NO_GROUP_PATTERN']

If you'd like to help document any of these further, PRs are appreciated!

While galtzo-floss tools are free software and will always be, the project would benefit immensely from some funding. Raising a monthly budget of... "dollars" would make the project more sustainable.

We welcome both individual and corporate sponsors! We also offer a wide array of funding channels to account for your preferences. Currently, Open Collective is our preferred funding platform.

If you're working in a company that's making significant use of galtzo-floss tools we'd appreciate it if you suggest to your company to become a galtzo-floss sponsor.

You can support the development of galtzo-floss tools via GitHub Sponsors, Liberapay, PayPal, Open Collective and Tidelift.

Support us with a monthly donation and help us continue our activities. [Become a backer]

NOTE: kettle-readme-backers updates this list every day, automatically.

No backers yet. Be the first!

Become a sponsor and get your logo on our README on GitHub with a link to your site. [Become a sponsor]

NOTE: kettle-readme-backers updates this list every day, automatically.

No sponsors yet. Be the first!

I’m driven by a passion to foster a thriving open-source community – a space where people can tackle complex problems, no matter how small. Revitalizing libraries that have fallen into disrepair, and building new libraries focused on solving real-world challenges, are my passions. I was recently affected by layoffs, and the tech jobs market is unwelcoming. I’m reaching out here because your support would significantly aid my efforts to provide for my family, and my farm (11 🐔 chickens, 2 🐶 dogs, 3 🐰 rabbits, 8 🐈‍ cats).

If you work at a company that uses my work, please encourage them to support me as a corporate sponsor. My work on gems you use might show up in bundle fund.

I’m developing a new library, floss_funding, designed to empower open-source developers like myself to get paid for the work we do, in a sustainable way. Please give it a look.

Floss-Funding.dev: 👉️ No network calls. 👉️ No tracking. 👉️ No oversight. 👉️ Minimal crypto hashing. 💡 Easily disabled nags

See SECURITY.md.

If you need some ideas of where to help, you could work on adding more code coverage, check issues or PRs, or use the gem and think about how it could be better.

We so if you make changes, remember to update it.

See CONTRIBUTING.md for more detailed instructions.

See CONTRIBUTING.md.

Everyone interacting with this project's codebases, issue trackers, chat rooms and mailing lists agrees to follow the .

Made with contributors-img.

Also see GitLab Contributors: https://gitlab.com/galtzo-floss/require_bench/-/graphs/main

This library follows for its public API where practical. For most applications, prefer the Pessimistic Version Constraint with two digits of precision.

For example:

spec.add_dependency("require_bench", "~> 1.0")

See CHANGELOG.md for a list of releases.

The gem is available as open source under the terms of the MIT .

See LICENSE.md for the official copyright notice.

Maintainers have teeth and need to pay their dentists. After getting laid off in an RIF in March, and encountering difficulty finding a new one, I began spending most of my time building open source tools. I'm hoping to be able to pay for my kids' health insurance this month, so if you value the work I am doing, I need your support. Please consider sponsoring me or the project.

To join the community or get help, use the RubyForum or Discord.

To say "thanks!" ☝️ Join the community or 👇️ send money.

💌 💌 💌

Many parts of this project are actively managed by a kettle-jem smart template utilizing StructuredMerge.org merge contracts.

Thanks for RTFM. ☺️