yamlconfig 0.1.0

data/lib/LICENSE

@@ -0,0 +1,10 @@
+Copyright (c) 2006, Christopher Maujean and project contributors
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+    * Neither the name of the NGSLib nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/lib/yamlconfig.rb

@@ -0,0 +1,116 @@
+# $Id: yamlconfig.rb 44 2006-08-13 23:18:33Z cmaujean $
+# See LICENSE for copyright information
+require 'yaml'
+
+# This class represents a configuration, using a YAML file
+# by providing "accessor" methods for each item in the YAML file
+class YAMLConfig
+	attr_accessor :resource
+	include Enumerable
+
+	def initialize(resource)
+		@specialmethods = Array.new
+		@resource = resource
+
+		# initial method load
+		reload()
+	end
+
+	#
+	# This method is provided for keys and other structures where
+	# getting at the method call is impossible.
+	#
+	# This will return 'nil' for all values if the YAML you have loaded
+	# is improperly formed.
+	#
+
+	def [](key)
+		if !@con.nil?
+			return @con[key]
+		end
+
+		nil
+	end
+
+	#
+	# This is a writer in the same spirit as the [] method. Please read
+	# the documentation for that.
+	#
+	
+	def []=(key, value)
+		if !@con.nil?
+			return @con[key] = value
+		end
+
+		nil
+	end
+
+	#
+	# Rewrite and reload the yaml file. Note, that this will overwrite your current
+	# yaml file and reload your configuration. If you want to avoid
+	# doing this, provide the path to a filename for it to work with.
+	#
+
+	def write(io=@resource)
+		# Some duck-typing checks to make sure we're dealing with
+		# something that looks like an IO object.
+	
+		f = File.open(io, 'w')
+
+		f << YAML::dump(@con)
+
+		if io == @resource
+			f.reopen(io, 'r')
+			reload
+		end
+
+		true
+	end
+
+	# Remove all current (if any) attr_readers, then load the resource 
+	# named in @resource into psuedo attr_readers
+	def reload
+		# first remove all the previous methods from this instance
+		@specialmethods.each do |meth|
+			(class << self; self; end).class_eval { undef_method(meth) }  
+		end
+
+		# wipe the old list
+		@specialmethods = []
+
+		# then load the new methods
+		# add a method to the Singleton class of this instance of Config.
+		# giving a private readonly accessor named "key" that returns "value" for each 
+		# key value pair of the YAML file named in @filename
+		@con = loadresource()
+		@con.each do |key,value|
+			(class << self; self; end).class_eval { define_method(key) { value }}
+
+			#add it to the @specialmethods array
+			@specialmethods.push key
+		end
+
+
+	end
+	
+	# standard each usage, iterates over the config keys
+	# returning key,value
+	def each
+		@specialmethods.each do |key|
+			yield key, self.send(key)
+		end
+	end
+
+
+	#--
+	# End of public documentation
+	private
+
+	def loadresource()
+		# TODO, make this take plugins or some sort of adapter type scheme for 
+		# deciding how to load what into a hash
+		YAML.load_file(@resource)
+	end
+end
+
+# vi:sw=2 ts=2

data/test/data/accessor_config

@@ -0,0 +1 @@
+'#nogoodshits': [ '*.bar.com', '*.example.com' ]

data/test/data/config

@@ -0,0 +1 @@
+servername: normalfairypoof

data/test/data/flatulentmonkey

@@ -0,0 +1 @@
+servername: flatulentmonkey

data/test/data/freakboy

@@ -0,0 +1,2 @@
+servername: freakboy
+boondongle: foogalicious

data/test/tc_yamlconfig.rb

@@ -0,0 +1,90 @@
+require 'test/unit'
+require 'yamlconfig'
+require 'fileutils'
+
+class TestConfig < Test::Unit::TestCase
+  def test_yaml_write
+    old_file = 'yamlconfig/test/data/accessor_config'
+    new_file = old_file + '_tmp'
+    FileUtils.cp old_file, new_file
+
+    # write to the same filehandle
+    f = nil
+    assert_nothing_raised do
+      f = YAMLConfig.new new_file
+      f['nogoodshits'] = %W(cmaujean erikh PopeKetric)
+      f.write
+    end
+
+    # test that it reloads properly
+        
+    assert_equal f['nogoodshits'], %W(cmaujean erikh PopeKetric)
+    assert_equal f['#nogoodshits'], %W(*.bar.com *.example.com) 
+
+    FileUtils.rm new_file
+
+    # write to a new filehandle
+
+    assert_nothing_raised do
+      f.write new_file
+      f = YAMLConfig.new new_file
+    end
+
+    # test that it created the right data
+
+    assert_equal f['nogoodshits'], %W(cmaujean erikh PopeKetric)
+    assert_equal f['#nogoodshits'], %W(*.bar.com *.example.com) 
+
+    FileUtils.rm new_file
+
+  end
+
+  def test_array_accessor
+    f = nil
+    assert_nothing_raised do
+      f = YAMLConfig.new('yamlconfig/test/data/accessor_config')
+    end
+    assert_equal f['#nogoodshits'],  %W(*.bar.com *.example.com)
+    assert_nil f['monkey']
+
+    assert_nothing_raised do
+      f['monkey'] = "foo"
+    end
+
+    assert_equal f['monkey'], 'foo'
+  end
+
+  def test_accessors 
+    f = YAMLConfig.new('yamlconfig/test/data/freakboy')
+    g = YAMLConfig.new('yamlconfig/test/data/config')
+  
+    assert_equal f.servername, 'freakboy'
+    assert_equal g.servername, 'normalfairypoof'
+    assert_equal f.boondongle, 'foogalicious'
+
+  end
+  
+
+  def test_reload
+    f = YAMLConfig.new('yamlconfig/test/data/freakboy')
+    f.resource = 'yamlconfig/test/data/flatulentmonkey'
+    f.reload
+    begin
+      f.boondongle
+    rescue NoMethodError
+      assert(true, "NoMethodError was triggered for boondongle")
+    else
+      assert(false, "NoMethodError was not triggered! something is wrong, return was #{f.boondongle}")
+    end
+    assert_equal f.servername, 'flatulentmonkey'
+  end
+
+  def test_each
+    f = YAMLConfig.new('yamlconfig/test/data/freakboy')
+    f.each do |key,value|
+      assert f[key] == value, "part of the each tests, f[#{key}] == #{value}"
+    end
+  end
+end
+
+# vi:sw=2 ts=2

metadata

@@ -0,0 +1,53 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.9.0
+specification_version: 1
+name: yamlconfig
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+date: 2006-08-13 00:00:00 -07:00
+summary: YAML file based configuration object with an EASY interface
+require_paths: 
+- lib
+email: cmaujean@gmail.com
+homepage: http://rubyforge.org/projects/ngslib
+rubyforge_project: 
+description: 
+autorequire: 
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+post_install_message: 
+authors: 
+- Christopher Maujean
+files: 
+- lib/yamlconfig.rb
+- lib/LICENSE
+- test/data
+- test/tc_yamlconfig.rb
+- test/data/config
+- test/data/freakboy
+- test/data/flatulentmonkey
+- test/data/accessor_config
+test_files: 
+- test/tc_yamlconfig.rb
+rdoc_options: []
+
+extra_rdoc_files: []
+
+executables: []
+
+extensions: []
+
+requirements: []
+
+dependencies: []
+