public_suffix 4.0.6 → 5.0.0

data/lib/public_suffix/domain.rb

@@ -4,7 +4,7 @@
 #
 # Domain name parser based on the Public Suffix List.
 #
-# Copyright (c) 2009-2020 Simone Carletti <weppos@weppos.net>
+# Copyright (c) 2009-2022 Simone Carletti <weppos@weppos.net>
 
 module PublicSuffix
 

data/lib/public_suffix/errors.rb

@@ -4,7 +4,7 @@
 #
 # Domain name parser based on the Public Suffix List.
 #
-# Copyright (c) 2009-2020 Simone Carletti <weppos@weppos.net>
+# Copyright (c) 2009-2022 Simone Carletti <weppos@weppos.net>
 
 module PublicSuffix
 

data/lib/public_suffix/list.rb

@@ -4,7 +4,7 @@
 #
 # Domain name parser based on the Public Suffix List.
 #
-# Copyright (c) 2009-2020 Simone Carletti <weppos@weppos.net>
+# Copyright (c) 2009-2022 Simone Carletti <weppos@weppos.net>
 
 module PublicSuffix
 
@@ -63,7 +63,7 @@ module PublicSuffix
     #
     # See http://publicsuffix.org/format/ for more details about input format.
     #
-    # @param  string [#each_line] the list to parse
+    # @param  input [#each_line] the list to parse
     # @param  private_domains [Boolean] whether to ignore the private domains section
     # @return [PublicSuffix::List]
     def self.parse(input, private_domains: true)
@@ -87,7 +87,7 @@ module PublicSuffix
             section = 2
 
           # skip comments
-          when line.start_with?(comment_token)
+          when line.start_with?(comment_token) # rubocop:disable Lint/DuplicateBranch
             next
 
           else
@@ -173,7 +173,7 @@ module PublicSuffix
     # @return [PublicSuffix::Rule::*]
     def find(name, default: default_rule, **options)
       rule = select(name, **options).inject do |l, r|
-        return r if r.class == Rule::Exception
+        return r if r.instance_of?(Rule::Exception)
 
         l.length > r.length ? l : r
       end

data/lib/public_suffix/rule.rb

@@ -4,7 +4,7 @@
 #
 # Domain name parser based on the Public Suffix List.
 #
-# Copyright (c) 2009-2020 Simone Carletti <weppos@weppos.net>
+# Copyright (c) 2009-2022 Simone Carletti <weppos@weppos.net>
 
 module PublicSuffix
 
@@ -125,16 +125,15 @@ module PublicSuffix
       # @param  private [Boolean]
       def initialize(value:, length: nil, private: false)
         @value    = value.to_s
-        @length   = length || @value.count(DOT) + 1
+        @length   = length || (@value.count(DOT) + 1)
         @private  = private
       end
 
       # Checks whether this rule is equal to <tt>other</tt>.
       #
-      # @param  [PublicSuffix::Rule::*] other The rule to compare
-      # @return [Boolean]
-      #   Returns true if this rule and other are instances of the same class
-      #   and has the same value, false otherwise.
+      # @param  other [PublicSuffix::Rule::*] The rule to compare
+      # @return [Boolean] true if this rule and other are instances of the same class
+      #         and has the same value, false otherwise.
       def ==(other)
         equal?(other) || (self.class == other.class && value == other.value)
       end
@@ -162,7 +161,7 @@ module PublicSuffix
       # @param  name [String] the domain name to check
       # @return [Boolean]
       def match?(name)
-        # Note: it works because of the assumption there are no
+        # NOTE: it works because of the assumption there are no
         # rules like foo.*.com. If the assumption is incorrect,
         # we need to properly walk the input and skip parts according
         # to wildcard component.
@@ -176,7 +175,7 @@ module PublicSuffix
       end
 
       # @abstract
-      # @param  [String, #to_s] name The domain name to decompose
+      # @param  domain [#to_s] The domain name to decompose
       # @return [Array<String, nil>]
       def decompose(*)
         raise NotImplementedError
@@ -196,7 +195,7 @@ module PublicSuffix
 
       # Decomposes the domain name according to rule properties.
       #
-      # @param  [String, #to_s] name The domain name to decompose
+      # @param  domain [#to_s] The domain name to decompose
       # @return [Array<String>] The array with [trd + sld, tld].
       def decompose(domain)
         suffix = parts.join('\.')
@@ -222,12 +221,13 @@ module PublicSuffix
       # @param  content [String] the content of the rule
       # @param  private [Boolean]
       def self.build(content, private: false)
-        new(value: content.to_s[2..-1], private: private)
+        new(value: content.to_s[2..], private: private)
       end
 
       # Initializes a new rule.
       #
       # @param  value [String]
+      # @param  length [Integer]
       # @param  private [Boolean]
       def initialize(value:, length: nil, private: false)
         super(value: value, length: length, private: private)
@@ -243,7 +243,7 @@ module PublicSuffix
 
       # Decomposes the domain name according to rule properties.
       #
-      # @param  [String, #to_s] name The domain name to decompose
+      # @param  domain [#to_s] The domain name to decompose
       # @return [Array<String>] The array with [trd + sld, tld].
       def decompose(domain)
         suffix = ([".*?"] + parts).join('\.')
@@ -266,10 +266,10 @@ module PublicSuffix
 
       # Initializes a new rule from the content.
       #
-      # @param  content [String] the content of the rule
+      # @param  content [#to_s] the content of the rule
       # @param  private [Boolean]
       def self.build(content, private: false)
-        new(value: content.to_s[1..-1], private: private)
+        new(value: content.to_s[1..], private: private)
       end
 
       # Gets the original rule definition.
@@ -281,7 +281,7 @@ module PublicSuffix
 
       # Decomposes the domain name according to rule properties.
       #
-      # @param  [String, #to_s] name The domain name to decompose
+      # @param  domain [#to_s] The domain name to decompose
       # @return [Array<String>] The array with [trd + sld, tld].
       def decompose(domain)
         suffix = parts.join('\.')
@@ -299,7 +299,7 @@ module PublicSuffix
       #
       # @return [Array<String>]
       def parts
-        @value.split(DOT)[1..-1]
+        @value.split(DOT)[1..]
       end
 
     end
@@ -321,7 +321,7 @@ module PublicSuffix
     #   PublicSuffix::Rule.factory("!congresodelalengua3.ar")
     #   # => #<PublicSuffix::Rule::Exception>
     #
-    # @param  [String] content The rule content.
+    # @param  content [#to_s] the content of the rule
     # @return [PublicSuffix::Rule::*] A rule instance.
     def self.factory(content, private: false)
       case content.to_s[0, 1]

data/lib/public_suffix/version.rb

@@ -5,9 +5,11 @@
 #
 # Domain name parser based on the Public Suffix List.
 #
-# Copyright (c) 2009-2020 Simone Carletti <weppos@weppos.net>
+# Copyright (c) 2009-2022 Simone Carletti <weppos@weppos.net>
 
 module PublicSuffix
-  # The current library version.
-  VERSION = "4.0.6"
+
+  # @return [String] The current library version.
+  VERSION = "5.0.0"
+
 end

data/lib/public_suffix.rb

@@ -4,7 +4,7 @@
 #
 # Domain name parser based on the Public Suffix List.
 #
-# Copyright (c) 2009-2020 Simone Carletti <weppos@weppos.net>
+# Copyright (c) 2009-2022 Simone Carletti <weppos@weppos.net>
 
 require_relative "public_suffix/domain"
 require_relative "public_suffix/version"
@@ -57,15 +57,13 @@ module PublicSuffix
   #   # => PublicSuffix::DomainInvalid: http://www.google.com is not expected to contain a scheme
   #
   #
-  # @param  [String, #to_s] name The domain name or fully qualified domain name to parse.
-  # @param  [PublicSuffix::List] list The rule list to search, defaults to the default {PublicSuffix::List}
-  # @param  [Boolean] ignore_private
+  # @param  name [#to_s] The domain name or fully qualified domain name to parse.
+  # @param  list [PublicSuffix::List] The rule list to search, defaults to the default {PublicSuffix::List}
+  # @param  ignore_private [Boolean]
   # @return [PublicSuffix::Domain]
   #
-  # @raise [PublicSuffix::DomainInvalid]
-  #   If domain is not a valid domain.
-  # @raise [PublicSuffix::DomainNotAllowed]
-  #   If a rule for +domain+ is found, but the rule doesn't allow +domain+.
+  # @raise [PublicSuffix::DomainInvalid] If domain is not a valid domain.
+  # @raise [PublicSuffix::DomainNotAllowed] If a rule for +domain+ is found, but the rule doesn't allow +domain+.
   def self.parse(name, list: List.default, default_rule: list.default_rule, ignore_private: false)
     what = normalize(name)
     raise what if what.is_a?(DomainInvalid)
@@ -119,8 +117,8 @@ module PublicSuffix
   #   # => false
   #
   #
-  # @param  [String, #to_s] name The domain name or fully qualified domain name to validate.
-  # @param  [Boolean] ignore_private
+  # @param  name [#to_s] The domain name or fully qualified domain name to validate.
+  # @param  ignore_private [Boolean]
   # @return [Boolean]
   def self.valid?(name, list: List.default, default_rule: list.default_rule, ignore_private: false)
     what = normalize(name)
@@ -135,9 +133,9 @@ module PublicSuffix
   #
   # This method doesn't raise. Instead, it returns nil if the domain is not valid for whatever reason.
   #
-  # @param  [String, #to_s] name The domain name or fully qualified domain name to parse.
-  # @param  [PublicSuffix::List] list The rule list to search, defaults to the default {PublicSuffix::List}
-  # @param  [Boolean] ignore_private
+  # @param  name [#to_s] The domain name or fully qualified domain name to parse.
+  # @param  list [PublicSuffix::List] The rule list to search, defaults to the default {PublicSuffix::List}
+  # @param  ignore_private [Boolean]
   # @return [String]
   def self.domain(name, **options)
     parse(name, **options).domain
@@ -171,7 +169,7 @@ module PublicSuffix
 
     return DomainInvalid.new("Name is blank") if name.empty?
     return DomainInvalid.new("Name starts with a dot") if name.start_with?(DOT)
-    return DomainInvalid.new("%s is not expected to contain a scheme" % name) if name.include?("://")
+    return DomainInvalid.new(format("%s is not expected to contain a scheme", name)) if name.include?("://")
 
     name
   end

data/public_suffix.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |s|
     "source_code_uri" => "https://github.com/weppos/publicsuffix-ruby/tree/v#{s.version}",
   }
 
-  s.required_ruby_version = ">= 2.3"
+  s.required_ruby_version = ">= 2.6"
 
   s.require_paths    = ["lib"]
   s.files            = `git ls-files`.split("\n")

data/test/acceptance_test.rb

@@ -64,7 +64,7 @@ class AcceptanceTest < Minitest::Test
   def test_rejected
     REJECTED_CASES.each do |name, expected|
       assert_equal expected, PublicSuffix.valid?(name),
-                   "Expected %s to be %s" % [name.inspect, expected.inspect]
+                   format("Expected %s to be %s", name.inspect, expected.inspect)
       assert !valid_domain?(name),
              "#{name} expected to be invalid"
     end
@@ -72,9 +72,9 @@ class AcceptanceTest < Minitest::Test
 
 
   CASE_CASES = [
-    ["Www.google.com", %w( www google com )],
-    ["www.Google.com", %w( www google com )],
-    ["www.google.Com", %w( www google com )],
+    ["Www.google.com", %w[www google com]],
+    ["www.Google.com", %w[www google com]],
+    ["www.google.Com", %w[www google com]],
   ].freeze
 
   def test_ignore_case

data/test/psl_test.rb

@@ -45,7 +45,7 @@ class PslTest < Minitest::Test
     end
 
     message = "The following #{failures.size} tests fail:\n"
-    failures.each { |i, o, d| message += "Expected %s to be %s, got %s\n" % [i.inspect, o.inspect, d.inspect] }
+    failures.each { |i, o, d| message += format("Expected %s to be %s, got %s\n", i.inspect, o.inspect, d.inspect) }
     assert_equal 0, failures.size, message
   end
 

data/test/test_helper.rb

@@ -1,13 +1,5 @@
 # frozen_string_literal: true
 
-if ENV["COVERAGE"]
-  require "simplecov"
-  SimpleCov.start
-
-  require "codecov"
-  SimpleCov.formatter = SimpleCov::Formatter::Codecov
-end
-
 require "minitest/autorun"
 require "minitest/reporters"
 require "mocha/minitest"

data/test/unit/domain_test.rb

@@ -10,15 +10,15 @@ class PublicSuffix::DomainTest < Minitest::Test
 
   # Tokenizes given input into labels.
   def test_self_name_to_labels
-    assert_equal  %w( someone spaces live com ),
+    assert_equal  %w[someone spaces live com],
                   PublicSuffix::Domain.name_to_labels("someone.spaces.live.com")
-    assert_equal  %w( leontina23samiko wiki zoho com ),
+    assert_equal  %w[leontina23samiko wiki zoho com],
                   PublicSuffix::Domain.name_to_labels("leontina23samiko.wiki.zoho.com")
   end
 
   # Converts input into String.
   def test_self_name_to_labels_converts_input_to_string
-    assert_equal  %w( someone spaces live com ),
+    assert_equal  %w[someone spaces live com],
                   PublicSuffix::Domain.name_to_labels(:"someone.spaces.live.com")
   end
 

data/test/unit/list_test.rb

@@ -214,7 +214,7 @@ LIST
     assert_instance_of PublicSuffix::List, list
     assert_equal 4, list.size
 
-    rules = %w( com *.uk !british-library.uk blogspot.com ).map { |name| PublicSuffix::Rule.factory(name) }
+    rules = %w[com *.uk !british-library.uk blogspot.com].map { |name| PublicSuffix::Rule.factory(name) }
     assert_equal rules, list.each.to_a
 
     # private domains

data/test/unit/rule_test.rb

@@ -29,8 +29,8 @@ class PublicSuffix::RuleTest < Minitest::Test
   def test_default_returns_default_wildcard
     default = PublicSuffix::Rule.default
     assert_equal PublicSuffix::Rule::Wildcard.build("*"), default
-    assert_equal %w( example tldnotlisted ), default.decompose("example.tldnotlisted")
-    assert_equal %w( www.example tldnotlisted ), default.decompose("www.example.tldnotlisted")
+    assert_equal %w[example tldnotlisted], default.decompose("example.tldnotlisted")
+    assert_equal %w[www.example tldnotlisted], default.decompose("www.example.tldnotlisted")
   end
 
 end
@@ -140,15 +140,15 @@ class PublicSuffix::RuleNormalTest < Minitest::Test
   end
 
   def test_parts
-    assert_equal %w(com), @klass.build("com").parts
-    assert_equal %w(co com), @klass.build("co.com").parts
-    assert_equal %w(mx co com), @klass.build("mx.co.com").parts
+    assert_equal %w[com], @klass.build("com").parts
+    assert_equal %w[co com], @klass.build("co.com").parts
+    assert_equal %w[mx co com], @klass.build("mx.co.com").parts
   end
 
   def test_decompose
     assert_equal [nil, nil], @klass.build("com").decompose("com")
-    assert_equal %w( example com ), @klass.build("com").decompose("example.com")
-    assert_equal %w( foo.example com ), @klass.build("com").decompose("foo.example.com")
+    assert_equal %w[example com], @klass.build("com").decompose("example.com")
+    assert_equal %w[foo.example com], @klass.build("com").decompose("foo.example.com")
   end
 
 end
@@ -175,14 +175,14 @@ class PublicSuffix::RuleExceptionTest < Minitest::Test
   end
 
   def test_parts
-    assert_equal %w( uk ), @klass.build("!british-library.uk").parts
-    assert_equal %w( tokyo jp ), @klass.build("!metro.tokyo.jp").parts
+    assert_equal %w[uk], @klass.build("!british-library.uk").parts
+    assert_equal %w[tokyo jp], @klass.build("!metro.tokyo.jp").parts
   end
 
   def test_decompose
     assert_equal [nil, nil], @klass.build("!british-library.uk").decompose("uk")
-    assert_equal %w( british-library uk ), @klass.build("!british-library.uk").decompose("british-library.uk")
-    assert_equal %w( foo.british-library uk ), @klass.build("!british-library.uk").decompose("foo.british-library.uk")
+    assert_equal %w[british-library uk], @klass.build("!british-library.uk").decompose("british-library.uk")
+    assert_equal %w[foo.british-library uk], @klass.build("!british-library.uk").decompose("foo.british-library.uk")
   end
 
 end
@@ -209,14 +209,14 @@ class PublicSuffix::RuleWildcardTest < Minitest::Test
   end
 
   def test_parts
-    assert_equal %w( uk ), @klass.build("*.uk").parts
-    assert_equal %w( co uk ), @klass.build("*.co.uk").parts
+    assert_equal %w[uk], @klass.build("*.uk").parts
+    assert_equal %w[co uk], @klass.build("*.co.uk").parts
   end
 
   def test_decompose
     assert_equal [nil, nil], @klass.build("*.do").decompose("nic.do")
-    assert_equal %w( google co.uk ), @klass.build("*.uk").decompose("google.co.uk")
-    assert_equal %w( foo.google co.uk ), @klass.build("*.uk").decompose("foo.google.co.uk")
+    assert_equal %w[google co.uk], @klass.build("*.uk").decompose("google.co.uk")
+    assert_equal %w[foo.google co.uk], @klass.build("*.uk").decompose("foo.google.co.uk")
   end
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: public_suffix
 version: !ruby/object:Gem::Version
-  version: 4.0.6
+  version: 5.0.0
 platform: ruby
 authors:
 - Simone Carletti
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-02 00:00:00.000000000 Z
+date: 2022-07-24 00:00:00.000000000 Z
 dependencies: []
 description: PublicSuffix can parse and decompose a domain name into top level domain,
   domain and subdomains.
@@ -20,11 +20,13 @@ extra_rdoc_files:
 - LICENSE.txt
 files:
 - ".github/FUNDING.yml"
+- ".github/dependabot.yml"
+- ".github/workflows/psl-update.yml"
+- ".github/workflows/release.yml"
 - ".github/workflows/tests.yml"
 - ".gitignore"
 - ".rubocop.yml"
 - ".rubocop_opinionated.yml"
-- ".travis.yml"
 - ".yardopts"
 - 2.0-Upgrade.md
 - CHANGELOG.md
@@ -34,7 +36,6 @@ files:
 - Rakefile
 - SECURITY.md
 - bin/console
-- codecov.yml
 - data/list.txt
 - lib/public_suffix.rb
 - lib/public_suffix/domain.rb
@@ -71,9 +72,9 @@ licenses:
 metadata:
   bug_tracker_uri: https://github.com/weppos/publicsuffix-ruby/issues
   changelog_uri: https://github.com/weppos/publicsuffix-ruby/blob/master/CHANGELOG.md
-  documentation_uri: https://rubydoc.info/gems/public_suffix/4.0.6
+  documentation_uri: https://rubydoc.info/gems/public_suffix/5.0.0
   homepage_uri: https://simonecarletti.com/code/publicsuffix-ruby
-  source_code_uri: https://github.com/weppos/publicsuffix-ruby/tree/v4.0.6
+  source_code_uri: https://github.com/weppos/publicsuffix-ruby/tree/v5.0.0
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -82,36 +83,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.3'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.3.7
 signing_key: 
 specification_version: 4
 summary: Domain name parser based on the Public Suffix List.
-test_files:
-- test/acceptance_test.rb
-- test/benchmarks/bm_find.rb
-- test/benchmarks/bm_find_all.rb
-- test/benchmarks/bm_names.rb
-- test/benchmarks/bm_select.rb
-- test/benchmarks/bm_select_incremental.rb
-- test/benchmarks/bm_valid.rb
-- test/profilers/domain_profiler.rb
-- test/profilers/find_profiler.rb
-- test/profilers/find_profiler_jp.rb
-- test/profilers/initialization_profiler.rb
-- test/profilers/list_profsize.rb
-- test/profilers/object_binsize.rb
-- test/psl_test.rb
-- test/test_helper.rb
-- test/tests.txt
-- test/unit/domain_test.rb
-- test/unit/errors_test.rb
-- test/unit/list_test.rb
-- test/unit/public_suffix_test.rb
-- test/unit/rule_test.rb
+test_files: []

data/.travis.yml

@@ -1,23 +0,0 @@
-language: ruby
-
-rvm:
-  # - 2.3
-  - 2.4
-  - 2.5
-  - 2.6
-  - 2.7
-  - ruby-head
-
-env:
-  - COVERAGE=1
-
-cache:
-  - bundler
-
-matrix:
-  allow_failures:
-    - rvm: ruby-head
-
-before_install:
-  - gem update --system
-  - gem install bundler

data/codecov.yml

@@ -1,12 +0,0 @@
-# https://docs.codecov.io/docs/coverage-configuration
-coverage:
-  precision: 1
-  round: down
-  status:
-    project:
-      default: false
-    patch:
-      default: false
-
-# https://docs.codecov.io/docs/pull-request-comments#section-requiring-changes
-comment: off