win32-mutex 0.3.0 → 0.3.1

data/CHANGES

@@ -1,3 +1,9 @@
+== 0.3.1 - 8-Aug-2009
+* Changed license to Artistic 2.0.
+* Updated the gemspec, including addition of license and description update.
+* Renamed the test and example files.
+* Added test-unit, win32-process and win32-mmap as development dependencies.
+
 == 0.3.0 - 4-May-2007
 * Now pure Ruby.
 * Both the Mutex.new and Mutex.open methods now accept a block, and

data/README

@@ -5,6 +5,9 @@
    win32-ipc 0.5.0 or later
 
 == Installation
+=== Gem Installation
+   gem install win32-mutex
+=== Local Installation
    rake test (optional)
    rake install
 
@@ -21,12 +24,12 @@
    The mutex.rb file contains inline RDoc documentation. If you installed
    this file as a gem, then you have the docs.
 
-   For an example of win32-mutex in action, look at the mutex_test.rb file
-   in the 'examples' directory. You can also run the 'examples' rake task.
+   For an example of win32-mutex in action, look at the example_win32_mutex.rb
+   file in the 'examples' directory. You can also run the 'examples' rake task.
 
 == Notes
-   The Mutex class is a subclass of Win32::Ipc (win32-ipc). This package
-   require's the win32-ipc package internally (you don't need to explicitly
+   The Mutex class is a subclass of Win32::Ipc (win32-ipc). This library
+   require's the win32-ipc library internally (you don't need to explicitly
    call it).
 
 == Acknowledgements
@@ -37,10 +40,10 @@
    project page at http://www.rubyforge.net/projects/win32utils
     
 == License
-   Ruby's
+   Artistic 2.0
     
 == Copyright
-   (C) 2003-2007 Daniel J. Berger, All Rights Reserved
+   (C) 2003-2009 Daniel J. Berger, All Rights Reserved
     
 == Warranty
    This package is provided "as is" and without any express or

data/Rakefile

@@ -15,12 +15,10 @@ end
 
 desc 'Run the example program'
 task :example do
-   ruby '-Ilib examples/mutex_test.rb'
+   ruby '-Ilib examples/example_win32_mutex.rb'
 end
 
 Rake::TestTask.new do |t|
-   t.libs << 'test'
    t.verbose = true
    t.warning = true
-   t.test_files = FileList['test/tc_mutex.rb']
 end

data/examples/example_win32_mutex.rb

@@ -0,0 +1,65 @@
+##############################################################
+# example_win32_mutex.rb
+#
+# A test script for general futzing.  Modify as you see fit.
+# This test script requires win32-process and win32-mmap.
+##############################################################
+MUTEXNAME = "This is a very long name"
+
+require 'win32/mutex'
+require 'win32/process'
+require 'win32/mmap'
+include Win32
+
+pid = Process.fork
+
+# child_1
+if pid.nil?
+   mm = MMap.open('test')
+   mx = Win32::Mutex.open(MUTEXNAME)
+   5.times{   
+      mx.wait
+      puts "child_1 wait "
+      mm.gvalue += 123
+      sleep 1
+      mm.gvalue -= 123
+      mx.release
+      puts "child_1 release "
+   }
+   exit 1
+end
+
+pid2 = Process.fork
+
+# child_2
+if pid2.nil?
+   mm = MMap.open('test')
+   mx = Win32::Mutex.open(MUTEXNAME)
+   4.times{
+      mx.wait
+      puts "child_2 wait "
+      mm.gvalue += 456
+      sleep 2
+      mm.gvalue -= 456
+      mx.release
+      puts "child_2 release "
+   }
+   exit 1
+end
+
+#parent
+mm = MMap.new(:size => 1024, :name => 'test', :inherit => true)
+mm.gvalue = 5
+mx = Win32::Mutex.new(false, MUTEXNAME)
+
+3.times{
+   mx.wait
+   puts "parent wait"
+   sleep 5
+   printf("Value of GValue=%d\n", mm.gvalue)
+   mx.release
+   puts "parent release"
+}
+
+p Process.waitpid2(pid)
+p Process.waitpid2(pid2)

data/lib/win32/mutex.rb

@@ -1,6 +1,9 @@
 require 'win32/ipc'
 
+# The Win32 module serves as a namespace only.
 module Win32
+   
+   # The Mutex class encapsulates Windows mutex objects.
    class Mutex < Ipc
    
       # This is the error raised if any of the Mutex methods fail.
@@ -10,12 +13,12 @@ module Win32
       extend Windows::Error
       extend Windows::Handle
       
-      VERSION = '0.3.0'
+      # The version of the win32-mutex library
+      VERSION = '0.3.1'
       
-      # The name of the Mutex object.
-      #
+      # The name of the mutex object.
       attr_reader :name
-      
+
       # Creates and returns new Mutex object. If +name+ is omitted, the
       # Mutex object is created without a name, i.e. it's anonymous.
       #
@@ -33,8 +36,8 @@ module Win32
       #
       def initialize(initial_owner=false, name=nil, inherit=true)
          @initial_owner = initial_owner
-         @name    = name
-         @inherit = inherit
+         @name          = name
+         @inherit       = inherit
          
          # Used to prevent potential segfaults.
          if name && !name.is_a?(String)
@@ -63,7 +66,7 @@ module Win32
             begin
                yield self
             ensure
-               close
+               close # From superclass
             end
          end
       end
@@ -79,9 +82,6 @@ module Win32
       # already exist.
       #
       # If you want "open or create" semantics, then use Mutex.new.
-      #--
-      # The OpenMutex() call here is strictly to force an error if the user
-      # tries to open a mutex that doesn't already exist.
       #
       def self.open(name, inherit=true, &block)
          if name && !name.is_a?(String)
@@ -89,11 +89,18 @@ module Win32
          end
          
          bool = inherit ? 1 : 0
-         handle = OpenMutex(MUTEX_ALL_ACCESS, bool, name)
-         if handle == 0 || handle == INVALID_HANDLE_VALUE
-            raise Error, get_last_error
+
+         # The OpenMutex() call here is strictly to force an error if the user
+         # tries to open a mutex that doesn't already exist.
+         begin
+            handle = OpenMutex(MUTEX_ALL_ACCESS, bool, name)
+
+            if handle == 0 || handle == INVALID_HANDLE_VALUE
+               raise Error, get_last_error
+            end
+         ensure
+            CloseHandle(handle) if handle && handle > 0
          end
-         CloseHandle(handle)
 
          self.new(false, name, inherit, &block)
       end

data/test/{tc_mutex.rb → test_win32_mutex.rb}

@@ -1,27 +1,33 @@
-#####################################################################
+#######################################################################
 # tc_Win32::Mutex.rb
 #
-# Test suite for the win32-Win32::Mutex package. This test suite should
-# be run via the 'rake test' task.
-#####################################################################
+# Test suite for the win32-Win32::Mutex package. This test suite
+# should be run via the 'rake test' task.
+#######################################################################
+require 'rubygems'
+gem 'test-unit'
+
 require 'test/unit'
 require 'win32/mutex'
 
 class TC_Win32_Mutex < Test::Unit::TestCase
 	def setup
 		@mutex  = Win32::Mutex.new(true, 'test')
-		@umutex = Win32::Mutex.new(false, "Ηελλας")
+		@umutex = Win32::Mutex.new(false, 'Ηελλας')
 	end
 	
 	def test_version
-		assert_equal('0.3.0', Win32::Mutex::VERSION)
+		assert_equal('0.3.1', Win32::Mutex::VERSION)
 	end
 
 	def test_open
 	   assert_respond_to(Win32::Mutex, :open)
-	   assert_nothing_raised{ Win32::Mutex.open("test"){} }
-	   assert_nothing_raised{ Win32::Mutex.open("Ηελλας"){} }
-	   assert_raises(Win32::Mutex::Error){ Win32::Mutex.open("bogus"){} }
+	   assert_nothing_raised{ Win32::Mutex.open('test'){} }
+	   assert_nothing_raised{ Win32::Mutex.open('Ηελλας'){} }
+   end
+
+   def test_open_expected_errors
+	   assert_raise(Win32::Mutex::Error){ Win32::Mutex.open('bogus'){} }
 	end
 	
 	def test_release
@@ -31,13 +37,13 @@ class TC_Win32_Mutex < Test::Unit::TestCase
    
    def test_initial_owner
       assert_respond_to(@mutex, :initial_owner?)
-      assert_equal(true, @mutex.initial_owner?)
-      assert_equal(false, @umutex.initial_owner?)
+      assert_true(@mutex.initial_owner?)
+      assert_false(@umutex.initial_owner?)
    end
    
    def test_inheritable
       assert_respond_to(@mutex, :inheritable?)
-      assert_equal(true, @mutex.inheritable?)
+      assert_true(@mutex.inheritable?)
    end
 	
 	def test_wait

data/win32-mutex.gemspec

@@ -1,24 +1,33 @@
-require "rubygems"
+require 'rubygems'
 
 spec = Gem::Specification.new do |gem|
-   gem.name        = "win32-mutex"
-   gem.version     = "0.3.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     = "Interface to MS Windows Mutex objects."
-   gem.description = "Interface to MS Windows Mutex objects."
-   gem.test_file   = "test/tc_mutex.rb"
-   gem.has_rdoc    = true
-   gem.files       = Dir["lib/win32/*.rb"] + Dir["test/*"] + Dir["[A-Z]*"]
-   gem.files.reject! { |fn| fn.include? "CVS" }
-   gem.require_path = "lib"
-   gem.extra_rdoc_files = ["README", "CHANGES", "MANIFEST"]
-   gem.add_dependency("win32-ipc", ">= 0.5.0")
-end
+   gem.name      = 'win32-mutex'
+   gem.version   = '0.3.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   = 'Interface to MS Windows Mutex objects.'
+   gem.test_file = 'test/test_win32_mutex.rb'
+   gem.has_rdoc  = true
+   gem.files     = Dir['**/*'].reject{ |f| f.include?('CVS') }
+
+   gem.rubyforge_project = 'win32utils'
+   gem.extra_rdoc_files  = ['README', 'CHANGES', 'MANIFEST']
 
-if $0 == __FILE__
-   Gem.manage_gems
-   Gem::Builder.new(spec).build
+   gem.add_dependency('win32-ipc', '>= 0.5.0')
+   
+   gem.add_development_dependency('test-unit', '>= 2.0.3')
+   gem.add_development_dependency('win32-process', '>= 0.6.1')
+   gem.add_development_dependency('win32-mmap', '>= 0.2.2')
+
+   gem.description = <<-EOF
+      The win32-mutex library provides an interface for creating mutex objects
+      on MS Windows. A mutex object is a synchronization object whose state
+      is set to signaled when it is not owned by any thread, and non-signaled
+      when it is owned.
+   EOF
 end
+
+Gem::Builder.new(spec).build

metadata

@@ -1,67 +1,103 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.2
-specification_version: 1
 name: win32-mutex
 version: !ruby/object:Gem::Version 
-  version: 0.3.0
-date: 2007-05-04 00:00:00 -06:00
-summary: Interface to MS Windows Mutex objects.
-require_paths: 
-- lib
-email: djberg96@gmail.com
-homepage: http://www.rubyforge.org/projects/win32utils
-rubyforge_project: 
-description: Interface to MS Windows Mutex objects.
-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.3.1
 platform: ruby
-signing_key: 
-cert_chain: 
-post_install_message: 
 authors: 
 - Daniel J. Berger
-files: 
-- lib/win32/mutex.rb
-- test/CVS
-- test/tc_mutex.rb
-- CHANGES
-- CVS
-- examples
-- lib
-- MANIFEST
-- Rakefile
-- README
-- test
-- win32-mutex.gemspec
-test_files: 
-- test/tc_mutex.rb
-rdoc_options: []
-
-extra_rdoc_files: 
-- README
-- CHANGES
-- MANIFEST
-executables: []
-
-extensions: []
-
-requirements: []
+autorequire: 
+bindir: bin
+cert_chain: []
 
+date: 2009-08-08 00:00:00 -06:00
+default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: win32-ipc
+  type: :runtime
   version_requirement: 
-  version_requirements: !ruby/object:Gem::Version::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
         version: 0.5.0
     version: 
+- !ruby/object:Gem::Dependency 
+  name: test-unit
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.0.3
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: win32-process
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.6.1
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: win32-mmap
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.2.2
+    version: 
+description: "      The win32-mutex library provides an interface for creating mutex objects\n      on MS Windows. A mutex object is a synchronization object whose state\n      is set to signaled when it is not owned by any thread, and non-signaled\n      when it is owned.\n"
+email: djberg96@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+- CHANGES
+- MANIFEST
+files: 
+- CHANGES
+- examples/example_win32_mutex.rb
+- lib/win32/mutex.rb
+- MANIFEST
+- Rakefile
+- README
+- test/test_win32_mutex.rb
+- win32-mutex.gemspec
+has_rdoc: true
+homepage: http://www.rubyforge.org/projects/win32utils
+licenses: 
+- Artistic 2.0
+post_install_message: 
+rdoc_options: []
+
+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: []
+
+rubyforge_project: win32utils
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Interface to MS Windows Mutex objects.
+test_files: 
+- test/test_win32_mutex.rb