public_suffix_service 0.9.0 → 0.9.1

data/lib/{public_suffix_service → public_suffix}/errors.rb

@@ -1,13 +1,13 @@
 #--
-# Public Suffix Service
+# Public Suffix
 #
-# Domain Name parser based on the Public Suffix List.
+# Domain name parser based on the Public Suffix List.
 #
 # Copyright (c) 2009-2011 Simone Carletti <weppos@weppos.net>
 #++
 
 
-module PublicSuffixService
+module PublicSuffix
 
   class Error < StandardError
   end
@@ -18,11 +18,11 @@ module PublicSuffixService
   #
   # @example
   #
-  #   PublicSuffixService.parse("nic.test")
-  #   # => PublicSuffixService::DomainInvalid
+  #   PublicSuffix.parse("nic.test")
+  #   # => PublicSuffix::DomainInvalid
   #
-  #   PublicSuffixService.parse("http://www.nic.it")
-  #   # => PublicSuffixService::DomainInvalid
+  #   PublicSuffix.parse("http://www.nic.it")
+  #   # => PublicSuffix::DomainInvalid
   #
   # @since 0.6.0
   #
@@ -36,11 +36,11 @@ module PublicSuffixService
   #
   # @example
   #
-  #   PublicSuffixService.parse("nic.do")
-  #   # => PublicSuffixService::DomainNotAllowed
+  #   PublicSuffix.parse("nic.do")
+  #   # => PublicSuffix::DomainNotAllowed
   #
-  #   PublicSuffixService.parse("www.nic.do")
-  #   # => PublicSuffixService::Domain
+  #   PublicSuffix.parse("www.nic.do")
+  #   # => PublicSuffix::Domain
   #
   # @since 0.6.0
   #
@@ -50,7 +50,7 @@ module PublicSuffixService
 
   # Backward Compatibility
   #
-  # @deprecated Use {PublicSuffixService::DomainInvalid}.
+  # @deprecated Use {PublicSuffix::DomainInvalid}.
   #
   InvalidDomain = DomainInvalid
 

data/lib/{public_suffix_service/rule_list.rb → public_suffix/list.rb}

@@ -1,28 +1,28 @@
 #--
-# Public Suffix Service
+# Public Suffix
 #
-# Domain Name parser based on the Public Suffix List.
+# Domain name parser based on the Public Suffix List.
 #
 # Copyright (c) 2009-2011 Simone Carletti <weppos@weppos.net>
 #++
 
 
-module PublicSuffixService
+module PublicSuffix
 
-  # A {PublicSuffixService::RuleList} is a collection of one
-  # or more {PublicSuffixService::Rule}.
+  # A {PublicSuffix::List} is a collection of one
+  # or more {PublicSuffix::Rule}.
   #
-  # Given a {PublicSuffixService::RuleList},
-  # you can add or remove {PublicSuffixService::Rule},
+  # Given a {PublicSuffix::List},
+  # you can add or remove {PublicSuffix::Rule},
   # iterate all items in the list or search for the first rule
   # which matches a specific domain name.
   #
   #   # Create a new list
-  #   list =  PublicSuffixService::RuleList.new
+  #   list =  PublicSuffix::List.new
   #
   #   # Push two rules to the list
-  #   list << PublicSuffixService::Rule.factory("it")
-  #   list << PublicSuffixService::Rule.factory("com")
+  #   list << PublicSuffix::Rule.factory("it")
+  #   list << PublicSuffix::Rule.factory("com")
   #
   #   # Get the size of the list
   #   list.size
@@ -30,52 +30,52 @@ module PublicSuffixService
   #
   #   # Search for the rule matching given domain
   #   list.find("example.com")
-  #   # => #<PublicSuffixService::Rule::Normal>
+  #   # => #<PublicSuffix::Rule::Normal>
   #   list.find("example.org")
   #   # => nil
   #
-  # You can create as many {PublicSuffixService::RuleList} you want.
-  # The {PublicSuffixService::RuleList.default} rule list is used
+  # You can create as many {PublicSuffix::List} you want.
+  # The {PublicSuffix::List.default} rule list is used
   # to tokenize and validate a domain.
   #
-  # {PublicSuffixService::RuleList} implements +Enumerable+ module.
+  # {PublicSuffix::List} implements +Enumerable+ module.
   #
-  class RuleList
+  class List
     include Enumerable
 
-    # Gets the list of rules.
+    # Gets the array of rules.
     #
-    # @return [Array<PublicSuffixService::Rule::*>]
-    attr_reader :list
+    # @return [Array<PublicSuffix::Rule::*>]
+    attr_reader :rules
 
     # 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)
+    # every rule pointing to an array of integers (indexes of the rules in @rules).
     #
     # @return [Array]
     attr_reader :indexes
 
 
-    # Initializes an empty {PublicSuffixService::RuleList}.
+    # Initializes an empty {PublicSuffix::List}.
     #
     # @yield [self] Yields on self.
-    # @yieldparam [PublicSuffixService::RuleList] self The newly creates instance
+    # @yieldparam [PublicSuffix::List] self The newly created instance.
     #
     def initialize(&block)
-      @list    = []
+      @rules   = []
       @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
-    # {PublicSuffixService::Rule::Base#labels} element.
+    # Creates a naive index for +@rules+. Just a hash that will tell
+    # us where the elements of +@rules+ are relative to its first
+    # {PublicSuffix::Rule::Base#labels} element.
     #
-    # For instance if @list[5] and @list[4] are the only elements of the list
+    # For instance if @rules[5] and @rules[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.
     def create_index!
-      @list.map { |l| l.labels.first }.each_with_index do |elm, inx|
+      @rules.map { |l| l.labels.first }.each_with_index do |elm, inx|
         if !@indexes.has_key?(elm)
           @indexes[elm] = [inx]
         else
@@ -86,38 +86,37 @@ module PublicSuffixService
 
     # Checks whether two lists are equal.
     #
-    # RuleList <tt>one</tt> is equal to <tt>two</tt>, if <tt>two</tt> is an instance of 
-    # {PublicSuffixService::RuleList} and each +PublicSuffixService::Rule::*+
-    # in list <tt>one</tt> is available in list <tt>two</tt>,
-    # in the same order.
+    # List <tt>one</tt> is equal to <tt>two</tt>, if <tt>two</tt> is an instance of
+    # {PublicSuffix::List} and each +PublicSuffix::Rule::*+
+    # in list <tt>one</tt> is available in list <tt>two</tt>, in the same order.
     #
-    # @param [PublicSuffixService::RuleList] other
-    #   The rule list to compare.
+    # @param [PublicSuffix::List] other
+    #   The List to compare.
     #
     # @return [Boolean]
     def ==(other)
-      return false unless other.is_a?(RuleList)
+      return false unless other.is_a?(List)
       self.equal?(other) ||
-      self.list == other.list
+      self.rules == other.rules
     end
     alias :eql? :==
 
     # Iterates each rule in the list.
     def each(*args, &block)
-      @list.each(*args, &block)
+      @rules.each(*args, &block)
     end
 
     # Gets the list as array.
     #
-    # @return [Array<PublicSuffixService::Rule::*>]
+    # @return [Array<PublicSuffix::Rule::*>]
     def to_a
-      @list
+      @rules
     end
 
     # Adds the given object to the list
     # and optionally refreshes the rule index.
     #
-    # @param [PublicSuffixService::Rule::*] rule
+    # @param [PublicSuffix::Rule::*] rule
     #   The rule to add to the list.
     # @param [Boolean] index
     #   Set to true to recreate the rule index
@@ -128,7 +127,7 @@ module PublicSuffixService
     # @see #create_index!
     #
     def add(rule, index = true)
-      @list << rule
+      @rules << rule
       create_index! if index == true
       self
     end
@@ -138,7 +137,7 @@ module PublicSuffixService
     #
     # @return [Integer]
     def size
-      @list.size
+      @rules.size
     end
     alias length size
 
@@ -146,14 +145,14 @@ module PublicSuffixService
     #
     # @return [Boolean]
     def empty?
-      @list.empty?
+      @rules.empty?
     end
 
     # Removes all elements.
     #
     # @return [self]
     def clear
-      @list.clear
+      @rules.clear
       self
     end
 
@@ -180,7 +179,7 @@ module PublicSuffixService
     #
     # @param  [String, #to_s] domain The domain name.
     #
-    # @return [PublicSuffixService::Rule::*, nil]
+    # @return [PublicSuffix::Rule::*, nil]
     def find(domain)
       rules = select(domain)
       rules.select { |r|   r.type == :exception }.first ||
@@ -190,14 +189,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.
+    # that will speed up things when using +List.find('foo')+ a lot.
     #
     # @param  [String, #to_s] domain The domain name.
     #
-    # @return [Array<PublicSuffixService::Rule::*>]
+    # @return [Array<PublicSuffix::Rule::*>]
     def select(domain)
       indices = (@indexes[Domain.domain_to_labels(domain).first] || [])
-      @list.values_at(*indices).select { |rule| rule.match?(domain) }
+      @rules.values_at(*indices).select { |rule| rule.match?(domain) }
     end
 
 
@@ -206,20 +205,20 @@ module PublicSuffixService
     class << self
 
       # Gets the default rule list.
-      # Initializes a new {PublicSuffixService::RuleList} parsing the content
-      # of {PublicSuffixService::RuleList.default_definition}, if required.
+      # Initializes a new {PublicSuffix::List} parsing the content
+      # of {PublicSuffix::List.default_definition}, if required.
       #
-      # @return [PublicSuffixService::RuleList]
+      # @return [PublicSuffix::List]
       def default
         @@default ||= parse(default_definition)
       end
 
       # Sets the default rule list to +value+.
       #
-      # @param [PublicSuffixService::RuleList] value
+      # @param [PublicSuffix::List] value
       #   The new rule list.
       #
-      # @return [PublicSuffixService::RuleList]
+      # @return [PublicSuffix::List]
       def default=(value)
         @@default = value
       end
@@ -233,9 +232,9 @@ module PublicSuffixService
       end
 
       # Resets the default rule list and reinitialize it
-      # parsing the content of {PublicSuffixService::RuleList.default_definition}.
+      # parsing the content of {PublicSuffix::List.default_definition}.
       #
-      # @return [PublicSuffixService::RuleList]
+      # @return [PublicSuffix::List]
       def reload
         self.clear.default
       end
@@ -257,7 +256,7 @@ module PublicSuffixService
       #
       # @param [String] input The rule list to parse.
       #
-      # @return [Array<PublicSuffixService::Rule::*>]
+      # @return [Array<PublicSuffix::Rule::*>]
       def parse(input)
         new do |list|
           input.each_line do |line|

data/lib/{public_suffix_service → public_suffix}/rule.rb

@@ -1,24 +1,24 @@
 #--
-# Public Suffix Service
+# Public Suffix
 #
-# Domain Name parser based on the Public Suffix List.
+# Domain name parser based on the Public Suffix List.
 #
 # Copyright (c) 2009-2011 Simone Carletti <weppos@weppos.net>
 #++
 
 
-module PublicSuffixService
+module PublicSuffix
 
   # A Rule is a special object which holds a single definition
   # of the Public Suffix List.
   #
   # There are 3 types of ruleas, each one represented by a specific
-  # subclass within the +PublicSuffixService::Rule+ namespace.
+  # subclass within the +PublicSuffix::Rule+ namespace.
   #
-  # To create a new Rule, use the {PublicSuffixService::Rule#factory} method.
+  # To create a new Rule, use the {PublicSuffix::Rule#factory} method.
   #
-  #   PublicSuffixService::Rule.factory("ar")
-  #   # => #<PublicSuffixService::Rule::Normal>
+  #   PublicSuffix::Rule.factory("ar")
+  #   # => #<PublicSuffix::Rule::Normal>
   #
   class Rule
 
@@ -28,19 +28,19 @@ module PublicSuffixService
     #
     # @param  [String] name The rule definition.
     #
-    # @return [PublicSuffixService::Rule::*] A rule instance.
+    # @return [PublicSuffix::Rule::*] A rule instance.
     #
     # @example Creates a Normal rule
-    #   PublicSuffixService::Rule.factory("ar")
-    #   # => #<PublicSuffixService::Rule::Normal>
+    #   PublicSuffix::Rule.factory("ar")
+    #   # => #<PublicSuffix::Rule::Normal>
     #
     # @example Creates a Wildcard rule
-    #   PublicSuffixService::Rule.factory("*.ar")
-    #   # => #<PublicSuffixService::Rule::Wildcard>
+    #   PublicSuffix::Rule.factory("*.ar")
+    #   # => #<PublicSuffix::Rule::Wildcard>
     #
     # @example Creates an Exception rule
-    #   PublicSuffixService::Rule.factory("!congresodelalengua3.ar")
-    #   # => #<PublicSuffixService::Rule::Exception>
+    #   PublicSuffix::Rule.factory("!congresodelalengua3.ar")
+    #   # => #<PublicSuffix::Rule::Exception>
     #
     def self.factory(name)
       klass = case name.to_s[0..0]
@@ -63,9 +63,9 @@ module PublicSuffixService
     # of this class is to expose a common interface
     # for all the available subclasses.
     #
-    # * {PublicSuffixService::Rule::Normal}
-    # * {PublicSuffixService::Rule::Exception}
-    # * {PublicSuffixService::Rule::Wildcard}
+    # * {PublicSuffix::Rule::Normal}
+    # * {PublicSuffix::Rule::Exception}
+    # * {PublicSuffix::Rule::Wildcard}
     #
     # == Properties
     #
@@ -80,8 +80,8 @@ module PublicSuffixService
     #
     # Here's an example
     #
-    #   PublicSuffixService::Rule.factory("*.google.com")
-    #   #<PublicSuffixService::Rule::Wildcard:0x1015c14b0 
+    #   PublicSuffix::Rule.factory("*.google.com")
+    #   #<PublicSuffix::Rule::Wildcard:0x1015c14b0
     #       @labels=["com", "google"],
     #       @name="*.google.com",
     #       @type=:wildcard,
@@ -91,13 +91,13 @@ module PublicSuffixService
     # == Rule Creation
     #
     # The best way to create a new rule is passing the rule name
-    # to the <tt>PublicSuffixService::Rule.factory</tt> method.
+    # to the <tt>PublicSuffix::Rule.factory</tt> method.
     #
-    #   PublicSuffixService::Rule.factory("com")
-    #   # => PublicSuffixService::Rule::Normal
+    #   PublicSuffix::Rule.factory("com")
+    #   # => PublicSuffix::Rule::Normal
     #
-    #   PublicSuffixService::Rule.factory("*.com")
-    #   # => PublicSuffixService::Rule::Wildcard
+    #   PublicSuffix::Rule.factory("*.com")
+    #   # => PublicSuffix::Rule::Wildcard
     #
     # This method will detect the rule type and create an instance
     # from the proper rule class.
@@ -112,7 +112,7 @@ module PublicSuffixService
     # can be handled by the current rule.
     # You can use the <tt>#match?</tt> method.
     #
-    #   rule = PublicSuffixService::Rule.factory("com")
+    #   rule = PublicSuffix::Rule.factory("com")
     #   
     #   rule.match?("google.com")
     #   # => true
@@ -126,7 +126,7 @@ module PublicSuffixService
     #
     # When you have the right rule, you can use it to tokenize the domain name.
     # 
-    #   rule = PublicSuffixService::Rule.factory("com")
+    #   rule = PublicSuffix::Rule.factory("com")
     # 
     #   rule.decompose("google.com")
     #   # => ["google", "com"]
@@ -157,7 +157,7 @@ module PublicSuffixService
 
       # Checks whether this rule is equal to <tt>other</tt>.
       #
-      # @param [PublicSuffixService::Rule::*] other
+      # @param [PublicSuffix::Rule::*] other
       #   The rule to compare.
       #
       # @return [Boolean]
@@ -180,7 +180,7 @@ module PublicSuffixService
       #
       # @example
       #   rule = Rule.factory("com")
-      #   # #<PublicSuffixService::Rule::Normal>
+      #   # #<PublicSuffix::Rule::Normal>
       #   rule.match?("example.com")
       #   # => true
       #   rule.match?("example.net")
@@ -201,7 +201,7 @@ module PublicSuffixService
       #
       # @example
       #   rule = Rule.factory("*.do")
-      #   # => #<PublicSuffixService::Rule::Wildcard>
+      #   # => #<PublicSuffix::Rule::Wildcard>
       #   rule.allow?("example.do")
       #   # => false
       #   rule.allow?("www.example.do")