Class: URI::File

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain: self, `Generic`
Instance Chain: self, `Generic`, `::URI`, `RFC2396_REGEXP`
Inherits:	URI::Generic Object URI::Generic URI::File
Defined in:	lib/uri/file.rb

Overview

The “file” ::URI is defined by RFC8089.

Constant Summary

COMPONENT =

An Array of the available components for File.

# File 'lib/uri/file.rb', line 17
```
[
  :scheme,
  :host,
  :path
].freeze
```
DEFAULT_PORT =

A Default port of nil for File.

# File 'lib/uri/file.rb', line 12
```
nil
```

`::URI` - Included

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

`Generic` - Inherited

COMPONENT, DEFAULT_PORT, USE_REGISTRY

Class Method Summary

.build(args)

Description.

`Generic` - Inherited

.build	Synopsis.
.build2	Synopsis.
.component	Components of the `::URI` in the order.
.default_port	Returns default port.
.new	Args.
.use_proxy?, .use_registry

Instance Attribute Summary

`Generic` - Inherited

#absolute	Alias for Generic#absolute?.
#fragment	Returns the fragment component of the `::URI`.
#fragment=	Checks the fragment `v` component against the Parser Regexp for `:FRAGMENT`.
#hierarchical?	Returns true if `::URI` is hierarchical.
#host	Returns the host component of the `::URI`.
#host=	Args.
#hostname	Extract the host part of the `::URI` and unwrap brackets for IPv6 addresses.
#hostname=	Sets the host part of the `::URI` as the argument with brackets for IPv6 addresses.
#opaque	Returns the opaque part of the `::URI`.
#opaque=	Args.
#password	Returns the password component (without `::URI` decoding).
#password=	Args.
#path	Returns the path component of the `::URI`.
#path=	Args.
#port	Returns the port component of the `::URI`.
#port=	Args.
#query	Returns the query component of the `::URI`.
#query=	Args.
#registry=,
#relative?	Returns true if `::URI` does not have a scheme (e.g.
#scheme	Returns the scheme component of the `::URI`.
#scheme=	Args.
#user	Returns the user component (without `::URI` decoding).
#user=	Args.
#userinfo	Returns the userinfo, either as ‘user’ or ‘user:password’.
#userinfo=	Sets userinfo, argument is string like ‘name:pass’.
#registry

Instance Method Summary

#check_password(user)

raise InvalidURIError.
#check_user(user)

raise InvalidURIError.
#check_userinfo(user)

raise InvalidURIError.
#set_host(v)

Protected setter for the host component v.
#set_password(v)

do nothing.
#set_port(v)

do nothing.
#set_user(v)

do nothing.
#set_userinfo(v)

do nothing.

`Generic` - Inherited

#+	Alias for Generic#merge.
#-	Alias for Generic#route_from.
#==	Compares two URIs.
#absolute?	Returns true if `::URI` has a scheme (e.g.
#coerce	Args.
#component	Components of the `::URI` in the order.
#decoded_password	Returns the password component after `::URI` decoding.
#decoded_user	Returns the user component after `::URI` decoding.
#default_port	Returns default port.
#eql?,
#find_proxy	Returns a proxy `::URI`.
#hash, #inspect,
#merge	Args.
#merge!	Args.
#normalize	Returns normalized `::URI`.
#normalize!	Destructive version of `#normalize`.
#parser	Returns the parser to be used.
#route_from	Args.
#route_to	Args.
#select	Args.
#to_s	Constructs String from `::URI`.
#to_str	Alias for Generic#to_s.
#component_ary	Returns an Array of the components defined from the COMPONENT Array.
#set_host	Protected setter for the host component `v`.
#set_opaque	Protected setter for the opaque component `v`.
#set_password	Protected setter for the password component `v`.
#set_path	Protected setter for the path component `v`.
#set_port	Protected setter for the port component `v`.
#set_scheme	Protected setter for the scheme component `v`.
#set_user	Protected setter for the user component `v`.
#set_userinfo	Protected setter for the `user` component, and `password` if available (with validation).
#check_host	Checks the host `v` component for RFC2396 compliance and against the Parser Regexp for `:HOST`.
#check_opaque	Checks the opaque `v` component for RFC2396 compliance and against the Parser Regexp for `:OPAQUE`.
#check_password	Checks the password `v` component for RFC2396 compliance and against the Parser Regexp for `:USERINFO`.
#check_path	Checks the path `v` component for RFC2396 compliance and against the Parser Regexp for `:ABS_PATH` and `:REL_PATH`.
#check_port	Checks the port `v` component for RFC2396 compliance and against the Parser Regexp for `:PORT`.
#check_scheme	Checks the scheme `v` component against the Parser Regexp for `:SCHEME`.
#check_user	Checks the user `v` component for RFC2396 compliance and against the Parser Regexp for `:USERINFO`.
#check_userinfo	Checks the `user` and `password`.
#escape_userpass	Escapes ‘user:password’ `v` based on RFC 1738 section 3.1.
#merge_path	Merges a base path `base`, with relative path `rel`, returns a modified base path.
#replace!	Replaces self by other `::URI` object.
#route_from0,
#split_path	Returns an Array of the path split on ‘/’.
#split_userinfo	Returns the userinfo `ui` as `[user, password]` if properly formatted as ‘user:password’.
#set_registry, #check_registry, #route_from_path

Constructor Details

This class inherits a constructor from URI::Generic

Class Method Details

.build(args)

Description

Creates a new 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"

[ GitHub ]

# 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)

raise InvalidURIError

Raises:

(URI::InvalidURIError)

[ GitHub ]

# 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)

raise InvalidURIError

Raises:

(URI::InvalidURIError)

[ GitHub ]

# 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)

raise InvalidURIError

Raises:

(URI::InvalidURIError)

[ GitHub ]

# 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)

Protected setter for the host component v.

#set_password(v)

do nothing

[ GitHub ]

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


def set_password(v)
end

#set_port(v)

do nothing

[ GitHub ]

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


def set_port(v)
end

#set_user(v)

do nothing

[ GitHub ]

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


def set_user(v)
end

#set_userinfo(v)

do nothing

[ GitHub ]

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


def set_userinfo(v)
end

Class: URI::File

Overview

Constant Summary

::URI - Included

Generic - Inherited

Class Method Summary

Generic - Inherited

Instance Attribute Summary

Generic - Inherited

Instance Method Summary

Generic - Inherited

Constructor Details

Class Method Details

.build(args)

Description

Instance Method Details

#check_password(user)

#check_user(user)

#check_userinfo(user)

#set_host(v)

#set_password(v)

#set_port(v)

#set_user(v)

#set_userinfo(v)

`::URI` - Included

`Generic` - Inherited

`Generic` - Inherited

`Generic` - Inherited

`Generic` - Inherited