io-extra 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e110a14a9b41e4ae67f06a04338ebba468ae3731b1ed8d940606cfc50f56fa11
-  data.tar.gz: 90bc28cf009765f3cdefdeb4fa6028b4269a2b58067ceb9272f58fdfd75e5352
+  metadata.gz: 413914a045cda689f991f043d5b314d6734777094d0f90359e5c10c1062d7648
+  data.tar.gz: beeb120887bf9e7c3af06f0f2a9cc733cce21f21ddf9738ef2830bab0be1931f
 SHA512:
-  metadata.gz: 6dbb68585d84b9e0fde2b4e508749500eb86993157aeff7ce830e7b86676ac96027ef6ba18bac8ec1258f16f5b1331a97d5187de90237858828361928c888bc2
-  data.tar.gz: 66beb1736b6ca2d846aa0eeca812dcf317b90463b260a18f439197090df1de51d4117c9ae233ddcc9c687e84967af30446a270ec8e8ffd229636f9413ae70d6f
+  metadata.gz: 2ad2db30be150d3837b182e6063f2db69faf0895fde33b5ba552029c1ba988093efdfd96421a155129543ae43b545eca656b2e9243bc6c0c13fd3a4dec37a842
+  data.tar.gz: 3611120e98da21cd73fd3960a6a1df6a05514a5436fbf29de3e9d0f27971ad5c94e2309fcc3399581439dc95735c78bb75303ca772cca8dcd0225631a266a1b3

data/CHANGES

@@ -1,3 +1,16 @@
+== 1.4.0 - 8-Jul-2020
+* Replaced the C versions of IO.pread and IO.pwrite singleton methods with
+  pure Ruby wrappers since core Ruby has implemented instance method versions
+  since Ruby 2.5. These now require filehandles (rather than fileno) as an
+  argument.
+* Removed the pread_ptr method, I don't think anyone was using it. Might get
+  added back if there are complaints.
+* Removed the DIRECT constant since that is now defined by core Ruby.
+* Moved the VERSION constant into the pure Ruby file.
+* Now requires Ruby 2.5 or later.
+* Added a LICENSE file as required by the Apache-2.0 license.
+* The 'io-extra' file is now the preferred way to require this library.
+
 == 1.3.0 - 19-Oct-2018
 * Now assumes Ruby 2.1 or later. This has no effect on the external API, but
   it does allow for lots of internal cleanup.

data/MANIFEST

@@ -1,6 +1,7 @@
+* CHANGES
+* LICENSE
 * MANIFEST
 * README
-* CHANGES
 * Rakefile
 * io-extra.gemspec
 * certs/djberg96_pub.pem

data/README

@@ -11,7 +11,7 @@
   gem install io-extra
 
 = Synopsis
-  require 'io/extra' # or 'io-extra'
+  require 'io-extra' # Do not use 'io/extra'
 
   # Close all file descriptors from 3 up.
   IO.closefrom(3)
@@ -27,6 +27,10 @@
   IO.writev(fh.fileno, %w[a b c])
 
 = Developer's Notes
+  The "require 'io-extra'" is preferred over 'io/extra' because this is a mix
+  of pure Ruby and C extension. The former require's the latter, so that way
+  you get all the methods and constants that you expect.
+
   You might be wondering what the difference is between my implementation of
   IO.closefrom and a pure Ruby version that looks something like this:
 
@@ -73,10 +77,6 @@
   Please file any bug reports on the project page at
   https://github.com/djberg96/io-extra
 
-= Future Plans
-  * Switch from C extension to FFI (maybe).
-  * Add the IO.pselect method.
-
 = Acknowledgements
   Eric Wong for some great work on Linux compatibility and other fixes, as
   well as the code for the IO.writev method.
@@ -85,7 +85,7 @@
   Apache-2.0
 
 = Copyright
-  (C) 2003-2018 Daniel J. Berger
+  (C) 2003-2020 Daniel J. Berger
   All Rights Reserved
     
 = Warranty

data/ext/extconf.rb

@@ -10,8 +10,6 @@ have_header('sys/uio.h')
 have_func('closefrom')
 have_func('fdwalk')
 have_func('directio')
-have_func('pread')
-have_func('pwrite')
 have_func('writev')
 have_func('ttyname')
 

data/ext/io/extra.c

@@ -284,117 +284,6 @@ static VALUE io_set_directio(VALUE self, VALUE v_advice){
 }
 #endif
 
-#ifdef HAVE_PREAD
-struct pread_args {
-  int fd;
-  void *buf;
-  size_t nbyte;
-  off_t offset;
-};
-
-static VALUE nogvl_pread(void *ptr)
-{
-  struct pread_args *args = ptr;
-  return (VALUE)pread(args->fd, args->buf, args->nbyte, args->offset);
-}
-
-/*
- * 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 fd, VALUE nbyte, VALUE offset){
-  struct pread_args args;
-  VALUE str;
-  ssize_t nread;
-
-  args.fd = NUM2INT(fd);
-  args.nbyte = NUM2ULONG(nbyte);
-  args.offset = NUM2OFFT(offset);
-  str = rb_str_new(NULL, args.nbyte);
-  args.buf = RSTRING_PTR(str);
-
-  nread = (ssize_t)rb_thread_call_without_gvl((void*)nogvl_pread, &args, RUBY_UBF_IO, 0);
-
-  if(nread == -1)
-    rb_sys_fail("pread");
-
-  if((size_t)nread != args.nbyte)
-    rb_str_set_len(str, nread);
-
-  return str;
-}
-
-/*
- * IO.pread_ptr(fd, length, offset)
- *
- * This is identical to IO.pread, except that it returns the pointer address
- * of the string, instead of the actual buffer.
- *--
- * This was added because, in some cases, the IO.pread buffer might return
- * an empty string. In such situations we are unable to get the actual pointer
- * address with pure Ruby.
- */
-static VALUE s_io_pread_ptr(VALUE klass, VALUE v_fd, VALUE v_nbyte, VALUE v_offset){
-  int fd = NUM2INT(v_fd);
-  size_t nbyte = NUM2ULONG(v_nbyte);
-  off_t offset = NUM2OFFT(v_offset);
-  uintptr_t* vector = malloc(nbyte + 1);
-
-  if(pread(fd, vector, nbyte, offset) == -1){
-    free(vector);
-    rb_sys_fail("pread");
-  }
-
-  return ULL2NUM(vector[0]);
-}
-#endif
-
-#ifdef HAVE_PWRITE
-struct pwrite_args {
-  int fd;
-  const void *buf;
-  size_t nbyte;
-  off_t offset;
-};
-
-static VALUE nogvl_pwrite(void *ptr)
-{
-  struct pwrite_args *args = ptr;
-  return (VALUE)pwrite(args->fd, args->buf, args->nbyte, args->offset);
-}
-
-/*
- * 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 fd, VALUE buf, VALUE offset){
-  ssize_t result;
-  struct pwrite_args args;
-
-  args.fd = NUM2INT(fd);
-  args.buf = RSTRING_PTR(buf);
-  args.nbyte = RSTRING_LEN(buf);
-  args.offset = NUM2OFFT(offset);
-
-  result = (ssize_t)rb_thread_call_without_gvl((void*)nogvl_pwrite, &args, RUBY_UBF_IO, 0);
-
-  if(result == -1)
-    rb_sys_fail("pwrite");
-
-  return ULL2NUM(result);
-}
-#endif
-
 /* this can't be a function since we use alloca() */
 #define ARY2IOVEC(iov,iovcnt,expect,ary) \
    do { \
@@ -448,6 +337,10 @@ static VALUE s_io_writev(VALUE klass, VALUE fd, VALUE ary) {
   ssize_t left;
   struct writev_args args;
 
+  // Allow a fileno or filehandle
+  if(rb_respond_to(fd, rb_intern("fileno")))
+    fd = rb_funcall(fd, rb_intern("fileno"), 0, 0);
+
   args.fd = NUM2INT(fd);
   ARY2IOVEC(args.iov, args.iovcnt, left, ary);
 
@@ -553,22 +446,8 @@ void Init_extra(){
   rb_define_const(rb_cIO, "DIRECTIO_ON", UINT2NUM(DIRECTIO_ON));
 #endif
 
-#ifdef O_DIRECT
-  /* 040000: direct disk access (in Linux) */
-  rb_define_const(rb_cIO, "DIRECT", UINT2NUM(O_DIRECT));
-#endif
-
   rb_define_const(rb_cIO, "IOV_MAX", LONG2NUM(IOV_MAX));
 
-#ifdef HAVE_PREAD
-  rb_define_singleton_method(rb_cIO, "pread", s_io_pread, 3);
-  rb_define_singleton_method(rb_cIO, "pread_ptr", s_io_pread_ptr, 3);
-#endif
-
-#ifdef HAVE_PWRITE
-  rb_define_singleton_method(rb_cIO, "pwrite", s_io_pwrite, 3);
-#endif
-
 #ifdef HAVE_WRITEV
   rb_define_singleton_method(rb_cIO, "writev", s_io_writev, 2);
 #endif
@@ -576,7 +455,4 @@ void Init_extra(){
 #ifdef HAVE_TTYNAME
   rb_define_method(rb_cIO, "ttyname", io_get_ttyname, 0);
 #endif
-
-  /* 1.3.0: The version of this library. */
-  rb_define_const(rb_cIO, "EXTRA_VERSION", rb_str_freeze(rb_str_new2("1.3.0")));
 }

data/lib/io-extra.rb

@@ -1 +1,17 @@
 require 'io/extra'
+
+class IO
+  EXTRA_VERSION = '1.4.0'.freeze
+
+  # Singleton version of the IO#pwrite method.
+  #
+  def self.pwrite(fd, string, offset)
+    fd.pwrite(string, offset)
+  end
+
+  # Singleton version of the IO#pread method.
+  #
+  def self.pread(fd, maxlen, offset)
+    fd.pread(maxlen, offset)
+  end
+end

data/test/test_io_extra.rb

@@ -7,7 +7,7 @@
 require 'test-unit'
 require 'rbconfig'
 require 'io/nonblock'
-require 'io/extra'
+require 'io-extra'
 
 class TC_IO_Extra < Test::Unit::TestCase
   def setup
@@ -17,16 +17,10 @@ class TC_IO_Extra < Test::Unit::TestCase
   end
 
   def test_version
-    assert_equal('1.3.0', IO::EXTRA_VERSION)
+    assert_equal('1.4.0', IO::EXTRA_VERSION)
     assert_true(IO::EXTRA_VERSION.frozen?)
   end
 
-  def test_direct_constant
-    omit_unless(RbConfig::CONFIG['host_os'] =~ /linux/i, 'Linux-only')
-    assert_equal(040000, IO::DIRECT)
-    assert_equal(040000, File::DIRECT)
-  end
-
   def test_open_direct
     omit_unless(RbConfig::CONFIG['host_os'] =~ /linux/i, 'Linux-only')
     assert_nothing_raised do
@@ -75,7 +69,7 @@ class TC_IO_Extra < Test::Unit::TestCase
     @fh.close rescue nil
     @fh = File.open(@file)
     assert_respond_to(IO, :pread)
-    assert_equal("quick", IO.pread(@fh.fileno, 5, 4))
+    assert_equal("quick", IO.pread(@fh, 5, 4))
   end
 
   def test_pread_binary
@@ -86,34 +80,26 @@ class TC_IO_Extra < Test::Unit::TestCase
     assert_nothing_raised { @fh.syswrite("FOO\0HELLO") }
     @fh.close rescue nil
     @fh = File.open(@file)
-    assert_equal("O\0H", IO.pread(@fh.fileno, 3, size + 2))
-  end
-
-  def test_pread_ptr
-    @fh.close rescue nil
-    @fh = File.open(@file)
-    assert_respond_to(IO, :pread_ptr)
-    assert_kind_of(Integer, IO.pread_ptr(@fh.fileno, 5, 4))
+    assert_equal("O\0H", IO.pread(@fh, 3, size + 2))
   end
 
   def test_pread_last
     @fh.close rescue nil
     @fh = File.open(@file)
     size = @fh.stat.size
-    assert_equal("ck\n", IO.pread(@fh.fileno, 5, size - 3))
+    assert_equal("ck\n", IO.pread(@fh, 5, size - 3))
   end
 
   def test_pwrite
     assert_respond_to(IO, :pwrite)
-    assert_nothing_raised{ IO.pwrite(@fh.fileno, "HAL", 0) }
+    assert_nothing_raised{ IO.pwrite(@fh, "HAL", 0) }
   end
 
   def test_writev
     assert_respond_to(IO, :writev)
-    assert_equal(10, IO.writev(@fh.fileno, %w(hello world)))
+    assert_equal(10, IO.writev(@fh, %w[hello world]))
   end
 
-=begin
   def test_writev_retry
     empty = ""
     if empty.respond_to?(:force_encoding)
@@ -147,7 +133,6 @@ class TC_IO_Extra < Test::Unit::TestCase
        end
     end
   end
-=end
 
   def test_ttyname
     assert_respond_to(@fh, :ttyname)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: io-extra
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Daniel J. Berger
@@ -35,26 +35,26 @@ cert_chain:
   ORVCZpRuCPpmC8qmqxUnARDArzucjaclkxjLWvCVHeFa9UP7K3Nl9oTjJNv+7/jM
   WZs4eecIcUc4tKdHxcAJ0MO/Dkqq7hGaiHpwKY76wQ1+8xAh
   -----END CERTIFICATE-----
-date: 2018-10-19 00:00:00.000000000 Z
+date: 
 dependencies:
 - !ruby/object:Gem::Dependency
   name: test-unit
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.5.0
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.5.0
+        version: '3.0'
 description: |2
-      Adds the IO.closefrom, IO.fdwalk, IO.pread, IO.pread_ptr, IO.pwrite, and
-      IO.writev singleton methods as well as the IO#directio, IO#directio? and
-      IO#ttyname instance methods (for those platforms that support them).
+      Adds the IO.closefrom, IO.fdwalk, IO.pread, IO.pwrite, and IO.writev
+      singleton methods as well as the IO#directio, IO#directio? and IO#ttyname
+      instance methods (for those platforms that support them).
 email: djberg96@gmail.com
 executables: []
 extensions:
@@ -84,15 +84,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.1.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: Adds extra methods to the IO class