sys-proctable 1.0.0-universal-mingw32 → 1.1.0-universal-mingw32

data/benchmarks/bench_ps.rb

@@ -1,21 +1,21 @@
-########################################################################
-# bench_ps.rb
-#
-# Benchmark program to show overall speed and compare the block form
-# versus the non-block form. You should run this benchmark via the
-# 'rake bench' Rake task.
-########################################################################
-require 'benchmark'
-require 'sys/proctable'
-
-MAX = 10
-
-Benchmark.bm do |bench|
-   bench.report("Block form"){
-      MAX.times{ Sys::ProcTable.ps{} }
-   }
-
-   bench.report("Non-block form"){
-      MAX.times{ Sys::ProcTable.ps }
-   }
-end
+########################################################################
+# bench_ps.rb
+#
+# Benchmark program to show overall speed and compare the block form
+# versus the non-block form. You should run this benchmark via the
+# 'rake bench' Rake task.
+########################################################################
+require 'benchmark'
+require 'sys/proctable'
+
+MAX = 10
+
+Benchmark.bm do |bench|
+   bench.report("Block form"){
+      MAX.times{ Sys::ProcTable.ps{} }
+   }
+
+   bench.report("Non-block form"){
+      MAX.times{ Sys::ProcTable.ps }
+   }
+end

data/doc/top.txt

@@ -1,47 +1,47 @@
-= Description
-   A simple 'top' interface for Ruby
-
-= Prerequisites
-   Requires the "sys/proctable" package (which should be installed along
-   with this package).
-
-= Synopsis
-   require "sys/top"
-
-   Sys::Top.top(5).each{ |ps|
-      p ps
-   }
-	
-= Constants
-VERSION
-   Returns the version number of this package as a String.
-	
-= Class Methods
-Sys::Top.top(number=10, field="pctcpu")
-   Returns an array of ProcTableStruct's.  The size of the array (i.e. the
-   number of processes) that it returns is based on +number+, and sorted by
-   +pctcpu+.  By default, the size and field values are 10 and "pctcpu",
-   respectively.
-
-= Notes
-   Not all fields are available on all platforms.  Please check your
-   platform specific documentation for which fields are available.
-	
-= Bugs
-   None that I'm aware of.  Please log bug reports on the project page at
-   http://www.rubyforge.org/projects/sysutils
-	
-= License
-   Artistic 2.0
-	
-= Copyright
-   (C) 2004-2009 Daniel J. Berger
-   All Rights Reserved.
-    
-= 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.
-
-= Author
+= Description
+   A simple 'top' interface for Ruby
+
+= Prerequisites
+   Requires the "sys/proctable" package (which should be installed along
+   with this package).
+
+= Synopsis
+   require "sys/top"
+
+   Sys::Top.top(5).each{ |ps|
+      p ps
+   }
+	
+= Constants
+VERSION
+   Returns the version number of this package as a String.
+	
+= Class Methods
+Sys::Top.top(number=10, field="pctcpu")
+   Returns an array of ProcTableStruct's.  The size of the array (i.e. the
+   number of processes) that it returns is based on +number+, and sorted by
+   +pctcpu+.  By default, the size and field values are 10 and "pctcpu",
+   respectively.
+
+= Notes
+   Not all fields are available on all platforms.  Please check your
+   platform specific documentation for which fields are available.
+	
+= Bugs
+   None that I'm aware of.  Please log bug reports on the project page at
+   http://www.rubyforge.org/projects/sysutils
+	
+= License
+   Artistic 2.0
+	
+= Copyright
+   (C) 2004-2009 Daniel J. Berger
+   All Rights Reserved.
+    
+= 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.
+
+= Author
    Daniel J. Berger

data/examples/example_ps.rb

@@ -1,20 +1,20 @@
-#######################################################################
-# example_ps.rb
-#
-# Generic test program that demonstrates the use of ProcTable.ps. You
-# can run this via the 'rake example' task.
-#
-# Modify as you see fit
-#######################################################################
-require 'sys/proctable'
-include Sys
-
-puts "VERSION: " + ProcTable::VERSION
-sleep 2
-
-ProcTable.ps{ |s|
-   ProcTable.fields.each{ |field|
-      puts "#{field}: " + s.send(field).to_s    
-   }
-   puts '=' * 30
-}
+#######################################################################
+# example_ps.rb
+#
+# Generic test program that demonstrates the use of ProcTable.ps. You
+# can run this via the 'rake example' task.
+#
+# Modify as you see fit
+#######################################################################
+require 'sys/proctable'
+include Sys
+
+puts "VERSION: " + ProcTable::VERSION
+sleep 2
+
+ProcTable.ps{ |s|
+   ProcTable.fields.each{ |field|
+      puts "#{field}: " + s.send(field).to_s    
+   }
+   puts '=' * 30
+}

data/lib/sys-proctable.rb

@@ -1 +1 @@
-require 'sys/proctable'
+require 'sys/proctable'

data/lib/sys/proctable/version.rb

@@ -1,6 +1,6 @@
-module Sys
-  class ProcTable
-    # The version of the sys-proctable library
-    VERSION = '1.0.0'
-  end
-end
+module Sys
+  class ProcTable
+    # The version of the sys-proctable library
+    VERSION = '1.1.0'.freeze
+  end
+end

data/lib/sys/top.rb

@@ -1,31 +1,31 @@
-require 'sys/proctable'
-
-# The Sys module serves as a namespace only
-module Sys
-
-  # The Top class serves as a toplevel name for the 'top' method.
-  class Top
-
-    # The version of the sys-top library
-    VERSION = '1.0.4'
-
-    # Returns an array of Struct::ProcTableStruct elements containing up
-    # to +num+ elements, sorted by +field+. The default number of elements
-    # is 10, while the default field is 'pctcpu'.
-    #
-    # Exception: the default sort field is 'pid' on AIX and Windows.
-    #
-    def self.top(num=10, field='pctcpu')
-      field = field.to_s if field.is_a?(Symbol)
-
-      aix = RbConfig::CONFIG['host_os'] =~ /aix/i
-
-      # Sort by pid on Windows and AIX by default
-      if (File::ALT_SEPARATOR || aix) && field == 'pctcpu'
-        field = 'pid'
-      end
-
-      Sys::ProcTable.ps.sort_by{ |obj| obj.send(field) || '' }[0..num-1]
-    end
-  end
-end
+require 'sys/proctable'
+
+# The Sys module serves as a namespace only
+module Sys
+
+  # The Top class serves as a toplevel name for the 'top' method.
+  class Top
+
+    # The version of the sys-top library
+    VERSION = '1.0.4'
+
+    # Returns an array of Struct::ProcTableStruct elements containing up
+    # to +num+ elements, sorted by +field+. The default number of elements
+    # is 10, while the default field is 'pctcpu'.
+    #
+    # Exception: the default sort field is 'pid' on AIX and Windows.
+    #
+    def self.top(num=10, field='pctcpu')
+      field = field.to_s if field.is_a?(Symbol)
+
+      aix = RbConfig::CONFIG['host_os'] =~ /aix/i
+
+      # Sort by pid on Windows and AIX by default
+      if (File::ALT_SEPARATOR || aix) && field == 'pctcpu'
+        field = 'pid'
+      end
+
+      Sys::ProcTable.ps.sort_by{ |obj| obj.send(field) || '' }[0..num-1]
+    end
+  end
+end

data/lib/windows/sys/proctable.rb

@@ -1,207 +1,207 @@
-require 'win32ole'
-require 'socket'
-require 'date'
-require 'sys/proctable/version'
-
-# The Sys module serves as a namespace only
-module Sys
-
-  # The ProcTable class encapsulates process table information
-  class ProcTable
-
-    # There is no constructor
-    private_class_method :new
-
-    # Error typically raised if one of the Sys::ProcTable methods fails
-    class Error < StandardError; end
-
-    # The comm field corresponds to the 'name' field.  The 'cmdline' field
-    # is the CommandLine attribute on Windows XP or later, or the
-    # 'executable_path' field on Windows 2000 or earlier.
-    #
-    @fields = %w[
-      caption
-      cmdline
-      comm
-      creation_class_name
-      creation_date
-      cs_creation_class_name
-      cs_name
-      description
-      executable_path
-      execution_state
-      handle
-      handle_count
-      install_date
-      kernel_mode_time
-      maximum_working_set_size
-      minimum_working_set_size
-      name
-      os_creation_class_name
-      os_name
-      other_operation_count
-      other_transfer_count
-      page_faults
-      page_file_usage
-      ppid
-      peak_page_file_usage
-      peak_virtual_size
-      peak_working_set_size
-      priority
-      private_page_count
-      pid
-      quota_non_paged_pool_usage
-      quota_paged_pool_usage
-      quota_peak_non_paged_pool_usage
-      quota_peak_paged_pool_usage
-      read_operation_count
-      read_transfer_count
-      session_id
-      status
-      termination_date
-      thread_count
-      user_mode_time
-      virtual_size
-      windows_version
-      working_set_size
-      write_operation_count
-      write_transfer_count
-    ]
-
-    ProcTableStruct = Struct.new("ProcTableStruct", *@fields)
-
-    # call-seq:
-    #    ProcTable.fields
-    #
-    # Returns an array of fields that each ProcTableStruct will contain.  This
-    # may be useful if you want to know in advance what fields are available
-    # without having to perform at least one read of the /proc table.
-    #
-    def self.fields
-       @fields
-    end
-
-    # call-seq:
-    #    ProcTable.ps(pid=nil)
-    #    ProcTable.ps(pid=nil){ |ps| ... }
-    #
-    # In block form, yields a ProcTableStruct for each process entry that you
-    # have rights to.  This method returns an array of ProcTableStruct's in
-    # non-block form.
-    #
-    # If a +pid+ is provided, then only a single ProcTableStruct is yielded or
-    # returned, or nil if no process information is found for that +pid+.
-    #
-    def self.ps(pid=nil, host=Socket.gethostname)
-      if pid
-        raise TypeError unless pid.kind_of?(Fixnum)
-      end
-
-      array  = block_given? ? nil : []
-      struct = nil
-
-      begin
-        wmi = WIN32OLE.connect("winmgmts://#{host}/root/cimv2")
-      rescue WIN32OLERuntimeError => e
-        raise Error, e # Re-raise as ProcTable::Error
-      else
-        wmi.InstancesOf("Win32_Process").each{ |wproc|
-          if pid
-            next unless wproc.ProcessId == pid
-          end
-
-          # Some fields are added later, and so are nil initially
-          struct = ProcTableStruct.new(
-            wproc.Caption,
-            nil, # Added later, based on OS version
-            wproc.Name,
-            wproc.CreationClassName,
-            self.parse_ms_date(wproc.CreationDate),
-            wproc.CSCreationClassName,
-            wproc.CSName,
-            wproc.Description,
-            wproc.ExecutablePath,
-            wproc.ExecutionState,
-            wproc.Handle,
-            wproc.HandleCount,
-            self.parse_ms_date(wproc.InstallDate),
-            self.convert(wproc.KernelModeTime),
-            wproc.MaximumWorkingSetSize,
-            wproc.MinimumWorkingSetSize,
-            wproc.Name,
-            wproc.OSCreationClassName,
-            wproc.OSName,
-            self.convert(wproc.OtherOperationCount),
-            self.convert(wproc.OtherTransferCount),
-            wproc.PageFaults,
-            wproc.PageFileUsage,
-            wproc.ParentProcessId,
-            self.convert(wproc.PeakPageFileUsage),
-            self.convert(wproc.PeakVirtualSize),
-            self.convert(wproc.PeakWorkingSetSize),
-            wproc.Priority,
-            self.convert(wproc.PrivatePageCount),
-            wproc.ProcessId,
-            wproc.QuotaNonPagedPoolUsage,
-            wproc.QuotaPagedPoolUsage,
-            wproc.QuotaPeakNonPagedPoolUsage,
-            wproc.QuotaPeakPagedPoolUsage,
-            self.convert(wproc.ReadOperationCount),
-            self.convert(wproc.ReadTransferCount),
-            wproc.SessionId,
-            wproc.Status,
-            self.parse_ms_date(wproc.TerminationDate),
-            wproc.ThreadCount,
-            self.convert(wproc.UserModeTime),
-            self.convert(wproc.VirtualSize),
-            wproc.WindowsVersion,
-            self.convert(wproc.WorkingSetSize),
-            self.convert(wproc.WriteOperationCount),
-            self.convert(wproc.WriteTransferCount)
-          )
-
-          ###############################################################
-          # On Windows XP or later, set the cmdline to the CommandLine
-          # attribute.  Otherwise, set it to the ExecutablePath
-          # attribute.
-          ###############################################################
-          if wproc.WindowsVersion.to_f < 5.1
-            struct.cmdline = wproc.ExecutablePath
-          else
-            struct.cmdline = wproc.CommandLine
-          end
-
-          struct.freeze # This is read-only data
-
-          if block_given?
-            yield struct
-          else
-            array << struct
-          end
-        }
-      end
-
-      pid ? struct : array
-    end
-
-    private
-
-    #######################################################################
-    # Converts a string in the format '20040703074625.015625-360' into a
-    # Ruby Time object.
-    #######################################################################
-    def self.parse_ms_date(str)
-      return if str.nil?
-      return DateTime.parse(str)
-    end
-
-    #####################################################################
-    # There is a bug in win32ole where uint64 types are returned as a
-    # String instead of a Fixnum.  This method deals with that for now.
-    #####################################################################
-    def self.convert(str)
-      return nil if str.nil? # Return nil, not 0
-      return str.to_i
-    end
-  end
-end
+require 'win32ole'
+require 'socket'
+require 'date'
+require 'sys/proctable/version'
+
+# The Sys module serves as a namespace only
+module Sys
+
+  # The ProcTable class encapsulates process table information
+  class ProcTable
+
+    # There is no constructor
+    private_class_method :new
+
+    # Error typically raised if one of the Sys::ProcTable methods fails
+    class Error < StandardError; end
+
+    # The comm field corresponds to the 'name' field.  The 'cmdline' field
+    # is the CommandLine attribute on Windows XP or later, or the
+    # 'executable_path' field on Windows 2000 or earlier.
+    #
+    @fields = %w[
+      caption
+      cmdline
+      comm
+      creation_class_name
+      creation_date
+      cs_creation_class_name
+      cs_name
+      description
+      executable_path
+      execution_state
+      handle
+      handle_count
+      install_date
+      kernel_mode_time
+      maximum_working_set_size
+      minimum_working_set_size
+      name
+      os_creation_class_name
+      os_name
+      other_operation_count
+      other_transfer_count
+      page_faults
+      page_file_usage
+      ppid
+      peak_page_file_usage
+      peak_virtual_size
+      peak_working_set_size
+      priority
+      private_page_count
+      pid
+      quota_non_paged_pool_usage
+      quota_paged_pool_usage
+      quota_peak_non_paged_pool_usage
+      quota_peak_paged_pool_usage
+      read_operation_count
+      read_transfer_count
+      session_id
+      status
+      termination_date
+      thread_count
+      user_mode_time
+      virtual_size
+      windows_version
+      working_set_size
+      write_operation_count
+      write_transfer_count
+    ]
+
+    ProcTableStruct = Struct.new("ProcTableStruct", *@fields)
+
+    # call-seq:
+    #    ProcTable.fields
+    #
+    # Returns an array of fields that each ProcTableStruct will contain.  This
+    # may be useful if you want to know in advance what fields are available
+    # without having to perform at least one read of the /proc table.
+    #
+    def self.fields
+       @fields
+    end
+
+    # call-seq:
+    #    ProcTable.ps(pid=nil)
+    #    ProcTable.ps(pid=nil){ |ps| ... }
+    #
+    # In block form, yields a ProcTableStruct for each process entry that you
+    # have rights to.  This method returns an array of ProcTableStruct's in
+    # non-block form.
+    #
+    # If a +pid+ is provided, then only a single ProcTableStruct is yielded or
+    # returned, or nil if no process information is found for that +pid+.
+    #
+    def self.ps(pid=nil, host=Socket.gethostname)
+      if pid
+        raise TypeError unless pid.kind_of?(Fixnum)
+      end
+
+      array  = block_given? ? nil : []
+      struct = nil
+
+      begin
+        wmi = WIN32OLE.connect("winmgmts://#{host}/root/cimv2")
+      rescue WIN32OLERuntimeError => e
+        raise Error, e # Re-raise as ProcTable::Error
+      else
+        wmi.InstancesOf("Win32_Process").each{ |wproc|
+          if pid
+            next unless wproc.ProcessId == pid
+          end
+
+          # Some fields are added later, and so are nil initially
+          struct = ProcTableStruct.new(
+            wproc.Caption,
+            nil, # Added later, based on OS version
+            wproc.Name,
+            wproc.CreationClassName,
+            self.parse_ms_date(wproc.CreationDate),
+            wproc.CSCreationClassName,
+            wproc.CSName,
+            wproc.Description,
+            wproc.ExecutablePath,
+            wproc.ExecutionState,
+            wproc.Handle,
+            wproc.HandleCount,
+            self.parse_ms_date(wproc.InstallDate),
+            self.convert(wproc.KernelModeTime),
+            wproc.MaximumWorkingSetSize,
+            wproc.MinimumWorkingSetSize,
+            wproc.Name,
+            wproc.OSCreationClassName,
+            wproc.OSName,
+            self.convert(wproc.OtherOperationCount),
+            self.convert(wproc.OtherTransferCount),
+            wproc.PageFaults,
+            wproc.PageFileUsage,
+            wproc.ParentProcessId,
+            self.convert(wproc.PeakPageFileUsage),
+            self.convert(wproc.PeakVirtualSize),
+            self.convert(wproc.PeakWorkingSetSize),
+            wproc.Priority,
+            self.convert(wproc.PrivatePageCount),
+            wproc.ProcessId,
+            wproc.QuotaNonPagedPoolUsage,
+            wproc.QuotaPagedPoolUsage,
+            wproc.QuotaPeakNonPagedPoolUsage,
+            wproc.QuotaPeakPagedPoolUsage,
+            self.convert(wproc.ReadOperationCount),
+            self.convert(wproc.ReadTransferCount),
+            wproc.SessionId,
+            wproc.Status,
+            self.parse_ms_date(wproc.TerminationDate),
+            wproc.ThreadCount,
+            self.convert(wproc.UserModeTime),
+            self.convert(wproc.VirtualSize),
+            wproc.WindowsVersion,
+            self.convert(wproc.WorkingSetSize),
+            self.convert(wproc.WriteOperationCount),
+            self.convert(wproc.WriteTransferCount)
+          )
+
+          ###############################################################
+          # On Windows XP or later, set the cmdline to the CommandLine
+          # attribute.  Otherwise, set it to the ExecutablePath
+          # attribute.
+          ###############################################################
+          if wproc.WindowsVersion.to_f < 5.1
+            struct.cmdline = wproc.ExecutablePath
+          else
+            struct.cmdline = wproc.CommandLine
+          end
+
+          struct.freeze # This is read-only data
+
+          if block_given?
+            yield struct
+          else
+            array << struct
+          end
+        }
+      end
+
+      pid ? struct : array
+    end
+
+    private
+
+    #######################################################################
+    # Converts a string in the format '20040703074625.015625-360' into a
+    # Ruby Time object.
+    #######################################################################
+    def self.parse_ms_date(str)
+      return if str.nil?
+      return DateTime.parse(str)
+    end
+
+    #####################################################################
+    # There is a bug in win32ole where uint64 types are returned as a
+    # String instead of a Fixnum.  This method deals with that for now.
+    #####################################################################
+    def self.convert(str)
+      return nil if str.nil? # Return nil, not 0
+      return str.to_i
+    end
+  end
+end