configatron 1.0.0

data/README

@@ -0,0 +1,77 @@
+=Configatron
+
+Configatron makes configuring your applications and scripts incredibly easy. No longer is a there a need to use constants or global variables. Now you can use a simple and painless system to configure your life. And, because it's all Ruby, you can do any crazy thing you would like to!
+
+==Examples
+
+===Simple
+  configatron do |config|
+    config.email = "mark@mackframework.com"
+    config.database_url = "postgres://localhost/mack_framework_rocks"
+    # etc...
+  end
+  
+Now, anywhere in your code you can do the following:
+
+  configatron.email # => "mark@mackframework.com"
+  configatron.database_url # => "postgres://localhost/mack_framework_rocks"
+
+Viola! Simple as can be.
+
+Now you're saying, what if I want to have a 'default' set of options, but then override them later, based on other information? Simple again. Let's use our above example. We've configured our 'database_url' option to be "postgres://localhost/mack_framework_rocks". The problem with that is that is our production database url, not our development url. Fair enough, all you have to do is redeclare it:
+
+  configatron do |config|
+    config.database_url = "postgres://localhost/mack_framework_rocks_development"
+  end
+  
+becomes:
+
+  configatron.email # => "mark@mackframework.com"
+  configatron.database_url # => "postgres://localhost/mack_framework_rocks_development"
+  
+Notice how our other configuration parameters haven't changed? Cool, eh?
+
+===Namespaces
+
+The question that should be on your lips is what I need to have namespaced configuration parameters. It's easy! Configatron allows you to create namespaces.
+
+  configatron do |config|
+    config.website_url = "http://www.mackframework.com"
+    config.email do |email|
+      email.pop do |pop|
+        pop.address = "pop.example.com"
+        pop.port = "110"
+        # etc ...
+      end
+      email.smtp do |smtp|
+        smtp.address = "smtp.example.com"
+        smtp.port = "25"
+        # etc ...
+      end
+    end
+    # etc...
+  end
+
+becomes:
+
+  configatron.email.pop.address # => "pop.example.com"
+  configatron.email.smtp.address # => "smtp.example.com"
+  configatron.website_url # => "http://www.mackframework.com"
+  
+Configatron allows you to nest namespaces to your hearts content! Just keep going, it's that easy.
+
+Enjoy!
+
+==Contact
+Please mail bugs, suggestions and patches to <bugs@mackframework.com>.
+
+On the web at: http://www.mackframework.com
+
+==License and Copyright
+Copyright (C) 2008 Mark Bates, http://www.mackframework.com
+
+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 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/lib/configatron.rb

@@ -0,0 +1,8 @@
+require 'singleton'
+require File.join(File.dirname(__FILE__), 'helpers')
+require File.join(File.dirname(__FILE__), 'kernel')
+require File.join(File.dirname(__FILE__), 'configuration')
+require File.join(File.dirname(__FILE__), 'store')
+
+module Configatron # :nodoc:
+end

data/lib/configuration.rb

@@ -0,0 +1,91 @@
+module Configatron
+  # The central class for managing the configurations.
+  class Configuration
+    include Singleton
+    include Configatron::Helpers
+  
+    # If nil_for_missing is set to true nil will be returned if the configuration
+    # parameter doesn't exist. If set to false, default, then a NoMethodError exception
+    # will be raised.
+    attr_accessor :nil_for_missing
+  
+    def initialize # :nodoc:
+      @_storage_list = []
+      @_nil_for_missing = false
+    end
+  
+    # Yields a new Configatron::Store class.
+    def configure
+      storage = Configatron::Store.new
+      yield storage
+      unless storage.parameters.empty?
+        @_storage_list << storage
+        load_methods(storage)
+      end
+    end
+    
+    # Used to load configuration settings from a Hash.
+    def configure_from_hash(parameters)
+      storage = Configatron::Store.new(parameters)
+      @_storage_list << storage
+      load_methods(storage)
+    end
+    
+    # Replays the history of configurations.
+    def reload
+      @_storage_list.each do |storage|
+        load_methods(storage)
+      end
+    end
+  
+    # Does a hard reset of the Configatron::Configuration class. 
+    # All methods are undefined, the list of configuration parameters
+    # is emptied, and the nil_for_missing method gets reset to false.
+    def reset!
+      reset
+      self.nil_for_missing = false
+      @_storage_list = []
+    end
+    
+    # All methods are undefined.
+    def reset
+      @_storage_list.each do |storage|
+        storage.parameters.each do |k,v|
+          Configatron::Configuration.instance_eval do
+            begin
+              undef_method(k)
+            rescue NameError => e
+            end
+          end
+        end
+      end
+    end
+    
+    # Peels back n number of configuration parameters.
+    def revert(step = 1)
+      reset
+      step.times {@_storage_list.pop}
+      reload
+    end
+  
+    def method_missing(sym, *args)
+      handle_missing_parameter(sym)
+    end
+    
+    private
+    def load_methods(store)
+      store.parameters.each do |k,v|
+        if k.is_a?(Configatron::Store)
+          load_methods(k)
+        else
+          Configatron::Configuration.instance_eval do
+            define_method(k) do
+              v
+            end
+          end
+        end
+      end
+    end
+    
+  end # Configuration
+end # Configatron

data/lib/helpers.rb

@@ -0,0 +1,23 @@
+module Configatron
+  module Helpers
+    
+    def exists?(name)
+      self.respond_to?(name)
+    end
+    
+    def handle_missing_parameter(param)
+      if configatron.nil_for_missing
+        return nil
+      else
+        raise NoMethodError.new(param.to_s)
+      end
+    end
+    
+    def retrieve(name, default_value = ArgumentError)
+      return self.send(name) if exists?(name)
+      return default_value unless default_value == ArgumentError
+      handle_missing_parameter(name)
+    end
+    
+  end # Helpers
+end # Configatron 

data/lib/kernel.rb

@@ -0,0 +1,14 @@
+module Kernel
+  
+  # If called without a block it will return the Configatron::Configuration instance.
+  # If called with a block then it will call the Configatron::Configatron configure method
+  # and yield up a Configatron::Store object.
+  def configatron(&block)
+    if block_given?
+      Configatron::Configuration.instance.configure(&block)
+    else
+      Configatron::Configuration.instance
+    end
+  end
+  
+end

data/lib/store.rb

@@ -0,0 +1,48 @@
+module Configatron
+  # Used to store each of the 'sets' of configuration parameters.
+  class Store
+    include Configatron::Helpers
+    
+    # The actual key/pair parameter values.
+    attr_reader :parameters
+  
+    # Takes an optional Hash to configure parameters.
+    def initialize(parameters = {})
+      @parameters = parameters
+    end
+  
+    # If a method is called with an = at the end, then that method name, minus
+    # the equal sign is added to the parameter list as a key, and it's *args
+    # become the value for that key. Eventually the keys become method names.
+    # If a method is called without an = sign at the end then the value from
+    # the parameters hash is returned, if it exists.
+    def method_missing(sym, *args)
+      if sym.to_s.match(/(.+)=$/)
+        @parameters[sym.to_s.gsub("=", '').to_sym] = *args
+      else
+        val = @parameters[sym]
+        return val unless val.nil?
+        return handle_missing_parameter(sym)
+      end
+    end
+    
+    def exists?(name)
+      return true unless @parameters[name.to_sym].nil?
+      super(name)
+    end
+    
+    # Used to create 'namespaces' around a set of configuration parameters.
+    def namespace(name)
+      if exists?(name)
+        yield self.send(name.to_sym)
+      elsif configatron.exists?(name)
+        yield configatron.send(name.to_sym)
+      else
+        ns = Configatron::Store.new
+        yield ns
+        @parameters[name.to_sym] = ns
+      end
+    end
+  
+  end # Store
+end # Configatron

data/spec/spec.opts

@@ -0,0 +1,2 @@
+--format specdoc
+--colour

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'rubygems'
+require 'pathname'
+require 'spec'
+require Pathname(__FILE__).dirname.parent.expand_path + 'lib/configatron'

data/spec/unit/configuration_spec.rb

@@ -0,0 +1,145 @@
+require 'pathname'
+require Pathname(__FILE__).dirname.expand_path.parent + 'spec_helper'
+
+describe Configatron::Configuration do
+  
+  before :each do
+    configatron.reset!
+  end
+  
+  it "should be a Singleton" do
+    lambda{Configatron::Configuration.new}.should raise_error(NoMethodError)
+    Configatron::Configuration.instance.should == Configatron::Configuration.instance
+  end
+  
+  describe "configure_from_hash" do
+    
+    it "should take a Hash with the same outcome as the configure method" do
+      configatron.should_not respond_to(:bart)
+      configatron.should_not respond_to(:homer)
+      
+      configatron.configure_from_hash(:bart => "Bart Simpson", "homer" => "Homer Simpson")
+      
+      configatron.should respond_to(:bart)
+      configatron.should respond_to(:homer)
+      
+      configatron.bart.should == "Bart Simpson"
+      configatron.homer.should == "Homer Simpson"
+    end
+    
+  end
+  
+  describe "revert" do
+    
+    it "should roll back 1 level by default" do
+      configatron.should_not respond_to(:bart)
+      configatron.should_not respond_to(:homer)
+      
+      configatron do |config|
+        config.bart = "Bart Simpson"
+      end
+      configatron do |config|
+        config.homer = "Homer Simpson"
+      end
+      
+      configatron.should respond_to(:bart)
+      configatron.should respond_to(:homer)
+      
+      configatron.bart.should == "Bart Simpson"
+      configatron.homer.should == "Homer Simpson"
+      
+      configatron.revert
+      
+      configatron.should respond_to(:bart)
+      configatron.should_not respond_to(:homer)
+      configatron.bart.should == "Bart Simpson"
+      lambda{configatron.homer}.should raise_error(NoMethodError)
+    end
+    
+    it "should roll back n levels if specified" do
+      configatron.should_not respond_to(:bart)
+      configatron.should_not respond_to(:homer)
+      
+      configatron do |config|
+        config.bart = "Bart Simpson"
+      end
+      configatron do |config|
+        config.homer = "Homer Simpson"
+      end
+      
+      configatron.should respond_to(:bart)
+      configatron.should respond_to(:homer)
+      
+      configatron.bart.should == "Bart Simpson"
+      configatron.homer.should == "Homer Simpson"
+      
+      configatron.revert(2)
+      
+      configatron.should_not respond_to(:bart)
+      configatron.should_not respond_to(:homer)
+      lambda{configatron.bart}.should raise_error(NoMethodError)
+      lambda{configatron.homer}.should raise_error(NoMethodError)
+    end
+    
+  end
+  
+  describe "reset" do
+  
+    it "should remove all added methods" do
+      configatron.should_not respond_to(:rst1)
+      configatron.should_not respond_to(:rst2)
+    
+      configatron.nil_for_missing.should == false
+    
+      configatron do |config|
+        config.rst1 = "RST1"
+        config.rst2 = "RST2"
+      end
+    
+      configatron.should respond_to(:rst1)
+      configatron.should respond_to(:rst2)
+    
+      configatron.nil_for_missing = true
+      configatron.nil_for_missing.should == true
+    
+      configatron.reset
+    
+      configatron.nil_for_missing.should == true
+    
+      configatron.should_not respond_to(:rst1)
+      configatron.should_not respond_to(:rst2)
+    
+    end
+    
+  end
+  
+  describe "reset!" do
+
+    it "should remove all added methods and revert the nil_for_missing setting" do
+      configatron.should_not respond_to(:rst1)
+      configatron.should_not respond_to(:rst2)
+    
+      configatron.nil_for_missing.should == false
+    
+      configatron do |config|
+        config.rst1 = "RST1"
+        config.rst2 = "RST2"
+      end
+    
+      configatron.should respond_to(:rst1)
+      configatron.should respond_to(:rst2)
+    
+      configatron.nil_for_missing = true
+      configatron.nil_for_missing.should == true
+    
+      configatron.reset!
+    
+      configatron.nil_for_missing.should == false
+    
+      configatron.should_not respond_to(:rst1)
+      configatron.should_not respond_to(:rst2)
+    end
+    
+  end
+  
+end

data/spec/unit/helpers_spec.rb

@@ -0,0 +1,115 @@
+require 'pathname'
+require Pathname(__FILE__).dirname.expand_path.parent + 'spec_helper'
+
+describe Configatron::Helpers do
+  
+  before :each do
+    configatron.reset!
+  end
+  
+  describe "exists?" do
+    
+    it "should return true or false if the configuration parameter exists" do
+      
+      configatron.exists?(:foo).should == false
+      configatron.exists?(:email).should == false
+      
+      configatron do |config|
+        config.foo = :bar
+        config.namespace(:email) do |email|
+          email.address = "mark@mackframework.com"
+        end
+      end
+      
+      configatron.exists?(:foo).should == true
+      configatron.exists?(:email).should == true
+      configatron.email.exists?(:address).should == true
+      configatron.email.exists?(:server).should == false
+      
+    end
+    
+  end
+  
+  describe "retrieve" do
+    
+    before :each do
+      configatron do |config|
+        config.foo = :bar
+        config.namespace(:email) do |email|
+          email.address = "mark@mackframework.com"
+        end
+      end      
+    end
+    
+    it "should return a valid parameter" do
+      configatron.retrieve(:foo).should == :bar
+      configatron.email.retrieve(:address).should == "mark@mackframework.com"
+    end
+    
+    it "should return a default value if one is specified" do
+      configatron.retrieve(:name, "mark").should == "mark"
+      configatron.email.retrieve(:server, "pop3.example.com").should == "pop3.example.com"
+    end
+    
+    it "should behave like a standard missing parameter if no default value is specified" do
+      lambda{configatron.retrieve(:name)}.should raise_error(NoMethodError)
+      lambda{configatron.email.retrieve(:name)}.should raise_error(NoMethodError)
+    end
+    
+    it "should return nil if the default value is nil" do
+      configatron.retrieve(:name, nil).should == nil
+    end
+    
+    it "should work!" do
+      require 'logger'
+      configatron do |config|
+        config.namespace(:mack) do |mack|
+          mack.render_url_timeout = 5
+          mack.cache_classes = true
+          mack.use_lint = true
+          mack.show_exceptions = true
+          mack.session_id = "_mack_session_id"
+          mack.cookie_values = {
+            "path" => "/"
+          }
+          mack.site_domain = "http://localhost:3000"
+          mack.use_distributed_routes = false
+          mack.distributed_app_name = nil
+          mack.drb_timeout = 1
+          mack.default_respository_name = "default"
+        end
+        config.namespace(:cachetastic_default_options) do |cache|
+          cache.debug = false
+          cache.adapter = :local_memory
+          logger = ::Logger.new(STDOUT)
+          logger.level = ::Logger::INFO
+          cache.logger = logger
+        end
+        config.namespace(:log) do |log|
+          log.detailed_requests = true
+          log.level = :info
+          log.console = false
+          log.file = true
+          log.console_format = "%l:\t[%d]\t%M"
+          log.file_format = "%l:\t[%d]\t%M"
+        end
+      end
+      configatron do |config|
+        config.namespace(:mack) do |mack|
+          mack.drb_timeout = 0
+          mack.cookie_values = {}
+        end
+        config.namespace(:log) do |log|
+          log.level = :error
+        end
+        config.run_remote_tests = true
+      end
+      
+      configatron.log.retrieve(:file, false).should == true
+      configatron.log.file.should == true
+
+    end
+    
+  end
+  
+end

data/spec/unit/kernel_spec.rb

@@ -0,0 +1,48 @@
+require 'pathname'
+require Pathname(__FILE__).dirname.expand_path.parent + 'spec_helper'
+
+describe Kernel do
+
+  it "should have a configatron method" do
+    configatron
+  end
+  
+  describe "configatron" do
+    
+    before :each do
+      configatron.reset!
+    end
+    
+    it "should raise NoMethodError if the parameter doesn't exist" do
+      lambda{configatron.i_dont_exist}.should raise_error(NoMethodError)
+    end
+
+    it "should return nil if nil_for_missing is set to true" do
+      configatron.nil_for_missing = true
+      configatron.i_dont_exist.should == nil
+    end
+
+    it "should take a block that allows for the configuration of the configatron system" do
+      lambda{configatron.foo}.should raise_error(NoMethodError)
+      configatron do |config|
+        config.foo = :bar
+        config.say_hello = "Hello World"
+      end
+      configatron.foo.should == :bar
+      configatron.say_hello == "Hello World"
+    end
+
+    it "should allow previously defined parameters to be redefined" do
+      configatron do |config|
+        config.foo = :bar
+      end
+      configatron.foo.should == :bar
+      configatron do |config|
+        config.foo = "fubar"
+      end
+      configatron.foo.should == "fubar"
+    end
+    
+  end
+  
+end

data/spec/unit/store_spec.rb

@@ -0,0 +1,68 @@
+require 'pathname'
+require Pathname(__FILE__).dirname.expand_path.parent + 'spec_helper'
+
+describe Configatron::Store do
+  
+  before :each do
+    configatron.reset!
+  end
+  
+  describe "namespace" do
+    
+    it "should let you 'namespace' a set of configuration parameters" do
+      lambda{configatron.foo}.should raise_error(NoMethodError)
+      configatron do |config|
+        config.namespace(:foo) do |foo|
+          foo.bar = :bar
+        end
+      end
+      configatron.foo.bar.should == :bar
+    end
+    
+    it "should raise NoMethodError if nil_for_missing is set to false" do
+      lambda{configatron.foo}.should raise_error(NoMethodError)
+      configatron do |config|
+        config.namespace(:foo) do |foo|
+          foo.bar = :bar
+        end
+      end
+      lambda{configatron.foo.say_hello}.should raise_error(NoMethodError)
+    end
+    
+    it "should allow for unlimited nested namespaces" do
+      configatron do |config|
+        config.namespace(:foo) do |foo|
+          foo.bar = :bar
+          foo.namespace(:apples) do |apps|
+            apps.granny_smith = "Granny Smith"
+            apps.red = "Red"
+          end
+        end
+      end
+      configatron.foo.bar.should == :bar
+      configatron.foo.apples.granny_smith.should == "Granny Smith"
+    end
+    
+    it "should not override all parameters when you namespace" do
+      configatron do |config|
+        config.namespace(:foo) do |foo|
+          foo.bar = :bar
+          foo.name = "mark"
+        end
+      end
+      configatron.foo.bar.should == :bar
+      configatron.foo.name.should == "mark"
+      
+      configatron do |config|
+        config.namespace(:foo) do |foo|
+          foo.name = "mark bates"
+        end
+      end
+      
+      configatron.foo.bar.should == :bar
+      configatron.foo.name.should == "mark bates"
+    end
+    
+  end
+  
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification 
+name: configatron
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- markbates
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-08-29 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: "Configatron was developed by: markbates"
+email: mark@mackframework.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- lib/configatron.rb
+- lib/configuration.rb
+- lib/helpers.rb
+- lib/kernel.rb
+- lib/store.rb
+- README
+has_rdoc: true
+homepage: http://www.mackframework.com
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+- 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: magrathea
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: A powerful Ruby configuration system.
+test_files: 
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/unit
+- spec/unit/configuration_spec.rb
+- spec/unit/helpers_spec.rb
+- spec/unit/kernel_spec.rb
+- spec/unit/store_spec.rb