io-extra 1.0.1 → 1.0.2

data/CHANGES

@@ -1,3 +1,11 @@
+== 1.0.2 - 16-Jul-2007
+* Added a Rakefile with tasks for testing and installation.
+* Some doc updates and internal reorganization, but no significant code
+  changes.
+* Fixed an "implicit declaration" build warning (the man page was
+  mistaken about the header file I should use).
+* Minor updates to the example program.
+
 == 1.0.1 - 7-Jul-2006
 * Added a gemspec.
 * Added or improved the inline rdoc comments in the source.

data/MANIFEST

@@ -0,0 +1,10 @@
+* MANIFEST
+* README
+* CHANGES
+* Rakefile
+* io-extra.gemspec
+* doc/io_extra.txt
+* examples/test.rb
+* ext/extconf.rb
+* ext/io/extra.c
+* test/tc_ioextra.rb

data/README

@@ -2,17 +2,20 @@
 The io-extra package provides a few extra IO methods that you may find
 handy.  They are IO.closefrom, IO.fdwalk, IO#directio? and IO#directio=.
 	
-Not supported on MS Windows.
+Not supported on MS Windows or OS X.
 
 = Installation
-   ruby extconf.rb
-   make
-   ruby test/tc_ioextra.rb (optional)
-   make site-install
+== Standard Installation
+   rake test (optional)
+   rake install
+
+== Gem Installation
+   rake test (optional)
+   rake install_gem
 
 = Developer's Notes
-== Q) What is the difference between your implementation of IO.closefrom and a 
-pure Ruby version that looks something like this?
+You might be wondering what the difference is between my implementation of
+IO.closefrom and a pure Ruby version that looks something like this:
 
    def IO.closefrom(n)
       0.upto n do |fd|
@@ -25,8 +28,8 @@ than only open file descriptors.  However, I should note that this only
 applies if your platform supports the closefrom() function.  In that case,
 the only advantage is speed.
 
-== Q) What is the difference between your implementation of IO.fdwalk and a
-pure Ruby version that looks something like this?
+You might also be wondering what the difference is between my implementation
+of IO.fdwalk and a pure Ruby version that looks something like this:
 
    def IO.fdwalk(n)
       ObjectSpace.each_object(File){ |f|
@@ -35,5 +38,38 @@ pure Ruby version that looks something like this?
    end
 
 The primary difference is that this only closes Ruby file objects, not
-necessarily every filehandle opened by the Ruby process.  Think system(), for
-example.
+necessarily every filehandle opened by the Ruby process. For example, handles
+opened via system() calls.
+
+= Note to OS X Users
+The OS X platform does not support closefrom(), fdwalk() or directio(). The
+hand-crafted IO.closefrom function will not work because the getrlimit()
+function on OS X does not work. Patches welcome.
+
+= Documentation
+For further documentation, see the io_extra.txt file or the inline
+documentation that was generated by RDoc (if you did a gem install).
+
+= Known Issues
+None that I'm aware of. Please file any bug reports on the project page
+at http://www.rubyforge.org/projects/shards.
+
+= Future Plans
+I may add the File::O_DIRECT open constant on platforms that support it.
+   
+= License
+Ruby's
+
+= Copyright
+(C) 2003-2007 Daniel J. Berger
+All Rights Reserved
+    
+= Warranty
+This package is provided "as is" and without any express or
+implied warranties, including, without limitation, the implied
+warranties of merchantability and fitness for a particular purpose.
+	 
+= Author
+Daniel J. Berger
+djberg96 at nospam at gmail dot com
+imperator on IRC (irc.freenode.net)

data/doc/io_extra.txt

@@ -1,8 +1,8 @@
 = Description
    The io-extra package provides a few extra IO methods that you may find
-   handy.  They are IO.closefrom, IO.fdwalk and IO.directio.
+   handy. They are IO.closefrom, IO.fdwalk and IO.directio.
 	
-   Not supported on Win32.
+   Not supported on MS Windows or OS X.
 
 = Synopsis
    require "io/extra"
@@ -20,7 +20,7 @@
 IO.closefrom(low_fd)
    Closes all open file descriptors greater than or equal to 'low_fd'.
    
-   This uses your systems native closefrom() function, if supported.  If not,
+   This uses your systems native closefrom() function, if supported. If not,
    this method uses a slightly less efficient manual approach that uses
    getrlimit() behind the scenes.
    
@@ -34,7 +34,7 @@ IO.fdwalk(low_fd){ |fh| ... }
 = Instance methods
 IO#directio?
    Returns true or false, based on whether directio has been set for the
-   current handle.  The default is false.
+   current handle. The default is false.
    
    Note supported on all platforms.
    
@@ -64,26 +64,5 @@ IO::DIRECTIO_OFF
 IO::EXTRA_VERSION
    Returns the current version number of this package as a String.
 
-= Known Bugs
-   You may receive a warning about implicit declaration during the build
-   process.  You can ignore this.
-   
-= Future Plans
-   Eliminate warnings that occur during the build process.
-   
-= License
-   Ruby's
-
-= Copyright
-   (C) 2003-2005 Daniel J. Berger
-   All Rights Reserved
-    
-= Warranty
-   This package is provided "as is" and without any express or
-   implied warranties, including, without limitation, the implied
-   warranties of merchantability and fitness for a particular purpose.
-	 
-= Author
-   Daniel J. Berger
-   djberg96 at gmail dot com
-   imperator on IRC (irc.freenode.net)
+= Other documentation
+See the README for more documentation.

data/ext/extconf.rb

@@ -0,0 +1,12 @@
+require 'mkmf'
+require 'fileutils'
+
+dir_config('io')
+
+FileUtils.cp('io/extra.c', '.')
+
+have_func('closefrom')
+have_func('fdwalk')
+have_func('directio')
+
+create_makefile('io/extra')

data/{lib → ext}/io/extra.c

@@ -10,7 +10,7 @@
 
 #ifdef HAVE_DIRECTIO
 #include <sys/types.h>
-#include <sys/fcntl.h>
+#include <fcntl.h>
 #endif
 
 /*
@@ -35,13 +35,13 @@ static VALUE io_closefrom(VALUE klass, VALUE v_low_fd){
    getrlimit(RLIMIT_NOFILE, &limits);
    lowfd = NUM2INT(v_low_fd);
 
-   for(i = lowfd; i < limits.rlim_max; i++){
+   for(i = lowfd; i < limits.rlim_max; i++)
       close(i);
-   }
 #endif
    return klass;
 }
 
+#ifdef HAVE_FDWALK
 /*
  * Used by io_fdwalk. Yields a File object back to the block.
  * It's up to the user to close it.
@@ -54,7 +54,6 @@ static int close_func(void* lowfd, int fd){
    return 0;
 }
 
-#ifdef HAVE_FDWALK
 /*
  * call-seq:
  *    IO.fdwalk(lowfd){ |fh| ... }
@@ -98,13 +97,14 @@ static VALUE io_get_directio(VALUE self){
  *    IO#directio=(advice)
  *
  * Sets the advice for the current file descriptor using directio().  Valid
- * values are IO::DIRECTIO_ON and IO::DIRECTIO_OFF.
+ * values are IO::DIRECTIO_ON and IO::DIRECTIO_OFF. See the directio(3c) man
+ * page for more information.
  *
  * All file descriptors start at DIRECTIO_OFF, unless your filesystem has
  * been mounted using 'forcedirectio' (and supports that option).
  */
 static VALUE io_set_directio(VALUE self, VALUE v_advice){
-   int fd, rv;
+   int fd;
    int advice = NUM2INT(v_advice);
 
    /* Only two possible valid values */
@@ -114,9 +114,7 @@ static VALUE io_set_directio(VALUE self, VALUE v_advice){
    /* Retrieve the current file descriptor in order to pass it to directio() */
    fd = NUM2INT(rb_funcall(self, rb_intern("fileno"), 0, 0));
 
-   rv = directio(fd, advice);
-
-   if(-1 == rv)
+   if(directio(fd, advice) < 0)
       rb_raise(rb_eStandardError, "The directio() call failed");
 
    if(advice == DIRECTIO_ON)
@@ -139,9 +137,14 @@ void Init_extra(){
 #ifdef HAVE_DIRECTIO
    rb_define_method(rb_cIO, "directio?", io_get_directio, 0);
    rb_define_method(rb_cIO, "directio=", io_set_directio, 1);
+   
+   /* 0: Applications get the default system behavior when accessing file data. */
    rb_define_const(rb_cIO, "DIRECTIO_OFF", UINT2NUM(DIRECTIO_OFF));
+   
+   /* 1: File data is not cached in the system's memory pages. */
    rb_define_const(rb_cIO, "DIRECTIO_ON", UINT2NUM(DIRECTIO_ON));
 #endif
 
-   rb_define_const(rb_cIO, "EXTRA_VERSION", rb_str_new2("1.0.1"));
+   /* 1.0.2: The version of this package. This a string. */
+   rb_define_const(rb_cIO, "EXTRA_VERSION", rb_str_new2("1.0.2"));
 }

data/test/tc_ioextra.rb

@@ -1,64 +1,50 @@
-#################################################
+###########################################################################
 # tc_ioextra.rb
 #
-# Test suite for the io-extra package.
-#################################################
-base = File.basename(Dir.pwd)
-
-if base == "test" || base =~ /io-extra/
-   require "ftools"
-   Dir.chdir("..") if base == "test"
-   Dir.mkdir("io") rescue nil
-   File.copy("extra.so","io")
-   $LOAD_PATH.unshift(Dir.pwd)
-   Dir.chdir("test")  rescue nil
-end
-
-require "test/unit"
-require "io/extra"
+# Test suite for the io-extra package. This test should be run via the
+# 'rake test' task.
+###########################################################################
+require 'test/unit'
+require 'io/extra'
 
 class TC_IO_Extra < Test::Unit::TestCase
    def setup
-      @file = "delete_this.txt"
-      @fh = File.open(@file,"w+")
+      @file = 'delete_this.txt'
+      @fh = File.open(@file, 'w+')
    end
      
    def test_version
-      assert_equal("1.0.1", IO::EXTRA_VERSION)
+      assert_equal('1.0.2', IO::EXTRA_VERSION)
    end
    
    def test_directio
-      assert_respond_to(@fh,:directio?)
+      assert_respond_to(@fh, :directio?)
       assert_nothing_raised{ @fh.directio? }
    end
-   
+
    def test_directio_set
-      assert_respond_to(@fh,:directio=)
+      assert_respond_to(@fh, :directio=)
       assert_raises(StandardError){ @fh.directio = 99 }
       assert_nothing_raised{ @fh.directio = IO::DIRECTIO_ON }
    end
-  
-   def test_closefrom
-      assert_respond_to(IO,:closefrom)
-      assert_nothing_raised{ IO.closefrom(3) }
+
+   def test_constants
+      assert_not_nil(IO::DIRECTIO_ON)
+      assert_not_nil(IO::DIRECTIO_OFF)
    end
-   
+
    def test_fdwalk
-      assert_respond_to(IO,:fdwalk)
+      assert_respond_to(IO, :fdwalk)
       assert_nothing_raised{ IO.fdwalk(0){ } }
    end
-   
-   def test_constants
-      assert_not_nil(IO::DIRECTIO_ON)
-      assert_not_nil(IO::DIRECTIO_OFF)
+
+   def test_closefrom
+      assert_respond_to(IO, :closefrom)
+      assert_nothing_raised{ IO.closefrom(3) }
    end
   
-   # Ignore EBADF, since some of the tests will close @fh
    def teardown
-      begin
-         @fh.close
-      rescue Errno::EBADF
-      end
+      @fh.close rescue nil
       @fh = nil
       File.delete(@file) if File.exists?(@file)
    end

metadata

@@ -1,10 +1,10 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.0
+rubygems_version: 0.9.4
 specification_version: 1
 name: io-extra
 version: !ruby/object:Gem::Version 
-  version: 1.0.1
-date: 2006-07-07 00:00:00 -06:00
+  version: 1.0.2
+date: 2007-07-16 00:00:00 -06:00
 summary: Adds the IO.closefrom and IO.fdwalk class methods as well as the IO#directio and IO#directio? instance methods (for those platforms that support them).
 require_paths: 
 - lib
@@ -31,9 +31,10 @@ authors:
 files: 
 - doc/io_extra.txt
 - test/tc_ioextra.rb
-- lib/io/extra.c
+- ext/io/extra.c
 - CHANGES
 - README
+- MANIFEST
 test_files: 
 - test/tc_ioextra.rb
 rdoc_options: []
@@ -41,10 +42,11 @@ rdoc_options: []
 extra_rdoc_files: 
 - CHANGES
 - README
+- MANIFEST
 executables: []
 
 extensions: 
-- extconf.rb
+- ext/extconf.rb
 requirements: []
 
 dependencies: []

data/extconf.rb

@@ -1,10 +0,0 @@
-require "mkmf"
-require "ftools"
-
-File.copy("lib/io/extra.c",".")
-
-have_func("closefrom")
-have_func("fdwalk")
-have_func("directio")
-
-create_makefile("io/extra")