sys-uptime 0.4.5-i586-linux → 0.5.0-i586-linux

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/lib/sys/uptime.rb

@@ -1,14 +1,20 @@
 # On Linux, parse /proc/uptime
 module Sys
    class Uptime
-      VERSION = '0.4.5'
+      class Error < StandardError; end
+
+      VERSION = '0.5.0'
 
       @@file = '/proc/uptime'
 
       # Returns the uptime in seconds
       #
       def self.seconds
-         IO.readlines(@@file).to_s.split.first.to_i
+         begin
+            IO.readlines(@@file).to_s.split.first.to_i
+         rescue Exception => err
+            raise Error, err
+         end
       end
 
       # Returns the uptime in minutes

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

@@ -3,8 +3,8 @@ rubygems_version: 0.9.0
 specification_version: 1
 name: sys-uptime
 version: !ruby/object:Gem::Version 
-  version: 0.4.5
-date: 2006-11-20 00:00:00 -06:00
+  version: 0.5.0
+date: 2007-03-30 00:00:00 -05:00
 summary: A Ruby interface for getting system uptime information.
 require_paths: 
 - lib
@@ -34,7 +34,6 @@ files:
 - CHANGES
 - README
 - MANIFEST
-- ext/uptime.c
 - lib/sys/uptime.rb
 test_files: 
 - test/tc_uptime.rb
@@ -45,7 +44,6 @@ extra_rdoc_files:
 - README
 - MANIFEST
 - doc/uptime.txt
-- ext/uptime.c
 executables: []
 
 extensions: []

data/ext/uptime.c

@@ -1,231 +0,0 @@
-/******************************************************************************
- * uptime.c
- *
- * Authors:
- *    Daniel Berger
- *    Mike Hall
- *
- * sys-uptime source code for most *nix platforms
- *****************************************************************************/
-#include <ruby.h>
-
-#if defined (__FreeBSD__) || defined (__NetBSD__)
-#include <sys/time.h>
-
-#if defined (__NetBSD__)
-#include <sys/param.h>
-#endif
-
-#if (__FreeBSD >= 5)
-#include <sys/types.h>
-#endif
-
-#include <sys/sysctl.h>
-
-#else
-#include <sys/times.h>
-#include <unistd.h>
-#include <time.h>
-
-#ifdef HAVE_UTMPX_H
-#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
-#define TICKS sysconf(CLOCKS_PER_SEC)
-#endif
-
-#endif
-
-#define MAXSTRINGSIZE 32 /* reasonable limit */
-
-#define SYS_UPTIME_VERSION "0.4.5"
-
-VALUE cUptimeError;
-
-unsigned long get_uptime_secs()
-{
-#if defined (__FreeBSD__) || defined (__NetBSD__)
-   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 time(NULL) - tv.tv_sec;
-#else
-   struct tms tms;
-   unsigned long seconds;
-   seconds = times(&tms) / TICKS;
-   
-   if(-1 == seconds)
-      rb_raise(cUptimeError,"times() function failed");
-      
-   if(seconds < 0)
-      rb_raise(cUptimeError,"value returned larger than type could handle");
-   
-   return seconds;
-#endif
-}
-
-/*
- * call-seq:
- *    Uptime.seconds
- *
- * Returns the total number of seconds the system has been up.
- */
-static VALUE uptime_seconds()
-{
-   return UINT2NUM(get_uptime_secs());
-}
-
-/*
- * call-seq:
- *    Uptime.minutes
- * 
- * Returns the total number of minutes the system has been up.
- */
-static VALUE uptime_minutes()
-{
-   return UINT2NUM(get_uptime_secs() / 60);
-}
-
-/*
- * call-seq:
- *    Uptime.hours
- *
- * Returns the total number of hours the system has been up.
- */
-static VALUE uptime_hours()
-{
-   return UINT2NUM(get_uptime_secs() / 3600);
-}
-
-/*
- * call-seq:
- *    Uptime.days
- *
- * Returns the total number of days the system has been up.
- */
-static VALUE uptime_days()
-{
-   return UINT2NUM(get_uptime_secs() / 86400);
-}
-
-/*
- * call-seq:
- *    Uptime.uptime
- *
- * Calculates and returns the number of days, hours, minutes and
- * seconds the system has been running as a colon-separated string.
- */
-static VALUE uptime_uptime()
-{
-   char c_string[MAXSTRINGSIZE];
-   long seconds, days, hours, minutes;
- 
-   seconds = get_uptime_secs();
-   days = seconds/86400;
-   seconds -= days*86400;
-   hours = seconds/3600;
-   seconds -= hours*3600;
-   minutes = seconds/60;
-   seconds -= minutes*60;
-
-   sprintf(c_string, "%ld:%ld:%ld:%ld", days, hours, minutes, seconds);
-   return rb_str_new2(c_string);
-}
-
-/*
- * call-seq:
- *    Uptime.dhms
- *
- * Calculates and returns the number of days, hours, minutes and
- * seconds the system has been running as a four-element Array.
- */
-static VALUE uptime_dhms()
-{
-   VALUE a = rb_ary_new2(4);
-   long s, m, h, d;
-
-   s = get_uptime_secs();
-   d =  s                / (24*60*60);
-   h = (s -= d*24*60*60) / (   60*60);
-	m = (s -= h*   60*60) /        60;
-	s      -= m*      60;
-
-	rb_ary_push(a, INT2FIX(d));
-	rb_ary_push(a, INT2FIX(h));
-	rb_ary_push(a, INT2FIX(m));
-	rb_ary_push(a, INT2FIX(s));
-	return a;
-}
-
-/*
- * call-seq:
- *    Uptime.boot_time
- *
- * Returns the boot time as a Time object.
- */
-static VALUE uptime_btime(){
-#if defined (__FreeBSD__) || defined (__NetBSD__)
-   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);
-#else
-#ifdef HAVE_UTMPX_H
-   struct utmpx* ent;
- 
-   setutxent();
-
-   while( (ent = getutxent()) ){
-      if(ent->ut_type == BOOT_TIME){
-         return rb_time_new(ent->ut_tv.tv_sec,ent->ut_tv.tv_usec);
-      }      
-   }
-
-   endutxent();
-#else
-   rb_raise(cUptimeError,"boot_time() not implemented on this platform");
-#endif
-#endif
-   return Qnil;
-}
-
-void Init_uptime()
-{
-   VALUE mSys, cUptime;
-
-   /* Modules and Classes */
-   mSys = rb_define_module("Sys");
-   cUptime = rb_define_class_under(mSys, "Uptime", rb_cObject);
-   cUptimeError = rb_define_class_under(mSys, "UptimeError", rb_eStandardError);
-   
-   /* Constants */
-   rb_define_const(cUptime, "VERSION", rb_str_new2(SYS_UPTIME_VERSION));
-
-   /* Class Methods */
-   rb_define_singleton_method(cUptime, "seconds", uptime_seconds, 0);
-   rb_define_singleton_method(cUptime, "minutes", uptime_minutes, 0);
-   rb_define_singleton_method(cUptime, "hours",   uptime_hours,   0);
-   rb_define_singleton_method(cUptime, "days",    uptime_days,    0);
-   rb_define_singleton_method(cUptime, "uptime",  uptime_uptime,  0);
-   rb_define_singleton_method(cUptime, "dhms",    uptime_dhms,    0);
-   rb_define_singleton_method(cUptime, "boot_time", uptime_btime, 0);
-}