sugarfree-config 1.0.0 → 1.1.0

data/README.rdoc

@@ -2,10 +2,11 @@
 
 Configuration handling the easy way.
 
-SugarfreeConfig allows easy access to per Rails environment config values 
-stored in a YAML file. 
+SugarfreeConfig allows easy access to per Rails environment config values
+stored in a YAML file.
 
-SugarfreeConfig only works with Rails!!
+SugarfreeConfig only works with Rails! since SugarfreecConfig 1.1.0 works
+with rails 3 and ruby 1.9.1
 
 == Installation
 
@@ -13,11 +14,24 @@ Just install the gem from Gemcutter
 
   $ gem install sugarfree-config --source http://gemcutter.org
 
+== Notes on rails 3
+
+In rails 2.x gems were required after Rails.root was initialized. Default rails 3.0
+application generator uses Bundler, and auto-requires all gems before application
+initialization. This could be solved forcing the bundler not to require the gem.
+In your Gemfile:
+
+  gem 'problematic-gem', :require => false
+
+and adding an initializer with the require line 
+
+  require 'problematic-gem'
+
 == Usage
 
 Config must be stored in "#{RAILS_ROOT}/config/config.yml" and must have
 at least a section for each RAILS_ENV
- 
+
 Configuration can be accessed like this
 
   SugarfreeConfig.a.b.c #=> 'value'
@@ -32,24 +46,24 @@ which will expect a config file like (given development env)
 otherwise a ConfigKeyException will be raised
 
 Configuration is accessed through a ConfigIterator that (as its name says) is
-and iterator and cannot be reused. However there is a workaround to allow the
+an iterator and cannot be reused. However there is a workaround to allow the
 repeated use of scoped iterators.
 
   # This doesn't work
-  var a_config = app_config.a
+  var a_config = SugarfreeConfig.a
   a_config.b.c #=> 'value'
-  a_config.b.c #=> Ups!!! trie to grab config.a.b.c.b.c
- 
+  a_config.b.c #=> Ups!!! tried to grab config.a.b.c.b.c
+
   # Workaround
-  var a_config = app_config.a
+  var a_config = SugarfreeConfig.a
   a_config.dup.b.c #=> 'value'
   a_config.dup.b.c #=> 'value'
 
 == Further customization
 
-By default Sugarfree-config caches in memory the YAML file. If you want the gem 
+By default Sugarfree-config caches in memory the YAML file. If you want the gem
 to reload this file each time a value is accessed (like in development mode)
-you must force the initialization of the SugarfreeConfig module.  
+you must force the initialization of the SugarfreeConfig module.
 
 This could be a possible Rails initializer:
 
@@ -64,6 +78,6 @@ This could be a possible Rails initializer:
 
 == Contact
 
-Please mail bugs, suggestions and patches to 
+Please mail bugs, suggestions and patches to
 contact@davidbarral.com[mailto:contact@davidbarral.com]
 

data/lib/sugarfree-config.rb

@@ -1,17 +1,20 @@
 #
 # Sugarfree config allows easy access to the config values.
-# 
-# See README.textile for usage info 
+#
+# See README.textile for usage info
 #
 module SugarfreeConfig
-    
-  def self.init(force_reload = false)
-    @@config = Config.new(force_reload)
+
+  class << self
+    attr_reader :config
+    def init(force_reload = false)
+      @config = Config.new(force_reload)
+    end
   end
 
   def self.method_missing(*args)
-    init unless @@config
-    @@config.send(*args)
+    init unless SugarfreeConfig.config
+    SugarfreeConfig.config.send(*args)
   end
 
   #
@@ -19,17 +22,17 @@ module SugarfreeConfig
   #
   class ConfigException < Exception
   end
-  
+
   #
   # Exception raised by the Config Iterator when a key is not found
   #
   class ConfigKeyException < ConfigException
-    
+
     #
     # Config key path (as a key collection) that failed
     #
     attr_accessor :key_path_elements
-    
+
     #
     # Create a new exception with the not found key paths (+key_path_elements+
     # Array)
@@ -39,28 +42,28 @@ module SugarfreeConfig
       super("Cannot find key #{self.key_path_elements.join('.')}")
     end
   end
-    
+
   #
   # Config base object. Caches the configuration in memory an acts as a factory
   # for the ConfigIterators needed to get config values
   #
   class Config
-    
+
     #
     # Conifg file is expected at "#{RAILS_ROOT}/config/config.yml"
-    #    
-    DEFAULT_CONFIG_FILE = File.join(RAILS_ROOT, 'config', 'config.yml')
-            
+    #
+    DEFAULT_CONFIG_FILE = Rails.root.join('config', 'config.yml')
+
     def values
-      @values = fetch_config unless @values && !@force_reload     
+      @values = fetch_config unless @values && !@force_reload
       @values
     end
-        
+
     #
     # Creates a new config object and load the config file into memory
     #
-    def initialize(force_reload = false) 
-      @force_reload = force_reload  
+    def initialize(force_reload = false)
+      @force_reload = force_reload
     end
 
     #
@@ -69,56 +72,56 @@ module SugarfreeConfig
     def to_hash
       @values
     end
-    
+
     #
-    # Here is the magic. The first request to config returns a new 
+    # Here is the magic. The first request to config returns a new
     # ConfigIterator that will handle the first +symbol+
     #
     def method_missing(symbol, *args)
       ConfigIterator.new(values, symbol).next
     end
-     
+
     protected
-    
+
       #
       # Fetch the config from the file
       #
       def fetch_config
-       if Object.const_defined?('RAILS_DEFAULT_LOGGER') && RAILS_DEFAULT_LOGGER.debug?          
+       if Object.const_defined?('RAILS_DEFAULT_LOGGER') && RAILS_DEFAULT_LOGGER.debug?
           RAILS_DEFAULT_LOGGER.debug "Loading #{DEFAULT_CONFIG_FILE}::#{RAILS_ENV}"
         end
-        HashWithIndifferentAccess.new(YAML::load(File.new(DEFAULT_CONFIG_FILE))[RAILS_ENV])                       
-      end    
+        HashWithIndifferentAccess.new(YAML::load(File.new(DEFAULT_CONFIG_FILE))[RAILS_ENV])
+      end
   end
 
   #
   # Config Iterator. Given a configuration hash it can navigate trough the
-  # values using method calls that will be translated into hash keys and 
+  # values using method calls that will be translated into hash keys and
   # indexed
   #
   class ConfigIterator
-    
+
     #
-    # Create a new iterator with a given +configuration+ and the first 
+    # Create a new iterator with a given +configuration+ and the first
     # element of the path to be iterated (+first_path_element+)
     #
     def initialize(configuration, first_path_element)
       @scoped_config = configuration
       @path_elements = [first_path_element]
     end
-    
+
     #
     # Returns the current scope as a hash. Usefull to get a Big hash of config
     # that will be used later.
     #
-    def to_hash      
+    def to_hash
       @scoped_config
     end
-    
+
     #
     # Iterate to the next element in the path
-    # 
-    # Algorithm: 
+    #
+    # Algorithm:
     # 1. Get the last element of the key path
     # 2. Try to find it in the scoped config.
     # 3. If not present raise an error
@@ -126,7 +129,7 @@ module SugarfreeConfig
     #    config is reset to this new value and self is returned
     # 5. If present and is a value then return the value
     #
-    def next      
+    def next
       if (value = @scoped_config[@path_elements.last]).nil?
         raise ConfigKeyException.new(@path_elements)
       elsif value.is_a?(Hash)
@@ -136,17 +139,17 @@ module SugarfreeConfig
         value
       end
     end
-    
+
     #
     # Here is the magic. When an unknown symbol is passed this symbol is set
-    # as the last path element of this iteration, and the iterator is then 
+    # as the last path element of this iteration, and the iterator is then
     # forced to make that movement
     #
     def method_missing(symbol, *args)
       @path_elements << symbol
       self.next
-    end        
+    end
   end
-  
+
 end
-  
+

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: sugarfree-config
 version: !ruby/object:Gem::Version 
-  version: 1.0.0
+  prerelease: false
+  segments: 
+  - 1
+  - 1
+  - 0
+  version: 1.1.0
 platform: ruby
 authors: 
 - David Barral
@@ -9,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-01 00:00:00 +01:00
+date: 2010-03-19 00:00:00 +01:00
 default_executable: 
 dependencies: []
 
@@ -39,18 +44,20 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: Configuration handling the easy way