Project

permafrost

0.0
No release in over 3 years
Low commit activity in last 3 years
Environment variables are a standard way for configuring applications in production. It allows for quickly changing the configuration, and avoids having to introduce secrets in the code. When testing code that relies on environment variables, it becomes problematic to mock the environment, and even more to clean up afterwards. Permafrost allows you to define a limited scope where the environment is set as you decide, returning it to its original state afterwards.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies
 Project Readme

Permafrost

Freeze the environment (i.e. ENV) in a limited scope.

Inspired by Timecop.

Installation

Add this line to your application's Gemfile:

gem "permafrost", "~> 1.0"

And then execute:

$ bundle install

Or install it yourself as:

$ gem install permafrost

Usage

Freeze the environment, and change it at will inside a sandbox:

ENV # { "RAILS_ENV" => "production", ... }

Permafrost.freeze do
  ENV.clear # {}
end

ENV # { "RAILS_ENV" => "production", ... }

Or, set the environment to use inside the sandbox:

ENV # { "RAILS_ENV" => "production", ... }

Permafrost.freeze("foo" => "bar") do
  ENV # { "foo" => "bar" }
end

ENV # { "RAILS_ENV" => "production", ... }

You can also just change something in the environment, leaving the rest as it is:

ENV # { "RAILS_ENV" => "production", ... }

Permafrost.merge("foo" => "bar") do
  ENV # { "RAILS_ENV" => "production", ..., "foo" => "bar" }
end

ENV # { "RAILS_ENV" => "production", ... }

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake to run the linter and 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/subvisual/permafrost.

License

Permafrost is copyright © 2020 Subvisual, Lda.

It is open-source, made available for free, and is subject to the terms in its license.

About

Permafrost was created and is maintained with ❤️ by Subvisual.

Subvisual