win32-semaphore 0.3.0 → 0.3.1

data/CHANGES

@@ -1,3 +1,9 @@
+== 0.3.1 - 11-Aug-2009
+* Changed license to Artistic 2.0.
+* The Semaphore.open method is now slightly more robust.
+* Renamed the test and example files.
+* Some gemspec updates, including license and description.
+
 == 0.3.0 - 3-May-2007
 * Now pure Ruby.
 * Added a Rakefile, with test, install and example tasks.

data/MANIFEST

@@ -3,6 +3,6 @@
 * README
 * Rakefile
 * win32-semaphore.gemspec
-* examples/semaphore_test.rb
+* examples/example_semaphore.rb
 * lib/win32/semaphore.rb
-* test/tc_semaphore.rb
+* test/test_win32_semaphore.rb

data/README

@@ -9,7 +9,7 @@
    rake install
 
 == Synopsis
-   require "win32/semaphore"
+   require 'win32/semaphore'
    include Win32
 
    Semaphore.new(1, 5, 'test') do |sem|
@@ -18,7 +18,7 @@
    end
 
 == Documentation
-   The event.rb file contains inline RDoc documentation. If you installed
+   The semaphore.rb file contains inline RDoc documentation. If you installed
    this file as a gem, then you have the docs.
 
    For more detailed documentation about Semaphores on MS Windows in general,
@@ -42,10 +42,10 @@
    Suggestions welcome.
 
 == License
-   Ruby's
+   Artistic 2.0
 
 == Copyright
-   (C) 2003-2007 Daniel J. Berger
+   (C) 2003-2009 Daniel J. Berger
    All Rights Reserved	
 
 == Warranty

data/Rakefile

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

data/examples/example_semaphore.rb

@@ -0,0 +1,40 @@
+##############################################################
+# example_semaphore.rb
+#
+# A test script for general futzing.  Modify as you see fit.
+#
+# Note that you can run this via the 'rake example' task.
+##############################################################
+require "win32/semaphore"
+include Win32
+
+test = 1
+s = Semaphore.new(3,3,"test")
+test += 1
+puts "ok #{test}"
+
+print 'not ' unless s.wait(10) > 0
+test += 1
+puts "ok #{test}"
+
+print 'not ' unless s.wait(0) > 0
+test += 1
+puts "ok #{test}"
+
+printf "If you don't see 'ok %d' immediately, you'd better hit Ctrl-C\n", test+1
+print 'not ' unless s.wait > 0
+test += 1
+puts "ok #{test}"
+
+print 'not ' if s.wait(0) > 0
+test += 1
+puts "ok #{test}"
+
+s.release
+s.release(1)
+
+print 'not ' unless (result = s.release(1)) == 2
+test += 1
+puts "ok #{test}\t(result is #{result})"
+
+s.close

data/lib/win32/semaphore.rb

@@ -1,6 +1,9 @@
 require 'win32/ipc'
 
+# The Win32 module serves as a namespace only.
 module Win32
+
+   # The Semaphore class encapsulates semaphore objects on Windows.
    class Semaphore < Ipc
    
       # This is the error raised if any of the Semaphore methods fail.
@@ -10,7 +13,8 @@ module Win32
       extend Windows::Error
       extend Windows::Handle
       
-      VERSION = '0.3.0'
+      # The version of the win32-semaphore library
+      VERSION = '0.3.1'
       
       # The initial count for the semaphore object. This value must be greater
       # than or equal to zero and less than or equal to +max_count+. The state
@@ -92,21 +96,25 @@ module Win32
       # the semaphore doesn't already exist.
       #
       # If you want "open or create" semantics, then use Semaphore.new.
-      #--
-      # The OpenSemaphore() call here is strictly to force an error if the user
-      # tries to open a semaphore that doesn't already exist.
       #
       def self.open(name, inherit=true, &block)
          if name && !name.is_a?(String)
             raise TypeError, 'name must be a string'
          end
-         
+
          bool = inherit ? 1 : 0
-         handle = OpenSemaphore(EVENT_ALL_ACCESS, bool, name)
-         if handle == 0 || handle == INVALID_HANDLE_VALUE
-            raise Error, get_last_error
+
+         # The OpenSemaphore() call here is strictly to force an error if the
+         # user tries to open a semaphore that doesn't already exist.
+         begin
+            handle = OpenSemaphore(SEMAPHORE_ALL_ACCESS, bool, name)
+
+            if handle == 0 || handle == INVALID_HANDLE_VALUE
+               raise Error, get_last_error
+            end
+         ensure
+            CloseHandle(handle)
          end
-         CloseHandle(handle)
 
          self.new(0, 1, name, inherit, &block)
       end
@@ -118,9 +126,11 @@ module Win32
       #
       def release(amount = 1)
          pcount = [0].pack('L')
+
          unless ReleaseSemaphore(@handle, amount, pcount)
             raise Error, get_last_error   
          end
+
          pcount.unpack('L').first
       end
       

data/test/{tc_semaphore.rb → test_win32_semaphore.rb}

@@ -14,7 +14,7 @@ class TC_Semaphore < Test::Unit::TestCase
    end
    
    def test_version
-      assert_equal('0.3.0', Semaphore::VERSION)
+      assert_equal('0.3.1', Semaphore::VERSION)
    end
    
    def test_max_semaphore_name

data/win32-semaphore.gemspec

@@ -1,24 +1,29 @@
-require "rubygems"
+require 'rubygems'
 
 spec = Gem::Specification.new do |gem|
-   gem.name        = "win32-semaphore"
-   gem.version     = "0.3.0"
-   gem.author      = "Daniel J. Berger"
-   gem.email       = "djberg96@gmail.com"
-   gem.homepage    = "http://www.rubyforge.org/projects/win32utils"
+   gem.name        = 'win32-semaphore'
+   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 Semaphore objects."
-   gem.description = "Interface to MS Windows Semaphore objects."
-   gem.test_file   = "test/tc_semaphore.rb"
+   gem.summary     = 'Interface to MS Windows Semaphore objects.'
+   gem.test_file   = 'test/test_win32_semaphore.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.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')
+
+   gem.description = <<-EOF
+      The win32-semaphore library provides an interface to semaphore objects
+      on MS Windows. A semaphore is a kernel object used for resource counting.
+      This allows threads to query the number of resources available, and wait
+      if there aren't any available.
+   EOF
 end
+
+Gem::Builder.new(spec).build

metadata

@@ -1,68 +1,73 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.2
-specification_version: 1
 name: win32-semaphore
 version: !ruby/object:Gem::Version 
-  version: 0.3.0
-date: 2007-05-03 00:00:00 -06:00
-summary: Interface to MS Windows Semaphore objects.
-require_paths: 
-- lib
-email: djberg96@gmail.com
-homepage: http://www.rubyforge.org/projects/win32utils
-rubyforge_project: 
-description: Interface to MS Windows Semaphore 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
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-08-11 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: win32-ipc
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: "      The win32-semaphore library provides an interface to semaphore objects\n      on MS Windows. A semaphore is a kernel object used for resource counting.\n      This allows threads to query the number of resources available, and wait\n      if there aren't any available.\n"
+email: djberg96@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+- CHANGES
+- MANIFEST
 files: 
-- lib/win32/semaphore.rb
-- test/CVS
-- test/tc_semaphore.rb
 - CHANGES
-- CVS
-- doc
-- examples
-- lib
+- examples/example_semaphore.rb
+- lib/win32/semaphore.rb
 - MANIFEST
 - Rakefile
 - README
-- test
+- test/test_win32_semaphore.rb
 - win32-semaphore.gemspec
-test_files: 
-- test/tc_semaphore.rb
+has_rdoc: true
+homepage: http://www.rubyforge.org/projects/win32utils
+licenses: 
+- Artistic 2.0
+post_install_message: 
 rdoc_options: []
 
-extra_rdoc_files: 
-- README
-- CHANGES
-- 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: 
-- !ruby/object:Gem::Dependency 
-  name: win32-ipc
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Version::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 0.5.0
-    version: 
+rubyforge_project: win32utils
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Interface to MS Windows Semaphore objects.
+test_files: 
+- test/test_win32_semaphore.rb