loadcfg 0.1 → 0.2

data/CHANGELOG

@@ -1,2 +1,4 @@
+v0.2
+-- You can pass options to loadconfig method like your own environment and if will ignore to raise exceptions when no data is found the environment option.
 v0.1
 -- Allow you to load a configuration file, let's say config/whatever.yaml as constants

data/README.rdoc

@@ -1,14 +1,18 @@
 == loadcfg
 
-Rails gem for read environments constants following some convention.
+Rails gem for read environment variables configuration, just follow some convention.
 
 == Install
 
-gem install loadcfg --source http://gems.github.com or then gem 'loadcfg' in your bundle file.
+  gem install loadcfg
+  
+or then add gem 'loadcfg' to your Gemfile and run:
+  
+  bundle install
 
 == Usage
 
-Let's say you have some configuration constants that depends on the environment you are working on, for example config/facebook.yml
+Let's say you have some configuration variables that depend of the environment you are working on, for example config/facebook.yml
 
   development:
     app_id: <the_app_id_for_development_env>
@@ -27,21 +31,30 @@ Let's say you have some configuration constants that depends on the environment
     secret_key: <the_secret_key_for_production_env>
     callback_url: <the_callback_url_for_production_env>
   
-One of the conventions is that you should put the file in the config dir of your proyect, then in any class where you want to use the constants you call the loadconfig method passing the config file name as symbol, for example
+One of the conventions is that you should put the file in the config directory of your rails project, then, in any class where you want to use the constants you just need to call loadconfig method passing the config file name as a symbol, for example:
 
   class FacebookHelper
     loadconfig :facebook
   end
 
-that's going to generate a constant for each key in the yaml config file with the file name as a prefix, for example
+that's going to generate a constant for each key in the yaml config file, each constant will has file name as a prefix, for example:
 
   class FacebookHelper
     loadconfig :facebook
   
     def some_method_that_deals_with_facebook_api
       fb_id = FACEBOOK_APP_ID
-      # here fb_id contains the value you gave for the environment you are working on
+      fb_secret_key = FACEBOOK_SECRET_KEY
+      # here fb_id and fb_secret_key contain the values you gave them for the environment you are working on      
     end
   end
+  
+== Options
+
+There is a couple of options you can pass to loadconfig method
+  
+  loadconfig :facebook, :environment => :my_environment, :ignore_not_found => true
+
+If there's no my_environment entry in the config/facebook.yml file there will be no exception raised.
 
 That's it.

data/Rakefile

@@ -2,7 +2,7 @@ require 'rubygems'
 require 'rake'
 require 'echoe'
 
-Echoe.new('loadcfg', '0.1') do |p|
+Echoe.new('loadcfg', '0.2') do |p|
   p.description = "Allow you to load any configuration constants from config/whatever.yml"
   p.url = "http://github.com/j4rs/loadcfg"
   p.author = "Jorge Rodriguez"

data/lib/loadcfg.rb

@@ -7,10 +7,15 @@ module LoadCfg
   end
     
   module ClassMethods
-    def loadconfig(yaml_file_name)
-      loaded_yaml = YAML.load_file(Rails.root.join("config/#{yaml_file_name}.yml"))[Rails.env]
-      loaded_yaml.keys.each do |key|
-        self.const_set("#{[yaml_file_name, '_', key].join.upcase}", loaded_yaml[key]) 
+    def loadconfig(yaml_file_name, options = {})
+      environment = (options[:environment] || Rails.env).to_s
+      loaded_yaml = YAML.load_file(Rails.root.join("config/#{yaml_file_name}.yml"))[environment]
+      if loaded_yaml.present?
+        loaded_yaml.keys.each do |key|
+          self.const_set("#{[yaml_file_name, '_', key].join.upcase}", loaded_yaml[key]) 
+        end
+      else
+        raise "Data not found on enviroment: '#{environment}'" unless options[:ignore_not_found]
       end
     end
   end

data/loadcfg.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{loadcfg}
-  s.version = "0.1"
+  s.version = "0.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = [%q{Jorge Rodriguez}]
-  s.date = %q{2011-08-09}
+  s.date = %q{2011-08-13}
   s.description = %q{Allow you to load any configuration constants from config/whatever.yml}
   s.email = %q{jorge.rodriguez.suarez@gmail.com}
   s.extra_rdoc_files = [%q{CHANGELOG}, %q{README.rdoc}, %q{lib/loadcfg.rb}]

metadata

@@ -2,7 +2,7 @@
 name: loadcfg
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: "0.1"
+  version: "0.2"
 platform: ruby
 authors: 
 - Jorge Rodriguez
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-08-09 00:00:00 Z
+date: 2011-08-13 00:00:00 Z
 dependencies: []
 
 description: Allow you to load any configuration constants from config/whatever.yml