public_suffix_service 0.6.0 → 0.7.0

data/lib/public_suffix_service/errors.rb

@@ -23,7 +23,16 @@ module PublicSuffixService
   # A domain is considered invalid when no rule is found
   # in the definition list.
   #
-  # Since 0.6.0
+  # @example
+  #
+  #   PublicSuffixService.parse("nic.test")
+  #   # => PublicSuffixService::DomainInvalid
+  #
+  #   PublicSuffixService.parse("http://www.nic.it")
+  #   # => PublicSuffixService::DomainInvalid
+  #
+  # @since 0.6.0
+  #
   class DomainInvalid < Error
   end
 
@@ -32,9 +41,7 @@ module PublicSuffixService
   # but the rules set a requirement which is not satisfied
   # by the input you are trying to parse.
   #
-  # Since 0.6.0
-  #
-  # Examples
+  # @example
   #
   #   PublicSuffixService.parse("nic.do")
   #   # => PublicSuffixService::DomainNotAllowed
@@ -42,11 +49,16 @@ module PublicSuffixService
   #   PublicSuffixService.parse("www.nic.do")
   #   # => PublicSuffixService::Domain
   #
+  # @since 0.6.0
+  #
   class DomainNotAllowed < DomainInvalid
   end
 
 
   # Backward Compatibility
+  #
+  # @deprecated Use {PublicSuffixService::DomainInvalid}.
+  #
   InvalidDomain = DomainInvalid
 
 end

data/lib/public_suffix_service/rule.rb

@@ -18,24 +18,26 @@ module PublicSuffixService
 
   class Rule
 
-    # Takes the <tt>name</tt> of the rule, detects the specific rule class
+    # Takes the +name+ of the rule, detects the specific rule class
     # and creates a new instance of that class.
-    # The <tt>name</tt> becomes the rule value.
+    # The +name+ becomes the rule +value+.
     #
-    # name - The String rule definition.
+    # @param  [String] name The rule definition.
     #
-    # Examples
+    # @return [PublicSuffixService::Rule::*] A rule instance.
     #
+    # @example Creates a Normal rule
     #   PublicSuffixService::Rule.factory("ar")
     #   # => #<PublicSuffixService::Rule::Normal>
     #
+    # @example Creates a Wildcard rule
     #   PublicSuffixService::Rule.factory("*.ar")
     #   # => #<PublicSuffixService::Rule::Wildcard>
     #
+    # @example Creates an Exception rule
     #   PublicSuffixService::Rule.factory("!congresodelalengua3.ar")
     #   # => #<PublicSuffixService::Rule::Exception>
     #
-    # Returns a rule instance, a kind of PublicSuffixService::Rule::Base.
     def self.factory(name)
       klass = case name.to_s[0..0]
         when "*"  then  "wildcard"
@@ -53,20 +55,20 @@ module PublicSuffixService
     # in the {Public Suffix List}[http://publicsuffix.org].
     # 
     # This is intended to be an Abstract class
-    # and you sholnd't create a direct instance. The only purpose
+    # and you shouldn't create a direct instance. The only purpose
     # of this class is to expose a common interface
     # for all the available subclasses.
     #
-    # * PublicSuffixService::Rule::Normal
-    # * PublicSuffixService::Rule::Exception
-    # * PublicSuffixService::Rule::Wildcard
+    # * {PublicSuffixService::Rule::Normal}
+    # * {PublicSuffixService::Rule::Exception}
+    # * {PublicSuffixService::Rule::Wildcard}
     #
     # == Properties
     #
     # A rule is composed by 4 properties:
     #
     # name    - The name of the rule, corresponding to the rule definition
-    #           in the public suffic list
+    #           in the public suffix list
     # value   - The value, a normalized version of the rule name.
     #           The normalization process depends on rule tpe.
     # type    - The rule type (:normal, :wildcard, :exception)
@@ -128,12 +130,20 @@ module PublicSuffixService
     #   rule.decompose("www.google.com")
     #   # => ["www.google", "com"]
     #
+    # @abstract
+    #
     class Base
 
       attr_reader :name, :value, :type, :labels
 
       # Initializes a new rule with name and value.
-      # If value is nil, name also becomes the value for this rule.
+      # If value is +nil+, name also becomes the value for this rule.
+      #
+      # @param [String] name
+      #   The name of the rule
+      # @param [String] value
+      #   The value of the rule. If nil, defaults to +name+.
+      #
       def initialize(name, value = nil)
         @name   = name.to_s
         @value  = value || @name
@@ -143,10 +153,12 @@ module PublicSuffixService
 
       # Checks whether this rule is equal to <tt>other</tt>.
       #
-      # other - The PublicSuffixService::Rule::Base to compare.
+      # @param [PublicSuffixService::Rule::*] other
+      #   The rule to compare.
       #
-      # Returns true if this rule and other are instances of the same class
-      # and has the same value, false otherwise.
+      # @return [Boolean]
+      #   Returns true if this rule and other are instances of the same class
+      #   and has the same value, false otherwise.
       def ==(other)
         return false unless other.is_a?(self.class)
         self.equal?(other) ||
@@ -155,32 +167,72 @@ module PublicSuffixService
       alias :eql? :==
 
 
-      # Checks whether this rule matches <tt>domain</tt>.
+      # Checks if this rule matches +domain+.
+      #
+      # @param [String, #to_s] domain
+      #   The domain name to check.
       #
-      # domain - The String domain name to check.
+      # @return [Boolean]
+      #
+      # @example
+      #   rule = Rule.factory("com")
+      #   # #<PublicSuffixService::Rule::Normal>
+      #   rule.match?("example.com")
+      #   # => true
+      #   rule.match?("example.net")
+      #   # => false
       #
-      # Returns Boolean.
       def match?(domain)
         l1 = labels
         l2 = Domain.domain_to_labels(domain)
         odiff(l1, l2).empty?
       end
 
+      # Checks if this rule allows +domain+.
+      #
+      # @param [String, #to_s] domain
+      #   The domain name to check.
+      #
+      # @return [Boolean]
+      #
+      # @example
+      #   rule = Rule.factory("*.do")
+      #   # #<PublicSuffixService::Rule::Wildcard>
+      #   rule.allow?("example.do")
+      #   # => false
+      #   rule.allow?("www.example.do")
+      #   # => true
+      #
+      def allow?(domain)
+        !decompose(domain).last.nil?
+      end
+
+
       # Gets the length of this rule for comparison.
-      # The length usually matches the number of rule <tt>parts</tt>.
+      # The length usually matches the number of rule +parts+.
+      #
       # Subclasses might actually override this method.
       #
-      # Returns an Integer with the number of parts.
+      # @return [Integer] The number of parts.
       def length
         parts.length
       end
 
-      # Raises NotImplementedError.
+      #
+      # @raise  [NotImplementedError]
+      # @abstract
       def parts
         raise NotImplementedError
       end
 
-      # Raises NotImplementedError.
+      #
+      # @param [String, #to_s] domain
+      #   The domain name to decompose.
+      #
+      # @return [Array<String, nil>]
+      #
+      # @raise  [NotImplementedError]
+      # @abstract
       def decompose(domain)
         raise NotImplementedError
       end
@@ -188,7 +240,6 @@ module PublicSuffixService
 
       private
 
-
         def odiff(one, two)
           ii = 0
           while(ii < one.size && one[ii] == two[ii])
@@ -201,6 +252,11 @@ module PublicSuffixService
 
     class Normal < Base
 
+      # Initializes a new rule with +name+.
+      #
+      # @param [String] name
+      #   The name of this rule.
+      #
       def initialize(name)
         super(name, name)
       end
@@ -208,16 +264,19 @@ module PublicSuffixService
       # dot-split rule value and returns all rule parts
       # in the order they appear in the value.
       #
-      # Returns an Array with the domain parts.
+      # @return [Array<String>]
       def parts
         @parts ||= @value.split(".")
       end
 
       # Decomposes the domain according to rule properties.
       #
-      # domain - The String domain name to parse.
+      # @param [String, #to_s] domain
+      #   The domain name to decompose.
+      #
+      # @return [Array<String>]
+      #   The array with [trd + sld, tld].
       #
-      # Return an Array with [trd + sld, tld].
       def decompose(domain)
         domain.to_s =~ /^(.*)\.(#{parts.join('\.')})$/
         [$1, $2]
@@ -227,6 +286,11 @@ module PublicSuffixService
 
     class Wildcard < Base
 
+      # Initializes a new rule with +name+.
+      #
+      # @param [String] name
+      #   The name of this rule.
+      #
       def initialize(name)
         super(name, name.to_s[2..-1])
       end
@@ -234,20 +298,27 @@ module PublicSuffixService
       # dot-split rule value and returns all rule parts
       # in the order they appear in the value.
       #
-      # Returns an Array with the domain parts.
+      # @return [Array<String>]
       def parts
         @parts ||= @value.split(".")
       end
 
+      # Overwrites the default implementation to cope with
+      # the +*+ char.
+      #
+      # @return [Integer] The number of parts.
       def length
         parts.length + 1 # * counts as 1
       end
 
       # Decomposes the domain according to rule properties.
       #
-      # domain - The String domain name to parse.
+      # @param [String, #to_s] domain
+      #   The domain name to decompose.
+      #
+      # @return [Array<String>]
+      #   The array with [trd + sld, tld].
       #
-      # Return an Array with [trd + sld, tld].
       def decompose(domain)
         domain.to_s =~ /^(.*)\.(.*?\.#{parts.join('\.')})$/
         [$1, $2]
@@ -257,6 +328,10 @@ module PublicSuffixService
 
     class Exception < Base
 
+      # Initializes a new rule with +name+.
+      #
+      # @param  [String] name   The name of this rule.
+      #
       def initialize(name)
         super(name, name.to_s[1..-1])
       end
@@ -269,16 +344,19 @@ module PublicSuffixService
       # If the prevailing rule is a exception rule,
       # modify it by removing the leftmost label. 
       #
-      # Returns an Array with the domain parts.
+      # @return [Array<String>]
       def parts
         @parts ||= @value.split(".")[1..-1]
       end
 
       # Decomposes the domain according to rule properties.
       #
-      # domain - The String domain name to parse.
+      # @param [String, #to_s] domain
+      #   The domain name to decompose.
+      #
+      # @return [Array<String>]
+      #   The array with [trd + sld, tld].
       #
-      # Return an Array with [trd + sld, tld].
       def decompose(domain)
         domain.to_s =~ /^(.*)\.(#{parts.join('\.')})$/
         [$1, $2]

data/lib/public_suffix_service/rule_list.rb

@@ -16,11 +16,11 @@
 
 module PublicSuffixService
 
-  # = Rule List
+  # A {PublicSuffixService::RuleList} is a collection of one
+  # or more {PublicSuffixService::Rule}.
   #
-  # A PublicSuffixService::RuleList is a collection of one or more PublicSuffixService::Rule.
-  #
-  # Given a RuleList, you can add or remove PublicSuffixService::Rule,
+  # Given a {PublicSuffixService::RuleList},
+  # you can add or remove {PublicSuffixService::Rule},
   # iterate all items in the list or search for the first rule
   # which matches a specific domain name.
   #
@@ -41,47 +41,48 @@ module PublicSuffixService
   #   list.find("example.org")
   #   # => nil
   #
-  # You can create as many PublicSuffixService::RuleList you want.
-  # The PublicSuffixService::RuleList.default rule list is used by DomainName
+  # You can create as many {PublicSuffixService::RuleList} you want.
+  # The {PublicSuffixService::RuleList.default} rule list is used
   # to tokenize and validate a domain.
   #
-  # PublicSuffixService::RuleList implements Enumerable module.
+  # {PublicSuffixService::RuleList} implements +Enumerable+ module.
   #
   class RuleList
     include Enumerable
 
     # Gets the list of rules.
     #
-    # Returns the Array of rule instances.
-    # Each rule is an instance of the proper corresponding of
-    # PublicSuffixService::Rule::Base.
+    # @return [Array<PublicSuffixService::Rule::*>]
     attr_reader :list
 
     # Gets the naive index, a hash that with the keys being the first label of
     # every rule pointing to an array of integers (indexes of the rules in @list)
-    attr_reader  :indexes
+    #
+    # @return [Array]
+    attr_reader :indexes
 
 
-    # Initializes an empty PublicSuffixService::RuleList.
-    # If block is given, yields on self.
-    def initialize(&block) # :yields: self
+    # Initializes an empty {PublicSuffixService::RuleList}.
+    #
+    # @yield [self] Yields on self.
+    # @yieldparam [PublicSuffixService::RuleList] self The newly creates instance
+    #
+    def initialize(&block)
       @list    = []
       @indexes = {}
       yield(self) if block_given?
       create_index!
     end
 
-    # Creates a naive index for @list. Just a hash that will tell
-    # us where the elements of @list are relative to its first
-    # Rule#labels element.
+    # Creates a naive index for +@list+. Just a hash that will tell
+    # us where the elements of +@list+ are relative to its first
+    # {PublicSuffixService::Rule::Base#labels} element.
     #
     # For instance if @list[5] and @list[4] are the only elements of the list
     # where Rule#labels.first is 'us' @indexes['us'] #=> [5,4], that way in 
     # select we can avoid mapping every single rule against the candidate domain.
-    #
-    # Returns nothing.
     def create_index!
-      @list.map{|l| l.labels.first }.each_with_index do |elm, inx|
+      @list.map { |l| l.labels.first }.each_with_index do |elm, inx|
         if !@indexes.has_key?(elm)
           @indexes[elm] = [inx]
         else
@@ -91,14 +92,16 @@ module PublicSuffixService
     end
 
     # Checks whether two lists are equal.
+    #
     # RuleList <tt>one</tt> is equal to <tt>two</tt>, if <tt>two</tt> is an instance of 
-    # <tt>PublicSuffixService::RuleList</tt> and each <tt>PublicSuffixService::Rule::Base</tt>
+    # {PublicSuffixService::RuleList} and each +PublicSuffixService::Rule::*+
     # in list <tt>one</tt> is available in list <tt>two</tt>,
     # in the same order.
     #
-    # other - The PublicSuffixService::RuleList to compare.
+    # @param [PublicSuffixService::RuleList] other
+    #   The rule list to compare.
     #
-    # Returns true if self is equal to other.
+    # @return [Boolean]
     def ==(other)
       return false unless other.is_a?(RuleList)
       self.equal?(other) ||
@@ -107,34 +110,40 @@ module PublicSuffixService
     alias :eql? :==
 
     # Iterates each rule in the list.
-    #
-    # Returns nothing.
     def each(*args, &block)
       @list.each(*args, &block)
     end
 
-    # Gets the list as Array.
+    # Gets the list as array.
     #
-    # Return an Array.
+    # @return [Array<PublicSuffixService::Rule::*>]
     def to_a
       @list
     end
 
-    # Adds the given object to the list.
+    # Adds the given object to the list
+    # and optionally refreshes the rule index.
     #
-    # rule - The rule to add to the list. 
-    #        Expected to be a subclass of PublicSuffixService::Rule::Base.
+    # @param [PublicSuffixService::Rule::*] rule
+    #   The rule to add to the list.
+    # @param [Boolean] index
+    #   Set to true to recreate the rule index
+    #   after the rule has been added to the list.
     #
-    # Returns self.
-    def add(rule)
+    # @return [self]
+    #
+    # @see #create_index!
+    #
+    def add(rule, index = true)
       @list << rule
+      create_index! if index == true
       self
     end
     alias << add
 
     # Gets the number of elements in the list.
     #
-    # Returns an Integer.
+    # @return [Integer]
     def size
       @list.size
     end
@@ -142,14 +151,14 @@ module PublicSuffixService
 
     # Checks whether the list is empty.
     #
-    # Returns true if the list contains no elements.
+    # @return [Boolean]
     def empty?
       @list.empty?
     end
 
     # Removes all elements.
     #
-    # Returns self.
+    # @return [self]
     def clear
       @list.clear
       self
@@ -176,9 +185,7 @@ module PublicSuffixService
     #   which directly match the labels of the prevailing rule (joined by dots).
     # * The registered domain is the public suffix plus one additional label.
     #
-    # Note: This might not be the most efficient algorithm.
-    #
-    # Returns a PublicSuffixService::Rule::Base instance or nil.
+    # @return [PublicSuffixService::Rule::*, nil]
     def find(domain)
       rules = select(domain)
       rules.select { |r|   r.type == :exception }.first ||
@@ -187,14 +194,14 @@ module PublicSuffixService
 
     # Selects all the rules matching given domain.
     #
-    # Will use @indexes to try only the rules that share the same first label,
-    # that will speed up things when using RuleList.find('foo') a lot.
+    # Will use +@indexes+ to try only the rules that share the same first label,
+    # that will speed up things when using +RuleList.find('foo')+ a lot.
     #
-    # Returns an Array of rule instances.
-    # Each rule is an instance of the corresponding subclass of
-    # PublicSuffixService::Rule::Base.
+    # @param  [String, #to_s] domain The domain name.
+    #
+    # @return [Array<PublicSuffixService::Rule::*>]
     def select(domain)
-      indices = (@indexes[ Domain.domain_to_labels(domain).first ] || [])
+      indices = (@indexes[Domain.domain_to_labels(domain).first] || [])
       @list.values_at(*indices).select { |rule| rule.match?(domain) }
     end
 
@@ -203,36 +210,37 @@ module PublicSuffixService
 
     class << self
 
-      # Gets the default PublicSuffixService::RuleList.
-      # Initializes a new PublicSuffixService::RuleList parsing the content
-      # of PublicSuffixService::RuleList.default_definition, if required.
+      # Gets the default rule list.
+      # Initializes a new {PublicSuffixService::RuleList} parsing the content
+      # of {PublicSuffixService::RuleList.default_definition}, if required.
       #
-      # Returns a PublicSuffixService::RuleList.
+      # @return [PublicSuffixService::RuleList]
       def default
         @@default ||= parse(default_definition)
       end
 
-      # Sets the default <tt>PublicSuffixService::RuleList</tt> to <tt>value</tt>.
+      # Sets the default rule list to +value+.
       #
-      # value - The new PublicSuffixService::RuleList.
+      # @param [PublicSuffixService::RuleList] value
+      #   The new rule list.
       #
-      # Returns the PublicSuffixService::RuleList.
+      # @return [PublicSuffixService::RuleList]
       def default=(value)
         @@default = value
       end
 
-      # Sets the default PublicSuffixService::RuleList to nil.
+      # Sets the default rule list to +nil+.
       #
-      # Returns self.
+      # @return [self]
       def clear
         self.default = nil
         self
       end
 
-      # Resets the default <tt>PublicSuffixService::RuleList</tt> and reinitialize it
-      # parsing the content of <tt>PublicSuffixService::RuleList.default_definition</tt>.
+      # Resets the default rule list and reinitialize it
+      # parsing the content of {PublicSuffixService::RuleList.default_definition}.
       #
-      # Returns a PublicSuffixService::RuleList.
+      # @return [PublicSuffixService::RuleList]
       def reload
         self.clear.default
       end
@@ -242,18 +250,19 @@ module PublicSuffixService
       # or a simple <tt>String</tt>.
       # The object must respond to <tt>#each_line</tt>.
       #
-      # Returns a File.
+      # @return [File]
       def default_definition
         File.new(File.join(File.dirname(__FILE__), "definitions.dat"))
       end
 
 
-      # Parse given <tt>input</tt> treating the content as Public Suffic List.
+      # Parse given +input+ treating the content as Public Suffix List.
+      #
       # See http://publicsuffix.org/format/ for more details about input format.
       #
-      # Returns an Array of rule instances.
-      # Each rule is an instance of the corresponding subclass of
-      # PublicSuffixService::Rule::Base.
+      # @param [String] input The rule list to parse.
+      #
+      # @return [Array<PublicSuffixService::Rule::*>]
       def parse(input)
         new do |list|
           input.each_line do |line|
@@ -267,7 +276,7 @@ module PublicSuffixService
               next
             # append rule
             else
-              list << Rule.factory(line)
+              list.add(Rule.factory(line), false)
             end
           end
         end