Improve require/File.expand_path performance on Windows

* configure.in (mingw): add shlwapi to the list of dependency
  libs for Windows.
* win32/Makefile.sub (EXTSOLIBS): ditto.

* internal.h: declare internal functions rb_w32_init_file,
  rb_file_expand_path_internal and rb_file_expand_path_fast.

* file.c (Init_File): invoke Windows initialization rb_w32_init_file

* win32/file.c (rb_file_load_path_internal): new function.
  Windows-specific implementation that replaces file_expand_path.
  [Bug #6836][ruby-core:46996]

* win32/file.c (rb_w32_init_file): new function. Initialize codepage
  cache for faster conversion encodings lookup.

* file.c (file_expand_path): rename to rb_file_expand_path_internal.
  Conditionally exclude from Windows.

* file.c (rb_file_expand_path_fast): new function. delegates to
  rb_file_expand_path_internal without performing a hit to the
  filesystem.

* file.c (file_expand_path_1): use rb_file_expand_path_internal without
  path expansion (used by require).
* file.c (rb_find_file_ext_safe): ditto.
* file.c (rb_find_file_safe): ditto.

* load.c (rb_get_expanded_load_path): use rb_file_expand_path_fast.
* load.c (rb_feature_provided): ditto.

* file.c (rb_file_expand_path): use rb_file_expand_path_internal with
  path expansion.
* file.c (rb_file_absolute_path): ditto.

* test/ruby/test_file_exhaustive.rb: new tests to exercise
  rb_file_expand_path_internal implementation and compliance with
  existing behaviors.

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@36811 b2dd03c8-39d4-4d8f-98ff-823fe69b080e

1 files changed, 206 insertions, 0 deletions

diff --git a/test/ruby/test_file_exhaustive.rb b/test/ruby/test_file_exhaustive.rb
index 7467bffdfe..1523823bb7 100644
--- a/test/ruby/test_file_exhaustive.rb
+++ b/test/ruby/test_file_exhaustive.rb
@@ -14,6 +14,7 @@ class TestFileExhaustive < Test::Unit::TestCase
 
   def setup
     @dir = Dir.mktmpdir("rubytest-file")
+    @rootdir = "#{DRIVE}/"
     File.chown(-1, Process.gid, @dir)
     @file = make_tmp_filename("file")
     @zerofile = make_tmp_filename("zerofile")
@@ -450,9 +451,24 @@ class TestFileExhaustive < Test::Unit::TestCase
       assert_equal(expected.force_encoding(cp), File.expand_path(a.dup.force_encoding(cp)), cp)
     end
 
+    path = "\u3042\u3044\u3046\u3048\u304a".encode("EUC-JP")
+    assert_equal("#{Dir.pwd}/#{path}".encode("CP932"), File.expand_path(path).encode("CP932"))
+
+    path = "\u3042\u3044\u3046\u3048\u304a".encode("CP51932")
+    assert_equal("#{Dir.pwd}/#{path}", File.expand_path(path))
+
     assert_incompatible_encoding {|d| File.expand_path(d)}
   end
 
+  def test_expand_path_encoding_filesystem
+    path = "~".encode("US-ASCII")
+    dir = "C:/".encode("IBM437")
+    fs = Encoding.find("filesystem")
+
+    assert_equal fs, File.expand_path(path).encoding
+    assert_equal fs, File.expand_path(path, dir).encoding
+  end
+
   def test_expand_path_home
     assert_kind_of(String, File.expand_path("~")) if ENV["HOME"]
     assert_raise(ArgumentError) { File.expand_path("~foo_bar_baz_unknown_user_wahaha") }
@@ -460,7 +476,13 @@ class TestFileExhaustive < Test::Unit::TestCase
     begin
       bug3630 = '[ruby-core:31537]'
       home = ENV["HOME"]
+      home_drive = ENV["HOMEDRIVE"]
+      home_path = ENV["HOMEPATH"]
+      user_profile = ENV["USERPROFILE"]
       ENV["HOME"] = nil
+      ENV["HOMEDRIVE"] = nil
+      ENV["HOMEPATH"] = nil
+      ENV["USERPROFILE"] = nil
       assert_raise(ArgumentError) { File.expand_path("~") }
       ENV["HOME"] = "~"
       assert_raise(ArgumentError, bug3630) { File.expand_path("~") }
@@ -468,9 +490,193 @@ class TestFileExhaustive < Test::Unit::TestCase
       assert_raise(ArgumentError, bug3630) { File.expand_path("~") }
     ensure
       ENV["HOME"] = home
+      ENV["HOMEDRIVE"] = home_drive
+      ENV["HOMEPATH"] = home_path
+      ENV["USERPROFILE"] = user_profile
+    end
+  end
+
+  def test_expand_path_remove_trailing_alternative_data
+    assert_equal File.join(@rootdir, "aaa"), File.expand_path("#{@rootdir}/aaa::$DATA")
+    assert_equal File.join(@rootdir, "aa:a"), File.expand_path("#{@rootdir}/aa:a:$DATA")
+    assert_equal File.join(@rootdir, "aaa:$DATA"), File.expand_path("#{@rootdir}/aaa:$DATA")
+  end if DRIVE
+
+  def test_expand_path_resolve_empty_string_current_directory
+    assert_equal(Dir.pwd, File.expand_path(""))
+  end
+
+  def test_expand_path_resolve_dot_current_directory
+    assert_equal(Dir.pwd, File.expand_path("."))
+  end
+
+  def test_expand_path_resolve_file_name_relative_current_directory
+    assert_equal(File.join(Dir.pwd, "foo"), File.expand_path("foo"))
+  end
+
+  def test_ignore_nil_dir_string
+    assert_equal(File.join(Dir.pwd, "foo"), File.expand_path("foo", nil))
+  end
+
+  def test_expand_path_resolve_file_name_and_dir_string_relative
+    assert_equal(File.join(Dir.pwd, "bar", "foo"),
+      File.expand_path("foo", "bar"))
+  end
+
+  def test_expand_path_cleanup_dots_file_name
+    bug = "[ruby-talk:18512]"
+
+    assert_equal(File.join(Dir.pwd, ".a"), File.expand_path(".a"), bug)
+    assert_equal(File.join(Dir.pwd, "..a"), File.expand_path("..a"), bug)
+
+    if DRIVE
+      # cleanup dots only on Windows
+      assert_equal(File.join(Dir.pwd, "a"), File.expand_path("a."), bug)
+      skip "FIXME"
+      assert_equal(File.join(Dir.pwd, "a"), File.expand_path("a.."), bug)
+    else
+      assert_equal(File.join(Dir.pwd, "a."), File.expand_path("a."), bug)
+      assert_equal(File.join(Dir.pwd, "a.."), File.expand_path("a.."), bug)
+    end
+  end
+
+  def test_expand_path_converts_a_pathname_to_an_absolute_pathname_using_a_complete_path
+    assert_equal(@dir, File.expand_path("", "#{@dir}"))
+    assert_equal(File.join(@dir, "a"), File.expand_path("a", "#{@dir}"))
+    assert_equal(File.join(@dir, "a"), File.expand_path("../a", "#{@dir}/xxx"))
+    assert_equal(@rootdir, File.expand_path(".", "#{@rootdir}"))
+  end
+
+  def test_expand_path_ignores_supplied_dir_if_path_contains_a_drive_letter
+    assert_equal(@rootdir, File.expand_path(@rootdir, "D:/"))
+  end if DRIVE
+
+  def test_expand_path_removes_trailing_slashes_from_absolute_path
+    assert_equal(File.join(@rootdir, "foo"), File.expand_path("#{@rootdir}foo/"))
+    assert_equal(File.join(@rootdir, "foo.rb"), File.expand_path("#{@rootdir}foo.rb/"))
+  end
+
+  def test_expand_path_removes_trailing_spaces_from_absolute_path
+    assert_equal(File.join(@rootdir, "a"), File.expand_path("#{@rootdir}a "))
+  end if DRIVE
+
+  def test_expand_path_converts_a_pathname_which_starts_with_a_slash_using_dir_s_drive
+    assert_match(%r"\Az:/foo\z"i, File.expand_path('/foo', "z:/bar"))
+  end if DRIVE
+
+  def test_expand_path_converts_a_pathname_which_starts_with_a_slash_and_unc_pathname
+    assert_equal("//foo", File.expand_path('//foo', "//bar"))
+    assert_equal("//bar/foo", File.expand_path('/foo', "//bar"))
+    assert_equal("//foo", File.expand_path('//foo', "/bar"))
+  end if DRIVE
+
+  def test_expand_path_converts_a_dot_with_unc_dir
+    assert_equal("//", File.expand_path('.', "//"))
+  end
+
+  def test_expand_path_preserves_unc_path_root
+    assert_equal("//", File.expand_path("//"))
+    assert_equal("//", File.expand_path("//."))
+    assert_equal("//", File.expand_path("//.."))
+  end
+
+  def test_expand_path_converts_a_pathname_which_starts_with_a_slash_using_host_share
+    assert_match(%r"\A//host/share/foo\z"i, File.expand_path('/foo', "//host/share/bar"))
+  end if DRIVE
+
+  def test_expand_path_converts_a_pathname_which_starts_with_a_slash_using_a_current_drive
+    assert_match(%r"\A#{DRIVE}/foo\z"i, File.expand_path('/foo'))
+  end
+
+  def test_expand_path_returns_tainted_strings_or_not
+    assert_equal(true, File.expand_path('foo').tainted?)
+    assert_equal(true, File.expand_path('foo'.taint).tainted?)
+    assert_equal(true, File.expand_path('/foo'.taint).tainted?)
+    assert_equal(true, File.expand_path('foo', 'bar').tainted?)
+    assert_equal(true, File.expand_path('foo', '/bar'.taint).tainted?)
+    assert_equal(true, File.expand_path('foo'.taint, '/bar').tainted?)
+    assert_equal(true, File.expand_path('~').tainted?)
+
+    if DRIVE
+      assert_equal(true, File.expand_path('/foo').tainted?)
+      assert_equal(false, File.expand_path('//foo').tainted?)
+      assert_equal(true, File.expand_path('C:/foo'.taint).tainted?)
+      assert_equal(false, File.expand_path('C:/foo').tainted?)
+      assert_equal(true, File.expand_path('foo', '/bar').tainted?)
+      assert_equal(true, File.expand_path('foo', 'C:/bar'.taint).tainted?)
+      assert_equal(true, File.expand_path('foo'.taint, 'C:/bar').tainted?)
+      assert_equal(false, File.expand_path('foo', 'C:/bar').tainted?)
+      assert_equal(false, File.expand_path('C:/foo/../bar').tainted?)
+      assert_equal(false, File.expand_path('foo', '//bar').tainted?)
+    else
+      assert_equal(false, File.expand_path('/foo').tainted?)
+      assert_equal(false, File.expand_path('foo', '/bar').tainted?)
     end
   end
 
+  def test_expand_path_converts_a_pathname_to_an_absolute_pathname_using_home_as_base
+    old_home = ENV["HOME"]
+    home = ENV["HOME"] = "#{DRIVE}/UserHome"
+    assert_equal(home, File.expand_path("~"))
+    assert_equal(home, File.expand_path("~", "C:/FooBar"))
+    assert_equal(File.join(home, "a"), File.expand_path("~/a", "C:/FooBar"))
+  ensure
+    ENV["HOME"] = old_home
+  end
+
+  def test_expand_path_converts_a_pathname_to_an_absolute_pathname_using_unc_home
+    old_home = ENV["HOME"]
+    unc_home = ENV["HOME"] = "//UserHome"
+    assert_equal(unc_home, File.expand_path("~"))
+  ensure
+    ENV["HOME"] = old_home
+  end if DRIVE
+
+  def test_expand_path_does_not_modify_a_home_string_argument
+    old_home = ENV["HOME"]
+    home = ENV["HOME"] = "#{DRIVE}/UserHome"
+    str = "~/a"
+    assert_equal("#{home}/a", File.expand_path(str))
+    assert_equal("~/a", str)
+  ensure
+    ENV["HOME"] = old_home
+  end
+
+  def test_expand_path_raises_argument_error_for_any_supplied_username
+    bug = '[ruby-core:39597]'
+    assert_raise(ArgumentError, bug) { File.expand_path("~anything") }
+  end if DRIVE
+
+  def test_expand_path_raises_a_type_error_if_not_passed_a_string_type
+    assert_raise(TypeError) { File.expand_path(1) }
+    assert_raise(TypeError) { File.expand_path(nil) }
+    assert_raise(TypeError) { File.expand_path(true) }
+  end
+
+  def test_expand_path_expands_dot_dir
+    assert_equal("#{DRIVE}/dir", File.expand_path("#{DRIVE}/./dir"))
+  end
+
+  def test_expand_path_does_not_modify_the_string_argument
+    str = "./a/b/../c"
+    assert_equal("#{Dir.pwd}/a/c", File.expand_path(str, Dir.pwd))
+    assert_equal("./a/b/../c", str)
+  end
+
+  def test_expand_path_returns_a_string_when_passed_a_string_subclass
+    sub = Class.new(String)
+    str = sub.new "./a/b/../c"
+    path = File.expand_path(str, Dir.pwd)
+    assert_equal("#{Dir.pwd}/a/c", path)
+    assert_instance_of(String, path)
+  end
+
+  def test_expand_path_accepts_objects_that_have_a_to_path_method
+    klass = Class.new { def to_path; "a/b/c"; end }
+    obj = klass.new
+    assert_equal("#{Dir.pwd}/a/b/c", File.expand_path(obj))
+  end
+
   def test_basename
     assert_equal(File.basename(@file).sub(/\.test$/, ""), File.basename(@file, ".test"))
     assert_equal("", s = File.basename(""))