win32-pipe 0.2.0 → 0.2.1

data/CHANGES

@@ -1,3 +1,10 @@
+== 0.2.1 - 9-Aug-2009
+* License changed to Artistic 2.0.
+* Test and example files renamed.
+* Gemspec updates, including license and description.
+* Updates to the Rakefile, including the removal of old C rake tasks, as
+  well as the addition of tasks to run the example programs.
+
 == 0.2.0 - 28-May-2008
 * Now pure Ruby.
 * Major interface change. Pipe::Server.new and Pipe::Client.new replace the

data/MANIFEST

@@ -3,13 +3,13 @@
 * CHANGES
 * Rakefile
 * win32-pipe.gemspec
-* examples/test_server.rb
-* examples/test_server_async.rb
-* examples/test_client.rb
-* examples/test_client_async.rb
+* examples/example_server.rb
+* examples/example_server_async.rb
+* examples/example_client.rb
+* examples/example_client_async.rb
 * lib/win32/pipe.rb
 * lib/win32/pipe/client.rb
 * lib/win32/pipe/server.rb
-* test/tc_pipe.rb
-* test/tc_pipe_client.rb
-* test/tc_pipe_server.rb
+* test/test_win32_pipe.rb
+* test/test_win32_pipe_client.rb
+* test/test_win32_pipe_server.rb

data/README

@@ -1,17 +1,16 @@
-= Description
+== Description
    A Ruby interface for named pipes on Windows.
 
-= Prerequisites
+== Prerequisites
 * windows-pr 0.8.5 or later
 
-= Installation
-== Local
-   rake install (non-gem) or rake install_gem (gem)
-
-== Remote
+== Installation
+=== Gem Installation
    gem install win32-pipe
+=== Local
+   rake install
 
-= Synopsis
+== Synopsis
    require 'win32/pipe'
    include Win32
     
@@ -27,30 +26,30 @@
    pipe_client.write("Hello World")
    pipe_client.close
 
-= What's a named pipe?
+== What's a named pipe?
    A pipe with a name - literally. In practice, it will feel more like a cross
    between a socket and a pipe. At least, it does to me.
 
-= What good is it?
+== What good is it?
    My hope is that it can be used in certain circumstances where a fork might
    be desirable, but which is not possible on Windows. It could also be handy
-   for the traditional "piping data to a server" usage.  And if you come up
+   for the traditional "piping data to a server" usage. And if you come up
    with anything cool, please let us all know!
 
-= Future Plans
-* Add transactions
+== Future Plans
+   Add transactions
 
-= License
-   Ruby's
+== License
+   Artistic
 
-= Warranty
+== 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.
 
-= Copyright
-   (C) 2003-2008, Daniel J. Berger, All Rights Reserved.
+== Copyright
+   (C) 2003-2009, Daniel J. Berger, All Rights Reserved.
 
-= Authors
+== Authors
    Daniel Berger
    Park Heesob

data/Rakefile

@@ -22,44 +22,27 @@ task :install do
    FileUtils.cp(server_file, sub_installdir, :verbose => true)   
 end
 
-desc 'Install the win32-pipe library'
-task :install_c => [:build] do
-   Dir.chdir('ext'){
-      sh 'nmake install'
-   }
+desc 'Run the asynchronous client example program'
+task :example_async_client do
+   ruby '-Ilib examples/example_client_async.rb'
 end
 
-desc "Clean any build files for win32-pipe"
-task :clean do
-   Dir.chdir('ext') do
-      if File.exists?('pipe.so') ||
-         File.exists?('win32/pipe.so')
-      then
-         sh 'nmake distclean'
-         rm 'win32/pipe.so' if File.exists?('win32/pipe.so') 
-      end
-   end
+desc 'Run the client example program'
+task :example_client do
+   ruby '-Ilib examples/example_client.rb'
 end
 
-desc "Build win32-pipe (but don't install it)"
-task :build => [:clean] do
-   Dir.chdir('ext') do
-      ruby 'extconf.rb'
-      sh 'nmake'
-      mv 'pipe.so', 'win32' # For the test suite
-   end
+desc 'Run the asynchronous server example program'
+task :example_async_server do
+   ruby '-Ilib examples/example_server_async.rb'
 end
 
-desc "Run the sample program"
-task :example do |t|
-   Dir.chdir('examples'){
-      sh 'ruby test.rb'
-   }
+desc 'Run the server example program'
+task :example_server do
+   ruby '-Ilib examples/example_server.rb'
 end
 
-Rake::TestTask.new('test') do |test|
-   test.libs << 'lib/win32'
-   test.libs << 'lib/win32/pipe'
-   test.test_files = FileList['test/tc*']
+Rake::TestTask.new do |test|
    test.warning = true
+   test.verbose = true
 end

data/examples/{test_client.rb → example_client.rb}

@@ -1,5 +1,5 @@
 #########################################################################
-# test_client.rb
+# example_client.rb
 #
 # Simple client test.  Be sure to start the server first in a separate
 # terminal. You can run this example via the 'rake example_client' task.

data/examples/{test_client_async.rb → example_client_async.rb}

@@ -1,5 +1,5 @@
 #########################################################################
-# test_client_async.rb
+# example_client_async.rb
 #
 # Simple client test. Be sure to start the server first in a separate
 # terminal. You can run this example via the 'rake example_async_client'

data/examples/{test_server.rb → example_server.rb}

@@ -1,5 +1,5 @@
 #########################################################################
-# test_server.rb
+# example_server.rb
 #
 # A simple named pipe server.  Start this up in its own terminal window.
 # You may have to use the task manager to kill it if you don't connect

data/examples/{test_server_async.rb → example_server_async.rb}

@@ -1,5 +1,5 @@
 #######################################################################
-# test_server_async.rb
+# example_server_async.rb
 #
 # A simple, asynchronous named pipe server. Start this up in its own
 # terminal window. You can run this program via the

data/lib/win32/pipe.rb

@@ -16,10 +16,11 @@ module Win32
       include Windows::File
       include Windows::Error
       
+      # Error typically raised if any of the Pipe methods fail.
       class Error < StandardError; end
       
       # The version of this library
-      VERSION = '0.2.0'
+      VERSION = '0.2.1'
 
       PIPE_BUFFER_SIZE = 512 #:nodoc:
       PIPE_TIMEOUT = 5000    #:nodoc:
@@ -94,7 +95,7 @@ module Win32
       # The default open mode is FILE_ATTRIBUTE_NORMAL | FILE_FLAG_WRITE_THROUGH.
       #
       def initialize(name, pipe_mode = DEFAULT_PIPE_MODE, open_mode = DEFAULT_OPEN_MODE)
-         @name      = "\\\\.\\pipe\\" + name
+         @name = "\\\\.\\pipe\\" + name
 
          @pipe_mode = pipe_mode.nil? ? DEFAULT_PIPE_MODE : pipe_mode
          @open_mode = open_mode.nil? ? DEFAULT_OPEN_MODE : open_mode

data/test/{tc_pipe.rb → test_win32_pipe.rb}

@@ -1,5 +1,5 @@
 ##########################################################################
-# tc_pipe.rb
+# test_win32_pipe.rb
 #
 # Test suite for the win32-pipe library. This test suite should be run
 # via the 'rake test' task.
@@ -14,7 +14,7 @@ class TC_Win32_Pipe < Test::Unit::TestCase
    end
    
    def test_version
-      assert_equal('0.2.0', Pipe::VERSION)
+      assert_equal('0.2.1', Pipe::VERSION)
    end
 
    def test_name
@@ -79,7 +79,7 @@ class TC_Win32_Pipe < Test::Unit::TestCase
    
    def test_write
       assert_respond_to(@pipe, :write)
-      assert_raises(ArgumentError){ @pipe.write }    # Must have 1 argument
+      assert_raises(ArgumentError){ @pipe.write }      # Must have 1 argument
       assert_raises(Pipe::Error){ @pipe.write("foo") } # Nothing to write to
    end
 

data/test/{tc_pipe_client.rb → test_win32_pipe_client.rb}

@@ -1,5 +1,5 @@
 ##########################################################################
-# tc_pipe_client.rb
+# test_win32_pipe_client.rb
 #
 # Test suite for the Pipe::Client class. This test suite should be run
 # as part of the 'rake test' task.

data/test/{tc_pipe_server.rb → test_win32_pipe_server.rb}

@@ -1,5 +1,5 @@
 ##########################################################################
-# tc_pipe_server.rb
+# test_win32_pipe_server.rb
 #
 # Test suite for the Pipe::Server class. This test suite should be run
 # as part of the 'rake test' task.

data/win32-pipe.gemspec

@@ -1,26 +1,28 @@
-require "rubygems"
+require 'rubygems'
 
 spec = Gem::Specification.new do |gem|
-	gem.name         = "win32-pipe"
-	gem.version      = "0.2.0"
-	gem.author       = "Daniel J. Berger"
-	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.description  = "An interface for named pipes on MS Windows"
-	gem.test_files   = Dir["test/tc_*.rb"]
-	gem.has_rdoc     = true
+	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.rubyforge_project = 'win32utils'
 	gem.extra_rdoc_files  = ['CHANGES', 'README', 'MANIFEST']
-	gem.rubyforge_project = "win32utils"
 	
-	files = Dir["doc/*"] + Dir["examples/*"] + Dir["lib/win32/**/*.rb"]
-	files += Dir["test/*"] + Dir["[A-Z]*"]
-	files.delete_if{ |item| item.include?("CVS") }
-	gem.files = files
+	gem.add_dependency('windows-pr', '>= 1.0.6')
+	
+	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
 end
 
-if $0 == __FILE__
-   Gem.manage_gems
-   Gem::Builder.new(spec).build
-end
+Gem::Builder.new(spec).build

metadata

@@ -1,68 +1,82 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.4
-specification_version: 1
 name: win32-pipe
 version: !ruby/object:Gem::Version 
-  version: 0.2.0
-date: 2008-05-28 00:00:00 -06:00
-summary: An interface for named pipes on MS Windows
-require_paths: 
-- lib
-email: djberg96@gmail.com
-homepage: http://www.rubyforge.org/projects/win32utils
-rubyforge_project: win32utils
-description: An interface for named pipes on MS Windows
-autorequire: 
-default_executable: 
-bindir: bin
-has_rdoc: true
-required_ruby_version: !ruby/object:Gem::Version::Requirement 
-  requirements: 
-  - - ">"
-    - !ruby/object:Gem::Version 
-      version: 0.0.0
-  version: 
+  version: 0.2.1
 platform: ruby
-signing_key: 
-cert_chain: 
-post_install_message: 
 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 
+  name: windows-pr
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    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"
+email: djberg96@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- CHANGES
+- README
+- MANIFEST
 files: 
-- examples/test_client.rb
-- examples/test_client_async.rb
-- examples/test_server.rb
-- examples/test_server_async.rb
+- CHANGES
+- examples/example_client.rb
+- examples/example_client_async.rb
+- examples/example_server.rb
+- examples/example_server_async.rb
 - lib/win32/pipe/client.rb
 - lib/win32/pipe/server.rb
 - lib/win32/pipe.rb
-- test/tc_pipe.rb
-- test/tc_pipe_client.rb
-- test/tc_pipe_server.rb
-- CHANGES
-- examples
-- ext
-- lib
 - MANIFEST
 - Rakefile
 - README
-- test
+- test/test_win32_pipe.rb
+- test/test_win32_pipe_client.rb
+- test/test_win32_pipe_server.rb
 - win32-pipe.gemspec
-test_files: 
-- test/tc_pipe.rb
-- test/tc_pipe_client.rb
-- test/tc_pipe_server.rb
+has_rdoc: true
+homepage: http://www.rubyforge.org/projects/win32utils
+licenses: 
+- Artistic 2.0
+post_install_message: 
 rdoc_options: []
 
-extra_rdoc_files: 
-- CHANGES
-- README
-- MANIFEST
-executables: []
-
-extensions: []
-
+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: 
 requirements: []
 
-dependencies: []
-
+rubyforge_project: win32utils
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: An interface for named pipes on MS Windows
+test_files: 
+- test/test_win32_pipe.rb
+- test/test_win32_pipe_client.rb
+- test/test_win32_pipe_server.rb