sugarfree-config 1.0.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 [name of plugin creator]
+
+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.rdoc

@@ -0,0 +1,69 @@
+= SugarfreeConfig
+
+Configuration handling the easy way.
+
+SugarfreeConfig allows easy access to per Rails environment config values 
+stored in a YAML file. 
+
+SugarfreeConfig only works with Rails!!
+
+== Installation
+
+Just install the gem from Gemcutter
+
+  $ gem install sugarfree-config --source http://gemcutter.org
+
+== 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'
+
+which will expect a config file like (given development env)
+
+  development:
+    a:
+      b:
+        c: 'value'
+
+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
+repeated use of scoped iterators.
+
+  # This doesn't work
+  var a_config = app_config.a
+  a_config.b.c #=> 'value'
+  a_config.b.c #=> Ups!!! trie to grab config.a.b.c.b.c
+ 
+  # Workaround
+  var a_config = app_config.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 
+to reload this file each time a value is accessed (like in development mode)
+you must force the initialization of the SugarfreeConfig module.  
+
+This could be a possible Rails initializer:
+
+  SugarfreeConfig.init(Rails.env.development?) # True to force reload each time
+
+  class Object
+    # For people who prefer app_config.a.b.c instead of SugarfreeConfig.a.b.c
+    def app_config
+      SugarfreeConfig
+    end
+  end
+
+== Contact
+
+Please mail bugs, suggestions and patches to 
+contact@davidbarral.com[mailto:contact@davidbarral.com]
+

data/init.rb

@@ -0,0 +1,2 @@
+require 'sugarfree-config'
+

data/lib/sugarfree-config.rb

@@ -0,0 +1,152 @@
+#
+# Sugarfree config allows easy access to the config values.
+# 
+# See README.textile for usage info 
+#
+module SugarfreeConfig
+    
+  def self.init(force_reload = false)
+    @@config = Config.new(force_reload)
+  end
+
+  def self.method_missing(*args)
+    init unless @@config
+    @@config.send(*args)
+  end
+
+  #
+  # Exception raised by the module on unexpected behaviors
+  #
+  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)
+    #
+    def initialize(key_path_elements)
+      self.key_path_elements = [*key_path_elements].map(&:to_s)
+      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')
+            
+    def values
+      @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  
+    end
+
+    #
+    # Returns all the config as a big hash
+    #
+    def to_hash
+      @values
+    end
+    
+    #
+    # 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?          
+          RAILS_DEFAULT_LOGGER.debug "Loading #{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 
+  # indexed
+  #
+  class ConfigIterator
+    
+    #
+    # 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      
+      @scoped_config
+    end
+    
+    #
+    # Iterate to the next element in the path
+    # 
+    # 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
+    # 4. If present and is a hash we are not in a config leaf, so the scoped
+    #    config is reset to this new value and self is returned
+    # 5. If present and is a value then return the value
+    #
+    def next      
+      if (value = @scoped_config[@path_elements.last]).nil?
+        raise ConfigKeyException.new(@path_elements)
+      elsif value.is_a?(Hash)
+        @scoped_config = value
+        self
+      else
+        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 
+    # forced to make that movement
+    #
+    def method_missing(symbol, *args)
+      @path_elements << symbol
+      self.next
+    end        
+  end
+  
+end
+  

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification 
+name: sugarfree-config
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- David Barral
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-12-01 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: Access to per Rails environment configuration stored in a YAML file
+email: contact@davidbarral.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.rdoc
+- LICENSE
+- init.rb
+- lib/sugarfree-config.rb
+has_rdoc: true
+homepage: http://github.com/davidbarral/sugarfree-config
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Configuration handling the easy way
+test_files: []
+