win32-changenotify 0.5.0 → 0.5.1

data/CHANGES

@@ -1,3 +1,13 @@
+== 0.5.1 - 21-Aug-2009
+* License changed to Artistic 2.0.
+* The ChangeNotify#wait method is now slightly more robust.
+* Renamed test file to test_win32_changenotify.rb.
+* Some gemspec updates, including license and description.
+* Renamed example file to example_win32_changenotify.rb to avoid any
+  confusion with actual test files.
+* Removed the doc/changenotify.txt file because I felt it was redundant.
+* Added an example rake task.
+
 == 0.5.0 - 9-Aug-2007
 * Now pure Ruby!
 * Now requires the win32-event library.

data/MANIFEST

@@ -3,10 +3,9 @@
 * MANIFEST
 * Rakefile
 * win32-changenotify.gemspec
-* doc/changenotify.txt
 * examples/test.rb
 * ext/extconf.rb
 * ext/win32/changenotify.c
 * ext/win32/changenotify.h
 * lib/win32/changenotify.rb
-* test/tc_changenotify.rb
+* test/test_win32_changenotify.rb

data/README

@@ -47,9 +47,6 @@
    This library is deprecated in favor of win32-changejournal on NTFS
    filesystems.
    
-   For additional documentation please see the 'changenotify.txt' file under
-   the 'doc' directory.
-   
 = Pure Ruby vs C Extension
 	The C code we used for this library prior to 0.5.0 is still available in
 	CVS for this project, but is not distributed with official releases. Note
@@ -74,7 +71,7 @@
 	
 = Future Plans
    Probably none. This library is deprecated in favor of win32-changejournal.
-   However, that library only works on NTFS filesystems, so this package will
+   However, that library only works on NTFS filesystems, so this library will
    be maintained as well.
    
    That being said, I'm always open to improvements, so feel free to submit
@@ -85,10 +82,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

@@ -20,9 +20,11 @@ task :install_gem do
    sh "gem install #{file}"
 end
 
+desc 'Run the example program'
+task :example do
+   ruby '-Ilib examples/example_win32_changenotify.rb'
+
 Rake::TestTask.new do |t|
-   t.libs << 'test'
    t.verbose = true
    t.warning = true
-   t.test_files = FileList['test/tc_changenotify.rb']
 end

data/examples/example_win32_changenotify.rb

@@ -0,0 +1,35 @@
+#######################################################################
+# example_win32_changenotify.rb
+#
+# An example script for general futzing and demonstration. You can
+# run this program via the 'rake example' task.
+#
+# Modify as you see fit.
+#######################################################################
+require 'win32/changenotify'
+require 'pp'
+include Win32
+
+puts "VERSION: " + ChangeNotify::VERSION
+
+puts "This will run for 20 seconds"
+
+flags = ChangeNotify::FILE_NAME | ChangeNotify::DIR_NAME
+flags |= ChangeNotify::LAST_WRITE
+
+cn = ChangeNotify.new("c:\\", true, flags)
+
+# Wait up to 20 seconds for something to happen
+begin
+   cn.wait(20){ |events|
+      events.each { |event|
+	     puts "Something changed"
+	     puts "File: " + event.file_name
+	     puts "Action: " + event.action
+      }
+   }
+rescue
+   cn.close
+end
+
+puts "ChangeNotify example program done"

data/lib/win32/changenotify.rb

@@ -5,7 +5,10 @@ require 'windows/directory'
 require 'windows/unicode'
 require 'windows/msvcrt/buffer'
 
+# The Win32 module serves as a namespace only
 module Win32
+   
+   # The Win32::ChangeNotify class encapsulates filesystem change notifications
    class ChangeNotify < Ipc
       include Windows::NIO
       include Windows::File
@@ -13,8 +16,8 @@ module Win32
       include Windows::Unicode
       include Windows::MSVCRT::Buffer
       
-      # The version of this library
-      VERSION = '0.5.0'
+      # The version of the win32-changenotify library
+      VERSION = '0.5.1'
       
       # Aliased constants
  
@@ -36,6 +39,8 @@ module Win32
       # Filter: File size changes
       SIZE = FILE_NOTIFY_CHANGE_SIZE
       
+      # :stopdoc:
+      
       # Private constants
      
       # File was added
@@ -56,6 +61,8 @@ module Win32
       # Yielded by the ChangeNotify#wait method
       ChangeNotifyStruct = Struct.new('ChangeNotifyStruct', :action, :file_name)
       
+      # :startdoc:
+      
       # The path that was provided to the constructor
       attr_reader :path
       
@@ -137,48 +144,14 @@ module Win32
          subtree    = @recursive ? 1 : 0
          dir_handle = get_dir_handle(@path)        
          comp_key   = [12345].pack('L')
-               
-         comp_port = CreateIoCompletionPort(dir_handle, 0, comp_key, 0)
-         
-         if comp_port == 0
-            raise Error, get_last_error
-         end
-
-         bool = ReadDirectoryChangesW(
-            dir_handle,
-            fni,
-            fni.size,
-            subtree,
-            @filter,
-            rbytes,
-            @overlap,
-            0
-         )
-         
-         unless bool
-            raise Error, get_last_error
-         end
-         
-         while true
-            bool = GetQueuedCompletionStatus(
-               comp_port,
-               qbytes,
-               comp_key,
-               @overlap,
-               seconds
-            )
+                  
+         begin
+            comp_port = CreateIoCompletionPort(dir_handle, 0, comp_key, 0)
             
-            unless bool
+            if comp_port == 0
                raise Error, get_last_error
             end
-            
-            @signaled = true
-            @event.signaled = true
-           
-            break if comp_key.unpack('L').first == 0
-                     
-            yield get_file_action(fni) if block_given?
-                       
+
             bool = ReadDirectoryChangesW(
                dir_handle,
                fni,
@@ -193,13 +166,52 @@ module Win32
             unless bool
                raise Error, get_last_error
             end
+            
+            while true
+               bool = GetQueuedCompletionStatus(
+                  comp_port,
+                  qbytes,
+                  comp_key,
+                  @overlap,
+                  seconds
+               )
+               
+               unless bool
+                  raise Error, get_last_error
+               end
+               
+               @signaled = true
+               @event.signaled = true
+              
+               break if comp_key.unpack('L').first == 0
+                        
+               yield get_file_action(fni) if block_given?
+                          
+               bool = ReadDirectoryChangesW(
+                  dir_handle,
+                  fni,
+                  fni.size,
+                  subtree,
+                  @filter,
+                  rbytes,
+                  @overlap,
+                  0
+               )
+               
+               unless bool
+                  raise Error, get_last_error
+               end
+            end
+         ensure 
+            CloseHandle(dir_handle)
          end
-         
-         CloseHandle(dir_handle)
       end
       
       private
       
+      # Returns an array of ChangeNotify structs, each containing a file name
+      # and an action.
+      #
       def get_file_action(fni2)
          fni = fni2.dup
          array  = []       
@@ -260,4 +272,4 @@ module Win32
          handle
       end
    end
-end
+end

data/test/{tc_changenotify.rb → test_win32_changenotify.rb}

@@ -1,5 +1,5 @@
 #############################################################################
-# tc_changenotify.rb
+# test_win32_changenotify.rb
 #
 # Test suite for the win32-changenotify package. You should run this
 # test via the 'rake test' task.
@@ -8,14 +8,14 @@ require 'test/unit'
 require 'win32/changenotify'
 include Win32
 
-class TC_ChangeNotify < Test::Unit::TestCase
+class TC_Win32_ChangeNotify < Test::Unit::TestCase
    def setup
       @filter = ChangeNotify::FILE_NAME | ChangeNotify::DIR_NAME
       @cn = ChangeNotify.new("c:\\", false, @filter)
    end
 	
    def test_version
-      assert_equal('0.5.0', ChangeNotify::VERSION)
+      assert_equal('0.5.1', ChangeNotify::VERSION)
    end
 	
    def test_path

data/win32-changenotify.gemspec

@@ -2,23 +2,27 @@ require 'rubygems'
 
 spec = Gem::Specification.new do |gem|
    gem.name        = 'win32-changenotify'
-   gem.version     = '0.5.0'
+   gem.version     = '0.5.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     = 'A way to monitor files and directories on MS Windows'
-   gem.description = 'A way to monitor files and directories on MS Windows'
-   gem.test_file   = 'test/tc_changenotify.rb'
+   gem.test_file   = 'test/test_win32_changenotify.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 = ['MANIFEST', 'README', 'CHANGES']
-   gem.add_dependency('windows-pr', '>= 0.7.0')
-end
+   gem.files       = Dir['**/*'].reject{ |f| f.include?('CVS') }
+
+   gem.rubyforge_project = 'win32utils'
+   gem.extra_rdoc_files  = ['MANIFEST', 'README', 'CHANGES']
 
-if $0 == __FILE__
-   Gem.manage_gems
-   Gem::Builder.new(spec).build
+   gem.add_dependency('windows-pr', '>= 1.0.6')
+
+   gem.description = <<-EOF
+      The win32-changenotify library provides an interface for monitoring
+      changes in files or diretories on the MS Windows filesystem. It not only
+      tells you when a change occurs, but the nature of the change as well.
+   EOF
 end
+
+Gem::Builder.new(spec).build

metadata

@@ -1,69 +1,73 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.4
-specification_version: 1
 name: win32-changenotify
 version: !ruby/object:Gem::Version 
-  version: 0.5.0
-date: 2007-08-09 00:00:00 -06:00
-summary: A way to monitor files and directories on MS Windows
-require_paths: 
-- lib
-email: djberg96@gmail.com
-homepage: http://www.rubyforge.org/projects/win32utils
-rubyforge_project: 
-description: A way to monitor files and directories 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.5.1
 platform: ruby
-signing_key: 
-cert_chain: 
-post_install_message: 
 authors: 
 - Daniel J. Berger
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-08-21 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-changenotify library provides an interface for monitoring\n      changes in files or diretories on the MS Windows filesystem. It not only\n      tells you when a change occurs, but the nature of the change as well.\n"
+email: djberg96@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- MANIFEST
+- README
+- CHANGES
 files: 
-- lib/win32/changenotify.rb
-- test/CVS
-- test/tc_changenotify.rb
 - CHANGES
-- CVS
-- doc
-- examples
-- ext
-- lib
+- examples/example_win32_changenotify.rb
+- lib/win32/changenotify.rb
 - MANIFEST
 - Rakefile
 - README
-- test
+- test/test_win32_changenotify.rb
 - win32-changenotify.gemspec
-test_files: 
-- test/tc_changenotify.rb
+has_rdoc: true
+homepage: http://www.rubyforge.org/projects/win32utils
+licenses: 
+- Artistic 2.0
+post_install_message: 
 rdoc_options: []
 
-extra_rdoc_files: 
-- MANIFEST
-- README
-- CHANGES
-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: windows-pr
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Version::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 0.7.0
-    version: 
+rubyforge_project: win32utils
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: A way to monitor files and directories on MS Windows
+test_files: 
+- test/test_win32_changenotify.rb