win32-eventlog 0.5.0 → 0.5.1

data/CHANGES

@@ -1,4 +1,15 @@
-= 0.5.0 - 12-Sep-2008
+== 0.5.1 - 8-Aug-2009
+* License changed to Artistic 2.0.
+* Some gemspec updates; test-unit and ptools are now development dependencies
+  instead of runtime dependencies and the description has been updated.
+* Some RDoc updates, including documentation of the event type constants.
+* Several RDoc updates for the Win32::MC class.
+* Minor refactoring of the test suite.
+* Added rake tasks for running the mc or eventlog libraries separately, as
+  well as tasks for running the examples.
+* Example programs renamed to avoid any confusion with actual test files.
+
+== 0.5.0 - 12-Sep-2008
 * Fixed an issue for Windows Vista and later where some event descriptions
   were missing. This fix requires windows-pr 0.9.3 or later.
 * The EventLog#full? method now raises an EventLog::Error if it should fail
@@ -9,7 +20,7 @@
 * Renamed the test files to start with 'test_'.
 * Removed the ts_all.rb file.
 
-= 0.4.9 - 7-Sep-2008
+== 0.4.9 - 7-Sep-2008
 * The private get_description method, which is used internally to read the
   event log, has been updated to work with 64 bit Windows. The changes needed
   for this require a more recent windows-pr library, i.e. 0.9.2 or later.
@@ -18,14 +29,14 @@
   properties for both the EventLog#tail and EventLog#notify_change methods.
 * Some internal refactoring to use begin/ensure where appropriate.
 
-= 0.4.8 - 17-May-2008
+== 0.4.8 - 17-May-2008
 * Fixed in a bug in the EventLog#read method where a log entry requiring
   over 64k would fail and spiral into an infinite loop. Thanks go to
   Stuart Clarke for the spot.
 * Improved handling of failed log reading in the read_last_event private
   method.
 
-= 0.4.7 - 8-Dec-2007
+== 0.4.7 - 8-Dec-2007
 * Fixed a bug where you couldn't write to custom (parent) event sources.
   Thanks go to Tim Uckun for the spot.
 * Now handles ParameterMessageFiles, both in the EventLog.add_event_source
@@ -36,20 +47,20 @@
 * The EventLog.add_event_source now returns the creation disposition
   instead of self.
 
-= 0.4.6 - 27-Aug-2007
+== 0.4.6 - 27-Aug-2007
 * Reading event logs is now approximately 5-7 times faster!
 * Fixed a potential bug where, in rare cases, event descriptions could be
   overwritten by other event descriptions.
 * Fixed a bug where, in unusual cases, there was leading garbage in the
   event descriptions.
 
-= 0.4.5 - 25-Aug-2007
+== 0.4.5 - 25-Aug-2007
 * Fixed two potential issues where reading from remote event log sources
   could fail either due to permissions (reading DLL's) or because local
   registry entries didn't necessarily match the remote registry entries.
   Thanks go to Andrew Garberoglio and Ivan Shiel for the spot.
 
-= 0.4.4 - 31-Jul-2007
+== 0.4.4 - 31-Jul-2007
 * The EventLogError class is now EventLog::Error.
 * The MCError class is now MC::Error.
 * Added a Rakefile with tasks for installation and testing.
@@ -58,14 +69,14 @@
 * Added some more source comments.
 * Updates to the README and MANIFEST file.
 
-= 0.4.3 - 18-Dec-2006
+== 0.4.3 - 18-Dec-2006
 * Removed the FORMAT_MESSAGE_FROM_SYSTEM flag to the FormatMessage function
   in the get_description private method because it could sometimes return
   bogus information.  Thanks go to Greg Holmes for the spot.
 * Added the string_inserts member to the EventLogStruct.  This contains an
   array of only the raw string inserts, rather than the entire text message.
 
-= 0.4.2 - 6-Aug-2006
+== 0.4.2 - 6-Aug-2006
 * Fixed a bug in the EventLog.read method related to the
   EVENTLOG_BACKWARDS_READ flag.
 * Fixed a bug in the EventLog.read method where the event_type was not being
@@ -73,11 +84,11 @@
 * Fixed bugs in the EventLog#tail method where it would fail if the log was
   full and dups would appear.
 
-= 0.4.1 - 28-May-2006
+== 0.4.1 - 28-May-2006
 * Fixed a bug in the EventLog#notify_change method where the handle would
   die after five or six reads.  Thanks go to botp for the spot.
 
-= 0.4.0 - 24-May-2006
+== 0.4.0 - 24-May-2006
 * Now pure Ruby.
 * Now includes a gemspec.
 * Fixed a major bug the EventLog#tail method where it was reading the log in
@@ -100,7 +111,7 @@
 * Made the .txt files rdoc friendly, and removed the .rd files.
 * Minor adjustments to the test suite.
 
-== 0.3.1 - 16-Feb-2005
+=== 0.3.1 - 16-Feb-2005
 * Minor modifications to the source to eliminate some warnings that appeared
   in Ruby 1.8.2 or later, plus other minor tweaks.
 * Renamed the sample programs and moved the 'examples' directory to the

data/MANIFEST

@@ -4,9 +4,9 @@
 * Rakefile
 * win32-eventlog.gemspec
 * doc/tutorial.txt
-* examples/test_read.rb
-* examples/test_write.rb
-* examples/test_notify.rb
+* examples/example_read.rb
+* examples/example_write.rb
+* examples/example_notify.rb
 * lib/win32/eventlog.rb
 * lib/win32/mc.rb
 * misc/install_msg.rb

data/README

@@ -1,4 +1,4 @@
-= Description
+== Description
    The win32-eventlog library provides an interface for reading from and
    writing to the MS Windows Event Log.
 
@@ -6,7 +6,7 @@
    win32-mc library (provided with this distro), assuming you have the
    proper tools installed.
 
-= Prerequisites
+== Prerequisites
    Ruby 1.8.2 or later.
    windows-pr 0.9.3 or later.
    
@@ -14,15 +14,19 @@
    install message sources. You won't need these for simply reading from or
    writing to an existing event log.
 
-= Installation
+== Installation
+=== Gem Installation
+   gem install win32-eventlog
+=== Local Installation
    rake test (optional)
    rake install (non-gem) or rake install_gem (gem)
 
+=== General Installation Notes
    This will install both the win32-eventlog and win32-mc libraries. The latter
    is strictly for turning .mc files into .dll files. See the mc documentation
    for more details.
 
-= Installing the 'RubyMsg' event source
+== Installing the 'RubyMsg' event source
    If you wish to install the RubyMsg event source, run the 'install_msg.rb'
    script in the 'misc' directory.  This will create a 'rubymsg' directory
    under your toplevel Ruby installation directory (usually C:\ruby), and
@@ -37,32 +41,33 @@
    you do not understand this, please read the 'tutorial.txt' file in the 'doc'
    directory.
 
-= Additional documentation
+== Additional documentation
    If you are unfamiliar with message files and event logging on Windows in
    general, please read the 'tutorial.txt' file.
 
    There are also a couple of sample test scripts under the 'examples'
    directory if you want to futz around and get a feel for how things work.
 
-= If the tc_mc.rb tests fail
-   There's a chance that you either don't have the mc, rc and/or link commands
-   installed or they're not in your %PATH%. If you have MSVC++, you should have
-   them somewhere on your system.
+== If the test_mc.rb tests are skipped
+   If the tests from the test_mc.rb file are omitted then you either don't
+   have the mc, rc and/or link commands installed or they're not in your
+   system's %PATH%. If you have MSVC++, you should have them somewhere on your
+   system.
 
-= Known Issues
+== Known Issues
    None known.
 
    Please file any bug reports on the project page at
    http://www.rubyforge.org/projects/win32utils.
 
-= License
-   Ruby's
+== License
+   Artistic 2.0
 
-= Warranty
+== Warranty
    This package is provided "as is" and without any express or
    implied warranties, including, without limitation, the implied
    warranties of merchantability and fitness for a particular purpose.
 
-= Authors
+== Authors
    Daniel J. Berger
    Park Heesob

data/Rakefile

@@ -1,7 +1,7 @@
 require 'rake'
 require 'rake/testtask'
 
-desc "Install the win32-eventlog and win32-mc libraries (non-gem)"
+desc 'Install win32-eventlog and win32-mc (non-gem)'
 task :install do
    dest = File.join(Config::CONFIG['sitelibdir'], 'win32')
    Dir.mkdir(dest) unless File.exists? dest
@@ -9,14 +9,38 @@ task :install do
    cp 'lib/win32/mc.rb', dest, :verbose => true
 end
 
-desc "Install the win32-eventlog package as a gem"
+desc 'Install the win32-eventlog library as a gem'
 task :install_gem do
    ruby 'win32-eventlog.gemspec'
    file = Dir["*.gem"].first
    sh "gem install #{file}"
 end
 
-Rake::TestTask.new do |t|
+desc 'Run the notify (tail) example program'
+task :example_notify do
+   ruby '-Ilib examples/example_notify.rb'
+
+desc 'Run the read example program'
+task :example_read do
+   ruby '-Ilib examples/example_read.rb'
+
+desc 'Run the write example program'
+task :example_write do
+   ruby '-Ilib examples/example_write.rb'
+
+Rake::TestTask.new(:test) do |t|
    t.warning = true
    t.verbose = true
 end
+
+Rake::TestTask.new(:test_eventlog) do |t|
+   t.warning    = true
+   t.verbose    = true
+   t.test_files = Dir['test/test_eventlog.rb']
+end
+
+Rake::TestTask.new(:test_mc) do |t|
+   t.warning    = true
+   t.verbose    = true
+   t.test_files = Dir['test/test_mc.rb']
+end

data/doc/tutorial.txt

@@ -1,4 +1,4 @@
-= Information about Message Files
+== Information about Message Files
 Each event source should register message files that contain description
 strings for each event identifier, event category, and parameter. Register
 these files in the EventMessageFile, CategoryMessageFile, and
@@ -11,7 +11,7 @@ files. Several applications can share the same message file.
 You should typically create message files as resource-only DLLs. They are
 smaller and faster than ordinary DLLs.
 
-= What does a .mc file look like?
+== What does a .mc file look like?
 
 A .mc file is just a plain text file that is parsed by the "mc" utility to
 generate a header and, ultimately, a .dll file.  Here is a quick sample.
@@ -38,7 +38,7 @@ Language=English
 Error: %1
 .
 
-= How to generate a .dll file from a .mc file
+== How to generate a .dll file from a .mc file
 To turn this file into a .dll you have two options.  The first is to use the
 command line utilities.  Follow these steps:
 
@@ -75,7 +75,7 @@ is the text that shows up in the event description.
 The "data" field is what replaces "%1" as an actual text string in the event
 log, sort of like a printf format specifier, except that it's always a string.
 
-= Registering an event source
+== Registering an event source
 First, create the .dll file from the .mc file. Then register that .dll file
 for an event source we'll call "foo". You can name the .dll file anything
 you like, but for sanity's sake I recommend keeping the same as the event
@@ -99,7 +99,7 @@ been inserted into the registry. You can find it under:
 
 HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\EventLog\Application.
 
-= Writing to the event source
+== Writing to the event source
 Now that our event source 'foo' is registered, we can begin writing event
 log data for it.  Here's an example of how you use it:
 

data/examples/example_notify.rb

@@ -0,0 +1,24 @@
+############################################################################
+# example_notify.rb (win32-eventlog)
+#
+# A sample script for demonstrating the tail method.  Start this in its own
+# terminal.  Then, in another terminal, write an entry to the event log
+# (or force an entry via some other means) and watch the output.
+#
+# You can run this code via the 'example_notify' rake task.
+############################################################################
+Thread.new { loop { sleep 0.01 } } # Allow Ctrl-C
+
+require 'win32/eventlog'
+include Win32
+
+log = EventLog.open
+
+# replace 'tail' with 'notify_change' to see the difference
+log.tail{ |struct|
+   puts "Got something"
+   p struct
+   puts
+}
+
+log.close

data/examples/example_read.rb

@@ -0,0 +1,84 @@
+############################################################################
+# example_read.rb (win32-eventlog)
+#
+# Test script for general futzing.  This will attempt to read and backup
+# your Event Log. You can run this example via the 'rake example_read'
+# task.
+#
+# Modify as you see fit.
+############################################################################
+require 'win32/eventlog'
+include Win32
+
+puts "VERSION: " + EventLog::VERSION
+sleep 1
+
+# A few different ways to read an event log
+
+el = EventLog.new("Application")
+el.read{ |log|
+   p log
+}
+el.close
+
+EventLog.read("Application"){ |log|
+   p log
+   puts
+}
+
+EventLog.open("Application") do |log|
+   log.read{ |struct|
+      p struct
+      puts
+   }
+end
+
+backup_file = "C:\\event_backup1"
+File.delete(backup_file) if File.exists?(backup_file)
+
+e1 = EventLog.open("System")
+puts "System log opened"
+
+e2 = EventLog.open("Application")
+puts "Application log opened"
+
+e3 = EventLog.open("Security")
+puts "Security log opened"
+
+puts "=" * 40
+
+puts "Total system records: " + e1.total_records.to_s
+puts "Total application records: " + e2.total_records.to_s
+puts "Total security records: " + e3.total_records.to_s
+
+puts "=" * 40
+
+puts "Oldest system record number: " + e1.oldest_record_number.to_s
+puts "Oldest application record number: " + e2.oldest_record_number.to_s
+puts "Oldest security record number: " + e3.oldest_record_number.to_s
+
+puts "=" * 40
+
+e2.backup(backup_file)
+puts "Application log backed up to #{backup_file}"
+
+puts "=" * 40
+
+e1.close
+puts "System log closed"
+
+e2.close
+puts "Application log closed"
+
+e3.close
+puts "Security log closed"
+
+e4 = EventLog.open_backup(backup_file)
+e4.read{ |elr|
+   p elr
+   puts
+}
+puts "Finished reading backup file"
+e4.close
+
+File.delete(backup_file)

data/examples/example_write.rb

@@ -0,0 +1,65 @@
+##############################################################################
+# example_write.rb
+#
+# Tests both the creation of an Event Log source and writing to the Event
+# Log. You can run this via the 'rake example_write' task.
+#
+# Modify as you see fit.
+##############################################################################
+
+# Prompt user to continue, or not...
+msg = <<TEXT
+
+	This script will create an event source 'foo' in your registry and
+	write an event to the 'Application' source.
+	Is that ok [y/N]?
+TEXT
+print msg
+
+ans = STDIN.gets.chomp
+unless ans == "y" || ans == "Y"
+	puts "Ok, exiting..."
+   	exit!
+end
+
+require "win32/eventlog"
+require "win32/mc"
+include Win32
+
+puts "EventLog VERSION: " + EventLog::VERSION
+puts "MC VERSION: " + MC::VERSION
+sleep 1
+
+m = MC.new("foo.mc")
+m.create_all
+puts ".dll created"
+sleep 1
+
+dll_file = File.expand_path(m.dll_file)
+
+EventLog.add_event_source(
+   'source'                => "Application",
+   'key_name'              => "foo",
+   'category_count'        => 2,
+   'event_message_file'    => dll_file,
+   'category_message_file' => dll_file
+)
+
+puts "Event source added to registry"
+sleep 1
+
+e1 = EventLog.open("Application")
+
+e1.report_event(
+   :source      => "foo",
+   :event_type  => EventLog::WARN,
+   :category    => "0x00000002L".hex,
+   :event_id    => "0xC0000003L".hex,
+   :data        => "Danger Will Robinson!"
+)
+
+puts "Event written to event log"
+
+e1.close
+
+puts "Finished.  Exiting..."

data/lib/win32/eventlog.rb

@@ -38,27 +38,61 @@ module Win32
       extend Windows::Registry
       
       # The version of the win32-eventlog library
-      VERSION = '0.5.0'
+      VERSION = '0.5.1'
       
-      # Aliased read flags
-      FORWARDS_READ   = EVENTLOG_FORWARDS_READ
+      # The log is read in chronological order, i.e. oldest to newest.
+      FORWARDS_READ = EVENTLOG_FORWARDS_READ
+
+      # The log is read in reverse chronological order, i.e. newest to oldest.
       BACKWARDS_READ  = EVENTLOG_BACKWARDS_READ
-      SEEK_READ       = EVENTLOG_SEEK_READ
+
+      # Begin reading from a specific record.
+      SEEK_READ = EVENTLOG_SEEK_READ
+
+      # Read the records sequentially. If this is the first read operation, the
+      # EVENTLOG_FORWARDS_READ or EVENTLOG_BACKWARDS_READ flags determines
+      # which record is read first.
       SEQUENTIAL_READ = EVENTLOG_SEQUENTIAL_READ
+
+      # Event types
       
-      # Aliased event types
-      SUCCESS         = EVENTLOG_SUCCESS
-      ERROR           = EVENTLOG_ERROR_TYPE
-      WARN            = EVENTLOG_WARNING_TYPE
-      INFO            = EVENTLOG_INFORMATION_TYPE
-      AUDIT_SUCCESS   = EVENTLOG_AUDIT_SUCCESS
-      AUDIT_FAILURE   = EVENTLOG_AUDIT_FAILURE
+      # Information event, an event that describes the successful operation
+      # of an application, driver or service.
+      SUCCESS = EVENTLOG_SUCCESS
+
+      # Error event, an event that indicates a significant problem such as
+      # loss of data or functionality.
+      ERROR = EVENTLOG_ERROR_TYPE
+
+      # Warning event, an event that is not necessarily significant but may
+      # indicate a possible future problem.
+      WARN = EVENTLOG_WARNING_TYPE
+
+      # Information event, an event that describes the successful operation
+      # of an application, driver or service.
+      INFO = EVENTLOG_INFORMATION_TYPE
+
+      # Success audit event, an event that records an audited security attempt
+      # that is successful.
+      AUDIT_SUCCESS = EVENTLOG_AUDIT_SUCCESS
+
+      # Failure audit event, an event that records an audited security attempt
+      # that fails.
+      AUDIT_FAILURE = EVENTLOG_AUDIT_FAILURE
+
+      private
+      
+      # :stopdoc:
       
       BUFFER_SIZE = 1024 * 64
       MAX_SIZE    = 256
       MAX_STRINGS = 16
       BASE_KEY    = "SYSTEM\\CurrentControlSet\\Services\\EventLog\\"
       
+      # :startdoc:
+
+      public
+      
       # The EventLogStruct encapsulates a single event log record.
       EventLogStruct = Struct.new('EventLogStruct', :record_number,
          :time_generated, :time_written, :event_id, :event_type, :category,
@@ -95,7 +129,7 @@ module Win32
          @server = server
          @file   = file
          
-         # Avoid Win32API segfaults
+         # Avoid potential segfaults from win32-api
          raise TypeError unless @source.is_a?(String)
          raise TypeError unless @server.is_a?(String) if @server
          
@@ -136,7 +170,7 @@ module Win32
          @source = source
          @server = server
          
-         # Avoid Win32API segfaults
+         # Avoid potential segfaults from win32-api
          raise TypeError unless @file.is_a?(String)
          raise TypeError unless @source.is_a?(String)
          raise TypeError unless @server.is_a?(String) if @server        
@@ -391,8 +425,8 @@ module Win32
          self
       end
       
-      # Closes the EventLog handle.  Automatically closed for you if you use
-      # the block form of EventLog.new.
+      # Closes the EventLog handle. The handle is automatically closed for you
+      # if you use the block form of EventLog.new.
       # 
       def close
          CloseEventLog(@handle)
@@ -432,8 +466,7 @@ module Win32
          total = [0].pack('L')
          
          unless GetNumberOfEventLogRecords(@handle, total)
-            error = 'GetNumberOfEventLogRecords() failed: '
-            error += get_last_error
+            error = 'GetNumberOfEventLogRecords() failed: ' + get_last_error
             raise Error, error
          end
          
@@ -456,7 +489,7 @@ module Win32
          @handle = OpenEventLog(@server, @source)
          
          if @handle == 0
-            error = "OpenEventLog() failed: " + get_last_error
+            error = 'OpenEventLog() failed: ' + get_last_error
             raise Error, error
          end
          
@@ -811,7 +844,7 @@ module Win32
                'error'
             when EVENTLOG_WARNING_TYPE
                'warning'
-            when EVENTLOG_INFORMATION_TYPE
+            when EVENTLOG_INFORMATION_TYPE, EVENTLOG_SUCCESS
                'information'
             when EVENTLOG_AUDIT_SUCCESS
                'audit_success'
@@ -1112,4 +1145,4 @@ module Win32
         [va_list0, buf.nstrip]
      end      
    end
-end
+end

data/lib/win32/mc.rb

@@ -1,10 +1,23 @@
+# The Win32 module serves as a namespace only.
 module Win32
+   
+   # The MC class encapsulates the mc (eventlog message compiler) commands.
    class MC
+      
+      # Raised if any of the MC methods fail.
       class Error < StandardError; end;
       
-      VERSION = '0.1.4'
+      # The version of the win32-mc library.
+      VERSION = '0.1.5'
 		
-      attr_accessor :mc_file, :res_file, :dll_file
+      # The name of the message category file initially processed.
+      attr_accessor :mc_file
+      
+      # The name of the resource file generated by the mc command.
+      attr_accessor :res_file
+      
+      # The name of the dll file generated by the link command.
+      attr_accessor :dll_file
 		
 		# Accepts three file names as arguments and returns an MC object.  The
       # +mc_file+ is the name of the .mc file to be used to ultimately
@@ -87,17 +100,17 @@ module Win32
    end
 end
 
-if $0 == __FILE__
-	include Win32
-	
+if $PROGRAM_NAME == __FILE__
 	mc_file = ARGV[0]
 	
-	unless mc_file
+	if mc_file
+	   mc_file.chomp!
+	else
 		msg = "Usage: ruby mc.rb 'filename.mc'"
-		raise MC::Error, msg
+		raise Win32::MC::Error, msg
 	end
 	
-	m = MC.new(mc_file.chomp)
+	m = Win32::MC.new(mc_file)
 	m.create_header
 	m.create_res_file
 	m.create_dll_file

data/misc/install_msg.rb

@@ -0,0 +1,48 @@
+##############################################################################
+# install_msg.rb
+#
+# This script will create a 'RubyMsg' event source in your registry.  All of
+# the relevant files will be copied to the 'rubymsg' directory under C:\ruby,
+# or wherever your toplevel Ruby installation directory is located.  By
+# default, this will be installed in the 'Application' log.  If you wish to
+# change that, change the word 'Application' to either 'Security' or 'System'
+# (or your own custom log).
+#
+# DO NOT MOVE THE DLL FILE ONCE IT IS INSTALLED.  If you do, you will have
+# to delete the registry entry and reinstall the event source pointing to the
+# proper directory.
+#
+# You should only run this script *after* you have installed win32-eventlog.
+##############################################################################
+require "rbconfig"
+require "fileutils"
+require "win32/eventlog"
+require "win32/mc"
+include Win32
+include Config
+
+prefix  = CONFIG["prefix"]
+msgdir  = prefix + '/rubymsg'
+msgfile = 'rubymsg.mc'
+
+Dir.mkdir(msgdir) unless File.exists?(msgdir)
+FileUtils.cp("lib/rubymsg.mc",msgdir)
+Dir.chdir(msgdir)
+
+m = MC.new(msgfile)
+m.create_all
+
+puts ".dll created"
+
+dll_file = File.expand_path(m.dll_file)
+
+# Change 'Application' to whatever you feel is appropriate
+EventLog.add_event_source(
+   'source'                => "Application",
+   'key_name'              => "RubyMsg",
+   'category_count'        => 3,
+   'event_message_file'    => dll_file,
+   'category_message_file' => dll_file
+)
+
+puts "Event source 'RubyMsg' added to registry"

data/misc/rubymsg.mc

@@ -0,0 +1,35 @@
+MessageId=0x1
+SymbolicName=CATEGORY_ERROR
+Language=English
+Error
+.
+
+MessageId=0x2
+SymbolicName=CATEGORY_WARNING
+Language=English
+Warning
+.
+
+MessageId=0x3
+SymbolicName=CATEGORY_OUTPUT
+Language=English
+Output
+.
+
+MessageId=0x4
+SymbolicName=RUBY_ERROR
+Language=English
+Ruby error: %1
+.
+
+MessageId=0x5
+SymbolicName=RUBY_WARNING
+Language=English
+Ruby warning: %1
+.
+
+MessageId=0x6
+SymbolicName=RUBY_OUTPUT
+Language=English
+Ruby output: %1
+.

data/test/test_eventlog.rb

@@ -7,25 +7,27 @@
 #############################################################################
 require 'rubygems'
 gem 'test-unit'
+
 require 'test/unit'
 require 'win32/eventlog'
 require 'socket'
 include Win32
 
-print "\nRelax - this will take a few moments\n\n"
-
 class TC_EventLog < Test::Unit::TestCase
+   def self.startup
+      @@hostname = Socket.gethostname      
+   end
+   
    def setup
       @log      = EventLog.new('Application')
       @logfile  = 'temp.evt'
       @bakfile  = 'C:\event_log.bak'
-      @hostname = Socket.gethostname
       @records  = []
       @last     = nil
    end
  
    def test_version
-      assert_equal('0.5.0', EventLog::VERSION)
+      assert_equal('0.5.1', EventLog::VERSION)
    end
    
    # Use the alias to validate it as well.
@@ -34,18 +36,18 @@ class TC_EventLog < Test::Unit::TestCase
       assert_nothing_raised{ EventLog.open }
       assert_nothing_raised{ EventLog.open{ |log| } }
       assert_nothing_raised{ EventLog.open('System') }
-      assert_nothing_raised{ EventLog.open('System', @hostname) }
+      assert_nothing_raised{ EventLog.open('System', @@hostname) }
    end
    
    def test_constructor_expected_errors
-      assert_raises(EventLog::Error){ EventLog.new('System', @hostname, 'foo') }
+      assert_raises(EventLog::Error){ EventLog.new('System', @@hostname, 'foo') }
       assert_raises(TypeError){ EventLog.open(1) }
       assert_raises(TypeError){ EventLog.open('System', 1) }
    end
    
    def test_constructor_instance_variables
-      assert_nothing_raised{ @log = EventLog.new('Application', @hostname) }
-      assert_equal(@hostname, @log.server)
+      assert_nothing_raised{ @log = EventLog.new('Application', @@hostname) }
+      assert_equal(@@hostname, @log.server)
       assert_equal('Application', @log.source)
    end
    
@@ -85,7 +87,7 @@ class TC_EventLog < Test::Unit::TestCase
       assert_nothing_raised{ EventLog.read("Application", nil){ break } }
       assert_nothing_raised{ EventLog.read("Application", nil, nil){ break } }
       assert_nothing_raised{ EventLog.read("Application", nil, nil, 10){ break } } 
-   end   
+   end  
    
    def test_class_read_expected_errors   
       assert_raises(ArgumentError){
@@ -113,7 +115,7 @@ class TC_EventLog < Test::Unit::TestCase
          @records = EventLog.read(nil, nil, flags, @last)
       }
       assert_equal(10, @records.length)
-   end
+   end 
    
    # This test could fail, since a record number + 10 may not actually exist.
    def test_seek_read_backwards
@@ -122,6 +124,11 @@ class TC_EventLog < Test::Unit::TestCase
       assert_nothing_raised{ @records = EventLog.read(nil, nil, flags, @last) }
       assert_equal(11, @records.length)
    end
+   
+   def test_eventlog_struct_is_frozen
+      EventLog.read{ |log| @entry = log; break }
+      assert_true(@entry.frozen?)      
+   end
   
    def test_server
       assert_respond_to(@log, :server)
@@ -217,10 +224,13 @@ class TC_EventLog < Test::Unit::TestCase
    
    def teardown
       @log.close rescue nil
-      File.delete(@bakfile) rescue nil
+      File.delete(@bakfile) if File.exists?(@bakfile)
       @logfile  = nil
-      @hostname = nil
       @records  = nil
       @last     = nil
    end
+   
+   def self.shutdown
+      @@hostname = nil      
+   end
 end

data/test/test_mc.rb

@@ -8,25 +8,19 @@
 ############################################################################
 require 'rubygems'
 gem 'test-unit'
+
 require 'test/unit'
 require 'win32/mc'
 require 'ptools'
 include Win32
 
 class TC_Win32_MC < Test::Unit::TestCase
-   class << self
-      def startup
-         Dir.chdir('test') unless File.basename(Dir.pwd) == 'test'
-         @@mc_cmd = File.which('mc')
-         @@rc_cmd = File.which('rc')
-         @@link_cmd = File.which('link')
-      end
-      
-      def shutdown
-         @@mc_cmd = nil
-         @@rc_cmd = nil
-         @@link_cmd = nil
-      end      
+   def self.startup
+      Dir.chdir(File.expand_path(File.dirname(__FILE__)))
+
+      @@mc_cmd   = File.which('mc')
+      @@rc_cmd   = File.which('rc')
+      @@link_cmd = File.which('link')
    end
    
    def setup 
@@ -34,7 +28,7 @@ class TC_Win32_MC < Test::Unit::TestCase
    end
    
    def test_01_version
-      assert_equal('0.1.4', MC::VERSION)
+      assert_equal('0.1.5', MC::VERSION)
    end
 
    def test_02_create_header
@@ -62,6 +56,12 @@ class TC_Win32_MC < Test::Unit::TestCase
 
    def teardown
       @mc = nil
-      File.delete('foo.dll') rescue nil
+      File.delete('foo.dll') if File.exists?('foo.dll')
    end
+
+   def self.shutdown
+      @@mc_cmd = nil
+      @@rc_cmd = nil
+      @@link_cmd = nil
+   end      
 end

data/win32-eventlog.gemspec

@@ -1,27 +1,33 @@
-require "rubygems"
+require 'rubygems'
 
 spec = Gem::Specification.new do |gem|
-   gem.name        = "win32-eventlog"
-   gem.version     = "0.5.0"
-   gem.authors     = ["Daniel J. Berger", "Park Heesob"]
-   gem.email       = "djberg96@gmail.com"
-   gem.homepage    = "http://www.rubyforge.org/projects/win32utils"
-   gem.platform    = Gem::Platform::RUBY
-   gem.summary     = "Interface for the MS Windows Event Log."
-   gem.description = "Interface for the MS Windows Event Log."
-   gem.test_files  = Dir["test/*.rb"]
-   gem.has_rdoc    = true
+   gem.name       = 'win32-eventlog'
+   gem.version    = '0.5.1'
+   gem.authors    = ['Daniel J. Berger', 'Park Heesob']
+   gem.license    = 'Artistic 2.0'
+   gem.email      = 'djberg96@gmail.com'
+   gem.homepage   = 'http://www.rubyforge.org/projects/win32utils'
+   gem.platform   = Gem::Platform::RUBY
+   gem.summary    = 'Interface for the MS Windows Event Log.'
+   gem.test_files = Dir['test/*.rb']
+   gem.has_rdoc   = true
+   gem.files      = Dir['**/*'].reject{ |f| f.include?('CVS') }
+
    gem.rubyforge_project = 'win32utils'
-   gem.files       = Dir["lib/win32/*.rb"] + Dir["test/*"] + Dir["[A-Z]*"]
-   gem.files.reject! { |fn| fn.include? "CVS" }
-   gem.require_path = "lib"
-   gem.extra_rdoc_files = ["README", "CHANGES", "MANIFEST", "doc/tutorial.txt"]
-   gem.add_dependency("windows-pr", ">= 0.9.3")
-   gem.add_dependency("ptools", ">= 1.1.6")
-   gem.add_dependency("test-unit", ">= 2.0.0")
-end
+   gem.extra_rdoc_files  = ['README', 'CHANGES', 'MANIFEST', 'doc/tutorial.txt']
 
-if $0 == __FILE__
-   Gem.manage_gems
-   Gem::Builder.new(spec).build
+   gem.add_dependency('windows-pr', '>= 0.9.3')
+   gem.add_development_dependency('ptools', '>= 1.1.6')
+   gem.add_development_dependency('test-unit', '>= 2.0.3')
+
+   gem.description = <<-EOF
+      The win32-eventlog library provides an interface to the MS Windows event
+      log. Event logging provides a standard, centralized way for applications
+      (and the operating system) to record important software and hardware
+      events. The event-logging service stores events from various sources in a
+      single collection called an event log. This library allows you to inspect
+      existing logs as well as create new ones.
+   EOF
 end
+
+Gem::Builder.new(spec).build

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: win32-eventlog
 version: !ruby/object:Gem::Version 
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors: 
 - Daniel J. Berger
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-09-12 00:00:00 -06:00
+date: 2009-08-08 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -25,7 +25,7 @@ dependencies:
     version: 
 - !ruby/object:Gem::Dependency 
   name: ptools
-  type: :runtime
+  type: :development
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
@@ -35,15 +35,15 @@ dependencies:
     version: 
 - !ruby/object:Gem::Dependency 
   name: test-unit
-  type: :runtime
+  type: :development
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 2.0.0
+        version: 2.0.3
     version: 
-description: Interface for the MS Windows Event Log.
+description: "      The win32-eventlog library provides an interface to the MS Windows event\n      log. Event logging provides a standard, centralized way for applications\n      (and the operating system) to record important software and hardware\n      events. The event-logging service stores events from various sources in a\n      single collection called an event log. This library allows you to inspect\n      existing logs as well as create new ones.\n"
 email: djberg96@gmail.com
 executables: []
 
@@ -55,25 +55,26 @@ extra_rdoc_files:
 - MANIFEST
 - doc/tutorial.txt
 files: 
+- CHANGES
+- doc/tutorial.txt
+- examples/example_notify.rb
+- examples/example_read.rb
+- examples/example_write.rb
 - lib/win32/eventlog.rb
 - lib/win32/mc.rb
-- test/foo.mc
-- test/test_eventlog.rb
-- test/test_mc.rb
-- CHANGES
-- doc
-- examples
-- lib
 - MANIFEST
-- misc
+- misc/install_msg.rb
+- misc/rubymsg.mc
 - Rakefile
 - README
-- test
-- win32-eventlog-0.5.0.gem
+- test/foo.mc
+- test/test_eventlog.rb
+- test/test_mc.rb
 - win32-eventlog.gemspec
-- doc/tutorial.txt
 has_rdoc: true
 homepage: http://www.rubyforge.org/projects/win32utils
+licenses: 
+- Artistic 2.0
 post_install_message: 
 rdoc_options: []
 
@@ -94,9 +95,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: win32utils
-rubygems_version: 1.2.0
+rubygems_version: 1.3.5
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: Interface for the MS Windows Event Log.
 test_files: 
 - test/test_eventlog.rb