From 77561ad441b437c3057fe533c64407dd00095d4e Mon Sep 17 00:00:00 2001 From: naruse Date: Thu, 15 Mar 2018 16:51:31 +0000 Subject: [PATCH] Introduce URI::File to handle file URI scheme * the default value of URI::File's authority is "" (localhost). Both nil and "localhost" is normalized to "" by default. * URI::File ignores setting userinfo and port [Feature #14035] fix https://github.com/ruby/ruby/pull/1719 fic https://github.com/ruby/ruby/pull/1832 git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@62767 b2dd03c8-39d4-4d8f-98ff-823fe69b080e --- lib/uri.rb | 4 +- lib/uri/file.rb | 95 +++++++++++++++++++++++++++++++++++++++++++ test/uri/test_file.rb | 67 ++++++++++++++++++++++++++++++ 3 files changed, 165 insertions(+), 1 deletion(-) create mode 100644 lib/uri/file.rb create mode 100644 test/uri/test_file.rb diff --git a/lib/uri.rb b/lib/uri.rb index 971a970..b123fa8 100644 --- a/lib/uri.rb +++ b/lib/uri.rb @@ -41,7 +41,7 @@ # #=> URI::RSYNC # # URI.scheme_list -# #=> {"FTP"=>URI::FTP, "HTTP"=>URI::HTTP, "HTTPS"=>URI::HTTPS, +# #=> {"FILE"=>URI::File, "FTP"=>URI::FTP, "HTTP"=>URI::HTTP, "HTTPS"=>URI::HTTPS, # "LDAP"=>URI::LDAP, "LDAPS"=>URI::LDAPS, "MAILTO"=>URI::MailTo, # "RSYNC"=>URI::RSYNC} # @@ -65,6 +65,7 @@ # == Class tree # # - URI::Generic (in uri/generic.rb) +# - URI::File - (in uri/file.rb) # - URI::FTP - (in uri/ftp.rb) # - URI::HTTP - (in uri/http.rb) # - URI::HTTPS - (in uri/https.rb) @@ -104,6 +105,7 @@ module URI require 'uri/common' require 'uri/generic' +require 'uri/file' require 'uri/ftp' require 'uri/http' require 'uri/https' diff --git a/lib/uri/file.rb b/lib/uri/file.rb new file mode 100644 index 0000000..1a98b07 --- /dev/null +++ b/lib/uri/file.rb @@ -0,0 +1,95 @@ +# frozen_string_literal: true + +require 'uri/generic' + +module URI + + # + # The "file" URI is defined by RFC8089 + # + class File < Generic + # A Default port of nil for URI::File + DEFAULT_PORT = nil + + # + # An Array of the available components for URI::File + # + COMPONENT = [ + :scheme, + :host, + :path + ].freeze + + # + # == Description + # + # Creates a new URI::File object from components, with syntax checking. + # + # The components accepted are +host+ and +path+. + # + # The components should be provided either as an Array, or as a Hash + # with keys formed by preceding the component names with a colon. + # + # If an Array is used, the components must be passed in the order + # [host, path] + # + # If the path supplied is absolute, it will be escaped in order to + # make it absolute in the URI. Examples: + # + # require 'uri' + # + # uri = URI::File.build(['host.example.com', '/path/file.zip']) + # puts uri.to_s -> file://host.example.com/path/file.zip + # + # uri2 = URI::File.build({:host => 'host.example.com', + # :path => 'ruby/src'}) + # puts uri2.to_s -> file://host.example.com/ruby/src + # + def self.build(args) + tmp = Util::make_components_hash(self, args) + super(tmp) + end + + # protected setter for the host component +v+ + # + # see also URI::Generic.host= + # + def set_host(v) + v = "" if v.nil? || v == "localhost" + @host = v + end + + # do nothing + def set_port(v) + end + + # raise InvalidURIError + def check_userinfo(user) + raise URI::InvalidURIError, "can not set userinfo for file URI" + end + + # raise InvalidURIError + def check_user(user) + raise URI::InvalidURIError, "can not set user for file URI" + end + + # raise InvalidURIError + def check_password(user) + raise URI::InvalidURIError, "can not set password for file URI" + end + + # do nothing + def set_userinfo(v) + end + + # do nothing + def set_user(v) + end + + # do nothing + def set_password(v) + end + end + + @@schemes['FILE'] = File +end diff --git a/test/uri/test_file.rb b/test/uri/test_file.rb new file mode 100644 index 0000000..7e542b6 --- /dev/null +++ b/test/uri/test_file.rb @@ -0,0 +1,67 @@ +# frozen_string_literal: false +require 'test/unit' +require 'uri/file' + +class URI::TestFile < Test::Unit::TestCase + def test_parse + u = URI("file://example.com/file") + assert_equal "/file", u.path + + u = URI("file://localhost/file") + assert_equal "/file", u.path + assert_equal "file:///file", u.to_s + + u = URI("file://localhost:30/file") + assert_equal "", u.host + assert_equal nil, u.port + assert_equal "/file", u.path + assert_equal "file:///file", u.to_s + + u = URI("file:///file") + assert_equal "/file", u.path + assert_equal "file:///file", u.to_s + + u = URI("file:/file") + assert_equal "/file", u.path + assert_equal "file:///file", u.to_s + + u = URI("file://foo:pass@example.com/file") + assert_equal "/file", u.path + assert_equal nil, u.user + assert_equal nil, u.password + + u = URI("file:///c:/path/to/file") + assert_equal "/c:/path/to/file", u.path + + # this form is not supported + u = URI("file:c:/path/to/file") + assert_equal "c:/path/to/file", u.opaque + + end + + def test_build + u = URI::File.build(scheme: "file", host: "example.com", path:"/file") + assert_equal "/file", u.path + assert_equal "file://example.com/file", u.to_s + assert_raise(URI::InvalidURIError){ u.user = "foo" } + assert_raise(URI::InvalidURIError){ u.password = "foo" } + assert_raise(URI::InvalidURIError){ u.userinfo = "foo" } + assert_raise(URI::InvalidURIError){ URI::File.build(scheme: "file", userinfo: "foo", host: "example.com", path:"/file") } + + u = URI::File.build(scheme: "file", path:"/file") + assert_equal "", u.host + assert_equal "/file", u.path + assert_equal "file:///file", u.to_s + + u = URI::File.build(scheme: "file", host: "localhost", path:"/file") + assert_equal "", u.host + assert_equal "/file", u.path + assert_equal "file:///file", u.to_s + + u = URI::File.build(scheme: "file", path:"/file", port: 30) + assert_equal "", u.host + assert_equal nil, u.port + assert_equal "/file", u.path + assert_equal "file:///file", u.to_s + end +end