win32-dir 0.3.7 → 0.4.0

data/lib/win32/dir/constants.rb

@@ -0,0 +1,18 @@
+module Dir::Constants
+  private
+
+  FILE_DEVICE_FILE_SYSTEM      = 0x00000009
+  INVALID_HANDLE_VALUE         = 0xFFFFFFFF
+  INVALID_FILE_ATTRIBUTES      = 0xFFFFFFFF
+  FILE_FLAG_OPEN_REPARSE_POINT = 0x00200000
+  FILE_FLAG_BACKUP_SEMANTICS   = 0x02000000
+  FILE_ATTRIBUTE_DIRECTORY     = 0x00000010
+  FILE_ATTRIBUTE_REPARSE_POINT = 0x00000400
+  ERROR_ALREADY_EXISTS         = 183
+  METHOD_BUFFERED              = 0
+  OPEN_EXISTING                = 3
+  GENERIC_READ                 = 0x80000000
+  GENERIC_WRITE                = 0x40000000
+  SHGFI_DISPLAYNAME            = 0x000000200
+  SHGFI_PIDL                   = 0x000000008
+end

data/lib/win32/dir/functions.rb

@@ -0,0 +1,35 @@
+# Necessary to force JRuby to use the gem, not its builtin version
+if RUBY_PLATFORM == 'java'
+  require 'rubygems'
+  gem 'ffi'
+end
+
+require 'ffi'
+
+module Dir::Functions
+  extend FFI::Library
+
+  ffi_lib :shell32
+
+  attach_function :SHGetFolderPathW, [:ulong, :int, :ulong, :ulong, :buffer_out], :ulong
+  attach_function :SHGetFolderLocation, [:ulong, :int, :ulong, :ulong, :pointer], :ulong
+  attach_function :SHGetFileInfo, [:ulong, :ulong, :pointer, :uint, :uint], :ulong
+
+  ffi_lib :shlwapi
+
+  attach_function :PathIsDirectoryEmptyW, [:buffer_in], :bool
+
+  ffi_lib :kernel32
+
+  attach_function :CloseHandle, [:ulong], :bool
+  attach_function :CreateDirectoryW, [:buffer_in, :pointer], :bool
+  attach_function :CreateFileW, [:buffer_in, :ulong, :ulong, :pointer, :ulong, :ulong, :ulong], :ulong
+  attach_function :DeviceIoControl, [:ulong, :ulong, :pointer, :ulong, :pointer, :ulong, :pointer, :pointer], :bool
+  attach_function :GetCurrentDirectoryW, [:ulong, :buffer_out], :ulong
+  attach_function :GetFileAttributesW, [:buffer_in], :ulong
+  attach_function :GetLastError, [], :ulong
+  attach_function :GetShortPathNameW, [:buffer_in, :buffer_out, :ulong], :ulong
+  attach_function :GetLongPathNameW, [:buffer_in, :buffer_out, :ulong], :ulong
+  attach_function :GetFullPathNameW, [:buffer_in, :ulong, :buffer_out, :pointer], :ulong
+  attach_function :RemoveDirectoryW, [:buffer_in], :bool
+end

data/lib/win32/dir/structs.rb

@@ -0,0 +1,29 @@
+require 'ffi'
+
+module Dir::Structs
+  extend FFI::Library
+
+  class SHFILEINFO < FFI::Struct
+    layout(
+      :hIcon, :ulong,
+      :iIcon, :int,
+      :dwAttributes, :ulong,
+      :szDisplayName, [:char, 256],
+      :szTypeName, [:char, 80]
+    )
+  end
+
+  # I fudge a bit, assuming a MountPointReparseBuffer
+  class REPARSE_JDATA_BUFFER < FFI::Struct
+    layout(
+      :ReparseTag, :ulong,
+      :ReparseDataLength, :ushort,
+      :Reserved, :ushort,
+      :SubstituteNameOffset, :ushort,
+      :SubstituteNameLength, :ushort,
+      :PrintNameOffset, :ushort,
+      :PrintNameLength, :ushort,
+      :PathBuffer, [:char, 1024]
+    )
+  end
+end

data/test/test_win32_dir.rb

@@ -5,30 +5,27 @@
 # Test suite for the win32-dir library.  You should run this test case
 # via the 'rake test' task.
 ###########################################################################
-require 'rubygems'
-gem 'test-unit'
-
-require 'test/unit'
+require 'test-unit'
 require 'win32/dir'
+require 'tmpdir'
 require 'fileutils'
 
 class TC_Win32_Dir < Test::Unit::TestCase
   def self.startup
-    @@test_home = File.dirname(File.expand_path(__FILE__))
+    @@java = RUBY_PLATFORM == 'java'
+    @@temp = Dir.tmpdir
+    @@from = File.join(@@temp, "test_from_directory")
+    Dir.mkdir(@@from)
   end
 
   def setup
-    Dir.chdir(@@test_home) unless File.basename(Dir.pwd) == 'test'
-    @@from = File.join(Dir.pwd, "test_from_directory")
-
-    @ascii_to   = "test_to_directory"
-    @unicode_to = "Ελλάσ" # Greek - the word is 'Hellas'
+    @ascii_to   = File.join(@@temp, "test_to_directory")
+    @unicode_to = File.join(@@temp, "Ελλάσ")
     @test_file  = File.join(@@from, "test.txt")
-    Dir.mkdir(@@from)
   end
-   
+
   def test_version
-    assert_equal('0.3.7', Dir::VERSION)
+    assert_equal('0.4.0', Dir::VERSION)
   end
 
   test 'glob handles backslashes' do
@@ -53,327 +50,336 @@ class TC_Win32_Dir < Test::Unit::TestCase
     assert_nothing_raised{ Dir[pattern] }
     assert_true(Dir[pattern].size > 0)
   end
-  
-  def test_create_junction_basic
+
+  test "create_junction basic functionality" do
     assert_respond_to(Dir, :create_junction)
   end
 
-  def test_create_junction_ascii
+  test "create_junction works as expected with ascii characters" do
     assert_nothing_raised{ Dir.create_junction(@ascii_to, @@from) }
     assert_true(File.exists?(@ascii_to))
     File.open(@test_file, 'w'){ |fh| fh.puts "Hello World" }
     assert_equal(Dir.entries(@@from), Dir.entries(@ascii_to))
   end
 
-  def test_create_junction_unicode
+  test "create_junction works as expected with unicode characters" do
     assert_nothing_raised{ Dir.create_junction(@unicode_to, @@from) }
     assert_true(File.exists?(@unicode_to))
     File.open(@test_file, 'w'){ |fh| fh.puts "Hello World" }
     assert_equal(Dir.entries(@@from), Dir.entries(@unicode_to))
   end
-   
-  def test_is_junction
+
+  test "junction? method returns boolean value" do
     assert_respond_to(Dir, :junction?)
     assert_nothing_raised{ Dir.create_junction(@ascii_to, @@from) }
-    assert_equal(false, Dir.junction?(@@from))
-    assert_equal(true, Dir.junction?(@ascii_to))
+    assert_false(Dir.junction?(@@from))
+    assert_true(Dir.junction?(@ascii_to))
   end
 
-  def test_reparse_dir_alias
-    assert_respond_to(Dir, :reparse_dir?) # alias
-    assert_equal(true, Dir.method(:reparse_dir?) == Dir.method(:junction?))
+  test "reparse_dir? is an aliase for junction?" do
+    assert_respond_to(Dir, :reparse_dir?)
+    assert_true(Dir.method(:reparse_dir?) == Dir.method(:junction?))
   end
-   
-  def test_is_empty
+
+  test "empty? method returns expected result" do
     assert_respond_to(Dir, :empty?)
-    assert_equal(false, Dir.empty?("C:\\")) # One would think
-    assert_equal(true, Dir.empty?(@@from))
+    assert_false(Dir.empty?("C:\\")) # One would think
+    assert_true(Dir.empty?(@@from))
   end
 
-  def test_pwd_basic
+  test "pwd basic functionality" do
+    omit_if(@@java)
     assert_respond_to(Dir, :pwd)
     assert_nothing_raised{ Dir.pwd }
     assert_kind_of(String, Dir.pwd)
   end
 
-  def test_pwd_short_path
+  test "pwd returns full path even if short path was just used" do
+    omit_if(@@java)
     Dir.chdir("C:\\Progra~1")
     assert_equal("C:\\Program Files", Dir.pwd)
   end
 
-  def test_pwd_long_path
+  test "pwd returns full path if long path was just used" do
+    omit_if(@@java)
     Dir.chdir("C:\\Program Files")
     assert_equal("C:\\Program Files", Dir.pwd)
   end
- 
-  def test_pwd_caps
+
+  test "pwd uses standard case conventions" do
+    omit_if(@@java)
     Dir.chdir("C:\\PROGRAM FILES")
     assert_equal("C:\\Program Files", Dir.pwd)
   end
-   
-  def test_pwd_forward_slash
+
+  test "pwd converts forward slashes to backslashes" do
+    omit_if(@@java)
     Dir.chdir("C:/Program Files")
     assert_equal("C:\\Program Files", Dir.pwd)
   end
-   
-  def test_pwd_is_proper_alias
+
+  test "pwd and getwd are aliases" do
+    omit_if(@@java)
     assert_true(Dir.method(:getwd) == Dir.method(:pwd))
   end
 
-  def test_admintools
+  test "admintools constant is set" do
     assert_not_nil(Dir::ADMINTOOLS)
     assert_kind_of(String, Dir::ADMINTOOLS)
   end
-   
-  def test_altstartup
+
+  test "altstartup constant is set" do
     assert_not_nil(Dir::ALTSTARTUP)
     assert_kind_of(String, Dir::ALTSTARTUP)
   end
-   
-  def test_appdata
+
+  test "appdata constant is set" do
     assert_not_nil(Dir::APPDATA)
     assert_kind_of(String, Dir::APPDATA)
   end
-   
-  def test_bitbucket
+
+  test "bitbucket constant is set" do
     assert_not_nil(Dir::BITBUCKET)
     assert_kind_of(String, Dir::BITBUCKET)
   end
-   
-  def test_cdburn_area
+
+  test "cdburn area is set" do
     assert_not_nil(Dir::CDBURN_AREA)
     assert_kind_of(String, Dir::CDBURN_AREA)
   end
-   
-  def test_common_admintools
+
+  test "common admintools is set" do
     assert_not_nil(Dir::COMMON_ADMINTOOLS)
     assert_kind_of(String, Dir::COMMON_ADMINTOOLS)
   end
-   
-  def test_common_altstartup
+
+  test "common_altstartup constant is set" do
     assert_not_nil(Dir::COMMON_ALTSTARTUP)
     assert_kind_of(String, Dir::COMMON_ALTSTARTUP)
   end
-   
-  def test_common_appdata
+
+  test "common_appdata constant is set" do
     assert_not_nil(Dir::COMMON_APPDATA)
     assert_kind_of(String, Dir::COMMON_APPDATA)
   end
-   
-  def test_common_desktopdirectory
+
+  test "common desktopdirectory constant is set" do
     assert_not_nil(Dir::COMMON_DESKTOPDIRECTORY)
     assert_kind_of(String, Dir::COMMON_DESKTOPDIRECTORY)
   end
-   
-  def test_common_documents
+
+  test "common_documents constant is set" do
     assert_not_nil(Dir::COMMON_DOCUMENTS)
     assert_kind_of(String, Dir::COMMON_DOCUMENTS)
   end
-   
-  def test_common_favorites
+
+  test "common_favorites constant is set" do
     assert_not_nil(Dir::COMMON_FAVORITES)
     assert_kind_of(String, Dir::COMMON_FAVORITES)
   end
-   
-  def test_common_music
+
+  test "common_music constant is set" do
     assert_not_nil(Dir::COMMON_MUSIC)
     assert_kind_of(String, Dir::COMMON_MUSIC)
   end
-   
-  def test_common_pictures
+
+  test "common_pictures constant is set" do
     assert_not_nil(Dir::COMMON_PICTURES)
     assert_kind_of(String, Dir::COMMON_PICTURES)
   end
-   
-  def test_common_programs
+
+  test "common_programs constant is set" do
     assert_not_nil(Dir::COMMON_PROGRAMS)
     assert_kind_of(String, Dir::COMMON_PROGRAMS)
   end
-  
-  def test_common_startmenu
+
+  test "common_startmenu constant is set" do
     assert_not_nil(Dir::COMMON_STARTMENU)
     assert_kind_of(String, Dir::COMMON_STARTMENU)
   end
-   
-  def test_common_startup
+
+  test "common_startup constant is set" do
     assert_not_nil(Dir::COMMON_STARTUP)
     assert_kind_of(String, Dir::COMMON_STARTUP)
   end
-  
-  def test_common_templates
+
+  test "common_templates constant is set" do
     assert_not_nil(Dir::COMMON_TEMPLATES)
     assert_kind_of(String, Dir::COMMON_TEMPLATES)
   end
-   
-  def test_common_video
+
+  test "common_video constant is set" do
     assert_not_nil(Dir::COMMON_VIDEO)
     assert_kind_of(String, Dir::COMMON_VIDEO)
   end
-   
-  def test_controls
+
+  test "controls constant is set" do
     assert_not_nil(Dir::CONTROLS)
     assert_kind_of(String, Dir::CONTROLS)
   end
-   
-  def test_cookies
+
+  test "cookies constant is set" do
     assert_not_nil(Dir::COOKIES)
     assert_kind_of(String, Dir::COOKIES)
   end
-   
-  def test_desktop
+
+  test "desktop constant is set" do
     assert_not_nil(Dir::DESKTOP)
     assert_kind_of(String, Dir::DESKTOP)
   end
-   
-  def test_desktopdirectory
+
+  test "desktopdirectory is set" do
     assert_not_nil(Dir::DESKTOPDIRECTORY)
     assert_kind_of(String, Dir::DESKTOPDIRECTORY)
   end
-   
-  def test_drives
+
+  test "drives constant is set" do
     assert_not_nil(Dir::DRIVES)
     assert_kind_of(String, Dir::DRIVES)
   end
 
-  def test_favorites
+  test "favorites constant is set" do
     assert_not_nil(Dir::FAVORITES)
     assert_kind_of(String, Dir::FAVORITES)
   end
-   
-  def test_fonts
+
+  test "fonts constant is set" do
     assert_not_nil(Dir::FONTS)
     assert_kind_of(String, Dir::FONTS)
   end
-   
-  def test_history
+
+  test "history constant is set" do
     assert_not_nil(Dir::HISTORY)
     assert_kind_of(String, Dir::HISTORY)
   end
-   
-  def test_internet
+
+  test "internet constant is set" do
     assert_not_nil(Dir::INTERNET)
     assert_kind_of(String, Dir::INTERNET)
   end
-   
-  def test_internet_cache
+
+  test "internet_cache constant is set" do
     assert_not_nil(Dir::INTERNET_CACHE)
     assert_kind_of(String, Dir::INTERNET_CACHE)
   end
-   
-  def test_local_appdata
+
+  test "local_appdata constant is set" do
     assert_not_nil(Dir::LOCAL_APPDATA)
     assert_kind_of(String, Dir::LOCAL_APPDATA)
   end
-   
-  def test_mydocuments
+
+  test "mydocuments constant is set" do
     assert_not_nil(Dir::MYDOCUMENTS)
     assert_kind_of(String, Dir::MYDOCUMENTS)
   end
-   
-  def test_local_mymusic
+
+  test "mymusic constant is set" do
     assert_not_nil(Dir::MYMUSIC)
     assert_kind_of(String, Dir::MYMUSIC)
   end
-   
-  def test_local_mypictures
+
+  test "mypictures constant is set" do
     assert_not_nil(Dir::MYPICTURES)
     assert_kind_of(String, Dir::MYPICTURES)
   end
-   
-  def test_local_myvideo
+
+  test "myvideo constant is set" do
     assert_not_nil(Dir::MYVIDEO)
     assert_kind_of(String, Dir::MYVIDEO)
   end
-   
-  def test_nethood
+
+  test "nethood constant is set" do
     assert_not_nil(Dir::NETHOOD)
     assert_kind_of(String, Dir::NETHOOD)
   end
-   
-  def test_network
+
+  test "network constant is set" do
     assert_not_nil(Dir::NETWORK)
     assert_kind_of(String, Dir::NETWORK)
   end
 
-  def test_personal
+  test "personal constant is set" do
     assert_not_nil(Dir::PERSONAL)
     assert_kind_of(String, Dir::PERSONAL)
   end
-   
-  def test_printers
+
+  test "printers cosntant is set" do
     assert_not_nil(Dir::PRINTERS)
     assert_kind_of(String, Dir::PRINTERS)
   end
-   
-  def test_printhood
+
+  test "printhood constant is set" do
     assert_not_nil(Dir::PRINTHOOD)
     assert_kind_of(String, Dir::PRINTHOOD)
   end
-   
-  def test_profile
+
+  test "profile constant is set" do
     assert_not_nil(Dir::PROFILE)
     assert_kind_of(String, Dir::PROFILE)
   end
-   
-  # Doesn't appear to actually exist
-  #def test_profiles
-  #  assert_not_nil(Dir::PROFILES)
-  #  assert_kind_of(String,Dir::PROFILES)
-  #end
-   
-  def test_program_files
+
+  test "program_files constant is set" do
     assert_not_nil(Dir::PROGRAM_FILES)
     assert_kind_of(String, Dir::PROGRAM_FILES)
   end
-   
-  def test_program_files_common
+
+  test "program_files_common constant is set" do
     assert_not_nil(Dir::PROGRAM_FILES_COMMON)
     assert_kind_of(String, Dir::PROGRAM_FILES_COMMON)
   end
-   
-  def test_programs
+
+  test "programs constant is set" do
     assert_not_nil(Dir::PROGRAMS)
     assert_kind_of(String, Dir::PROGRAMS)
   end
-   
-  def test_recent
+
+  test "recent constant is set" do
     assert_not_nil(Dir::RECENT)
     assert_kind_of(String, Dir::RECENT)
   end
-  
-  def test_sendto
+
+  test "sendto constant is set" do
     assert_not_nil(Dir::SENDTO)
     assert_kind_of(String, Dir::SENDTO)
   end
-   
-  def test_startmenu
+
+  test "startmenu constant is set" do
     assert_not_nil(Dir::STARTMENU)
     assert_kind_of(String, Dir::STARTMENU)
   end
-   
-  def test_startup
+
+  test "startup constant is set" do
     assert_not_nil(Dir::STARTUP)
     assert_kind_of(String, Dir::STARTUP)
   end
-   
-  def test_system
+
+  test "system constant is set" do
     assert_not_nil(Dir::SYSTEM)
     assert_kind_of(String, Dir::SYSTEM)
   end
-   
-  def test_templates
+
+  test "templates constant is set" do
     assert_not_nil(Dir::TEMPLATES)
     assert_kind_of(String, Dir::TEMPLATES)
   end
 
-  def test_windows_dir
+  test "windows constant is set" do
     assert_not_nil(Dir::WINDOWS)
     assert_kind_of(String, Dir::WINDOWS)
   end
 
+  test "ffi functions are private" do
+    assert_not_respond_to(Dir, :SHGetFolderPathW)
+  end
+
   def teardown
     FileUtils.rm_rf(@ascii_to)
     FileUtils.rm_rf(@unicode_to)
+  end
+
+  def self.shutdown
     FileUtils.rm_rf(@@from)
+    @@test_home = nil
+    @@from = nil
   end
 end