Class PublicSuffix::Domain
In: lib/public_suffix/domain.rb
Parent: Object

Methods

Public Class methods

Splits a string into its possible labels as a domain in reverse order from the input string.

The input is not validated, but it is assumed to be a valid domain.

@param [String, to_s] domain

  The domain name to split.

@return [Array<String>]

@example

  domain_to_labels('google.com')
  # => ['com', 'google']

  domain_to_labels('google.co.uk')
  # => ['uk', 'co', 'google']

Creates and returns a new {PublicSuffix::Domain} instance.

@overload initialize(tld)

  Initializes with a +tld+.
  @param [String] tld The TLD (extension)

@overload initialize(tld, sld)

  Initializes with a +tld+ and +sld+.
  @param [String] tld The TLD (extension)
  @param [String] sld The TRD (domain)

@overload initialize(tld, sld, trd)

  Initializes with a +tld+, +sld+ and +trd+.
  @param [String] tld The TLD (extension)
  @param [String] sld The SLD (domain)
  @param [String] tld The TRD (subdomain)

@yield [self] Yields on self. @yieldparam [PublicSuffix::Domain] self The newly creates instance

@example Initialize with a TLD

  PublicSuffix::Domain.new("com")
  # => #<PublicSuffix::Domain @tld="com">

@example Initialize with a TLD and SLD

  PublicSuffix::Domain.new("com", "example")
  # => #<PublicSuffix::Domain @tld="com", @trd=nil>

@example Initialize with a TLD, SLD and TRD

  PublicSuffix::Domain.new("com", "example", "wwww")
  # => #<PublicSuffix::Domain @tld="com", @trd=nil, @sld="example">

Public Instance methods

Returns a domain-like representation of this object if the object is a {domain?}, nil otherwise.

  PublicSuffix::Domain.new("com").domain
  # => nil

  PublicSuffix::Domain.new("com", "google").domain
  # => "google.com"

  PublicSuffix::Domain.new("com", "google", "www").domain
  # => "www.google.com"

This method doesn‘t validate the input. It handles the domain as a valid domain name and simply applies the necessary transformations.

  # This is an invalid domain
  PublicSuffix::Domain.new("zip", "google").domain
  # => "google.zip"

This method returns a FQD, not just the domain part. To get the domain part, use sld (aka second level domain).

  PublicSuffix::Domain.new("com", "google", "www").domain
  # => "google.com"

  PublicSuffix::Domain.new("com", "google", "www").sld
  # => "google"

@return [String]

@see domain? @see subdomain

Checks whether self looks like a domain.

This method doesn‘t actually validate the domain. It only checks whether the instance contains a value for the {tld} and {sld} attributes. If you also want to validate the domain, use {valid_domain?} instead.

@return [Boolean]

@example

  PublicSuffix::Domain.new("com").domain?
  # => false

  PublicSuffix::Domain.new("com", "google").domain?
  # => true

  PublicSuffix::Domain.new("com", "google", "www").domain?
  # => true

  # This is an invalid domain, but returns true
  # because this method doesn't validate the content.
  PublicSuffix::Domain.new("zip", "google").domain?
  # => true

@see subdomain?

Checks whether self is exclusively a domain, and not a subdomain.

@return [Boolean]

Checks whether self is exclusively a subdomain.

@return [Boolean]

Returns the full domain name.

@return [String]

@example Gets the domain name of a domain

  PublicSuffix::Domain.new("com", "google").name
  # => "google.com"

@example Gets the domain name of a subdomain

  PublicSuffix::Domain.new("com", "google", "www").name
  # => "www.google.com"

Returns the rule matching this domain in the default {PublicSuffix::List}.

@return [PublicSuffix::Rule::Base, nil]

  The rule instance a rule matches current domain,
  nil if no rule is found.

Returns the Second Level Domain part, aka the domain part.

@return [String, nil]

Returns a domain-like representation of this object if the object is a {subdomain?}, nil otherwise.

  PublicSuffix::Domain.new("com").subdomain
  # => nil

  PublicSuffix::Domain.new("com", "google").subdomain
  # => nil

  PublicSuffix::Domain.new("com", "google", "www").subdomain
  # => "www.google.com"

This method doesn‘t validate the input. It handles the domain as a valid domain name and simply applies the necessary transformations.

  # This is an invalid domain
  PublicSuffix::Domain.new("zip", "google", "www").subdomain
  # => "www.google.zip"

This method returns a FQD, not just the domain part. To get the domain part, use tld (aka third level domain).

  PublicSuffix::Domain.new("com", "google", "www").subdomain
  # => "www.google.com"

  PublicSuffix::Domain.new("com", "google", "www").trd
  # => "www"

@return [String]

@see subdomain? @see domain

Checks whether self looks like a subdomain.

This method doesn‘t actually validate the subdomain. It only checks whether the instance contains a value for the {tld}, {sld} and {trd} attributes. If you also want to validate the domain, use {valid_subdomain?} instead.

@return [Boolean]

@example

  PublicSuffix::Domain.new("com").subdomain?
  # => false

  PublicSuffix::Domain.new("com", "google").subdomain?
  # => false

  PublicSuffix::Domain.new("com", "google", "www").subdomain?
  # => true

  # This is an invalid domain, but returns true
  # because this method doesn't validate the content.
  PublicSuffix::Domain.new("zip", "google", "www").subdomain?
  # => true

@see domain?

Returns the Top Level Domain part, aka the extension.

@return [String, nil]

Returns an array containing the domain parts.

@return [Array<String, nil>]

@example

  PublicSuffix::Domain.new("google.com").to_a
  # => [nil, "google", "com"]

  PublicSuffix::Domain.new("www.google.com").to_a
  # => [nil, "google", "com"]

Returns a string representation of this object.

@return [String]

Returns the Third Level Domain part, aka the subdomain part.

@return [String, nil]

Checks whether self is assigned and allowed according to default {List}.

This method triggers a new rule lookup in the default {List}, which is a quite intensive task.

@return [Boolean]

@example Check a valid domain

  Domain.new("com", "example").valid?
  # => true

@example Check a valid subdomain

  Domain.new("com", "example", "www").valid?
  # => true

@example Check a not-assigned domain

  Domain.new("zip", "example").valid?
  # => false

@example Check a not-allowed domain

  Domain.new("do", "example").valid?
  # => false
  Domain.new("do", "example", "www").valid?
  # => true

Checks whether self looks like a domain and validates according to default {List}.

@return [Boolean]

@example

  PublicSuffix::Domain.new("com").domain?
  # => false

  PublicSuffix::Domain.new("com", "google").domain?
  # => true

  PublicSuffix::Domain.new("com", "google", "www").domain?
  # => true

  # This is an invalid domain
  PublicSuffix::Domain.new("zip", "google").false?
  # => true

@see domain? @see valid?

Checks whether self looks like a subdomain and validates according to default {List}.

@return [Boolean]

@example

  PublicSuffix::Domain.new("com").subdomain?
  # => false

  PublicSuffix::Domain.new("com", "google").subdomain?
  # => false

  PublicSuffix::Domain.new("com", "google", "www").subdomain?
  # => true

  # This is an invalid domain
  PublicSuffix::Domain.new("zip", "google", "www").subdomain?
  # => false

@see subdomain? @see valid?

[Validate]