sys-uname 0.7.4 → 0.8.0

data/CHANGES

@@ -1,3 +1,15 @@
+== 0.8.0 - 10-Apr-2007
+* The Uname.model method should now work on most BSD platforms, not just OS X,
+  since it uses the sysctl() function behind the scenes.
+* The 'id' method was changed to 'id_number' on HP-UX to avoid confusion with
+  the Object.id method.
+* The UnameError class is now Uname::Error.
+* Added a Rakefile. There are now tasks for building, testing and installing
+  this package.
+* Removed some pre-setup code from the test suite that was no longer necessary
+  as a result of the Rake test task.
+* No code changes.
+
 == 0.7.4 - 19-Nov-2006
 * Internal layout changes, doc updates and gemspec improvements.
 * No code changes.

data/MANIFEST

@@ -1,16 +1,12 @@
-install.rb
-MANIFEST
-CHANGES
-README
-sys-uname.gemspec
-
-doc/uname.txt
-
-examples/uname_test.rb
-
-ext/extconf.rb
-ext/uname.c
-
-lib/sys/uname.rb
-
-test/tc_uname.rb
+* install.rb
+* MANIFEST
+* CHANGES
+* Rakefile
+* README
+* sys-uname.gemspec
+* doc/uname.txt
+* examples/uname_test.rb
+* ext/extconf.rb
+* ext/uname.c
+* lib/sys/uname.rb
+* test/tc_uname.rb

data/README

@@ -6,14 +6,8 @@
    Active WMI service (normally on by default).
 
 = Installation
-=== Unix
-   ruby extconf.rb
-   make
-   ruby test/tc_uname.rb (optional)
-   make site-install
-=== MS Windows
-   ruby test\tc_uname.rb (optional)
-   ruby install.rb
+   rake test (optional)
+   rake install (non-gem) or rake install_gem (gems)
    
 = Synopsis
    require 'sys/uname'
@@ -25,12 +19,13 @@
    Folks building this package on SunOS get two extra methods: architecture()
    and platform()
 
-= OS X Notes
-   OS X users get the extra method "model()".
+= BSD flavors, including OS X
+   Users on BSD platforms get the extra Uname.model method.
 
 = HP-UX Notes
-   HP-UX users get the extra method "id()".  This is actually a String, not
-   a Fixnum, because that's how it's defined in the utsname struct.
+   HP-UX users get the extra Uname.id_number method.  This is actually a
+   String, not a Fixnum, because that's how it's defined in the utsname
+   struct.
 
 = MS Windows Notes
    The C version for Windows has been completely scrapped in favor of an OLE
@@ -39,4 +34,4 @@
    UnameStruct members mean.
 
 = Documentation
-  For more details, see the 'uname.txt' file under the 'doc' directory. 
+  For more details, see the 'uname.txt' file under the 'doc' directory. 

data/Rakefile

@@ -0,0 +1,72 @@
+require 'rake'
+require 'rake/clean'
+require 'rake/testtask'
+
+desc "Clean the build files for the sys-uname source for UNIX systems"
+task :clean do
+   FileUtils.rm_rf('sys') if File.exists?('sys')
+
+   Dir.chdir('ext') do
+      unless RUBY_PLATFORM.match('mswin')
+         FileUtils.rm_rf('sys') if File.exists?('sys')
+         build_file = 'uname.' + Config::CONFIG['DLEXT']
+         sh 'make distclean' if File.exists?(build_file)
+      end
+   end
+end
+
+desc "Build the sys-uname package on UNIX systems (but don't install it)"
+task :build => [:clean] do
+   Dir.chdir('ext') do
+      unless RUBY_PLATFORM.match('mswin')
+         ruby 'extconf.rb'
+         sh 'make'
+         build_file = 'uname.' + Config::CONFIG['DLEXT']
+         Dir.mkdir('sys') unless File.exists?('sys')
+         FileUtils.cp(build_file, 'sys')
+      end
+   end
+end
+
+desc "Run the example program"
+task :example => [:build] do
+   Dir.mkdir('sys') unless File.exists?('sys')
+   if RUBY_PLATFORM.match('mswin')
+      sh 'ruby -Ilib examples/uname_test.rb'
+   else
+      sh 'ruby -Iext examples/uname_test.rb'
+   end
+end
+
+if RUBY_PLATFORM.match('mswin')
+   desc "Install the sys-uname package (non-gem)"
+   task :install do
+      sh 'ruby install.rb'
+   end
+else
+   desc "Install the sys-uname package"
+   task :install => [:build] do
+      Dir.chdir('ext') do
+         sh 'make install'
+      end
+   end
+end
+
+desc "Install the sys-uname package as a gem"
+task :install_gem do
+   ruby 'sys-uname.gemspec'
+   file = Dir['sys-uname*.gem'].first
+   sh "gem install #{file}"
+end
+
+desc "Run the test suite"
+Rake::TestTask.new("test") do |t|
+   if RUBY_PLATFORM.match('mswin')
+      t.libs << 'lib'
+   else
+      task :test => :build
+      t.libs << 'ext'
+      t.libs.delete('lib')
+   end
+   t.test_files = FileList['test/tc_uname.rb']
+end

data/doc/uname.txt

@@ -76,7 +76,7 @@ Uname.dhcp_cache
    interface configured by boot(1M) followed by the DHCPACK reply from
    the server.
     
-== OS X Only
+== BSD Platforms Only (including OS X)
 Uname.model
    Returns the model type,  e.g. "PowerBook5,1"
     
@@ -105,7 +105,7 @@ Uname.id
    Ruby's
 
 == Copyright
-   (C) 2002-2006 Daniel J. Berger
+   (C) 2002-2007 Daniel J. Berger
    All Rights Reserved
 
 == Warranty
@@ -115,8 +115,8 @@ Uname.id
 
 == Author
    Daniel Berger
-   djberg96 at gmail dot com
+   djberg96 at nospam at gmail dot com
    imperator on IRC (Freenode)
 	
 == See Also
-   uname(1) for unix, or WMI for MS Windows.
+   uname(1) for unix, or WMI for MS Windows.

data/ext/extconf.rb

@@ -1,28 +1,9 @@
-##########################
-# extconf.rb - sys-uname
-##########################
 require 'mkmf'
 
-if PLATFORM.match('mswin')
-   STDERR.puts "Run 'ruby install.rb' instead for Windows"
-   STDERR.puts "Exiting..."
-   exit
-end
+have_func('sysctl')
 
 if RUBY_PLATFORM =~ /sunos|solaris/i
    have_header('sys/systeminfo.h')
 end
 
-########################################################################
-# Move any ".rb" files under 'lib/sys/' to ".orig" to prevent mkmf from
-# installing them during the 'make install' phase.
-########################################################################
-if File.basename(Dir.pwd) == 'ext'
-   Dir.chdir('..'){
-      Dir["lib/sys/*.rb"].each{ |f|
-         File.rename(f, 'lib/sys/' + File.basename(f, '.rb')+ '.orig')
-      }
-   }
-end
-
 create_makefile('sys/uname')

data/ext/uname.c

@@ -1,14 +1,12 @@
 /******************************************************************************
- * unix.c (uname.c) - Ruby Extension for *nix (POSIX?) operating systems.
+ * uname.c - Ruby extension for returning uname information on Unix platforms.
  *
- * Author(s):
- *    Daniel Berger (primary)
- *    Mike Hall (OS X patch)
+ * Author: Daniel Berger
  *****************************************************************************/
-#include "ruby.h"
+#include <ruby.h>
 #include <sys/utsname.h>
 
-#define SYS_UNAME_VERSION "0.7.4"
+#define SYS_UNAME_VERSION "0.8.0"
 
 /* Solaris */
 #ifdef HAVE_SYS_SYSTEMINFO_H
@@ -16,10 +14,10 @@
 #include <sys/systeminfo.h>
 #endif
 
-/* OS X - use Darwin's 'sysctl()' to get the model name */
-#if defined(__MACH__) && defined(__APPLE__)
+/* BSD platforms, including OS X */
+#ifdef HAVE_SYSCTL
 #include <sys/sysctl.h>
-static int getmodel(char *buf, int n)
+static int get_model(char *buf, int n)
 {
    size_t sz = n;
    int mib[2];
@@ -40,7 +38,7 @@ VALUE sUname;
 /*
  * Returns a struct of type UnameStruct that contains sysname, nodename,
  * machine, version, and release.  On Solaris, it will also include 
- * architecture and platform.  On HP-UX, it will also include id.
+ * architecture and platform.  On HP-UX, it will also include id_number.
  */
 static VALUE uname_uname_all()
 {
@@ -52,13 +50,13 @@ static VALUE uname_uname_all()
 #ifdef HAVE_SYS_SYSTEMINFO_H
    char platform[BUFSIZE];
    char arch[BUFSIZE];
-   sysinfo(SI_ARCHITECTURE,arch,BUFSIZE);
-   sysinfo(SI_PLATFORM,platform,BUFSIZE);
+   sysinfo(SI_ARCHITECTURE, arch, BUFSIZE);
+   sysinfo(SI_PLATFORM, platform, BUFSIZE);
 #endif
 
-#if defined(__MACH__) && defined(__APPLE__)
+#ifdef HAVE_SYSCTL
    char model[BUFSIZ];
-   getmodel(model, sizeof(model));
+   get_model(model, sizeof(model));
 #endif
 
    return rb_struct_new(sUname,
@@ -72,7 +70,7 @@ static VALUE uname_uname_all()
       rb_str_new2(platform)
 #endif
 
-#if defined(__MACH__) && defined(__APPLE__)
+#ifdef HAVE_SYSCTL
       ,rb_str_new2(model)
 #endif
 
@@ -125,7 +123,7 @@ static VALUE uname_release()
 }
 
 /*
- * Returns the operating system name.  e.g. "SunOS".
+ * Returns the operating system name. e.g. "SunOS".
  */
 static VALUE uname_sysname()
 {
@@ -141,17 +139,17 @@ static VALUE uname_sysname()
 static VALUE uname_architecture()
 {
    char buf[BUFSIZE];
-   sysinfo(SI_ARCHITECTURE,buf,BUFSIZE);
+   sysinfo(SI_ARCHITECTURE, buf, BUFSIZE);
    return rb_str_new2(buf);
 }
 
 /* 
- * Returns the platform identifier.  e.g. "SUNW,Sun-Blade-100".
+ * Returns the platform identifier. e.g. "SUNW,Sun-Blade-100".
  */
 static VALUE uname_platform()
 {
    char buf[BUFSIZE];
-   sysinfo(SI_PLATFORM,buf,BUFSIZE);
+   sysinfo(SI_PLATFORM, buf, BUFSIZE);
    return rb_str_new2(buf);
 }
 
@@ -165,7 +163,7 @@ static VALUE uname_platform()
 static VALUE uname_isalist()
 {
    char buf[BUFSIZE];
-   sysinfo(SI_ISALIST,buf,BUFSIZE);
+   sysinfo(SI_ISALIST, buf, BUFSIZE);
    return rb_str_new2(buf);
 }
 #endif
@@ -176,7 +174,7 @@ static VALUE uname_isalist()
 static VALUE uname_hw_provider()
 {
    char buf[BUFSIZE];
-   sysinfo(SI_HW_PROVIDER,buf,BUFSIZE);
+   sysinfo(SI_HW_PROVIDER, buf, BUFSIZE);
    return rb_str_new2(buf);
 }
 
@@ -187,7 +185,7 @@ static VALUE uname_hw_provider()
 static VALUE uname_hw_serial()
 {
    char buf[BUFSIZE];
-   sysinfo(SI_HW_SERIAL,buf,BUFSIZE);
+   sysinfo(SI_HW_SERIAL, buf, BUFSIZE);
    return rb_Integer(rb_str_new2(buf));
 }
 
@@ -197,7 +195,7 @@ static VALUE uname_hw_serial()
 static VALUE uname_srpc_domain()
 {
    char buf[BUFSIZE];
-   sysinfo(SI_SRPC_DOMAIN,buf,BUFSIZE);
+   sysinfo(SI_SRPC_DOMAIN, buf, BUFSIZE);
    return rb_str_new2(buf);
 }
 
@@ -210,27 +208,27 @@ static VALUE uname_srpc_domain()
 static VALUE uname_dhcp_cache()
 {
    char buf[BUFSIZE];
-   sysinfo(SI_DHCP_CACHE,buf,BUFSIZE);
+   sysinfo(SI_DHCP_CACHE, buf, BUFSIZE);
    return rb_str_new2(buf);
 }
 #endif
 #endif
 
-#if defined(__MACH__) && defined(__APPLE__)
+#ifdef HAVE_SYSCTL
 /*
  * Returns the model type, e.g. "PowerBook5,1"
  */
 static VALUE uname_model()
 {
    char model[BUFSIZ];
-   getmodel(model, sizeof(model));
+   get_model(model, sizeof(model));
    return rb_str_new2(model);
 }
 #endif
 
 #if defined(__hpux)
 /*
- * Returns the id number, e.g. 234233587.  This is a String, not a Fixnum.
+ * Returns the id number, e.g. 234233587. This is a string, not a number.
  */
 static VALUE uname_id()
 {
@@ -243,10 +241,15 @@ static VALUE uname_id()
 /* An interface for returning uname (platform) information. */
 void Init_uname()
 {
-   VALUE sys_mSys, cUname;
+   VALUE mSys, cUname;
 
-   sys_mSys = rb_define_module("Sys");
-   cUname = rb_define_class_under(sys_mSys, "Uname", rb_cObject);
+   /* The Sys module serves only as a toplevel namespace */
+   mSys = rb_define_module("Sys");
+
+   /* The Uname serves as the base class from which system information can
+    * be obtained via various class methods.
+    */
+   cUname = rb_define_class_under(mSys, "Uname", rb_cObject);
 
    rb_define_singleton_method(cUname, "sysname", uname_sysname, 0);
    rb_define_singleton_method(cUname, "nodename",uname_nodename,0);
@@ -269,26 +272,29 @@ void Init_uname()
 #endif
 #endif
 
-#if defined(__MACH__) && defined(__APPLE__)
+#ifdef HAVE_SYSCTL
    rb_define_singleton_method(cUname, "model", uname_model, 0);
 #endif
 
 #if defined(__hpux)
-   rb_define_singleton_method(cUname, "id", uname_id, 0);
+   rb_define_singleton_method(cUname, "id_number", uname_id, 0);
 #endif
 
+   /* The UnameStruct encapsulates information associated with system
+    * information, such as operating system version, release, etc.
+    */
    sUname = rb_struct_define("UnameStruct","sysname","nodename",
       "machine","version","release",
 #ifdef HAVE_SYS_SYSTEMINFO_H
       "architecture","platform",
 #endif
 
-#if defined(__MACH__) && defined(__APPLE__)
+#ifdef HAVE_SYSCTL
       "model",
 #endif
 
 #if defined(__hpux)
-      "id",
+      "id_number",
 #endif
    NULL);
 

data/test/tc_uname.rb

@@ -1,30 +1,9 @@
 ##############################################################################
 # tc_uname.rb
 #
-# Test suite for the sys-uname package.
+# Test suite for the sys-uname package. This test suite should be run via
+# the 'rake test' task.
 ##############################################################################
-base = File.basename(Dir.pwd)
-
-if base == 'test' || base =~ /sys-uname/
-   Dir.chdir('..') if base == 'test'
-   
-   if RUBY_PLATFORM.match('mswin')
-      $LOAD_PATH.unshift(Dir.pwd + '/lib')
-   else
-      require 'ftools'
-      require 'rbconfig'
-      Dir.mkdir('sys') unless File.exists?('sys')
-      file = 'uname.' + Config::CONFIG['DLEXT']
-      if File.exists?(file)
-         File.copy(file, 'sys')
-      else
-         File.copy('ext/' + file, 'sys')
-      end
-   end
-
-   $LOAD_PATH.unshift(Dir.pwd)
-end
-
 require 'sys/uname'
 require 'test/unit'
 include Sys
@@ -39,7 +18,7 @@ class TC_Uname < Test::Unit::TestCase
       assert_not_nil(Uname::VERSION)
       assert_nothing_raised{ Uname::VERSION }
       assert_kind_of(String, Uname::VERSION)
-      assert_equal('0.7.4', Uname::VERSION)
+      assert_equal('0.8.0', Uname::VERSION)
    end
  
    def test_machine
@@ -143,7 +122,7 @@ class TC_Uname < Test::Unit::TestCase
    end
    
    def test_model
-      if RUBY_PLATFORM =~ /darwin|powerpc/i
+      if RUBY_PLATFORM =~ /darwin|powerpc|bsd|mach/i
          assert_respond_to(Uname, :model)
          assert_nothing_raised{ Uname.model }
          assert_kind_of(String, Uname.model)
@@ -152,13 +131,13 @@ class TC_Uname < Test::Unit::TestCase
       end
    end
    
-   def test_id
+   def test_id_number
       if RUBY_PLATFORM =~ /hpux/i
-         assert_respond_to(Uname, :id)
-         assert_nothing_raised{ Uname.id }
-         assert_kind_of(String, Uname.id)
+         assert_respond_to(Uname, :id_number)
+         assert_nothing_raised{ Uname.id_number }
+         assert_kind_of(String, Uname.id_number)
       else
-         puts '"id" test skipped on this platform'
+         puts '"test_id_number" test skipped on this platform'
       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-uname
 version: !ruby/object:Gem::Version 
-  version: 0.7.4
-date: 2006-11-19 00:00:00 -07:00
+  version: 0.8.0
+date: 2007-04-11 00:00:00 -06:00
 summary: An interface for returning uname (platform) information
 require_paths: 
 - lib
@@ -31,9 +31,10 @@ authors:
 files: 
 - doc/uname.txt
 - test/tc_uname.rb
-- README
 - CHANGES
 - MANIFEST
+- README
+- Rakefile
 - ext/extconf.rb
 - ext/uname.c
 test_files: 
@@ -45,6 +46,7 @@ extra_rdoc_files:
 - README
 - MANIFEST
 - doc/uname.txt
+- ext/uname.c
 executables: []
 
 extensions: