configtoolkit 1.2.0 → 2.0.0

data/test/test_hash.rb

@@ -0,0 +1,82 @@
+#!/usr/bin/env ruby
+
+require 'readerwritertest'
+
+require 'configtoolkit/hashreader'
+require 'configtoolkit/hashwriter'
+
+class HASHTest < Test::Unit::TestCase
+  include ReaderWriterTest
+
+  SAMPLE_CONFIG_HASH = {
+    :req_integer => 6,
+    :req_big_integer => 90000000000,
+    :req_float => 3.14,
+    :req_string => "sample string2",
+    :req_boolean => true,
+    :req_pathname => Pathname.new("/usr/designingpatterns/bin"),
+    :req_uri => URI("http://blogs.designingpatterns.com"),
+    :req_symbol => :sample_symbol2,
+    :nested_config => {
+      :req_nested_integer => 34,
+      :req_nested_array => [
+                            {
+                              :req_second_nested_pathname => Pathname.new("/usr/designingpatterns/Applications/pattmake"),
+                              :req_second_nested_array => [6, 20]
+                            },
+                            {
+                              :req_second_nested_pathname => Pathname.new("/usr"),
+                              :req_second_nested_array => [205, 206]
+                            }
+                           ]
+    },
+    :opt_integer => 56
+  }
+
+  CONTAINED_SAMPLE_CONFIG_HASH = {
+    :first => {
+      :second => {
+        :req_integer => 5,
+        :req_big_integer => 10000000000,
+        :req_float => 5.678,
+        :req_string => "sample string",
+        :req_boolean => false,
+        :req_pathname => Pathname.new("/usr/designingpatterns"),
+        :req_uri => URI("http://www.designingpatterns.com"),
+        :req_symbol => :sample_symbol,
+        :nested_config => {
+          :req_nested_integer => 33,
+          :req_nested_array => [
+                                {
+                                  :req_second_nested_pathname => Pathname.new("/usr/designingpatterns/Applications"),
+                                  :req_second_nested_array => [5, 19]
+                                },
+                                {
+                                  :req_second_nested_pathname => Pathname.new("/usr/designingpatterns/Applications/etc"),
+                                  :req_second_nested_array => [200, 201]
+                                }
+                               ]
+        },
+        :opt_integer => 42
+      }
+    }
+  }
+
+  def test_reader_writer
+    run_reader_test(ConfigToolkit::HashReader,
+                    "",
+                    REFERENCE_SAMPLE_CONFIG,
+                    SAMPLE_CONFIG_HASH)
+
+    writer = ConfigToolkit::HashWriter.new()
+    REFERENCE_SAMPLE_CONFIG.dump(writer)
+    assert_equal(SAMPLE_CONFIG_HASH, writer.config_hash)
+
+    run_reader_test(ConfigToolkit::HashReader,
+                    "first.second",
+                    REFERENCE_CONTAINED_SAMPLE_CONFIG,
+                    CONTAINED_SAMPLE_CONFIG_HASH)
+    REFERENCE_CONTAINED_SAMPLE_CONFIG.dump(writer)
+    assert_equal(CONTAINED_SAMPLE_CONFIG_HASH, writer.config_hash)
+  end
+end

data/test/test_keyvalue.rb

@@ -0,0 +1,185 @@
+#!/usr/bin/env ruby
+
+require 'readerwritertest'
+
+require 'configtoolkit/keyvaluereader'
+require 'configtoolkit/keyvaluewriter'
+require 'configtoolkit/hashreader'
+
+require 'rubygems'
+require 'assertions'
+require 'relative'
+
+class KeyValueTest < Test::Unit::TestCase
+  include ReaderWriterTest
+  
+  WACKY_KEY_VALUE_CONFIG = ConfigToolkit::KeyValueConfig.load(
+    ConfigToolkit::HashReader.new(:key_value_delimiter => ":>",
+                                  :comment_line_prefix => ";;",
+                                  :directive_line_prefix => "##",
+                                  :array_opening => "(",
+                                  :array_closing => "|",
+                                  :hash_opening => "+",
+                                  :hash_closing => "-",
+                                  :hash_key_value_delimiter => ">>>>")
+  )
+
+  def test_reader
+    run_reader_test(ConfigToolkit::KeyValueReader,
+                    "",
+                    REFERENCE_SAMPLE_CONFIG,
+                    File.expand_path_relative_to_caller("sample.cfg"))
+
+    run_reader_test(ConfigToolkit::KeyValueReader,
+                    "",
+                    REFERENCE_SAMPLE_CONFIG,
+                    File.new(File.expand_path_relative_to_caller("sample.cfg"), "r"))
+    
+    run_reader_test(ConfigToolkit::KeyValueReader,
+                    "first.second",
+                    REFERENCE_CONTAINED_SAMPLE_CONFIG,
+                    File.expand_path_relative_to_caller("contained_sample.cfg"))
+
+    #
+    # Try reading a config file containing REFERENCE_SAMPLE_CONFIG but using
+    # a wacky key-value format.
+    #
+    wacky_reader = ConfigToolkit::KeyValueReader.new(File.expand_path_relative_to_caller("wacky_sample1.cfg"), WACKY_KEY_VALUE_CONFIG)
+    config = SampleConfig.load(wacky_reader)
+    assert_equal(REFERENCE_SAMPLE_CONFIG, config)
+  end
+
+  def verify_reader_error(file_name, reader_config, message)
+    reader = ConfigToolkit::KeyValueReader.new(file_name, reader_config)
+    
+    assert_raise_message(message, ConfigToolkit::Error) do
+      reader.read()
+    end
+  end
+
+  def test_containers
+    #
+    # Read the same config file, once with containers allowed (default) and
+    # once without.  Verify that the results reflect whether or not containers
+    # are allowed.
+    #
+    reader = ConfigToolkit::KeyValueReader.new(File.expand_path_relative_to_caller("containers.cfg"))
+    assert_equal({:favorite_ice_cream => {:flavor => "butter pecan", :topping= => "caramel"}}, reader.read())
+    
+    config = ConfigToolkit::KeyValueConfig.load(ConfigToolkit::HashReader.new(:allow_containers => false))
+    reader = ConfigToolkit::KeyValueReader.new(File.expand_path_relative_to_caller("containers.cfg"), config)
+    assert_equal({:favorite_ice_cream => "{flavor => butter pecan, topping= => caramel}"}, reader.read())
+  end
+
+  def test_reader_errors
+    path = File.expand_path_relative_to_caller("missing_include_argument.cfg")
+    verify_reader_error(path,
+                        ConfigToolkit::KeyValueConfig::DEFAULT_CONFIG,
+                        "Error parsing line #1 of #{path}: missing filename for include directive!")
+
+    path = File.expand_path_relative_to_caller("bad_include1.cfg")
+    bad_path = File.expand_path_relative_to_caller("bad_include2.cfg")
+    verify_reader_error(path,
+                        ConfigToolkit::KeyValueConfig::DEFAULT_CONFIG,
+                        "Error parsing line #3 of #{bad_path}: missing key-value delimiter '='!")
+
+    path = File.expand_path_relative_to_caller("bad_directive.cfg")
+    verify_reader_error(path,
+                        ConfigToolkit::KeyValueConfig::DEFAULT_CONFIG,
+                        "Error parsing line #1 of #{path}: unknown directive 'bogus'!")
+
+    path = File.expand_path_relative_to_caller("extra_container_closing.cfg")
+    verify_reader_error(path,
+                        ConfigToolkit::KeyValueConfig::DEFAULT_CONFIG,
+                        "Error parsing line #2 of #{path}: unmatched '}'!")
+
+    path = File.expand_path_relative_to_caller("extra_string_after_nested_container.cfg")
+    verify_reader_error(path,
+                        ConfigToolkit::KeyValueConfig::DEFAULT_CONFIG,
+                        "Error parsing line #1 of #{path}: extraneous character 'b' after container!")
+
+    path = File.expand_path_relative_to_caller("extra_string_after_container.cfg")
+    verify_reader_error(path,
+                        ConfigToolkit::KeyValueConfig::DEFAULT_CONFIG,
+                        "Error parsing line #2 of #{path}: extraneous string 'abcd' after container!")
+
+    path = File.expand_path_relative_to_caller("missing_hash_value.cfg")
+    verify_reader_error(path,
+                        ConfigToolkit::KeyValueConfig::DEFAULT_CONFIG,
+                        "Error parsing line #1 of #{path}: hash key 'topping' is missing a value!")
+
+    path = File.expand_path_relative_to_caller("missing_hash_element.cfg")
+    verify_reader_error(path,
+                        ConfigToolkit::KeyValueConfig::DEFAULT_CONFIG,
+                        "Error parsing line #2 of #{path}: missing container element before ','!")
+
+    path = File.expand_path_relative_to_caller("missing_array_element.cfg")
+    verify_reader_error(path,
+                        ConfigToolkit::KeyValueConfig::DEFAULT_CONFIG,
+                        "Error parsing line #2 of #{path}: missing container element before ','!")
+
+    path = File.expand_path_relative_to_caller("missing_hash_closing.cfg")
+    verify_reader_error(path,
+                        ConfigToolkit::KeyValueConfig::DEFAULT_CONFIG,
+                        "Error parsing line #2 of #{path}: missing hash closing '}'!")
+
+    path = File.expand_path_relative_to_caller("missing_array_closing.cfg")
+    verify_reader_error(path,
+                        ConfigToolkit::KeyValueConfig::DEFAULT_CONFIG,
+                        "Error parsing line #2 of #{path}: missing array closing ']'!")
+
+    path = File.expand_path_relative_to_caller("missing_directive.cfg")
+    verify_reader_error(path,
+                        ConfigToolkit::KeyValueConfig::DEFAULT_CONFIG,
+                        "Error parsing line #1 of #{path}: missing directive on line starting with directive prefix '*'!")
+
+    path = File.expand_path_relative_to_caller("missing_key_value_delimiter.cfg")
+    verify_reader_error(path,
+                        ConfigToolkit::KeyValueConfig::DEFAULT_CONFIG,
+                        "Error parsing line #1 of #{path}: missing key-value delimiter '='!")
+
+    assert_raise_message("Error parsing line #1 of <unknown>: only can process relative include directives in File streams!", ConfigToolkit::Error) do
+      string_stream = StringIO.new("*include bogus")
+      ConfigToolkit::KeyValueReader.new(string_stream).read()
+    end
+  end
+  
+  
+  def test_writer
+    run_writer_test(ConfigToolkit::KeyValueWriter,
+                    :sort_lines_and_line_contents,
+                    REFERENCE_SAMPLE_CONFIG,
+                    File.expand_path_relative_to_caller("sample.cfg"),
+                    File.expand_path_relative_to_caller("sample.dumped.cfg"),
+                    File.expand_path_relative_to_caller("sample.dumped.cfg"))
+
+    run_writer_test(ConfigToolkit::KeyValueWriter,
+                    :sort_lines_and_line_contents,
+                    REFERENCE_CONTAINED_SAMPLE_CONFIG,
+                    File.expand_path_relative_to_caller("contained_sample.cfg"),
+                    File.expand_path_relative_to_caller("contained_sample.dumped.cfg"),
+                    File.expand_path_relative_to_caller("contained_sample.dumped.cfg"))
+  end
+
+  def test_reader_writer
+    run_reader_writer_test(ConfigToolkit::KeyValueReader,
+                           ConfigToolkit::KeyValueWriter,
+                           REFERENCE_SAMPLE_CONFIG,
+                           [File.expand_path_relative_to_caller("sample.cfg")],
+                           [File.expand_path_relative_to_caller("sample.dumped.cfg")])
+
+    run_reader_writer_test(ConfigToolkit::KeyValueReader,
+                           ConfigToolkit::KeyValueWriter,
+                           REFERENCE_SAMPLE_CONFIG,
+                           [File.expand_path_relative_to_caller("wacky_sample1.cfg"),
+                            WACKY_KEY_VALUE_CONFIG],
+                           [File.expand_path_relative_to_caller("wacky_sample.dumped.cfg"),
+                            WACKY_KEY_VALUE_CONFIG])
+
+    run_reader_writer_test(ConfigToolkit::KeyValueReader,
+                           ConfigToolkit::KeyValueWriter,
+                           REFERENCE_CONTAINED_SAMPLE_CONFIG,
+                           [File.expand_path_relative_to_caller("contained_sample.cfg")],
+                           [File.expand_path_relative_to_caller("contained_sample.dumped.cfg")])
+  end
+end

data/test/test_prettyprint.rb

@@ -0,0 +1,28 @@
+#!/usr/bin/env ruby
+
+require 'readerwritertest'
+
+require 'configtoolkit/prettyprintwriter'
+
+require 'rubygems'
+require 'relative'
+
+class PrettyPrintTest < Test::Unit::TestCase
+  include ReaderWriterTest
+
+  def test_writer
+    run_writer_test(ConfigToolkit::PrettyPrintWriter,
+                    :sort_lines,
+                    REFERENCE_SAMPLE_CONFIG,
+                    File.expand_path_relative_to_caller("sample.pretty_print"),
+                    File.expand_path_relative_to_caller("sample.dumped.pretty_print"),
+                    File.expand_path_relative_to_caller("sample.dumped.pretty_print"))
+
+    run_writer_test(ConfigToolkit::PrettyPrintWriter,
+                    :sort_lines,
+                    REFERENCE_CONTAINED_SAMPLE_CONFIG,
+                    File.expand_path_relative_to_caller("contained_sample.pretty_print"),
+                    File.expand_path_relative_to_caller("contained_sample.dumped.pretty_print"),
+                    File.expand_path_relative_to_caller("contained_sample.dumped.pretty_print"))
+  end
+end

data/test/test_ruby.rb

@@ -0,0 +1,50 @@
+#!/usr/bin/env ruby
+
+require 'readerwritertest'
+
+require 'configtoolkit/rubyreader'
+
+require 'rubygems'
+require 'assertions'
+require 'relative'
+
+class RubyTest < Test::Unit::TestCase
+  include ReaderWriterTest
+
+  def test_reader
+    run_reader_test(ConfigToolkit::RubyReader,
+                    "",
+                    REFERENCE_SAMPLE_CONFIG,
+                    File.expand_path_relative_to_caller("sample.rcfg"))
+
+    run_reader_test(ConfigToolkit::RubyReader,
+                    "",
+                    REFERENCE_SAMPLE_CONFIG,
+                    File.new(File.expand_path_relative_to_caller("sample.rcfg"), "r"))
+    
+    run_reader_test(ConfigToolkit::RubyReader,
+                    "first.second",
+                    REFERENCE_CONTAINED_SAMPLE_CONFIG,
+                    File.expand_path_relative_to_caller("contained_sample.rcfg"))
+  end
+
+  def verify_reader_error(file_name, message)
+    reader = ConfigToolkit::RubyReader.new(file_name)
+    
+    assert_raise_message(message, ConfigToolkit::Error) do
+      reader.read()
+    end
+  end
+
+  def test_reader_errors
+    verify_reader_error(File.expand_path_relative_to_caller("bad_containing_object_assignment.rcfg"),
+                        "cannot assign to object config.first.second")
+
+    verify_reader_error(File.expand_path_relative_to_caller("bad_array_index.rcfg"),
+                        "cannot index with array notation into config.unknown_array")
+
+    assert_raise(NoMethodError) do
+      ConfigToolkit::RubyReader.new(File.expand_path_relative_to_caller("bad_parameter_reference.rcfg")).read()
+    end
+  end
+end

data/test/test_yaml.rb

@@ -1,76 +1,83 @@
 #!/usr/bin/env ruby
 
-require 'common'
 require 'readerwritertest'
 
 require 'configtoolkit/yamlreader'
 require 'configtoolkit/yamlwriter'
 
+require 'rubygems'
+require 'assertions'
+require 'relative'
+
 class YAMLTest < Test::Unit::TestCase
   include ReaderWriterTest
 
-  def test_readers
+  def test_reader
     run_reader_test(ConfigToolkit::YAMLReader,
                     "",
                     REFERENCE_SAMPLE_CONFIG,
-                    get_test_config_file_name("sample.standard_yaml_classes.yaml"))
+                    File.expand_path_relative_to_caller("sample.standard_yaml_classes.yaml"))
     
     run_reader_test(ConfigToolkit::YAMLReader,
                     "",
                     REFERENCE_SAMPLE_CONFIG,
-                    get_test_config_file_name("sample.ruby_yaml_classes.yaml"))
+                    File.expand_path_relative_to_caller("sample.ruby_yaml_classes.yaml"))
     
     run_reader_test(ConfigToolkit::YAMLReader,
                     "",
                     REFERENCE_SAMPLE_CONFIG,
-                    File.new(get_test_config_file_name("sample.ruby_yaml_classes.yaml"), "r"))
+                    File.new(File.expand_path_relative_to_caller("sample.ruby_yaml_classes.yaml"), "r"))
     
     run_reader_test(ConfigToolkit::YAMLReader,
-                    "contained_sample",
+                    "first.second",
                     REFERENCE_CONTAINED_SAMPLE_CONFIG,
-                    get_test_config_file_name("contained_sample.yaml"))
+                    File.expand_path_relative_to_caller("contained_sample.yaml"))
   end
-  
-  def test_writers
+        
+  def test_writer
     run_writer_test(ConfigToolkit::YAMLWriter,
+                    :sort_lines,
                     REFERENCE_SAMPLE_CONFIG,
-                    get_test_config_file_name("sample.standard_yaml_classes.yaml"),
-                    get_test_config_file_name("sample.standard_yaml_classes.dumped.yaml"),
-                    get_test_config_file_name("sample.standard_yaml_classes.dumped.yaml"),
+                    File.expand_path_relative_to_caller("sample.standard_yaml_classes.yaml"),
+                    File.expand_path_relative_to_caller("sample.standard_yaml_classes.dumped.yaml"),
+                    File.expand_path_relative_to_caller("sample.standard_yaml_classes.dumped.yaml"),
                     true)
     
     run_writer_test(ConfigToolkit::YAMLWriter,
+                    :sort_lines,
                     REFERENCE_SAMPLE_CONFIG,
-                    get_test_config_file_name("sample.ruby_yaml_classes.yaml"),
-                    get_test_config_file_name("sample.ruby_yaml_classes.dumped.yaml"),
-                    get_test_config_file_name("sample.ruby_yaml_classes.dumped.yaml"),
+                    File.expand_path_relative_to_caller("sample.ruby_yaml_classes.yaml"),
+                    File.expand_path_relative_to_caller("sample.ruby_yaml_classes.dumped.yaml"),
+                    File.expand_path_relative_to_caller("sample.ruby_yaml_classes.dumped.yaml"),
                     false)
     
     run_writer_test(ConfigToolkit::YAMLWriter,
+                    :sort_lines,
                     REFERENCE_SAMPLE_CONFIG,
-                    get_test_config_file_name("sample.standard_yaml_classes.yaml"),
-                    get_test_config_file_name("sample.standard_yaml_classes.dumped.yaml"),
-                    File.new(get_test_config_file_name("sample.standard_yaml_classes.dumped.yaml"), "w"),
+                    File.expand_path_relative_to_caller("sample.standard_yaml_classes.yaml"),
+                    File.expand_path_relative_to_caller("sample.standard_yaml_classes.dumped.yaml"),
+                    File.new(File.expand_path_relative_to_caller("sample.standard_yaml_classes.dumped.yaml"), "w"),
                     true)
     
     run_writer_test(ConfigToolkit::YAMLWriter,
+                    :sort_lines,
                     REFERENCE_CONTAINED_SAMPLE_CONFIG,
-                    get_test_config_file_name("contained_sample.yaml"),
-                    get_test_config_file_name("contained_sample.dumped.yaml"),
-                    get_test_config_file_name("contained_sample.dumped.yaml"),
+                    File.expand_path_relative_to_caller("contained_sample.yaml"),
+                    File.expand_path_relative_to_caller("contained_sample.dumped.yaml"),
+                    File.expand_path_relative_to_caller("contained_sample.dumped.yaml"),
                     true)
   end
   
-  def test_readers_writers
+  def test_reader_writer
     run_reader_writer_test(ConfigToolkit::YAMLReader,
                            ConfigToolkit::YAMLWriter,
                            REFERENCE_SAMPLE_CONFIG,
-                           [get_test_config_file_name("sample.standard_yaml_classes.dumped.yaml")],
-                           [get_test_config_file_name("sample.standard_yaml_classes.dumped.yaml"), false])
+                           [File.expand_path_relative_to_caller("sample.standard_yaml_classes.dumped.yaml")],
+                           [File.expand_path_relative_to_caller("sample.standard_yaml_classes.dumped.yaml"), false])
     run_reader_writer_test(ConfigToolkit::YAMLReader,
                            ConfigToolkit::YAMLWriter,
                            REFERENCE_CONTAINED_SAMPLE_CONFIG,
-                           [get_test_config_file_name("contained_sample.yaml")],
-                           [get_test_config_file_name("contained_sample.dumped.yaml"), true])
+                           [File.expand_path_relative_to_caller("contained_sample.yaml")],
+                           [File.expand_path_relative_to_caller("contained_sample.dumped.yaml"), true])
   end
 end