win32-file 0.7.2 → 0.7.3

data/lib/win32/file/constants.rb

@@ -1,27 +1,27 @@
-require 'ffi'
-
-module Windows
-  module File
-    module Constants
-      FILE_ATTRIBUTE_NORMAL = 0x00000080
-      FILE_ATTRIBUTE_REPARSE_POINT = 0x00000400
-      FILE_FLAG_BACKUP_SEMANTICS = 0x02000000
-      FILE_FLAG_OPEN_REPARSE_POINT = 0x00200000
-      FILE_SHARE_READ = 1
-
-      FILE_TYPE_UNKNOWN = 0x0000
-      FILE_TYPE_CHAR    = 0x0002
-      NO_ERROR = 0
-
-      GENERIC_READ = 0x80000000
-      INVALID_HANDLE_VALUE = (1 << FFI::Platform::ADDRESS_SIZE) - 1
-      INVALID_FILE_ATTRIBUTES = (1 << FFI::Platform::ADDRESS_SIZE) - 1
-      IO_REPARSE_TAG_SYMLINK = 0xA000000C
-      OPEN_EXISTING = 3
-
-      DRIVE_REMOVABLE = 2
-      DRIVE_CDROM     = 5
-      DRIVE_RAMDISK   = 6
-    end
-  end
-end
+require 'ffi'
+
+module Windows
+  module File
+    module Constants
+      FILE_ATTRIBUTE_NORMAL = 0x00000080
+      FILE_ATTRIBUTE_REPARSE_POINT = 0x00000400
+      FILE_FLAG_BACKUP_SEMANTICS = 0x02000000
+      FILE_FLAG_OPEN_REPARSE_POINT = 0x00200000
+      FILE_SHARE_READ = 1
+
+      FILE_TYPE_UNKNOWN = 0x0000
+      FILE_TYPE_CHAR    = 0x0002
+      NO_ERROR = 0
+
+      GENERIC_READ = 0x80000000
+      INVALID_HANDLE_VALUE = (1 << FFI::Platform::ADDRESS_SIZE) - 1
+      INVALID_FILE_ATTRIBUTES = (1 << FFI::Platform::ADDRESS_SIZE) - 1
+      IO_REPARSE_TAG_SYMLINK = 0xA000000C
+      OPEN_EXISTING = 3
+
+      DRIVE_REMOVABLE = 2
+      DRIVE_CDROM     = 5
+      DRIVE_RAMDISK   = 6
+    end
+  end
+end

data/lib/win32/file/functions.rb

@@ -1,49 +1,49 @@
-module Windows
-  module File
-    module Functions
-      extend FFI::Library
-      ffi_lib :kernel32
-
-      typedef :ulong, :dword
-      typedef :uintptr_t, :handle
-      typedef :pointer, :ptr
-
-      def self.attach_pfunc(*args)
-        attach_function(*args)
-        private args[0]
-      end
-
-      attach_pfunc :CloseHandle, [:handle], :bool
-      attach_pfunc :CreateFileW, [:buffer_in, :dword, :dword, :pointer, :dword, :dword, :handle], :handle
-      attach_pfunc :CreateSymbolicLinkW, [:buffer_in, :buffer_in, :dword], :bool
-      attach_pfunc :FindFirstFileW, [:buffer_in, :pointer], :handle
-      attach_pfunc :GetDiskFreeSpaceW, [:buffer_in, :pointer, :pointer, :pointer, :pointer], :bool
-      attach_pfunc :GetDriveTypeW, [:buffer_in], :uint
-      attach_pfunc :GetFileType, [:handle], :dword
-      attach_pfunc :GetFileAttributesW, [:buffer_in], :dword
-      attach_pfunc :GetFinalPathNameByHandleW, [:handle, :buffer_out, :dword, :dword], :dword
-      attach_pfunc :GetShortPathNameW, [:buffer_in, :buffer_out, :dword], :dword
-      attach_pfunc :GetLongPathNameW, [:buffer_in, :buffer_out, :dword], :dword
-      attach_pfunc :QueryDosDeviceA, [:string, :buffer_out, :dword], :dword
-
-      ffi_lib :shlwapi
-
-      attach_pfunc :PathFindExtensionW, [:buffer_in], :pointer
-      attach_pfunc :PathIsRootW, [:buffer_in], :bool
-      attach_pfunc :PathStripPathW, [:pointer], :void
-      attach_pfunc :PathRemoveBackslashW, [:buffer_in], :string
-      attach_pfunc :PathRemoveFileSpecW, [:pointer], :bool
-      attach_pfunc :PathRemoveExtensionW, [:buffer_in], :void
-      attach_pfunc :PathStripToRootW, [:buffer_in], :bool
-    end
-  end
-end
-
-class String
-  # Read a wide character string up until the first double null, and delete
-  # any remaining null characters.
-  def wstrip
-    self.force_encoding('UTF-16LE').encode('UTF-8',:invalid=>:replace,:undef=>:replace).
-    split("\x00")[0].encode(Encoding.default_external)
-  end
-end
+module Windows
+  module File
+    module Functions
+      extend FFI::Library
+      ffi_lib :kernel32
+
+      typedef :ulong, :dword
+      typedef :uintptr_t, :handle
+      typedef :pointer, :ptr
+
+      def self.attach_pfunc(*args)
+        attach_function(*args)
+        private args[0]
+      end
+
+      attach_pfunc :CloseHandle, [:handle], :bool
+      attach_pfunc :CreateFileW, [:buffer_in, :dword, :dword, :pointer, :dword, :dword, :handle], :handle
+      attach_pfunc :CreateSymbolicLinkW, [:buffer_in, :buffer_in, :dword], :bool
+      attach_pfunc :FindFirstFileW, [:buffer_in, :pointer], :handle
+      attach_pfunc :GetDiskFreeSpaceW, [:buffer_in, :pointer, :pointer, :pointer, :pointer], :bool
+      attach_pfunc :GetDriveTypeW, [:buffer_in], :uint
+      attach_pfunc :GetFileType, [:handle], :dword
+      attach_pfunc :GetFileAttributesW, [:buffer_in], :dword
+      attach_pfunc :GetFinalPathNameByHandleW, [:handle, :buffer_out, :dword, :dword], :dword
+      attach_pfunc :GetShortPathNameW, [:buffer_in, :buffer_out, :dword], :dword
+      attach_pfunc :GetLongPathNameW, [:buffer_in, :buffer_out, :dword], :dword
+      attach_pfunc :QueryDosDeviceA, [:string, :buffer_out, :dword], :dword
+
+      ffi_lib :shlwapi
+
+      attach_pfunc :PathFindExtensionW, [:buffer_in], :pointer
+      attach_pfunc :PathIsRootW, [:buffer_in], :bool
+      attach_pfunc :PathStripPathW, [:pointer], :void
+      attach_pfunc :PathRemoveBackslashW, [:buffer_in], :string
+      attach_pfunc :PathRemoveFileSpecW, [:pointer], :bool
+      attach_pfunc :PathRemoveExtensionW, [:buffer_in], :void
+      attach_pfunc :PathStripToRootW, [:buffer_in], :bool
+    end
+  end
+end
+
+class String
+  # Read a wide character string up until the first double null, and delete
+  # any remaining null characters.
+  def wstrip
+    self.force_encoding('UTF-16LE').encode('UTF-8',:invalid=>:replace,:undef=>:replace).
+    split("\x00")[0].encode(Encoding.default_external)
+  end
+end

data/lib/win32/file/structs.rb

@@ -1,24 +1,24 @@
-module Windows
-  module File
-    module Structs
-      class FILETIME < FFI::Struct
-        layout(:dwLowDateTime, :ulong, :dwHighDateTime, :ulong)
-      end
-
-      class WIN32_FIND_DATA < FFI::Struct
-        layout(
-          :dwFileAttributes, :ulong,
-          :ftCreationTime, FILETIME,
-          :ftLastAccessTime, FILETIME,
-          :ftLastWriteTime, FILETIME,
-          :nFileSizeHigh, :ulong,
-          :nFileSizeLow, :ulong,
-          :dwReserved0, :ulong,
-          :dwReserved1, :ulong,
-          :cFileName, [:uint8, 260*2],
-          :cAlternateFileName, [:uint8, 14*2]
-        )
-      end
-    end
-  end
-end
+module Windows
+  module File
+    module Structs
+      class FILETIME < FFI::Struct
+        layout(:dwLowDateTime, :ulong, :dwHighDateTime, :ulong)
+      end
+
+      class WIN32_FIND_DATA < FFI::Struct
+        layout(
+          :dwFileAttributes, :ulong,
+          :ftCreationTime, FILETIME,
+          :ftLastAccessTime, FILETIME,
+          :ftLastWriteTime, FILETIME,
+          :nFileSizeHigh, :ulong,
+          :nFileSizeLow, :ulong,
+          :dwReserved0, :ulong,
+          :dwReserved1, :ulong,
+          :cFileName, [:uint8, 260*2],
+          :cAlternateFileName, [:uint8, 14*2]
+        )
+      end
+    end
+  end
+end

data/test/test_win32_file_link.rb

@@ -1,141 +1,141 @@
-#############################################################################
-# test_win32_file_link.rb
-#
-# Test case for the link related methods of win32-file. You should run this
-# test via the 'rake test' or 'rake test:link' task.
-#############################################################################
-require 'test-unit'
-require 'win32/security'
-require 'win32/file'
-
-class TC_Win32_File_Link < Test::Unit::TestCase
-  def self.startup
-    Dir.chdir(File.expand_path(File.dirname(__FILE__)))
-    @@file = File.join(Dir.pwd, 'link_test.txt')
-    File.open(@@file, 'w'){ |fh| fh.puts "This is a link test." }
-  end
-
-  def setup
-    @link  = "this_is_a_symlink"
-    @file  = "link_test.txt"
-    @admin = Win32::Security.elevated_security?
-  end
-
-  test "symlink basic functionality" do
-    assert_respond_to(File, :symlink)
-  end
-
-  test "symlink to a file works as expected" do
-    omit_unless(@admin)
-    assert_nothing_raised{ File.symlink(@@file, @link) }
-    assert_true(File.exist?(@link))
-    assert_true(File.symlink?(@link))
-  end
-
-  test "symlink method returns zero" do
-    omit_unless(@admin)
-    assert_equal(0, File.symlink(@@file, @link))
-  end
-
-  test "symlink requires two arguments" do
-    assert_raise(ArgumentError){ File.symlink }
-    assert_raise(ArgumentError){ File.symlink(@link) }
-    assert_raise(ArgumentError){ File.symlink(@@file, @link, @link) }
-  end
-
-  test "symlink fails if link already exists" do
-    omit_unless(@admin)
-    File.symlink(@@file, @link)
-    assert_raise(SystemCallError){ File.symlink(@@file, @link) }
-  end
-
-  test "symlink does not fail if target does not exist" do
-    omit_unless(@admin)
-    assert_nothing_raised{ File.symlink('bogus.txt', @link) }
-  end
-
-  test "symlink? basic functionality" do
-    assert_respond_to(File, :symlink?)
-    assert_boolean(File.symlink?(@@file))
-  end
-
-  test "symlink? returns expected result" do
-    omit_unless(@admin)
-    File.symlink(@@file, @link)
-    assert_true(File.symlink?(@link))
-    assert_false(File.symlink?(@file))
-  end
-
-  test "symlink? requires one argument only" do
-    assert_raise(ArgumentError){ File.symlink? }
-    assert_raise(ArgumentError){ File.symlink?(@@file, @@file) }
-  end
-
-  test "readlink basic functionality" do
-    assert_respond_to(File, :readlink)
-  end
-
-  test "readlink returns the expected value when reading a symlink" do
-    omit_unless(@admin)
-    File.symlink(@file, @link)
-    expected = File.expand_path(@file).tr("/", "\\")
-    assert_equal(expected, File.readlink(@link))
-  end
-
-  test "readlink raises an error when reading a regular file" do
-    assert_raise(Errno::EINVAL){ File.readlink(@@file) }
-  end
-
-  test "readlink requires one argument only" do
-    assert_raise(ArgumentError){ File.readlink }
-    assert_raise(ArgumentError){ File.readlink(@link, @link) }
-  end
-
-  test "readlink raises an error if the file is not found" do
-    assert_raise(Errno::ENOENT){ File.readlink('bogus.txt') }
-  end
-
-  test "realdirpath basic functionality" do
-    assert_respond_to(File, :realdirpath)
-  end
-
-  test "realdirpath returns the expected value for a regular file" do
-    assert_equal(Dir.pwd, File.realdirpath(Dir.pwd))
-    assert_equal(@@file, File.realdirpath(@@file).tr("/", "\\"))
-  end
-
-  test "realdirpath returns the expected value for a symlink" do
-    omit_unless(@admin)
-    File.symlink(@@file, @link)
-    expected = File.expand_path(@file).tr("/", "\\")
-    assert_equal(expected, File.realdirpath(@link))
-  end
-
-  test "realpath basic functionality" do
-    assert_respond_to(File, :realpath)
-  end
-
-  test "realpath returns the expected value for a regular file" do
-    assert_equal(Dir.pwd, File.realpath(Dir.pwd))
-    assert_equal(@@file, File.realpath(@@file).tr("/", "\\"))
-  end
-
-  test "realpath returns the expected value for a symlink" do
-    omit_unless(@admin)
-    File.symlink(@@file, @link)
-    expected = File.expand_path(@file).tr("/", "\\")
-    assert_equal(expected, File.realpath(@link))
-  end
-
-  def teardown
-    File.delete(@link) rescue nil # Necessary for dangling links
-    @link  = nil
-    @admin = nil
-    @file  = nil
-  end
-
-  def self.shutdown
-    File.delete(@@file) if File.exist?(@@file)
-    @@file = nil
-  end
-end
+#############################################################################
+# test_win32_file_link.rb
+#
+# Test case for the link related methods of win32-file. You should run this
+# test via the 'rake test' or 'rake test:link' task.
+#############################################################################
+require 'test-unit'
+require 'win32/security'
+require 'win32/file'
+
+class TC_Win32_File_Link < Test::Unit::TestCase
+  def self.startup
+    Dir.chdir(File.expand_path(File.dirname(__FILE__)))
+    @@file = File.join(Dir.pwd, 'link_test.txt')
+    File.open(@@file, 'w'){ |fh| fh.puts "This is a link test." }
+  end
+
+  def setup
+    @link  = "this_is_a_symlink"
+    @file  = "link_test.txt"
+    @admin = Win32::Security.elevated_security?
+  end
+
+  test "symlink basic functionality" do
+    assert_respond_to(File, :symlink)
+  end
+
+  test "symlink to a file works as expected" do
+    omit_unless(@admin)
+    assert_nothing_raised{ File.symlink(@@file, @link) }
+    assert_true(File.exist?(@link))
+    assert_true(File.symlink?(@link))
+  end
+
+  test "symlink method returns zero" do
+    omit_unless(@admin)
+    assert_equal(0, File.symlink(@@file, @link))
+  end
+
+  test "symlink requires two arguments" do
+    assert_raise(ArgumentError){ File.symlink }
+    assert_raise(ArgumentError){ File.symlink(@link) }
+    assert_raise(ArgumentError){ File.symlink(@@file, @link, @link) }
+  end
+
+  test "symlink fails if link already exists" do
+    omit_unless(@admin)
+    File.symlink(@@file, @link)
+    assert_raise(SystemCallError){ File.symlink(@@file, @link) }
+  end
+
+  test "symlink does not fail if target does not exist" do
+    omit_unless(@admin)
+    assert_nothing_raised{ File.symlink('bogus.txt', @link) }
+  end
+
+  test "symlink? basic functionality" do
+    assert_respond_to(File, :symlink?)
+    assert_boolean(File.symlink?(@@file))
+  end
+
+  test "symlink? returns expected result" do
+    omit_unless(@admin)
+    File.symlink(@@file, @link)
+    assert_true(File.symlink?(@link))
+    assert_false(File.symlink?(@file))
+  end
+
+  test "symlink? requires one argument only" do
+    assert_raise(ArgumentError){ File.symlink? }
+    assert_raise(ArgumentError){ File.symlink?(@@file, @@file) }
+  end
+
+  test "readlink basic functionality" do
+    assert_respond_to(File, :readlink)
+  end
+
+  test "readlink returns the expected value when reading a symlink" do
+    omit_unless(@admin)
+    File.symlink(@file, @link)
+    expected = File.expand_path(@file).tr("/", "\\")
+    assert_equal(expected, File.readlink(@link))
+  end
+
+  test "readlink raises an error when reading a regular file" do
+    assert_raise(Errno::EINVAL){ File.readlink(@@file) }
+  end
+
+  test "readlink requires one argument only" do
+    assert_raise(ArgumentError){ File.readlink }
+    assert_raise(ArgumentError){ File.readlink(@link, @link) }
+  end
+
+  test "readlink raises an error if the file is not found" do
+    assert_raise(Errno::ENOENT){ File.readlink('bogus.txt') }
+  end
+
+  test "realdirpath basic functionality" do
+    assert_respond_to(File, :realdirpath)
+  end
+
+  test "realdirpath returns the expected value for a regular file" do
+    assert_equal(Dir.pwd, File.realdirpath(Dir.pwd))
+    assert_equal(@@file, File.realdirpath(@@file).tr("/", "\\"))
+  end
+
+  test "realdirpath returns the expected value for a symlink" do
+    omit_unless(@admin)
+    File.symlink(@@file, @link)
+    expected = File.expand_path(@file).tr("/", "\\")
+    assert_equal(expected, File.realdirpath(@link))
+  end
+
+  test "realpath basic functionality" do
+    assert_respond_to(File, :realpath)
+  end
+
+  test "realpath returns the expected value for a regular file" do
+    assert_equal(Dir.pwd, File.realpath(Dir.pwd))
+    assert_equal(@@file, File.realpath(@@file).tr("/", "\\"))
+  end
+
+  test "realpath returns the expected value for a symlink" do
+    omit_unless(@admin)
+    File.symlink(@@file, @link)
+    expected = File.expand_path(@file).tr("/", "\\")
+    assert_equal(expected, File.realpath(@link))
+  end
+
+  def teardown
+    File.delete(@link) rescue nil # Necessary for dangling links
+    @link  = nil
+    @admin = nil
+    @file  = nil
+  end
+
+  def self.shutdown
+    File.delete(@@file) if File.exist?(@@file)
+    @@file = nil
+  end
+end