Class: URI::File

Inherits:
Generic show all
Defined in:
lib/uri/file.rb

Overview

The “file” URI is defined by RFC8089.

Constant Summary collapse

DEFAULT_PORT =

A Default port of nil for URI::File.

nil
COMPONENT =

An Array of the available components for URI::File.

[
  :scheme,
  :host,
  :path
].freeze

Constants inherited from Generic

Generic::USE_REGISTRY

Constants included from URI

DEFAULT_PARSER, Parser, REGEXP, RFC3986_PARSER, TBLDECWWWCOMP_, TBLENCURICOMP_, TBLENCWWWCOMP_, VERSION, VERSION_CODE

Instance Attribute Summary

Attributes inherited from Generic

#fragment, #host, #opaque, #path, #port, #query, #scheme

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Generic

#==, #absolute?, build2, #coerce, #component, component, #decoded_password, #decoded_user, #default_port, default_port, #eql?, #find_proxy, #hash, #hierarchical?, #hostname, #hostname=, #initialize, #inspect, #merge, #merge!, #normalize, #normalize!, #parser, #password, #password=, #registry, #registry=, #relative?, #route_from, #route_to, #select, #to_s, use_proxy?, use_registry, #user, #user=, #userinfo, #userinfo=

Methods included from URI

decode_uri_component, decode_www_form, decode_www_form_component, encode_uri_component, encode_www_form, encode_www_form_component, extract, for, join, parse, regexp, register_scheme, scheme_list, split

Constructor Details

This class inherits a constructor from URI::Generic

Class Method Details

.build(args) ⇒ Object

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].

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"



53
54
55
56
 
# File 'lib/uri/file.rb', line 53

def self.build(args)
  tmp = Util::make_components_hash(self, args)
  super(tmp)
end

Instance Method Details

#check_password(user) ⇒ Object

raise InvalidURIError

Raises:



82
83
84
 
# File 'lib/uri/file.rb', line 82

def check_password(user)
  raise URI::InvalidURIError, "can not set password for file URI"
end

#check_user(user) ⇒ Object

raise InvalidURIError

Raises:



77
78
79
 
# File 'lib/uri/file.rb', line 77

def check_user(user)
  raise URI::InvalidURIError, "can not set user for file URI"
end

#check_userinfo(user) ⇒ Object

raise InvalidURIError

Raises:



72
73
74
 
# File 'lib/uri/file.rb', line 72

def check_userinfo(user)
  raise URI::InvalidURIError, "can not set userinfo for file URI"
end

#set_host(v) ⇒ Object

Protected setter for the host component v.

See also URI::Generic.host=.



62
63
64
65
 
# File 'lib/uri/file.rb', line 62

def set_host(v)
  v = "" if v.nil? || v == "localhost"
  @host = v
end

#set_password(v) ⇒ Object

do nothing



95
96
 
# File 'lib/uri/file.rb', line 95

def set_password(v)
end

#set_port(v) ⇒ Object

do nothing



68
69
 
# File 'lib/uri/file.rb', line 68

def set_port(v)
end

#set_user(v) ⇒ Object

do nothing



91
92
 
# File 'lib/uri/file.rb', line 91

def set_user(v)
end

#set_userinfo(v) ⇒ Object

do nothing



87
88
 
# File 'lib/uri/file.rb', line 87

def set_userinfo(v)
end