sys-uptime 0.4.5 → 0.5.0

data/CHANGES

@@ -1,3 +1,13 @@
+== 0.5.0 - 30-Mar-2007
+* For platforms that use C code, the code now always uses the sysctl()
+  function if supported by your system. This replaces the platform specific
+  checks I was doing for the various BSD flavors.
+* Fix for OS X - the Uptime.boot_time method now works.
+* UptimeError is now Uptime::Error.
+* Improved RDoc in the uptime.c source code.
+* Added a Rakefile - users should now use the 'test' and 'install' rake tasks.
+* Updates to the MANIFEST, README and uptime.txt files.
+
 == 0.4.5 - 19-Nov-2006
 * Internal layout changes, minor doc updates and gemspec improvements.
 * No code changes.

data/MANIFEST

@@ -1,17 +1,13 @@
-CHANGES
-MANIFEST
-README
-install.rb
-sys-uptime.gemspec
-
-doc/uptime.txt
-
-examples/test.rb
-
-ext/extconf.rb
-ext/uptime.c
-
-lib/sys/linux.rb
-lib/sys/windows.rb
-
-test/tc_uptime.rb
+* CHANGES
+* MANIFEST
+* Rakefile
+* README
+* install.rb
+* sys-uptime.gemspec
+* doc/uptime.txt
+* examples/test.rb
+* ext/extconf.rb
+* ext/uptime.c
+* lib/sys/linux.rb
+* lib/sys/windows.rb
+* test/tc_uptime.rb

data/README

@@ -4,17 +4,15 @@
 = Prerequisites
    Ruby 1.8.0 or later.
    Ruby 1.8.2 or later is recommended on MS Windows.
+   A C compiler, except for MS Windows.
 
 = Installation
-=== Unix:
-   ruby extconf.rb
-   make
-   ruby test/tc_uptime.rb (optional)
-   make install
-
-=== Windows and Linux:
-   ruby test\tc_uptime.rb (optional)
-   ruby install.rb
+=== Manual
+   rake test (optional)
+   rake install
+=== Gems
+   ruby sys-uptime.gemspec
+   gem install sys-uptime-X.Y.Z.gem # Where 'X.Y.Z' are version numbers
 
 == Notes
-   For additional documentation see doc/uptime.txt.
+   For additional documentation see doc/uptime.txt.

data/doc/uptime.txt

@@ -43,10 +43,12 @@ Uptime.uptime
    seconds the system has been running as a colon-separated string.
     
 == Exceptions
-UptimeError
-   Raised if something goes wrong.  On Unix, this would likely mean a
-   failure of the times() function.  On Windows, it probably means you
-   failed to connect to WMI properly.
+Uptime::Error
+   Raised if something goes wrong. On Unix, this would likely mean a
+   failure of the times() function. That would be highly unusual.
+   
+   On Windows, it probably means you failed to connect to WMI properly. The
+   mostly likely reason would be that the WMI service wasn't running.
     
 == Notes
    On MS Windows each of the class methods optionally takes a host name as
@@ -73,7 +75,7 @@ UptimeError
    Ruby's
     
 == Copyright
-   Copyright 2002-2006, Daniel J. Berger
+   Copyright 2002-2007, Daniel J. Berger
 
    All Rights Reserved. This module is free software. It may be used,
    redistributed and/or modified under the same terms as Ruby itself.
@@ -90,7 +92,7 @@ UptimeError
 
 == Author
    Daniel J. Berger
-   djberg96 at gmail dot com
+   djberg96 at nospam at gmail dot com
    imperator on IRC (Freenode)
     
 == See Also

data/ext/extconf.rb

@@ -1,29 +1,26 @@
-################################################
+##########################################################################
 # extconf.rb
 #
-# Configuration & build script for sys-uptime.
-################################################
+# Configuration & build script for sys-uptime. Generally speaking you
+# should build sys-uptime with the 'rake build' task instead of running
+# this script manually.
+##########################################################################
 require 'mkmf'
 require 'fileutils'
 
 if RUBY_PLATFORM =~ /windows|win32|cygwin|mingw|dos|linux/i
    STDERR.puts 'Run the "install.rb" script instead on this platform'
    exit
-else 
-   # Don't install the pure Ruby libraries during 'make install'.
-   if File.basename(Dir.pwd) =~ /ext|sys-uptime/i
-      Dir.chdir('..'){
-         if File.exists?('lib/sys/windows.rb')
-            FileUtils.mv('lib/sys/windows.rb', 'lib/sys/windows.orig')
-         end
-      
-         if File.exists?('lib/sys/linux.rb')
-            FileUtils.mv('lib/sys/linux.rb', 'lib/sys/linux.orig')
-         end
-      }
-   end
 end
 
 have_header('sys/loadavg.h')
-have_header('utmpx.h')
+
+if have_func('sysctl')
+   have_header('sys/param.h')
+   have_header('sys/time.h')
+   have_header('sys/types.h')
+else
+   have_header('utmpx.h')
+end
+
 create_makefile('sys/uptime')

data/ext/uptime.c

@@ -8,21 +8,27 @@
  * sys-uptime source code for most *nix platforms
  *****************************************************************************/
 #include <ruby.h>
+#include <string.h>
+#include <errno.h>
 
-#if defined (__FreeBSD__) || defined (__NetBSD__)
-#include <sys/time.h>
+#ifdef HAVE_SYSCTL
+
+#include <sys/sysctl.h>
 
-#if defined (__NetBSD__)
+#ifdef HAVE_SYS_PARAM_H
 #include <sys/param.h>
 #endif
 
-#if (__FreeBSD >= 5)
-#include <sys/types.h>
+#ifdef HAVE_SYS_TIME_H
+#include <sys/time.h>
 #endif
 
-#include <sys/sysctl.h>
+#ifdef HAVE_SYS_TYPES_H
+#include <sys/types.h>
+#endif
 
 #else
+
 #include <sys/times.h>
 #include <unistd.h>
 #include <time.h>
@@ -31,10 +37,6 @@
 #include <utmpx.h>
 #endif
 
-#ifdef HAVE_SYS_LOADAVG_H
-#include <sys/loadavg.h>
-#endif
-
 #ifdef _SC_CLK_TCK
 #define TICKS sysconf(_SC_CLK_TCK)
 #else
@@ -43,24 +45,29 @@
 
 #endif
 
+#ifdef HAVE_SYS_LOADAVG_H
+#include <sys/loadavg.h>
+#endif
+
 #define MAXSTRINGSIZE 32 /* reasonable limit */
 
-#define SYS_UPTIME_VERSION "0.4.5"
+#define SYS_UPTIME_VERSION "0.5.0"
 
 VALUE cUptimeError;
 
 unsigned long get_uptime_secs()
 {
-#if defined (__FreeBSD__) || defined (__NetBSD__)
+#ifdef HAVE_SYSCTL
    struct timeval tv;
    size_t tvlen = sizeof(tv);
    int mib[2];
 
    mib[0] = CTL_KERN;
    mib[1] = KERN_BOOTTIME;
-   if(sysctl(mib, 2, &tv, &tvlen, NULL, 0)){
-      rb_raise(cUptimeError, "sysctl() call failed");
-   }
+
+   if(sysctl(mib, 2, &tv, &tvlen, NULL, 0))
+      rb_raise(cUptimeError, "sysctl() call failed %s", strerror(errno));
+   
    return time(NULL) - tv.tv_sec;
 #else
    struct tms tms;
@@ -68,10 +75,10 @@ unsigned long get_uptime_secs()
    seconds = times(&tms) / TICKS;
    
    if(-1 == seconds)
-      rb_raise(cUptimeError,"times() function failed");
+      rb_raise(cUptimeError, "times() function failed: %s", strerror(errno));
       
    if(seconds < 0)
-      rb_raise(cUptimeError,"value returned larger than type could handle");
+      rb_raise(cUptimeError, "value returned larger than type could handle");
    
    return seconds;
 #endif
@@ -142,6 +149,7 @@ static VALUE uptime_uptime()
    seconds -= minutes*60;
 
    sprintf(c_string, "%ld:%ld:%ld:%ld", days, hours, minutes, seconds);
+
    return rb_str_new2(c_string);
 }
 
@@ -167,6 +175,7 @@ static VALUE uptime_dhms()
 	rb_ary_push(a, INT2FIX(h));
 	rb_ary_push(a, INT2FIX(m));
 	rb_ary_push(a, INT2FIX(s));
+
 	return a;
 }
 
@@ -177,17 +186,20 @@ static VALUE uptime_dhms()
  * Returns the boot time as a Time object.
  */
 static VALUE uptime_btime(){
-#if defined (__FreeBSD__) || defined (__NetBSD__)
+   VALUE v_time = Qnil;
+
+#ifdef HAVE_SYSCTL
    struct timeval tv;
    size_t tvlen = sizeof(tv);
    int mib[2];
 
    mib[0] = CTL_KERN;
    mib[1] = KERN_BOOTTIME;
-   if(sysctl(mib, 2, &tv, &tvlen, NULL, 0)){
-      rb_raise(cUptimeError,"sysctl() call failed");
-   }
-   return rb_time_new(tv.tv_sec,tv.tv_usec);
+
+   if(sysctl(mib, 2, &tv, &tvlen, NULL, 0))
+      rb_raise(cUptimeError, "sysctl() call failed: %s", strerror(errno));
+
+   v_time = rb_time_new(tv.tv_sec,tv.tv_usec);
 #else
 #ifdef HAVE_UTMPX_H
    struct utmpx* ent;
@@ -196,28 +208,36 @@ static VALUE uptime_btime(){
 
    while( (ent = getutxent()) ){
       if(ent->ut_type == BOOT_TIME){
-         return rb_time_new(ent->ut_tv.tv_sec,ent->ut_tv.tv_usec);
-      }      
+         v_time = rb_time_new(ent->ut_tv.tv_sec, ent->ut_tv.tv_usec);
+         break;
+      }
    }
 
    endutxent();
 #else
-   rb_raise(cUptimeError,"boot_time() not implemented on this platform");
+   rb_raise(cUptimeError, "boot_time method not implemented on this platform");
 #endif
 #endif
-   return Qnil;
+
+   return v_time;
 }
 
 void Init_uptime()
 {
    VALUE mSys, cUptime;
 
-   /* Modules and Classes */
+   /* The Sys module only serves as a toplevel namespace */
    mSys = rb_define_module("Sys");
+
+   /* The Uptime class contains several class methods for obtaining uptime 
+    * information.
+    */
    cUptime = rb_define_class_under(mSys, "Uptime", rb_cObject);
-   cUptimeError = rb_define_class_under(mSys, "UptimeError", rb_eStandardError);
+
+   /* The Uptime::Error class is raised if any of the Uptime methods fail */
+   cUptimeError = rb_define_class_under(cUptime, "Error", rb_eStandardError);
    
-   /* Constants */
+   /* 0.5.0: The version of this package, returned as a String */
    rb_define_const(cUptime, "VERSION", rb_str_new2(SYS_UPTIME_VERSION));
 
    /* Class Methods */

data/test/tc_uptime.rb

@@ -1,35 +1,16 @@
-#################################
+#####################################################################
 # tc_uptime.rb
 #
-# Test suite for sys-uptime.
-#################################
-base = File.basename(Dir.pwd)
-if base == 'test' || base =~ /sys-uptime.*/
-   require 'fileutils'
-   Dir.chdir('..') if base == 'test'
-   Dir.mkdir('sys') unless File.exists?('sys')
-
-   if RUBY_PLATFORM.match('mswin')
-      FileUtils.cp('lib/sys/windows.rb', 'sys/uptime.rb') rescue nil
-   elsif RUBY_PLATFORM.match('linux')
-      FileUtils.cp('lib/sys/linux.rb', 'sys/uptime.rb') rescue nil
-   else
-      require 'rbconfig'
-      file = 'ext/uptime.' + Config::CONFIG['DLEXT']
-      FileUtils.cp(file, 'sys')
-   end
-
-   $LOAD_PATH.unshift(Dir.pwd)
-   $LOAD_PATH.unshift(Dir.pwd + '/lib')
-end
-
+# Test suite for sys-uptime. This should generally be run via the
+# 'rake test' task, since it handles the pre-setup code for you.
+#####################################################################
 require 'sys/uptime'
 require 'test/unit'
 include Sys
 
 class TC_Uptime < Test::Unit::TestCase
    def test_version
-      assert_equal('0.4.5', Uptime::VERSION)
+      assert_equal('0.5.0', Uptime::VERSION)
    end
 
    def test_seconds
@@ -77,4 +58,8 @@ class TC_Uptime < Test::Unit::TestCase
       assert_nothing_raised{ Uptime.boot_time }
       assert_kind_of(Time, Uptime.boot_time)
    end
+
+   def test_uptime_error
+      assert_kind_of(StandardError, Uptime::Error.new)
+   end
 end

metadata

@@ -1,10 +1,10 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.0
+rubygems_version: 0.9.2
 specification_version: 1
 name: sys-uptime
 version: !ruby/object:Gem::Version 
-  version: 0.4.5
-date: 2006-11-20 00:00:00 -07:00
+  version: 0.5.0
+date: 2007-03-30 00:00:00 -06:00
 summary: A Ruby interface for getting system uptime information.
 require_paths: 
 - lib
@@ -34,8 +34,8 @@ files:
 - CHANGES
 - README
 - MANIFEST
-- ext/uptime.c
 - ext/extconf.rb
+- ext/uptime.c
 test_files: 
 - test/tc_uptime.rb
 rdoc_options: []