win32-nio 0.1.1 → 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0e0c6f82dd50fb6d6c72e8debf48914350850adb
+  data.tar.gz: 375cf9ae2ca2a33313714c3b29180bfb2b391134
+SHA512:
+  metadata.gz: ce3a15a046baebf4051e44a62d40f5bd8d13afa7cf2c425ddd9f076a8a92467fc1a77d92a9376f74b59bebff6514e6dc73562ec98a28cab823c0d82ca160566f
+  data.tar.gz: 467026cf075920fc853ccdbe6a4eea13418b5b33ab1851e05523dd5010e0b316ab90c24baaafa70323acbd20354cf51074a4564fe155feccc069b64dea78a9c0

data/CHANGES

@@ -1,21 +1,27 @@
-== 0.1.1 - 10-Apr-2013
-* Updated the HANDLE type in the underlying FFI code. This affects
-  64 bit versions of Ruby.
-
-== 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.
-* Rafactored the Rakefile, removed an old install task and added new
-  gem tasks.
-
-== 0.0.2 - 6-Aug-2009
-* License changed to Artistic 2.0.
-* Some gemspec updates, including adding win32-event as a dependency and
-  test-unit as a development dependency.
-
-== 0.0.1 - 28-Nov-2008
-* Initial release
+== 0.1.2 - 20-Oct-2013
+* Fixed the underlying data types for the OVERLAPPED FFI struct. This
+  affected 64-bit versions of Ruby.
+* Updated gem:create task for Rubygems 2.x.
+* Removed unnecessary require in test suite.
+
+== 0.1.1 - 10-Apr-2013
+* Updated the HANDLE type in the underlying FFI code. This affects
+  64 bit versions of Ruby.
+
+== 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.
+* Rafactored the Rakefile, removed an old install task and added new
+  gem tasks.
+
+== 0.0.2 - 6-Aug-2009
+* License changed to Artistic 2.0.
+* Some gemspec updates, including adding win32-event as a dependency and
+  test-unit as a development dependency.
+
+== 0.0.1 - 28-Nov-2008
+* Initial release

data/MANIFEST

@@ -1,13 +1,13 @@
-* CHANGES
-* MANIFEST
-* Rakefile
-* README
-* 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
+* CHANGES
+* MANIFEST
+* Rakefile
+* README
+* 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

data/README

@@ -1,72 +1,72 @@
-= Description
-  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
-
-= Synopsis
-  require 'win32/nio'
-  include Win32
-   
-  p NIO.read('some_file.text')
-   
-  p NIO.readlines('some_file.txt')
-   
-= Proof of Concept
-  This code is ALPHA!
-  
-  This code is mostly a proof of concept to see how to implement Ruby's
-  IO functions in pure Windows functions. While it does offer a couple of
-  features over and above Ruby's IO interface, such as the ability to supply
-  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 FFI), which means
-  it isn't optimized for speed.
-
-= Benchmarks
-
-  Using my HP Windows XP Pro laptop, with a 1.66 core duo Pentium T5500 and
-  2gb of RAM, I saw these results, which were typical in repeated runs:
-                         
-                          user     system      total        real
-  IO.read(small)         0.016000   0.047000   0.063000 (  0.063000)
-  NIO.read(small)        0.109000   0.000000   0.109000 (  0.109000)
-  IO.read(medium)        0.422000   0.094000   0.516000 (  0.532000)
-  NIO.read(medium)       0.937000   0.062000   0.999000 (  1.047000)
-  IO.read(large)         3.282000   1.063000   4.345000 (  4.468000)
-  NIO.read(large)        8.187000   1.062000   9.249000 (  9.454000)
-  IO.readlines(small)    0.156000   0.063000   0.219000 (  0.234000)
-  NIO.readlines(small)   0.141000   0.000000   0.141000 (  0.797000)
-  IO.readlines(medium)   2.984000   0.250000   3.234000 (  3.625000)
-  NIO.readlines(medium)  1.172000   0.062000   1.234000 (  3.406000)
-  IO.readlines(large)    18.625000   2.281000  20.906000 ( 21.532000)
-  NIO.readlines(large)   12.406000   0.563000  12.969000 (122.643000)
-   
-  Note that, in most cases, the user and system time has decreased, but
-  the real time has increased.
-   
-= Known Bugs
-  None that I know of. Please log any other bug reports on the RubyForge
-  project page at https://github.com/djberg96/win32-nio.
-
-= Future Plans
-  The pure Ruby code is really only meant for prototyping. The eventual
-  plan is to convert the Ruby code to equivalent C code in order to improve
-  performance.
-
-= License
-  Artistic 2.0
-    
-= Copyright
-  (C) 2008-2013 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(s)
-  Daniel Berger
-  Park Heesob
+= Description
+  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
+
+= Synopsis
+  require 'win32/nio'
+  include Win32
+   
+  p NIO.read('some_file.text')
+   
+  p NIO.readlines('some_file.txt')
+   
+= Proof of Concept
+  This code is ALPHA!
+  
+  This code is mostly a proof of concept to see how to implement Ruby's
+  IO functions in pure Windows functions. While it does offer a couple of
+  features over and above Ruby's IO interface, such as the ability to supply
+  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 FFI), which means
+  it isn't optimized for speed.
+
+= Benchmarks
+
+  Using my HP Windows XP Pro laptop, with a 1.66 core duo Pentium T5500 and
+  2gb of RAM, I saw these results, which were typical in repeated runs:
+                         
+                          user     system      total        real
+  IO.read(small)         0.016000   0.047000   0.063000 (  0.063000)
+  NIO.read(small)        0.109000   0.000000   0.109000 (  0.109000)
+  IO.read(medium)        0.422000   0.094000   0.516000 (  0.532000)
+  NIO.read(medium)       0.937000   0.062000   0.999000 (  1.047000)
+  IO.read(large)         3.282000   1.063000   4.345000 (  4.468000)
+  NIO.read(large)        8.187000   1.062000   9.249000 (  9.454000)
+  IO.readlines(small)    0.156000   0.063000   0.219000 (  0.234000)
+  NIO.readlines(small)   0.141000   0.000000   0.141000 (  0.797000)
+  IO.readlines(medium)   2.984000   0.250000   3.234000 (  3.625000)
+  NIO.readlines(medium)  1.172000   0.062000   1.234000 (  3.406000)
+  IO.readlines(large)    18.625000   2.281000  20.906000 ( 21.532000)
+  NIO.readlines(large)   12.406000   0.563000  12.969000 (122.643000)
+   
+  Note that, in most cases, the user and system time has decreased, but
+  the real time has increased.
+   
+= Known Bugs
+  None that I know of. Please log any other bug reports on the RubyForge
+  project page at https://github.com/djberg96/win32-nio.
+
+= Future Plans
+  The pure Ruby code is really only meant for prototyping. The eventual
+  plan is to convert the Ruby code to equivalent C code in order to improve
+  performance.
+
+= License
+  Artistic 2.0
+    
+= Copyright
+  (C) 2008-2013 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(s)
+  Daniel Berger
+  Park Heesob

data/Rakefile

@@ -1,46 +1,51 @@
-require 'rake'
-require 'rake/clean'
-require 'rake/testtask'
-
-CLEAN.include("**/*.gem", "**/*.txt")
-
-namespace 'gem' do
-  desc 'Create the win32-nio gem'
-  task :create => [:clean] do
-    spec = eval(IO.read('win32-nio.gemspec'))
-    Gem::Builder.new(spec).build
-  end
-
-  desc 'Install the win32-nio gem'
-  task :install => [:create] do
-    file = Dir['*.gem'].first
-    sh "gem install #{file}"
-  end
-end
-
-desc 'Run the benchmark suite'
-task :bench do
-  sh "ruby -Ilib benchmarks/win32_nio_benchmarks.rb"
-end
-
-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'
+require 'rake'
+require 'rake/clean'
+require 'rake/testtask'
+
+CLEAN.include("**/*.gem", "**/*.txt")
+
+namespace 'gem' do
+  desc 'Create the win32-nio gem'
+  task :create => [:clean] do
+    spec = eval(IO.read('win32-nio.gemspec'))
+    if Gem::VERSION < "2.0.0"
+      Gem::Builder.new(spec).build
+    else
+      require 'rubygems/package'
+      Gem::Package.build(spec)
+    end
+  end
+
+  desc 'Install the win32-nio gem'
+  task :install => [:create] do
+    file = Dir['*.gem'].first
+    sh "gem install #{file}"
+  end
+end
+
+desc 'Run the benchmark suite'
+task :bench do
+  sh "ruby -Ilib benchmarks/win32_nio_benchmarks.rb"
+end
+
+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/benchmarks/win32_nio_benchmarks.rb

@@ -1,113 +1,113 @@
-########################################################################
-# win32_nio_benchmarks.rb
-#
-# Run this via the 'rake bench' task to compare win32-nio with Ruby's
-# own IO methods. This benchmark will take a bit of time, since it
-# generates some test files on the fly.
-########################################################################
-require 'benchmark'
-require 'win32/nio'
-include Win32
-
-MAX = (ARGV[0] || '10').chomp.to_i # Default to 10 iterations
-PHRASE = "The quick brown fox jumped over the lazy dog's back"
-
-SMALL_FILE  = "small_nio_test.txt"  # 588k
-MEDIUM_FILE = "medium_nio_test.txt" # 6mb
-LARGE_FILE  = "large_nio_test.txt"  # 60mb
-HUGE_FILE   = "huge_nio_test.txt"   # 618mb
-
-unless File.exists?(SMALL_FILE)
-   File.open(SMALL_FILE, 'w'){ |fh|
-      10000.times{ |n| fh.puts PHRASE + ": #{n}" }
-   }
-
-   puts "Small file created"
-end
-
-unless File.exists?(MEDIUM_FILE)
-   File.open(MEDIUM_FILE, 'w'){ |fh|
-      110000.times{ |n| fh.puts PHRASE + ": #{n}" }
-   }
-
-   puts "Medium file created"
-end
-
-unless File.exists?(LARGE_FILE)
-   File.open(LARGE_FILE, 'w'){ |fh|
-      1000000.times{ |n| fh.puts PHRASE + ": #{n}" }
-   }
-
-   puts "Large file created"
-end
-
-unless File.exists?(HUGE_FILE)
-   #File.open(HUGE_FILE, 'w'){ |fh|
-   #   10000000.times{ |n| fh.puts PHRASE + ": #{n}" }
-   #}
-
-   #puts "Huge file created"
-end
-
-Benchmark.bm(20) do |x|
-   x.report('IO.read(small)'){
-      MAX.times{ IO.read(SMALL_FILE) }
-   }
-
-   x.report('NIO.read(small)'){
-      MAX.times{ NIO.read(SMALL_FILE) }
-   }
-
-   x.report('IO.read(medium)'){
-      MAX.times{ IO.read(MEDIUM_FILE) }
-   }
-
-   x.report('NIO.read(medium)'){
-      MAX.times{ NIO.read(MEDIUM_FILE) }
-   }
-
-   x.report('IO.read(large)'){
-      MAX.times{ IO.read(LARGE_FILE) }
-   }
-
-   x.report('NIO.read(large)'){
-      MAX.times{ NIO.read(LARGE_FILE) }
-   }
-
-   #x.report('IO.read(huge)'){
-   #   MAX.times{ IO.read(HUGE_FILE) }
-   #}
-
-   #x.report('NIO.read(huge)'){
-   #   MAX.times{ NIO.read(HUGE_FILE) }
-   #}
-
-   x.report('IO.readlines(small)'){
-      MAX.times{ IO.readlines(SMALL_FILE) }
-   }
-
-   x.report('NIO.readlines(small)'){
-      MAX.times{ NIO.readlines(SMALL_FILE) }
-   }
-   
-   x.report('IO.readlines(medium)'){
-      MAX.times{ IO.readlines(MEDIUM_FILE) }
-   }
-
-   x.report('NIO.readlines(medium)'){
-      MAX.times{ NIO.readlines(MEDIUM_FILE) }
-   }
-   
-   x.report('IO.readlines(large)'){
-      MAX.times{ IO.readlines(LARGE_FILE) }
-   }
-
-   x.report('NIO.readlines(large)'){
-      MAX.times{ NIO.readlines(LARGE_FILE) }
-   }
-end
-
-File.delete(SMALL_FILE) if File.exists?(SMALL_FILE)
-File.delete(MEDIUM_FILE) if File.exists?(MEDIUM_FILE)
-File.delete(LARGE_FILE) if File.exists?(LARGE_FILE)
-File.delete(HUGE_FILE) if File.exists?(HUGE_FILE)
+########################################################################
+# win32_nio_benchmarks.rb
+#
+# Run this via the 'rake bench' task to compare win32-nio with Ruby's
+# own IO methods. This benchmark will take a bit of time, since it
+# generates some test files on the fly.
+########################################################################
+require 'benchmark'
+require 'win32/nio'
+include Win32
+
+MAX = (ARGV[0] || '10').chomp.to_i # Default to 10 iterations
+PHRASE = "The quick brown fox jumped over the lazy dog's back"
+
+SMALL_FILE  = "small_nio_test.txt"  # 588k
+MEDIUM_FILE = "medium_nio_test.txt" # 6mb
+LARGE_FILE  = "large_nio_test.txt"  # 60mb
+HUGE_FILE   = "huge_nio_test.txt"   # 618mb
+
+unless File.exists?(SMALL_FILE)
+   File.open(SMALL_FILE, 'w'){ |fh|
+      10000.times{ |n| fh.puts PHRASE + ": #{n}" }
+   }
+
+   puts "Small file created"
+end
+
+unless File.exists?(MEDIUM_FILE)
+   File.open(MEDIUM_FILE, 'w'){ |fh|
+      110000.times{ |n| fh.puts PHRASE + ": #{n}" }
+   }
+
+   puts "Medium file created"
+end
+
+unless File.exists?(LARGE_FILE)
+   File.open(LARGE_FILE, 'w'){ |fh|
+      1000000.times{ |n| fh.puts PHRASE + ": #{n}" }
+   }
+
+   puts "Large file created"
+end
+
+unless File.exists?(HUGE_FILE)
+   #File.open(HUGE_FILE, 'w'){ |fh|
+   #   10000000.times{ |n| fh.puts PHRASE + ": #{n}" }
+   #}
+
+   #puts "Huge file created"
+end
+
+Benchmark.bm(20) do |x|
+   x.report('IO.read(small)'){
+      MAX.times{ IO.read(SMALL_FILE) }
+   }
+
+   x.report('NIO.read(small)'){
+      MAX.times{ NIO.read(SMALL_FILE) }
+   }
+
+   x.report('IO.read(medium)'){
+      MAX.times{ IO.read(MEDIUM_FILE) }
+   }
+
+   x.report('NIO.read(medium)'){
+      MAX.times{ NIO.read(MEDIUM_FILE) }
+   }
+
+   x.report('IO.read(large)'){
+      MAX.times{ IO.read(LARGE_FILE) }
+   }
+
+   x.report('NIO.read(large)'){
+      MAX.times{ NIO.read(LARGE_FILE) }
+   }
+
+   #x.report('IO.read(huge)'){
+   #   MAX.times{ IO.read(HUGE_FILE) }
+   #}
+
+   #x.report('NIO.read(huge)'){
+   #   MAX.times{ NIO.read(HUGE_FILE) }
+   #}
+
+   x.report('IO.readlines(small)'){
+      MAX.times{ IO.readlines(SMALL_FILE) }
+   }
+
+   x.report('NIO.readlines(small)'){
+      MAX.times{ NIO.readlines(SMALL_FILE) }
+   }
+   
+   x.report('IO.readlines(medium)'){
+      MAX.times{ IO.readlines(MEDIUM_FILE) }
+   }
+
+   x.report('NIO.readlines(medium)'){
+      MAX.times{ NIO.readlines(MEDIUM_FILE) }
+   }
+   
+   x.report('IO.readlines(large)'){
+      MAX.times{ IO.readlines(LARGE_FILE) }
+   }
+
+   x.report('NIO.readlines(large)'){
+      MAX.times{ NIO.readlines(LARGE_FILE) }
+   }
+end
+
+File.delete(SMALL_FILE) if File.exists?(SMALL_FILE)
+File.delete(MEDIUM_FILE) if File.exists?(MEDIUM_FILE)
+File.delete(LARGE_FILE) if File.exists?(LARGE_FILE)
+File.delete(HUGE_FILE) if File.exists?(HUGE_FILE)