rubylogparser 0.1.1 → 0.1.3

data/EXAMPLES.txt

@@ -25,13 +25,11 @@ Time) are also printed.
   lp = RubyLogParser.new
   lp.open_query('FS', 'Select Top 10 name, size INTO STDOUT from c:/win*.* ORDER BY size DESC', 'CSV', nil)
 
-  while hash = lp.data_hash(lp.process_array_line(lp.readline)) do
+  while hash = lp.read_hash do
     p "#{hash['Name'].ljust(60)} #{hash['Size'].rjust(12)}\n"
   end
-
+  
   lp.parse_errors_and_stats(lp.read)
-
-  p "Parse errors:\n" + lp.parse_errors.to_s + "\n\n"
   p "Processed: " + (lp.elements_processed.nil? ? "0" : "#{lp.elements_processed}") + "\n"
   p "Output: " + (lp.elements_output.nil? ? "0" : "#{lp.elements_output}") + "\n"
   p "Time: " + (lp.execution_time.nil? ? "0" : "#{lp.execution_time}") + " seconds\n"
@@ -65,13 +63,11 @@ In this example, each line of data is read into an array for further processing
   "
   
   lp.open_query('EVT', sql, 'CSV', nil)
-  while array = lp.process_array_line(lp.readline) do
+  while array = lp.read_array_line do
     p "#{array[0].ljust(35)} #{array[1].rjust(8)}\n"
   end
   
   lp.parse_errors_and_stats(lp.read)
-
-  p "Parse errors:\n" + lp.parse_errors.to_s + "\n\n"
   p "Processed: " + (lp.elements_processed.nil? ? "0" : "#{lp.elements_processed}") + "\n"
   p "Output: " + (lp.elements_output.nil? ? "0" : "#{lp.elements_output}") + "\n"
   p "Time: " + (lp.execution_time.nil? ? "0" : "#{lp.execution_time}") + " seconds\n"
@@ -105,10 +101,11 @@ printing the query statistics.
 
   lp.open_query('REG', sql, 'CSV', {'e' => 100})
 
-  while array = lp.process_array_line(lp.readline) do
+  while array = lp.read_array_line do
     p "#{array[0].ljust(80)} #{array[1].rjust(25)}\n"
   end
-
+  
+  lp.parse_errors_and_stats(lp.read)
   p "Parse errors:\n" + lp.parse_errors.to_s + "\n\n"
   p "Statistics:\n"
   p "Processed: " + (lp.elements_processed.nil? ? "0" : "#{lp.elements_processed}") + "\n"
@@ -140,4 +137,4 @@ open_query method as {'queryInfo' => true, 'iw' => true}.
 
   lp.open_query('EVT', sql, nil, {'queryInfo' => true})
 
-  puts "#{lp.formatted_queryInfo}"
+  puts "#{lp.queryInfo}"

data/GUIDE.txt

@@ -84,12 +84,12 @@ Next we read the Log Parser output line by line into an array and format the
 output to be printed to the screen. See the examples/files.rb example for using
 a hash to retrieve output.
 
-  while array = lp.process_array_line(lp.readline) do
+  while array = lp.read_array_line do
     p "#{array[0].ljust(35)} #{array[1].rjust(8)}\n"
   end
 
 Once all output has been processed, the query statistics and any warnings/errors
-are read from the remaining Log Parser output in the pipe and made available.
+are available.
 
   lp.parse_errors_and_stats(lp.read)
   p "Parse errors:\n" + lp.parse_errors.to_s + "\n\n"

data/History.txt

@@ -1,8 +1,12 @@
-== 0.1.1 / 2008-06-06
+== 0.1.3 / 2008-12-27
 
-* Updated to have 100% code coverage (as reported by rcov)
-* Methods refactored to achieve the 100% testing nirvana.
-* Some minor changes in the examples
+* Updated paths to find LogParser for 64-bit Windows installs (tested on Windows Server 2008)
+* Added methods read_hash and read_array_line back in that were unintentionally dropped and broke the documentation / examples
+* Updated documentation
+
+== 0.1.1 / 2008-05-30
+
+* Added better test coverage (100% coverage according to rcov)
 
 == 0.1.0 / 2008-01-10
 

data/README.txt

@@ -51,8 +51,8 @@ Testing was done in the following environment:
 
 * Microsoft Log Parser 2.2
 
-Other software versions may work but are completely untested. Testing with Rails
-and Ruby 1.9 will be done in early 2008.
+Other software versions may work but are completely untested. I have used and tested
+the examples on Windows XP and Windows Server 2008.
 
 == INSTALL:
 
@@ -70,6 +70,8 @@ locations:
 
 * c:\Program Files\Log Parser 2.2\LogParser.exe (Default location when downloaded and installed without the IIS Resource kit)
 
+* c:\Program Files (x86)\Log Parser 2.2\LogParser.exe (Default location for 64-bit Windows Server 2008 install)
+
 * LogParser.exe on the path somewhere
 
 If the LogParser.exe executable cannot be found, the "test_valid_executable"

data/Rakefile

@@ -5,6 +5,7 @@ require 'rubylogparser'
 
 Hoe.new('rubylogparser', RubyLogParser::VERSION) do |p|
   p.rubyforge_name = 'rubylogparser'
+  p.version = "0.1.3"
   p.author = 'Jim Clark'
   p.email = 'jimclark@ieee.org'
   p.summary = "RubyLogParser provides a wrapper around Microsoft's Log Parser executable."

data/examples/event_log.rb

@@ -19,7 +19,7 @@ ORDER BY number_of_events desc
 lp.open_query('EVT', sql, 'CSV', nil)
 
 i=1
-while array = lp.process_array_line(lp.readline) do
+while array = lp.read_array_line do
   p "#{i}.".ljust(4) + " #{array[0].ljust(35)} #{array[1].rjust(8)}\n"
   i += 1
 end
@@ -27,6 +27,6 @@ end
 lp.parse_errors_and_stats(lp.read)
 
 p "Parse errors:\n" + lp.parse_errors.to_s + "\n\n"
-p "\nProcessed: " + (lp.elements_processed.nil? ? "0" : "#{lp.elements_processed}") + "\n"
+p "Processed: " + (lp.elements_processed.nil? ? "0" : "#{lp.elements_processed}") + "\n"
 p "Output: " + (lp.elements_output.nil? ? "0" : "#{lp.elements_output}") + "\n"
 p "Time: " + (lp.execution_time.nil? ? "0" : "#{lp.execution_time}") + " seconds\n"

data/examples/files.rb

@@ -6,17 +6,16 @@ require 'rubylogparser.rb'
 lp = RubyLogParser.new
 
 # Note: This query may take several minutes to run
-lp.open_query('FS', 'Select Top 10 name, size INTO STDOUT from c:/rubylogparser/*.* ORDER BY size DESC', 'CSV', nil)
+lp.open_query('FS', 'Select Top 10 name, size INTO STDOUT from c:/win*.* ORDER BY size DESC', 'CSV', nil)
 
 i=1
-while hash = lp.data_hash(lp.process_array_line(lp.readline)) do
-  p "#{i}. #{hash['Name'].ljust(60)} #{hash['Size'].rjust(12)}\n"
+while hash = lp.read_hash do
+  p "#{i}.".ljust(4) + " #{hash['Name'].ljust(60)} #{hash['Size'].rjust(12)}\n"
   i += 1
 end
 
 lp.parse_errors_and_stats(lp.read)
 
-p "Parse errors:\n" + lp.parse_errors.to_s + "\n\n"
 p "Processed: " + (lp.elements_processed.nil? ? "0" : "#{lp.elements_processed}") + "\n"
 p "Output: " + (lp.elements_output.nil? ? "0" : "#{lp.elements_output}") + "\n"
 p "Time: " + (lp.execution_time.nil? ? "0" : "#{lp.execution_time}") + " seconds\n"

data/examples/registry.rb

@@ -19,7 +19,7 @@ lp.open_query('REG', sql, 'CSV', {'e' => 100})
 
 i=1
 while array = lp.process_array_line(lp.readline) do
-  p "#{i}. #{array[0].ljust(80)} #{array[1].rjust(25)}\n"
+  p "#{i}.".ljust(5) + " #{array[0].ljust(80)} #{array[1].rjust(25)}\n"
   i += 1  
 end
 

data/lib/rubylogparser.rb

@@ -16,7 +16,7 @@
 require 'csv'
 
 class RubyLogParser
-  VERSION = "0.1.1"
+  VERSION = "0.1.3"
   
   # Stores the various options that will be used to build the command line that
   # the process is eventually started with
@@ -71,7 +71,7 @@ class RubyLogParser
   def valid_executable(lp_executable = nil)
     @logparser_exe = nil
     if lp_executable.nil? then
-      file_locations = ['c:\Program Files\IIS Resources\Log Parser 2.2\LogParser.exe', 'c:\Program Files\Log Parser 2.2\LogParser.exe', 'LogParser.exe']
+      file_locations = ['c:\Program Files\IIS Resources\Log Parser 2.2\LogParser.exe', 'c:\Program Files\Log Parser 2.2\LogParser.exe', 'c:\Program Files (x86)\Log Parser 2.2\LogParser.exe', 'LogParser.exe']
     else
       file_locations = [ lp_executable ]
     end
@@ -196,7 +196,7 @@ class RubyLogParser
   # the data output is complete and anything that will follow are the errors
   # or query statistics.
   def process_line(line)
-    if line == "\r\n" then
+    if (line == "\r\n" || line =~ /Task completed with parse errors/i) then
       self.error_flag = true # remaining output should now be error
       return nil
     else
@@ -307,13 +307,18 @@ class RubyLogParser
     return data_array
   end
   
+  # Often times, the easiest way to use the LogParser output is to parse a single
+  # line into a hash that is keyed by the field names. Once all LogParser output
+  # has been read, this will return nil.
+  def read_hash
+    self.data_hash(self.process_array_line(self.readline))  
+  end
+  
+  # Similar to read_hash, this method will parse a single return the LogParser
+  # output in an array. If no output remains, this will return nil.
+  def read_array_line
+    self.process_array_line(self.readline)
+  end
+  
 end
-=begin
-@logparser = RubyLogParser.new
-@logparser.open_query('EVT','SELECT Top 2 SourceName INTO STDOUT From System','CSV',nil)
-temp = @logparser.read_array(true)
-p temp.length
-p "Stat info:"
-p @logparser.read_all
 
-=end

data/test/test_rubylogparser.rb

@@ -134,4 +134,26 @@ class Test_RubyLogParser < Test::Unit::TestCase
     assert_equal 2, temp.length
   end
   
+  def test_read_hash
+    @logparser.cmd_options['i'] = 'EVT'
+    @logparser.cmd_options['sql'] = 'SELECT Top 1 SourceName INTO STDOUT From System'
+    @logparser.cmd_options['o'] = 'CSV'
+    @logparser.build_command_string(nil)
+    @logparser.field_definitions("SourceName")
+    @logparser.create_process
+    temp = @logparser.read_hash
+    assert_not_equal nil, temp['SourceName']
+  end
+  
+  def test_read_array_line
+    @logparser.cmd_options['i'] = 'EVT'
+    @logparser.cmd_options['sql'] = 'SELECT Top 1 SourceName INTO STDOUT From System'
+    @logparser.cmd_options['o'] = 'CSV'
+    @logparser.build_command_string(nil)
+    @logparser.field_definitions("SourceName")
+    @logparser.create_process
+    temp = @logparser.read_array_line
+    assert_not_equal nil, temp[0]
+  end
+  
 end

metadata

@@ -1,33 +1,39 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.4
-specification_version: 1
 name: rubylogparser
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
-date: 2008-06-06 00:00:00 -07:00
-summary: RubyLogParser provides a wrapper around Microsoft's Log Parser executable.
-require_paths: 
-- lib
-email: jimclark@ieee.org
-homepage: http://rubyforge.org/projects/rubylogparser/
-rubyforge_project: rubylogparser
-description: RubyLogParser enables the output from Microsoft's Log Parser to be processed by Ruby data structures (arrays and hashes).
-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: 
+  version: 0.1.3
 platform: ruby
-signing_key: 
-cert_chain: 
-post_install_message: 
 authors: 
 - Jim Clark
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-12-27 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.8.2
+    version: 
+description: RubyLogParser enables the output from Microsoft's Log Parser to be processed by Ruby data structures (arrays and hashes).
+email: jimclark@ieee.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- EXAMPLES.txt
+- GUIDE.txt
+- History.txt
+- Manifest.txt
+- README.txt
 files: 
 - EXAMPLES.txt
 - GUIDE.txt
@@ -41,30 +47,32 @@ files:
 - examples/registry.rb
 - lib/rubylogparser.rb
 - test/test_rubylogparser.rb
-test_files: 
-- test/test_rubylogparser.rb
+has_rdoc: true
+homepage: http://rubyforge.org/projects/rubylogparser/
+post_install_message: 
 rdoc_options: 
 - --main
 - README.txt
-extra_rdoc_files: 
-- EXAMPLES.txt
-- GUIDE.txt
-- History.txt
-- Manifest.txt
-- README.txt
-executables: []
-
-extensions: []
-
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
 requirements: []
 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: hoe
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Version::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 1.5.3
-    version: 
+rubyforge_project: rubylogparser
+rubygems_version: 1.3.1
+signing_key: 
+specification_version: 2
+summary: RubyLogParser provides a wrapper around Microsoft's Log Parser executable.
+test_files: 
+- test/test_rubylogparser.rb