/dot_rails

A Rails plugin that allows per-user database.yml and environment.rb files

Primary LanguageRuby

DOT RAILS - a plugin that enables per-user, out-of-band configuration files.

With this plugin in your rails app, you can have your own environment.rb 
and database.yml files inside a .rails directory on your home directory. 

The database config (~/.rails/{app-name}-database.yml) replaces the values 
defined in config/database.yml for your application. Where as the environment
files (~/.rails/{app-name}-environment.rb and {app-name}-{RAILS_ENV}.rb)
are loaded after the "official" environment.rb and environments/*.rb files,
allowing you to define additional settings.

As you can see, both file names are prefixed by your "application name". The
plugin tries to guess it by looking at the name of the directory containing
your rails app, but you can override this by defining a RAILS_APP environment
variable or ruby constant.

POSSIBLE FILES:
  {app name}-database.yml         Replaces your app config/database.yml

  {app name}-pre-environment.rb   Loaded before Initializer.run,
                                  with no particular context.

  {app name}-environment.rb       Loaded after Initializer.run, 
                                  with no particular context.

  {app name}-{RAILS_ENV}.rb       Loaded after the official environments file,
                                  it receives a "config" local variable.

POSSIBLE LOCATIONS:
   $DOT_RAILS_PATH
   ~/.rails
   $HOME/.rails
   ../      # this means you can place it next to your app directory
   
--------------------------------------------------------------------------------
Copyright (c) 2008 Sebastian Delmont <sd@notso.net> 
Copyright (c) 2008 StreetEasy / NMD Interactive <http://www.streeteasy.com/> 
All rights reserved.

Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice, this 
list of conditions and the following disclaimer.

* Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution.

* Neither the name of Sebastian Delmont, nor StreetEasy nor NMD Interactive 
nor the names of their contributors may be used to endorse or promote products 
derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-------------------------------------------------------------------------------