io-extra 1.2.5 → 1.4.0

data/lib/io-extra.rb

@@ -0,0 +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

@@ -4,13 +4,10 @@
 # Test suite for the io-extra library. This test should be run via the
 # 'rake test' task.
 ###########################################################################
-require 'rubygems'
-gem 'test-unit'
-
-require 'test/unit'
+require 'test-unit'
 require 'rbconfig'
 require 'io/nonblock'
-require 'io/extra'
+require 'io-extra'
 
 class TC_IO_Extra < Test::Unit::TestCase
   def setup
@@ -20,13 +17,8 @@ class TC_IO_Extra < Test::Unit::TestCase
   end
 
   def test_version
-    assert_equal('1.2.5', IO::EXTRA_VERSION)
-  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)
+    assert_equal('1.4.0', IO::EXTRA_VERSION)
+    assert_true(IO::EXTRA_VERSION.frozen?)
   end
 
   def test_open_direct
@@ -38,20 +30,17 @@ class TC_IO_Extra < Test::Unit::TestCase
   end
 
   def test_directio
-    omit_if(RbConfig::CONFIG['host_os'] =~ /darwin/i, 'unsupported')
     assert_respond_to(@fh, :directio?)
     assert_nothing_raised{ @fh.directio? }
   end
 
   def test_directio_set
-    omit_if(RbConfig::CONFIG['host_os'] =~ /darwin/i, 'unsupported')
     assert_respond_to(@fh, :directio=)
     assert_raises(StandardError){ @fh.directio = 99 }
     assert_nothing_raised{ @fh.directio = IO::DIRECTIO_ON }
   end
 
   def test_constants
-    omit_if(RbConfig::CONFIG['host_os'] =~ /darwin/i, 'unsupported')
     assert_not_nil(IO::DIRECTIO_ON)
     assert_not_nil(IO::DIRECTIO_OFF)
   end
@@ -66,6 +55,11 @@ class TC_IO_Extra < Test::Unit::TestCase
     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) }
@@ -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,31 +80,24 @@ 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
 
   def test_writev_retry
@@ -147,9 +134,15 @@ class TC_IO_Extra < Test::Unit::TestCase
     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.exists?(@file)
+    File.delete(@file) if File.exist?(@file)
   end
 end

metadata

@@ -1,97 +1,99 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: io-extra
-version: !ruby/object:Gem::Version 
-  hash: 21
-  prerelease: 
-  segments: 
-  - 1
-  - 2
-  - 5
-  version: 1.2.5
+version: !ruby/object:Gem::Version
+  version: 1.4.0
 platform: ruby
-authors: 
+authors:
 - Daniel J. Berger
 autorequire: 
 bindir: bin
-cert_chain: []
-
-date: 2011-03-23 00:00:00 -06:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIEcDCCAtigAwIBAgIBATANBgkqhkiG9w0BAQsFADA/MREwDwYDVQQDDAhkamJl
+  cmc5NjEVMBMGCgmSJomT8ixkARkWBWdtYWlsMRMwEQYKCZImiZPyLGQBGRYDY29t
+  MB4XDTE4MDMxODE1MjIwN1oXDTI4MDMxNTE1MjIwN1owPzERMA8GA1UEAwwIZGpi
+  ZXJnOTYxFTATBgoJkiaJk/IsZAEZFgVnbWFpbDETMBEGCgmSJomT8ixkARkWA2Nv
+  bTCCAaIwDQYJKoZIhvcNAQEBBQADggGPADCCAYoCggGBALgfaroVM6CI06cxr0/h
+  A+j+pc8fgpRgBVmHFaFunq28GPC3IvW7Nvc3Y8SnAW7pP1EQIbhlwRIaQzJ93/yj
+  u95KpkP7tA9erypnV7dpzBkzNlX14ACaFD/6pHoXoe2ltBxk3CCyyzx70mTqJpph
+  75IB03ni9a8yqn8pmse+s83bFJOAqddSj009sGPcQO+QOWiNxqYv1n5EHcvj2ebO
+  6hN7YTmhx7aSia4qL/quc4DlIaGMWoAhvML7u1fmo53CYxkKskfN8MOecq2vfEmL
+  iLu+SsVVEAufMDDFMXMJlvDsviolUSGMSNRTujkyCcJoXKYYxZSNtIiyd9etI0X3
+  ctu0uhrFyrMZXCedutvXNjUolD5r9KGBFSWH1R9u2I3n3SAyFF2yzv/7idQHLJJq
+  74BMnx0FIq6fCpu5slAipvxZ3ZkZpEXZFr3cIBtO1gFvQWW7E/Y3ijliWJS1GQFq
+  058qERadHGu1yu1dojmFRo6W2KZvY9al2yIlbkpDrD5MYQIDAQABo3cwdTAJBgNV
+  HRMEAjAAMAsGA1UdDwQEAwIEsDAdBgNVHQ4EFgQUFZsMapgzJimzsbaBG2Tm8j5e
+  AzgwHQYDVR0RBBYwFIESZGpiZXJnOTZAZ21haWwuY29tMB0GA1UdEgQWMBSBEmRq
+  YmVyZzk2QGdtYWlsLmNvbTANBgkqhkiG9w0BAQsFAAOCAYEAW2tnYixXQtKxgGXq
+  /3iSWG2bLwvxS4go3srO+aRXZHrFUMlJ5W0mCxl03aazxxKTsVVpZD8QZxvK91OQ
+  h9zr9JBYqCLcCVbr8SkmYCi/laxIZxsNE5YI8cC8vvlLI7AMgSfPSnn/Epq1GjGY
+  6L1iRcEDtanGCIvjqlCXO9+BmsnCfEVehqZkQHeYczA03tpOWb6pon2wzvMKSsKH
+  ks0ApVdstSLz1kzzAqem/uHdG9FyXdbTAwH1G4ZPv69sQAFAOCgAqYmdnzedsQtE
+  1LQfaQrx0twO+CZJPcRLEESjq8ScQxWRRkfuh2VeR7cEU7L7KqT10mtUwrvw7APf
+  DYoeCY9KyjIBjQXfbj2ke5u1hZj94Fsq9FfbEQg8ygCgwThnmkTrrKEiMSs3alYR
+  ORVCZpRuCPpmC8qmqxUnARDArzucjaclkxjLWvCVHeFa9UP7K3Nl9oTjJNv+7/jM
+  WZs4eecIcUc4tKdHxcAJ0MO/Dkqq7hGaiHpwKY76wQ1+8xAh
+  -----END CERTIFICATE-----
+date: 
+dependencies:
+- !ruby/object:Gem::Dependency
   name: test-unit
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 9
-        segments: 
-        - 2
-        - 1
-        - 1
-        version: 2.1.1
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
   type: :development
-  version_requirements: *id001
-description: "    Adds the IO.closefrom, IO.fdwalk, IO.pread, IO.pread_ptr, IO.pwrite, and\n    IO.writev singleton methods as well as the IO#directio and IO#directio?\n    instance methods (for those platforms that support them).\n"
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.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
+      instance methods (for those platforms that support them).
 email: djberg96@gmail.com
 executables: []
-
-extensions: 
+extensions:
 - ext/extconf.rb
-extra_rdoc_files: 
+extra_rdoc_files:
 - CHANGES
 - README
 - MANIFEST
 - ext/io/extra.c
-files: 
-- Rakefile
-- README
-- doc/io_extra.txt
-- io-extra.gemspec
-- CHANGES
-- examples/example_io_extra.rb
-- examples/example_pread.rb
-- test/test_io_extra.rb
-- MANIFEST
-- ext/extconf.rb
-- ext/io/extra.c
-has_rdoc: true
-homepage: http://www.rubyforge.org/projects/shards
-licenses: 
-- Artistic 2.0
+files:
+- lib/io-extra.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
+  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: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 59
-      segments: 
-      - 1
-      - 8
-      - 6
-      version: 1.8.6
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
-rubyforge_project: shards
-rubygems_version: 1.6.2
+rubygems_version: 3.0.6
 signing_key: 
-specification_version: 3
-summary: Adds extra methods to the IO class.
-test_files: 
+specification_version: 4
+summary: Adds extra methods to the IO class
+test_files:
 - test/test_io_extra.rb

data/Rakefile

@@ -1,93 +0,0 @@
-require 'rake'
-require 'rake/clean'
-require 'rake/testtask'
-require 'rbconfig'
-include RbConfig
-
-CLEAN.include(
-  '**/*.gem',               # Gem files
-  '**/*.rbc',               # Rubinius
-  '**/*.o',                 # C object file
-  '**/*.log',               # Ruby extension build log
-  '**/Makefile',            # C Makefile
-  '**/conftest.dSYM',       # OS X build directory
-  "**/*.#{CONFIG['DLEXT']}" # C shared object
-)
-
-if File::ALT_SEPARATOR
-  STDERR.puts 'Not supported on this platform. Exiting.'
-  exit(-1)
-end
-
-desc "Build the io-extra library (but don't install it)"
-task :build => [:clean] do
-  Dir.chdir('ext') do
-    ruby 'extconf.rb'
-    sh 'make'
-    build_file = File.join(Dir.pwd, 'extra.' + CONFIG['DLEXT'])
-    Dir.mkdir('io') unless File.exists?('io')
-    FileUtils.cp(build_file, 'io')
-  end
-end
-
-namespace :gem do
-  desc 'Create the io-extra gem'
-  task :create => [:clean] do
-    spec = eval(IO.read('io-extra.gemspec'))
-    Gem::Builder.new(spec).build
-  end
-
-  desc "Install the io-extra library as a gem"
-  task :install => [:create] do
-    file = Dir["io-extra*.gem"].last
-    sh "gem install #{file}"
-  end
-end
-
-namespace :archive do
-  spec = eval(IO.read('io-extra.gemspec'))
-  file = "io-extra-#{spec.version}"
-
-  desc 'Create an io-extra tarball.'
-  task :tar do
-    file = file + ".tar"
-    cmd  = "git archive --format=tar --prefix=#{file}/ -o #{file} HEAD"
-    sh cmd
-  end
-
-  desc 'Create a gzipped tarball for io-extra'
-  task :gz => [:tar] do
-    sh "gzip #{file}"
-  end
-
-  desc 'Create a bzip2 tarball for io-extra'
-  task :bz2 => [:tar] do
-    sh "bzip2 #{file}"
-  end
-
-  desc 'Create a zipped tarball for io-extra'
-  task :zip do
-    sh "git archive --format=zip --prefix=#{file}/ -o #{file}.zip HEAD"
-  end
-end
-
-desc "Run the example io-extra program"
-task :example => [:build] do
-  ruby '-Iext examples/example_io_extra.rb'
-end
-
-namespace :example do
-  desc "Run the IO.pread example program."
-  task :pread do
-    ruby '-Iext examples/example_io_extra.rb'
-  end
-end
-
-Rake::TestTask.new do |t|
-  task :test => :build
-  t.libs << 'ext'
-  t.verbose = true
-  t.warning = true
-end
-
-task :default => :test

data/doc/io_extra.txt

@@ -1,85 +0,0 @@
-= Description
-   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
-   require "io/extra"
-   
-   # Print the fileno of each file handle and then close it
-   IO.fdwalk(0){ |fh|
-      p fh.fileno
-      fh.close
-   }
-   
-   # Close all file handles with a fileno greater than or equal to 2.
-   IO.closefrom(2)
-   
-= Class Methods
-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 method uses a slightly less efficient manual approach that uses
-   getrlimit() behind the scenes.
-   
-IO.fdwalk(low_fd){ |fh| ... }
-   Iterates over each open file descriptor and yields back a File object.
-   Note that it is up to you to close file handles, if desired, when this
-   method is used.
-	
-   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?
-   Returns true or false, based on whether directio has been set for the
-   current handle. The default is false.
-   
-   Note supported on all platforms.
-   
-IO#directio=(io_const)
-   Sets the advice for the current file descriptor using directio().  Valid
-   values are IO::DIRECTIO_ON and IO::DIRECTIO_OFF.
-   
-   All file descriptors start at DIRECTIO_OFF, unless your filesystem has
-   been mounted using 'forcedirectio' (and supports that option).
-   
-   Not supported on all platforms
-   
-= Constants
-IO::DIRECTIO_ON
-   This value can be passed to IO#directio= in order to turn directio on for
-   the given file handle.
-   
-   This value is only defined if your platform supports the directio()
-   function.
-IO::DIRECTIO_OFF
-   This value can be passed to IO#directio= in order to turn directio off for
-   the given file handle.
-   
-   This value is only defined if your platform supports the directio()
-   function.
-   
-IO::EXTRA_VERSION
-   Returns the current version number of this library as a String.
-
-= Other documentation
-See the README for more documentation.