win32-nio 0.0.3 → 0.1.0

data/CHANGES

@@ -1,3 +1,7 @@
+== 0.1.0 - 12-Jul-2012
+* Changed from win32-api to FFI.
+* Now requires Ruby 1.9 or later.
+
 == 0.0.3 - 24-Apr-2010
 * Removed inline gem building from the gemspec. That's now handled by a
   Rakefile task.

data/MANIFEST

@@ -5,5 +5,9 @@
 * win32-nio.gemspec
 * benchmarks/win32_nio_benchmarks.rb
 * lib/win32/nio.rb
+* lib/windows/constants.rb
+* lib/windows/functions.rb
+* lib/windows/macros.rb
+* lib/windows/structs.rb
 * test/test_win32_nio_read.rb
-* test/test_win32_nio_readlines.rb
+* test/test_win32_nio_readlines.rb

data/README

@@ -1,6 +1,6 @@
 = Description
-   Native IO for Windows. This class matches and extends the current Ruby
-   IO class API, using native Windows functions underneath the hood.
+  Native IO for Windows. This class matches and extends the current Ruby
+  IO class API, using native Windows functions underneath the hood.
 
 = Installation
   gem install win32-nio
@@ -22,7 +22,7 @@
   an event or a block to the NIO.read method, it offers little practical
   advantage at the moment.
    
-  In addition, it is currently using pure Ruby (via win32-api), which means
+  In addition, it is currently using pure Ruby (via FFI), which means
   it isn't optimized for speed.
 
 = Benchmarks
@@ -60,7 +60,7 @@
   Artistic 2.0
     
 = Copyright
-  (C) 2008-2010 Daniel J. Berger, All Rights Reserved
+  (C) 2008-2012 Daniel J. Berger, All Rights Reserved
     
 = Warranty
   This package is provided "as is" and without any express or
@@ -70,4 +70,3 @@
 = Author(s)
   Daniel Berger
   Park Heesob
-   

data/Rakefile

@@ -1,14 +1,10 @@
 require 'rake'
+require 'rake/clean'
 require 'rake/testtask'
-require 'rbconfig'
-include Config
 
-namespace 'gem' do
-  desc 'Remove any .gem files from the project.'
-  task :clean do
-    Dir['*.gem'].each{ |f| File.delete(f) }
-  end
+CLEAN.include("**/*.gem", "**/*.txt")
 
+namespace 'gem' do
   desc 'Create the win32-nio gem'
   task :create => [:clean] do
     spec = eval(IO.read('win32-nio.gemspec'))
@@ -27,7 +23,24 @@ task :bench do
   sh "ruby -Ilib benchmarks/win32_nio_benchmarks.rb"
 end
 
-Rake::TestTask.new do |t|
-  t.verbose = true
-  t.warning = true
+namespace :test do
+  Rake::TestTask.new(:read) do |t|
+    t.verbose = true
+    t.warning = true
+    t.test_files = FileList['test/test_win32_nio_read.rb']
+  end
+
+  Rake::TestTask.new(:readlines) do |t|
+    t.verbose = true
+    t.warning = true
+    t.test_files = FileList['test/test_win32_nio_readlines.rb']
+  end
+
+  Rake::TestTask.new(:all) do |t|
+    t.verbose = true
+    t.warning = true
+    t.test_files = FileList['test/test*.rb']
+  end
 end
+
+task :default => 'test:all'

data/lib/win32/nio.rb

@@ -1,56 +1,26 @@
-require 'windows/file'
-require 'windows/handle'
-require 'windows/error'
-require 'windows/memory'
-require 'windows/nio'
-require 'windows/synchronize'
-require 'windows/system_info'
-require 'windows/thread'
-require 'windows/msvcrt/io'
-require 'windows/msvcrt/buffer'
+require 'ffi'
 require 'win32/event'
 
+require File.join(File.dirname(__FILE__), 'windows/functions')
+require File.join(File.dirname(__FILE__), 'windows/constants')
+require File.join(File.dirname(__FILE__), 'windows/structs')
+require File.join(File.dirname(__FILE__), 'windows/macros')
+
 # The Win32 module serves as a namespace only.
 module Win32
-   
+
   # The NIO class encapsulates the native IO methods for MS Windows.
   class NIO
-    include Windows::File
-    include Windows::Handle
-    include Windows::Error
-    include Windows::Synchronize
-    include Windows::MSVCRT::IO
-    include Windows::MSVCRT::Buffer
-    include Windows::SystemInfo
-    include Windows::Memory      
-    include Windows::NIO
-    include Windows::Thread
-
-    extend Windows::File
-    extend Windows::Handle
-    extend Windows::Error
-    extend Windows::Synchronize
-    extend Windows::MSVCRT::IO
-    extend Windows::MSVCRT::Buffer
-    extend Windows::SystemInfo
-    extend Windows::Memory      
-    extend Windows::NIO
-    extend Windows::Thread
-      
+    include Windows::Constants
+    include Windows::Structs
+    extend  Windows::Functions
+    extend  Windows::Macros
+
     # The version of the win32-nio library
-    VERSION = '0.0.2'
-
-    # Error typically raised if any of the native functions fail.
-    class Error < StandardError; end
-
-    # This method is similar to Ruby's IO.read method except that, in
-    # addition to using native function calls, it accepts an optional +event+
-    # argument for the fourth argument, which must be an instance of
-    # Win32::Event (if provided). The event is automatically set to a
-    # signaled state when the read operation completes.
-    #   
-    # If a block is provided, then it is treated as a callback that fires
-    # when the read operation is complete.
+    VERSION = '0.1.0'
+
+    # This method is similar to Ruby's IO.read method except that it uses
+    # native function calls.
     #
     # Examples:
     #
@@ -63,94 +33,89 @@ module Win32
     # # Read 50 bytes starting at offset 10
     # Win32::NIO.read(file, 50, 10)
     #
-    # # Read 25 bytes, starting at offset 5, and print "Done!" when finished.
-    # Win32::NIO.read(file, 25, 5){ puts "Done!" }
+    # Note that the +options+ that may be passed to this method are limited
+    # to :encoding, :mode and :event because we're no longer using the open
+    # function internally. In the case of :mode the only thing that is checked
+    # for is the presence of the 'b' (binary) mode.
     #
-    # # Attach an event that fires when finished.
-    # require 'win32/event'
-    # event = Win32::Event.new{ puts "Finished!" }
-    # Win32::NIO.read(file, nil, nil, event)
+    # The :event option, if present, must be a Win32::Event object.
+    #--
+    # In practice the fact that I ignore open_args: is irrelevant since you
+    # would never want to open in anything other than GENERIC_READ. I suppose
+    # I could change this to as a way to pass flags to CreateFile.
     #
-    def self.read(port_name, length=nil, offset=0, event=nil, &block)
-      if length
-        raise TypeError unless length.is_a?(Fixnum)
-        raise ArgumentError if length < 0
-      end
+    def self.read(name, length=nil, offset=0, options={})
+      begin
+        fname = name + "\0"
+        fname.encode!('UTF-16LE')
 
-      if offset
-        raise TypeError unless offset.is_a?(Fixnum)
-        raise ArgumentError if offset < 0
-      end
+        flags = FILE_FLAG_SEQUENTIAL_SCAN
+        olap  = Overlapped.new
+        event = options[:event]
 
-      if event
-        raise TypeError unless event.is_a?(Win32::Event)
-      end
+        if event
+          raise TypeError unless event.is_a?(Win32::Event)
+        end
 
-      flags = FILE_FLAG_SEQUENTIAL_SCAN 
+        olap[:Offset] = offset
 
-      overlapped = 0.chr * 20  # sizeof(OVERLAPPED)
-      overlapped[8,4] = [offset].pack('L') # OVERLAPPED.Offset
+        if offset > 0 || event
+          flags |= FILE_FLAG_OVERLAPPED
+          olap[:hEvent] = event.handle if event
+        end
 
-      if offset > 0 || event
-        flags |= FILE_FLAG_OVERLAPPED
-        overlapped[16,4] = [event.handle].pack('L') if event
-      end
+        handle = CreateFileW(
+          fname,
+          GENERIC_READ,
+          FILE_SHARE_READ,
+          nil,
+          OPEN_EXISTING,
+          flags,
+          0
+        )
 
-      handle = CreateFile(
-        port_name,
-        FILE_READ_DATA,
-        FILE_SHARE_READ,
-        0,
-        OPEN_EXISTING,
-        flags,
-        0
-      )
-
-      if handle == INVALID_HANDLE_VALUE
-        raise Error, get_last_error
-      end
-         
-      # Ruby's File.size is broken, so we implement it here. Also, if an
-      # offset is provided, we can reduce the size to only what we need.
-      if length.nil?
-        size = [0].pack('Q')
-        GetFileSizeEx(handle, size)
-        length = size.unpack('Q').first
-        length -= offset if offset
-      end
+        if handle == INVALID_HANDLE_VALUE
+          raise SystemCallError.new("CreateFile", FFI.errno)
+        end
 
-      buf = 0.chr * length
+        length ||= File.size(name)
+        buf  = 0.chr * length
 
-      begin
         if block_given?
-          callback = Win32::API::Callback.new('LLP', 'V'){ block.call }
-          bool = ReadFileEx(handle, buf, length, overlapped, callback)
+          callback = Proc.new{ |e,b,o| block.call }
+          bool = ReadFileEx(handle, buf, buf.size, olap, callback)
         else
-          bytes = [0].pack('L')
-          bool = ReadFile(handle, buf, length, bytes, overlapped)
+          bool = ReadFile(handle, buf, buf.size, nil, olap)
         end
-            
-        errno = GetLastError()
+
+        errno = FFI.errno
 
         SleepEx(1, true) # Must be in alertable wait state
-         
+
         unless bool
-          if errno = ERROR_IO_PENDING
-            unless GetOverlappedResult(handle, overlapped, bytes, true)
-              raise Error, get_last_error
+          if errno == ERROR_IO_PENDING
+            bytes = FFI::MemoryPointer.new(:ulong)
+            unless GetOverlappedResult(handle, olap, bytes, true)
+              raise SystemCallError.new("GetOverlappedResult", FFI.errno)
             end
           else
-            raise Error, errno
+            raise SystemCallError.new("ReadFile", errno)
           end
         end
-            
-        event.wait if event
+
+        result = buf.delete(0.chr)
+
+        result.encode!(options[:encoding]) if options[:encoding]
+
+        if options[:mode] && options[:mode].include?('t') && ($/ != "\r\n")
+          result.gsub!(/\r\n/, $/)
+        end
+
+        result
       ensure
-        CloseHandle(handle)
+        CloseHandle(handle) if handle && handle != INVALID_HANDLE_VALUE
       end
-         
-      buf[0, length]
-    end
+    end # NIO.read
 
     # Reads the entire file specified by portname as individual lines, and
     # returns those lines in an array. Lines are separated by +sep+.
@@ -159,79 +124,77 @@ module Win32
     # is drastically different. We use a scattered IO read.
     #
     def self.readlines(file, sep = "\r\n")
-      handle = CreateFile(
-        file,
-        GENERIC_READ,
-        FILE_SHARE_READ,
-        nil,
-        OPEN_EXISTING,
-        FILE_FLAG_OVERLAPPED | FILE_FLAG_NO_BUFFERING,
-        nil
-      )
-         
-      if handle == INVALID_HANDLE_VALUE
-        raise Error, get_last_error
-      end
-         
-      sysbuf = 0.chr * 40
-      GetSystemInfo(sysbuf)
-
-      file_size = [0].pack('Q')
-      GetFileSizeEx(handle, file_size)
-      file_size = file_size.unpack('Q')[0]
+      fname = file + "\0"
+      fname.encode!('UTF-16LE')
 
-      page_size = sysbuf[4,4].unpack('L')[0] # dwPageSize
-      page_num  = (file_size.to_f / page_size).ceil
-         
       begin
-        base_address = VirtualAlloc(
+        handle = CreateFileW(
+          fname,
+          GENERIC_READ,
+          FILE_SHARE_READ,
           nil,
-          page_size * page_num,
-          MEM_COMMIT,
-          PAGE_READWRITE
+          OPEN_EXISTING,
+          FILE_FLAG_OVERLAPPED | FILE_FLAG_NO_BUFFERING,
+          0
         )
-               
-        buf_list = []
-            
-        for i in 0...page_num
-          buf_list.push(base_address + page_size * i)
+
+        if handle == INVALID_HANDLE_VALUE
+          raise SystemCallError.new("CreateFileW", FFI.errno)
         end
-                  
-        seg_array  = buf_list.pack('Q*') + 0.chr * 8
-        overlapped = 0.chr * 20
-                  
-        bool = ReadFileScatter(
-          handle,
-          seg_array,
-          page_size * page_num, 
-          nil,
-          overlapped
-        )
 
-        unless bool
-          error = GetLastError()
-          if error != ERROR_IO_PENDING
-            raise Error, get_last_error(error)
+        sysinfo = SystemInfo.new
+        GetSystemInfo(sysinfo)
+
+        file_size = File.size(file)
+        page_size = sysinfo[:dwPageSize]
+        page_num  = (file_size.to_f / page_size).ceil
+
+        begin
+          size = page_size * page_num
+          base_address = VirtualAlloc(nil, size, MEM_COMMIT, PAGE_READWRITE)
+
+          if base_address == 0
+            raise SystemCallError.new("VirtualAlloc", FFI.errno)
           end
-        end
 
-        SleepEx(1, true) unless HasOverlappedIoCompleted(overlapped)
+          # Add 1 for null as per the docs
+          array = FFI::MemoryPointer.new(FileSegmentElement, page_num + 1)
 
-        buffer = 0.chr * file_size
-        memcpy(buffer, buf_list[0], file_size)
-      ensure
-        CloseHandle(handle)
-        VirtualFree(base_address, 0, MEM_RELEASE)
-      end
+          for i in 0...page_num
+            fse = FileSegmentElement.new(array[i])
+            fse[:Alignment] = base_address + page_size * i
+          end
+
+          overlapped = Overlapped.new
+
+          bool = ReadFileScatter(handle, array, size, nil, overlapped)
+
+          unless bool
+            error = FFI.errno
+            if error == ERROR_IO_PENDING
+              SleepEx(1, true) while !HasOverlappedIoCompleted(overlapped)
+            else
+              raise SystemCallError.new("ReadFileScatter", error)
+            end
+          end
 
-      if sep == ""
-        buffer = buffer.split(/(\r\n){2,}/)
-        buffer.delete("\r\n")
-      else
-        buffer = buffer.split(sep)
+          string = array[0].read_pointer.read_string
+
+          if sep == ""
+            array = string.split(/(\r\n){2,}/)
+            array.delete("\r\n")
+          else
+            array = string.split(sep)
+          end
+
+          array
+        ensure
+          VirtualFree(base_address, 0, MEM_RELEASE)
+        end
+      ensure
+        CloseHandle(handle) if handle && handle != INVALID_HANDLE_VALUE
       end
+    end # NIO.readlines
 
-      buffer
-    end
-  end
-end
+  end # NIO
+end # Win32

data/lib/win32/windows/constants.rb

@@ -0,0 +1,72 @@
+module Windows
+  module Constants
+    INVALID_HANDLE_VALUE = 0xFFFFFFFF
+
+    CREATE_NEW        = 1
+    CREATE_ALWAYS     = 2
+    OPEN_EXISTING     = 3
+    OPEN_ALWAYS       = 4
+    TRUNCATE_EXISTING = 5
+
+    GENERIC_READ    = 0x80000000
+    GENERIC_WRITE   = 0x40000000
+    GENERIC_EXECUTE = 0x20000000
+    GENERIC_ALL     = 0x10000000
+
+    FILE_SHARE_READ = 0x00000001
+
+    FILE_FLAG_WRITE_THROUGH       = 0x80000000
+    FILE_FLAG_OVERLAPPED          = 0x40000000
+    FILE_FLAG_NO_BUFFERING        = 0x20000000
+    FILE_FLAG_RANDOM_ACCESS       = 0x10000000
+    FILE_FLAG_SEQUENTIAL_SCAN     = 0x08000000
+    FILE_FLAG_DELETE_ON_CLOSE     = 0x04000000
+    FILE_FLAG_BACKUP_SEMANTICS    = 0x02000000
+    FILE_FLAG_POSIX_SEMANTICS     = 0x01000000
+    FILE_FLAG_OPEN_REPARSE_POINT  = 0x00200000
+    FILE_FLAG_OPEN_NO_RECALL      = 0x00100000
+    FILE_FLAG_FIRST_PIPE_INSTANCE = 0x00080000
+
+    MEM_COMMIT      = 0x1000
+    MEM_RESERVE     = 0x2000
+    MEM_DECOMMIT    = 0x4000
+    MEM_RELEASE     = 0x8000
+    MEM_FREE        = 0x10000
+    MEM_PRIVATE     = 0x20000
+    MEM_MAPPED      = 0x40000
+    MEM_RESET       = 0x80000
+    MEM_TOP_DOWN    = 0x100000
+    MEM_WRITE_WATCH = 0x200000
+    MEM_PHYSICAL    = 0x400000
+    MEM_LARGE_PAGES = 0x20000000
+    MEM_4MB_PAGES   = 0x80000000
+
+    PAGE_NOACCESS          = 0x01
+    PAGE_READONLY          = 0x02
+    PAGE_READWRITE         = 0x04
+    PAGE_WRITECOPY         = 0x08
+    PAGE_EXECUTE           = 0x10
+    PAGE_EXECUTE_READ      = 0x20
+    PAGE_EXECUTE_READWRITE = 0x40
+    PAGE_EXECUTE_WRITECOPY = 0x80
+    PAGE_GUARD             = 0x100
+    PAGE_NOCACHE           = 0x200
+    PAGE_WRITECOMBINE      = 0x400
+
+    INFINITE         = 0xFFFFFFFF
+    WAIT_OBJECT_0    = 0
+    WAIT_TIMEOUT     = 0x102
+    WAIT_ABANDONED   = 128
+    WAIT_ABANDONED_0 = WAIT_ABANDONED
+    WAIT_FAILED      = 0xFFFFFFFF
+    
+    STATUS_WAIT_0           =  0    
+    STATUS_ABANDONED_WAIT_0 =  128    
+    STATUS_USER_APC         =  192    
+    STATUS_TIMEOUT          =  258    
+    STATUS_PENDING          =  259
+
+    ERROR_IO_INCOMPLETE     = 996
+    ERROR_IO_PENDING        = 997
+  end
+end

data/lib/win32/windows/functions.rb

@@ -0,0 +1,23 @@
+require 'ffi'
+
+module Windows
+  module Functions
+    extend FFI::Library
+    ffi_lib :kernel32
+    ffi_convention :stdcall
+
+    attach_function :CloseHandle, [:long], :bool
+    attach_function :CreateFileA, [:string, :ulong, :ulong, :pointer, :ulong, :ulong, :ulong], :ulong
+    attach_function :CreateFileW, [:buffer_in, :ulong, :ulong, :pointer, :ulong, :ulong, :ulong], :ulong
+    attach_function :GetOverlappedResult, [:ulong, :pointer, :pointer, :bool], :bool
+    attach_function :GetSystemInfo, [:pointer], :void
+    attach_function :ReadFile, [:ulong, :buffer_out, :ulong, :pointer, :pointer], :bool
+    attach_function :ReadFileScatter, [:ulong, :pointer, :ulong, :pointer, :pointer], :bool
+    attach_function :SleepEx, [:ulong, :bool], :ulong
+    attach_function :VirtualAlloc, [:pointer, :size_t, :ulong, :ulong], :ulong
+    attach_function :VirtualFree, [:ulong, :size_t, :ulong], :bool
+
+    callback :completion_function, [:ulong, :ulong, :pointer], :void
+    attach_function :ReadFileEx, [:ulong, :buffer_out, :ulong, :pointer, :completion_function], :bool
+  end
+end

data/lib/win32/windows/macros.rb

@@ -0,0 +1,7 @@
+module Windows
+  module Macros
+    def HasOverlappedIoCompleted(overlapped)
+      overlapped[:Internal] != 259 # STATUS_PENDING
+    end
+  end
+end

data/lib/win32/windows/structs.rb

@@ -0,0 +1,39 @@
+require 'ffi'
+
+module Windows
+  module Structs
+    extend FFI::Library
+
+    # I'm assuming the anonymous struct for the internal union here.
+    class Overlapped < FFI::Struct
+      layout(
+        :Internal, :ulong,
+        :InternalHigh, :ulong,
+        :Offset, :ulong,
+        :OffsetHigh, :ulong,
+        :hEvent, :ulong
+      )
+    end
+
+    # dwOemId is deprecated. Just assume the nested struct.
+    class SystemInfo < FFI::Struct
+      layout(
+        :wProcessorArchitecture, :ushort,
+        :wReserved, :ushort,
+        :dwPageSize, :ulong,
+        :lpMinimumApplicationAddress, :pointer,
+        :lpMaximumApplicationAddress, :pointer,
+        :dwActiveProcessorMask, :pointer,
+        :dwNumberOfProcessors, :ulong,
+        :dwProcessorType, :ulong,
+        :dwAllocationGranularity, :ulong,
+        :wProcessorLevel, :ushort,
+        :wProcessorRevision, :ushort
+      )
+    end
+
+    class FileSegmentElement < FFI::Union
+      layout(:Buffer, :pointer, :Alignment, :uint64)
+    end
+  end
+end

data/test/test_win32_nio_read.rb

@@ -1,90 +1,82 @@
-require 'rubygems'
-gem 'test-unit'
-
+########################################################################
+# test_win32_nio_read.rb
+#
+# Tests for the NIO.read method.
+########################################################################
+require 'test-unit'
 require 'win32/nio'
 require 'test/unit'
 include Win32
 
 class TC_Win32_NIO_Read < Test::Unit::TestCase
-   def self.startup
-      Dir.chdir(File.expand_path(File.dirname(__FILE__)))
+  def self.startup
+    Dir.chdir(File.expand_path(File.dirname(__FILE__)))
+
+    @@file = 'read_test.txt'
+    @@text = "The quick brown fox jumped over the lazy dog's back"
+
+    File.open(@@file, 'w'){ |fh|
+      100.times{ |n| fh.puts @@text + ": #{n}" }
+    }
+  end
+
+  def setup
+    @size  = File.size(@@file)
+  end
+
+  test "version number is set to expected value" do
+    assert_equal('0.1.0', Win32::NIO::VERSION)
+  end
+
+  test "read method basic functionality" do
+    assert_respond_to(NIO, :read)
+    assert_nothing_raised{ NIO.read(@@file) }
+  end
 
-      @@file = 'read_test.txt'
-      @@text = "The quick brown fox jumped over the lazy dog's back"
-      
-      File.open(@@file, 'w'){ |fh|
-         100.times{ |n|
-            fh.puts @@text + ": #{n}"
-         }
-      }
-   end
+  test "read method accepts a file name and returns a string of the expected size" do
+    assert_kind_of(String, NIO.read(@@file))
+    p @size
+    p NIO.read(@@file).size
+    assert_true(NIO.read(@@file).size == @size)
+  end
 
-   def setup
-      @size  = File.size(@@file)
-      @event = Win32::Event.new('test')
-   end
-   
-   def test_nio_version
-      assert_equal('0.0.2', Win32::NIO::VERSION)      
-   end
+  test "read method accepts a length argument and returns a string of that length" do
+    assert_nothing_raised{ NIO.read(@@file, 19) }
+    assert_equal('The quick brown fox', NIO.read(@@file, 19))
+    assert_equal('', NIO.read(@@file, 0))
+  end
 
-   def test_nio_read_basic
-      assert_respond_to(NIO, :read)
-   end
+  test "read method accepts an offset and returns a string between offset and length" do
+    assert_nothing_raised{ NIO.read(@@file, 19, 4) }
+    assert_equal('quick brown fox', NIO.read(@@file, 15, 4))
+    assert_equal("lazy dog's back: 99\r\n", NIO.read(@@file, nil, @size-21))
+  end
 
-   def test_nio_read_with_file_name
-      assert_nothing_raised{ NIO.read(@@file) }
-      assert_kind_of(String, NIO.read(@@file))
-      assert_true(NIO.read(@@file).size == @size)
-   end
+  test "read method requires at least one argument" do
+    assert_raise(ArgumentError){ NIO.read }
+  end
 
-   def test_nio_read_with_file_name_and_length
-      assert_nothing_raised{ NIO.read(@@file, 19) }
-      assert_equal('The quick brown fox', NIO.read(@@file, 19))
-      assert_equal('', NIO.read(@@file, 0))
-   end
+  test "length parameter must be a positive number" do
+    assert_raise(ArgumentError){ NIO.read(@@file, -1) }
+    assert_raise(TypeError){ NIO.read(@@file, 'foo') }
+  end
 
-   def test_nio_read_with_file_name_and_length_and_offset
-      assert_nothing_raised{ NIO.read(@@file, 19, 4) }
-      assert_equal('quick brown fox', NIO.read(@@file, 15, 4))
-      assert_equal("lazy dog's back: 99\r\n", NIO.read(@@file, nil, @size-21))
-   end
-   
-   def test_nio_read_with_event
-      assert_false(@event.signaled?)
-      assert_nothing_raised{ NIO.read(@@file, 9, 0, @event) }
-      assert_true(@event.signaled?)
-   end
+  test "offset parameter must be a positive number" do
+    assert_raise(Errno::EINVAL, Errno::ENAMETOOLONG){ NIO.read(@@file, 1, -1) }
+    assert_raise(TypeError){ NIO.read(@@file, 1, 'foo') }
+  end
 
-   def test_nio_read_expected_errors
-      assert_raise(ArgumentError){ NIO.read }
-      assert_raise(ArgumentError){ NIO.read(@@file, -1) }
-      assert_raise(TypeError){ NIO.read(@@file, 'foo') }
-      assert_raise(ArgumentError){ NIO.read(@@file, 1, -1) }
-      assert_raise(TypeError){ NIO.read(@@file, 1, 'foo') }
-      assert_raise(TypeError){ NIO.read(@@file, 1, 1, 'foo') }
-   end
-   
-   def test_readlines_basic
-      assert_respond_to(NIO, :readlines)
-      assert_nothing_raised{ NIO.readlines(@@file) }
-      assert_kind_of(Array, NIO.readlines(@@file))   
-   end
-   
-   def test_readlines
-      assert_equal("#{@@text}: 0", NIO.readlines(@@file).first)
-      assert_equal("#{@@text}: 99", NIO.readlines(@@file).last)    
-   end
+  test "options parameter must be a hash" do
+    assert_raise(TypeError){ NIO.read(@@file, 1, 1, 'foo') }
+  end
 
-   def teardown
-      @size = nil
-      @event.close if @event
-      @event = nil
-   end
+  def teardown
+    @size = nil
+  end
 
-   def self.shutdown
-      File.delete(@@file) if File.exists?(@@file)
-      @@file = nil
-      @@text = nil
-   end
+  def self.shutdown
+    File.delete(@@file) if File.exists?(@@file)
+    @@file = nil
+    @@text = nil
+  end
 end

data/test/test_win32_nio_readlines.rb

@@ -3,59 +3,64 @@
 #
 # Test case for the Win32::NIO.readlines method.
 #######################################################################
-require 'rubygems'
-gem 'test-unit'
-require 'test/unit'
+require 'test-unit'
 require 'win32/nio'
 include Win32
 
 class TC_Win32_NIO_Readlines < Test::Unit::TestCase
-   def self.startup
-      @@line = "The quick brown fox jumped over the lazy dog's back"
-      @@file = "readlines_test.txt"
-      @@size = 10
-      File.open(@@file, 'w'){ |fh|
-         1.upto(@@size){ |n|
-            fh.puts @@line + ": #{n}"
-            fh.puts if n % 3 == 0
-         }
+  def self.startup
+    @@line = "The quick brown fox jumped over the lazy dog's back"
+    @@file = "readlines_test.txt"
+    @@size = 10
+
+    File.open(@@file, 'w'){ |fh|
+      1.upto(@@size){ |n|
+        fh.puts @@line + ": #{n}"
+        fh.puts if n % 3 == 0
       }
-   end
-
-   def setup
-      @array = nil
-   end
-
-   def test_nio_readlines_basic
-      assert_respond_to(NIO, :readlines)
-   end
-
-   def test_nio_readlines
-      assert_nothing_raised{ NIO.readlines(@@file) }
-      assert_kind_of(Array, NIO.readlines(@@file))
-      assert_equal(@@size + 3, NIO.readlines(@@file).size)
-      assert_equal(@@line + ': 1', NIO.readlines(@@file).first)
-   end
-
-   def test_nio_readlines_with_empty_line_ending
-      assert_nothing_raised{ NIO.readlines(@@file, '') }
-      assert_kind_of(Array, NIO.readlines(@@file, ''))
-      assert_equal(4, NIO.readlines(@@file, '').size)
-   end
-
-   def test_nio_readlines_expected_errors
-      assert_raise(ArgumentError){ NIO.readlines }
-      assert_raise(ArgumentError){ NIO.readlines(@@file, '', true) }
-   end
-
-   def teardown
-      @array = nil
-   end
-
-   def self.shutdown
-      File.delete(@@file) if File.exists?(@@file)
-      @@file = nil
-      @@size = nil
-      @@line = nil
-   end
+    }
+  end
+
+  def setup
+    @array = nil
+  end
+
+  test "readlines method basic functionality" do
+    assert_respond_to(NIO, :readlines)
+    assert_nothing_raised{ NIO.readlines(@@file) }
+  end
+
+  test "readlines returns an array" do
+    assert_kind_of(Array, NIO.readlines(@@file))
+  end
+
+  test "readlines returns an array of the expected size" do
+    assert_equal(@@size + 3, NIO.readlines(@@file).size)
+    assert_equal(@@line + ': 1', NIO.readlines(@@file).first)
+  end
+
+  test "readlines treats an empty second argument as a paragraph separator" do
+    assert_nothing_raised{ NIO.readlines(@@file, '') }
+    assert_kind_of(Array, NIO.readlines(@@file, ''))
+    assert_equal(4, NIO.readlines(@@file, '').size)
+  end
+
+  test "readlines expects at least one argument" do
+    assert_raise(ArgumentError){ NIO.readlines }
+  end
+
+  test "readlines accepts a maximum of two arguments" do
+    assert_raise(ArgumentError){ NIO.readlines(@@file, '', true) }
+  end
+
+  def teardown
+    @array = nil
+  end
+
+  def self.shutdown
+    File.delete(@@file) if File.exists?(@@file)
+    @@file = nil
+    @@size = nil
+    @@line = nil
+  end
 end

data/win32-nio.gemspec

@@ -2,18 +2,22 @@ require 'rubygems'
 
 Gem::Specification.new do |spec|
   spec.name     = 'win32-nio'
-  spec.version  = '0.0.3'
+  spec.version  = '0.1.0'
   spec.author   = 'Daniel J. Berger'
   spec.license  = 'Artistic 2.0'
   spec.email    = 'djberg96@gmail.com'
   spec.homepage = 'http://www.rubyforge.org/projects/win32utils'
-  spec.platform = Gem::Platform::RUBY
   spec.summary  = 'Native IO for MS Windows'
-  spec.has_rdoc = true
   spec.files    = Dir['**/*'].reject{ |f| f.include?('git') }
 
   spec.rubyforge_project = 'Win32Utils'
   spec.extra_rdoc_files  = ['README', 'CHANGES', 'MANIFEST']
+  spec.required_ruby_version = '> 1.9.0'
+
+  spec.add_dependency('ffi')
+  spec.add_dependency('win32-event', '>= 0.6.0')
+
+  spec.add_development_dependency('test-unit')
 
   spec.description = <<-EOF
     The win32-nio library implements certain IO methods using native
@@ -21,8 +25,4 @@ Gem::Specification.new do |spec|
     layer that MRI typically uses. In addition, some methods provide
     additional event handling capability.
   EOF
-
-  spec.add_dependency('windows-pr', '>= 0.9.5')
-  spec.add_dependency('win32-event', '>= 0.5.0')
-  spec.add_development_dependency('test-unit', '>= 2.0.3')
 end

metadata

@@ -1,113 +1,112 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: win32-nio
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 0
-  - 3
-  version: 0.0.3
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Daniel J. Berger
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2010-04-24 00:00:00 -06:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: windows-pr
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        - 9
-        - 5
-        version: 0.9.5
+date: 2012-07-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ffi
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: win32-event
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        - 5
-        - 0
-        version: 0.5.0
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: win32-event
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.6.0
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: test-unit
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 2
-        - 0
-        - 3
-        version: 2.0.3
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id003
-description: "    The win32-nio library implements certain IO methods using native\n    Windows function calls rather than using the POSIX compatibility\n    layer that MRI typically uses. In addition, some methods provide\n    additional event handling capability.\n"
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! "    The win32-nio library implements certain IO methods using native\n
+  \   Windows function calls rather than using the POSIX compatibility\n    layer
+  that MRI typically uses. In addition, some methods provide\n    additional event
+  handling capability.\n"
 email: djberg96@gmail.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - README
 - CHANGES
 - MANIFEST
-files: 
+files:
 - benchmarks/win32_nio_benchmarks.rb
 - CHANGES
 - lib/win32/nio.rb
+- lib/win32/windows/constants.rb
+- lib/win32/windows/functions.rb
+- lib/win32/windows/macros.rb
+- lib/win32/windows/structs.rb
 - MANIFEST
 - Rakefile
 - README
 - test/test_win32_nio_read.rb
 - test/test_win32_nio_readlines.rb
 - win32-nio.gemspec
-has_rdoc: true
 homepage: http://www.rubyforge.org/projects/win32utils
-licenses: 
+licenses:
 - Artistic 2.0
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>'
+    - !ruby/object:Gem::Version
+      version: 1.9.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: Win32Utils
-rubygems_version: 1.3.6
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Native IO for MS Windows
 test_files: []
-