win32-dir 0.4.6 → 0.4.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 25ed1b84d472bc93aebe5c716279d7257ee195f8
-  data.tar.gz: 034fa5750ff550ee2d16b576141764ada29afe99
+  metadata.gz: e5e981af6ec776b828331968e333f10e07a00da1
+  data.tar.gz: 6d4998906fc38e42b166b4f169bcd3e209e8fe50
 SHA512:
-  metadata.gz: d497ce2b9d5e8ad5ffc218b1b135b833145a473dd2a639c4c043ca7d6424914a6cb05ec0cc1977dac7e54451e51de03908b59668b12a6b0449794cc4b8bbc9e0
-  data.tar.gz: b41580cef0a66660329635b7ea5ebbe613ec5f856ca0883d00de049240c52086af88dade08d45254939f42e8cb5c824a47b3ec651e14186992bb767a41583f69
+  metadata.gz: 3f6d943d7546b4b5a6df5507bf06e2dca571fe4f708eac4cf6f483f24cb20e304f3ab5cbbfb075d98cce0112e6e676069f0551d555f7e37ac78f536f2a5b45a9
+  data.tar.gz: cb65e88ec9fa7d671c4a2744ed4f7e0cb80405d88f63a22a15411b33b04bbfef00adf37fa24a3120f1f274569e92fd06bcadb465ddefc63f591a541c5b9f44db

data/CHANGES

@@ -1,3 +1,14 @@
+== 0.4.7 - 26-Apr-2014
+* All arguments to methods are now interpolated so that they'll use whatever 
+  to_str implemenation the argument provides instead of assuming String
+  arguments. This change was made because it turns out that at least some
+  of the overridden methods in MRI accept Pathname objects. Thanks go to
+  Josh Cooper/Puppet Labs for the spot.
+* Refactored the Dir.getwd method to use bonafide FFI buffers instead of
+  naked Ruby char buffers.
+* Internally various functions now fail in the event that the resulting
+  paths would exceed their buffers.
+
 == 0.4.6 - 21-Oct-2013
 * Fixed the INVALID_HANDLE_VALUE and INVALID_FILE_ATTRIBUTES constants for
   64-bit versions of Ruby.

data/README

@@ -233,6 +233,8 @@ Dir::TEMPLATES
   only instead of an actual path.
 	
 == Known Bugs
+  The Dir.create_junction and Dir.read_junction methods do not work with JRuby.
+
   Please log any bug reports on the project page at
   http://www.github.com/djberg96/win32-dir
 
@@ -259,7 +261,7 @@ Dir::TEMPLATES
   http://www.gittip.com/djberg96/
     
 == Copyright
-  (C) 2003-2013 Daniel J. Berger, All Rights Reserved
+  (C) 2003-2014 Daniel J. Berger, All Rights Reserved
     
 == Warranty
   This package is provided "as is" and without any express or

data/Rakefile

@@ -19,7 +19,7 @@ namespace 'gem' do
   end
   
   desc "Install the win32-dir gem"
-  task :install => [:build] do
+  task :install => [:create] do
     file = Dir["*.gem"].first
     sh "gem install #{file}"
   end

data/lib/win32/dir.rb

@@ -8,7 +8,7 @@ class Dir
   extend Dir::Functions
 
   # The version of the win32-dir library.
-  VERSION = '0.4.6'
+  VERSION = '0.4.7'
 
   # CSIDL constants
   csidl = Hash[
@@ -113,9 +113,9 @@ class Dir
     #
     def glob(glob_pattern, flags = 0, &block)
       if glob_pattern.is_a?(Array)
-        temp = glob_pattern.map!{ |pattern| pattern.tr("\\", "/") }
+        temp = glob_pattern.map!{ |pattern| "#{pattern}".tr("\\", "/") }
       else
-        temp = glob_pattern.tr("\\", "/")
+        temp = "#{glob_pattern}".tr("\\", "/")
       end
 
       old_glob(temp, flags, &block)
@@ -127,7 +127,7 @@ class Dir
     # backslashes in path names.
     #
     def [](*glob_patterns)
-      temp = glob_patterns.map!{ |pattern| pattern.tr("\\", "/") }
+      temp = glob_patterns.map!{ |pattern| "#{pattern}".tr("\\", "/") }
       old_ref(*temp)
     end
 
@@ -148,31 +148,34 @@ class Dir
       #    Dir.getwd # => C:\Program Files
       #
       def getwd
-        path1 = 0.chr * 1024
-        path2 = 0.chr * 1024
-        path3 = 0.chr * 1024
+        path1 = FFI::Buffer.new(:wint_t, 1024, true)
+        path2 = FFI::Buffer.new(:wint_t, 1024, true)
+        path3 = FFI::Buffer.new(:wint_t, 1024, true)
 
-        path1.encode!('UTF-16LE')
+        length = GetCurrentDirectoryW(path1.size, path1)
 
-        if GetCurrentDirectoryW(path1.size, path1) == 0
+        if length == 0 || length > path1.size
           raise SystemCallError.new("GetCurrentDirectoryW", FFI.errno)
         end
 
-        path2.encode!('UTF-16LE')
+        length = GetShortPathNameW(path1, path2, path2.size)
 
-        if GetShortPathNameW(path1, path2, path2.size) == 0
+        if length == 0 || length > path2.size
           raise SystemCallError.new("GetShortPathNameW", FFI.errno)
         end
 
-        path3.encode!('UTF-16LE')
+        length = GetLongPathNameW(path2, path3, path3.size)
 
-        if GetLongPathNameW(path2, path3, path3.size) == 0
+        if length == 0 || length > path3.size
           raise SystemCallError.new("GetLongPathNameW", FFI.errno)
         end
+
+        path = path3.read_bytes(length * 2).wstrip
+
         begin
-          path3.strip.encode(Encoding.default_external)
+          path.encode(Encoding.default_external)
         rescue Encoding::UndefinedConversionError
-          path3.strip.encode('UTF-8')
+          path.encode('UTF-8')
         end
       end
 
@@ -189,26 +192,24 @@ class Dir
   #    Dir.create_junction('C:/to', 'C:/from')
   #
   def self.create_junction(to, from)
-    to   = to.wincode
-    from = from.wincode
+    to   = "#{to}".wincode
+    from = "#{from}".wincode
 
-    from_path = 0.chr * 1024
-    from_path.encode!('UTF-16LE')
+    from_path = (0.chr * 1024).encode('UTF-16LE')
 
     length = GetFullPathNameW(from, from_path.size, from_path, nil)
 
-    if length == 0
+    if length == 0 || length > from_path.size
       raise SystemCallError.new("GetFullPathNameW", FFI.errno)
     else
       from_path.strip!
     end
 
-    to_path = 0.chr * 1024
-    to_path.encode!('UTF-16LE')
+    to_path = (0.chr * 1024).encode('UTF-16LE')
 
     length = GetFullPathNameW(to, to_path.size, to_path, nil)
 
-    if length == 0
+    if length == 0 || length > to_path.size
       raise SystemCallError.new("GetFullPathNameW", FFI.errno)
     else
       to_path.strip!
@@ -257,7 +258,7 @@ class Dir
           handle,
           CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 41, METHOD_BUFFERED, 0),
           rdb,
-          rdb[:ReparseDataLength] + 8,
+          rdb[:ReparseDataLength] + rdb.header_size,
           nil,
           0,
           bytes,
@@ -278,27 +279,26 @@ class Dir
     self
   end
 
-  # Returns the+ +path+ that a given +symlink+ points to.
-  # Raises +ENOENT+ if given path does not exist, returns +false+
+  # Returns the path that a given junction points to. Raises an
+  # Errno::ENOENT error if the given path does not exist. Returns false
   # if it is not a junction.
   #
   # Example:
   #
   #    Dir.mkdir('C:/from')
   #    Dir.create_junction('C:/to', 'C:/from')
-  #    Dir.read_junction("c:/to")          => "c:/from"
+  #    Dir.read_junction("c:/to") # => "c:/from"
   #
   def self.read_junction(junction)
-    return false unless Dir.junction?(junction)
+    return false unless Dir.junction?("#{junction}")
 
-    junction = junction.wincode
+    junction = "#{junction}".wincode
 
-    junction_path = 0.chr * 1024
-    junction_path.encode!('UTF-16LE')
+    junction_path = (0.chr * 1024).encode('UTF-16LE')
 
     length = GetFullPathNameW(junction, junction_path.size, junction_path, nil)
 
-    if length == 0
+    if length == 0 || length > junction_path.size
       raise SystemCallError.new("GetFullPathNameW", FFI.errno)
     else
       junction_path.strip!
@@ -370,7 +370,7 @@ class Dir
   # a directory, or contains any files other than '.' or '..'.
   #
   def self.empty?(path)
-    PathIsDirectoryEmptyW(path.wincode)
+    PathIsDirectoryEmptyW("#{path}".wincode)
   end
 
   # Returns whether or not +path+ is a junction.
@@ -378,7 +378,7 @@ class Dir
   def self.junction?(path)
     bool = true
 
-    attrib = GetFileAttributesW(path.wincode)
+    attrib = GetFileAttributesW("#{path}".wincode)
 
     # Only directories with a reparse point attribute can be junctions
     if attrib == INVALID_FILE_ATTRIBUTES ||

data/lib/win32/dir/functions.rb

@@ -23,16 +23,19 @@ module Dir::Functions
   typedef :pointer, :ptr
 
   ffi_lib :shell32
+  ffi_convention :stdcall
 
   attach_pfunc :SHGetFolderPathW, [:hwnd, :int, :handle, :dword, :buffer_out], :dword
   attach_pfunc :SHGetFolderLocation, [:hwnd, :int, :handle, :dword, :ptr], :dword
   attach_pfunc :SHGetFileInfo, [:dword, :dword, :ptr, :uint, :uint], :dword
 
   ffi_lib :shlwapi
+  ffi_convention :stdcall
 
   attach_pfunc :PathIsDirectoryEmptyW, [:buffer_in], :bool
 
   ffi_lib :kernel32
+  ffi_convention :stdcall
 
   attach_pfunc :CloseHandle, [:handle], :bool
   attach_pfunc :CreateDirectoryW, [:buffer_in, :ptr], :bool
@@ -53,4 +56,11 @@ class String
   def wincode
     (self.tr(File::SEPARATOR, File::ALT_SEPARATOR) + 0.chr).encode('UTF-16LE')
   end
+
+  # 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/dir/structs.rb

@@ -25,5 +25,13 @@ module Dir::Structs
       :PrintNameLength, :ushort,
       :PathBuffer, [:char, 1024]
     )
+
+    # The REPARSE_DATA_BUFFER_HEADER_SIZE which is calculated as:
+    #
+    # sizeof(ReparseTag) + sizeof(ReparseDataLength) + sizeof(Reserved)
+    #
+    def header_size
+      FFI::Type::ULONG.size + FFI::Type::USHORT.size + FFI::Type::USHORT.size
+    end
   end
 end

data/test/test_win32_dir.rb

@@ -9,6 +9,7 @@ require 'test-unit'
 require 'win32/dir'
 require 'tmpdir'
 require 'fileutils'
+require 'pathname'
 
 class TC_Win32_Dir < Test::Unit::TestCase
   def self.startup
@@ -25,7 +26,7 @@ class TC_Win32_Dir < Test::Unit::TestCase
   end
 
   test "version number is set to expected value" do
-    assert_equal('0.4.6', Dir::VERSION)
+    assert_equal('0.4.7', Dir::VERSION)
   end
 
   test 'glob handles backslashes' do
@@ -52,6 +53,13 @@ class TC_Win32_Dir < Test::Unit::TestCase
     assert_true(array.include?('.'))
   end
 
+  test 'glob handles Pathname objects' do
+    pattern1 = Pathname.new("C:\\Program Files\\Common Files\\System\\*.dll")
+    pattern2 = Pathname.new("C:\\Windows\\*.exe")
+    assert_nothing_raised{ Dir.glob([pattern1, pattern2]) }
+    assert_true(Dir.glob([pattern1, pattern2]).size > 0)
+  end
+
   test 'ref handles backslashes' do
     pattern = "C:\\Program Files\\Common Files\\System\\*.dll"
     assert_nothing_raised{ Dir[pattern] }
@@ -65,6 +73,13 @@ class TC_Win32_Dir < Test::Unit::TestCase
     assert_true(Dir[pattern1, pattern2].size > 0)
   end
 
+  test 'ref handles pathname arguments' do
+    pattern1 = Pathname.new("C:\\Program Files\\Common Files\\System\\*.dll")
+    pattern2 = Pathname.new("C:\\Windows\\*.exe")
+    assert_nothing_raised{ Dir[pattern1, pattern2] }
+    assert_true(Dir[pattern1, pattern2].size > 0)
+  end
+
   test "create_junction basic functionality" do
     assert_respond_to(Dir, :create_junction)
   end
@@ -83,6 +98,13 @@ class TC_Win32_Dir < Test::Unit::TestCase
     assert_equal(Dir.entries(@@from), Dir.entries(@unicode_to))
   end
 
+  test "create_junction works as expected with pathname objects" do
+    assert_nothing_raised{ Dir.create_junction(Pathname.new(@ascii_to), Pathname.new(@@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
+
   test "read_junction works as expected with ascii characters" do
     assert_nothing_raised{ Dir.create_junction(@ascii_to, @@from) }
     assert_true(File.exists?(@ascii_to))
@@ -101,11 +123,18 @@ class TC_Win32_Dir < Test::Unit::TestCase
     assert_nothing_raised{ File.join(Dir.read_junction(@unicode_to), 'foo') }
   end
 
+  test "read_junction works as expected with pathname objects" do
+    assert_nothing_raised{ Dir.create_junction(Pathname.new(@ascii_to), Pathname.new(@@from)) }
+    assert_true(File.exists?(@ascii_to))
+    assert_equal(Dir.read_junction(@ascii_to), @@from)
+  end
+
   test "junction? method returns boolean value" do
     assert_respond_to(Dir, :junction?)
     assert_nothing_raised{ Dir.create_junction(@ascii_to, @@from) }
     assert_false(Dir.junction?(@@from))
     assert_true(Dir.junction?(@ascii_to))
+    assert_true(Dir.junction?(Pathname.new(@ascii_to)))
   end
 
   test "reparse_dir? is an aliase for junction?" do
@@ -117,6 +146,7 @@ class TC_Win32_Dir < Test::Unit::TestCase
     assert_respond_to(Dir, :empty?)
     assert_false(Dir.empty?("C:\\")) # One would think
     assert_true(Dir.empty?(@@from))
+    assert_true(Dir.empty?(Pathname.new(@@from)))
   end
 
   test "pwd basic functionality" do

data/win32-dir.gemspec

@@ -2,7 +2,7 @@ require 'rubygems'
 
 Gem::Specification.new do |spec|
   spec.name      = 'win32-dir'
-  spec.version   = '0.4.6'
+  spec.version   = '0.4.7'
   spec.authors   = ['Daniel J. Berger', 'Park Heesob']
   spec.license   = 'Artistic 2.0'
   spec.email     = 'djberg96@gmail.com'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: win32-dir
 version: !ruby/object:Gem::Version
-  version: 0.4.6
+  version: 0.4.7
 platform: ruby
 authors:
 - Daniel J. Berger
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-21 00:00:00.000000000 Z
+date: 2014-04-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -68,14 +68,14 @@ extra_rdoc_files:
 - MANIFEST
 files:
 - CHANGES
+- MANIFEST
+- README
+- Rakefile
 - examples/dir_example.rb
+- lib/win32/dir.rb
 - lib/win32/dir/constants.rb
 - lib/win32/dir/functions.rb
 - lib/win32/dir/structs.rb
-- lib/win32/dir.rb
-- MANIFEST
-- Rakefile
-- README
 - test/test_win32_dir.rb
 - win32-dir.gemspec
 homepage: http://github.com/djberg96/win32-dir
@@ -98,7 +98,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: win32utils
-rubygems_version: 2.1.9
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Extra constants and methods for the Dir class on Windows.