yamlconfig 0.1.2 → 0.2.0

data/lib/yamlconfig.rb

@@ -1,5 +1,4 @@
-# $Id: yamlconfig.rb 67 2006-08-30 15:54:59Z erikh $
-# 
+#
 # See LICENSE for copyright information
 #
 
@@ -8,117 +7,126 @@ 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
-		
+  attr_accessor :resource
+  include Enumerable
+
+  def initialize(resource)
+    @specialmethods = Array.new
+    @resource = resource
+
+    reload_from_file()
+  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
+
+  #
+  # this should take a [] capable object, add it (keys and values) to
+  # self, and return self
+  #
+
+  def +(other)
+    if !@con.nil?
+      other.each do |k, v|
+        # add it to con
+        @con[k] = v
+
+        # add it as a method
+        (class << self; self; end).class_eval { define_method(k) { v }}
+
+        #add it to the @specialmethods array
+        @specialmethods.push k
+      end
+    end
+    self
+  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)
+    File.open(io, 'w+') do |f|
+      f << YAML::dump(@con)
+    end
+    
+    if io == @resource
+      reload_from_file
+    end
+  end
+
+  # Remove all current (if any) attr_readers, then load the resource
+  # named in @resource into psuedo attr_readers
+  def reload_from_file
+    
+    # first remove all the previous methods from this instance
     if @specialmethods
       @specialmethods.each do |meth|
-          (class << self; self; end).class_eval { undef_method(meth) }  
+          (class << self; self; end).class_eval { undef_method(meth) }
       end
     end
 
-		# wipe the old list
-		@specialmethods = []
+    @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()
+    # 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 in @resource
+    @con = loadresource()
     if @con
       @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
-	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
+
+  # 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
 
 require 'yamlconfig/version'
-
-# vi:sw=2 ts=2

data/lib/yamlconfig/version.rb

@@ -1 +1 @@
-YAMLConfig::VERSION = "0.1.2"
+YAMLConfig::VERSION = "0.2.0"

data/spec/data/accessor_config_tmp

@@ -0,0 +1,8 @@
+--- 
+"#nogoodshits": 
+- "*.bar.com"
+- "*.example.com"
+nogoodshits: 
+- cmaujean
+- erikh
+- PopeKetric

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'fileutils'
+
+require 'simplecov'
+SimpleCov.start

data/spec/yamlconfig_spec.rb

@@ -0,0 +1,145 @@
+require 'spec_helper'
+require 'yamlconfig'
+
+describe YAMLConfig do
+  describe "with an empty file" do
+    it "does not raise an exception" do
+      lambda {
+        YAMLConfig.new('spec/data/empty_file')
+      }.should_not raise_error
+    end
+  end
+  
+  describe "with complex values" do
+    before :each do
+      @yc = YAMLConfig.new('spec/data/complex_values')
+    end
+
+    it "creates an instance" do
+      @yc.kind_of?(YAMLConfig).should be_true
+    end
+    
+    it "parses array values" do
+      @yc.arrayval[1].should == "bar"
+    end
+    
+    it "parses hashes" do
+      @yc.hashval["foo"].should == "FOO"
+    end
+  end
+  
+  describe "#write" do
+    before :each do
+      @old_file = 'spec/data/accessor_config'
+      @new_file = @old_file + '_tmp'
+      FileUtils.cp @old_file, @new_file
+      
+      @yc = YAMLConfig.new @new_file
+      @yc['nogoodshits'] = %W(cmaujean erikh PopeKetric)
+    end
+
+    it "writes to the same filehandle and reloads" do
+      lambda { @yc.write }.should_not raise_error
+      @yc['nogoodshits'].should == %W(cmaujean erikh PopeKetric)
+      @yc['#nogoodshits'].should == %W(*.bar.com *.example.com) 
+    end
+
+    it "writes to a new filehandle and does not reload" do
+      FileUtils.rm @new_file rescue true # don't care if the file doesn't exist
+      @yc.write @new_file
+            
+      @yc['nogoodshits'].should == %W(cmaujean erikh PopeKetric)
+      @yc['#nogoodshits'].should == %W(*.bar.com *.example.com) 
+    end
+    
+    after :each do
+      #FileUtils.rm @new_file rescue true # don't care if the file doesn't exist
+    end
+  end
+  
+  describe "#[key]" do
+    before :each do
+      lambda {
+        @yc = YAMLConfig.new('spec/data/accessor_config')
+      }.should_not raise_error
+    end
+    
+    it "returns the value for the key requested" do
+      @yc['#nogoodshits'].should ==  %W(*.bar.com *.example.com)
+    end
+    
+    it "returns nil for keys that do not exist" do
+      @yc['monkey'].should be_nil
+    end
+  end
+  
+  describe "#[key]=value" do
+    before :each do
+      lambda {
+        @yc = YAMLConfig.new('spec/data/accessor_config')
+      }.should_not raise_error
+      @yc['monkey'] = "foo"
+    end
+    
+    it "sets key=value for new keys" do
+      @yc['monkey'].should == 'foo'
+    end
+    
+    it "sets key=value for existing keys" do
+      @yc['monkey'] = "bar"
+      @yc['monkey'].should == "bar"
+    end
+  end
+  
+  describe "dynamic accessors" do
+    before :each do
+      @freakboy = YAMLConfig.new('spec/data/freakboy')
+      @config = YAMLConfig.new('spec/data/config')
+    end
+    
+    it "returns the value when a key is called as an accessor" do
+      @freakboy.boondongle.should == "foogalicious"
+    end
+    
+    it "it retains different values for different instances" do
+      @freakboy.servername.should == 'freakboy'
+      @config.servername.should == 'normalfairypoof'
+    end
+  end
+  
+  describe "reload_from_file" do
+    before :each do
+      @yc = YAMLConfig.new('spec/data/freakboy')
+      @yc.resource = 'spec/data/flatulentmonkey'
+      @yc.reload_from_file
+    end
+    
+    it "should throw NoMethodError for non-existent methods" do
+      lambda {
+        @yc.boondongle
+      }.should raise_error(NoMethodError)
+    end
+    
+    it "should not throw errors for existing methods" do
+      @yc.servername.should == 'flatulentmonkey'
+    end
+  end
+
+  describe "#each" do
+    it "iterates the keys and values" do
+      f = YAMLConfig.new('spec/data/freakboy')
+      f.each do |key,value|
+        f[key].should == value
+      end
+    end
+  end
+    
+  describe "#+" do 
+    it "adds the new keys and values to itself" do
+      f = YAMLConfig.new('spec/data/freakboy')
+      y = { 'a' => '1', 'b' => '2' }
+      a = f + y
+      f.a.should == '1'
+    end
+  end
+end

metadata

@@ -1,57 +1,67 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.4
-specification_version: 1
 name: yamlconfig
 version: !ruby/object:Gem::Version 
-  version: 0.1.2
-date: 2007-09-16 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: ngslib
-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: 
+  prerelease: 
+  version: 0.2.0
 platform: ruby
-signing_key: 
-cert_chain: 
-post_install_message: 
 authors: 
 - Christopher Maujean
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-04-05 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: 
+email: cmaujean@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- lib/LICENSE
 files: 
 - lib/LICENSE
-- lib/yamlconfig
 - lib/yamlconfig/version.rb
 - lib/yamlconfig.rb
-- test/data
-- test/data/accessor_config
-- test/data/complex_values
-- test/data/config
-- test/data/empty_file
-- test/data/flatulentmonkey
-- test/data/freakboy
-- test/tc_yamlconfig.rb
-test_files: 
-- test/tc_yamlconfig.rb
-rdoc_options: []
-
-extra_rdoc_files: 
-- lib/LICENSE
-executables: []
+- spec/data/accessor_config
+- spec/data/accessor_config_tmp
+- spec/data/complex_values
+- spec/data/config
+- spec/data/empty_file
+- spec/data/flatulentmonkey
+- spec/data/freakboy
+- spec/spec_helper.rb
+- spec/yamlconfig_spec.rb
+has_rdoc: true
+homepage: http://rubyforge.org/projects/ngslib
+licenses: []
 
-extensions: []
+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: []
 
-dependencies: []
-
+rubyforge_project: ngslib
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: YAML file based configuration object with an EASY interface
+test_files: 
+- spec/yamlconfig_spec.rb

data/test/tc_yamlconfig.rb

@@ -1,102 +0,0 @@
-require 'test/unit'
-require 'yamlconfig'
-require 'fileutils'
-
-class TestConfig < Test::Unit::TestCase
-  def test_yaml_empty
-    assert_nothing_raised do
-      YAMLConfig.new('yamlconfig/test/data/empty_file')
-    end
-  end
-
-  def test_yaml_complex
-    f = YAMLConfig.new('yamlconfig/test/data/complex_values')
-    assert_equal(f.arrayval[1], "bar", "array values work")
-    assert_equal(f.hashval["foo"], "FOO", "hash values work")
-  end
-
-  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