configmanager 0.0.1

data/lib/configmanager.rb

@@ -0,0 +1,27 @@
+#
+# 16 Jul 2012
+#
+
+require "options_arg"
+
+require "configmanager/configuration"
+require "configmanager/loaders"
+
+# General purpose configuration manager.
+# Loads properties from YAML files and makes them available through a same hash like interface.
+# Supports ${} and $() style references. All references are evaluated only when a property's value is requested.
+module ConfigManager
+
+  # Loads properties from the specified file.
+  #
+  # @param [String] file_path the file to load properties from.
+  # @param [Object] loader any object that can respond to the 'load_properties(file_path, configuration)' method and return a hash.
+  # @param [ConfigManager::Configuration] configuration the configuration to load the properties into.
+  #
+  # @return [ConfigManager::Configuration] the configuration object wrapping the properties loaded from the file.
+  def self.load_from_file(file_path, loader = YAMLPropertiesLoader, configuration = ConfigManager::Configuration.new())
+    loader.load_properties(file_path, configuration)
+    configuration
+  end
+
+end

data/lib/options_arg.rb

@@ -0,0 +1,66 @@
+#
+# 16 Jul 2012
+#
+
+# Provides a few methods to work with hashes.
+module Kernel
+
+  # Raised if a required option has not been set.
+  class OptionNotSetError < Exception
+  end
+
+  private
+
+  # Get a value from the specified hash.
+  #
+  # @param [Hash] options the hash.
+  # @param [Symbol] key the key whose value is required.
+  # @param [TrueClass, FalseClass] required flag to indicate if it is an error if the key does not exist.
+  # @param [Object] default the default value if the key does not exist. Only used if 'required' is false.
+  #
+  # @return [Object] the value from the hash, or the default value.
+  def get_option(options, key, required = false, default = nil)
+    if options.has_key?(key)
+      options[key]
+    elsif required
+      raise OptionNotSetError.new("Option '#{key}' has not been set!")
+    else
+      default
+    end
+  end
+
+  # Pops (delete) a value from the specified hash.
+  #
+  # @param [Hash] options the hash.
+  # @param [Symbol] key the key whose value is required.
+  # @param [TrueClass, FalseClass] required flag to indicate if it is an error if the key does not exist.
+  # @param [Object] default the default value if the key does not exist. Only used if 'required' is false.
+  #
+  # @return [Object] the value from the hash, or the default value.
+  def pop_option(options, key, required = false, default = nil)
+    if options.has_key?(key)
+      options.delete(key)
+    elsif required
+      raise OptionNotSetError.new("Option '#{key}' has not been set!")
+    else
+      default
+    end
+  end
+
+  # Sets a value in the specified hash.
+  #
+  # @param [Hash] options the hash.
+  # @param [Symbol] key the key whose value is to be set.
+  # @param [Object] value the value to set.
+  # @param [TrueClass, FalseClass] overwrite flag to indicate if existing values should be overwritten.
+  #
+  # @return [Object] the value in the hash at the end of the operation.
+  def set_option(options, key, value, overwrite)
+    if not options.has_key?(key) or overwrite
+      options[key] = value
+    end
+    # Return whatever is in the hash now.
+    options[key]
+  end
+
+end

data/lib/test_configmanager.rb

@@ -0,0 +1,26 @@
+#
+# 20 Jul 2012
+#
+
+$LOAD_PATH << "."
+
+require "configmanager"
+require "configmanager/combined_configuration"
+require "configmanager/loaders"
+
+properties_configuration = ConfigManager.load_from_file("samples/test 1.properties", ConfigManager::JavaPropertiesLoader)
+yaml_configuration = ConfigManager.load_from_file("samples/test 1.yaml", ConfigManager::YAMLPropertiesLoader)
+
+test_configuration = ConfigManager::CombinedConfiguration.new()
+test_configuration.add_configuration("properties", properties_configuration)
+test_configuration.add_configuration("yaml", yaml_configuration)
+
+keys = ["sample_string", "sample_int", "sample_float", "sample_array", "sample_int_array", "sample_reference",
+        "sample_reference_array"]
+
+puts ".properties"
+keys.each { |key| puts test_configuration["test.#{key}"].inspect }
+
+puts ""
+puts ".yaml"
+keys.each { |key| puts test_configuration["test_yaml.#{key}"].inspect }

metadata

@@ -0,0 +1,51 @@
+--- !ruby/object:Gem::Specification
+name: configmanager
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Suraj Vijayakumar
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-20 00:00:00.000000000Z
+dependencies: []
+description: ConfigManager can load properties from YAML or Java style property files.
+  Properties can have references to other properties that are resolved at run-time.
+  Inspired, in part by Apache's configuration API.
+email:
+- vijayakumar.suraj@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/configmanager.rb
+- lib/options_arg.rb
+- lib/test_configmanager.rb
+homepage: 
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.7.2
+signing_key: 
+specification_version: 3
+summary: An easy configuration manager for managing an applications configuration
+  files.
+test_files: []