RSpec::StubbedEnv

ENV stubbing via a shared context for more powerful tests.

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['FOO']).to eq('is bar')
  end
end
Project RSpec::StubbedEnv
gem name rspec-stubbed_env
license License: MIT
download rank Downloads Today
version Version
continuous integration Build Status
test coverage Test Coverage
maintainability Maintainability
dependencies Depfu
code triage Open Source Helpers
homepage on Github.com, on Railsbling.com
documentation on RDoc.info
Spread ~♡ⓛⓞⓥⓔ♡~ 🌍 🌎 🌏, 🍚, , 👼, 🐛, :shipit:, Tweet Peter

Installation

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

Usage

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['FOO']).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['FOO']).to eq('is bar')
  end
end

Development

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. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/pboling/rspec-stubbed_env.

Code of Conduct

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

Versioning

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:

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

License

License: MIT