io-extra 1.4.0 → 1.5.0

data/spec/io_extra_spec.rb

@@ -0,0 +1,179 @@
+################################################################################
+# io_extra_spec.rb
+#
+# Tests for the io-extra library. These should be run via the 'rake spec' task.
+################################################################################
+require 'rspec'
+require 'rbconfig'
+require 'io/nonblock'
+require 'io-extra'
+require 'fileutils'
+
+describe IO do
+  let(:linux) { RbConfig::CONFIG['host_os'] =~ /linux/i }
+  let(:osx) { RbConfig::CONFIG['host_os'] =~ /darwin/i }
+
+  before do
+    @file = 'delete_this.txt'
+    @fh = File.open(@file, 'w+')
+    @fh.puts "The quick brown fox jumped over the lazy dog's back"
+  end
+
+  after do
+    @fh.close rescue nil
+    @fh = nil
+    FileUtils.rm_f(@file)
+  end
+
+  context 'constants' do
+    example 'EXTRA_VERSION' do
+      expect(IO::EXTRA_VERSION).to eq('1.5.0')
+      expect(IO::EXTRA_VERSION).to be_frozen
+    end
+
+    example 'DIRECT' do
+      skip 'Skipped unless Linux' unless linux
+      # O_DIRECT value varies by architecture (e.g., 040000 on x86_64, 0100000 on others)
+      # Just verify it's defined and is a valid flag (positive integer)
+      expect(IO::DIRECT).to be_a(Integer)
+      expect(IO::DIRECT).to be > 0
+      expect(IO::DIRECT).to eq(File::DIRECT)
+    end
+
+    example 'DIRECTIO_ON and DIRECTIO_OFF' do
+      expect(IO::DIRECTIO_ON).not_to be_nil
+      expect(IO::DIRECTIO_OFF).not_to be_nil
+    end
+
+    example 'IOV_MAX_constant' do
+      expect(IO::IOV_MAX).to be_a(Integer)
+    end
+  end
+
+  context 'flags' do
+    example 'DIRECT flag' do
+      skip 'Skipped unless Linux' unless linux
+      expect { File.open(@fh.path, IO::RDWR | IO::DIRECT).close }.not_to raise_error
+    end
+
+    example 'directio? method' do
+      expect(@fh).to respond_to(:directio?)
+      expect{ @fh.directio? }.not_to raise_error
+    end
+
+    example 'set DIRECTIO_ON' do
+      expect(@fh).to respond_to(:directio=)
+      expect{ @fh.directio = 99 }.to raise_error(StandardError)
+      expect{ @fh.directio = IO::DIRECTIO_ON }.not_to raise_error
+    end
+  end
+
+  context 'fdwalk' do
+    example 'fdwalk basic functionality' do
+      expect(IO).to respond_to(:fdwalk)
+      expect{ IO.fdwalk(0){} }.not_to raise_error
+    end
+
+    example 'fdwalk_honors_lowfd' do
+      IO.fdwalk(1){ |f| expect(f.fileno >= 1).to be(true) }
+    end
+  end
+
+  context 'closefrom' do
+    example 'closefrom' do
+      expect(IO).to respond_to(:closefrom)
+      expect{ IO.closefrom(3) }.not_to raise_error
+    end
+  end
+
+  context 'pread' do
+    example 'pread basic functionality' do
+      @fh.close rescue nil
+      @fh = File.open(@file)
+      expect(IO).to respond_to(:pread)
+      expect(IO.pread(@fh, 5, 4)).to eq('quick')
+    end
+
+    example 'pread works in binary mode' do
+      @fh.close rescue nil
+      @fh = File.open(@file, 'ab')
+      @fh.binmode
+      size = @fh.stat.size
+      expect { @fh.syswrite("FOO\0HELLO") }.not_to raise_error
+      @fh.close rescue nil
+      @fh = File.open(@file)
+      expect(IO.pread(@fh, 3, size + 2)).to eq("O\0H")
+    end
+
+    example 'pread with offset works as expected' do
+      @fh.close rescue nil
+      @fh = File.open(@file)
+      size = @fh.stat.size
+      expect(IO.pread(@fh, 5, size - 3)).to eq("ck\n")
+    end
+  end
+
+  context 'pwrite' do
+    example 'pwrite basic functionality' do
+      expect(IO).to respond_to(:pwrite)
+      expect{ IO.pwrite(@fh, 'HAL', 0) }.not_to raise_error
+    end
+  end
+
+  context 'writev' do
+    example 'writev' do
+      expect(IO).to respond_to(:writev)
+      expect(IO.writev(@fh, %w[hello world])).to eq(10)
+    end
+  end
+
+  context 'writev_retry' do
+    skip 'no /dev/urandom found, skipping' unless File.exist?('/dev/urandom')
+    # rubocop:disable Metrics/BlockLength
+    example 'writev with retry works as expected' do
+      empty = ''
+
+      if empty.respond_to?(:force_encoding)
+        empty.force_encoding(Encoding::BINARY)
+      end
+
+      # bs * count should be > PIPE_BUF
+      [true, false].each do |nonblock|
+        [[512, 512], [131073, 3], [4098, 64]].each do |(bs, count)|
+          rd, wr = IO.pipe
+          wr.nonblock = nonblock
+          buf = File.open('/dev/urandom', 'rb') { |fp| fp.sysread(bs) }
+          vec = (1..count).map { buf }
+
+          pid = fork do
+            wr.close
+            tmp = []
+            sleep 0.1
+            loop do
+              tmp << rd.readpartial(8192, buf)
+            rescue EOFError
+              break
+            end
+            ok = (vec.join(empty) == tmp.join(empty))
+            exit! ok
+          end
+
+          expect { rd.close }.not_to raise_error
+          expect(IO.writev(wr.fileno, vec)).to eq(bs * count)
+          expect { wr.close }.not_to raise_error
+          _, status = Process.waitpid2(pid)
+          expect(status.success?).to be(true)
+        end
+      end
+      # rubocop:enable Metrics/BlockLength
+    end
+  end
+
+  example 'ttyname' do
+    expect(@fh).to respond_to(:ttyname)
+    expect(@fh.ttyname).to be_nil
+
+    skip 'skipping ttyname spec in CI environment' if ENV['CI']
+    expect($stdout.ttyname).to be_a(String)
+  end
+end

metadata

@@ -1,11 +1,10 @@
 --- !ruby/object:Gem::Specification
 name: io-extra
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Daniel J. Berger
-autorequire: 
 bindir: bin
 cert_chain:
 - |
@@ -35,22 +34,64 @@ cert_chain:
   ORVCZpRuCPpmC8qmqxUnARDArzucjaclkxjLWvCVHeFa9UP7K3Nl9oTjJNv+7/jM
   WZs4eecIcUc4tKdHxcAJ0MO/Dkqq7hGaiHpwKY76wQ1+8xAh
   -----END CERTIFICATE-----
-date: 
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: test-unit
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: |2
       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
@@ -60,23 +101,42 @@ executables: []
 extensions:
 - ext/extconf.rb
 extra_rdoc_files:
-- CHANGES
-- README
-- MANIFEST
+- CHANGES.md
+- MANIFEST.md
+- README.md
 - ext/io/extra.c
 files:
+- CHANGES.md
+- Gemfile
+- LICENSE
+- MANIFEST.md
+- README.md
+- Rakefile
+- certs/djberg96_pub.pem
+- doc/io_extra.txt
+- examples/example_io_extra.rb
+- examples/example_pread.rb
+- examples/writev_benchmark.rb
+- ext/extconf.rb
+- ext/extra.bundle.dSYM/Contents/Info.plist
+- ext/extra.bundle.dSYM/Contents/Resources/Relocations/aarch64/extra.bundle.yml
+- ext/io/extra.c
+- io-extra.gemspec
 - lib/io-extra.rb
+- spec/io_extra_spec.rb
 homepage: https://github.com/djberg96/io-extra
 licenses:
 - Apache-2.0
 metadata:
   homepage_uri: https://github.com/djberg96/io-extra
   bug_tracker_uri: https://github.com/djberg96/io-extra/issues
-  changelog_uri: https://github.com/djberg96/io-extra/blob/master/CHANGES
+  changelog_uri: https://github.com/djberg96/io-extra/blob/main/CHANGES.md
   documentation_uri: https://github.com/djberg96/io-extra/wiki
   source_code_uri: https://github.com/djberg96/io-extra
   wiki_uri: https://github.com/djberg96/io-extra/wiki
-post_install_message: 
+  rubygems_mfa_required: 'true'
+  github_repo: https://github.com/djberg96/io-extra
+  funding_uri: https://github.com/sponsors/djberg96
 rdoc_options: []
 require_paths:
 - lib
@@ -84,16 +144,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Adds extra methods to the IO class
 test_files:
-- test/test_io_extra.rb
+- spec/io_extra_spec.rb

data/README

@@ -1,97 +0,0 @@
-= Description
-  The io-extra library provides a few extra IO methods that you may find
-  handy. They are IO.closefrom, IO.fdwalk, IO.pread, IO.pread_ptr, IO.pwrite,
-  IO.writev, IO#directio? and IO#directio=.
-	
-  This library is not supported on MS Windows.
-
-  Support for OS X is limited. See below for details.
-
-= Installation
-  gem install io-extra
-
-= Synopsis
-  require 'io-extra' # Do not use 'io/extra'
-
-  # Close all file descriptors from 3 up.
-  IO.closefrom(3)
-
-  # Inspect all the open handles
-  IO.fdwalk(0){ |handle|
-    puts "=" * 40 
-    p handle
-    p handle.fileno
-  }
-
-  # Write an array to an IO object efficiently
-  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:
-
-  def IO.closefrom(n)
-    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,
-  the only advantage is speed.
-
-  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|
-       yield f if f.fileno >= n
-     }
-   end
-
-  The primary difference is that this only closes Ruby file objects, not
-  necessarily every file handle 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() or fdwalk(). 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
-  The IO.writev tests fail on Solaris. Short test scripts seem to work,
-  however. We're not sure what the issue is yet. Help wanted.
-
-  Update: As of 2018 Solaris is basically dead, so I'm not going to worry
-  about supporting Solaris unless there's an outcry.
-
-  Please file any bug reports on the project page at
-  https://github.com/djberg96/io-extra
-
-= Acknowledgements
-  Eric Wong for some great work on Linux compatibility and other fixes, as
-  well as the code for the IO.writev method.
-
-= License
-  Apache-2.0
-
-= Copyright
-  (C) 2003-2020 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

data/test/test_io_extra.rb

@@ -1,148 +0,0 @@
-###########################################################################
-# test_io_extra.rb
-#
-# Test suite for the io-extra library. This test should be run via the
-# 'rake test' task.
-###########################################################################
-require 'test-unit'
-require 'rbconfig'
-require 'io/nonblock'
-require 'io-extra'
-
-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.4.0', IO::EXTRA_VERSION)
-    assert_true(IO::EXTRA_VERSION.frozen?)
-  end
-
-  def test_open_direct
-    omit_unless(RbConfig::CONFIG['host_os'] =~ /linux/i, 'Linux-only')
-    assert_nothing_raised do
-      fh = File.open(@fh.path, IO::RDWR|IO::DIRECT)
-      fh.close
-    end
-  end
-
-  def test_directio
-    assert_respond_to(@fh, :directio?)
-    assert_nothing_raised{ @fh.directio? }
-  end
-
-  def test_directio_set
-    assert_respond_to(@fh, :directio=)
-    assert_raises(StandardError){ @fh.directio = 99 }
-    assert_nothing_raised{ @fh.directio = IO::DIRECTIO_ON }
-  end
-
-  def test_constants
-    assert_not_nil(IO::DIRECTIO_ON)
-    assert_not_nil(IO::DIRECTIO_OFF)
-  end
-
-  def test_IOV_MAX_constant
-    assert_kind_of(Integer, IO::IOV_MAX)
-  end
-
-  def test_fdwalk
-    omit_if(RbConfig::CONFIG['host_os'] =~ /darwin/i, 'unsupported')
-    assert_respond_to(IO, :fdwalk)
-    assert_nothing_raised{ IO.fdwalk(0){ } }
-  end
-
-  def test_fdwalk_honors_lowfd
-    omit_if(RbConfig::CONFIG['host_os'] =~ /darwin/i, 'unsupported')
-    IO.fdwalk(1){ |f| assert_true(f.fileno >= 1) }
-  end
-
-  def test_closefrom
-    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, 5, 4))
-  end
-
-  def test_pread_binary
-    @fh.close rescue nil
-    @fh = File.open(@file, "ab")
-    @fh.binmode
-    size = @fh.stat.size
-    assert_nothing_raised { @fh.syswrite("FOO\0HELLO") }
-    @fh.close rescue nil
-    @fh = File.open(@file)
-    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, 5, size - 3))
-  end
-
-  def test_pwrite
-    assert_respond_to(IO, :pwrite)
-    assert_nothing_raised{ IO.pwrite(@fh, "HAL", 0) }
-  end
-
-  def test_writev
-    assert_respond_to(IO, :writev)
-    assert_equal(10, IO.writev(@fh, %w[hello world]))
-  end
-
-  def test_writev_retry
-    empty = ""
-    if empty.respond_to?(:force_encoding)
-      empty.force_encoding(Encoding::BINARY)
-    end
-
-    # bs * count should be > PIPE_BUF
-    [ true, false ].each do |nonblock|
-       [ [ 512, 512 ], [ 131073, 3 ], [ 4098, 64 ] ].each do |(bs,count)|
-          rd, wr = IO.pipe
-          wr.nonblock = nonblock
-          buf = File.open("/dev/urandom", "rb") { |fp| fp.sysread(bs) }
-          vec = (1..count).map { buf }
-          pid = fork do
-             wr.close
-             tmp = []
-             sleep 0.1
-             begin
-                tmp << rd.readpartial(8192, buf)
-             rescue EOFError
-                break
-             end while true
-             ok = (vec.join(empty) == tmp.join(empty))
-             exit! ok
-          end
-          assert_nothing_raised { rd.close }
-          assert_equal(bs * count, IO.writev(wr.fileno, vec))
-          assert_nothing_raised { wr.close }
-          _, status = Process.waitpid2(pid)
-          assert status.success?
-       end
-    end
-  end
-
-  def test_ttyname
-    assert_respond_to(@fh, :ttyname)
-    assert_nil(@fh.ttyname)
-    assert_kind_of(String, STDOUT.ttyname)
-  end
-
-  def teardown
-    @fh.close rescue nil
-    @fh = nil
-    File.delete(@file) if File.exist?(@file)
-  end
-end