win32-changenotify 0.5.1 → 0.6.0

data/lib/win32/changenotify/constants.rb

@@ -0,0 +1,28 @@
+module Windows
+  module Constants
+    FILE_ACTION_ADDED            = 0x00000001
+    FILE_ACTION_REMOVED          = 0x00000002
+    FILE_ACTION_MODIFIED         = 0x00000003
+    FILE_ACTION_RENAMED_OLD_NAME = 0x00000004
+    FILE_ACTION_RENAMED_NEW_NAME = 0x00000005
+
+    FILE_NOTIFY_CHANGE_FILE_NAME   = 1
+    FILE_NOTIFY_CHANGE_DIR_NAME    = 2
+    FILE_NOTIFY_CHANGE_ATTRIBUTES  = 4
+    FILE_NOTIFY_CHANGE_SIZE        = 8
+    FILE_NOTIFY_CHANGE_LAST_WRITE  = 16
+    FILE_NOTIFY_CHANGE_LAST_ACCESS = 32
+    FILE_NOTIFY_CHANGE_CREATION    = 64
+    FILE_NOTIFY_CHANGE_SECURITY    = 256
+
+    FILE_LIST_DIRECTORY        = 1
+    FILE_SHARE_READ            = 1
+    FILE_SHARE_WRITE           = 2
+    FILE_SHARE_DELETE          = 4
+    OPEN_EXISTING              = 3
+    FILE_FLAG_BACKUP_SEMANTICS = 0x02000000
+    FILE_FLAG_OVERLAPPED       = 0x40000000
+
+    INVALID_HANDLE_VALUE = 0xFFFFFFFF
+  end
+end

data/lib/win32/changenotify/functions.rb

@@ -0,0 +1,60 @@
+require 'ffi'
+
+module Windows
+  module Functions
+    extend FFI::Library
+
+    # Make FFI functions private
+    module FFI::Library
+      def attach_pfunc(*args)
+        attach_function(*args)
+        private args[0]
+      end
+    end
+
+    ffi_lib :kernel32
+
+    typedef :uintptr_t, :handle
+    typedef :ulong, :dword
+    typedef :pointer, :ptr
+
+    attach_pfunc :ReadDirectoryChangesW,
+      [:handle, :ptr, :dword, :bool, :dword, :ptr, :ptr, :ptr],
+      :bool
+
+    attach_pfunc :CreateIoCompletionPort,
+      [:handle, :handle, :pointer, :dword],
+      :handle
+
+    attach_pfunc :GetQueuedCompletionStatus,
+      [:handle, :ptr, :ptr, :ptr, :dword],
+      :bool,
+      :nonblock => true
+
+    attach_pfunc :CreateFileA,
+      [:string, :dword, :dword, :ptr, :dword, :dword, :handle],
+      :handle
+
+    attach_pfunc :FormatMessage, :FormatMessageA,
+      [:ulong, :pointer, :ulong, :ulong, :pointer, :ulong, :pointer], :ulong
+
+
+    # Returns a nicer Windows error message
+    def win_error(function, err=FFI.errno)
+      flags = 0x00001000 | 0x00000200
+      buf = FFI::MemoryPointer.new(:char, 1024)
+
+      FormatMessage(flags, nil, err , 0x0409, buf, 1024, nil)
+
+      function + ': ' + buf.read_string.strip
+    end
+
+    # Shortcut for win_error with raise builtin
+    def raise_windows_error(function, err=FFI.errno)
+      raise SystemCallError.new(win_error(function, err), err)
+    end
+
+    module_function :win_error
+    module_function :raise_windows_error
+  end
+end

data/lib/win32/changenotify/structs.rb

@@ -0,0 +1,26 @@
+require 'ffi'
+
+module Windows
+  module Structs
+    extend FFI::Library
+
+    class OVERLAPPED < FFI::Struct
+      layout(
+        :Internal, :uintptr_t,
+        :InternalHigh, :uintptr_t,
+        :Offset, :ulong,
+        :OffsetHigh, :ulong,
+        :hEvent, :uintptr_t
+      )
+    end
+
+    class FILE_NOTIFY_INFORMATION < FFI::Struct
+      layout(
+        :NextEntryOffset, :ulong,
+        :Action, :ulong,
+        :FileNameLength, :ulong,
+        :FileName, [:uint8, 1024]
+      )
+    end
+  end
+end

data/test/test_win32_changenotify.rb

@@ -1,70 +1,93 @@
-#############################################################################
-# test_win32_changenotify.rb
-#
-# Test suite for the win32-changenotify package. You should run this
-# test via the 'rake test' task.
-#############################################################################
-require 'test/unit'
-require 'win32/changenotify'
-include Win32
-
-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.1', ChangeNotify::VERSION)
-   end
-	
-   def test_path
-      assert_respond_to(@cn, :path)
-      assert_equal("c:\\", @cn.path)
-   end
-   
-   def test_recursive
-      assert_respond_to(@cn, :recursive?)
-      assert_equal(false, @cn.recursive?)
-   end
-   
-   def test_filter
-      assert_respond_to(@cn, :filter)
-      assert_equal(@filter, @cn.filter)
-   end
-
-   # The errors here are expected because of the timeout.
-   def test_wait
-      assert_respond_to(@cn, :wait)
-      assert_raises(ChangeNotify::Error){ @cn.wait(0.001) }
-      assert_raises(ChangeNotify::Error){ @cn.wait(0.001){} }
-   end
-	
-   def test_wait_any
-      assert_respond_to(@cn, :wait_any)
-   end
-	
-   def test_wait_all
-      assert_respond_to(@cn, :wait_all)
-   end
-   
-   def test_expected_errors
-      assert_raises(TypeError){
-         ChangeNotify.new(1, true, @filter)
-      }
-      assert_raises(TypeError){
-         ChangeNotify.new("C:\\", 'foo', @filter)
-      }
-      assert_raises(TypeError){
-         ChangeNotify.new("C:\\", false, "foo")
-      }
-      assert_raises(TypeError){
-         ChangeNotify.new(1, true, @filter, 'bogus')
-      }
-   end
-	
-   def teardown
-      @cn = nil
-      @filter = nil
-   end
-end
+#############################################################################
+# test_win32_changenotify.rb
+#
+# Test suite for the win32-changenotify package. You should run this
+# test via the 'rake test' task.
+#############################################################################
+require 'test-unit'
+require 'win32/changenotify'
+include Win32
+
+class TC_Win32_ChangeNotify < Test::Unit::TestCase
+  def setup
+    @filter = ChangeNotify::FILE_NAME | ChangeNotify::DIR_NAME
+    @cn = ChangeNotify.new("c:\\", false, @filter)
+  end
+
+  test "version constant is set to expected value" do
+    assert_equal('0.6.0', ChangeNotify::VERSION)
+  end
+
+  test "path basic functionality" do
+    assert_respond_to(@cn, :path)
+    assert_nothing_raised{ @cn.path }
+    assert_kind_of(String, @cn.path)
+  end
+
+  test "path returns expected value" do
+    assert_equal("c:\\", @cn.path)
+  end
+
+  test "recursive basic functionality" do
+    assert_respond_to(@cn, :recursive?)
+    assert_nothing_raised{ @cn.recursive? }
+    assert_boolean(@cn.recursive?)
+  end
+
+  test "recursive returns expected value" do
+    assert_equal(false, @cn.recursive?)
+  end
+
+  test "filter method basic functionality" do
+    assert_respond_to(@cn, :filter)
+    assert_nothing_raised{ @cn.filter }
+    assert_kind_of(Numeric, @cn.filter)
+  end
+
+  test "filter method returns expected value" do
+    assert_equal(@filter, @cn.filter)
+  end
+
+  test "wait basic functionality" do
+    assert_respond_to(@cn, :wait)
+  end
+
+  test "an error is raised if a timeout occurs" do
+    assert_raise(SystemCallError){ @cn.wait(0.001) }
+    assert_raise(SystemCallError){ @cn.wait(0.001){} }
+  end
+
+  test "inherits wait_any method from Ipc parent" do
+    assert_respond_to(@cn, :wait_any)
+  end
+
+  test "inherites wait_all method from Ipc parent" do
+    assert_respond_to(@cn, :wait_all)
+  end
+
+  test "constructor requires the first argument to be a string" do
+    assert_raises(TypeError){ ChangeNotify.new(1, true, @filter) }
+  end
+
+  test "constructor requires second argument to be a boolean" do
+    assert_raises(TypeError){ ChangeNotify.new("C:\\", 'foo', @filter) }
+  end
+
+  test "constructor requires third argument to be numeric" do
+    assert_raises(TypeError){ ChangeNotify.new("C:\\", false, "foo") }
+  end
+
+  test "constructor requires fourth argument to be a Win32::Event object" do
+    assert_raises(TypeError){ ChangeNotify.new(1, true, @filter, 'bogus') }
+  end
+
+  test "ffi functions are private" do
+    assert_not_respond_to(@cn, :ReadDirectoryChangesW)
+    assert_not_respond_to(ChangeNotify, :ReadDirectoryChangesW)
+  end
+
+  def teardown
+    @cn = nil
+    @filter = nil
+  end
+end

data/win32-changenotify.gemspec

@@ -1,28 +1,28 @@
-require 'rubygems'
-
-spec = Gem::Specification.new do |gem|
-   gem.name        = 'win32-changenotify'
-   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.test_file   = 'test/test_win32_changenotify.rb'
-   gem.has_rdoc    = true
-   gem.files       = Dir['**/*'].reject{ |f| f.include?('CVS') }
-
-   gem.rubyforge_project = 'win32utils'
-   gem.extra_rdoc_files  = ['MANIFEST', 'README', 'CHANGES']
-
-   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
+require 'rubygems'
+
+Gem::Specification.new do |spec|
+  spec.name        = 'win32-changenotify'
+  spec.version     = '0.6.0'
+  spec.author      = 'Daniel J. Berger'
+  spec.license     = 'Artistic 2.0'
+  spec.email       = 'djberg96@gmail.com'
+  spec.homepage    = 'http://github.com/djberg96/win32-changenotify'
+  spec.summary     = 'A way to monitor files and directories on MS Windows'
+  spec.test_file   = 'test/test_win32_changenotify.rb'
+  spec.files       = Dir['**/*'].reject{ |f| f.include?('git') }
+
+  spec.rubyforge_project = 'win32utils'
+  spec.extra_rdoc_files  = ['MANIFEST', 'README', 'CHANGES']
+
+  spec.add_dependency('ffi')
+  spec.add_dependency('win32-event')
+
+  spec.add_development_dependency('test-unit')
+  spec.add_development_dependency('rake')
+
+  spec.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

metadata

@@ -1,73 +1,117 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: win32-changenotify
-version: !ruby/object:Gem::Version 
-  version: 0.5.1
+version: !ruby/object:Gem::Version
+  version: 0.6.0
 platform: ruby
-authors: 
+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
+date: 2013-08-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ffi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   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"
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: win32-event
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |2
+      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.
 email: djberg96@gmail.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - MANIFEST
 - README
 - CHANGES
-files: 
+files:
 - CHANGES
 - examples/example_win32_changenotify.rb
+- lib/win32/changenotify/constants.rb
+- lib/win32/changenotify/functions.rb
+- lib/win32/changenotify/structs.rb
 - lib/win32/changenotify.rb
 - MANIFEST
 - Rakefile
 - README
 - test/test_win32_changenotify.rb
 - win32-changenotify.gemspec
-has_rdoc: true
-homepage: http://www.rubyforge.org/projects/win32utils
-licenses: 
+homepage: http://github.com/djberg96/win32-changenotify
+licenses:
 - Artistic 2.0
+metadata: {}
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+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: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: win32utils
-rubygems_version: 1.3.5
+rubygems_version: 2.0.7
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: A way to monitor files and directories on MS Windows
-test_files: 
+test_files:
 - test/test_win32_changenotify.rb