simpleconfig 1.1 → 1.1.1

data/README.textile

@@ -1,8 +1,11 @@
-Simple Config is a plugin designed to make application-wide configuration settings easy to set and access in an object-oriented fashion.
+Simple Config is a plugin designed to make application-wide configuration settings easy to set and access in an
+ object-oriented fashion.
 
 Rails already provides a way of configuring the framework on a per-environment basis but other than global variables/constants set in each environment file or environment.rb, there isn't a built-in way of providing application-specific settings.
 
-One simple solution is to simply put all of your app configuration into a YAML file and load this somewhere in your environment, but here at Reevoo we wanted something a little bit more flexible that we could use across all of our applications and Simple Config is what we came up with.
+One simple solution is to simply put all of your app configuration into a YAML file and load this somewhere in your environment, but I wanted something a little bit more flexible that we could use across all of our applications and Simple Config is what we came up with.
+
+SimpleConfig was originally written against Rails 1.x and may still work but as of version 1.1.1 the minimum required Rails version is 2.3.5. You may be able to use it with older versions of Rails but YMMV.
 
 h2. Getting started
 
@@ -10,7 +13,7 @@ The plugin comes with a rake task to get you up and running quickly, so start by
 
   $ rake simple_config:setup
 
-This will create a config/settings folder and a blank settings file for each of the main Rails environments. It will also create a copy of the SimpleConfig initializer  in config/initializers/configuration.rb[1].
+This will create a config/settings folder and a blank settings file for each of the main Rails environments. It will also create a copy of the SimpleConfig initializer  in config/initializers/configuration.rb.
 
 Now, if you open up the configuration.rb initializer, you will see something like this:
 
@@ -19,8 +22,8 @@ SimpleConfig.for :application do
 
   # your app configuration here
   
-  load File.join(RAILS_ROOT, 'config', "settings", "#{RAILS_ENV}.rb"), :if_exists? => true
-  load File.join(RAILS_ROOT, 'config', "settings", "local.rb"),        :if_exists? => true
+  load File.join(Rails.root, 'config', "settings", "#{RAILS_ENV}.rb"), :if_exists? => true
+  load File.join(Rails.root, 'config', "settings", "local.rb"),        :if_exists? => true
   
 end
 </code></pre>
@@ -29,7 +32,7 @@ This is where you can set any configuration variables that are required across a
 
 Variables can be overwritten, and are defined in the order that they are loaded, so you can set up default values in the above file and override them in the environment files.
 
-As well as loading a settings file for your current Rails environment, a file called "local.rb" is loaded which is designed as a place for you to override variables specific to your own development environment -- you can just keep a copy of this locally without having to check it into your version control system[2].
+As well as loading a settings file for your current Rails environment, a file called "local.rb" is loaded which is designed as a place for you to override variables specific to your own development environment -- you can just keep a copy of this locally without having to check it into your version control system[1].
 
 h2. Variables
 
@@ -145,14 +148,4 @@ class MyController < ApplicationController
 end
 </code></pre>
 
-
-fn1(footnote). SimpleConfig was designed with Rails 2.0 in mind but it has been tested with Rails 1.2. To use the Rails-style initializers that SimpleConfig takes advantage of in Rails 1.2, simply add this to the bottom of your environment.rb file:
-
-<pre><code class="ruby">
-# backported Rails 2.x initializer folder functionality
-Dir[File.join(RAILS_ROOT, 'config', 'initializers', '*.rb')].each do |initializer|
-  load initializer
-end
-</code></pre>
-
-fn2(footnote). In fact, I recommend you make sure your version control system ignores this file otherwise you risk checking in a file that will override values in production! If you are using Subversion, simply add local.rb to the svn:ignore property for the config/settings folder.
+fn1(footnote). In fact, I recommend you make sure your version control system ignores this file otherwise you risk checking in a file that will override values in production! If you are using Subversion, simply add local.rb to the svn:ignore property for the config/settings folder.

data/lib/simple_config.rb

@@ -1,105 +1,105 @@
 require 'yaml'
 
-unless defined?(Rails)
+unless Object.public_method_defined?(:tap)
   class Object
-    def returning(object, &block)
-      yield object if block_given?
-      object
+    def tap(&block)
+      yield self
+      self
     end
   end
 end
 
 module SimpleConfig
-  
+
   class << self
     def for(config_name, &block)
       default_manager.for(config_name, &block)
     end
-    
+
     def default_manager
       @default_manager ||= Manager.new
     end
   end
-  
+
   class Manager
     def initialize
       @configs = {}
     end
-    
+
     def for(config_name, &block)
-      returning @configs[config_name] ||= Config.new do |config|
+      (@configs[config_name] ||= Config.new).tap do |config|
         config.configure(&block) if block_given?
       end
     end
   end
-  
+
   class Config
     def initialize
       @groups = {}
       @settings = {}
     end
-    
+
     def configure(&block)
       instance_eval(&block)
     end
-    
+
     def group(name, &block)
-      returning @groups[name] ||= Config.new do |group|
+      (@groups[name] ||= Config.new).tap do |group|
         group.configure(&block) if block_given?
       end
     end
-    
+
     def set(key, value)
       @settings[key] = value
     end
-    
+
     def get(key)
       @settings[key]
     end
-    
-    # 
-    # Unsets any variable with given +key+ 
+
+    #
+    # Unsets any variable with given +key+
     # and returns variable value if it exists, nil otherwise.
     # Any successive call to exists? :key will return false.
-    # 
+    #
     #   exists? :bar      # => false
-    # 
+    #
     #   set :bar, 'foo'
     #   exists? :bar      # => true
-    # 
+    #
     #   unset :bar        # => 'foo'
     #   exists? :bar      # => false
-    # 
+    #
     def unset(key)
       @settings.delete(key)
     end
-    
-    # 
+
+    #
     # Returns whether a variable with given +key+ is set.
-    # 
+    #
     # Please note that this method doesn't care about variable value.
     # A nil variable is considered as set.
-    # 
+    #
     #   exists? :bar      # => false
-    # 
+    #
     #   set :bar, 'foo'
     #   exists? :bar      # => true
-    # 
+    #
     #   set :bar, nil
     #   exists? :bar      # => true
-    # 
+    #
     # Use unset to completely remove a variable from the collection.
-    # 
+    #
     #   set :bar, 'foo'
     #   exists? :bar      # => true
-    # 
+    #
     #   unset :bar
     #   exists? :bar      # => false
-    # 
+    #
     def exists?(key)
       @settings.key?(key)
     end
-    
+
     def to_hash
       hash = @settings.dup
       @groups.each do |key,group|
@@ -110,11 +110,11 @@ module SimpleConfig
 
     def load(external_config_file, options={})
       options = {:if_exists? => false}.merge(options)
-      
+
       if options[:if_exists?]
         return unless File.exist?(external_config_file)
       end
-      
+
       case File.extname(external_config_file)
       when /rb/
         instance_eval(File.read(external_config_file))
@@ -122,7 +122,7 @@ module SimpleConfig
         YAMLParser.parse_contents_of_file(external_config_file).parse_into(self)
       end
     end
-    
+
     private
       def method_missing(method_name, *args)
         case true
@@ -135,22 +135,22 @@ module SimpleConfig
         end
       end
   end
-  
+
   class YAMLParser
     def initialize(raw_yaml_data)
       @data = YAML.load(raw_yaml_data)
     end
-    
+
     def self.parse_contents_of_file(yaml_file)
       new(File.read(yaml_file))
     end
-    
+
     def parse_into(config)
       @data.each do |key, value|
         parse(key, value, config)
       end
     end
-    
+
     private
       def parse(key, value, config)
         if value.is_a?(Hash)
@@ -161,5 +161,5 @@ module SimpleConfig
         end
       end
   end
-  
+
 end

data/templates/configuration.rb

@@ -2,17 +2,17 @@ SimpleConfig.for :application do
   
   # Set here your global configuration.
   # All settings can be overwritten later per-environment.
-  load File.join(RAILS_ROOT, 'config', "settings", "application.rb"),   :if_exists? => true
+  load File.join(Rails.root.to_s, 'config', "settings", "application.rb"),   :if_exists? => true
   
   # Per Environment settings.
   # At startup only the file matching current environment will be loaded.
   # Settings stored here will overwrite settings with the same name stored in application.rb
-  load File.join(RAILS_ROOT, 'config', "settings", "#{RAILS_ENV}.rb"),  :if_exists? => true
+  load File.join(Rails.root.to_s, 'config', "settings", "#{RAILS_ENV}.rb"),  :if_exists? => true
   
   # Local settings. It is designed as a place for you to override variables 
   # specific to your own development environment.
   # Make sure your version control system ignores this file otherwise 
   # you risk checking in a file that will override values in production
-  load File.join(RAILS_ROOT, 'config', "settings", "local.rb"),         :if_exists? => true
+  load File.join(Rails.root.to_s, 'config', "settings", "local.rb"),         :if_exists? => true
   
 end

metadata

@@ -1,20 +1,21 @@
 --- !ruby/object:Gem::Specification 
 name: simpleconfig
 version: !ruby/object:Gem::Version 
-  hash: 13
+  hash: 17
   prerelease: false
   segments: 
   - 1
   - 1
-  version: "1.1"
+  - 1
+  version: 1.1.1
 platform: ruby
 authors: 
 - Luke Redpath
-autorequire: simple_config
+autorequire: simpleconfig
 bindir: bin
 cert_chain: []
 
-date: 2010-07-07 00:00:00 +01:00
+date: 2010-07-31 00:00:00 +01:00
 default_executable: 
 dependencies: []