win32-changenotify 0.5.1 → 0.6.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 07c45d703b303035e2b57bdf85bfea1f31b17cea
+  data.tar.gz: a1804830a560e2aa35988900b95394558522fa59
+SHA512:
+  metadata.gz: 9915924bc56a91d81437e64cab7bb495297683ee4cb6835c32806a689f7e57f1e705ccbacdc1cc6b657e731ec62d94338a4e243f4c0233b88b7a465d55b20a20
+  data.tar.gz: 871f135bdd7f00971de340600904226f4e5af36c475ee3447401a36d4f8cabf335605c6d67ffa37373f9d54dda955e3a3eecf0ca8ce1eb8b08bcb9e7edf5729c

data/CHANGES

@@ -1,66 +1,70 @@
-== 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.
-* The constructor now accepts a block. If provided, it yields itself
-  and automatically closes itself when the block terminates.
-* Removed the ChangeNotify#reset method. It was never especially useful,
-  and now it's useless because of the way we wait for events (see below).
-* Added a Rakefile with tasks for installation and testing.
-* The code now uses completion ports internally, which greatly improves the
-  number of simultaneous events it can detect and report. See the 'Known
-  Issues' in the README for details on potential misses, however.
-* Some internal reorganization, with the C related code now moved into a
-  separate directory.
-* Doc, test, and example program updates.
-
-== 0.4.2 - 22-Nov-2006
-* Fixed bugs caused by changes to the Ruby internals with regards to question
-  marks and instance variables.  Thanks go to an anonymous user for the spot.
-* Minor documentation updates.
-
-== 0.4.1 - 2-Jan-2006
-* Code cleanup
-
-== 0.4.0 - 20-Apr-2005
-* ChangeNotify#wait now returns an array of ChangeNotifyStruct's, rather than
-  a single struct, because multiple notifications can occur for a single
-  event.
-* Example program and test suite updates.
-* Removed the changenotify.rd file.
-
-== 0.3.1 - 4-Feb-2005
-* Fixed a bug in ChangeNotify#wait where the timeout was not set to the
-  proper default if a timeout was not specified by the user.  Thanks go
-  to CT for the spot.
-* Made this document rdoc friendly.
-* Corrected the release date for 0.3.0.
-
-== 0.3.0 - 25-Jan-2005
-* The ChangeNotify#wait method now yields a ChangeNotifyStruct if a block is
-  provided.  This struct contains more detail on what changes occurred.
-* Added the ChangeNotify#path, ChangeNotify#recursive? and ChangeNotify#filter
-  methods.
-* The ChangeNotify.new method no longer accepts a block.  See the developer's
-  notes if you want the nitty gritty details.
-* Added more code to the extconf.rb file.  This was needed to set the
-  _WIN32_WINNT macro properly.
-* Moved the 'examples' directory to the toplevel.
-* Test suite and documentation updates.
-
-== 0.2.0 - 17-Jul-2004
-* Now uses the newer allocation framework.  This means that, as of this
-  releas, this package requires Ruby 1.8.0 or later.
-* Moved the test.rb file to doc/examples.
-
-== 0.1.0 - 7-May-2004
-* Initial release
+== 0.6.0 - 16-Aug-2013
+* Converted code to FFI.
+* Updated dependencies in the gemspec, including ffi and win32-event.
+
+== 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.
+* The constructor now accepts a block. If provided, it yields itself
+  and automatically closes itself when the block terminates.
+* Removed the ChangeNotify#reset method. It was never especially useful,
+  and now it's useless because of the way we wait for events (see below).
+* Added a Rakefile with tasks for installation and testing.
+* The code now uses completion ports internally, which greatly improves the
+  number of simultaneous events it can detect and report. See the 'Known
+  Issues' in the README for details on potential misses, however.
+* Some internal reorganization, with the C related code now moved into a
+  separate directory.
+* Doc, test, and example program updates.
+
+== 0.4.2 - 22-Nov-2006
+* Fixed bugs caused by changes to the Ruby internals with regards to question
+  marks and instance variables.  Thanks go to an anonymous user for the spot.
+* Minor documentation updates.
+
+== 0.4.1 - 2-Jan-2006
+* Code cleanup
+
+== 0.4.0 - 20-Apr-2005
+* ChangeNotify#wait now returns an array of ChangeNotifyStruct's, rather than
+  a single struct, because multiple notifications can occur for a single
+  event.
+* Example program and test suite updates.
+* Removed the changenotify.rd file.
+
+== 0.3.1 - 4-Feb-2005
+* Fixed a bug in ChangeNotify#wait where the timeout was not set to the
+  proper default if a timeout was not specified by the user.  Thanks go
+  to CT for the spot.
+* Made this document rdoc friendly.
+* Corrected the release date for 0.3.0.
+
+== 0.3.0 - 25-Jan-2005
+* The ChangeNotify#wait method now yields a ChangeNotifyStruct if a block is
+  provided.  This struct contains more detail on what changes occurred.
+* Added the ChangeNotify#path, ChangeNotify#recursive? and ChangeNotify#filter
+  methods.
+* The ChangeNotify.new method no longer accepts a block.  See the developer's
+  notes if you want the nitty gritty details.
+* Added more code to the extconf.rb file.  This was needed to set the
+  _WIN32_WINNT macro properly.
+* Moved the 'examples' directory to the toplevel.
+* Test suite and documentation updates.
+
+== 0.2.0 - 17-Jul-2004
+* Now uses the newer allocation framework.  This means that, as of this
+  releas, this package requires Ruby 1.8.0 or later.
+* Moved the test.rb file to doc/examples.
+
+== 0.1.0 - 7-May-2004
+* Initial release

data/MANIFEST

@@ -1,11 +1,11 @@
-* CHANGES
-* README
-* MANIFEST
-* Rakefile
-* win32-changenotify.gemspec
-* examples/test.rb
-* ext/extconf.rb
-* ext/win32/changenotify.c
-* ext/win32/changenotify.h
-* lib/win32/changenotify.rb
-* test/test_win32_changenotify.rb
+* CHANGES
+* README
+* MANIFEST
+* Rakefile
+* win32-changenotify.gemspec
+* examples/test.rb
+* lib/win32/changenotify.rb
+* lib/win32/changenotify/constants.rb
+* lib/win32/changenotify/functions.rb
+* lib/win32/changenotify/structs.rb
+* test/test_win32_changenotify.rb

data/README

@@ -1,97 +1,91 @@
-= Description
-	A class for monitoring events related to files and directories.  This
-	package is deprecated in favor of win32-changejournal on NTFS filesystems.
-
-= Prerequisites
-   * Ruby 1.8.0 or later
-   * win32-ipc 0.4.0 or later
-
-= Installation
-   rake test (optional)
-   rake install (non-gem) OR rake install_gem (gem)
-
-= Synopsis
-   require 'win32/changenotify'
-   include Win32
-	
-   # Indefinitely wait for a change in 'C:\some\path' and any of its
-   # subdirectories.  Print the file and action affected.
-	
-   filter = ChangeNotify::FILE_NAME | ChangeNotify::DIR_NAME
-   path   = 'C:\some\path'
-   
-   cn = ChangeNotify.new(path, true, filter)
-
-   cn.wait{ |arr|
-      arr.each{ |info|
-         p info.file_name
-         p info.action
-      }
-   }
-   
-   cn.close
-   
-   # OR
-   
-   ChangeNotify.new(path, true, filter) do |events|
-   	events.each{ |event|
-   		p event.file_name
-   		p event.action
-   	}
-   end
-
-= Notes
-   The Win32::ChangeNotify class is a subclass of Win32::Ipc, and thus has
-   all of its methods available as well.
-	
-   This library is deprecated in favor of win32-changejournal on NTFS
-   filesystems.
-   
-= 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
-	that it does NOT contain the completion port approach we use in 0.5.0 and
-	later and is actually less reliable (in terms of how many simultaneous
-	events it can pickup) as a result.
-	
-= Known Issues
-   Despite the improvements yielded as a result of using completion ports,
-   it's still possible that events could be missed. To be more precise,
-   any events that occur in the fraction of a second between the call to
-   GetQueuedCompletionStatus() and ReadDirectoryChangesW() in the wait loop
-   will not get picked up. As a general rule, the faster your system is,
-   the less likely you are to encounter this scenario.
-   
-   We do not believe it is possible to resolve this issue without native
-   thread support. We are, however, open to suggestions. :)
-
-= Acknowledgements
-   This class was originally based on the Win32::ChangeNotify Perl module by
-   Christopher Madsen.
-	
-= Future Plans
-   Probably none. This library is deprecated in favor of win32-changejournal.
-   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
-   ideas and patches.
-	
-= Known Bugs  
-   None that I know of. Please log any other bug reports on the RubyForge
-   project page at http://www.rubyforge.net/projects/win32utils
-   
-= License
-   Artistic 2.0
-    
-= Copyright
-   (C) 2003-2009 Daniel J. Berger, All Rights Reserved
-    
-= 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.
-	
-= Authors
-   Park Heesob
-   Daniel J. Berger
+= Description
+  A class for monitoring events related to files and directories.  This
+  package is deprecated in favor of win32-changejournal on NTFS filesystems.
+
+= Prerequisites
+  * ffi
+  * win32-ipc
+  * win32-event
+
+= Installation
+  gem install win32-changenotify
+
+= Synopsis
+  require 'win32/changenotify'
+  include Win32
+  
+  # Indefinitely wait for a change in 'C:\some\path' and any of its
+  # subdirectories.  Print the file and action affected.
+  
+  filter = ChangeNotify::FILE_NAME | ChangeNotify::DIR_NAME
+  path   = 'C:\some\path'
+   
+  cn = ChangeNotify.new(path, true, filter)
+
+  cn.wait{ |arr|
+    arr.each{ |info|
+      p info.file_name
+      p info.action
+    }
+  }
+   
+  cn.close
+   
+  # OR
+   
+  ChangeNotify.new(path, true, filter) do |events|
+    events.each{ |event|
+      p event.file_name
+      p event.action
+    }
+  end
+
+= Notes
+  The Win32::ChangeNotify class is a subclass of Win32::Ipc, and thus has
+  all of its methods available as well.
+  
+  This library is deprecated in favor of win32-changejournal on NTFS
+  filesystems.
+   
+= Known Issues
+  Despite the improvements yielded as a result of using completion ports,
+  it's still possible that events could be missed. To be more precise,
+  any events that occur in the fraction of a second between the call to
+  GetQueuedCompletionStatus() and ReadDirectoryChangesW() in the wait loop
+  will not get picked up. As a general rule, the faster your system is,
+  the less likely you are to encounter this scenario.
+   
+  With Ruby 2.x and JRuby this should be even less of an issue than it's
+  been in the past.
+
+= Acknowledgements
+  This class was originally based on the Win32::ChangeNotify Perl module by
+  Christopher Madsen.
+  
+= Future Plans
+  Probably none. This library is deprecated in favor of win32-changejournal.
+  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
+  ideas and patches.
+  
+= Known Bugs  
+  None that I know of. Please report any issues on the project page at:
+  
+  http://www.github.com/djberg96/win32-changenotify
+   
+= License
+  Artistic 2.0
+    
+= Copyright
+  (C) 2003-2013 Daniel J. Berger, All Rights Reserved
+    
+= 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.
+  
+= Authors
+  Park Heesob
+  Daniel J. Berger

data/Rakefile

@@ -1,30 +1,39 @@
 require 'rake'
 require 'rake/testtask'
+require 'rake/clean'
 require 'rbconfig'
-include Config
+include RbConfig
 
-desc 'Install the win32-changenotify package (non-gem)'
-task :install do
-   sitelibdir = CONFIG['sitelibdir']
-   installdir = File.join(sitelibdir, 'win32')
-   file = 'lib\win32\changenotify.rb'
+CLEAN.include("**/*.gem")
 
-   Dir.mkdir(installdir) unless File.exists?(installdir)
-   FileUtils.cp(file, installdir, :verbose => true)
-end
+namespace :gem do
+  desc 'Create the win32-changenotify gem'
+  task :create => [:clean] do
+    spec = eval(IO.read('win32-changenotify.gemspec'))
+    if Gem::VERSION.to_f >= 2.0
+      require 'rubygems/package'
+      Gem::Package.build(spec)
+    else
+      Gem::Builder.new(spec).build
+    end
+  end
 
-desc 'Install the win32-changenotify library as a gem'
-task :install_gem do
-   ruby 'win32-changenotify.gemspec'
-   file = Dir["*.gem"].first
-   sh "gem install #{file}"
+  desc 'Install the win32-changenotify gem'
+  task :install => [:create] do
+    ruby 'win32-changenotify.gemspec'
+    file = Dir["*.gem"].first
+    sh "gem install #{file}"
+  end
 end
 
 desc 'Run the example program'
 task :example do
-   ruby '-Ilib examples/example_win32_changenotify.rb'
+  ruby '-Ilib examples/example_win32_changenotify.rb'
+end
 
 Rake::TestTask.new do |t|
-   t.verbose = true
-   t.warning = true
+  t.verbose = true
+  t.warning = true
 end
+
+task :default => :test

data/examples/example_win32_changenotify.rb

@@ -1,35 +1,36 @@
-#######################################################################
-# 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"
+#######################################################################
+# 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'
+include Win32
+
+puts "VERSION: " + ChangeNotify::VERSION
+sec = 10
+dir = "C:\\Users"
+
+puts "This will timeout after #{sec} seconds of inactivity on #{dir}."
+
+flags = ChangeNotify::FILE_NAME | ChangeNotify::DIR_NAME
+flags |= ChangeNotify::LAST_WRITE
+
+cn = ChangeNotify.new(dir, true, flags)
+
+# Wait up to 'sec' seconds for something to happen
+begin
+  cn.wait(sec) do |events|
+    events.each { |event|
+	    puts "Something changed"
+	    puts "File: " + event.file_name
+	    puts "Action: " + event.action
+    }
+  end
+rescue
+  cn.close
+end
+
+puts "ChangeNotify example program done"