mirror of
https://github.com/ruby/ruby.git
synced 2022-11-09 12:17:21 -05:00
054ae999dc
The module here is called `URI`, so it's probably reasonable to expect a requirement for the path to be RFC3986-compliant, but on the other hand, the class is called `File`, so it might be reasonable to expect that a path produced by e.g. the `File` class would be consumable by its `build` method (this fails if the filename contains e.g. a space). https://github.com/ruby/uri/commit/ef79789b83
100 lines
2.2 KiB
Ruby
100 lines
2.2 KiB
Ruby
# frozen_string_literal: true
|
|
|
|
require_relative '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 <code>[host, path]</code>.
|
|
#
|
|
# A path from e.g. the File class should be escaped before
|
|
# being passed.
|
|
#
|
|
# Examples:
|
|
#
|
|
# require 'uri'
|
|
#
|
|
# uri1 = URI::File.build(['host.example.com', '/path/file.zip'])
|
|
# uri1.to_s # => "file://host.example.com/path/file.zip"
|
|
#
|
|
# uri2 = URI::File.build({:host => 'host.example.com',
|
|
# :path => '/ruby/src'})
|
|
# uri2.to_s # => "file://host.example.com/ruby/src"
|
|
#
|
|
# uri3 = URI::File.build({:path => URI::escape('/path/my file.txt')})
|
|
# uri3.to_s # => "file:///path/my%20file.txt"
|
|
#
|
|
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
|
|
|
|
register_scheme 'FILE', File
|
|
end
|