solaris-kstat 0.2.2 → 0.2.3

data/CHANGES

@@ -1,3 +1,10 @@
+== 0.2.3 - 23-Jul-2007
+* KstatError is now Kstat::Error.
+* Documentation improvements and updates.
+* Added a Rakefile with tasks for installation and testing.
+* Added a dir_config('kstat') to the extconf.rb file in case you should need it.
+* Internal project layout and code cleanup changes that you don't care about.
+
 == 0.2.2 - 10-Jul-2006
 * Updated the gemspec (and put a gem out on RubyForge).
 

data/MANIFEST

@@ -1,12 +1,10 @@
-CHANGES
-MANIFEST
-README
-extconf.rb
-solaris-kstat.gemspec
-
-examples/test.rb
-
-lib/solaris/rkstat.c
-lib/solaris/rkstat.h
-
-test/tc_kstat.rb
+* CHANGES
+* MANIFEST
+* README
+* Rakefile
+* solaris-kstat.gemspec
+* examples/test.rb
+* ext/extconf.rb
+* ext/solaris/rkstat.c
+* ext/solaris/rkstat.h
+* test/tc_kstat.rb

data/README

@@ -2,14 +2,17 @@
    Ruby extension for the Solaris kstat library.
    
 == Prerequisites
-   Solaris 8 or later.
+   Solaris 8 (2.8) or later.
    Ruby 1.8.x
 
 == Installation
-   ruby extconf.rb
-   make
-   ruby test/tc_kstat.rb (optional)
-   make site-install
+=== Manual Installation
+   rake test (optional)
+   rake install
+
+=== Gem Installation
+   rake test (optional)
+   rake install_gem
 
 == Synopsis
    require "solaris/kstat"
@@ -48,7 +51,7 @@ Kstat#record
    The more specific your criterion, the less data you will receive.
 
 == Error Classes
-KstatError < StandardError
+Kstat::Error < StandardError
    Raised if anything goes wrong.  Typically, this will only occur if you
    pass bad arguments to the constructor (e.g. a module name that doesn't
    exist, etc).
@@ -68,8 +71,9 @@ KstatError < StandardError
    I have noticed that results from the cpu_stat module differ from the output
    of the 'kstat' command line tool. I am convinced that my code is correct and
    that there is a bug in the Solaris::Kstat Perl module.  Unfortunately, the
-   source for the version of Solaris::Kstat that works on Solaris 8 and later is
-   not available (the version on CPAN only works on Solaris 6 and 7).
+   source for the version of the Solaris::Kstat Perl module that works on
+   Solaris 8 and later is not available (the version on CPAN only works on
+   Solaris 6 and 7).
 
    See http://tinyurl.com/karxw for more details.
    
@@ -77,13 +81,13 @@ KstatError < StandardError
    Thanks go to Charlie Mills for help with the 'volatile' issue.
 
 == Future Plans
-   Eliminate warnings that occur during the build process.
+   Eliminate warnings that occur during the build process, if possible.
    
 == License
    Ruby's
 
 == Copyright
-   (C) 2003-2006 Daniel J. Berger
+   (C) 2003-2007 Daniel J. Berger
    All Rights Reserved
     
 == Warranty
@@ -93,7 +97,7 @@ KstatError < StandardError
 	 
 == 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

@@ -0,0 +1,16 @@
+require 'mkmf'
+require 'fileutils'
+
+dir_config('kstat')
+
+FileUtils.cp('solaris/rkstat.c', '.')
+FileUtils.cp('solaris/rkstat.h', '.')
+
+# This package requires Solaris 2.8 or later
+unless have_header('kstat.h')
+   STDERR.puts "The kstat.h header file was not found. Exiting."
+   exit
+end
+
+have_library('kstat')
+create_makefile('solaris/kstat')

data/{lib → ext}/solaris/rkstat.c

@@ -21,15 +21,15 @@ VALUE cKstatError;
 
 static VALUE ks_allocate(VALUE klass){
    KstatStruct* ptr;
-   return Data_Make_Struct(klass,KstatStruct,0,ks_free,ptr);
+   return Data_Make_Struct(klass, KstatStruct, 0, ks_free, ptr);
 }
 
 /*
  * call-seq:
  *    Kstat.new(module=nil, instance=-1, name=nil)
  *
- * Creates and returns a Kstat object.  This does not traverse the kstat
- * chain.  The Kstat#record method uses the values passed to actually
+ * Creates and returns a Kstat object. This does NOT traverse the kstat
+ * chain. The Kstat#record method uses the values passed to actually
  * retrieve data.
  *
  * You may specify a module, an instance and a name.  The module defaults to
@@ -38,24 +38,24 @@ static VALUE ks_allocate(VALUE klass){
  */
 VALUE ks_init(int argc, VALUE* argv, VALUE self){
    KstatStruct* ptr;
-   VALUE rbModule, rbInstance, rbName;
+   VALUE v_module, v_instance, v_name;
 
    Data_Get_Struct(self,KstatStruct,ptr);
 
-   rb_scan_args(argc,argv,"03",&rbModule,&rbInstance,&rbName);
+   rb_scan_args(argc, argv, "03", &v_module, &v_instance, &v_name);
 
-   if(!NIL_P(rbModule)){
-      SafeStringValue(rbModule);
-      rb_iv_set(self,"@module",rbModule);
+   if(!NIL_P(v_module)){
+      SafeStringValue(v_module);
+      rb_iv_set(self, "@module", v_module);
    }
 
-   if(!NIL_P(rbName)){
-      SafeStringValue(rbName);
-      rb_iv_set(self,"@name",rbName);
+   if(!NIL_P(v_name)){
+      SafeStringValue(v_name);
+      rb_iv_set(self, "@name", v_name);
    }
 
-   if(!NIL_P(rbInstance))
-      rb_iv_set(self,"@instance",rbInstance);
+   if(!NIL_P(v_instance))
+      rb_iv_set(self, "@instance", v_instance);
 
    return self;
 }
@@ -66,7 +66,7 @@ VALUE ks_init(int argc, VALUE* argv, VALUE self){
  * The more specific your criterion, the less data you will receive.
  */
 VALUE ks_record(VALUE self){
-   volatile VALUE rbMHash, rbIHash, rbNHash, rbSHash;
+   volatile VALUE v_m_hash, v_i_hash, v_n_hash, v_s_hash;
    KstatStruct* ptr;
    kstat_io_t kio;
    kstat_timer_t kt;
@@ -75,38 +75,33 @@ VALUE ks_record(VALUE self){
    char* name;
    int instance = -1; /* -1 represents all instances (the default) */
 
-   VALUE rbModule, rbInstance, rbName;
+   VALUE v_module, v_instance, v_name;
 
    Data_Get_Struct(self,KstatStruct,ptr);
 
-   rbMHash = rb_hash_new(); /* Module name is key, holds rbIHashes   */
-   rbIHash = rb_hash_new(); /* Instance name is key, holds rbNHashes */
-   rbNHash = rb_hash_new(); /* Name is key, holds rbSHashes          */
+   v_m_hash = rb_hash_new(); /* Module name is key, holds v_i_hashes   */
+   v_i_hash = rb_hash_new(); /* Instance name is key, holds v_n_hashes */
+   v_n_hash = rb_hash_new(); /* Name is key, holds v_s_hashes          */
 
-   rbModule   = rb_iv_get(self,"@module");
-   rbInstance = rb_iv_get(self,"@instance");
-   rbName     = rb_iv_get(self,"@name");
+   v_module   = rb_iv_get(self, "@module");
+   v_instance = rb_iv_get(self, "@instance");
+   v_name     = rb_iv_get(self, "@name");
 
    /* Module is NULL by default (i.e. all modules are returned) */
-   if(NIL_P(rbModule)){
+   if(NIL_P(v_module))
       module = NULL;
-   }
-   else{
-      module = StringValuePtr(rbModule);
-   }
+   else
+      module = StringValuePtr(v_module);
 
    /* Instance defaults to -1 (i.e. all instances are returned) */
-   if(!NIL_P(rbInstance)){
-      instance = NUM2INT(rbInstance);
-   }
+   if(!NIL_P(v_instance))
+      instance = NUM2INT(v_instance);
 
    /* Name is NULL by default (i.e. all names are returned) */
-   if(NIL_P(rbName)){
+   if(NIL_P(v_name))
       name = NULL;
-   }
-   else{
-      name = StringValuePtr(rbName);
-   }
+   else
+      name = StringValuePtr(v_name);
 
    /* A failure probably means the module, instance or name doesn't exist */
    if((ptr->kc = kstat_open()) == NULL)
@@ -145,62 +140,67 @@ VALUE ks_record(VALUE self){
       /* Call the appropriate data mapper based on ks_type */
       switch(ptr->ksp->ks_type){
          case KSTAT_TYPE_NAMED:
-            kstat_read(ptr->kc,ptr->ksp,NULL);
-            rbSHash = map_named_data_type(ptr->ksp);
+            kstat_read(ptr->kc, ptr->ksp, NULL);
+            v_s_hash = map_named_data_type(ptr->ksp);
             break;
          case KSTAT_TYPE_IO:
-            kstat_read(ptr->kc,ptr->ksp,&kio);
-            rbSHash = map_io_data_type(&kio);
+            kstat_read(ptr->kc, ptr->ksp, &kio);
+            v_s_hash = map_io_data_type(&kio);
             break;
          case KSTAT_TYPE_TIMER:
-            kstat_read(ptr->kc,ptr->ksp,&kt);
-            rbSHash = map_timer_data_type(&kt);
+            kstat_read(ptr->kc, ptr->ksp, &kt);
+            v_s_hash = map_timer_data_type(&kt);
          case KSTAT_TYPE_INTR:
-            kstat_read(ptr->kc,ptr->ksp,NULL);
-            rbSHash = map_intr_data_type(ptr->ksp);
+            kstat_read(ptr->kc, ptr->ksp, NULL);
+            v_s_hash = map_intr_data_type(ptr->ksp);
             break;
          case KSTAT_TYPE_RAW:
-            kstat_read(ptr->kc,ptr->ksp,NULL);
-            rbSHash = map_raw_data_type(ptr->ksp);   
+            kstat_read(ptr->kc, ptr->ksp, NULL);
+            v_s_hash = map_raw_data_type(ptr->ksp);   
             break;
          default:
             rb_raise(cKstatError,"Unknown data record type");
       }
 
-      rb_hash_aset(rbNHash,rb_str_new2(ptr->ksp->ks_name),rbSHash);
-      rb_hash_aset(rbIHash,INT2FIX(ptr->ksp->ks_instance), rbNHash);
-      rb_hash_aset(rbMHash,rb_str_new2(ptr->ksp->ks_module),rbIHash);
+      rb_hash_aset(v_n_hash, rb_str_new2(ptr->ksp->ks_name), v_s_hash);
+      rb_hash_aset(v_i_hash, INT2FIX(ptr->ksp->ks_instance),  v_n_hash);
+      rb_hash_aset(v_m_hash, rb_str_new2(ptr->ksp->ks_module), v_i_hash);
 
       ptr->ksp = ptr->ksp->ks_next;
    }
 
-   return rbMHash;
+   return v_m_hash;
 }
 
-/*
- * Interface for Solaris kstat data.
- */
 void Init_kstat(){
    VALUE mSolaris, cKstat;
 
-   /* Module and Class declarations */
-   mSolaris    = rb_define_module("Solaris");
-   cKstat      = rb_define_class_under(mSolaris,"Kstat",rb_cObject);
-   cKstatError = rb_define_class_under(mSolaris,"KstatError",rb_eStandardError);
+   /* The Solaris module only serves as a toplevel namespace */
+   mSolaris = rb_define_module("Solaris");
+
+   /* The Kstat class encapsulates kstat (kernel statistics) information */
+   cKstat  = rb_define_class_under(mSolaris, "Kstat", rb_cObject);
+
+   /* The Kstat::Error class is raised if any of the Kstat methods fail */
+   cKstatError = rb_define_class_under(cKstat, "Error", rb_eStandardError);
 
-   rb_define_alloc_func(cKstat,ks_allocate);
+   rb_define_alloc_func(cKstat, ks_allocate);
 
    /* Instance Methods */
-   rb_define_method(cKstat,"initialize",ks_init,-1);
-   rb_define_method(cKstat,"record",ks_record,0);
+   rb_define_method(cKstat, "initialize", ks_init, -1);
+   rb_define_method(cKstat, "record", ks_record, 0);
+
+   /* Kernel module */
+   rb_define_attr(cKstat, "module", 1, 1);
+
+   /* Index of module entity */
+   rb_define_attr(cKstat, "instance", 1, 1);
 
-   /* Attributes */
-   rb_define_attr(cKstat,"module",1,1);
-   rb_define_attr(cKstat,"instance",1,1);
-   rb_define_attr(cKstat,"name",1,1);
+   /* Unique name within module */
+   rb_define_attr(cKstat, "name", 1, 1);
 
-   /* Constants */
-   rb_define_const(cKstat,"VERSION",rb_str_new2(SOLARIS_KSTAT_VERSION));
+   /* 0.2.3: The version of this package, returned as a String */
+   rb_define_const(cKstat, "VERSION", rb_str_new2(SOLARIS_KSTAT_VERSION));
 }
 
 #ifdef __cplusplus

data/{lib → ext}/solaris/rkstat.h

@@ -2,7 +2,7 @@
 extern "C" {
 #endif
 
-#define SOLARIS_KSTAT_VERSION "0.2.2"
+#define SOLARIS_KSTAT_VERSION "0.2.3"
 
 /* Function prototypes */
 static VALUE map_named_data_type(kstat_t* ksp);

data/test/tc_kstat.rb

@@ -1,17 +1,9 @@
 ###############################################################################
 # tc_kstat.rb
 #
-# Test suite for the solaris-kstat Ruby package.
+# Test suite for the solaris-kstat Ruby package. You should run this via
+# the 'rake test' task.
 ###############################################################################
-base = File.basename(Dir.pwd)
-if base == "test" || base =~ /solaris-kstat.*/
-   require "ftools"
-   Dir.chdir("..") if base == "test"
-   Dir.mkdir("solaris") unless File.exists?("solaris")
-   File.copy("kstat.so","solaris")
-   $LOAD_PATH.unshift Dir.pwd
-end
-
 require "solaris/kstat"
 require "test/unit"
 require "set"
@@ -23,7 +15,7 @@ class TC_Kstat < Test::Unit::TestCase
    end
 
    def test_version
-      assert_equal("0.2.2", Kstat::VERSION)
+      assert_equal("0.2.3", Kstat::VERSION)
    end
 
    def test_name
@@ -57,9 +49,9 @@ class TC_Kstat < Test::Unit::TestCase
    end
 
    def test_constructor_invalid_values
-      assert_raises(KstatError){ Kstat.new("bogus").record }
-      assert_raises(KstatError){ Kstat.new("cpu_info",99).record }
-      assert_raises(KstatError){ Kstat.new("cpu_info",0,"bogus").record }
+      assert_raises(Kstat::Error){ Kstat.new("bogus").record }
+      assert_raises(Kstat::Error){ Kstat.new("cpu_info",99).record }
+      assert_raises(Kstat::Error){ Kstat.new("cpu_info",0,"bogus").record }
       assert_raises(TypeError){ Kstat.new("cpu_info","x").record }
    end
 

metadata

@@ -1,10 +1,10 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.0
+rubygems_version: 0.9.4
 specification_version: 1
 name: solaris-kstat
 version: !ruby/object:Gem::Version 
-  version: 0.2.2
-date: 2006-07-11 00:00:00 -06:00
+  version: 0.2.3
+date: 2007-07-24 00:00:00 -06:00
 summary: Interface for the Solaris kstat library
 require_paths: 
 - lib
@@ -29,14 +29,15 @@ post_install_message:
 authors: 
 - Daniel J. Berger
 files: 
-- CHANGES
-- README
-- MANIFEST
-- extconf.rb
-- lib/solaris/rkstat.c
-- lib/solaris/rkstat.h
+- ext/extconf.rb
+- ext/solaris
+- ext/solaris/rkstat.c
+- ext/solaris/rkstat.h
 - test/tc_kstat.rb
 - examples/test.rb
+- README
+- CHANGES
+- MANIFEST
 test_files: 
 - test/tc_kstat.rb
 rdoc_options: []
@@ -44,10 +45,12 @@ rdoc_options: []
 extra_rdoc_files: 
 - README
 - CHANGES
+- MANIFEST
+- ext/solaris/rkstat.c
 executables: []
 
 extensions: 
-- extconf.rb
+- ext/extconf.rb
 requirements: []
 
 dependencies: []

data/extconf.rb

@@ -1,14 +0,0 @@
-require "mkmf"
-require "ftools"
-
-File.copy("lib/solaris/rkstat.c",".")
-File.copy("lib/solaris/rkstat.h",".")
-
-# This package requires Solaris 2.8 or later
-unless have_header("kstat.h")
-   STDERR.puts "The kstat.h header file was not found.  Exiting."
-   exit
-end
-
-have_library("kstat")
-create_makefile("solaris/kstat")