magiconf 0.1.0

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/.rvmrc

@@ -0,0 +1 @@
+rvm use 1.9.3@magiconf --create

data/Gemfile

@@ -0,0 +1,2 @@
+source :rubygems
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Seth Vargo
+
+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.markdown

@@ -0,0 +1,125 @@
+Magiconf
+========
+Magiconf is a light-weight alternative to figaro that is designed to work directly with Rails. Easily store and access all your application's configuration data using a single yaml file. A great solution for storing passwords, dealing with heroku, and working in a team with different development environments.
+
+Installation
+------------
+1. Add `magiconf` to your application's Gemfile:
+
+        gem 'magiconf'
+
+  Don't forget to run the `bundle` command to install.
+
+2. Next, create `config/application.yml`:
+
+        touch config/application.yml
+
+3. Add your configuration variables:
+
+        # config/application.yml
+        username: 'seth'
+        password: 'aj29slda'
+        development:
+          pusher_url: 'http://github.com/pusher'
+        production:
+          pusher_url: 'http://google.com/pusher'
+
+Usage
+-----
+You now have access to all your configuration data in an easy constant: `YourApp::Config`. For example, if my Rails app was name `Envelope`, I could access my configuration with `Envelope::Config`. Let's look at a simple example:
+
+```ruby
+# Gemfile
+gem 'magiconf'
+gem 'rails'
+```
+
+```text
+# config/application.yml
+username: 'seth'
+development:
+  password: 'test'
+production:
+  password: 'super_secret_test'
+```
+
+```ruby
+# app/controllers/application_controller.rb
+def authenticate
+  username = Envelope::Config.username
+  password = Envelope::Config.password
+
+  render :unathorized unless params[:username] == username && params[:password] == password
+end
+```
+**Note: Magiconf will automatically merge the keys associated with your current Rails environment with the top-level ones.**
+
+Nested Keys
+-----------
+Sometimes, it might make sense to nest your data. For example, a common pusher configuration might look like this:
+
+```yaml
+# config/application.yml
+pusher:
+  app_id: 123
+  key: abcdef
+  secret: abcdefghijklmnop1234567890
+```
+
+The `.pusher` method would return this data, accessible in a hash:
+
+```ruby
+>> Envelope::Config.pusher
+=> {"app_id"=>123, "key"=>"abcdef", "secret"=>"abcdefghijklmnop1234567890"}
+```
+
+**Notice that the keys are strings, not symbols.** This means you would do something like this in an initializer:
+
+```ruby
+# config/initializers/pusher.rb
+Pusher.app_id = Envelope::Config.pusher['app_id']  # not :app_id
+Pusher.key = Envelope::Config.pusher['key']        # not :key
+Pusher.secret = Envelope::Config.pusher['secret']  # not :secret
+```
+
+Using in Application Configuration
+----------------------------------
+Imagine you want to define application configuration variables with Magiconf - maybe you want to define the default host for mail in development. You'd do something like this:
+
+```yaml
+# config/application.yml
+development:
+  host: 'www.example.com'
+```
+
+```ruby
+# config/environments/development.rb
+...
+config.action_mailer.default_url_options = { host: Envelope::Config.host }
+```
+
+...And if you try to start up your server, you'll see:
+
+```text
+uninitialized constant MyApp::Config (NameError)
+```
+
+Huh? Well, it turns out that, even though Magiconf hooks into the Rails initialization process as early as possible, it's not soon enough. There's no way for me to get added anywhere earlier in the stack. Fortunately, there's an easy workaround.
+
+Open up `config/application.rb` and add the following line to the bottom of the file (around line 72):
+
+```ruby
+# config/application.rb
+...
+Magiconf.setup!
+```
+
+Restart your server and things will work like a charm!
+
+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

data/Rakefile

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

data/lib/magiconf.rb

@@ -0,0 +1,22 @@
+module Magiconf
+  extend self
+
+  def setup!
+    # Get the namespace and create the module
+    namespace = Rails.application.class.parent_name.constantize
+    nodule = namespace.const_set('Config', Module.new)
+
+    # Open up the config file
+    config = YAML::load( ERB.new( File.read('config/application.yml') ).result )
+    config.merge!( config.fetch(Rails.env, {}) )
+    config.symbolize_keys!
+
+    config.keys.each do |key|
+      nodule.define_singleton_method key do
+        return config[key]
+      end
+    end
+  end
+end
+
+require 'magiconf/railtie' if defined?(Rails)

data/lib/magiconf/railtie.rb

@@ -0,0 +1,8 @@
+module Magiconf
+  class Railtie < ::Rails::Railtie
+    initializer 'magiconf.initialize', before: 'load_environment_config' do |app|
+      namespace = app.class.parent_name.constantize
+      Magiconf.setup! unless namespace.const_defined?('Config')
+    end
+  end
+end

data/lib/magiconf/version.rb

@@ -0,0 +1,3 @@
+module Magiconf
+  VERSION = '0.1.0'
+end

data/magiconf.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'magiconf/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = 'magiconf'
+  gem.version       = Magiconf::VERSION
+  gem.author       = 'Seth Vargo'
+  gem.email         = 'sethvargo@gmail.com'
+  gem.description   = %q{Magiconf is a tiny gem for managing a Rails application configuration file}
+  gem.summary       = %q{Manage a single Rails application config file with Magiconf}
+  gem.homepage      = ''
+
+  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.require_paths = ['lib']
+
+  gem.add_development_dependency 'rake'
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: magiconf
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Seth Vargo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Magiconf is a tiny gem for managing a Rails application configuration
+  file
+email: sethvargo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- Gemfile
+- LICENSE.txt
+- README.markdown
+- Rakefile
+- lib/magiconf.rb
+- lib/magiconf/railtie.rb
+- lib/magiconf/version.rb
+- magiconf.gemspec
+homepage: ''
+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'
+      segments:
+      - 0
+      hash: -605009535946545267
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -605009535946545267
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Manage a single Rails application config file with Magiconf
+test_files: []