summaryrefslogtreecommitdiff
path: root/lib/uri
diff options
context:
space:
mode:
authornaruse <naruse@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2018-03-15 16:51:31 +0000
committernaruse <naruse@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2018-03-15 16:51:31 +0000
commit04883f12c8944922117482d4d446502e5d5d3413 (patch)
treef53ea95a094653f08804dcd0797129c1a96ce1d2 /lib/uri
parent09fb6248389be31975480306654a18cf4cea232a (diff)
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
Diffstat (limited to 'lib/uri')
-rw-r--r--lib/uri/file.rb95
1 files changed, 95 insertions, 0 deletions
diff --git a/lib/uri/file.rb b/lib/uri/file.rb
new file mode 100644
index 0000000000..1a98b07d3a
--- /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