if ci_badges.map(&:color).detect { it != "green"} ☝️ let me know, as I may have missed the discord 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.

kettle-wash is for gems that define runtime behavior in constants, especially constants whose values are conditionally derived from ENV.

Ruby constants are usually loaded once. That is a problem for test suites that need to prove every line and branch of a constant definition file, because a second example cannot naturally re-run:

DO_COV = ENV.fetch("K_SOUP_COV_DO", "false").casecmp?("true")
COVERAGE_DIR = ENV.fetch("K_SOUP_COV_DIR", "coverage")

kettle-wash gives those constant-owning modules a small reset API. Specs can delete the declared constants, mutate ENV, reload the source file, and then assert the alternate branch. This lets coverage tools see the real constant definition lines and branches execute, instead of forcing projects to choose between accurate coverage and constant-backed configuration.

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

Compatible with MRI Ruby 3.2.0+, and concordant releases of JRuby, and TruffleRuby. CI workflows and Appraisals are generated for MRI Ruby 3.2.0+. 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	Daily download rank
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

Find this repo on federated forges (Coming soon!)

Federated DVCS Repository	Status	Issues	PRs	Wiki	CI	Discussions
🧪 kettle-dev/kettle-wash on GitLab	The Truth	💚	💚	💚	🐭 Tiny Matrix	➖
🧊 kettle-dev/kettle-wash on CodeBerg	An Ethical Mirror (Donate)	💚	💚	➖	⭕️ No Matrix	➖
🐙 kettle-dev/kettle-wash on GitHub	Another Mirror	💚	💚	💚	💯 Full Matrix	💚
🎮️ Discord Server		Let's	talk	about	this	library!

Available as part of the Tidelift Subscription.

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

bundle add kettle-wash

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

gem install kettle-wash

There is no global configuration. Each consumer declares the constants it owns and the file that can rebuild them.

Use Kettle::Wash::Change when a module has constants derived from environment or runtime state and specs need to reset those constants between examples for accurate line and branch coverage.

require "kettle/wash"

module MyGem
  module Constants
    VALUE = ENV.fetch("MY_GEM_VALUE", "default")

    include Kettle::Wash::Change.new(
      constants: %w[
        VALUE
      ],
      path: "my_gem/constants.rb"
    )
  end
end

The generated singleton methods remove only the declared constants:

MyGem::Constants.delete_const

MyGem::Constants.reset_const do
  ENV["MY_GEM_VALUE"] = "changed"
end

In specs, use stub_env from rspec-stubbed_env inside reset_const. The constants are deleted before the block runs, then the configured file is loaded again after the block finishes. This avoids modifying the real process environment.

require "rspec/stubbed_env"

RSpec.describe MyGem::Constants do
  include_context "with stubbed env"

  it "uses the default value" do
    described_class.reset_const do
      stub_env("MY_GEM_VALUE" => nil)
    end

    expect(described_class::VALUE).to eq("default")
  end

  it "uses the configured value" do
    described_class.reset_const do
      stub_env("MY_GEM_VALUE" => "configured")
    end

    expect(described_class::VALUE).to eq("configured")
  end
end

That shape lets SimpleCov see both examples execute the actual constant definition line. For a production use, see kettle-soup-cover's constants specs, which reset Kettle::Soup::Cover::Constants under different K_SOUP_COV_* environment values to cover branch-heavy constant definitions.

See SECURITY.md.

If you need some ideas of where to help, you could work on adding more code coverage, or if it is already 💯 (see below) 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/kettle-dev/kettle-wash/-/graphs/main

⭐️ Star History

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("kettle-wash", "~> 0.1")

See CHANGELOG.md for a list of releases.

The gem is available under the following licenses: AGPL-3.0-only, PolyForm-Small-Business-1.0.0, Big-Time-Public-License. See LICENSE.md for details.

If none of the available licenses suit your use case, please contact us to discuss a custom commercial license.

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 👇️ Join the Discord.

To say "thanks!" ☝️ Join the Discord 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. ☺️