public_suffix_service 0.4.0 → 0.5.0

data/CHANGELOG.rdoc

@@ -1,6 +1,13 @@
 = Changelog
 
 
+== Release 0.5.0
+
+* CHANGED: Improve documentation for Domain#domain and Domain#subdomain (#1).
+
+* CHANGED: Performance improvements (#2).
+
+
 == Release 0.4.0
 
 * CHANGED: Rename library from DomainName to PublicSuffixService to reduce the probability of name conflicts.

data/README.rdoc

@@ -1,13 +1,13 @@
 = Public Suffix Service
 
-Public Suffix Service is a Ruby domain name parser based on the Public Suffix List available at http://publicsuffix.org.
+*Public Suffix Service* is a Ruby domain name parser based on the {Public Suffix List}[http://publicsuffix.org].
 
 
 == What is the Public Suffix List?
 
-The Public Suffix List is a cross-vendor initiative to provide an accurate list of domain name suffixes.
+The *Public Suffix List* is a cross-vendor initiative to provide an accurate list of domain name suffixes.
 
-The Public Suffix List is an initiative of the Mozilla Project, but is maintained as a community resource. It is available for use in any software, but was originally created to meet the needs of browser manufacturers.
+The *Public Suffix List* is an initiative of the Mozilla Project, but is maintained as a community resource. It is available for use in any software, but was originally created to meet the needs of browser manufacturers.
 
 A "public suffix" is one under which Internet users can directly register names. Some examples of public suffixes are ".com", ".co.uk" and "pvt.k12.wy.us". The Public Suffix List is a list of all known public suffixes.
 
@@ -32,22 +32,22 @@ http://stackoverflow.com/questions/288810/get-the-subdomain-from-a-url
 
 == Requirements
 
-* Ruby >= 1.8.6 (not tested with previous versions)
+* Ruby >= 1.8.6 or Ruby 1.9.x
 
-Successfully tested against
+Successfully tested with the following interpreters
 
 * Ruby 1.8.6 / 1.8.7 / 1.9.1
-* MacRuby 0.4
+* MacRuby
 * Ruby Enterprise Edition
 
 
 == Installation
 
-Via RubyGems
+The best way to install *Public Suffix Service* is via {RubyGems}[http://www.rubygems.org].
 
   $ gem install public_suffix_service
 
-You might need administrator privileges on your system to install it.
+You might need administrator privileges on your system to install the Gem.
 
 
 == Usage
@@ -55,22 +55,32 @@ You might need administrator privileges on your system to install it.
 Example domain without subdomains.
 
   domain = PublicSuffixService.parse("google.com")
+  # => #<PublicSuffixService::Domain>
   domain.tld
   # => "com"
-  domain.domain
+  domain.sld
   # => "google"
+  domain.trd
+  # => nil
+  domain.domain
+  # => "google.com"
   domain.subdomain
   # => nil
 
 Example domain with subdomains.
 
   domain = PublicSuffixService.parse("www.google.com")
+  # => #<PublicSuffixService::Domain>
   domain.tld
   # => "com"
-  domain.domain
+  domain.sld
   # => "google"
-  domain.subdomain
+  domain.trd
   # => "www"
+  domain.domain
+  # => "google.com"
+  domain.subdomain
+  # => "google.com"
 
 Simple validation example.
 
@@ -89,6 +99,21 @@ Simple validation example.
 Author:: {Simone Carletti}[http://www.simonecarletti.com/] <weppos@weppos.net>
 
 
+== FeedBack and Bug reports
+
+If you use this library and find yourself missing any functionality I have missed, please {let me know}[mailto:weppos@weppos.net].
+
+Bug reports and Feature suggestions {are welcomed}[http://github.com/weppos/public_suffix_service/issues].
+
+
+== More
+
+* {Homepage}[http://www.simonecarletti.com/code/public_suffix_service]
+* {Repository}[http://github.com/weppos/public_suffix_service]
+* {API Documentation}[http://www.simonecarletti.com/code/public_suffix_service/api/] (RDoc)
+* {Introducing the Public Suffix List library for Ruby}[http://www.simonecarletti.com/blog/2010/06/public-suffix-list-library-for-ruby/]
+
+
 == Changelog
 
 See the CHANGELOG.rdoc file for details.
@@ -96,4 +121,5 @@ See the CHANGELOG.rdoc file for details.
 
 == License
 
-Copyright (c) 2009-2010 Simone Carletti, DomainName is released under the MIT license.
+Copyright (c) 2009-2010 Simone Carletti,
+*Public Suffix Service* is released under the MIT license.

data/Rakefile

@@ -1,10 +1,14 @@
 require "rubygems"
 require "rake/testtask"
-require "rake/rdoctask"
 require "rake/gempackagetask"
+begin
+  require "hanna/rdoctask"
+rescue LoadError
+  require "rake/rdoctask"
+end
 
 $:.unshift(File.dirname(__FILE__) + "/lib")
-require 'public_suffix_service'
+require "public_suffix_service"
 
 
 # Common package properties
@@ -49,8 +53,8 @@ spec = Gem::Specification.new do |s|
   s.email             = "weppos@weppos.net"
   s.homepage          = "http://www.simonecarletti.com/code/public_suffix_service"
   s.description       = <<-EOD
-    Intelligent Domain Name parser based in the Public Suffic List. \
-    Domain Name can parse and decompose a domain name into top level domain, \
+    Intelligent domain name parser based in the Public Suffic List. \
+    PublicSuffixService can parse and decompose a domain name into top level domain, \
     domain and subdomains.
   EOD
 
@@ -86,9 +90,9 @@ task :gemspec do
   File.open(file, "w") {|f| f << spec.to_ruby }
 end
 
-desc "Remove any temporary products, including gemspec."
+desc "Remove any temporary products, including gemspec"
 task :clean => [:clobber] do
-  rm "#{spec.name}.gemspec"
+  rm "#{spec.name}.gemspec" if File.file?("#{spec.name}.gemspec")
 end
 
 desc "Remove any generated file"
@@ -100,7 +104,7 @@ task :package => [:gemspec]
 begin
   require "rcov/rcovtask"
 
-  desc "Create a code coverage report."
+  desc "Create a code coverage report"
   Rcov::RcovTask.new do |t|
     t.test_files = FileList["test/**/*_test.rb"]
     t.ruby_opts << "-Itest -x mocha,rcov,Rakefile"
@@ -117,7 +121,7 @@ task :console do
 end
 
 begin
-  require 'code_statistics'
+  require "code_statistics"
   desc "Show library's code statistics"
   task :stats do
     CodeStatistics.new(["Public Suffix Service", "lib"],
@@ -127,6 +131,13 @@ rescue LoadError
   puts "CodeStatistics (Rails) is not available"
 end
 
+desc "Publish documentation to the site"
+task :publish_rdoc => [:clobber_rdoc, :rdoc] do
+  ENV["username"] || raise(ArgumentError, "Missing ssh username")
+  sh "rsync -avz --delete rdoc/ #{ENV["username"]}@code:/var/www/apps/code/#{PKG_NAME}/api"
+end
+
+
 Dir["tasks/**/*.rake"].each do |file|
   load(file)
 end

data/lib/public_suffix_service/domain.rb

@@ -18,6 +18,22 @@ module PublicSuffixService
 
   class Domain
 
+    # 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.
+    #
+    # domain - The String domain to be split.
+    #
+    # Examples
+    #
+    #   domain_to_labels('google.com.uk')
+    #   # => ['uk', 'com', 'google']
+    #
+    # Returns an Array of String representing the possible labels.
+    def self.domain_to_labels(domain)
+      domain.to_s.split(".").reverse
+    end
+
     def initialize(*args, &block)
       @tld, @sld, @trd = args
       yield(self) if block_given?
@@ -61,10 +77,10 @@ module PublicSuffixService
     #
     # Examples
     #
-    #   DomainName.new("com", "google").name
+    #   PublicSuffixService::Domain.new("com", "google").name
     #   # => "google.com"
     #
-    #   DomainName.new("com", "google", "www").name
+    #   PublicSuffixService::Domain.new("com", "google", "www").name
     #   # => "www.google.com"
     #
     # Returns a String with the domain name.
@@ -75,23 +91,78 @@ module PublicSuffixService
     # Returns a domain-like representation of this object
     # if the object is a <tt>domain?</tt>,
     # <tt>nil</tt> otherwise.
+    #
+    #   PublicSuffixService::Domain.new("com").domain
+    #   # => nil
+    #
+    #   PublicSuffixService::Domain.new("com", "google").domain
+    #   # => "google.com"
+    #
+    #   PublicSuffixService::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
+    #   PublicSuffixService::Domain.new("zip", "google").domain
+    #   # => "google.zip"
+    #
+    # This method returns a FQD, not just the domain part.
+    # To get the domain part, use <tt>#sld</tt> (aka second level domain).
+    #
+    #   PublicSuffixService::Domain.new("com", "google", "www").domain
+    #   # => "google.com"
+    #
+    #   PublicSuffixService::Domain.new("com", "google", "www").sld
+    #   # => "google"
+    #
+    # Returns a String or nil.
     def domain
       return unless domain?
       [sld, tld].join(".")
     end
 
-    # Returns a subdomain-like representation of this object
+    # Returns a domain-like representation of this object
     # if the object is a <tt>subdomain?</tt>,
     # <tt>nil</tt> otherwise.
+    #
+    #   PublicSuffixService::Domain.new("com").subdomain
+    #   # => nil
+    #
+    #   PublicSuffixService::Domain.new("com", "google").subdomain
+    #   # => nil
+    #
+    #   PublicSuffixService::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
+    #   PublicSuffixService::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 <tt>#tld</tt> (aka third level domain).
+    #
+    #   PublicSuffixService::Domain.new("com", "google", "www").subdomain
+    #   # => "www.google.com"
+    #
+    #   PublicSuffixService::Domain.new("com", "google", "www").trd
+    #   # => "www"
+    #
+    # Returns a String or nil.
     def subdomain
       return unless subdomain?
       [trd, sld, tld].join(".")
     end
 
-    # Gets the rule matching this domain in the default PublicSuffixService::RuleList.
+    # Gets the rule matching this domain
+    # in the default PublicSuffixService::RuleList.
     #
-    # Returns an instance of PublicSuffixService::Rule::Base if a rule matches current domain,
-    # nil if no rule is found.
+    # Returns the PublicSuffixService::Rule::Base instance
+    # if a rule matches current domain, nil if no rule is found.
     def rule
       RuleList.default.find(name)
     end
@@ -102,25 +173,26 @@ module PublicSuffixService
     # This method doesn't actually validate the domain.
     # It only checks whether the instance contains
     # a value for the <tt>tld</tt> and <tt>sld</tt> attributes.
-    # If you also want to validate the domain, use <tt>#valid_domain?</tt> instead.
+    # If you also want to validate the domain,
+    # use <tt>#valid_domain?</tt> instead.
     #
     # Examples
     #
-    #   DomainName.new("com").domain?
+    #   PublicSuffixService::Domain.new("com").domain?
     #   # => false
     #
-    #   DomainName.new("com", "google").domain?
+    #   PublicSuffixService::Domain.new("com", "google").domain?
     #   # => true
     #
-    #   DomainName.new("com", "google", "www").domain?
+    #   PublicSuffixService::Domain.new("com", "google", "www").domain?
     #   # => true
     #
     #   # This is an invalid domain, but returns true
     #   # because this method doesn't validate the content.
-    #   DomainName.new("zip", "google").domain?
+    #   PublicSuffixService::Domain.new("zip", "google").domain?
     #   # => true
     #
-    # Returns true if this instance looks like a domain.
+    # Returns Boolean.
     def domain?
       !(tld.nil? || sld.nil?)
     end
@@ -130,36 +202,41 @@ module PublicSuffixService
     # This method doesn't actually validate the subdomain.
     # It only checks whether the instance contains
     # a value for the <tt>tld</tt>, <tt>sld</tt> and <tt>trd</tt> attributes.
-    # If you also want to validate the domain, use <tt>#valid_subdomain?</tt> instead.
+    # If you also want to validate the domain,
+    # use <tt>#valid_subdomain?</tt> instead.
     #
     # Examples
     #
-    #   DomainName.new("com").subdomain?
+    #   PublicSuffixService::Domain.new("com").subdomain?
     #   # => false
     #
-    #   DomainName.new("com", "google").subdomain?
+    #   PublicSuffixService::Domain.new("com", "google").subdomain?
     #   # => false
     #
-    #   DomainName.new("com", "google", "www").subdomain?
+    #   PublicSuffixService::Domain.new("com", "google", "www").subdomain?
     #   # => true
     #
     #   # This is an invalid domain, but returns true
     #   # because this method doesn't validate the content.
-    #   DomainName.new("zip", "google", "www").subdomain?
+    #   PublicSuffixService::Domain.new("zip", "google", "www").subdomain?
     #   # => true
     #
-    # Returns true if this instance looks like a subdomain.
+    # Returns Boolean.
     def subdomain?
       !(tld.nil? || sld.nil? || trd.nil?)
     end
 
     # Checks whether <tt>self</tt> is exclusively a domain,
     # and not a subdomain.
+    #
+    # Returns Boolean.
     def is_a_domain?
       domain? && !subdomain?
     end
 
     # Checks whether <tt>self</tt> is exclusively a subdomain.
+    #
+    # Returns Boolean.
     def is_a_subdomain?
       subdomain?
     end
@@ -170,7 +247,7 @@ module PublicSuffixService
     # Note: this method triggers a new rule lookup in the default RuleList,
     # which is a quite intensive task.
     #
-    # Returns true if this instance is valid.
+    # Returns Boolean.
     def valid?
       !rule.nil?
     end
@@ -178,21 +255,21 @@ module PublicSuffixService
     # Checks whether <tt>self</tt> looks like a domain and validates
     # according to default <tt>RuleList</tt>.
     #
-    # See also <tt>DomainName#domain?</tt> and <tt>DomainName#valid?</tt>.
+    # See also <tt>#domain?</tt> and <tt>#valid?</tt>.
     #
     # Examples
     #
-    #   DomainName.new("com").domain?
+    #   PublicSuffixService::Domain.new("com").domain?
     #   # => false
     #
-    #   DomainName.new("com", "google").domain?
+    #   PublicSuffixService::Domain.new("com", "google").domain?
     #   # => true
     #
-    #   DomainName.new("com", "google", "www").domain?
+    #   PublicSuffixService::Domain.new("com", "google", "www").domain?
     #   # => true
     #
     #   # This is an invalid domain
-    #   DomainName.new("zip", "google").false?
+    #   PublicSuffixService::Domain.new("zip", "google").false?
     #   # => true
     #
     # Returns true if this instance looks like a domain and is valid.
@@ -203,21 +280,21 @@ module PublicSuffixService
     # Checks whether <tt>self</tt> looks like a subdomain and validates
     # according to default <tt>RuleList</tt>.
     #
-    # See also <tt>DomainName#subdomain?</tt> and <tt>DomainName#valid?</tt>.
+    # See also <tt>#subdomain?</tt> and <tt>#valid?</tt>.
     #
     # Examples
     #
-    #   DomainName.new("com").subdomain?
+    #   PublicSuffixService::Domain.new("com").subdomain?
     #   # => false
     #
-    #   DomainName.new("com", "google").subdomain?
+    #   PublicSuffixService::Domain.new("com", "google").subdomain?
     #   # => false
     #
-    #   DomainName.new("com", "google", "www").subdomain?
+    #   PublicSuffixService::Domain.new("com", "google", "www").subdomain?
     #   # => true
     #
     #   # This is an invalid domain
-    #   DomainName.new("zip", "google", "www").subdomain?
+    #   PublicSuffixService::Domain.new("zip", "google", "www").subdomain?
     #   # => false
     #
     # Returns true if this instance looks like a domain and is valid.

data/lib/public_suffix_service/rule.rb

@@ -22,7 +22,7 @@ module PublicSuffixService
     # and creates a new instance of that class.
     # The <tt>name</tt> becomes the rule value.
     #
-    # name - The rule String definition
+    # name - The String rule definition.
     #
     # Examples
     #
@@ -35,6 +35,7 @@ module PublicSuffixService
     #   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"
@@ -137,12 +138,12 @@ module PublicSuffixService
         @name   = name.to_s
         @value  = value || @name
         @type   = self.class.name.split("::").last.downcase.to_sym
-        @labels = domain_to_labels(@value)
+        @labels = Domain.domain_to_labels(@value)
       end
 
       # Checks whether this rule is equal to <tt>other</tt>.
       #
-      # other - An other PublicSuffixService::Rule::Base to compare.
+      # other - The PublicSuffixService::Rule::Base to compare.
       #
       # Returns true if this rule and other are instances of the same class
       # and has the same value, false otherwise.
@@ -156,13 +157,12 @@ module PublicSuffixService
 
       # Checks whether this rule matches <tt>domain</tt>.
       #
-      # domain - A string with the domain name to check.
+      # domain - The String domain name to check.
       #
-      # Returns a true if this rule matches domain,
-      # false otherwise.
+      # Returns Boolean.
       def match?(domain)
         l1 = labels
-        l2 = domain_to_labels(domain)
+        l2 = Domain.domain_to_labels(domain)
         odiff(l1, l2).empty?
       end
 
@@ -188,9 +188,6 @@ module PublicSuffixService
 
       private
 
-        def domain_to_labels(domain)
-          domain.to_s.split(".").reverse
-        end
 
         def odiff(one, two)
           ii = 0
@@ -218,7 +215,7 @@ module PublicSuffixService
 
       # Decomposes the domain according to rule properties.
       #
-      # domain - A String with the domain name to parse
+      # domain - The String domain name to parse.
       #
       # Return an Array with [trd + sld, tld].
       def decompose(domain)
@@ -248,7 +245,7 @@ module PublicSuffixService
 
       # Decomposes the domain according to rule properties.
       #
-      # domain - A String with the domain name to parse
+      # domain - The String domain name to parse.
       #
       # Return an Array with [trd + sld, tld].
       def decompose(domain)
@@ -279,7 +276,7 @@ module PublicSuffixService
 
       # Decomposes the domain according to rule properties.
       #
-      # domain - A String with the domain name to parse
+      # domain - The String domain name to parse.
       #
       # Return an Array with [trd + sld, tld].
       def decompose(domain)
@@ -291,4 +288,4 @@ module PublicSuffixService
 
   end
 
-end
+end

data/lib/public_suffix_service/rule_list.rb

@@ -51,17 +51,43 @@ module PublicSuffixService
     include Enumerable
 
     # Gets the list of rules.
-    # Each rule is expected to be a subclass of PublicSuffixService::Rule::Base.
     #
-    # Returns an Array of rules.
+    # Returns the Array of rule instances.
+    # Each rule is an instance of the proper corresponding of
+    # PublicSuffixService::Rule::Base.
     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
+
 
     # Initializes an empty PublicSuffixService::RuleList.
     # If block is given, yields on self.
     def initialize(&block) # :yields: self
-      @list = []
+      @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.
+    #
+    # 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|
+        if !@indexes.has_key?(elm)
+          @indexes[elm] = [inx]
+        else
+          @indexes[elm] << inx
+        end
+      end
     end
 
     # Checks whether two lists are equal.
@@ -161,10 +187,15 @@ module PublicSuffixService
 
     # Selects all the rules matching given domain.
     #
-    # Returns an Array of rules.
-    #   Each rule is expected to be a subclass of PublicSuffixService::Rule::Base.
+    # 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.
     def select(domain)
-      @list.select { |rule| rule.match?(domain) }
+      indices = (@indexes[ Domain.domain_to_labels(domain).first ] || [])
+      @list.values_at(*indices).select { |rule| rule.match?(domain) }
     end
 
 
@@ -172,11 +203,11 @@ module PublicSuffixService
 
     class << self
 
-      # Gets the default <tt>PublicSuffixService::RuleList</tt>.
-      # Initializes a new <tt>PublicSuffixService::RuleList</tt> 
-      # parsing the content of <tt>PublicSuffixService::RuleList.default_definition</tt> if necessary.
+      # Gets the default PublicSuffixService::RuleList.
+      # Initializes a new PublicSuffixService::RuleList parsing the content
+      # of PublicSuffixService::RuleList.default_definition, if required.
       #
-      # Returns an instance of PublicSuffixService::RuleList.
+      # Returns a PublicSuffixService::RuleList.
       def default
         @@default ||= parse(default_definition)
       end
@@ -185,12 +216,12 @@ module PublicSuffixService
       #
       # value - The new PublicSuffixService::RuleList.
       #
-      # Returns the new PublicSuffixService::RuleList.
+      # Returns the PublicSuffixService::RuleList.
       def default=(value)
         @@default = value
       end
 
-      # Sets the default <tt>PublicSuffixService::RuleList</tt> to <tt>nil</tt>.
+      # Sets the default PublicSuffixService::RuleList to nil.
       #
       # Returns self.
       def clear
@@ -201,16 +232,17 @@ module PublicSuffixService
       # Resets the default <tt>PublicSuffixService::RuleList</tt> and reinitialize it
       # parsing the content of <tt>PublicSuffixService::RuleList.default_definition</tt>.
       #
-      # Returns an instance of PublicSuffixService::RuleList.
+      # Returns a PublicSuffixService::RuleList.
       def reload
         self.clear.default
       end
 
       # Gets the default definition list.
-      # Can be any <tt>IOStream</tt> including a <tt>File</tt> or a simple <tt>String</tt>.
+      # Can be any <tt>IOStream</tt> including a <tt>File</tt>
+      # or a simple <tt>String</tt>.
       # The object must respond to <tt>#each_line</tt>.
       #
-      # Returns an object which responds to <tt>#each_line</tt>.
+      # Returns a File.
       def default_definition
         File.new(File.join(File.dirname(__FILE__), "definitions.dat"))
       end
@@ -219,7 +251,9 @@ module PublicSuffixService
       # Parse given <tt>input</tt> treating the content as Public Suffic List.
       # See http://publicsuffix.org/format/ for more details about input format.
       #
-      # Returns an Array of PublicSuffixService::Rule::Base.
+      # Returns an Array of rule instances.
+      # Each rule is an instance of the corresponding subclass of
+      # PublicSuffixService::Rule::Base.
       def parse(input)
         new do |list|
           input.each_line do |line|

data/lib/public_suffix_service/version.rb

@@ -18,7 +18,7 @@ module PublicSuffixService
 
   module Version
     MAJOR = 0
-    MINOR = 4
+    MINOR = 5
     PATCH = 0
     BUILD = nil
 
@@ -27,4 +27,4 @@ module PublicSuffixService
 
   VERSION = Version::STRING
 
-end
+end

data/lib/public_suffix_service.rb

@@ -28,9 +28,12 @@ module PublicSuffixService
   AUTHORS         = ["Simone Carletti <weppos@weppos.net>"]
 
 
-  # Parses <tt>domain</tt> and returns a new <tt>PubliSuffixService::Domain</tt> instance.
+  # Parses <tt>domain</tt> and returns the
+  # PubliSuffixService::Domain instance.
   #
-  # domain - A String with the domain name to parse.
+  # domain - The String domain name to parse.
+  #
+  # Examples
   #
   #   PublicSuffixService.parse("google.com")
   #   # => #<PubliSuffixService::Domain ...>
@@ -45,6 +48,8 @@ module PublicSuffixService
   #   # => PublicSuffixService::InvalidDomain
   #
   # Raises PublicSuffixService::Error if domain is not a valid domain
+  #
+  # Returns the PubliSuffixService::Domain domain.
   def self.parse(domain)
     rule = RuleList.default.find(domain) || raise(InvalidDomain, "`#{domain}' is not a valid domain")
 
@@ -64,9 +69,9 @@ module PublicSuffixService
   # Checks whether <tt>domain</tt> is a valid domain name.
   #
   # This method doesn't care whether domain is a domain or subdomain.
-  # The check is performed using the default <tt>PublicSuffixService::RuleList</tt>.
+  # The check is performed using the default PublicSuffixService::RuleList.
   #
-  # domain - A String with the domain name to check.
+  # domain - The String domain name to parse.
   #
   # Examples
   #
@@ -82,7 +87,7 @@ module PublicSuffixService
   #   PublicSuffixService.valid?("x.yz")
   #   # => false
   #
-  # Returns true if <tt>domain</tt> is a valid domain.
+  # Returns Boolean.
   def self.valid?(domain)
     !RuleList.default.find(domain).nil?
   end

data/public_suffix_service.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{public_suffix_service}
-  s.version = "0.3.0"
+  s.version = "0.4.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Simone Carletti"]
@@ -12,7 +12,7 @@ Gem::Specification.new do |s|
   s.email = %q{weppos@weppos.net}
   s.extra_rdoc_files = ["CHANGELOG.rdoc", "LICENSE.rdoc", "README.rdoc"]
   s.files = ["Rakefile", "CHANGELOG.rdoc", "LICENSE.rdoc", "README.rdoc", "public_suffix_service.gemspec", "test/acceptance_test.rb", "test/public_suffix_service/domain_test.rb", "test/public_suffix_service/rule_list_test.rb", "test/public_suffix_service/rule_test.rb", "test/public_suffix_service_test.rb", "test/test_helper.rb", "lib/public_suffix_service/definitions.dat", "lib/public_suffix_service/domain.rb", "lib/public_suffix_service/errors.rb", "lib/public_suffix_service/rule.rb", "lib/public_suffix_service/rule_list.rb", "lib/public_suffix_service/version.rb", "lib/public_suffix_service.rb"]
-  s.homepage = %q{http://www.simonecarletti.com/code/public-suffix-service}
+  s.homepage = %q{http://www.simonecarletti.com/code/public_suffix_service}
   s.rdoc_options = ["--main", "README.rdoc"]
   s.require_paths = ["lib"]
   s.rubygems_version = %q{1.3.7}

data/test/public_suffix_service/domain_test.rb

@@ -6,6 +6,11 @@ class PublicSuffixService::DomainTest < Test::Unit::TestCase
     @klass = PublicSuffixService::Domain
   end
 
+  def test_domain_to_lables
+    assert_equal %w{com live spaces someone},       PublicSuffixService::Domain.domain_to_labels('someone.spaces.live.com')
+    assert_equal %w{com zoho wiki leontina23samiko}, PublicSuffixService::Domain.domain_to_labels('leontina23samiko.wiki.zoho.com')
+  end
+
 
   def test_initialize_with_tld
     domain = @klass.new("com")
@@ -138,4 +143,4 @@ class PublicSuffixService::DomainTest < Test::Unit::TestCase
     assert !@klass.new("com", "google").valid_subdomain?
   end
 
-end
+end

data/test/public_suffix_service/rule_list_test.rb

@@ -16,6 +16,28 @@ class PublicSuffixService::RuleListTest < Test::Unit::TestCase
     assert_equal 0, @list.length
   end
 
+  def test_initialize_create_index_when_empty
+    assert_equal({}, @list.indexes)
+  end
+
+  def test_find__with_index
+    @list = PublicSuffixService::RuleList.parse(<<EOS)
+// com : http://en.wikipedia.org/wiki/.com
+com
+
+// uk : http://en.wikipedia.org/wiki/.uk
+*.uk
+*.sch.uk
+!bl.uk
+!british-library.uk
+EOS
+
+    assert !@list.indexes.empty?
+    assert_equal [1,2,3,4], @list.indexes.delete('uk')
+    assert_equal [0], @list.indexes.delete('com')
+    assert @list.indexes.empty?
+  end
+
 
   def test_equality_with_self
     list = PublicSuffixService::RuleList.new
@@ -179,4 +201,4 @@ EOS
     assert_equal %w(ac com.ac ad *.ar !congresodelalengua3.ar).map { |name| PublicSuffixService::Rule.factory(name) }, list.to_a
   end
 
-end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: public_suffix_service
 version: !ruby/object:Gem::Version 
-  hash: 15
+  hash: 11
   prerelease: false
   segments: 
   - 0
-  - 4
+  - 5
   - 0
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors: 
 - Simone Carletti
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-31 00:00:00 +02:00
+date: 2010-09-13 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -32,7 +32,7 @@ dependencies:
         version: "0"
   type: :development
   version_requirements: *id001
-description: "    Intelligent Domain Name parser based in the Public Suffic List.     Domain Name can parse and decompose a domain name into top level domain,     domain and subdomains.\n"
+description: "    Intelligent domain name parser based in the Public Suffic List.     PublicSuffixService can parse and decompose a domain name into top level domain,     domain and subdomains.\n"
 email: weppos@weppos.net
 executables: []