🫥 RSpec::StubbedEnv

🌻 Synopsis

An ENV stubbing / hiding library for sophisticated RSpec test suites.

• ENV stubbing and hiding via shared contexts for more powerful tests
  • ENV hiding via hide_env("FOO") was added in v1.0.2
• No need to add dotenv just for the spec suite

ruby describe "my stubbed test" do include_context "with stubbed env" include_context "with hidden env" context "with FOO=is bar" do before do stub_env("FOO" => "is bar") end it "has a value" do expect(ENV.fetch("FOO", nil)).to(eq("is bar")) expect(ENV.fetch("FOO")).to(eq("is bar")) expect(ENV["FOO"]).to(eq("is bar")) end end context "without BAR set" do before do hide_env("BAR") end it "is nil" do expect(ENV.fetch("BAR", nil)).to(be_nil) expect(ENV["BAR"]).to(be_nil) end it "raises error" do expect { ENV.fetch("BAR") }.to(raise_error(KeyNotFound)) end end end

This gem has no runtime dependencies.

I expect the current release of this gem to be compatible with Ruby 1.8.7+, but it is only tested on CI against Ruby 2.3+, due to the inherent limitations of GitHub Actions.

| 🚚 Amazing test matrix was brought to you by | 🔎 appraisal2 🔎 | |------------------------------------------------|--------------------------------------------------------------------------------------| | 👟 Check it out! | ✨ github.com/appraisal-rb/appraisal2 ✨ |

💡 Info you can shake a stick at

Federated DVCS

Enterprise Support

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

✨ Installation

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

$ bundle add rspec-stubbed_env

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

$ gem install rspec-stubbed_env

🔒 Secure Installation

🔧 Basic Usage

You must configure RSpec to use the :expect syntax, or some compatible alternative.

ruby RSpec.configure do |config| config.expect_with(:rspec) do |c| c.syntax = :expect end end

Require the library in your spec/test helper somewhere: ruby require "rspec/stubbed_env"

ENV stubbing

• is opt-in, via a shared context, rather than global.
• does not affect the real ENV at all. It is a true stub.
• has the same scope as a before, subject, or let at the same level.

See the spec suite for detailed examples.

```ruby

This is normal, without stubbing, ENV is not set

describe "vanilla" do it "has no ENV stub" do expect(ENV.fetch("FOO", nil)).to(benil) expect(ENV["FOO"]).to(benil) end end

With a stubbed ENV!

describe "my stubbed test" do includecontext "with stubbed env" before do stubenv("FOO" => "is bar") end it "has a value" do expect(ENV.fetch("FOO", nil)).to(eq("is bar")) expect(ENV["FOO"]).to(eq("is bar")) end end ```

ENV can be stubbed trough the stub_env method, or key/value pairs to be stubbed can be provided directly to the include_context call:

```ruby describe "my stubbed test" do include_context "with stubbed env", "FOO" => "is bar"

it "has a value" do expect(ENV.fetch("FOO", nil)).to(eq("is bar")) expect(ENV["FOO"]).to(eq("is bar")) end end ```

If you want to make stub_env method available globally (without the include_context call), you can add in the spec_helper.

I do not recommend the global approach, as it results in a loss of clarity on which tests are testing ENV-based behaviors. Here's a foot-gun if you want it.

ruby RSpec.configure do |config| config.include(RSpec::StubbedEnv::StubHelpers) # Or you could include the context globally # config.include_context "with stubbed env" end

ENV hiding

• is opt-in, via a shared context, rather than global.
• does not affect the real ENV at all. It is a true stub.
• has the same scope as a before, subject, or let at the same level.

See the spec suite for detailed examples.

```ruby

This is normal, without hiding, ENV is set

ENV["MYPATH"] = "/home/doodle" describe "vanilla" do it "has ENV with nothing hidden" do expect(ENV.fetch("MYPATH", nil)).to("/home/doodle") expect(ENV["MY_PATH"]).to("/home/doodle") end end

With a hidden ENV variable!

describe "my hidden test" do includecontext "with hidden env" before do hideenv("MYPATH") end it "MYPATH is not set" do expect(ENV.fetch("MYPATH", nil)).to(benil) expect(ENV["MYPATH"]).to(benil) end end ```

ENV variables can be hidden trough the hide_env method, or variable names to be hidden can be provided directly to the include_context call:

```ruby describe "my hidden test" do includecontext "with hidden env", "MYPATH"

it "MYPATH is not set" do expect(ENV.fetch("MYPATH", nil)).to(benil) expect(ENV["MYPATH"]).to(be_nil) end end ```

If you want to make hide_env method available globally (without the include_context call), you can add in the spec_helper:

I do not recommend the global approach, as it results in a loss of clarity on which tests are testing ENV-based behaviors. Here's a foot-gun if you want it.

ruby RSpec.configure do |config| config.include(RSpec::StubbedEnv::HideHelpers) # Or you could include the context globally # config.include_context "with hidden env" end

🚚 Switch to main branch

We migrated from master to main as the default branch. If this affected your local checkout:

console git branch -m master main git fetch origin git branch -u origin/main main git remote set-head origin -a

🔐 Security

See SECURITY.md.

🤝 Contributing

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.

🚀 Release Instructions

See CONTRIBUTING.md.

Code Coverage

🪇 Code of Conduct

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

🌈 Contributors

Made with contributors-img.

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

⭐️ Star History

📌 Versioning

This Library adheres to . Violations of this scheme should be reported as bugs. Specifically, if a minor or patch version is released that breaks backward compatibility, a new version should be immediately released that restores compatibility. Breaking changes to the public API will only be introduced with new major versions.

📌 Is "Platform Support" part of the public API?

Yes. But I'm obligated to include notes...

SemVer should, but doesn't explicitly, say that dropping support for specific Platforms is a breaking change to an API. It is obvious to many, but not all, and since the spec is silent, the bike shedding is endless.

dropping support for a platform is both obviously and objectively a breaking change

• Jordan Harband (@ljharb, maintainer of SemVer) in SemVer issue 716

To get a better understanding of how SemVer is intended to work over a project's lifetime, read this article from the creator of SemVer:

• "Major Version Numbers are Not Sacred"

As a result of this policy, and the interpretive lens used by the maintainer, you can (and should) specify a dependency on these libraries using the Pessimistic Version Constraint with two digits of precision.

For example:

ruby spec.add_dependency("rspec-stubbed_env", "~> 1.0")

See CHANGELOG.md for a list of releases.

📄 License

The gem is available as open source under the terms of the MIT License . See LICENSE.txt for the official Copyright Notice.

© Copyright

• Copyright (c) 2018-2020, 2024-2025 Peter H. Boling, of Galtzo.com , and rspec-stubbed_env contributors

🤑 One more thing

Having arrived at the bottom of the page, please endure a final supplication. The primary maintainer of this gem, Peter Boling, wants Ruby to be a great place for people to solve problems, big and small. Please consider supporting his efforts via the giant yellow link below, or one of the smaller ones, depending on button size preference.

P.S. If you need help️ or want to say thanks, 👇 Join the Discord.