win32-file 0.7.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fe733f3c66c36ad77e79b95f169dbfbea6d495d0
-  data.tar.gz: fc11dce1680290901e70b7423e63a361cf5e0118
+  metadata.gz: 047468a1a793c4485f3e336084cbdab03ec973ee
+  data.tar.gz: f2cab49afe63c66b94995e83c0dcf7374ba52efa
 SHA512:
-  metadata.gz: 062129c39980b67de8373c48dcdbd612d6001fd7afd49e74c19bdf06f3779a8ea1d5658da4c3fb5b931a04dcfa00447b2de64711d76fee31aea250fbb1f41919
-  data.tar.gz: 0035f29a6657abf5535498e77a38acdf106133f922134ec164c14dad5b3b5f9d2e7550cff363ac5a2e470e93b501822e589d6d2c1718715ef902c8ea2fe52fff
+  metadata.gz: eae986e7739d2fc6307f2ded1c1349ae1e0590248f01c98456f368215f93ba4499c358bc80986f3f80e2e83f0e62693f81565e795af1b9f71880ae965c751218
+  data.tar.gz: 04634af88ef4466e08e8506e3c661d3afabb7fe31cf42c34f22b7ef121b9d3b07c565ba1964e079448300f5c6fecc0231de5649a5500b362c75709b8bfd76e42

data/CHANGES

@@ -1,3 +1,9 @@
+== 0.7.1 - 28-Apr-2014
+* Modified all custom singleton methods to accept arguments that define either
+  to_str or to_path to be in line with MRI's behavior.
+* Some internal changes for the long_path and short_path methods.
+* Added some path tests.
+
 == 0.7.0 - 16-Dec-2013
 * Now requires Ruby 1.9 or later.
 * Converted to use FFI instead of win32-api. Now works with JRuby, too.

data/README

@@ -22,7 +22,7 @@
   * File.short_path
 
 == Singleton Methods Redefined
-  * File.basename         # UNC path issues in MRI
+  * File.basename         # UNC path issues, root path differences.
   * File.blksize          # Not implemented in MRI
   * File.blockdev?        # Not implemented in MRI
   * File.chardev?         # Not implemented in MRI
@@ -55,15 +55,11 @@
 
   https://github.com/djberg96/win32-file/issues
 
-  Or the Win32Utils project page at:
-
-  http://www.rubyforge.org/projects/win32utils.
-
 == License
   Artistic 2.0
 
 == 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/lib/win32/file.rb

@@ -1,6 +1,6 @@
-require File.join(File.dirname(__FILE__), 'file', 'constants')
-require File.join(File.dirname(__FILE__), 'file', 'structs')
-require File.join(File.dirname(__FILE__), 'file', 'functions')
+require_relative 'file/constants'
+require_relative 'file/structs'
+require_relative 'file/functions'
 require 'win32/file/stat'
 
 class File
@@ -9,7 +9,7 @@ class File
   extend Windows::File::Functions
 
   # The version of the win32-file library
-  WIN32_FILE_VERSION = '0.7.0'
+  WIN32_FILE_VERSION = '0.7.1'
 
   class << self
     alias_method :join_orig, :join
@@ -36,7 +36,8 @@ class File
   #
   # This was reimplemented because the current version does not handle UNC
   # paths properly, i.e. it should not return anything less than the root.
-  # In most other respects it is identical to the current implementation.
+  # In most other respects it is identical to the current implementation,
+  # except that it does not strip the drive letter on a root path.
   #
   # Unlike MRI, this version will convert all forward slashes to
   # backslashes automatically.
@@ -48,8 +49,8 @@ class File
   #    File.basename("\\\\foo\\bar")             -> "\\\\foo\\bar"
   #
   def self.basename(file, suffix = nil)
-    raise TypeError unless file.is_a?(String)
-    raise TypeError unless suffix.is_a?(String) if suffix
+    file = string_check(file)
+    suffix = string_check(suffix) if suffix
 
     return file if file.empty? # Return an empty path as-is.
 
@@ -99,7 +100,7 @@ class File
   #    File.dirname("\\\\foo\\bar")          -> "\\\\foo\\bar"
   #
   def self.dirname(file)
-    raise TypeError unless file.is_a?(String)
+    file = string_check(file)
 
     # Short circuit for empty paths
     return '.' if file.empty?
@@ -160,6 +161,7 @@ class File
   # the current version does not handle UNC paths properly.
   #
   def self.split(file)
+    file = string_check(file)
     array = []
 
     if file.empty? || PathIsRootW(file.wincode)
@@ -180,28 +182,32 @@ class File
   # name in 8.3 format.
   #
   def self.long_path(file)
-    buffer = 0.chr * 1024
-    wfile  = file.wincode
+    buffer = FFI::Buffer.new(:wint_t, 1024, true)
+    wfile  = string_check(file).wincode
 
-    if GetLongPathNameW(wfile, buffer, buffer.size/2) == 0
+    length = GetLongPathNameW(wfile, buffer, buffer.size)
+
+    if length == 0 || length > buffer.size / 2
       raise SystemCallError.new('GetLongPathName', FFI.errno)
     end
 
-    buffer.wstrip
+    buffer.read_bytes(length * 2).wstrip
   end
 
   # Returns +path+ in 8.3 format. For example, 'c:\documentation.doc'
   # would be returned as 'c:\docume~1.doc'.
   #
   def self.short_path(file)
-    buffer = 0.chr * 1024
-    wfile  = file.wincode
+    buffer = FFI::Buffer.new(:wint_t, 1024, true)
+    wfile  = string_check(file).wincode
+
+    length = GetShortPathNameW(wfile, buffer, buffer.size)
 
-    if GetShortPathNameW(wfile, buffer, buffer.size/2) == 0
+    if length == 0 || length > buffer.size / 2
       raise SystemCallError.new('GetShortPathName', FFI.errno)
     end
 
-    buffer.wstrip
+    buffer.read_bytes(length * 2).wstrip
   end
 
   # Creates a symbolic link called +new_name+ for the file or directory
@@ -211,8 +217,8 @@ class File
   # returns nil as per MRI.
   #
   def self.symlink(target, link)
-    raise TypeError unless target.is_a?(String)
-    raise TypeError unless link.is_a?(String)
+    target = string_check(target)
+    link = string_check(link)
 
     flags = File.directory?(target) ? 1 : 0
 
@@ -230,8 +236,9 @@ class File
   #
   def self.symlink?(file)
     return false unless File.exists?(file)
+
     bool  = false
-    wfile = file.wincode
+    wfile = string_check(file).wincode
 
     attrib = GetFileAttributesW(wfile)
 
@@ -269,6 +276,8 @@ class File
   # On Windows we only modify the realpath method if the file is a symlink.
   #
   def self.realdirpath(file, relative_to = nil)
+    file = string_check(file)
+
     if symlink?(file)
       if relative_to
         File.join(relative_to, File.basename(readlink(file)))
@@ -287,6 +296,9 @@ class File
   # On Windows we only modify the realpath method if the file is a symlink.
   #
   def self.realpath(file, relative_to = nil)
+    file = string_check(file)
+    relative_to = string_check(relative_to) if relative_to
+
     if symlink?(file)
       if relative_to
         result = File.join(relative_to, File.basename(readlink(file)))
@@ -306,6 +318,8 @@ class File
   # Returns the path of the of the symbolic link referred to by +file+.
   #
   def self.readlink(file)
+    file = string_check(file)
+
     if exists?(file) && !symlink?(file)
       raise SystemCallError.new(22) # EINVAL, match the spec
     end
@@ -480,10 +494,17 @@ class File
   def stat
     File::Stat.new(self.path)
   end
-end
 
-if $0 == __FILE__
-  p File.dirname("C:/Users/djberge/test.txt////")
-  p File.basename("C:/Users/djberge/test.txt")
-  p File.basename("C:/Users/djberge/test.txt", ".txt")
+  # Private singleton methods
+  class << self
+    private
+
+    # Simulate Ruby's string checking
+    def string_check(arg)
+      return arg if arg.is_a?(String)
+      return arg.send(:to_str) if arg.respond_to?(:to_str, true) # MRI allows private to_str
+      return arg.to_path if arg.respond_to?(:to_path)
+      raise TypeError
+    end
+  end
 end

data/test/test_win32_file_misc.rb

@@ -1,16 +1,16 @@
-########################################################################
-# Miscellaneous tests for win32-file that didn't fit anywhere else.
-########################################################################
-require 'win32/file'
-require 'test-unit'
-
-class TC_Win32_File_Misc < Test::Unit::TestCase
-  test "version constant is set to expected value" do
-    assert_equal('0.7.0', File::WIN32_FILE_VERSION)
-  end
-
-  test "ffi functions are private" do
-    assert_not_respond_to(File, :CloseHandle)
-    assert_not_respond_to(File, :CreateFileW)
-  end
-end
+########################################################################
+# Miscellaneous tests for win32-file that didn't fit anywhere else.
+########################################################################
+require 'win32/file'
+require 'test-unit'
+
+class TC_Win32_File_Misc < Test::Unit::TestCase
+  test "version constant is set to expected value" do
+    assert_equal('0.7.1', File::WIN32_FILE_VERSION)
+  end
+
+  test "ffi functions are private" do
+    assert_not_respond_to(File, :CloseHandle)
+    assert_not_respond_to(File, :CreateFileW)
+  end
+end

data/test/test_win32_file_path.rb

@@ -6,6 +6,7 @@
 #############################################################################
 require 'test-unit'
 require 'win32/file'
+require 'pathname'
 
 class TC_Win32_File_Path < Test::Unit::TestCase
   def self.startup
@@ -97,6 +98,11 @@ class TC_Win32_File_Path < Test::Unit::TestCase
     assert_equal("foo.txt", File.basename("foo.txt\\\\\\"))
   end
 
+  test "basename method handles arguments that honor to_str or to_path" do
+    assert_equal("foo.txt", File.basename(Pathname.new("C:/blah/blah/foo.txt")))
+    assert_equal("foo", File.basename(Pathname.new("C:/blah/blah/foo.txt"), Pathname.new(".*")))
+  end
+
   test "dirname basic functionality" do
     assert_respond_to(File, :dirname)
     assert_nothing_raised{ File.dirname("C:\\foo") }
@@ -158,11 +164,15 @@ class TC_Win32_File_Path < Test::Unit::TestCase
     assert_equal("\\\\foo\\bar", File.dirname("\\\\foo\\bar\\baz\\"))
   end
 
-  test "argument to dirname must be a string" do
+  test "argument to dirname must be a stringy object" do
     assert_raises(TypeError){ File.dirname(nil) }
     assert_raises(TypeError){ File.dirname(['foo', 'bar']) }
   end
 
+  test "dirname method handles arguments that honor to_str or to_path" do
+    assert_equal("C:\\blah\\blah", File.dirname(Pathname.new("C:/blah/blah/foo.txt")))
+  end
+
   test "split method basic functionality" do
     assert_respond_to(File, :split)
     assert_nothing_raised{ File.split("C:\\foo\\bar") }
@@ -203,6 +213,15 @@ class TC_Win32_File_Path < Test::Unit::TestCase
     assert_equal("C:\\foo\\bar", path)
   end
 
+  test "split method accepts stringy arguments" do
+    assert_equal(["C:\\foo", "bar"], File.split(Pathname.new("C:/foo/bar")))
+  end
+
+  test "split requires a stringy argument or a TypeError is raised" do
+    assert_raise(TypeError){ File.split(nil) }
+    assert_raise(TypeError){ File.split([]) }
+  end
+
   test "File.long_path basic functionality" do
     assert_respond_to(File, :long_path)
     assert_nothing_raised{ File.long_path(@short_file) }

data/win32-file.gemspec

@@ -2,7 +2,7 @@ require 'rubygems'
 
 Gem::Specification.new do |spec|
   spec.name       = 'win32-file'
-  spec.version    = '0.7.0'
+  spec.version    = '0.7.1'
   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-file
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.7.1
 platform: ruby
 authors:
 - Daniel J. Berger
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-16 00:00:00.000000000 Z
+date: 2014-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -96,13 +96,13 @@ extra_rdoc_files:
 - MANIFEST
 files:
 - CHANGES
+- MANIFEST
+- README
+- Rakefile
+- lib/win32/file.rb
 - lib/win32/file/constants.rb
 - lib/win32/file/functions.rb
 - lib/win32/file/structs.rb
-- lib/win32/file.rb
-- MANIFEST
-- Rakefile
-- README
 - test/test_win32_file_link.rb
 - test/test_win32_file_misc.rb
 - test/test_win32_file_path.rb
@@ -128,7 +128,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: win32utils
-rubygems_version: 2.0.3
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Extra or redefined methods for the File class on Windows.