Spec-Zone.ru › Ruby 2.4

класс URI::Generic

Родитель:
Объект
Включенные модули:
URI

Базовый класс для всех классов URI. Реализует общий синтаксис URI в соответствии с RFC 2396.

Константы

COMPONENT

Массив доступных компонентов для URI::Generic

DEFAULT_PORT

Значение порта по умолчанию — nil для URI::Generic

Атрибуты

fragment[R]

возвращает компонент фрагмента URI.

URI("http://foo/bar/baz?search=FooBar#ponies").fragment #=> "ponies"
host[R]

возвращает компонент хоста URI.

URI("http://foo/bar/baz").host #=> "foo"

Возвращает nil, если компонент хоста отсутствует.

URI("mailto:foo@example.org").host #=> nil

Компонент не содержит номер порта.

URI("http://foo:8080/bar/baz").host #=> "foo"

Так как IPv6-адреса заключены в квадратные скобки в URI, этот метод возвращает IPv6-адреса в квадратных скобках. Этот формат не подходит для передачи в методы сокетов, такие как IO.open. Если требуются имена хостов без скобок, используйте метод «hostname».

URI("http://[::1]/bar/baz").host #=> "[::1]"
URI("http://[::1]/bar/baz").hostname #=> "::1"
opaque[R]

возвращает неявную часть URI.

URI("mailto:foo@example.org").opaque #=> "foo@example.org"

Часть пути, которая не использует слеш '/'. Путь обычно относится к абсолютному пути и неявной части.

(see RFC2396 Section 3 and 5.2)
path[R]

возвращает компонент пути URI.

URI("http://foo/bar/baz").path #=> "/bar/baz"
port[R]

возвращает компонент порта URI.

URI("http://foo/bar/baz").port #=> "80"

URI("http://foo:8080/bar/baz").port #=> "8080"
query[R]

возвращает компонент запроса URI.

URI("http://foo/bar/baz?search=FooBar").query #=> "search=FooBar"
scheme[R]

возвращает компонент схемы URI.

URI("http://foo/bar/baz").scheme #=> "http"

Открытые методы класса

build(args) Показать исходный код
# File lib/uri/generic.rb, line 115
def self.build(args)
  if args.kind_of?(Array) &&
      args.size == ::URI::Generic::COMPONENT.size
    tmp = args.dup
  elsif args.kind_of?(Hash)
    tmp = ::URI::Generic::COMPONENT.collect do |c|
      if args.include?(c)
        args[c]
      else
        nil
      end
    end
  else
    component = self.class.component rescue ::URI::Generic::COMPONENT
    raise ArgumentError,
    "expected Array of or Hash of components of #{self.class} (#{component.join(', ')})"
  end

  tmp << nil
  tmp << true
  return self.new(*tmp)
end

Синопсис

См. новый

Описание

Создаёт новый экземпляр URI::Generic из компонентов URI::Generic с проверкой. Компоненты: схема, имя пользователя, хост, порт, регистр, путь, неявная часть, запрос и фрагмент. Вы можете передавать аргументы либо в виде массива, либо в виде хэша. Обратитесь к методу new, чтобы узнать используемые ключи хэша или порядок элементов массива.

build2(args) Показать исходный код
# File lib/uri/generic.rb, line 77
def self.build2(args)
  begin
    return self.build(args)
  rescue InvalidComponentError
    if args.kind_of?(Array)
      return self.build(args.collect{|x|
        if x.is_a?(String)
          DEFAULT_PARSER.escape(x)
        else
          x
        end
      })
    elsif args.kind_of?(Hash)
      tmp = {}
      args.each do |key, value|
        tmp[key] = if value
            DEFAULT_PARSER.escape(value)
          else
            value
          end
      end
      return self.build(tmp)
    end
  end
end

Синопсис

См. новый

Описание

Сначала пытается создать новый экземпляр URI::Generic с помощью ::build. Но если возникает исключение URI::InvalidComponentError, тогда он URI::Escape#escape все компоненты URI и пытается снова.

component() Показать исходный код
# File lib/uri/generic.rb, line 55
def self.component
  self::COMPONENT
end

Компоненты URI в порядке.

default_port() Показать исходный код
# File lib/uri/generic.rb, line 30
def self.default_port
  self::DEFAULT_PORT
end

Возвращает порт по умолчанию

new(scheme, userinfo, host, port, registry, path, opaque, query, fragment, parser = DEFAULT_PARSER, arg_check = false) Показать исходный код
# File lib/uri/generic.rb, line 167
def initialize(scheme,
               userinfo, host, port, registry,
               path, opaque,
               query,
               fragment,
               parser = DEFAULT_PARSER,
               arg_check = false)
  @scheme = nil
  @user = nil
  @password = nil
  @host = nil
  @port = nil
  @path = nil
  @query = nil
  @opaque = nil
  @fragment = nil
  @parser = parser == DEFAULT_PARSER ? nil : parser

  if arg_check
    self.scheme = scheme
    self.userinfo = userinfo
    self.hostname = host
    self.port = port
    self.path = path
    self.query = query
    self.opaque = opaque
    self.fragment = fragment
  else
    self.set_scheme(scheme)
    self.set_userinfo(userinfo)
    self.set_host(host)
    self.set_port(port)
    self.set_path(path)
    self.query = query
    self.set_opaque(opaque)
    self.fragment=(fragment)
  end
  if registry
    raise InvalidURIError,
      "the scheme #{@scheme} does not accept registry part: #{registry} (or bad hostname?)"
  end

  @scheme&.freeze
  self.set_path('') if !@path && !@opaque # (see RFC2396 Section 5.2)
  self.set_port(self.default_port) if self.default_port && !@port
end

Аргументы

scheme

Схема протокола, например, 'http', 'ftp', 'mailto' и так далее.

userinfo

Имя пользователя и пароль, например, 'sdmitry:bla'

host

Имя хоста сервера

port

Порт сервера

registry

Регистр именных авторитетов.

path

Путь на сервере

opaque

Неявная часть

query

Данные запроса

fragment

Часть URI после символа '#'

parser

Парсер для внутреннего использования [URI::DEFAULT_PARSER по умолчанию]

arg_check

Проверка аргументов [по умолчанию false]

Описание

Создаёт новый экземпляр URI::Generic из компонентов “generic” без проверки.

Публичные методы экземпляров

+(oth)
Псевдоним для: merge
-(oth)
Псевдоним для: route_from
==(oth) Показать исходный код
# File lib/uri/generic.rb, line 1361
def ==(oth)
  if self.class == oth.class
    self.normalize.component_ary == oth.normalize.component_ary
  else
    false
  end
end

Сравнение с URI

absolute()
Псевдоним для: absolute?
absolute?() Показать исходный код
# File lib/uri/generic.rb, line 959
def absolute?
  if @scheme
    true
  else
    false
  end
end

Проверка, является ли URI абсолютным

Также псевдоним для: absolute
coerce(oth) Показать исходный код
# File lib/uri/generic.rb, line 1451
def coerce(oth)
  case oth
  when String
    oth = parser.parse(oth)
  else
    super
  end

  return oth, self
end

Аргументы

v

URI или строка

Описание

attempt to parse other URI +oth+
return [parsed_oth, self]

Использование

require 'uri'

uri = URI.parse("http://my.example.com")
uri.coerce("http://foo.com")
#=> [#<URI::HTTP:0x00000000bcb028 URL:http://foo.com/>, #<URI::HTTP:0x00000000d92178 URL:http://my.example.com>]
Вызывает метод суперкласса
component() Показать исходный код
# File lib/uri/generic.rb, line 310
def component
  self.class.component
end

Компоненты URI в порядке.

default_port() Показать исходный код
# File lib/uri/generic.rb, line 37
def default_port
  self.class.default_port
end

Возвращает порт по умолчанию

eql?(oth) Показать исходный код
# File lib/uri/generic.rb, line 1373
def eql?(oth)
  self.class == oth.class &&
  parser == oth.parser &&
  self.component_ary.eql?(oth.component_ary)
end
find_proxy(env=ENV) Показать исходный код
# File lib/uri/generic.rb, line 1477
def find_proxy(env=ENV)
  raise BadURIError, "relative URI: #{self}" if self.relative?
  name = self.scheme.downcase + '_proxy'
  proxy_uri = nil
  if name == 'http_proxy' && env.include?('REQUEST_METHOD') # CGI?
    # HTTP_PROXY conflicts with *_proxy for proxy settings and
    # HTTP_* for header information in CGI.
    # So it should be careful to use it.
    pairs = env.reject {|k, v| /\Ahttp_proxy\z/i !~ k }
    case pairs.length
    when 0 # no proxy setting anyway.
      proxy_uri = nil
    when 1
      k, _ = pairs.shift
      if k == 'http_proxy' && env[k.upcase] == nil
        # http_proxy is safe to use because ENV is case sensitive.
        proxy_uri = env[name]
      else
        proxy_uri = nil
      end
    else # http_proxy is safe to use because ENV is case sensitive.
      proxy_uri = env.to_hash[name]
    end
    if !proxy_uri
      # Use CGI_HTTP_PROXY.  cf. libwww-perl.
      proxy_uri = env["CGI_#{name.upcase}"]
    end
  elsif name == 'http_proxy'
    unless proxy_uri = env[name]
      if proxy_uri = env[name.upcase]
        warn 'The environment variable HTTP_PROXY is discouraged.  Use http_proxy.'
      end
    end
  else
    proxy_uri = env[name] || env[name.upcase]
  end

  if proxy_uri.nil? || proxy_uri.empty?
    return nil
  end

  if self.hostname
    require 'socket'
    begin
      addr = IPSocket.getaddress(self.hostname)
      return nil if /\A127\.|\A::1\z/ =~ addr
    rescue SocketError
    end
  end

  name = 'no_proxy'
  if no_proxy = env[name] || env[name.upcase]
    no_proxy.scan(/(?!\.)([^:,\s]+)(?::(\d+))?/) {|host, port|
      if (!port || self.port == port.to_i)
        if /(\A|\.)#{Regexp.quote host}\z/i =~ self.host
          return nil
        elsif addr
          require 'ipaddr'
          return nil if
            begin
              IPAddr.new(host)
            rescue IPAddr::InvalidAddressError
              next
            end.include?(addr)
        end
      end
    }
  end
  URI.parse(proxy_uri)
end

Возвращает прокси-URI. Прокси-URI извлекается из переменных окружения, таких как http_proxy, ftp_proxy, no_proxy и т.д. Если подходящий прокси не найден, возвращается nil.

Если указан необязательный параметр env, он используется вместо ENV.

Обратите внимание, что рассматриваются также прописные переменные (HTTP_PROXY, FTP_PROXY, NO_PROXY и т.д.).

Но http_proxy и HTTP_PROXY обрабатываются особым образом в окружении CGI. Это потому, что HTTP_PROXY может быть задан заголовком Proxy:. Поэтому HTTP_PROXY не используется. http_proxy также не используется, если переменная нечувствительна к регистру. Можно использовать CGI_HTTP_PROXY вместо этого.

fragment=(v) Показать исходный код
# File lib/uri/generic.rb, line 932
def fragment=(v)
  return @fragment = nil unless v

  x = v.to_str
  v = x.dup if x.equal? v
  v.encode!(Encoding::UTF_8) rescue nil
  v.delete!("\t\r\n")
  v.force_encoding(Encoding::ASCII_8BIT)
  v.gsub!(/(?!%\h\h|[!-~])./n){'%%%02X' % $&.ord}
  v.force_encoding(Encoding::US_ASCII)
  @fragment = v
end

проверка фрагмента v компоненты URI против Regexp URI::Parser для :FRAGMENT

Аргументы

v

Строка

Описание

публичный метод-сеттер для компонента фрагмента v. (с валидацией)

Использование

require 'uri'

uri = URI.parse("http://my.example.com/?id=25#time=1305212049")
uri.fragment = "time=1305212086"
# =>  "time=1305212086"
uri
#=> #<URI::HTTP:0x000000007a81f8 URL:http://my.example.com/?id=25#time=1305212086>
hash() Показать исходный код
# File lib/uri/generic.rb, line 1369
def hash
  self.component_ary.hash
end
hierarchical?() Показать исходный код
# File lib/uri/generic.rb, line 948
def hierarchical?
  if @path
    true
  else
    false
  end
end

Проверка, содержит ли URI путь

host=(v) Показать исходный код
# File lib/uri/generic.rb, line 634
def host=(v)
  check_host(v)
  set_host(v)
  v
end

Аргументы

v

Строка

Описание

публичный метод-сеттер для компонента host v. (с валидацией)

см. также #check_host

Использование

require 'uri'

uri = URI.parse("http://my.example.com")
uri.host = "foo.com"
# =>  "foo.com"
uri
#=> #<URI::HTTP:0x000000008e89e8 URL:http://foo.com>
hostname() Показать исходный код
# File lib/uri/generic.rb, line 649
def hostname
  v = self.host
  /\A\[(.*)\]\z/ =~ v ? $1 : v
end

Извлечение части host URI и удаление скобок для IPv6-адресов.

Этот метод аналогичен #host, за исключением удаления скобок для IPv6 (и будущих IP)-адресов.

u = URI(“http://[::1]/bar”) p u.hostname #=> “::1” p u.host #=> “[::1]”

hostname=(v) Показать исходный код
# File lib/uri/generic.rb, line 667
def hostname=(v)
  v = "[#{v}]" if /\A\[.*\]\z/ !~ v && /:/ =~ v
  self.host = v
end

Установка части host URI в качестве аргумента с добавлением скобок для IPv6-адресов.

Этот метод аналогичен #host=, за исключением того, что аргумент может быть чистым IPv6-адресом.

u = URI(“foo/bar”) p u.to_s #=> “foo/bar” u.hostname = “::1” p u.to_s #=> “[::1]/bar”

Если аргумент похож на IPv6-адрес, он обрамляется скобками.

inspect() Показать исходный код
# File lib/uri/generic.rb, line 1428
def inspect
  "#<#{self.class} #{self}>"
end
merge(oth) Показать исходный код
# File lib/uri/generic.rb, line 1097
def merge(oth)
  rel = parser.send(:convert_to_uri, oth)

  if rel.absolute?
    #raise BadURIError, "both URI are absolute" if absolute?
    # hmm... should return oth for usability?
    return rel
  end

  unless self.absolute?
    raise BadURIError, "both URI are relative"
  end

  base = self.dup

  authority = rel.userinfo || rel.host || rel.port

  # RFC2396, Section 5.2, 2)
  if (rel.path.nil? || rel.path.empty?) && !authority && !rel.query
    base.fragment=(rel.fragment) if rel.fragment
    return base
  end

  base.query = nil
  base.fragment=(nil)

  # RFC2396, Section 5.2, 4)
  if !authority
    base.set_path(merge_path(base.path, rel.path)) if base.path && rel.path
  else
    # RFC2396, Section 5.2, 4)
    base.set_path(rel.path) if rel.path
  end

  # RFC2396, Section 5.2, 7)
  base.set_userinfo(rel.userinfo) if rel.userinfo
  base.set_host(rel.host)         if rel.host
  base.set_port(rel.port)         if rel.port
  base.query = rel.query       if rel.query
  base.fragment=(rel.fragment) if rel.fragment

  return base
end

Аргументы

oth

URI или строка

Описание

Объединение двух URI.

Использование

require 'uri'

uri = URI.parse("http://my.example.com")
p uri.merge("/main.rbx?page=1")
# =>  #<URI::HTTP:0x2021f3b0 URL:http://my.example.com/main.rbx?page=1>
Также псевдоним для: +
merge!(oth) Показать исходный код
# File lib/uri/generic.rb, line 1069
def merge!(oth)
  t = merge(oth)
  if self == t
    nil
  else
    replace!(t)
    self
  end
end

Аргументы

oth

URI или строка

Описание

Деструктивная форма merge

Использование

require 'uri'

uri = URI.parse("http://my.example.com")
uri.merge!("/main.rbx?page=1")
p uri
# =>  #<URI::HTTP:0x2021f3b0 URL:http://my.example.com/main.rbx?page=1>
normalize() Показать исходный код
# File lib/uri/generic.rb, line 1297
def normalize
  uri = dup
  uri.normalize!
  uri
end

Возвращает нормализованный URI

normalize!() Показать исходный код
# File lib/uri/generic.rb, line 1306
def normalize!
  if path&.empty?
    set_path('/')
  end
  if scheme && scheme != scheme.downcase
    set_scheme(self.scheme.downcase)
  end
  if host && host != host.downcase
    set_host(self.host.downcase)
  end
end

Деструктивная версия normalize

END_OF_DOCUMENT_MARKER
opaque=(v) Показать исходный код
# File lib/uri/generic.rb, line 902
def opaque=(v)
  check_opaque(v)
  set_opaque(v)
  v
end

Аргументы

v

Строка

Описание

Общедоступный метод установки компонента opaque v. (с валидацией).

См. также #check_opaque

parser() Показать исходный код
# File lib/uri/generic.rb, line 287
def parser
  if !defined?(@parser) || !@parser
    DEFAULT_PARSER
  else
    @parser || DEFAULT_PARSER
  end
end

Возвращает используемый парсер.

Если URI::Parser не определён, используется DEFAULT_PARSER.

password() Показать исходный код
# File lib/uri/generic.rb, line 576
def password
  @password
end

Возвращает компонент password

password=(password) Показать исходный код
# File lib/uri/generic.rb, line 501
def password=(password)
  check_password(password)
  set_password(password)
  # returns password
end

Аргументы

v

Строка

Описание

Общедоступный метод установки компонента password. (с валидацией).

См. также #check_password

Использование

require 'uri'

uri = URI.parse("http://john:S3nsit1ve@my.example.com")
uri.password = "V3ry_S3nsit1ve"
# =>  "V3ry_S3nsit1ve"
uri
#=> #<URI::HTTP:0x00000000881d90 URL:http://john:V3ry_S3nsit1ve@my.example.com>
path=(v) Показать исходный код
# File lib/uri/generic.rb, line 815
def path=(v)
  check_path(v)
  set_path(v)
  v
end

Аргументы

v

Строка

Описание

Общедоступный метод установки компонента path v. (с валидацией).

См. также #check_path

Использование

require 'uri'

uri = URI.parse("http://my.example.com/pub/files")
uri.path = "/faq/"
# =>  "/faq/"
uri
#=> #<URI::HTTP:0x000000008e89e8 URL:http://my.example.com/faq/>
port=(v) Показать исходный код
# File lib/uri/generic.rb, line 727
def port=(v)
  check_port(v)
  set_port(v)
  port
end

Аргументы

v

Строка

Описание

Общедоступный метод установки компонента port v. (с валидацией).

См. также #check_port

Использование

require 'uri'

uri = URI.parse("http://my.example.com")
uri.port = 8080
# =>  8080
uri
#=> #<URI::HTTP:0x000000008e89e8 URL:http://my.example.com:8080>
query=(v) Показать исходный код
# File lib/uri/generic.rb, line 841
def query=(v)
  return @query = nil unless v
  raise InvalidURIError, "query conflicts with opaque" if @opaque

  x = v.to_str
  v = x.dup if x.equal? v
  v.encode!(Encoding::UTF_8) rescue nil
  v.delete!("\t\r\n")
  v.force_encoding(Encoding::ASCII_8BIT)
  v.gsub!(/(?!%\h\h|[!$-&(-;=?-_a-~])./n.freeze){'%%%02X' % $&.ord}
  v.force_encoding(Encoding::US_ASCII)
  @query = v
end

Аргументы

v

Строка

Описание

Общедоступный метод установки компонента query v.

Использование

require 'uri'

uri = URI.parse("http://my.example.com/?id=25")
uri.query = "id=1"
# =>  "id=1"
uri
#=> #<URI::HTTP:0x000000008e89e8 URL:http://my.example.com/?id=1>
registry=(v) Показать исходный код
# File lib/uri/generic.rb, line 743
def registry=(v)
  raise InvalidURIError, "can not set registry"
end
relative?() Показать исходный код
# File lib/uri/generic.rb, line 971
def relative?
  !absolute?
end

Проверяет, является ли URI относительным

route_from(oth) Показать исходный код
# File lib/uri/generic.rb, line 1250
def route_from(oth)
  # you can modify `rel', but can not `oth'.
  begin
    oth, rel = route_from0(oth)
  rescue
    raise $!.class, $!.message
  end
  if oth == rel
    return rel
  end

  rel.set_path(route_from_path(oth.path, self.path))
  if rel.path == './' && self.query
    # "./?foo" -> "?foo"
    rel.set_path('')
  end

  return rel
end

Аргументы

oth

URI или Строка

Описание

Вычисляет относительный путь от oth к self

Использование

require 'uri'

uri = URI.parse('http://my.example.com/main.rbx?page=1')
p uri.route_from('http://my.example.com')
#=> #<URI::Generic:0x20218858 URL:/main.rbx?page=1>
Также алиас: -
route_to(oth) Показать исходный код
# File lib/uri/generic.rb, line 1290
def route_to(oth)
  parser.send(:convert_to_uri, oth).route_from(self)
end

Аргументы

oth

URI или Строка

Описание

Вычисляет относительный путь к oth от self

Использование

require 'uri'

uri = URI.parse('http://my.example.com')
p uri.route_to('http://my.example.com/main.rbx?page=1')
#=> #<URI::Generic:0x2020c2f6 URL:/main.rbx?page=1>
scheme=(v) Показать исходный код
# File lib/uri/generic.rb, line 359
def scheme=(v)
  check_scheme(v)
  set_scheme(v)
  v
end

Аргументы

v

Строка

Описание

Общедоступный метод установки компонента scheme v. (с валидацией).

См. также #check_scheme

Использование

require 'uri'

uri = URI.parse("http://my.example.com")
uri.scheme = "https"
# =>  "https"
uri
#=> #<URI::HTTP:0x000000008e89e8 URL:https://my.example.com>
select(*components) Показать исходный код
# File lib/uri/generic.rb, line 1417
def select(*components)
  components.collect do |c|
    if component.include?(c)
      self.send(c)
    else
      raise ArgumentError,
        "expected of components of #{self.class} (#{self.class.component.join(', ')})"
    end
  end
end

Аргументы

components

Несколько аргументов типа Symbol, определённых в URI::HTTP

Описание

Выбирает указанные компоненты из URI

Использование

require 'uri'

uri = URI.parse('http://myuser:mypass@my.example.com/test.rbx')
p uri.select(:userinfo, :host, :path)
# => ["myuser:mypass", "my.example.com", "/test.rbx"]
to_s() Показать исходный код
# File lib/uri/generic.rb, line 1321
def to_s
  str = ''.dup
  if @scheme
    str << @scheme
    str << ':'
  end

  if @opaque
    str << @opaque
  else
    if @host
      str << '//'
    end
    if self.userinfo
      str << self.userinfo
      str << '@'
    end
    if @host
      str << @host
    end
    if @port && @port != self.default_port
      str << ':'
      str << @port.to_s
    end
    str << @path
    if @query
      str << '?'
      str << @query
    end
  end
  if @fragment
    str << '#'
    str << @fragment
  end
  str
end

Строит строку из URI

user() Показать исходный код
# File lib/uri/generic.rb, line 571
def user
  @user
end

Возвращает компонент user

user=(user) Показать исходный код
# File lib/uri/generic.rb, line 472
def user=(user)
  check_user(user)
  set_user(user)
  # returns user
end

Аргументы

v

Строка

Описание

Общедоступный метод установки компонента user. (с валидацией).

См. также #check_user

Использование

require 'uri'

uri = URI.parse("http://john:S3nsit1ve@my.example.com")
uri.user = "sam"
# =>  "sam"
uri
#=> #<URI::HTTP:0x00000000881d90 URL:http://sam:V3ry_S3nsit1ve@my.example.com>
userinfo() Показать исходный код
# File lib/uri/generic.rb, line 560
def userinfo
  if @user.nil?
    nil
  elsif @password.nil?
    @user
  else
    @user + ':' + @password
  end
end

Возвращает userinfo, либо как 'user', либо как 'user:password'

userinfo=(userinfo) Показать исходный код
# File lib/uri/generic.rb, line 440
def userinfo=(userinfo)
  if userinfo.nil?
    return nil
  end
  check_userinfo(*userinfo)
  set_userinfo(*userinfo)
  # returns userinfo
end

Устанавливает userinfo, аргумент – строка типа 'name:pass'

Защищённые методы экземпляра

component_ary() Показать исходный код
# File lib/uri/generic.rb, line 1393
def component_ary
  component.collect do |x|
    self.send(x)
  end
end

возвращает массив компонентов, определённых из массива COMPONENT

set_host(v) Показать исходный код
# File lib/uri/generic.rb, line 606
def set_host(v)
  @host = v
end

защищённый метод-сеттер для компонента хоста v

см. также #host=

set_opaque(v) Показать исходный код
# File lib/uri/generic.rb, line 884
def set_opaque(v)
  @opaque = v
end

защищённый метод-сеттер для компонента непрозрачности v

см. также #opaque=

set_password(v) Показать исходный код
# File lib/uri/generic.rb, line 537
def set_password(v)
  @password = v
  # returns v
end

защищённый метод-сеттер для компонента пароля v

см. также #password=

set_path(v) Показать исходный код
# File lib/uri/generic.rb, line 787
def set_path(v)
  @path = v
end

защищённый метод-сеттер для компонента пути v

см. также #path=

set_port(v) Показать исходный код
# File lib/uri/generic.rb, line 698
def set_port(v)
  v = v.empty? ? nil : v.to_i unless !v || v.kind_of?(Integer)
  @port = v
end

защищённый метод-сеттер для компонента порта v

см. также #port=

set_scheme(v) Показать исходный код
# File lib/uri/generic.rb, line 331
def set_scheme(v)
  @scheme = v&.downcase
end

защищённый метод-сеттер для компонента схемы v

см. также #scheme=

set_user(v) Показать исходный код
# File lib/uri/generic.rb, line 527
def set_user(v)
  set_userinfo(v, @password)
  v
end

защищённый метод-сеттер для компонента пользователя v

см. также #user=

set_userinfo(user, password = nil) Показать исходный код
# File lib/uri/generic.rb, line 512
def set_userinfo(user, password = nil)
  unless password
    user, password = split_userinfo(user)
  end
  @user     = user
  @password = password if password

  [@user, @password]
end

защищённый метод-сеттер для компонента user и password, если доступен. (с валидацией)

см. также #userinfo=

Методы частного экземпляра

check_host(v) Показать исходный код
# File lib/uri/generic.rb, line 587
def check_host(v)
  return v unless v

  if @opaque
    raise InvalidURIError,
      "can not set host with registry or opaque"
  elsif parser.regexp[:HOST] !~ v
    raise InvalidComponentError,
      "bad component(expected host component): #{v}"
  end

  return true
end

проверяет компонент хоста v на соответствие RFC2396 и по отношению к Regexp URI::Parser для :HOST

Не может иметь определённый компонент реестра или непрозрачный компонент, с определённым компонентом хоста.

check_opaque(v) Показать исходный код
# File lib/uri/generic.rb, line 862
def check_opaque(v)
  return v unless v

  # raise if both hier and opaque are not nil, because:
  # absoluteURI   = scheme ":" ( hier_part | opaque_part )
  # hier_part     = ( net_path | abs_path ) [ "?" query ]
  if @host || @port || @user || @path  # userinfo = @user + ':' + @password
    raise InvalidURIError,
      "can not set opaque with host, port, userinfo or path"
  elsif v && parser.regexp[:OPAQUE] !~ v
    raise InvalidComponentError,
      "bad component(expected opaque component): #{v}"
  end

  return true
end

проверяет непрозрачный v компонент на соответствие RFC2396 и по отношению к Regexp URI::Parser для :OPAQUE

Не может иметь определённый компонент хоста, порта, пользователя или пути, с определённым непрозрачным компонентом.

check_password(v, user = @user) Показать исходный код
# File lib/uri/generic.rb, line 416
def check_password(v, user = @user)
  if @opaque
    raise InvalidURIError,
      "can not set password with opaque"
  end
  return v unless v

  if !user
    raise InvalidURIError,
      "password component depends user component"
  end

  if parser.regexp[:USERINFO] !~ v
    raise InvalidComponentError,
      "bad password component"
  end

  return true
end

проверяет компонент пароля v на соответствие RFC2396 и по отношению к Regexp URI::Parser для :USERINFO

Не может иметь определённый компонент реестра или непрозрачный компонент, с определённым компонентом пользователя.

check_path(v) Показать исходный код
# File lib/uri/generic.rb, line 755
def check_path(v)
  # raise if both hier and opaque are not nil, because:
  # absoluteURI   = scheme ":" ( hier_part | opaque_part )
  # hier_part     = ( net_path | abs_path ) [ "?" query ]
  if v && @opaque
    raise InvalidURIError,
      "path conflicts with opaque"
  end

  # If scheme is ftp, path may be relative.
  # See RFC 1738 section 3.2.2, and RFC 2396.
  if @scheme && @scheme != "ftp"
    if v && v != '' && parser.regexp[:ABS_PATH] !~ v
      raise InvalidComponentError,
        "bad component(expected absolute path component): #{v}"
    end
  else
    if v && v != '' && parser.regexp[:ABS_PATH] !~ v &&
       parser.regexp[:REL_PATH] !~ v
      raise InvalidComponentError,
        "bad component(expected relative path component): #{v}"
    end
  end

  return true
end

проверяет компонент пути v на соответствие RFC2396 и по отношению к Regexp URI::Parser для :ABS_PATH и :REL_PATH

Не может иметь определённый непрозрачный компонент, с определённым компонентом пути.

check_port(v) Показать исходный код
# File lib/uri/generic.rb, line 679
def check_port(v)
  return v unless v

  if @opaque
    raise InvalidURIError,
      "can not set port with registry or opaque"
  elsif !v.kind_of?(Integer) && parser.regexp[:PORT] !~ v
    raise InvalidComponentError,
      "bad component(expected port component): #{v.inspect}"
  end

  return true
end

проверяет компонент порта v на соответствие RFC2396 и по отношению к Regexp URI::Parser для :PORT

Не может иметь определённый компонент реестра или непрозрачный компонент, с определённым компонентом порта.

check_scheme(v) Показать исходный код
# File lib/uri/generic.rb, line 317
def check_scheme(v)
  if v && parser.regexp[:SCHEME] !~ v
    raise InvalidComponentError,
      "bad component(expected scheme component): #{v}"
  end

  return true
end

проверяет компонент схемы v по отношению к Regexp URI::Parser для :SCHEME

check_user(v) Показать исходный код
# File lib/uri/generic.rb, line 392
def check_user(v)
  if @opaque
    raise InvalidURIError,
      "can not set user with opaque"
  end

  return v unless v

  if parser.regexp[:USERINFO] !~ v
    raise InvalidComponentError,
      "bad component(expected userinfo component or user component): #{v}"
  end

  return true
end

проверяет компонент пользователя v на соответствие RFC2396 и по отношению к Regexp URI::Parser для :USERINFO

Не может иметь определённый компонент реестра или непрозрачный компонент, с определённым компонентом пользователя.

check_userinfo(user, password = nil) Показать исходный код
# File lib/uri/generic.rb, line 374
def check_userinfo(user, password = nil)
  if !password
    user, password = split_userinfo(user)
  end
  check_user(user)
  check_password(password, user)

  return true
end

проверяет user и password.

Если password не предоставлен, то user разбивается с помощью #split_userinfo, чтобы извлечь user и +password.

см. также #check_user, #check_password

escape_userpass(v) Показать исходный код
# File lib/uri/generic.rb, line 554
def escape_userpass(v)
  parser.escape(v, /[@:\/]/o) # RFC 1738 section 3.1 #/
end

экранирует 'user:password' v на основе раздела 3.1 RFC 1738

merge_path(base, rel) Показать исходный код
# File lib/uri/generic.rb, line 987
def merge_path(base, rel)

  # RFC2396, Section 5.2, 5)
  # RFC2396, Section 5.2, 6)
  base_path = split_path(base)
  rel_path  = split_path(rel)

  # RFC2396, Section 5.2, 6), a)
  base_path << '' if base_path.last == '..'
  while i = base_path.index('..')
    base_path.slice!(i - 1, 2)
  end

  if (first = rel_path.first) and first.empty?
    base_path.clear
    rel_path.shift
  end

  # RFC2396, Section 5.2, 6), c)
  # RFC2396, Section 5.2, 6), d)
  rel_path.push('') if rel_path.last == '.' || rel_path.last == '..'
  rel_path.delete('.')

  # RFC2396, Section 5.2, 6), e)
  tmp = []
  rel_path.each do |x|
    if x == '..' &&
        !(tmp.empty? || tmp.last == '..')
      tmp.pop
    else
      tmp << x
    end
  end

  add_trailer_slash = !tmp.empty?
  if base_path.empty?
    base_path = [''] # keep '/' for root directory
  elsif add_trailer_slash
    base_path.pop
  end
  while x = tmp.shift
    if x == '..'
      # RFC2396, Section 4
      # a .. or . in an absolute path has no special meaning
      base_path.pop if base_path.size > 1
    else
      # if x == '..'
      #   valid absolute (but abnormal) path "/../..."
      # else
      #   valid absolute path
      # end
      base_path << x
      tmp.each {|t| base_path << t}
      add_trailer_slash = false
      break
    end
  end
  base_path.push('') if add_trailer_slash

  return base_path.join('/')
end

Объединяет базовый путь base, с относительным путём rel, возвращает изменённый базовый путь.

replace!(oth) Показать исходный код
# File lib/uri/generic.rb, line 296
def replace!(oth)
  if self.class != oth.class
    raise ArgumentError, "expected #{self.class} object"
  end

  component.each do |c|
    self.__send__("#{c}=", oth.__send__(c))
  end
end

заменяет себя другим объектом URI

split_path(path) Показать исходный код
# File lib/uri/generic.rb, line 978
def split_path(path)
  path.split(%r{/+}, -1)
end

возвращает массив, полученный из разделения пути на '/'

split_userinfo(ui) Показать исходный код
# File lib/uri/generic.rb, line 545
def split_userinfo(ui)
  return nil, nil unless ui
  user, password = ui.split(':', 2)

  return user, password
end

возвращает userinfo ui как user, password, если он должным образом отформатирован как 'user:password'

Ruby Core © 1993–2017 Yukihiro Matsumoto
Licensed under the Ruby License.
Ruby Standard Library © contributors
Licensed under their own licenses.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API