Project

variant

0.0
No release in over a year
A policy gem for selecting different environments.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
 Dependencies

Development

>= 0
>= 0

Runtime

 Project Readme

Variant

Provides a model for application variants, including documenting behaviour like RACK_ENV and APP_ENV.

Development

Installation

bundle add variant

Usage

Variants are used to indicate the default configuration for an application. There are four suggested variants:

Variant Data Usage
Production Persistent, real data & interfaces. Instance/cluster.
Staging Duplicate/subset of production. Instance/cluster.
Development Fixtures, sample data. Local machine. Default variant.
Testing Fixtures, mocked interfaces. Local machine, continuous integration.

Environment Variables

The general mechanism for specifying a variant is on the command line before running the application:

VARIANT=production falcon serve

In your code, you access this like so:

Variant.default # => :production
Variant.for(:database) # => :production

System-specific Variants

You can specify system-specific variants. These are useful when you have e.g. 2 different database clusters, or you want to run a development instance connected to a production database.

VARIANT=production DATABASE_VARIANT=production-aws

In your code, you access this like so:

Variant.default # => :production
Variant.for(:database) # => :'production-aws'

If you don't specify a system-specific variant, it will be the same as the default variant.

Bake Integration

This gem provides bake recipes for setting the variants as outlined above.

bake variant:production ...
bake variant:staging ...
bake variant:development ...
bake variant:testing ...

In addition, the tasks also support specifying overrides:

% bake variant:development database=production variant:show
0.01s     info: Environment [pid=417910] [2020-02-29 11:43:25 +1300]
              | {"VARIANT"=>"development", "DATABASE_VARIANT"=>"production"}

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

License

Released under the MIT license.

Copyright, 2020, by Samuel G. D. Williams.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.