io-extra 1.0.2 → 1.1.0

data/CHANGES

@@ -1,3 +1,9 @@
+== 1.1.0 - 28-Aug-2008
+* Added IO.pread and IO.pwrite methods for those platforms that
+  support them.
+* Fixed a warning that could occur in the IO#directio method.
+* Some updates the README, CHANGES, and test files.
+
 == 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

data/MANIFEST

@@ -7,4 +7,4 @@
 * examples/test.rb
 * ext/extconf.rb
 * ext/io/extra.c
-* test/tc_ioextra.rb
+* test/test_io_extra.rb

data/README

@@ -1,6 +1,6 @@
 = Description
-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=.
+The io-extra library 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 or OS X.
 
@@ -18,14 +18,14 @@ 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|
+      0.upto(n) do |fd|
          IO.for_fd(fd).close
       end
    end
 
 The primary difference is that this walks all file descriptors, rather
-than only open file descriptors.  However, I should note that this only
-applies if your platform supports the closefrom() function.  In that case,
+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.
 
 You might also be wondering what the difference is between my implementation
@@ -38,7 +38,7 @@ of IO.fdwalk and a 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. For example, handles
+necessarily every file handle opened by the Ruby process. For example, handles
 opened via system() calls.
 
 = Note to OS X Users
@@ -61,7 +61,7 @@ I may add the File::O_DIRECT open constant on platforms that support it.
 Ruby's
 
 = Copyright
-(C) 2003-2007 Daniel J. Berger
+(C) 2003-2008 Daniel J. Berger
 All Rights Reserved
     
 = Warranty

data/doc/io_extra.txt

@@ -1,7 +1,10 @@
 = 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.
+   The io-extra library provides a few extra IO methods that you may find
+   handy.
 	
+= Supported Platforms
+   Works on most Unix platforms.
+
    Not supported on MS Windows or OS X.
 
 = Synopsis
@@ -29,7 +32,21 @@ IO.fdwalk(low_fd){ |fh| ... }
    Note that it is up to you to close file handles, if desired, when this
    method is used.
 	
-   Not supported by all platforms.
+   Not supported on all platforms.
+
+IO.pread(fd, length, offset)
+   Reads +length+ bytes of data from the given +fd+, starting at +offset.
+   The primary advantage of this method over Ruby's IO#read method is that
+   it performs the read without changing the file pointer.
+
+   Not supported on all platforms.
+
+IO.pwrite(fd, buf, offset)
+   Writes +buf+ to the given +fd+, starting at +offset. The primary advantage
+   of this method over a standard seek & write approach is that it performs
+   the write without changing the file pointer.
+
+   Not supported on all platforms.
 
 = Instance methods
 IO#directio?
@@ -62,7 +79,7 @@ IO::DIRECTIO_OFF
    function.
    
 IO::EXTRA_VERSION
-   Returns the current version number of this package as a String.
+   Returns the current version number of this library as a String.
 
 = Other documentation
-See the README for more documentation.
+See the README for more documentation.

data/ext/extconf.rb

@@ -3,10 +3,10 @@ require 'fileutils'
 
 dir_config('io')
 
-FileUtils.cp('io/extra.c', '.')
-
 have_func('closefrom')
 have_func('fdwalk')
 have_func('directio')
+have_func('pread')
+have_func('pwrite')
 
-create_makefile('io/extra')
+create_makefile('io/extra', 'io')

data/ext/io/extra.c

@@ -84,7 +84,10 @@ static VALUE io_fdwalk(int argc, VALUE* argv, VALUE klass){
  * current handle. The default is false.
  */
 static VALUE io_get_directio(VALUE self){
-   VALUE v_advice = rb_iv_get(self, "directio");
+   VALUE v_advice = Qnil;
+
+   if(rb_ivar_defined(rb_cIO, rb_intern("@directio")))
+      v_advice = rb_iv_get(self, "directio");
 
    if(NIL_P(v_advice))
       v_advice = Qfalse;
@@ -124,6 +127,59 @@ static VALUE io_set_directio(VALUE self, VALUE v_advice){
 }
 #endif
 
+#ifdef HAVE_PREAD
+/*
+ * IO.pread(fd, length, offset)
+ *
+ * This is similar to the IO.read method, except that it reads from a given
+ * position in the file without changing the file pointer. And unlike IO.read,
+ * the +fd+, +length+ and +offset+ arguments are all mandatory.
+ */
+static VALUE s_io_pread(VALUE klass, VALUE v_fd, VALUE v_nbyte, VALUE v_offset){
+   size_t result;
+   int fd = NUM2INT(v_fd);
+   size_t nbyte = NUM2ULONG(v_nbyte);
+   off_t offset = NUM2ULONG(v_offset);
+   char buf[nbyte+1];
+
+   result = pread(fd, buf, nbyte, offset);
+
+   if(result == -1)
+      rb_sys_fail("pread");
+
+   return rb_str_new2(buf);
+}
+#endif
+
+#ifdef HAVE_PWRITE
+/*
+ * IO.pwrite(fd, buf, offset)
+ *
+ * This method writes the +buf+, starting at +offset+, to the given +fd+,
+ * which must be opened with write permissions.
+ *
+ * This is similar to a seek & write in standard Ruby but the difference,
+ * beyond being a singleton method, is that the file pointer is never moved.
+ *
+ * Returns the number of bytes written.
+ */
+static VALUE s_io_pwrite(VALUE klass, VALUE v_fd, VALUE v_buf, VALUE v_offset){
+   ssize_t result;
+
+   result = pwrite(
+      NUM2INT(v_fd),
+      RSTRING(v_buf)->ptr,
+      RSTRING(v_buf)->len,
+      NUM2INT(v_offset)
+   );
+
+   if(result == -1)
+      rb_sys_fail("pwrite");
+
+   return ULL2NUM(result);
+}
+#endif
+
 /* Adds the IO.closefrom, IO.fdwalk class methods, as well as the IO#directio
  * and IO#directio? instance methods (if supported on your platform).
  */
@@ -145,6 +201,14 @@ void Init_extra(){
    rb_define_const(rb_cIO, "DIRECTIO_ON", UINT2NUM(DIRECTIO_ON));
 #endif
 
-   /* 1.0.2: The version of this package. This a string. */
-   rb_define_const(rb_cIO, "EXTRA_VERSION", rb_str_new2("1.0.2"));
+#ifdef HAVE_PREAD
+   rb_define_singleton_method(rb_cIO, "pread", s_io_pread, 3);
+#endif
+
+#ifdef HAVE_PWRITE
+   rb_define_singleton_method(rb_cIO, "pwrite", s_io_pwrite, 3);
+#endif
+
+   /* 1.1.0: The version of this package. This a string. */
+   rb_define_const(rb_cIO, "EXTRA_VERSION", rb_str_new2("1.1.0"));
 }

data/test/{tc_ioextra.rb → test_io_extra.rb}

@@ -1,7 +1,7 @@
 ###########################################################################
-# tc_ioextra.rb
+# test_io_extra.rb
 #
-# Test suite for the io-extra package. This test should be run via the
+# Test suite for the io-extra library. This test should be run via the
 # 'rake test' task.
 ###########################################################################
 require 'test/unit'
@@ -11,10 +11,11 @@ class TC_IO_Extra < Test::Unit::TestCase
    def setup
       @file = 'delete_this.txt'
       @fh = File.open(@file, 'w+')
+      @fh.puts "The quick brown fox jumped over the lazy dog's back"
    end
      
    def test_version
-      assert_equal('1.0.2', IO::EXTRA_VERSION)
+      assert_equal('1.1.0', IO::EXTRA_VERSION)
    end
    
    def test_directio
@@ -42,6 +43,18 @@ class TC_IO_Extra < Test::Unit::TestCase
       assert_respond_to(IO, :closefrom)
       assert_nothing_raised{ IO.closefrom(3) }
    end
+
+   def test_pread
+      @fh.close rescue nil
+      @fh = File.open(@file)
+      assert_respond_to(IO, :pread)
+      assert_equal("quick", IO.pread(@fh.fileno, 5, 4))
+   end
+
+   def test_pwrite
+      assert_respond_to(IO, :pwrite)
+      assert_nothing_raised{ IO.pwrite(@fh.fileno, "HAL", 0) }
+   end
   
    def teardown
       @fh.close rescue nil

metadata

@@ -1,53 +1,60 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.4
-specification_version: 1
 name: io-extra
 version: !ruby/object:Gem::Version 
-  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
-email: djberg96@gmail.com
-homepage: http://www.rubyforge.org/projects/shards
-rubyforge_project: shards
-description: 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).
-autorequire: 
-default_executable: 
-bindir: bin
-has_rdoc: true
-required_ruby_version: !ruby/object:Gem::Version::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: 1.8.0
-  version: 
+  version: 1.1.0
 platform: ruby
-signing_key: 
-cert_chain: 
-post_install_message: 
 authors: 
 - Daniel J. Berger
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-08-28 00:00:00 -06:00
+default_executable: 
+dependencies: []
+
+description: 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).
+email: djberg96@gmail.com
+executables: []
+
+extensions: 
+- ext/extconf.rb
+extra_rdoc_files: 
+- CHANGES
+- README
+- MANIFEST
 files: 
 - doc/io_extra.txt
-- test/tc_ioextra.rb
+- test/test_io_extra.rb
 - ext/io/extra.c
 - CHANGES
 - README
 - MANIFEST
-test_files: 
-- test/tc_ioextra.rb
+has_rdoc: true
+homepage: http://www.rubyforge.org/projects/shards
+post_install_message: 
 rdoc_options: []
 
-extra_rdoc_files: 
-- CHANGES
-- README
-- MANIFEST
-executables: []
-
-extensions: 
-- ext/extconf.rb
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: 1.8.0
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
 requirements: []
 
-dependencies: []
-
+rubyforge_project: shards
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+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).
+test_files: 
+- test/test_io_extra.rb