win32-dir 0.4.2 → 0.4.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ba7a9adc26183f9771184c4faad59d88fbc5bd22
+  data.tar.gz: 62e1d08549b6806816874e5299600394f9ebf5e3
+SHA512:
+  metadata.gz: 7e388fc8eff13cf9cf188e82bdab4a7d4ee6164910daaa61889baebd69bc0269d0973a1d6d8bff4b993d33975071ffc73d358dbfd54e125a366e9bd5bf1ba7bd
+  data.tar.gz: b2fcfbe2d31741398df8cb55220f8256af771247dbb4bcaf7564e3c0bdbeceba50f4578e71cb46a0aced31380456ba3281bb9c4dfb7a66f814c797d9630cc371

data/CHANGES

@@ -1,3 +1,11 @@
+== 0.4.3 - 24-Jul-2013
+* Changed the Dir.read_junction and CSIDL constant strings so that they
+  use the default external encoding instead of UTF-16LE. This means that
+  they will now work with methods like File.join. Thanks go to Josh Cooper
+  for the patches.
+* Some changes for internal handling of making FFI functions private.
+* Updated gem:create task for rubygems 2.
+
 == 0.4.2 - 8-Apr-2013
 * Fixed the HANDLE function prototypes in the underlying FFI code and added
   some custom typedefs for convenience. This affects 64 bit Ruby code.

data/Rakefile

@@ -6,10 +6,16 @@ CLEAN.include('**/*.gem', '**/*.log')
 
 namespace 'gem' do
   desc "Create the win32-dir gem"
-  task :build => [:clean] do
+  task :create => [:clean] do
     Dir["*.gem"].each{ |f| File.delete(f) }
     spec = eval(IO.read('win32-dir.gemspec'))
-    Gem::Builder.new(spec).build
+
+    if Gem::VERSION.to_f < 2.0
+      Gem::Builder.new(spec).build
+    else
+      require 'rubygems/package'
+      Gem::Package.build(spec)
+    end
   end
   
   desc "Install the win32-dir gem"

data/lib/win32/dir/functions.rb

@@ -7,6 +7,14 @@ end
 require 'ffi'
 
 module Dir::Functions
+  module FFI::Library
+    # Wrapper method for attach_function + private
+    def attach_pfunc(*args)
+      attach_function(*args)
+      private args[0]
+    end
+  end
+
   extend FFI::Library
 
   typedef :ulong, :dword
@@ -16,27 +24,27 @@ module Dir::Functions
 
   ffi_lib :shell32
 
-  attach_function :SHGetFolderPathW, [:hwnd, :int, :handle, :dword, :buffer_out], :dword
-  attach_function :SHGetFolderLocation, [:hwnd, :int, :handle, :dword, :ptr], :dword
-  attach_function :SHGetFileInfo, [:dword, :dword, :ptr, :uint, :uint], :dword
+  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
 
-  attach_function :PathIsDirectoryEmptyW, [:buffer_in], :bool
+  attach_pfunc :PathIsDirectoryEmptyW, [:buffer_in], :bool
 
   ffi_lib :kernel32
 
-  attach_function :CloseHandle, [:handle], :bool
-  attach_function :CreateDirectoryW, [:buffer_in, :ptr], :bool
-  attach_function :CreateFileW, [:buffer_in, :dword, :dword, :ptr, :dword, :dword, :handle], :handle
-  attach_function :DeviceIoControl, [:handle, :dword, :ptr, :dword, :ptr, :dword, :ptr, :ptr], :bool
-  attach_function :GetCurrentDirectoryW, [:dword, :buffer_out], :dword
-  attach_function :GetFileAttributesW, [:buffer_in], :dword
-  attach_function :GetLastError, [], :dword
-  attach_function :GetShortPathNameW, [:buffer_in, :buffer_out, :dword], :dword
-  attach_function :GetLongPathNameW, [:buffer_in, :buffer_out, :dword], :dword
-  attach_function :GetFullPathNameW, [:buffer_in, :dword, :buffer_out, :ptr], :dword
-  attach_function :RemoveDirectoryW, [:buffer_in], :bool
+  attach_pfunc :CloseHandle, [:handle], :bool
+  attach_pfunc :CreateDirectoryW, [:buffer_in, :ptr], :bool
+  attach_pfunc :CreateFileW, [:buffer_in, :dword, :dword, :ptr, :dword, :dword, :handle], :handle
+  attach_pfunc :DeviceIoControl, [:handle, :dword, :ptr, :dword, :ptr, :dword, :ptr, :ptr], :bool
+  attach_pfunc :GetCurrentDirectoryW, [:dword, :buffer_out], :dword
+  attach_pfunc :GetFileAttributesW, [:buffer_in], :dword
+  attach_pfunc :GetLastError, [], :dword
+  attach_pfunc :GetShortPathNameW, [:buffer_in, :buffer_out, :dword], :dword
+  attach_pfunc :GetLongPathNameW, [:buffer_in, :buffer_out, :dword], :dword
+  attach_pfunc :GetFullPathNameW, [:buffer_in, :dword, :buffer_out, :ptr], :dword
+  attach_pfunc :RemoveDirectoryW, [:buffer_in], :bool
 end
 
 class String

data/lib/win32/dir.rb

@@ -7,26 +7,8 @@ class Dir
   include Dir::Constants
   extend Dir::Functions
 
-  private_class_method(
-    :SHGetFolderPathW,
-    :SHGetFolderLocation,
-    :SHGetFileInfo,
-    :PathIsDirectoryEmptyW,
-    :CloseHandle,
-    :CreateDirectoryW,
-    :CreateFileW,
-    :DeviceIoControl,
-    :GetCurrentDirectoryW,
-    :GetFileAttributesW,
-    :GetLastError,
-    :GetShortPathNameW,
-    :GetLongPathNameW,
-    :GetFullPathNameW,
-    :RemoveDirectoryW
-  )
-
   # The version of the win32-dir library.
-  VERSION = '0.4.2'
+  VERSION = '0.4.3'
 
   # CSIDL constants
   csidl = Hash[
@@ -110,7 +92,7 @@ class Dir
       end
     end
 
-    Dir.const_set(key, path) if path
+    Dir.const_set(key, path.encode(Encoding.default_external)) if path
   }
 
   # Set Dir::MYDOCUMENTS to the same as Dir::PERSONAL if undefined
@@ -287,10 +269,6 @@ class Dir
   # Raises +ENOENT+ if given path does not exist, returns +false+
   # if it is not a junction.
   #
-  # Note that regardless of the encoding of the string passed in,
-  # +read_junction()+ will always return a result as UTF-16LE, as it's
-  # actually written in the reparse point.
-  #
   # Example:
   #
   #    Dir.mkdir('C:/from')
@@ -368,7 +346,7 @@ class Dir
     jname = jname.bytes.to_a.pack('C*')
     jname = jname.force_encoding("UTF-16LE")
     raise "Junction name came back as #{jname}" unless jname[0..3] == "\\??\\".encode("UTF-16LE")
-    return jname[4..-1].gsub("\\".encode("UTF-16LE"), "/".encode("UTF-16LE"))
+    File.expand_path(jname[4..-1].encode(Encoding.default_external))
   end
 
   # Returns whether or not +path+ is empty.  Returns false if +path+ is not

data/test/test_win32_dir.rb

@@ -25,7 +25,7 @@ class TC_Win32_Dir < Test::Unit::TestCase
   end
 
   test "version number is set to expected value" do
-    assert_equal('0.4.2', Dir::VERSION)
+    assert_equal('0.4.3', Dir::VERSION)
   end
 
   test 'glob handles backslashes' do
@@ -72,13 +72,19 @@ class TC_Win32_Dir < Test::Unit::TestCase
   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))
-    assert_equal(Dir.read_junction(@ascii_to), @@from.bytes.to_a.pack('C*').encode("UTF-16LE"))
+    assert_equal(Dir.read_junction(@ascii_to), @@from)
   end
 
   test "read_junction works as expected with unicode characters" do
     assert_nothing_raised{ Dir.create_junction(@unicode_to, @@from) }
     assert_true(File.exists?(@unicode_to))
-    assert_equal(Dir.read_junction(@unicode_to), @@from.bytes.to_a.pack('C*').encode("UTF-16LE"))
+    assert_equal(Dir.read_junction(@unicode_to), @@from)
+  end
+
+  test "read_junction with unicode characters is joinable" do
+    assert_nothing_raised{ Dir.create_junction(@unicode_to, @@from) }
+    assert_true(File.exists?(@unicode_to))
+    assert_nothing_raised{ File.join(Dir.read_junction(@unicode_to), 'foo') }
   end
 
   test "junction? method returns boolean value" do
@@ -380,6 +386,11 @@ class TC_Win32_Dir < Test::Unit::TestCase
     assert_kind_of(String, Dir::WINDOWS)
   end
 
+  test "constants are ascii_compatible?" do
+    assert_true(Dir::COMMON_APPDATA.encoding.ascii_compatible?)
+    assert_nothing_raised{ File.join(Dir::COMMON_APPDATA, 'foo') }
+  end
+
   test "ffi functions are private" do
     assert_not_respond_to(Dir, :SHGetFolderPathW)
   end

data/win32-dir.gemspec

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

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: win32-dir
 version: !ruby/object:Gem::Version
-  version: 0.4.2
-  prerelease: 
+  version: 0.4.3
 platform: ruby
 authors:
 - Daniel J. Berger
@@ -10,45 +9,42 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-08 00:00:00.000000000 Z
+date: 2013-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: test-unit
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 2.4.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 2.4.0
-description: ! "    The win32-dir library provides extra methods and constants for
-  the\n    builtin Dir class. The constants provide a convenient way to identify\n
-  \   certain directories across all versions of Windows. Some methods have\n    been
-  added, such as the ability to create junctions. Others have been\n    modified to
-  provide a more consistent result for MS Windows.\n"
+description: |2
+      The win32-dir library provides extra methods and constants for the
+      builtin Dir class. The constants provide a convenient way to identify
+      certain directories across all versions of Windows. Some methods have
+      been added, such as the ability to create junctions. Others have been
+      modified to provide a more consistent result for MS Windows.
 email: djberg96@gmail.com
 executables: []
 extensions: []
@@ -71,27 +67,26 @@ files:
 homepage: http://github.com/djberg96/win32-dir
 licenses:
 - Artistic 2.0
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: 1.9.2
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: win32utils
-rubygems_version: 1.8.24
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Extra constants and methods for the Dir class on Windows.
 test_files:
 - test/test_win32_dir.rb