sys-filesystem 0.1.0 → 0.1.1

data/CHANGES

@@ -1,2 +1,11 @@
+== 0.1.1 - 28-Mar-2007
+* Bug fix for BSD flavors.  Thanks go to Jeremy Kemper and Ole Christian
+  Rynning for the spot.
+* Bug fix for OS X (along the same lines as the BSD fix). Thanks go to
+  Aurelian Dehay for the spot.
+* Some Rdoc improvements for the C extension.
+* Tweaks to the gemspec.
+* Added synopsis to the README.
+
 == 0.1.0 - 17-Nov-2006
 * Initial release.  Alpha. Code is stable, but API is not.

data/MANIFEST

@@ -1,14 +1,11 @@
-MANIFEST
-CHANGES
-README
-install.rb
-extconf.rb
-sys-fileystem.gemspec
-
-examples/example_stat.rb
-
-ext/filesystem.c
-
-lib/sys/filesystem.rb
-
-test/tc_filesystem.rb
+* MANIFEST
+* CHANGES
+* Rakefile
+* README
+* install.rb
+* sys-fileystem.gemspec
+* examples/example_stat.rb
+* ext/extconf.rb
+* ext/filesystem.c
+* lib/sys/filesystem.rb
+* test/tc_filesystem.rb

data/README

@@ -6,15 +6,18 @@
 * windows-pr, 0.6.0 or later.
 
 = Installation
-=== MS Windows:
-   ruby test/tc_filesystem.rb (optional)
-   ruby install.rb
-
-=== All other platforms:
-   ruby extconf.rb
-   make
-   ruby test/tc_filesystem.rb (optional)
-   make install
+=== Manual Installation
+   rake test (optional)
+   rake install
+=== Gem Installation
+   ruby sys-filesystem.gemspec
+   gem install sys-filesystem-X.Y.Z.gem
+
+= Synopsis
+   require 'sys/filesystem'
+   include Sys
+   
+   p Filesystem.stat("/")
 
 = Notes
 === MS Windows
@@ -23,6 +26,10 @@
 === UNIX
    This is a C extension that wraps statvfs, etc.
 
+= Sample code
+   Run 'rake example' if you want to see a basic sample run. The actual code
+   is 'example_stat.rb' in the 'examples' directory. Modify it as you see fit.
+
 = Known Bugs
    None that I'm aware of.  Please report bugs on the project page at
    http://www.rubyforge.org/projects/sysutils.
@@ -35,7 +42,7 @@
    Park Heesob, for implementation and API ideas for the MS Windows version.
 
 = Copyright
-   (C) 2003-2006 Daniel J. Berger
+   (C) 2003-2007 Daniel J. Berger
    All Rights Reserved
 
 = Warranty

data/Rakefile

@@ -0,0 +1,70 @@
+require 'rake'
+require 'rake/clean'
+require 'rake/testtask'
+
+desc "Clean the build files for the sys-filesystem source for UNIX systems"
+task :clean do
+   Dir.chdir('examples') do
+      FileUtils.rm_rf('sys') if File.exists?('sys')
+   end
+
+   Dir.chdir('ext') do
+      unless RUBY_PLATFORM.match('mswin')
+         FileUtils.rm_rf('sys') if File.exists?('sys')
+         build_file = 'filesystem.' + Config::CONFIG['DLEXT']
+         sh 'make distclean' if File.exists?(build_file)
+      end
+   end
+end
+
+desc "Build the sys-filesystem 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 = 'filesystem.' + Config::CONFIG['DLEXT']
+         Dir.mkdir('sys') unless File.exists?('sys')
+         FileUtils.cp(build_file, 'sys')
+      end
+   end
+end
+
+if RUBY_PLATFORM.match('mswin')
+   desc "Install the sys-filesystem package"
+   task :install do
+      sh 'ruby install.rb'
+   end
+else
+   desc "Install the sys-filesystem package"
+   task :install => [:build] do
+      Dir.chdir('ext') do
+         sh 'make install'
+      end
+   end
+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_filesystem.rb']
+end
+
+desc "Run the example program"
+task :example => [:build] do |t|
+   Dir.chdir('examples') do
+      Dir.mkdir('sys') unless File.exists?('sys')
+   end
+
+   FileUtils.cp('ext/sys/filesystem.' + Config::CONFIG['DLEXT'], 'examples/sys')
+
+   Dir.chdir('examples') do
+      ruby 'example_stat.rb'
+   end
+end

data/ext/extconf.rb

@@ -0,0 +1,13 @@
+require 'mkmf'
+
+have_header("sys/mnttab.h")
+have_header("mntent.h")
+have_func("statvfs")
+
+if have_header("sys/statvfs.h")
+   have_struct_member("struct statvfs", "f_basetype", "sys/statvfs.h")
+else
+   have_header("sys/vnode.h")
+end
+
+create_makefile("sys/filesystem")

data/ext/filesystem.c

@@ -7,11 +7,17 @@
 #include <ruby.h>
 
 #include <sys/types.h>
+
+#ifdef HAVE_SYS_STATVFS_H /* Most flavors of UNIX */
 #include <sys/statvfs.h>
+#else                     /* FreeBSD 4.x */
+#include <sys/param.h>
+#include <sys/mount.h>
+#include <sys/vnode.h>
+#endif
 
-#ifdef HAVE_SYS_MNTTAB_H
+#ifdef HAVE_SYS_MNTTAB_H  /* Solaris */
 
-/* Solaris */
 #include <sys/mnttab.h>
 #define MNTENT	mnttab
 #define START_MNT(F,M) fopen(F,M)
@@ -19,15 +25,16 @@
 #define END_MNT(F) fclose(F)
 #define MOUNTLIST	"/etc/mnttab"
 
-#else
+#else /* Most flavors of UNIX */
 
-/* All other flavors of UNIX */
+#ifdef HAVE_MNTENT_H
 #include <mntent.h>
 #define MNTENT	mntent
 #define START_MNT(F,M) setmntent(F,M)
 #define GET_MNT(FP,MP) ((MP = getmntent(FP)) != NULL)
 #define END_MNT(F) endmntent(F)
 #define MOUNTLIST	"/etc/mtab"
+#endif
 
 #endif
 
@@ -41,11 +48,21 @@ VALUE mSys, cFilesys, cStat;
  */
 static VALUE fs_stat(VALUE klass, VALUE v_path){
    VALUE v_stat;
-   struct statvfs fs;
    char* path = StringValuePtr(v_path);
 
+#ifdef HAVE_STATVFS
+   struct statvfs fs;
+
    if(statvfs(path, &fs) < 0)
       rb_sys_fail("statvfs");
+#else
+   struct mount mp;
+   struct statfs fs;
+   struct proc p;
+
+   if(VFS_STATFS(&mp, &fs, &p) < 0)
+      rb_sys_fail("VFS_STATFS");  
+#endif
 
    v_stat = rb_funcall(cStat, rb_intern("new"), 0, 0);
 
@@ -104,10 +121,16 @@ static VALUE fixnum_to_gb(VALUE self){
 }
 
 void Init_filesystem(){
-   /* Classes and Modules */
-   mSys     = rb_define_module("Sys");
+   /* The toplevel namespace */
+   mSys = rb_define_module("Sys");
+
+   /* The Filesystem class serves an abstract base class. It's methods return
+    * objects of other types. Do not instantiate.
+    */
    cFilesys = rb_define_class_under(mSys, "Filesystem", rb_cObject);
-   cStat    = rb_define_class_under(cFilesys, "Stat", rb_cObject);
+
+   /* Instances of this class are returned by the Filesystem.stat method */
+   cStat = rb_define_class_under(cFilesys, "Stat", rb_cObject);
 
    /* Singleton methods */
    rb_define_singleton_method(cFilesys, "stat", fs_stat, 1);
@@ -155,17 +178,17 @@ void Init_filesystem(){
 
    /* Constants */
 
-   /* The version of this package */
-   rb_define_const(cFilesys, "VERSION", rb_str_new2("0.1.0"));
+   /* 0.1.1: The version of this package */
+   rb_define_const(cFilesys, "VERSION", rb_str_new2("0.1.1"));
 
-   /* Read only file system */
+   /* 0x00000001: Read only file system */
    rb_define_const(cStat, "RDONLY", INT2FIX(ST_RDONLY));
 
-   /* File system does not support suid or sgid semantics */
+   /* 0x00000002: File system does not support suid or sgid semantics */
    rb_define_const(cStat, "NOSUID", INT2FIX(ST_NOSUID));
 
 #ifdef ST_NOTRUNC
-   /* File system does not truncate file names longer than +name_max+ */
+   /* 0x00000003: File system does not truncate file names longer than +name_max+ */
    rb_define_const(cStat, "NOTRUNC", INT2FIX(ST_NOTRUNC));
 #endif
 

data/test/tc_unix.rb

@@ -2,19 +2,8 @@
 # tc_unix.rb
 #
 # Test case for the Sys::Filesystem.stat method and related stuff.
+# This test suite should be run via the 'rake test' task.
 ####################################################################
-base = File.basename(Dir.pwd)
-
-if base == 'test' || base =~ /filesystem/i
-   require 'fileutils'
-   require 'rbconfig'
-   Dir.chdir('..') if base == 'test'
-   Dir.mkdir('sys') rescue nil
-   file = 'filesystem.' + Config::CONFIG['DLEXT']
-   FileUtils.cp(file, 'sys')
-   $LOAD_PATH.unshift(Dir.pwd)
-end
-
 require 'test/unit'
 require 'sys/filesystem'
 include Sys
@@ -27,7 +16,7 @@ class TC_Filesystem_Unix < Test::Unit::TestCase
    end
 
    def test_version
-      assert_equal('0.1.0', Filesystem::VERSION)
+      assert_equal('0.1.1', Filesystem::VERSION)
    end
 
    def test_stat_path
@@ -93,7 +82,7 @@ class TC_Filesystem_Unix < Test::Unit::TestCase
       assert_kind_of(Fixnum, @stat.name_max)
    end
 
-   unless RUBY_PLATFORM.match('linux')
+   unless RUBY_PLATFORM =~ /linux|darwin/i
       def test_stat_base_type
          assert_respond_to(@stat, :base_type)
          assert_kind_of(String, @stat.base_type)
@@ -103,7 +92,7 @@ class TC_Filesystem_Unix < Test::Unit::TestCase
    def test_stat_constants
       assert_not_nil(Filesystem::Stat::RDONLY)
       assert_not_nil(Filesystem::Stat::NOSUID)
-      unless RUBY_PLATFORM.match('linux')
+      unless RUBY_PLATFORM =~ /linux|darwin/i
          assert_not_nil(Filesystem::Stat::NOTRUNC)
       end
    end

data/test/tc_windows.rb

@@ -1,11 +1,9 @@
 ####################################################################
-# tc_unix.rb
+# tc_windows.rb
 #
 # Test case for the Sys::Filesystem.stat method and related stuff.
+# This should be run via the 'rake test' task.
 ####################################################################
-Dir.chdir('..') if File.basename(Dir.pwd) == 'test'
-$LOAD_PATH.unshift(Dir.pwd + '/lib')
-
 require 'test/unit'
 require 'sys/filesystem'
 include Sys
@@ -18,7 +16,7 @@ class TC_Filesystem_Unix < Test::Unit::TestCase
    end
 
    def test_version
-      assert_equal('0.1.0', Filesystem::VERSION)
+      assert_equal('0.1.1', Filesystem::VERSION)
    end
 
    def test_stat_path

metadata

@@ -1,10 +1,10 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.0
+rubygems_version: 0.9.2
 specification_version: 1
 name: sys-filesystem
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
-date: 2006-11-17 00:00:00 -07:00
+  version: 0.1.1
+date: 2007-03-28 00:00:00 -06:00
 summary: A Ruby interface for getting file system information.
 require_paths: 
 - lib
@@ -35,7 +35,8 @@ files:
 - CHANGES
 - MANIFEST
 - README
-- extconf.rb
+- Rakefile
+- ext/extconf.rb
 - ext/filesystem.c
 test_files: 
 - test/tc_filesystem.rb
@@ -45,10 +46,11 @@ extra_rdoc_files:
 - CHANGES
 - README
 - MANIFEST
+- ext/filesystem.c
 executables: []
 
 extensions: 
-- extconf.rb
+- ext/extconf.rb
 requirements: []
 
 dependencies: []

data/extconf.rb

@@ -1,9 +0,0 @@
-require 'mkmf'
-require 'fileutils'
-
-have_header("sys/mnttab.h")
-have_struct_member("struct statvfs", "f_basetype", "sys/statvfs.h")
-
-FileUtils.cp('ext/filesystem.c', '.')
-
-create_makefile("sys/filesystem")