yamalicious 0.0.1.alpha

data/.gitignore

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

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 LocalJobVentures
+
+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,96 @@
+# Yamalicious
+
+The purpose of this gem is to load configuration information from YAML files and environment variables into a globally available
+nested hash (actually a Hashie::Mash rather than a hash).
+
+## Goals:
+
+1. Store configuration info in YAML, since it's easy to read and change
+2. Allow common settings to be shared among all environments
+3. Allow each environment to override the common settings.
+4. Allow the YAML to be loaded from two separate files (public and private), so that 
+   the developer can store some settings in source control and others outside of source control
+5. Allow environment variables to be used instead of YAML files (for Heroku, for example).
+
+## Usage:
+
+Install the gem and setup an intializer.
+
+### Gem
+
+In your gemfile,
+
+    # Gemfile
+    gem 'yamalicious'
+    
+### Initializer
+
+In an initializer,
+
+    # config/initializers/_load_config.rb
+    APP_CONFIG = Yamalicious.load_config
+    
+This will load YAML from `yamalicious.yml`, `yamalicious.local.yml`, and from an environment variable named `yamalicious`.
+
+### Configuration
+
+If you wish to adjust which files are loaded and what environment variable is used, just pass a hash containing `:file_prefix` to `load_config` like this:
+
+    # config/initializers/_load_config.rb
+    APP_CONFIG = Yamalicious.load_config(:file_prefix => "settings")
+    
+This will load YAML from `settings.yml`, `settings.local.yml`, and from an environment variable named `settings`
+
+### Avoiding global constant
+
+If you don't like using a global constant like `APP_CONFIG`, you can use Rails' built in configuration object like this:
+
+    # config/initializers/_load_config.rb
+    Rails.configuration.yamalicious = Yamalicious.load_config
+  
+### YAML files
+
+The YAML should contain a section for each environment as well as a section named default, like this:
+
+    # yamalicious.yml
+    default:
+      api_key: ASDGLKASDG
+    
+    development:
+      api_key: HJASDOSHS 
+    
+    production:
+      api_key: ALSJHDGYD
+
+The YAML is loaded into a nested hash using `YAML.load`
+
+The environment-specific section of the YAML is deep merged into the default section.
+
+### Environment variables
+
+The environment variables should be strict base64 encoded YAML, in the same format as the YAML files, with a default section and a section for each relevant environment.
+
+### Deep merging
+
+The YAML from the two files and the environment variable are deep merged together in the following order of precedence:
+
+1. `yamalicious` environment variable
+2. `yamalicious.local.yml`
+3. `yamalicious.yml`
+
+### Result
+  
+The result of the `load_config` method is a Hashie::Mash, which you can treat as a hash that is accessible with loose object notation like this:
+
+    APP_CONFIG.section.nested_section.value
+   
+You can read more about that [here] [1]
+
+### Loading more than one set of files:
+
+    # config/initializers/_load_config.rb
+    EMAIL_CONFIG = Yamalicious.load_config(:file_prefix => "email_settings")
+    OTHER_CONFIG = Yamalicious.load_config(:file_prefix => "other_settings")
+    
+    
+  [1]: https://github.com/intridea/hashie/

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/yamalicious.rb

@@ -0,0 +1,34 @@
+require "yamalicious/version"
+require 'i18n/core_ext/hash' 
+require 'hashie/mash'
+ 
+# Note deep_merge is in ActiveSupport::CoreExtensionsHash and deep_symbolize_keys is in i18n::CoreExtensions::Hash
+
+module Yamalicious
+  def self.load_config(options = {})
+    file_prefix = options[:file_prefix] || "yamalicious"
+    config_path = [Rails.root, 'config'].join('/')
+    
+ 
+    yaml_files = {:public => "#{file_prefix}.yml",
+                  :private => "#{file_prefix}.local.yml"}
+
+    settings = {}
+    
+    yaml_files.each do |k, filename|
+      settings[k] = YAML.load_file([config_path, filename].join("/")) || {} rescue {}
+    end        
+      
+    settings[:env] = YAML.load(Base64.strict_decode64(ENV[file_prefix.to_s])) || {} rescue {}
+
+    combined = {}
+
+    [:public, :private, :env].each do |name|
+      default_settings = settings[name]["default"] || {}
+      environment_settings = settings[name][Rails.env] || {}
+      combined.deep_merge!(default_settings.deep_merge(environment_settings))
+    end
+   
+    ::Hashie::Mash.new(combined.deep_symbolize_keys)
+  end
+end

data/lib/yamalicious/version.rb

@@ -0,0 +1,3 @@
+module Yamalicious
+  VERSION = "0.0.1.alpha"
+end

data/yamalicious.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/yamalicious/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Nathan Wenneker"]
+  gem.email         = ["nathan@gladtocode.com"]
+  gem.description   = %q{Load configuration from YAML files and base64 encoded YAML environment variables into a Rails app}
+  gem.summary       = %q{YAML configuration loader for Rails apps}
+  gem.homepage      = "https://github.com/naw/yamalicious"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "yamalicious"
+  gem.require_paths = ["lib"]
+  gem.version       = Yamalicious::VERSION
+  
+  gem.add_dependency 'hashie'
+  gem.add_dependency 'rails'
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: yamalicious
+version: !ruby/object:Gem::Version
+  version: 0.0.1.alpha
+  prerelease: 6
+platform: ruby
+authors:
+- Nathan Wenneker
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Load configuration from YAML files and base64 encoded YAML environment
+  variables into a Rails app
+email:
+- nathan@gladtocode.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/yamalicious.rb
+- lib/yamalicious/version.rb
+- yamalicious.gemspec
+homepage: https://github.com/naw/yamalicious
+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: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: YAML configuration loader for Rails apps
+test_files: []