Class: Resolv::DNS::Name

Inherits:
Object
  • Object
show all
Defined in:
lib/resolv.rb

Overview

A representation of a DNS name.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(labels, absolute = true) ⇒ Name

:nodoc:



1096
1097
1098
1099
 
# File 'lib/resolv.rb', line 1096

def initialize(labels, absolute=true) # :nodoc:
  @labels = labels
  @absolute = absolute
end

Class Method Details

.create(arg) ⇒ Object

Creates a new DNS name from arg. arg can be:

Name

returns arg.

String

Creates a new Name.



1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
 
# File 'lib/resolv.rb', line 1085

def self.create(arg)
  case arg
  when Name
    return arg
  when String
    return Name.new(Label.split(arg), /\.\z/ =~ arg ? true : false)
  else
    raise ArgumentError.new("cannot interpret as DNS name: #{arg.inspect}")
  end
end

Instance Method Details

#==(other) ⇒ Object Also known as: eql?

:nodoc:



1112
1113
1114
1115
 
# File 'lib/resolv.rb', line 1112

def ==(other) # :nodoc:
  return false unless Name === other
  return @labels.join == other.to_a.join && @absolute == other.absolute?
end

#[](i) ⇒ Object

:nodoc:



1153
1154
1155
 
# File 'lib/resolv.rb', line 1153

def [](i) # :nodoc:
  return @labels[i]
end

#absolute? ⇒ Boolean

True if this name is absolute.

Returns:

  • (Boolean) 


1108
1109
1110
 
# File 'lib/resolv.rb', line 1108

def absolute?
  return @absolute
end

#hash ⇒ Object

:nodoc:



1141
1142
1143
 
# File 'lib/resolv.rb', line 1141

def hash # :nodoc:
  return @labels.hash ^ @absolute.hash
end

#inspect ⇒ Object

:nodoc:



1101
1102
1103
 
# File 'lib/resolv.rb', line 1101

def inspect # :nodoc:
  "#<#{self.class}: #{self.to_s}#{@absolute ? '.' : ''}>"
end

#length ⇒ Object

:nodoc:



1149
1150
1151
 
# File 'lib/resolv.rb', line 1149

def length # :nodoc:
  return @labels.length
end

#subdomain_of?(other) ⇒ Boolean

Returns true if other is a subdomain.

Example:

domain = Resolv::DNS::Name.create("y.z")
p Resolv::DNS::Name.create("w.x.y.z").subdomain_of?(domain) #=> true
p Resolv::DNS::Name.create("x.y.z").subdomain_of?(domain) #=> true
p Resolv::DNS::Name.create("y.z").subdomain_of?(domain) #=> false
p Resolv::DNS::Name.create("z").subdomain_of?(domain) #=> false
p Resolv::DNS::Name.create("x.y.z.").subdomain_of?(domain) #=> false
p Resolv::DNS::Name.create("w.z").subdomain_of?(domain) #=> false

Returns:

  • (Boolean)

Raises:

  • (ArgumentError) 


1133
1134
1135
1136
1137
1138
1139
 
# File 'lib/resolv.rb', line 1133

def subdomain_of?(other)
  raise ArgumentError, "not a domain name: #{other.inspect}" unless Name === other
  return false if @absolute != other.absolute?
  other_len = other.length
  return false if @labels.length <= other_len
  return @labels[-other_len, other_len] == other.to_a
end

#to_a ⇒ Object

:nodoc:



1145
1146
1147
 
# File 'lib/resolv.rb', line 1145

def to_a # :nodoc:
  return @labels
end

#to_s ⇒ Object

returns the domain name as a string.

The domain name doesn't have a trailing dot even if the name object is absolute.

Example:

p Resolv::DNS::Name.create("x.y.z.").to_s #=> "x.y.z"
p Resolv::DNS::Name.create("x.y.z").to_s #=> "x.y.z"



1168
1169
1170
 
# File 'lib/resolv.rb', line 1168

def to_s
  return @labels.join('.')
end