public_suffix 1.4.6 → 1.5.0

data/lib/public_suffix.rb

@@ -1,11 +1,10 @@
-#--
+#
 # Public Suffix
 #
 # Domain name parser based on the Public Suffix List.
 #
-# Copyright (c) 2009-2014 Simone Carletti <weppos@weppos.net>
-#++
-
+# Copyright (c) 2009-2015 Simone Carletti <weppos@weppos.net>
+#
 
 require 'public_suffix/domain'
 require 'public_suffix/version'
@@ -13,14 +12,8 @@ require 'public_suffix/errors'
 require 'public_suffix/rule'
 require 'public_suffix/list'
 
-
 module PublicSuffix
 
-  NAME            = "Public Suffix"
-  GEM             = "public_suffix"
-  AUTHORS         = ["Simone Carletti <weppos@weppos.net>"]
-
-
   # Parses +domain+ and returns the
   # {PublicSuffix::Domain} instance.
   #

data/lib/public_suffix/domain.rb

@@ -1,11 +1,10 @@
-#--
+#
 # Public Suffix
 #
 # Domain name parser based on the Public Suffix List.
 #
-# Copyright (c) 2009-2014 Simone Carletti <weppos@weppos.net>
-#++
-
+# Copyright (c) 2009-2015 Simone Carletti <weppos@weppos.net>
+#
 
 module PublicSuffix
 
@@ -33,6 +32,8 @@ module PublicSuffix
       domain.to_s.split(".").reverse
     end
 
+    attr_reader :tld, :sld, :trd
+
     # Creates and returns a new {PublicSuffix::Domain} instance.
     #
     # @overload initialize(tld)
@@ -88,32 +89,9 @@ module PublicSuffix
     #   # => [nil, "google", "com"]
     #
     def to_a
-      [trd, sld, tld]
+      [@trd, @sld, @tld]
     end
 
-
-    # Returns the Top Level Domain part, aka the extension.
-    #
-    # @return [String, nil]
-    def tld
-      @tld
-    end
-
-    # Returns the Second Level Domain part, aka the domain part.
-    #
-    # @return [String, nil]
-    def sld
-      @sld
-    end
-
-    # Returns the Third Level Domain part, aka the subdomain part.
-    #
-    # @return [String, nil]
-    def trd
-      @trd
-    end
-
-
     # Returns the full domain name.
     #
     # @return [String]
@@ -127,7 +105,7 @@ module PublicSuffix
     #   # => "www.google.com"
     #
     def name
-      [trd, sld, tld].reject { |part| part.nil? }.join(".")
+      [@trd, @sld, @tld].compact.join(".")
     end
 
     # Returns a domain-like representation of this object
@@ -164,8 +142,9 @@ module PublicSuffix
     # @see #subdomain
     #
     def domain
-      return unless domain?
-      [sld, tld].join(".")
+      if domain?
+        [@sld, @tld].join(".")
+      end
     end
 
     # Returns a domain-like representation of this object
@@ -202,8 +181,9 @@ module PublicSuffix
     # @see #domain
     #
     def subdomain
-      return unless subdomain?
-      [trd, sld, tld].join(".")
+      if subdomain?
+        [@trd, @sld, @tld].join(".")
+      end
     end
 
     # Returns the rule matching this domain
@@ -216,7 +196,6 @@ module PublicSuffix
       List.default.find(name)
     end
 
-
     # Checks whether <tt>self</tt> looks like a domain.
     #
     # This method doesn't actually validate the domain.
@@ -246,7 +225,7 @@ module PublicSuffix
     # @see #subdomain?
     #
     def domain?
-      !(tld.nil? || sld.nil?)
+      !(@tld.nil? || @sld.nil?)
     end
 
     # Checks whether <tt>self</tt> looks like a subdomain.
@@ -278,7 +257,7 @@ module PublicSuffix
     # @see #domain?
     #
     def subdomain?
-      !(tld.nil? || sld.nil? || trd.nil?)
+      !(@tld.nil? || @sld.nil? || @trd.nil?)
     end
 
     # Checks whether <tt>self</tt> is exclusively a domain,
@@ -327,7 +306,6 @@ module PublicSuffix
       !r.nil? && r.allow?(name)
     end
 
-
     # Checks whether <tt>self</tt> looks like a domain and validates
     # according to default {List}.
     #

data/lib/public_suffix/errors.rb

@@ -1,11 +1,10 @@
-#--
+#
 # Public Suffix
 #
 # Domain name parser based on the Public Suffix List.
 #
-# Copyright (c) 2009-2014 Simone Carletti <weppos@weppos.net>
-#++
-
+# Copyright (c) 2009-2015 Simone Carletti <weppos@weppos.net>
+#
 
 module PublicSuffix
 
@@ -43,7 +42,6 @@ module PublicSuffix
   class DomainNotAllowed < DomainInvalid
   end
 
-
   # Backward Compatibility
   #
   # @deprecated Use {PublicSuffix::DomainInvalid}.

data/lib/public_suffix/list.rb

@@ -1,11 +1,10 @@
-#--
+#
 # Public Suffix
 #
 # Domain name parser based on the Public Suffix List.
 #
-# Copyright (c) 2009-2014 Simone Carletti <weppos@weppos.net>
-#++
-
+# Copyright (c) 2009-2015 Simone Carletti <weppos@weppos.net>
+#
 
 module PublicSuffix
 
@@ -44,8 +43,7 @@ module PublicSuffix
     include Enumerable
 
     class << self
-      attr_accessor :default
-      attr_accessor :default_definition
+      attr_writer :default_definition
     end
 
     # Gets the default rule list.
@@ -76,7 +74,9 @@ module PublicSuffix
 
     # Enables/disables support for private (non-ICANN) domains
     # Implicitly reloads the list
-    # @param [Boolean] enable/disable support
+    #
+    # @param [Boolean] value
+    #   enable/disable support
     #
     # @return [PublicSuffix::List]
     def self.private_domains=(value)
@@ -100,6 +100,8 @@ module PublicSuffix
       self.clear.default
     end
 
+    DEFAULT_DEFINITION_PATH = File.join(File.dirname(__FILE__), "..", "..", "data", "definitions.txt")
+
     # Gets the default definition list.
     # Can be any <tt>IOStream</tt> including a <tt>File</tt>
     # or a simple <tt>String</tt>.
@@ -107,7 +109,7 @@ module PublicSuffix
     #
     # @return [File]
     def self.default_definition
-      @default_definition || File.new(File.join(File.dirname(__FILE__), "..", "definitions.txt"), "r:utf-8")
+      @default_definition || File.new(DEFAULT_DEFINITION_PATH, "r:utf-8")
     end
 
     # Parse given +input+ treating the content as Public Suffix List.
@@ -136,7 +138,6 @@ module PublicSuffix
       end
     end
 
-
     # Gets the array of rules.
     #
     # @return [Array<PublicSuffix::Rule::*>]
@@ -148,7 +149,6 @@ module PublicSuffix
     # @return [Array]
     attr_reader :indexes
 
-
     # Initializes an empty {PublicSuffix::List}.
     #
     # @yield [self] Yields on self.
@@ -250,7 +250,6 @@ module PublicSuffix
       self
     end
 
-
     # Returns the most appropriate rule for domain.
     #
     # From the Public Suffix List documentation:
@@ -276,7 +275,7 @@ module PublicSuffix
     # @return [PublicSuffix::Rule::*, nil]
     def find(domain)
       rules = select(domain)
-      rules.select { |r|   r.type == :exception }.first ||
+      rules.detect { |r|   r.type == :exception } ||
       rules.inject { |t,r| t.length > r.length ? t : r }
     end
 
@@ -290,7 +289,7 @@ module PublicSuffix
     # @return [Array<PublicSuffix::Rule::*>]
     def select(domain)
       # raise DomainInvalid, "Blank domain"
-      return [] if domain.to_s !~ /[^[:space:]]/
+      return [] if domain.to_s =~ /\A\s*\z/
       # raise DomainInvalid, "`#{domain}' is not expected to contain a scheme"
       return [] if domain.include?("://")
 

data/lib/public_suffix/rule.rb

@@ -1,11 +1,10 @@
-#--
+#
 # Public Suffix
 #
 # Domain name parser based on the Public Suffix List.
 #
-# Copyright (c) 2009-2014 Simone Carletti <weppos@weppos.net>
-#++
-
+# Copyright (c) 2009-2015 Simone Carletti <weppos@weppos.net>
+#
 
 module PublicSuffix
 
@@ -20,37 +19,7 @@ module PublicSuffix
   #   PublicSuffix::Rule.factory("ar")
   #   # => #<PublicSuffix::Rule::Normal>
   #
-  class Rule
-
-    # Takes the +name+ of the rule, detects the specific rule class
-    # and creates a new instance of that class.
-    # The +name+ becomes the rule +value+.
-    #
-    # @param  [String] name The rule definition.
-    #
-    # @return [PublicSuffix::Rule::*] A rule instance.
-    #
-    # @example Creates a Normal rule
-    #   PublicSuffix::Rule.factory("ar")
-    #   # => #<PublicSuffix::Rule::Normal>
-    #
-    # @example Creates a Wildcard rule
-    #   PublicSuffix::Rule.factory("*.ar")
-    #   # => #<PublicSuffix::Rule::Wildcard>
-    #
-    # @example Creates an Exception rule
-    #   PublicSuffix::Rule.factory("!congresodelalengua3.ar")
-    #   # => #<PublicSuffix::Rule::Exception>
-    #
-    def self.factory(name)
-      klass = case name.to_s[0..0]
-        when "*"  then  "wildcard"
-        when "!"  then  "exception"
-        else            "normal"
-      end
-      const_get(klass.capitalize).new(name)
-    end
-
+  module Rule
 
     #
     # = Abstract rule class
@@ -138,7 +107,7 @@ module PublicSuffix
     #
     class Base
 
-      attr_reader :name, :value, :type, :labels
+      attr_reader :name, :value, :labels
 
       # Initializes a new rule with name and value.
       # If value is +nil+, name also becomes the value for this rule.
@@ -151,10 +120,25 @@ module PublicSuffix
       def initialize(name, value = nil)
         @name   = name.to_s
         @value  = value || @name
-        @type   = self.class.name.split("::").last.downcase.to_sym
         @labels = Domain.domain_to_labels(@value)
       end
 
+      #
+      # The rule type name.
+      #
+      # @return [Symbol]
+      #
+      def self.type
+        @type ||= self.name.split("::").last.downcase.to_sym
+      end
+
+      #
+      # @see {type}
+      #
+      def type
+        self.class.type
+      end
+
       # Checks whether this rule is equal to <tt>other</tt>.
       #
       # @param [PublicSuffix::Rule::*] other
@@ -170,7 +154,6 @@ module PublicSuffix
       end
       alias :eql? :==
 
-
       # Checks if this rule matches +domain+.
       #
       # @param [String, #to_s] domain
@@ -211,7 +194,6 @@ module PublicSuffix
         !decompose(domain).last.nil?
       end
 
-
       # Gets the length of this rule for comparison.
       # The length usually matches the number of rule +parts+.
       #
@@ -226,7 +208,7 @@ module PublicSuffix
       # @raise  [NotImplementedError]
       # @abstract
       def parts
-        raise NotImplementedError
+        raise(NotImplementedError,"#{self.class}##{__method__} is not implemented")
       end
 
       #
@@ -238,20 +220,21 @@ module PublicSuffix
       # @raise  [NotImplementedError]
       # @abstract
       def decompose(domain)
-        raise NotImplementedError
+        raise(NotImplementedError,"#{self.class}##{__method__} is not implemented")
       end
 
-
       private
 
-        def odiff(one, two)
-          ii = 0
-          while(ii < one.size && one[ii] == two[ii])
-            ii += 1
-          end
-          one[ii..one.length]
+      def odiff(one, two)
+        ii = 0
+
+        while(ii < one.size && one[ii] == two[ii])
+          ii += 1
         end
 
+        one[ii..one.length]
+      end
+
     end
 
     class Normal < Base
@@ -368,6 +351,36 @@ module PublicSuffix
 
     end
 
+    RULES = {
+      '*' => Wildcard,
+      '!' => Exception
+    }
+    RULES.default = Normal
+
+    # Takes the +name+ of the rule, detects the specific rule class
+    # and creates a new instance of that class.
+    # The +name+ becomes the rule +value+.
+    #
+    # @param  [String] name The rule definition.
+    #
+    # @return [PublicSuffix::Rule::*] A rule instance.
+    #
+    # @example Creates a Normal rule
+    #   PublicSuffix::Rule.factory("ar")
+    #   # => #<PublicSuffix::Rule::Normal>
+    #
+    # @example Creates a Wildcard rule
+    #   PublicSuffix::Rule.factory("*.ar")
+    #   # => #<PublicSuffix::Rule::Wildcard>
+    #
+    # @example Creates an Exception rule
+    #   PublicSuffix::Rule.factory("!congresodelalengua3.ar")
+    #   # => #<PublicSuffix::Rule::Exception>
+    #
+    def self.factory(name)
+      RULES[name.to_s[0,1]].new(name)
+    end
+
   end
 
 end

data/lib/public_suffix/version.rb

@@ -1,18 +1,17 @@
-#--
+#
 # Public Suffix
 #
 # Domain name parser based on the Public Suffix List.
 #
-# Copyright (c) 2009-2014 Simone Carletti <weppos@weppos.net>
-#++
-
+# Copyright (c) 2009-2015 Simone Carletti <weppos@weppos.net>
+#
 
 module PublicSuffix
 
   module Version
     MAJOR = 1
-    MINOR = 4
-    PATCH = 6
+    MINOR = 5
+    PATCH = 0
     BUILD = nil
 
     STRING = [MAJOR, MINOR, PATCH, BUILD].compact.join(".")