win32-pipe 0.2.1 → 0.2.2

data/CHANGES

@@ -1,3 +1,8 @@
+== 0.2.2 - 19-Mar-2012
+* Added test-unit 2.x as a development dependency.
+* Refactored some tests to use features of test-unit 2.x.
+* Refactored the Rakefile.
+
 == 0.2.1 - 9-Aug-2009
 * License changed to Artistic 2.0.
 * Test and example files renamed.

data/Rakefile

@@ -1,48 +1,48 @@
 require 'rake'
 require 'rake/clean'
 require 'rake/testtask'
-require 'rbconfig'
-include Config
 
-desc 'Install the win32-pipe library (non-gem)'
-task :install do
-   sitelibdir = CONFIG['sitelibdir']
+CLEAN.include("**/*.gem")
 
-   pipe_installdir = File.join(sitelibdir, 'win32')
-   sub_installdir = File.join(sitelibdir, 'win32', 'pipe')
+namespace :gem do
+  desc 'Create the win32-pipe gem'
+  task :create => [:clean] do
+    spec = eval(IO.read('win32-pipe.gemspec'))
+    Gem::Builder.new(spec).build
+  end
 
-   pipe_file   = File.join('lib', 'win32', 'pipe.rb')
-   client_file = File.join('lib', 'win32', 'pipe', 'client.rb')
-   server_file = File.join('lib', 'win32', 'pipe', 'server.rb')
-   
-   FileUtils.mkdir_p(sub_installdir)
-
-   FileUtils.cp(pipe_file, pipe_installdir, :verbose => true)   
-   FileUtils.cp(client_file, sub_installdir, :verbose => true)   
-   FileUtils.cp(server_file, sub_installdir, :verbose => true)   
-end
-
-desc 'Run the asynchronous client example program'
-task :example_async_client do
-   ruby '-Ilib examples/example_client_async.rb'
-end
-
-desc 'Run the client example program'
-task :example_client do
-   ruby '-Ilib examples/example_client.rb'
-end
-
-desc 'Run the asynchronous server example program'
-task :example_async_server do
-   ruby '-Ilib examples/example_server_async.rb'
+  desc 'Install the win32-pipe gem'
+  task :install => [:create] do
+    file = Dir['*.gem'].first
+    sh "gem install #{file}"
+  end
 end
 
-desc 'Run the server example program'
-task :example_server do
-   ruby '-Ilib examples/example_server.rb'
+namespace :example do
+  desc 'Run the asynchronous client example program'
+  task :async_client do
+    ruby '-Ilib examples/example_client_async.rb'
+  end
+
+  desc 'Run the client example program'
+  task :client do
+    ruby '-Ilib examples/example_client.rb'
+  end
+
+  desc 'Run the asynchronous server example program'
+  task :async_server do
+    ruby '-Ilib examples/example_server_async.rb'
+  end
+
+  desc 'Run the server example program'
+  task :server do
+    ruby '-Ilib examples/example_server.rb'
+  end
 end
 
 Rake::TestTask.new do |test|
-   test.warning = true
-   test.verbose = true
+  test.warning = true
+  test.verbose = true
 end
+
+task :default => :test

data/lib/win32/pipe.rb

@@ -20,7 +20,7 @@ module Win32
       class Error < StandardError; end
       
       # The version of this library
-      VERSION = '0.2.1'
+      VERSION = '0.2.2'
 
       PIPE_BUFFER_SIZE = 512 #:nodoc:
       PIPE_TIMEOUT = 5000    #:nodoc:

data/lib/win32/pipe/client.rb

@@ -1,49 +1,65 @@
 # The Win32 module serves as a namespace only
 module Win32
-   # The Pipe::Client class encapsulates the client side of a named pipe
-   # connection.
-   #
-   class Pipe::Client < Pipe
-      # Create and return a new Pipe::Client instance.
-      #
-      # The default pipe mode is PIPE_WAIT.
-      #
-      # The default open mode is FILE_ATTRIBUTE_NORMAL | FILE_FLAG_WRITE_THROUGH.
-      #--
-      # 2147483776 is FILE_ATTRIBUTE_NORMAL | FILE_FLAG_WRITE_THROUGH
-      def initialize(name, pipe_mode = DEFAULT_PIPE_MODE, open_mode = DEFAULT_OPEN_MODE)
-         super(name, pipe_mode, open_mode)
+
+  # The Pipe::Client class encapsulates the client side of a named pipe
+  # connection.
+  #
+  class Pipe::Client < Pipe
+
+    # Create and return a new Pipe::Client instance. The +name+, +pipe_mode+,
+    # and +open_mode+ are passed to the Win32::Pipe superclass.
+    #
+    # The default +pipe_mode+ is NOWAIT.
+    #
+    # The default +open_mode+ is FILE_ATTRIBUTE_NORMAL | FILE_FLAG_WRITE_THROUGH.
+    #
+    # In block form the client object is yield, and is automatically
+    # disconnected and closed at the end of the block.
+    #
+    # Example:
+    #
+    #   require 'win32/pipe'
+    #
+    #   Pipe::Client.new('foo') do |pipe|
+    #     puts "Connected..."
+    #     pipe.write("Ruby rocks!")
+    #     data = pipe.read
+    #     puts "Got [#{data}] back from pipe server"
+    #  end
+    #
+    def initialize(name, pipe_mode = DEFAULT_PIPE_MODE, open_mode = DEFAULT_OPEN_MODE)
+      super(name, pipe_mode, open_mode)
          
-         @pipe = CreateFile(
-            @name,
-            GENERIC_READ | GENERIC_WRITE,
-            FILE_SHARE_READ | FILE_SHARE_WRITE,
-            nil,
-            OPEN_EXISTING,
-            @open_mode,
-            nil 
-         )
+      @pipe = CreateFile(
+        @name,
+        GENERIC_READ | GENERIC_WRITE,
+        FILE_SHARE_READ | FILE_SHARE_WRITE,
+        nil,
+        OPEN_EXISTING,
+        @open_mode,
+        nil 
+      )
 
-         error = GetLastError()
+      error = GetLastError()
          
-         if error == ERROR_PIPE_BUSY
-            unless WaitNamedPipe(@name, NMPWAIT_WAIT_FOREVER)
-               raise Error, get_last_error
-            end
-         end
+      if error == ERROR_PIPE_BUSY
+        unless WaitNamedPipe(@name, NMPWAIT_WAIT_FOREVER)
+          raise Error, get_last_error
+        end
+      end
          
-         if @pipe == INVALID_HANDLE_VALUE
-            raise Error, get_last_error
-         end
+      if @pipe == INVALID_HANDLE_VALUE
+        raise Error, get_last_error
+      end
          
-         if block_given?
-            begin
-               yield self
-            ensure
-               disconnect
-               close
-            end
-         end
+      if block_given?
+        begin
+          yield self
+        ensure
+          disconnect
+          close
+        end
       end
-   end
+    end
+  end
 end

data/test/test_win32_pipe.rb

@@ -4,119 +4,123 @@
 # Test suite for the win32-pipe library. This test suite should be run
 # via the 'rake test' task.
 ##########################################################################
+require 'rubygems'
+gem 'test-unit'
 require 'test/unit'
+
 require 'win32/pipe'
 include Win32
 
 class TC_Win32_Pipe < Test::Unit::TestCase
-   def setup
-      @pipe = Pipe.new('foo')
-   end
+  def setup
+    @pipe = Pipe.new('foo')
+  end
    
-   def test_version
-      assert_equal('0.2.1', Pipe::VERSION)
-   end
+  def test_version
+    assert_equal('0.2.2', Pipe::VERSION)
+  end
 
-   def test_name
-      assert_respond_to(@pipe, :name)
-      assert_nothing_raised{ @pipe.name }
-      assert_equal("\\\\.\\pipe\\foo", @pipe.name)
-   end
+  def test_name
+    assert_respond_to(@pipe, :name)
+    assert_nothing_raised{ @pipe.name }
+    assert_equal("\\\\.\\pipe\\foo", @pipe.name)
+  end
 
-   def test_pipe_mode
-      assert_respond_to(@pipe, :pipe_mode)
-      assert_nothing_raised{ @pipe.pipe_mode }
-      assert_equal(Pipe::DEFAULT_PIPE_MODE, @pipe.pipe_mode)
-   end
+  def test_pipe_mode
+    assert_respond_to(@pipe, :pipe_mode)
+    assert_nothing_raised{ @pipe.pipe_mode }
+    assert_equal(Pipe::DEFAULT_PIPE_MODE, @pipe.pipe_mode)
+  end
 
-   def test_open_mode
-      assert_respond_to(@pipe, :open_mode)
-      assert_nothing_raised{ @pipe.open_mode }
-      assert_equal(Pipe::DEFAULT_OPEN_MODE, @pipe.open_mode)
-   end
-   
-   def test_buffer
-      assert_respond_to(@pipe, :buffer)
-      assert_nothing_raised{ @pipe.buffer }
-   end
-   
-   def test_size
-      assert_respond_to(@pipe, :size)
-      assert_nothing_raised{ @pipe.size }
-   end
-   
-   def test_length_alias
-      assert_respond_to(@pipe, :length)
-      assert_equal(true, @pipe.method(:length) == @pipe.method(:size))
-   end
-   
-   def test_pending
-      assert_respond_to(@pipe, :pending?)
-      assert_nothing_raised{ @pipe.pending? }
-      assert_equal(false, @pipe.pending?)
-   end
+  def test_open_mode
+    assert_respond_to(@pipe, :open_mode)
+    assert_nothing_raised{ @pipe.open_mode }
+    assert_equal(Pipe::DEFAULT_OPEN_MODE, @pipe.open_mode)
+  end
+ 
+  def test_buffer
+    assert_respond_to(@pipe, :buffer)
+    assert_nothing_raised{ @pipe.buffer }
+  end
+ 
+  def test_size
+    assert_respond_to(@pipe, :size)
+    assert_nothing_raised{ @pipe.size }
+  end
+ 
+  def test_length_alias
+    assert_respond_to(@pipe, :length)
+    assert_true(@pipe.method(:length) == @pipe.method(:size))
+    assert_alias_method(@pipe, :length, :size)
+  end
+ 
+  def test_pending
+    assert_respond_to(@pipe, :pending?)
+    assert_nothing_raised{ @pipe.pending? }
+    assert_false(@pipe.pending?)
+  end
 
-   def test_asynchronous
-      assert_respond_to(@pipe, :asynchronous?)
-      assert_nothing_raised{ @pipe.asynchronous? }
-      assert_equal(false, @pipe.asynchronous?)
-   end
-   
-   def test_read
-      assert_respond_to(@pipe, :read)
-      assert_raises(Pipe::Error){ @pipe.read } # Nothing to read
-   end
-   
-   def test_transferred
-      assert_respond_to(@pipe, :transferred)
-      assert_nothing_raised{ @pipe.transferred }
-   end
-   
-   def test_wait
-      assert_respond_to(@pipe, :wait)
-      assert_raises(Pipe::Error){ @pipe.wait } # Can't wait in blocking mode
-   end
-   
-   def test_write
-      assert_respond_to(@pipe, :write)
-      assert_raises(ArgumentError){ @pipe.write }      # Must have 1 argument
-      assert_raises(Pipe::Error){ @pipe.write("foo") } # Nothing to write to
-   end
+  def test_asynchronous
+    assert_respond_to(@pipe, :asynchronous?)
+    assert_nothing_raised{ @pipe.asynchronous? }
+    assert_false(@pipe.asynchronous?)
+  end
+ 
+  def test_read
+    assert_respond_to(@pipe, :read)
+    assert_raises(Pipe::Error){ @pipe.read } # Nothing to read
+  end
+ 
+  def test_transferred
+    assert_respond_to(@pipe, :transferred)
+    assert_nothing_raised{ @pipe.transferred }
+  end
+ 
+  def test_wait
+    assert_respond_to(@pipe, :wait)
+    assert_raises(Pipe::Error){ @pipe.wait } # Can't wait in blocking mode
+  end
+ 
+  def test_write
+    assert_respond_to(@pipe, :write)
+    assert_raises(ArgumentError){ @pipe.write }      # Must have 1 argument
+    assert_raises(Pipe::Error){ @pipe.write("foo") } # Nothing to write to
+  end
 
-   def test_disconnect
-      assert_respond_to(@pipe, :disconnect)
-      assert_nothing_raised{ @pipe.disconnect }
-   end
+  def test_disconnect
+    assert_respond_to(@pipe, :disconnect)
+    assert_nothing_raised{ @pipe.disconnect }
+  end
 
-   def test_close
-      assert_respond_to(@pipe, :close)
-      assert_nothing_raised{ @pipe.close }
-   end
-   
-   def test_pipe_mode_constants
-      assert_not_nil(Pipe::WAIT)
-      assert_not_nil(Pipe::NOWAIT)
-      assert_not_nil(Pipe::TYPE_BYTE)
-      assert_not_nil(Pipe::TYPE_MESSAGE)
-      assert_not_nil(Pipe::READMODE_BYTE)
-      assert_not_nil(Pipe::READMODE_MESSAGE)
-   end
+  def test_close
+    assert_respond_to(@pipe, :close)
+    assert_nothing_raised{ @pipe.close }
+  end
+ 
+  def test_pipe_mode_constants
+    assert_not_nil(Pipe::WAIT)
+    assert_not_nil(Pipe::NOWAIT)
+    assert_not_nil(Pipe::TYPE_BYTE)
+    assert_not_nil(Pipe::TYPE_MESSAGE)
+    assert_not_nil(Pipe::READMODE_BYTE)
+    assert_not_nil(Pipe::READMODE_MESSAGE)
+  end
 
-   def test_open_mode_constants
-      assert_not_nil(Pipe::ACCESS_DUPLEX)
-      assert_not_nil(Pipe::ACCESS_INBOUND)
-      assert_not_nil(Pipe::ACCESS_OUTBOUND)
-      assert_not_nil(Pipe::FIRST_PIPE_INSTANCE)
-      assert_not_nil(Pipe::WRITE_THROUGH)
-      assert_not_nil(Pipe::OVERLAPPED)
-   end
+  def test_open_mode_constants
+    assert_not_nil(Pipe::ACCESS_DUPLEX)
+    assert_not_nil(Pipe::ACCESS_INBOUND)
+    assert_not_nil(Pipe::ACCESS_OUTBOUND)
+    assert_not_nil(Pipe::FIRST_PIPE_INSTANCE)
+    assert_not_nil(Pipe::WRITE_THROUGH)
+    assert_not_nil(Pipe::OVERLAPPED)
+  end
 
-   def test_other_constants
-      assert_not_nil(Pipe::INFINITE)
-   end
-   
-   def teardown
-      @pipe.close
-      @pipe = nil
-   end
+  def test_other_constants
+    assert_not_nil(Pipe::INFINITE)
+  end
+ 
+  def teardown
+    @pipe.close
+    @pipe = nil
+  end
 end

data/test/test_win32_pipe_client.rb

@@ -6,23 +6,55 @@
 ##########################################################################
 require 'test/unit'
 require 'win32/pipe'
-include Win32
 
 class TC_Win32_Pipe_Client < Test::Unit::TestCase
-   def setup
-      @pipe = nil
-   end
-
-   def test_constructor_basic
-      assert_respond_to(Pipe::Client, :new)
-   end
-
-   def test_constructor_expected_errors
-      assert_raise(ArgumentError){ Pipe::Client.new }
-      assert_raise(TypeError){ Pipe::Client.new(1) }
-   end
-
-   def teardown
-      @pipe = nil
-   end
+  def setup
+    @server = Win32::Pipe::Server.new('test')
+    @pipe   = nil
+    @name   = 'test'
+    @pmode  = Win32::Pipe::PIPE_NOWAIT
+    @omode  = Win32::Pipe::DEFAULT_OPEN_MODE
+  end
+
+  test "constructor basic functionality" do
+    assert_respond_to(Win32::Pipe::Client, :new)
+    assert_nothing_raised{ @pipe = Win32::Pipe::Client.new(@name) }
+  end
+
+  test "constructor accepts an optional pipe mode" do
+    assert_nothing_raised{ @pipe = Win32::Pipe::Client.new(@name, @pmode) }
+  end
+
+  test "constructor accepts an optional open mode" do
+    assert_nothing_raised{ @pipe = Win32::Pipe::Client.new(@name, @pmode, @omode) }
+  end
+
+  test "constructor requires a pipe name" do
+    assert_raise(ArgumentError){ Win32::Pipe::Client.new }
+  end
+
+  test "pipe name must be a string" do
+    assert_raise(TypeError){ Win32::Pipe::Client.new(1) }
+  end
+
+  test "an error is raised if the named pipe cannot be found" do
+    assert_raise(Win32::Pipe::Error){ Win32::Pipe::Client.new('bogus') }
+  end
+
+  def teardown
+    if @pipe
+      @pipe.disconnect
+      @pipe.close
+    end
+
+    if @server
+      @server.disconnect
+      @server.close
+    end
+
+    @pmode  = nil
+    @omode  = nil
+    @pipe   = nil
+    @server = nil
+  end
 end

data/test/test_win32_pipe_server.rb

@@ -15,7 +15,7 @@ class TC_Win32_Pipe_Server < Test::Unit::TestCase
 
    def test_constructor_basic
       assert_respond_to(Pipe::Server, :new)
-      assert_nothing_raised{ Pipe::Server.new('foo') }
+      assert_nothing_raised{ @pipe = Pipe::Server.new('foo') }
    end
 
    def test_connect

data/win32-pipe.gemspec

@@ -1,28 +1,25 @@
 require 'rubygems'
 
-spec = Gem::Specification.new do |gem|
-	gem.name       = 'win32-pipe'
-	gem.version    = '0.2.1'
-	gem.author     = 'Daniel J. Berger'
-   gem.license    = 'Artistic 2.0'
-	gem.email      = 'djberg96@gmail.com'
-	gem.homepage   = 'http://www.rubyforge.org/projects/win32utils'
-	gem.platform   = Gem::Platform::RUBY
-	gem.summary    = 'An interface for named pipes on MS Windows' 
-	gem.test_files = Dir['test/test_*.rb']
-	gem.has_rdoc   = true
-   gem.files      = Dir['**/*'].reject{ |f| f.include?('CVS') }
+Gem::Specification.new do |spec|
+	spec.name       = 'win32-pipe'
+	spec.version    = '0.2.2'
+	spec.author     = 'Daniel J. Berger'
+  spec.license    = 'Artistic 2.0'
+	spec.email      = 'djberg96@gmail.com'
+	spec.homepage   = 'http://www.rubyforge.org/projects/win32utils'
+	spec.summary    = 'An interface for named pipes on MS Windows' 
+	spec.test_files = Dir['test/test_*.rb']
+  spec.files      = Dir['**/*'].reject{ |f| f.include?('git') }
 
-	gem.rubyforge_project = 'win32utils'
-	gem.extra_rdoc_files  = ['CHANGES', 'README', 'MANIFEST']
+	spec.rubyforge_project = 'win32utils'
+	spec.extra_rdoc_files  = ['CHANGES', 'README', 'MANIFEST']
 	
-	gem.add_dependency('windows-pr', '>= 1.0.6')
+	spec.add_dependency('windows-pr', '>= 1.0.6')
+  spec.add_development_dependency('test-unit', '>= 2.1.0')
 	
-	gem.description = <<-EOF
-      The win32-pipe library provides an interface for named pipes on Windows.
-      A named pipe is a named, one-way or duplex pipe for communication
-      between the pipe server and one or more pipe clients. 
-   EOF
+	spec.description = <<-EOF
+    The win32-pipe library provides an interface for named pipes on Windows.
+    A named pipe is a named, one-way or duplex pipe for communication
+    between the pipe server and one or more pipe clients. 
+  EOF
 end
-
-Gem::Builder.new(spec).build

metadata

@@ -1,38 +1,49 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: win32-pipe
-version: !ruby/object:Gem::Version 
-  version: 0.2.1
+version: !ruby/object:Gem::Version
+  version: 0.2.2
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Daniel J. Berger
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2009-08-09 00:00:00 -06:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-03-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: windows-pr
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
+  requirement: &21666690 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 1.0.6
-    version: 
-description: "      The win32-pipe library provides an interface for named pipes on Windows.\n      A named pipe is a named, one-way or duplex pipe for communication\n      between the pipe server and one or more pipe clients. \n"
+  type: :runtime
+  prerelease: false
+  version_requirements: *21666690
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: &21666430 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :development
+  prerelease: false
+  version_requirements: *21666430
+description: ! "    The win32-pipe library provides an interface for named pipes on
+  Windows.\n    A named pipe is a named, one-way or duplex pipe for communication\n
+  \   between the pipe server and one or more pipe clients. \n"
 email: djberg96@gmail.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - CHANGES
 - README
 - MANIFEST
-files: 
+files:
 - CHANGES
 - examples/example_client.rb
 - examples/example_client_async.rb
@@ -48,35 +59,32 @@ files:
 - test/test_win32_pipe_client.rb
 - test/test_win32_pipe_server.rb
 - win32-pipe.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 
-      version: "0"
-  version: 
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-  version: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '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.5
+rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
 summary: An interface for named pipes on MS Windows
-test_files: 
+test_files:
 - test/test_win32_pipe.rb
 - test/test_win32_pipe_client.rb
 - test/test_win32_pipe_server.rb