steenzout-cfg 1.0.0

data/README.textile

@@ -0,0 +1,32 @@
+h1. steenzout-cfg
+
+Configuration management gem for steenzout packages which,
+if the same convention is followed,
+can be used for any other gems.
+
+
+h2. convention
+
+On your YAML configuration files, the gem name should be the first element.
+
+<pre><code># sample.yaml
+:gem1:
+  (...)
+    :property: value
+
+:gem2:
+  (...)
+    :property: value
+</pre><code>
+
+
+h2. usage
+
+<pre><code>require 'rubygems
+require 'steenzout-cfg'
+
+# load the configuration
+Steenzout::ConfigurationManager.load 'configuration.yaml'
+
+# access a specific gem configuration
+config = Steenzout::ConfigurationManager.configuration_for_gem 'steenzout-cfg'</code></pre>

data/lib/cfg/manager.rb

@@ -0,0 +1,51 @@
+module Steenzout
+
+  # Class to hold gem configurations.
+  class ConfigurationManager
+
+    @@loaded_configurations = {}
+    @@configurations = nil
+
+    # Loads the configuration from the given file.
+    # As convention, the configuration file should have as top symbol the gem name.
+    #
+    # Example:
+    #   :steenzout-cfg:
+    #     :log: 'log/development.log'
+    #
+    # Warning: loading a configuration file which hold configurations for a previous loaded gem,
+    #          will cause the previous configuration to be lost.
+    #
+    #
+    # @param filename: the file to load the configuration.
+    #
+    def self.load filename
+
+      raise ArgumentError, "File #{filename} does not exist!" if !File.exist? filename
+
+      if @@configurations.nil?
+        # load configuration
+        @@configurations = YAML.load_file(filename)
+      else
+        # merge existing configurations
+        YAML.load_file(filename).each {|key, value|
+          @@configurations[key] = value
+        }
+      end
+
+      # TODO: for each gem name, store from which file the configuration was loaded...
+
+    end
+
+
+
+    # Returns the configuration for the given gem.
+    #
+    # @param name: the name of the gem.
+    #
+    def self.configuration_for_gem name
+      @@configurations[:"#{name}"]
+    end
+
+  end
+end

data/lib/steenzout-cfg.rb

@@ -0,0 +1,7 @@
+require 'YAML'
+
+module Steenzout
+
+  autoload :ConfigurationManager, "#{File.dirname(__FILE__)}/cfg/manager"
+
+end

data/test/unit/cfg/manager_test.rb

@@ -0,0 +1,51 @@
+require 'test/unit'
+require 'lib/steenzout-cfg'
+
+
+
+class TestConfigurationManager < Test::Unit::TestCase
+
+  def setup
+
+    Steenzout::ConfigurationManager.load 'test/simple.yaml'
+
+  end
+
+
+
+  def test_configuration_for_gem
+
+    config = Steenzout::ConfigurationManager.configuration_for_gem 'steenzout-cfg'
+    assert_equal({:property => 'value1'}, config)
+
+  end
+
+
+
+  def test_load
+
+    # 1. loading another file with same gem configuration
+    Steenzout::ConfigurationManager.load 'test/another.yaml'
+
+    config = Steenzout::ConfigurationManager.configuration_for_gem 'steenzout-cfg'
+    assert_equal({:property => 'value2'}, config)
+
+
+    # 2. loading another file with no duplicate configuration
+    Steenzout::ConfigurationManager.load 'test/yetanother.yaml'
+
+    config = Steenzout::ConfigurationManager.configuration_for_gem 'steenzout-cfg'
+    assert_equal({:property => 'value2'}, config)
+
+    config = Steenzout::ConfigurationManager.configuration_for_gem 'steenzout-dao'
+    assert_equal({:property => 'value3'}, config)
+
+
+    # 3. loading from inexistent file
+    assert_raises ArgumentError do
+      Steenzout::ConfigurationManager.load 'test/inexistent.yaml'
+    end
+
+  end
+
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification 
+name: steenzout-cfg
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: 
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- steenzout
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-14 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: |
+  This gem provides configuration management functionality through a simple convention.
+
+email: 
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.textile
+files: 
+- lib/cfg/manager.rb
+- lib/steenzout-cfg.rb
+- README.textile
+- test/unit/cfg/manager_test.rb
+has_rdoc: true
+homepage: https://github.com/steenzout/steenzout-cfg
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.5.0
+signing_key: 
+specification_version: 3
+summary: Steenzout configuration management gem.
+test_files: 
+- test/unit/cfg/manager_test.rb