Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Rack middleware that adds an indicator of your application environment
Ruby HTML JavaScript
Branch: master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
lib
test
.gitignore
CHANGELOG
LICENSE
README.rdoc
Rakefile
rack-environmental.gemspec

README.rdoc

Rack::Environmental

Description

Never again will you accidentally delete production data! Rack::Environmental adds an indicator badge to your web application so that you can tell whether you're working with the staging, test, development or production version of your web app.

Installation

For bundler-managed applications just include Rack::Environmental in your Gemfile:

gem 'rack-environmental'

Alternatively, you can install Rack::Environmental manually:

$ gem install rack-environmental

Usage

This Rack middleware can be used with any Rack application, but here's how you would use it in Rails. Put the following in config/environment.rb:

config.middleware.use Rack::Environmental,
                        :staging =>     { :url => /^staging.+$/   },
                        :test =>        { :url => /^test.+$/      },
                        :development => { :url => /^localhost.+$/ }

When a request comes to your web app, Rack::Environmental compares the URL to the supplied regular expressions. If the URL matches, the name of the environment is displayed at the top of the web page.

Each environment can be further configured:

config.middleware.use Rack::Environmental,
                        :staging =>     { :url => /^staging.+$/,
                                          :color => "yellow",
                                          :size => :large          },
                        :test =>        { :url => /^test.+$/,
                                          :color => "purple",
                                          :style => :badge         },
                        :development => { :url => /^localhost.+$/,
                                          :color => "orange"       }

Here's the full list of configuration options:

:url        => a regular expression
:style      => either :badge (a transparent, floating badge), :banner (default), or :none (ignore this environment)
:color      => a string that represents a CSS color, such as "red", "rgb(6,70,14)", or "#8e6630"
:size       => :small, :medium, or :large; defaults to :medium
:opacity    => a number from 0 (completely transparent) to 1; only works with the badge style
:top        => distance in pixels from the top; only works with the badge style
:left       => distance in pixels from the left; only works with the badge style
:background => true or false; when true, the body's background color is changed

Ignoring environments

If there's a context where you want Rack::Environmental to specifically ignore your requests, such as a Jasmine test runner which returns essentially empty files to be built on by the test runner, you can “shut off” Rack::Environmental for that context by adding `:style => :none` to its options.

Something went wrong with that request. Please try again.