configtoolkit 1.0.0

data/lib/configtoolkit/toolkit.rb

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+module ConfigToolkit
+
+#
+# All exceptions thrown from the Toolkit descend from
+# this one; at some point, an exception class hierarchy
+# rooted in this class might be developed.
+#
+class Error < RuntimeError; end
+
+VERSION = '1.0.0'
+
+end
+
+require 'configtoolkit/types'
+require 'configtoolkit/baseconfig'

data/lib/configtoolkit/types.rb

@@ -0,0 +1,57 @@
+#!/usr/bin/env ruby
+module ConfigToolkit
+
+#
+# Since Ruby does not have a boolean type (TrueClass and FalseClass classes
+# exist, but they descend from object), define an empty marker class that
+# can be passed into the BaseConfig methods to add new parameters in order
+# to indicate that the parameter is a boolean (the value of the parameter will
+# be FalseClass or TrueClass, however).
+#
+class Boolean; end
+
+#
+# The ConstrainedArray models an Array with a specified size
+# and with all elements being a specified type (basically, it models
+# the arrays generally offerred by static typing languages).
+# A ConstrainedArray has:
+# 1.) A minimum number of elements
+# 2.) A maximum number of elements
+# 3.) An element type
+#
+# A future enhancement might be to allow users to specify a different
+# type for each element.  Note that the Constrained Array also allows
+# elements to be instances of a child class of its element type, not
+# just instances of its element type.  Thus, a ConstrainedArray containing
+# type Object essentially would have no type constraints.
+#
+# class ConstrainedArray actually is a class generator, similar to Struct.
+# Its new() method does *not* return a ConstrainedArray instance, but
+# instead returns a new class with the specified constraints that
+# descends from ConstrainedArray.  The class returned by new() is meant
+# to be used in the BaseConfig methods to add new parameters.  The
+# value of one of these parameters actually will be a native Ruby
+# Array, just one that satisifes the constraints contained in
+# the ConstrainedArray class.
+#
+class ConstrainedArray
+  #
+  # Define an accessor for some class instance variables used to
+  # store the constraints.
+  #
+  class << self
+    attr_reader :element_class
+    attr_reader :min_num_elements
+    attr_reader :max_num_elements
+  end
+
+  def self.new(element_class, min_num_elements = nil, max_num_elements = nil)
+    return Class.new(ConstrainedArray) do
+      @element_class = element_class
+      @min_num_elements = min_num_elements
+      @max_num_elements = max_num_elements
+    end
+  end
+end
+
+end

data/lib/configtoolkit/yamlreader.rb

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+require 'yaml'
+
+module ConfigToolkit
+
+class YAMLReader
+  def initialize(stream)
+    if(stream.class == String)
+      @stream = File.open(stream, "r")
+    else
+      @stream = stream
+    end
+  end
+
+  def read
+    return YAML::load(@stream)
+  end
+end
+
+end

data/lib/configtoolkit/yamlwriter.rb

@@ -0,0 +1,61 @@
+#!/usr/bin/env ruby
+require 'yaml'
+
+module ConfigToolkit
+
+class YAMLWriter
+  def initialize(stream, only_output_standard_yaml_types)
+    if(stream.class == String)
+      @stream = File.open(stream, "w")
+    else
+      @stream = stream
+    end
+
+    @only_output_standard_yaml_types = only_output_standard_yaml_types
+  end
+  
+  def convert_value_to_standard_yaml_type(param_value)
+    if(param_value.class == Hash)
+      return convert_hash_values_to_standard_yaml_types(param_value)
+    elsif(param_value.class == Array)
+      new_param_value = []
+
+      param_value.each do |element|
+        new_param_value.push(convert_value_to_standard_yaml_type(element))
+      end
+
+      return new_param_value
+    elsif((param_value.class <= Integer) ||
+          (param_value.class <= Float) ||
+          (param_value.class == TrueClass) ||
+          (param_value.class == FalseClass) ||
+          (param_value.class == String))
+      return param_value
+    else
+      return param_value.to_s
+    end
+  end
+
+  def convert_hash_values_to_standard_yaml_types(config_hash)
+    standard_yaml_typed_config_hash = {}
+    
+    config_hash.each do |param_name, param_value|
+      standard_yaml_typed_config_hash[param_name] = convert_value_to_standard_yaml_type(param_value)
+    end
+
+    return standard_yaml_typed_config_hash
+  end
+
+  def write(config_hash)
+    if(@only_output_standard_yaml_types)
+      output_config_hash = convert_hash_values_to_standard_yaml_types(config_hash)
+    else
+      output_config_hash = config_hash
+    end
+
+    YAML::dump(output_config_hash, @stream)
+    @stream.flush()
+  end
+end
+
+end

data/test/bad_config.yaml

@@ -0,0 +1,3 @@
+- 1
+- 2
+- 3

data/test/common.rb

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+def get_test_config_file_name(config_file_base_name)
+  return (Pathname.new(__FILE__).dirname() + config_file_base_name).to_s()
+end

data/test/contained_sample.yaml

@@ -0,0 +1,22 @@
+--- 
+contained_sample: 
+  opt_integer: 42
+  req_uri: http://www.designingpatterns.com
+  req_float: 5.678
+  req_pathname: /usr/designingpatterns
+  req_integer: 5
+  req_string: sample string
+  req_boolean: false
+  req_symbol: sample_symbol
+  req_big_integer: 10000000000
+  nested_config: 
+    req_nested_array: 
+    - req_second_nested_pathname: /usr/designingpatterns/Applications
+      req_second_nested_array: 
+      - 5
+      - 19
+    - req_second_nested_pathname: /usr/designingpatterns/Applications/etc
+      req_second_nested_array: 
+      - 200
+      - 201
+    req_nested_integer: 33

data/test/firewall.yaml

@@ -0,0 +1,11 @@
+--- 
+firewall: 
+  name: durian
+  architecture: ultrasparc
+  os: Solaris
+  num_cpus: 8
+  contains_sensitive_data: false
+  behind_firewall: false
+  addresses:
+    - http://firewall.designingpatterns.com
+    - http://durian.designingpatterns.com

data/test/machines.yaml

@@ -0,0 +1,100 @@
+name: apple
+architecture: powerpc
+os: AIX
+num_cpus: 32
+behind_firewall: no
+contains_sensitive_data: no
+addresses:
+  - http://default.designingpatterns.com
+  - http://apple.designingpatterns.com
+
+production:
+  name: orange
+  architecture: ultrasparc
+  os: Solaris
+  num_cpus: 64
+  contains_sensitive_data: yes
+  addresses:
+    - http://production.designingpatterns.com
+    - http://orange.designingpatterns.com
+
+test:
+  name: bananna
+  architecture: itanium
+  os: Linux
+  num_cpus: 16
+  contains_sensitive_data: no
+  addresses:
+    - http://test.designingpatterns.com
+    - http://bananna.designingpatterns.com
+
+bad_containing_object: 3
+
+missing_num_cpus:
+  name: bananna
+  architecture: itanium
+  os: Linux
+  contains_sensitive_data: no
+  addresses:
+    - http://test.designingpatterns.com
+    - http://bananna.designingpatterns.com
+
+missing_name_and_num_cpus:
+  architecture: itanium
+  os: Linux
+  contains_sensitive_data: no
+  addresses:
+    - http://test.designingpatterns.com
+    - http://bananna.designingpatterns.com
+
+bad_num_cpus:
+  name: bananna
+  architecture: itanium
+  os: Linux
+  num_cpus: -2
+  contains_sensitive_data: no
+  addresses:
+    - http://test.designingpatterns.com
+    - http://bananna.designingpatterns.com
+
+bad_addresses_element_type:
+  name: bananna
+  architecture: itanium
+  os: Linux
+  num_cpus: -2
+  contains_sensitive_data: no
+  addresses:
+    - 2
+    - http://bananna.designingpatterns.com
+
+bad_addresses_max_num_elements:
+  name: bananna
+  architecture: itanium
+  os: Linux
+  num_cpus: -2
+  contains_sensitive_data: no
+  addresses:
+    - http://test.designingpatterns.com
+    - http://bananna.designingpatterns.com
+    - http://fruitsalad.designingpatterns.com
+    - http://parfait.designingpatterns.com
+
+bad_addresses_min_num_elements:
+  name: bananna
+  architecture: itanium
+  os: Linux
+  num_cpus: -2
+  contains_sensitive_data: no
+  addresses:
+    - http://bananna.designingpatterns.com
+
+bad_contains_sensitive_data_behind_firewall_combo:
+  name: bananna
+  architecture: itanium
+  os: Linux
+  num_cpus: 4
+  contains_sensitive_data: yes
+  behind_firewall: no
+  addresses:
+    - http://test.designingpatterns.com
+    - http://bananna.designingpatterns.com

data/test/readerwritertest.rb

@@ -0,0 +1,122 @@
+#!/usr/bin/env ruby
+
+require 'configtoolkit'
+
+require 'pathname'
+require 'singleton'
+require 'uri'
+
+class SampleSecondNestedConfig < ConfigToolkit::BaseConfig
+  add_required_param(:req_second_nested_pathname, Pathname)
+  add_required_param(:req_second_nested_array,
+                     ConfigToolkit::ConstrainedArray.new(Integer, 2, 2))
+end
+
+class SampleNestedConfig < ConfigToolkit::BaseConfig
+  add_required_param(:req_nested_integer, Integer)
+  add_required_param(:req_nested_array,
+                     ConfigToolkit::ConstrainedArray.new(SampleSecondNestedConfig))
+end
+
+class SampleConfig < ConfigToolkit::BaseConfig
+  add_required_param(:req_integer, Integer)
+  add_required_param(:req_big_integer, Integer)
+  add_required_param(:req_float, Float)
+  add_required_param(:req_string, String)
+  add_required_param(:req_boolean, ConfigToolkit::Boolean)
+  add_required_param(:req_pathname, Pathname)
+  add_required_param(:req_uri, URI)
+  add_required_param(:req_symbol, Symbol)
+  add_required_param(:nested_config, SampleNestedConfig)
+  add_optional_param(:opt_integer, Fixnum, 123454321)
+end
+
+REFERENCE_SAMPLE_CONFIG = SampleConfig.new()
+REFERENCE_SAMPLE_CONFIG.req_integer = 6
+REFERENCE_SAMPLE_CONFIG.req_big_integer = 90000000000
+REFERENCE_SAMPLE_CONFIG.req_float = 3.14
+REFERENCE_SAMPLE_CONFIG.req_string = "sample string2"
+REFERENCE_SAMPLE_CONFIG.req_boolean = true
+REFERENCE_SAMPLE_CONFIG.req_pathname = Pathname.new("/usr/designingpatterns/bin")
+REFERENCE_SAMPLE_CONFIG.req_uri = URI("http://blogs.designingpatterns.com")
+REFERENCE_SAMPLE_CONFIG.req_symbol = :sample_symbol2
+REFERENCE_SAMPLE_CONFIG.nested_config = SampleNestedConfig.new()
+REFERENCE_SAMPLE_CONFIG.nested_config.req_nested_integer = 34
+REFERENCE_SAMPLE_CONFIG.nested_config.req_nested_array = 
+  [
+   SampleSecondNestedConfig.new(),
+   SampleSecondNestedConfig.new()
+  ]
+REFERENCE_SAMPLE_CONFIG.nested_config.req_nested_array[0].req_second_nested_pathname = Pathname.new("/usr/designingpatterns/Applications/pattmake")
+REFERENCE_SAMPLE_CONFIG.nested_config.req_nested_array[0].req_second_nested_array = [6, 20]
+REFERENCE_SAMPLE_CONFIG.nested_config.req_nested_array[1].req_second_nested_pathname = Pathname.new("/usr")
+REFERENCE_SAMPLE_CONFIG.nested_config.req_nested_array[1].req_second_nested_array = [205, 206]
+REFERENCE_SAMPLE_CONFIG.opt_integer = 56
+
+REFERENCE_CONTAINED_SAMPLE_CONFIG = SampleConfig.new()
+REFERENCE_CONTAINED_SAMPLE_CONFIG.req_integer = 5
+REFERENCE_CONTAINED_SAMPLE_CONFIG.req_big_integer = 10000000000
+REFERENCE_CONTAINED_SAMPLE_CONFIG.req_float = 5.678
+REFERENCE_CONTAINED_SAMPLE_CONFIG.req_string = "sample string"
+REFERENCE_CONTAINED_SAMPLE_CONFIG.req_boolean = false
+REFERENCE_CONTAINED_SAMPLE_CONFIG.req_pathname = Pathname.new("/usr/designingpatterns")
+REFERENCE_CONTAINED_SAMPLE_CONFIG.req_uri = URI("http://www.designingpatterns.com")
+REFERENCE_CONTAINED_SAMPLE_CONFIG.req_symbol = :sample_symbol
+REFERENCE_CONTAINED_SAMPLE_CONFIG.nested_config = SampleNestedConfig.new()
+REFERENCE_CONTAINED_SAMPLE_CONFIG.nested_config.req_nested_integer = 33
+REFERENCE_CONTAINED_SAMPLE_CONFIG.nested_config.req_nested_array = 
+  [
+   SampleSecondNestedConfig.new(),
+   SampleSecondNestedConfig.new()
+  ]
+REFERENCE_CONTAINED_SAMPLE_CONFIG.nested_config.req_nested_array[0].req_second_nested_pathname = Pathname.new("/usr/designingpatterns/Applications")
+REFERENCE_CONTAINED_SAMPLE_CONFIG.nested_config.req_nested_array[0].req_second_nested_array = [5, 19]
+REFERENCE_CONTAINED_SAMPLE_CONFIG.nested_config.req_nested_array[1].req_second_nested_pathname = Pathname.new("/usr/designingpatterns/Applications/etc")
+REFERENCE_CONTAINED_SAMPLE_CONFIG.nested_config.req_nested_array[1].req_second_nested_array = [200, 201]
+REFERENCE_CONTAINED_SAMPLE_CONFIG.opt_integer = 42
+REFERENCE_CONTAINED_SAMPLE_CONFIG.instance_variable_set(:@containing_object_name, "contained_sample")
+
+module ReaderWriterTest
+  def run_reader_test(reader_class,
+                      containing_object_name,
+                      reference_config,
+                      *reader_constructor_args)
+    reader = reader_class.new(*reader_constructor_args)
+    config = SampleConfig.load(reader, containing_object_name)
+    assert_equal(reference_config, config)
+  end
+
+  def get_sorted_file_contents(file_name)
+    file_contents = File.open(file_name, "r") do |file|
+      file.read()
+    end
+
+    return file_contents.split("\n").sort().join("\n").to_s()
+  end
+
+  def run_writer_test(writer_class,
+                      reference_config,
+                      reference_file_name,
+                      dump_file_name,
+                      *writer_constructor_args)
+    writer = writer_class.new(*writer_constructor_args)
+    reference_config.dump(writer)
+    
+    assert_equal(get_sorted_file_contents(reference_file_name),
+                 get_sorted_file_contents(dump_file_name))
+  end
+
+  def run_reader_writer_test(reader_class,
+                             writer_class,
+                             reference_config,
+                             reader_constructor_args,
+                             writer_constructor_args)
+    writer = writer_class.new(*writer_constructor_args)
+    reference_config.dump(writer)
+    
+    reader = reader_class.new(*reader_constructor_args)
+    config = SampleConfig.load(reader, reference_config.containing_object_name)
+    
+    assert_equal(reference_config, config)
+  end
+end

data/test/sample.ruby_yaml_types.yaml

@@ -0,0 +1,34 @@
+--- 
+opt_integer: 56
+req_uri: !ruby/object:URI::HTTP 
+  fragment: 
+  host: blogs.designingpatterns.com
+  opaque: 
+  password: 
+  path: ""
+  port: 80
+  query: 
+  registry: 
+  scheme: http
+  user: 
+req_float: 3.14
+req_pathname: !ruby/object:Pathname 
+  path: /usr/designingpatterns/bin
+req_symbol: :sample_symbol2
+req_boolean: true
+req_string: sample string2
+req_integer: 6
+req_big_integer: 90000000000
+nested_config: 
+  req_nested_array: 
+  - req_second_nested_pathname: !ruby/object:Pathname 
+      path: /usr/designingpatterns/Applications/pattmake
+    req_second_nested_array: 
+    - 6
+    - 20
+  - req_second_nested_pathname: !ruby/object:Pathname 
+      path: /usr
+    req_second_nested_array: 
+    - 205
+    - 206
+  req_nested_integer: 34