envious 0.1.0

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.rbenv-version
+.DS_STORE

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in envious.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Ryan Nielson
+
+MIT License
+
+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.

data/README.md

@@ -0,0 +1,47 @@
+# Envious
+
+Easy Ruby on Rails application and environment configuration.
+
+## What is Envious?
+Envious is used to configure environment variables for Ruby on Rails 3 applications. It allows you to add configuration variables without the need to add configuration files to your repository.
+
+Envious works by supplying your with an `environment_vars.yml` configuration file. When your Rails app is loaded, configurations options from this file are also loaded and added to the local Environment variable hash. The configuration options can then be accessed using the `ENV[KEY]` syntax.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'envious'
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install envious
+
+After installation, run the following to create `config/environment_vars.yml`, and add it to your `.gitignore`.
+
+    $ rails generate envious:setup
+
+## Usage
+
+Setting up configuration with Envious is easy. To begin, simply add some variables to your `config/environment_vars.yml` that you would like available in the `ENV` hash. Keep in mind that Envious uses `Rails.env` to allow configuration based on your current environment.
+```yaml
+development: 
+  USERNAME: "cat"
+
+production:
+  USERNAME: "dog"
+
+API_KEY: "ABCXYZ"
+```
+In the above case, `ENV["API_KEY"]` will produce `"ABCXYZ"` because any values not under an environment will be available in all environments. In development `ENV["USERNAME"]`  will be `"cat", and it will be `"dog"` in production.
+
+Since Envious configuration is loaded when your Rails app loads, the `ENV` hash is available anywhere in your application where you may need to call upon your configuration.
+
+
+## Questions or Problems?
+
+If you have any questions or issues with Envious, please add an [issue on GitHub](https://github.com/RyanNielson/envious/issues), or send a pull request.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/envious.gemspec

@@ -0,0 +1,13 @@
+Gem::Specification.new do |gem|
+  gem.name          = "envious"
+  gem.version       = "0.1.0"
+  gem.authors       = ["Ryan Nielson"]
+  gem.email         = ["ryan.nielson@gmail.com"]
+  gem.description   = %q{Easy Ruby on Rails application and environment configuration.}
+  gem.summary       = %q{Easy Ruby on Rails application and environment configuration using YAML and ENV.}
+  gem.homepage      = "http://github.com/ryannielson/envious"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+end

data/lib/envious.rb

@@ -0,0 +1,34 @@
+require "envious/railtie"
+
+module Envious
+  extend self
+
+  def load_env(specific_environment = nil)
+    environment = (specific_environment || self.environment).to_s
+    add_to_environment(default_vars.merge(environment_vars))
+  end
+
+  def file 
+    @file ||= Rails.root.join('config/environment_vars.yml')
+  end
+
+  def yaml
+    @yaml ||= File.exist?(file) ? YAML.load(File.read(file)) : {}
+  end
+
+  def environment
+    Rails.env
+  end
+
+  def default_vars()
+    yaml.reject { |_, v| Hash === v }
+  end
+
+  def environment_vars
+    yaml.fetch(environment)
+  end
+
+  def add_to_environment(hash)
+    hash.each { |key, value| ENV[key.to_s] = value.to_s }
+  end
+end

data/lib/envious/railtie.rb

@@ -0,0 +1,7 @@
+module Envious
+  class Railtie < Rails::Railtie
+    config.before_configuration do
+      Envious.load_env
+    end
+  end 
+end

data/lib/generators/envious/setup_generator.rb

@@ -0,0 +1,15 @@
+module Envious
+  module Generators
+    class SetupGenerator < Rails::Generators::Base
+      source_root File.expand_path('../templates', __FILE__)
+
+      def copy_environment_vars_file
+        copy_file 'environment_vars.yml', 'config/environment_vars.yml'
+      end
+
+      def configure_gitignore
+        append_file('.gitignore', '/config/environment_vars.yml') if File.exists?('.gitignore')
+      end
+    end
+  end
+end

data/lib/generators/envious/templates/environment_vars.yml

@@ -0,0 +1,15 @@
+# Add environmental variables to this file in yaml format:
+#
+# development: 
+#   USERNAME: "cat"
+#   PASSWORD: "secret"
+#
+# production:
+#   USERNAME: "dog"
+#   PASSWORD: "stillsecret"
+#
+# API_KEY: "ABCXYZ"
+# SECRET: "HELLO"
+#
+# Envious supports Rails environments so anything under production will only be loaded into the environment in production, and anything under development will only be loaded in the development environment.
+# Anything outside of an environment will be loaded no matter which Rails environment you're in.

metadata

@@ -0,0 +1,56 @@
+--- !ruby/object:Gem::Specification
+name: envious
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Ryan Nielson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-19 00:00:00.000000000 Z
+dependencies: []
+description: Easy Ruby on Rails application and environment configuration.
+email:
+- ryan.nielson@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- envious.gemspec
+- lib/envious.rb
+- lib/envious/railtie.rb
+- lib/generators/envious/setup_generator.rb
+- lib/generators/envious/templates/environment_vars.yml
+homepage: http://github.com/ryannielson/envious
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Easy Ruby on Rails application and environment configuration using YAML and
+  ENV.
+test_files: []