sys-cpu 0.6.1 → 0.6.2

data/CHANGES

@@ -1,3 +1,16 @@
+== 0.6.2 - ???
+* Fixed a bug in the cpu_freq function (which would only be noticed on
+  certain platforms in cases where the CPU.freq method failed). Thanks
+  go to Edho P Arief for the spot.
+* Explicitly add sys/param.h on OpenBSD, and default to the HW_MODEL mib
+  because HW_MACHINE does not exist. Thanks go to Edho P Arief for the patch.
+* Updated my support notes. In short I will support 1.8.6 and 1.9.x. I will
+  not support any 1.8.x branch later than 1.8.6.
+* Removed redundant information in the various .txt files that is already
+  covered in the README file.
+* Test files renamed.
+* Added test-unit 2.x as a development dependency.
+
 == 0.6.1 - 4-Jan-2009
 * Fix for OS X 10.5.x. Thanks go to Victor Costan for the spot and the patch.
 * Updated the gemspec and some other minor changes.

data/MANIFEST

@@ -9,11 +9,11 @@
 * doc/linux.txt
 * doc/sunos.txt
 * doc/windows.txt
-* examples/test_cpu_freebsd.rb
-* examples/test_cpu_hpux.rb
-* examples/test_cpu_linux.rb
-* examples/test_cpu_sunos.rb
-* examples/test_cpu_windows.rb
+* examples/example_sys_cpu_freebsd.rb
+* examples/example_sys_cpu_hpux.rb
+* examples/example_sys_cpu_linux.rb
+* examples/example_sys_cpu_sunos.rb
+* examples/example_sys_cpu_windows.rb
 * ext/extconf.rb
 * ext/version.h
 * ext/bsd/bsd.c
@@ -21,8 +21,9 @@
 * ext/sunos/sunos.c
 * lib/sys/linux.rb
 * lib/sys/windows.rb
-* test/tc_bsd.rb
-* test/tc_hpux.rb
-* test/tc_sunos.rb
-* test/tc_linux.rb
-* test/tc_windows.rb
+* test/test_sys_cpu.rb
+* test/test_sys_cpu_bsd.rb
+* test/test_sys_cpu_hpux.rb
+* test/test_sys_cpu_sunos.rb
+* test/test_sys_cpu_linux.rb
+* test/test_sys_cpu_windows.rb

data/README

@@ -1,19 +1,18 @@
-= Description
+== Description
    A Ruby interface for getting cpu information.
 
-= Installation
-== Standard Installation
-   rake test (optional)
-   rake install (non-gem)
-== Gem installation
-   rake test (optional)
-   ruby sys-cpu.gemspec
-   gem install sys-cpu-X.Y.Z.gem # where 'X.Y.Z' corresponds to the version.
+== Installation
+   gem install sys-cpu
+   gem install sys-cpu --platform mswin32 # MS Windows
 
-= Notes
+== Notes
 === All Platforms
    As of version 0.5.0 Ruby 1.8.0 or later is required.  It may work with
    earlier versions, but I will not support it.
+   
+   I do not support any Ruby 1.8.x branch after 1.8.6. It should work on those
+   versions of Ruby but if it breaks I'm not going to go out of my way to fix
+   it. I will, however, support the 1.9.x/2.x branch.
 
 === Solaris
    Currently there is no 'processors()' iterative method for multi-cpu systems.
@@ -39,8 +38,8 @@
    file after you run 'rake install' (via install.rb).
 
 === HP-UX
-   Unlike other platforms, you can get load averages for an individual cpu (in
-   multi-cpu systems). See documentation for more details.
+   Unlike other platforms, you can get load averages for an individual cpu in
+   multi-cpu systems. See documentation for more details.
 
 === MS Windows
    This is a pure Ruby implementation using the win32ole package + WMI. The C
@@ -51,29 +50,30 @@
    is no longer any delay.  Also, the 'processors' method has been
    added and the 'supported' method has been dropped.  See the documentation
    for other changes.
+   
+== Acknowledgements
+   Thanks go to the MPlayer team for some source code that helped me on
+   certain versions of FreeBSD.
 
-= Known Bugs
-   None that I'm aware of.  Please report bugs on the project page at
+== Known Bugs
+   None that I'm aware of. Please report bugs on the project page at
    http://www.rubyforge.org/projects/sysutils.
 
-= Future Plans
+== Future Plans
    Add iterative CPU.processors method.
    Make CPU.freq work on OS X.
    Add more information in general, such as what 'prtdiag' shows.
 
-= License
-   Ruby's.
+== License
+   Artistic 2.0
 
-= Copyright
-   (C) 2003-2007 Daniel J. Berger
-   All Rights Reserved
+== Copyright
+   (C) 2003-2009 Daniel J. Berger, All Rights Reserved
 
-= 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.
 
-= Author
+== Author
    Daniel J. Berger
-   djberg96 at nospam at gmail dot com
-   imperator on IRC (irc.freenode.net)

data/Rakefile

@@ -0,0 +1,95 @@
+require 'rake'
+require 'rake/clean'
+require 'rake/testtask'
+require 'rbconfig'
+
+desc "Clean the build files for the sys-cpu source for UNIX systems"
+task :clean do
+  FileUtils.rm_rf('sys') if File.exists?('sys')
+  FileUtils.rm_rf('lib/sys/cpu.rb') if File.exists?('lib/sys/cpu.rb')
+  Dir.chdir('ext') do
+    unless Config::CONFIG['host_os'] =~ /mswin|win32|mingw|cygwin|dos|linux/i
+      FileUtils.rm_rf('sys') if File.exists?('sys')
+      FileUtils.rm_rf('cpu.c') if File.exists?('cpu.c')
+      build_file = 'cpu.' + Config::CONFIG['DLEXT']
+      sh 'make distclean' if File.exists?(build_file)
+    end
+  end
+end
+
+desc "Build the sys-cpu library on UNIX systems (but don't install it)"
+task :build => [:clean] do
+  Dir.chdir('ext') do
+    unless Config::CONFIG['host_os'] =~ /mswin|win32|mingw|cygwin|dos|linux/i
+      ruby 'extconf.rb'
+      sh 'make'
+      build_file = 'cpu.' + Config::CONFIG['DLEXT']
+      Dir.mkdir('sys') unless File.exists?('sys')
+      FileUtils.cp(build_file, 'sys')
+    end
+  end
+end
+
+desc "Build the gem."
+task :gem do
+  spec = eval(IO.read('sys-cpu.gemspec'))
+  Gem::Builder.new(spec).build
+end
+
+if Config::CONFIG['host_os'] =~ /mswin|win32|mingw|cygwin|dos|linux/i
+  desc "Install the sys-cpu library"
+  task :install do
+    sh 'ruby install.rb'
+  end
+else
+  desc "Install the sys-cpu library"
+  task :install => [:build] do
+    Dir.chdir('ext') do
+      sh 'make install'
+    end
+  end
+end
+
+desc "Run the example program"
+task :example => [:build] do
+  Dir.mkdir('sys') unless File.exists?('sys')
+  if Config::CONFIG['host_os'] =~ /mswin|win32|mingw|cygwin|dos|linux/i
+    if Config::CONFIG['host_os'].match('linux')
+       FileUtils.cp('lib/sys/linux.rb', 'sys/cpu.rb')
+    else
+       FileUtils.cp('lib/sys/windows.rb', 'sys/cpu.rb')
+    end
+  else
+    build_file = 'ext/cpu.' + Config::CONFIG['DLEXT']
+    FileUtils.cp(build_file, 'sys')
+  end
+
+  case Config::CONFIG['host_os']
+    when /bsd|darwin|mach|osx/i
+      file = 'examples/test_cpu_bsd.rb'
+    when /hpux/i
+      file = 'examples/test_cpu_hpux.rb'
+    when /linux/i
+      file = 'examples/test_cpu_linux.rb'
+    when /sunos|solaris/i
+      file = 'examples/test_cpu_sunos.rb'
+    when /mswin|win32|cygwin|mingw|dos/i
+      file = 'examples/test_cpu_windows.rb'
+  end
+  sh "ruby -I. -Iext -Ilib #{file}"
+end
+
+Rake::TestTask.new do |t|
+  if Config::CONFIG['host_os'] =~ /mswin|win32|mingw|cygwin|dos|windows/i
+    t.libs << 'lib/windows'
+  elsif Config::CONFIG['host_os'] =~ /linux/i
+    t.libs << 'lib/linux'
+  else
+    task :test => :build
+    t.libs << 'ext'
+    t.libs.delete('lib')
+  end
+
+  t.libs << 'test'
+  t.test_files = FileList['test/test_sys_cpu.rb']
+end

data/doc/bsd.txt

@@ -1,7 +1,7 @@
-= Description
+== Description
    Sys::CPU - An interface for various cpu statistics
    
-= Synopsis
+== Synopsis
    require "sys/cpu"
    include Sys
 
@@ -13,11 +13,11 @@
    puts "CPU model: " + CPU.model
    puts "Load averages: " + CPU.load_avg.join(", ")
    
-= Constants
+== Constants
 VERSION
    Returns the current version number for this package.
     
-= Class Methods
+== Class Methods
 CPU.architecture
    Returns the cpu's architecture.
 
@@ -40,28 +40,10 @@ CPU.model
 CPU.num_cpu
    Returns an integer indicating the number of cpu's on the system.
     
-= Error Classes
+== Error Classes
 CPU::Error < StandardError
    Raised is response to internal function errors, usually relating to an
    invalid cpu number.
     
-= Known Bugs
-   None known.  Please post bug reports to the SourceForge home page at
-   http://www.rubyforge.org/projects/sysutils 
-    
-= Copyright
-   (C) 2003-2007 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.
-
-= License
-   Ruby's
-    
-= Author
-   Daniel J. Berger
-   djberg96 at nospam at gmail dot com
-   imperator on IRC (Freenode)
+== More Information
+See the README file for more information.

data/doc/hpux.txt

@@ -1,7 +1,7 @@
-= Description
+== Description
    Sys::CPU - An interface for various cpu statistics
    
-= Synopsis
+== Synopsis
    require "sys/cpu"
    include Sys
 
@@ -11,11 +11,11 @@
    puts "Number of active cpu's: " + CPU.num_active_cpu.to_s
    puts "Load averages: " + CPU.load_avg.join(", ")
    
-= Constants
+== Constants
 VERSION
    Returns the current version number for this package.
     
-= Class Methods
+== Class Methods
 CPU.architecture
    Returns the cpu architecture, e.g. PA RISC 1.2, etc.
     
@@ -45,31 +45,10 @@ CPU.num_cpu
 CPU.num_active_cpu
    Returns an integer indicating the number of active cpu's on the system.
     
-= Error Classes
+== Error Classes
 CPU::Error < StandardError
    Raised is response to internal function errors, usually relating to an
    invalid cpu number.
     
-= Known Bugs
-   No bugs known.  Please log any bugs at
-   http://www.rubyforge.org/projects/sysutils
-    
-= Future Plans
-   Add cpu model and type
-   
-= Copyright
-   (C) 2003-2007 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.
-    
-= License
-   Ruby's
-    
-= Author
-   Daniel J. Berger
-   djberg96 at nospam at gmail dot com
-   imperator on IRC (Freenode)
+== More Information
+See the README file for more information.

data/doc/sunos.txt

@@ -1,7 +1,7 @@
-= Description
+== Description
    Sys::CPU - An interface for various cpu statistics
    
-= Synopsis
+== Synopsis
    require "sys/cpu"
    include Sys
 
@@ -14,11 +14,11 @@
    puts "CPU model: " + CPU.model
    puts "Load averages: " + CPU.load_avg.join(", ")
    
-= Constants
+== Constants
 VERSION
    Returns the current version number for this package.
     
-= Class Methods
+== Class Methods
 CPU.freq(cpu_num=0)
    Returns an integer indicating the speed (i.e. frequency in Mhz) of
    'cpu_num', or CPU 0 if no number is provided.
@@ -47,32 +47,10 @@ CPU.num_cpu
 CPU.state(cpu_num)
    Returns a string indicating the cpu state of 'cpu_num'.
     
-= Error Classes
+== Error Classes
 CPU::Error < StandardError
    Raised is response to internal function errors, usually relating to an
    invalid cpu number.
     
-= Known Bugs
-   None known.  Please post bug reports to the SourceForge home page at
-   http://www.rubyforge.org/projects/sysutils
-    
-= Future Plans
-   Add more information, such as what prtdiag shows.
-   Get the model() method to display more specific information.
-    
-= Copyright
-   (C) 2003-2007 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.
-    
-= License
-   Ruby's
-    
-= Author
-   Daniel J. Berger
-   djberg96 at nospam at gmail dot com
-   imperator on IRC (Freenode)
+== More Information
+See the README file for more information.

data/doc/windows.txt

@@ -1,7 +1,7 @@
-= Description
+== Description
    Sys::CPU - An interface for various cpu statistics
     
-= Synopsis
+== Synopsis
    require "sys/cpu"
    include Sys
 
@@ -18,11 +18,11 @@
    puts "Model: " + CPU.model
    puts "Architecture: " + CPU.architecture
     
-= Constants
+== Constants
 VERSION
    Returns the current version number for this package.
     
-= Class Methods
+== Class Methods
 CPU.architecture(host=localhost)
    Returns the architecture of the cpu, e.g. x86 Family 15 Model 2
     
@@ -101,13 +101,13 @@ CPU.processors(host=localhost){ |cpu| ... }
 CPU.type(host=localhost)
     Returns a string indicating the type of processor, e.g. GenuineIntel.
     
-= Exception Classes
+== Exception Classes
 CPU::Error < StandardError
    Raised is response to internal function errors, most likely to be raised
    in the event that in invalid cpu number is provided for the 'freq'
    method.
     
-= Notes
+== Notes
    Some of the CPUStruct members may be nil.  As far as I can tell, this
    means that Windows is unable to determine the value for the attribute due
    to your BIOS and/or BIOS settings.  There is nothing clear in the
@@ -126,27 +126,5 @@ CPU::Error < StandardError
    frame) for a list of attributes and their meaning.  Link courtesy of
    tinyurl.com.	
 
-= Known Bugs
-   No bugs known.  Please log any bugs at
-   http://www.rubyforge.org/projects/sysutils
-
-= Future Plans
-   Add more detailed CPU usage information via the
-   Win32_PerfFormattedData_PerfOS_Processor class.
-    
-= Copyright
-   (C) 2003-2007 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.
-
-= License
-   Ruby's
-    
-= Author
-   Daniel J. Berger
-   djberg96 at nospam at gmail dot com
-   imperator/rubyhacker1 on IRC (Freenode)
+== More Information
+See the README file for more information.