configmanager 0.0.2 → 0.0.3

data/lib/configmanager/exceptions.rb

@@ -1,19 +1,19 @@
-#
-# 20 Jul 2012
-#
-
-module ConfigManager
-
-# Raised when a property references itself - either directly or indirectly.
-  class CircularReferenceError < Exception
-  end
-
-# Raised when a requested property's key is invalid.
-  class KeyError < Exception
-  end
-
-# Raised when a requested property does not exist.
-  class PropertyNotFoundError < Exception
-  end
-
+#
+# 20 Jul 2012
+#
+
+module ConfigManager
+
+# Raised when a property references itself - either directly or indirectly.
+  class CircularReferenceError < Exception
+  end
+
+# Raised when a requested property's key is invalid.
+  class KeyError < Exception
+  end
+
+# Raised when a requested property does not exist.
+  class PropertyNotFoundError < Exception
+  end
+
 end

data/lib/configmanager/interpolators.rb

@@ -1,65 +1,65 @@
-#
-# 20 Jul 2012
-#
-
-require "configmanager/configuration"
-require "configmanager/exceptions"
-
-module ConfigManager
-
-  # The default interpolator that will look for ${} property references.
-  # The interpolator will only inspect Strings and Strings in Arrays. All other types are returned as is.
-  class DefaultInterpolator
-
-    REFERENCE_REGEX = /\$\{[\w\.]+\}/
-
-    # Replaces all ${} references with an actual value. Will evaluate any nested references too.
-    # If circular references are detected, an exception is raised.
-    #
-    # @param [String] key the full (. separated) key against which this value was stored.
-    # @param [String, Array] raw_value the raw value to interpolate.
-    # @param [ConfigManager::Configuration] context the context under which the value should be evaluated.
-    # @param [Hash] options extra configuration options. Supported keys are:
-    #   :replacements - a hash containing replacement values for references. References are replaced with these value on priority.
-    #   :tolerate_missing_properties - a flag to indicate if an exception should be raised if referenced properties are missing.
-    #
-    # @return [String] the fully interpolated value.
-    def self.interpolate(key, raw_value, context, options = {})
-      # Default options.
-      replacements = get_option(options, :replacements, false, {})
-      tolerate_missing_references = get_option(options, :tolerate_missing_references, false, false)
-      interpolating = set_option(options, :interpolating, {}, false)
-      # Mark this key
-      interpolating[key] = true
-      # Check for type.
-      # Array - Recursively call this method.
-      # Not a String - Return as is.
-      # Otherwise, interpolate!
-      return raw_value.map { |item| interpolate(key, item, context, options) } if raw_value.kind_of?(Array)
-      return raw_value unless raw_value.kind_of?(String)
-      raw_value.gsub(REFERENCE_REGEX) do |reference|
-        # If the referenced key is still being interpolated, its a circular reference!
-        # Otherwise, substitute it with its replacement value (either from the supplied hash, or the provided context)
-        key = reference[2..-2]
-        if interpolating[key]
-          trace = (interpolating.keys + [key]).join(" -> ")
-          raise ConfigManager::CircularReferenceError.new("Cannot interpolate - Circular reference detected. Trace: #{trace}")
-        elsif replacements.has_key?(key)
-          replacements[key]
-        elsif context.has_property?(key)
-          context.get_property(key, options)
-        elsif tolerate_missing_references
-          reference
-        else
-          trace = (interpolating.keys + [key]).join(" -> ")
-          raise ConfigManager::PropertyNotFoundError.new("Cannot interpolate - Referenced key '#{key}' does not exist. Trace: #{trace}")
-        end
-      end
-    ensure
-      # Done, so mark as done.
-      interpolating.delete(key)
-    end
-
-  end
-
-end
+#
+# 20 Jul 2012
+#
+
+require "configmanager/configuration"
+require "configmanager/exceptions"
+
+module ConfigManager
+
+  # The default interpolator that will look for ${} property references.
+  # The interpolator will only inspect Strings and Strings in Arrays. All other types are returned as is.
+  class DefaultInterpolator
+
+    REFERENCE_REGEX = /\$\{[\w\.]+\}/
+
+    # Replaces all ${} references with an actual value. Will evaluate any nested references too.
+    # If circular references are detected, an exception is raised.
+    #
+    # @param [String] key the full (. separated) key against which this value was stored.
+    # @param [String, Array] raw_value the raw value to interpolate.
+    # @param [ConfigManager::Configuration] context the context under which the value should be evaluated.
+    # @param [Hash] options extra configuration options. Supported keys are:
+    #   :replacements - a hash containing replacement values for references. References are replaced with these value on priority.
+    #   :tolerate_missing_properties - a flag to indicate if an exception should be raised if referenced properties are missing.
+    #
+    # @return [String] the fully interpolated value.
+    def self.interpolate(key, raw_value, context, options = {})
+      # Default options.
+      replacements = get_option(options, :replacements, false, {})
+      tolerate_missing_references = get_option(options, :tolerate_missing_references, false, false)
+      interpolating = set_option(options, :interpolating, {}, false)
+      # Mark this key
+      interpolating[key] = true
+      # Check for type.
+      # Array - Recursively call this method.
+      # Not a String - Return as is.
+      # Otherwise, interpolate!
+      return raw_value.map { |item| interpolate(key, item, context, options) } if raw_value.kind_of?(Array)
+      return raw_value unless raw_value.kind_of?(String)
+      raw_value.gsub(REFERENCE_REGEX) do |reference|
+        # If the referenced key is still being interpolated, its a circular reference!
+        # Otherwise, substitute it with its replacement value (either from the supplied hash, or the provided context)
+        key = reference[2..-2]
+        if interpolating[key]
+          trace = (interpolating.keys + [key]).join(" -> ")
+          raise ConfigManager::CircularReferenceError.new("Cannot interpolate - Circular reference detected. Trace: #{trace}")
+        elsif replacements.has_key?(key)
+          replacements[key]
+        elsif context.has_property?(key)
+          context.get_property(key, options)
+        elsif tolerate_missing_references
+          reference
+        else
+          trace = (interpolating.keys + [key]).join(" -> ")
+          raise ConfigManager::PropertyNotFoundError.new("Cannot interpolate - Referenced key '#{key}' does not exist. Trace: #{trace}")
+        end
+      end
+    ensure
+      # Done, so mark as done.
+      interpolating.delete(key)
+    end
+
+  end
+
+end

data/lib/configmanager/loaders.rb

@@ -1,182 +1,182 @@
-#
-# 20 Jul 2012
-#
-
-module ConfigManager
-
-  # Loads properties from a YAML file.
-  class YAMLPropertiesLoader
-
-    # Loads properties from the specified YAML file. This is the default loader.
-    #
-    # @param [String] file_path the file to load.
-    # @param [Configuration] configuration the configuration to add the loaded properties to.
-    #
-    # @return [Hash] the properties read from the file.
-    def self.load_properties(file_path, configuration)
-      require "yaml"
-      file_path = File.expand_path(file_path)
-      properties = YAML.load_file(file_path)
-      files_to_import = properties.delete("import") { [] }
-      files_to_import = [files_to_import] unless files_to_import.kind_of?(Array)
-      configuration.add_properties(properties)
-      # Load any referenced files too.
-      file_dir = File.dirname(file_path)
-      files_to_import.each { |file_to_import| load_properties(File.expand_path(file_to_import, file_dir), configuration) }
-    end
-
-  end
-
-  # Loads properties from a Java style property file. The syntax is slightly different from regular property files.
-  # Important differences are :
-  # 1. Escape characters are not allowed.
-  # 2. Properties can be assigned a type (int, float, regex, string, bool).
-  # 3. Properties can be collected as arrays.
-  #
-  # A property would look like :
-  # <key><:optional_type> = <value>
-  # For arrays, add a [] to the property :
-  # <key><:optional_type>[] = <value separated by ','>
-  class JavaPropertiesLoader
-
-    # Raised if a property file is not valid.
-    class SyntaxError < Exception
-    end
-
-    LINE_REGEX = /^([\w\.]+)(:(\w+))?(\[\])?\s*([\s=])\s*(.*)$/
-    COMMAND_REGEX = /^@(\w+)\s+(.*)$/
-
-    TRUE_VALUES = %w(true yes on)
-    FALSE_VALUES = %w(false no off)
-    TYPE_CONVERTERS = {"bool" => :type_bool, "int" => :type_int, "float" => :type_float, "regex" => :type_regex,
-                       "string" => :type_string, nil => :type_string}
-    COMMANDS = {"import" => :command_import}
-
-    # Executes the import command.
-    #
-    # @param [String] file_to_import the file that needs to be imported.
-    # @param [String] file_path the file that contained the command.
-    # @param [Integer] line_number the line number where the command existed.
-    # @param [ConfigManager::Configuration] configuration the configuration to load the properties into.
-    #
-    # @return [NilClass]
-    def self.command_import(file_to_import, file_path, line_number, configuration)
-      file_to_import = file_to_import[1..-2]
-      file_dir = File.dirname(file_path)
-      file_to_import = File.expand_path(file_to_import, file_dir)
-      load_properties(file_to_import, configuration)
-      nil
-    end
-
-    # Loads properties from the specified Java style property file.
-    #
-    # @param [String] file_path the file to load properties from.
-    # @param [ConfigManager::Configuration] configuration the configuration to load the properties into.
-    #
-    # @return [NilClass]
-    def self.load_properties(file_path, configuration)
-      file_path = File.expand_path(file_path)
-      lines = File.readlines(file_path)
-      lines.each_with_index do |line, line_number|
-        line = line.chomp.strip
-        # Empty lines, ignore.
-        # Comment lines, ignore.
-        # Command - Call the command's method.
-        next if line.empty?
-        next if line.start_with?("#")
-        match = line.match(COMMAND_REGEX)
-        if match
-          command_name = match[1]
-          command_arg = match[2]
-          raise SyntaxError.new("Unrecognized command '#{command_name}' #(#{file_path}:#{line_number})") unless COMMANDS.has_key?(command_name)
-          send(COMMANDS[command_name], command_arg, file_path, line_number, configuration)
-          next
-        end
-        # Other lines, parse as a property.
-        # Raises an exception if the line was not valid.
-        match = line.match(LINE_REGEX)
-        raise SyntaxError.new("Syntax error '#{line}' (#{file_path}:#{line_number})") if match.nil?
-        key, type, array, value = match[1], match[3], match[4], match[6]
-        # Invalid types raise an exception.
-        raise SyntaxError.new("Unrecognized type '#{type}' (#{file_path}:#{line_number})") unless TYPE_CONVERTERS.has_key?(type)
-        type_converter = TYPE_CONVERTERS[type]
-
-        # Split into array if required and apply the type converter.
-        if array
-          value = value.split(",").map { |item| send(type_converter, item.strip, file_path, line_number) }
-        else
-          value = send(type_converter, value, file_path, line_number)
-        end
-
-        # Finally, add to configuration.
-        configuration.add_property(key, value)
-      end
-      nil
-    end
-
-    # Converts the specified string value into a boolean (TrueClass, FalseClass).
-    #
-    # @param [String] value the string value to convert.
-    # @param [String] file_path the file that contains the property.
-    # @param [Integer] line_number the line that contained this property.
-    #
-    # @return [TrueClass, FalseClass]
-    def self.type_bool(value, file_path, line_number)
-      return true if TRUE_VALUES.include?(value)
-      return false if FALSE_VALUES.include?(value)
-      raise SyntaxError.new("Invalid boolean '#{value}' (#{file_path}:#{line_number})")
-    end
-
-    # Converts the specified string value into float.
-    # Invalid values will raise an exception.
-    #
-    # @param [String] value the string value to convert.
-    # @param [String] file_path the file that contains the property.
-    # @param [Integer] line_number the line that contained this property.
-    #
-    # @return [Float]
-    def self.type_float(value, file_path, line_number)
-      Float(value)
-    rescue
-      raise SyntaxError.new("Invalid float value '#{value}' (#{file_path}:#{line_number})")
-    end
-
-    # Converts the specified string value into a integer.
-    # Invalid values will raise an exception
-    #
-    # @param [String] value the string value to convert.
-    # @param [String] file_path the file that contains the property.
-    # @param [Integer] line_number the line that contained this property.
-    #
-    # @return [Integer]
-    def self.type_int(value, file_path, line_number)
-      Integer(value)
-    rescue
-      raise SyntaxError.new("Invalid integer value '#{value}' (#{file_path}:#{line_number})")
-    end
-
-    # Converts the specified string value into a regexp.
-    #
-    # @param [String] value the string value to convert.
-    # @param [String] file_path the file that contains the property.
-    # @param [Integer] line_number the line that contained this property.
-    #
-    # @return [Regexp]
-    def self.type_regex(value, file_path, line_number)
-      Regexp.new(value)
-    end
-
-    # Returns the value as is.
-    #
-    # @param [String] value the string value to convert.
-    # @param [String] file_path the file that contains the property.
-    # @param [Integer] line_number the line that contained this property.
-    #
-    # @return [String]
-    def self.type_string(value, file_path, line_number)
-      value
-    end
-
-  end
-
-end
+#
+# 20 Jul 2012
+#
+
+module ConfigManager
+
+  # Loads properties from a YAML file.
+  class YAMLPropertiesLoader
+
+    # Loads properties from the specified YAML file. This is the default loader.
+    #
+    # @param [String] file_path the file to load.
+    # @param [Configuration] configuration the configuration to add the loaded properties to.
+    #
+    # @return [Hash] the properties read from the file.
+    def self.load_properties(file_path, configuration)
+      require "yaml"
+      file_path = File.expand_path(file_path)
+      properties = YAML.load_file(file_path)
+      files_to_import = properties.delete("import") { [] }
+      files_to_import = [files_to_import] unless files_to_import.kind_of?(Array)
+      configuration.add_properties(properties)
+      # Load any referenced files too.
+      file_dir = File.dirname(file_path)
+      files_to_import.each { |file_to_import| load_properties(File.expand_path(file_to_import, file_dir), configuration) }
+    end
+
+  end
+
+  # Loads properties from a Java style property file. The syntax is slightly different from regular property files.
+  # Important differences are :
+  # 1. Escape characters are not allowed.
+  # 2. Properties can be assigned a type (int, float, regex, string, bool).
+  # 3. Properties can be collected as arrays.
+  #
+  # A property would look like :
+  # <key><:optional_type> = <value>
+  # For arrays, add a [] to the property :
+  # <key><:optional_type>[] = <value separated by ','>
+  class JavaPropertiesLoader
+
+    # Raised if a property file is not valid.
+    class SyntaxError < Exception
+    end
+
+    LINE_REGEX = /^([\w\.]+)(:(\w+))?(\[\])?\s*([\s=])\s*(.*)$/
+    COMMAND_REGEX = /^@(\w+)\s+(.*)$/
+
+    TRUE_VALUES = %w(true yes on)
+    FALSE_VALUES = %w(false no off)
+    TYPE_CONVERTERS = {"bool" => :type_bool, "int" => :type_int, "float" => :type_float, "regex" => :type_regex,
+                       "string" => :type_string, nil => :type_string}
+    COMMANDS = {"import" => :command_import}
+
+    # Executes the import command.
+    #
+    # @param [String] file_to_import the file that needs to be imported.
+    # @param [String] file_path the file that contained the command.
+    # @param [Integer] line_number the line number where the command existed.
+    # @param [ConfigManager::Configuration] configuration the configuration to load the properties into.
+    #
+    # @return [NilClass]
+    def self.command_import(file_to_import, file_path, line_number, configuration)
+      file_to_import = file_to_import[1..-2]
+      file_dir = File.dirname(file_path)
+      file_to_import = File.expand_path(file_to_import, file_dir)
+      load_properties(file_to_import, configuration)
+      nil
+    end
+
+    # Loads properties from the specified Java style property file.
+    #
+    # @param [String] file_path the file to load properties from.
+    # @param [ConfigManager::Configuration] configuration the configuration to load the properties into.
+    #
+    # @return [NilClass]
+    def self.load_properties(file_path, configuration)
+      file_path = File.expand_path(file_path)
+      lines = File.readlines(file_path)
+      lines.each_with_index do |line, line_number|
+        line = line.chomp.strip
+        # Empty lines, ignore.
+        # Comment lines, ignore.
+        # Command - Call the command's method.
+        next if line.empty?
+        next if line.start_with?("#")
+        match = line.match(COMMAND_REGEX)
+        if match
+          command_name = match[1]
+          command_arg = match[2]
+          raise SyntaxError.new("Unrecognized command '#{command_name}' #(#{file_path}:#{line_number})") unless COMMANDS.has_key?(command_name)
+          send(COMMANDS[command_name], command_arg, file_path, line_number, configuration)
+          next
+        end
+        # Other lines, parse as a property.
+        # Raises an exception if the line was not valid.
+        match = line.match(LINE_REGEX)
+        raise SyntaxError.new("Syntax error '#{line}' (#{file_path}:#{line_number})") if match.nil?
+        key, type, array, value = match[1], match[3], match[4], match[6]
+        # Invalid types raise an exception.
+        raise SyntaxError.new("Unrecognized type '#{type}' (#{file_path}:#{line_number})") unless TYPE_CONVERTERS.has_key?(type)
+        type_converter = TYPE_CONVERTERS[type]
+
+        # Split into array if required and apply the type converter.
+        if array
+          value = value.split(",").map { |item| send(type_converter, item.strip, file_path, line_number) }
+        else
+          value = send(type_converter, value, file_path, line_number)
+        end
+
+        # Finally, add to configuration.
+        configuration.add_property(key, value)
+      end
+      nil
+    end
+
+    # Converts the specified string value into a boolean (TrueClass, FalseClass).
+    #
+    # @param [String] value the string value to convert.
+    # @param [String] file_path the file that contains the property.
+    # @param [Integer] line_number the line that contained this property.
+    #
+    # @return [TrueClass, FalseClass]
+    def self.type_bool(value, file_path, line_number)
+      return true if TRUE_VALUES.include?(value)
+      return false if FALSE_VALUES.include?(value)
+      raise SyntaxError.new("Invalid boolean '#{value}' (#{file_path}:#{line_number})")
+    end
+
+    # Converts the specified string value into float.
+    # Invalid values will raise an exception.
+    #
+    # @param [String] value the string value to convert.
+    # @param [String] file_path the file that contains the property.
+    # @param [Integer] line_number the line that contained this property.
+    #
+    # @return [Float]
+    def self.type_float(value, file_path, line_number)
+      Float(value)
+    rescue
+      raise SyntaxError.new("Invalid float value '#{value}' (#{file_path}:#{line_number})")
+    end
+
+    # Converts the specified string value into a integer.
+    # Invalid values will raise an exception
+    #
+    # @param [String] value the string value to convert.
+    # @param [String] file_path the file that contains the property.
+    # @param [Integer] line_number the line that contained this property.
+    #
+    # @return [Integer]
+    def self.type_int(value, file_path, line_number)
+      Integer(value)
+    rescue
+      raise SyntaxError.new("Invalid integer value '#{value}' (#{file_path}:#{line_number})")
+    end
+
+    # Converts the specified string value into a regexp.
+    #
+    # @param [String] value the string value to convert.
+    # @param [String] file_path the file that contains the property.
+    # @param [Integer] line_number the line that contained this property.
+    #
+    # @return [Regexp]
+    def self.type_regex(value, file_path, line_number)
+      Regexp.new(value)
+    end
+
+    # Returns the value as is.
+    #
+    # @param [String] value the string value to convert.
+    # @param [String] file_path the file that contains the property.
+    # @param [Integer] line_number the line that contained this property.
+    #
+    # @return [String]
+    def self.type_string(value, file_path, line_number)
+      value
+    end
+
+  end
+
+end