RSpec::StubbedEnv

ENV stubbing via a shared context for more powerful tests. Now you don't need to add dotenv just for your spec suite.

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

Project	RSpec::StubbedEnv
gem name	rspec-stubbed_env
license
download rank
version
dependencies
continuous integration
test coverage
maintainability
code triage
homepage	on Github.com, on Railsbling.com
documentation	on RDoc.info
Spread ♡ⓛⓞⓥⓔ♡	, 🧊, 🛖, 🧪, 🌏, 👼, ⚗️,

Add this line to your application's Gemfile:

gem "rspec-stubbed_env", :group => :test

And then execute:

$ bundle

Or install it yourself as:

$ gem install rspec-stubbed_env

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

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

Require the library in your spec/test helper somewhere:

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.

# This is normal, without stubbing, ENV is not set
describe "vanilla" do
  it "has no ENV stub" do
    expect(ENV.fetch("FOO", nil)).to(be_nil)
  end
end

# With a stubbed ENV!
describe "my stubbed test" do
  include_context "with stubbed env"
  before do
    stub_env("FOO" => "is bar")
  end
  it "has a value" do
    expect(ENV.fetch("FOO", nil)).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:

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"))
  end
end

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

RSpec.configure do |config|
  config.include(RSpec::StubbedEnv::TestHelpers)
end

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

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

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install.

See CONTRIBUTING.md.

• Liam Bennet of LittleOwlLabs was the original author.
• Peter H. Boling of Rails Bling has been maintaining since 2018.

See CONTRIBUTING.md. contributing: https://gitlab.com/pboling/rspec-stubbed_env/-/blob/main/CONTRIBUTING.md

Everyone interacting in the AnonymousActiveRecord project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.

This library aims to adhere to Semantic Versioning 2.0.0. 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.

As a result of this policy, you can (and should) specify a dependency on this gem using the Pessimistic Version Constraint with two digits of precision.

For example in a Gemfile:

gem 'rspec-stubbed_env', '~> 1.0', group: [:development, :test]

or in a gemspec

spec.add_development_dependency 'rspec-stubbed_env', '~> 1.0'

• Copyright © 2014 LittlOwlLabs Liam Bennet
• Copyright © 2018-2020, 2023 Peter H. Boling of Rails Bling