public_suffix 5.1.1 → 7.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f95fd278200cbe3922d07b90ca7b51231509770ff2df64b45f1f0dd0aae532b5
-  data.tar.gz: 8ca654313480fdb64b80d1ac2e54150cc594d731a88dfee4a125c8a32bb6aecc
+  metadata.gz: '084a35b60185cb9effa86043e48492bbdef04d05f0f25b022cd4814b812b3de2'
+  data.tar.gz: 70c513a2c19d770c0d6d929a9bb8fe868a9df87b899af6eaf4ffe24a4acfc903
 SHA512:
-  metadata.gz: e7f9ae38d463e8ef8355e033606d5f0a7689976054127f9d5a32b9e0af0bca7f54fa3287678d85def68e73a3fc466fc01d4b39db511386e121ac8bab1fe8c728
-  data.tar.gz: 22bf9f457b5d961de5a8e40de03558bdca814bf565343ed0024be69b71b789b538ca497b856bfa9f294b9cbfcf4c9cf48d9fd7670628f5e0684dc05afa528d1c
+  metadata.gz: 867e2369292df3275da727802270527999530fff53b9683228edf4f183e9f8fd7592cb3da2d2bf0923f2b7c727e778dbc45e329f234e7f1869d74f298994bf5a
+  data.tar.gz: 9fbbcf8839be0685d98d91e6fb44ec010f3dd2c3e80469b57b1138465701b3b0168da508aa3f7c8a3e46897c8135b337b2b64e1d17fb058e4de02a11efc4e984

data/CHANGELOG.md

@@ -2,17 +2,59 @@
 
 This project uses [Semantic Versioning 2.0.0](https://semver.org/).
 
+
+## 7.0.0
+
+### Changed
+
+- Updated definitions.
+- Minimum Ruby version is 3.2
+
+
+## 6.0.2
+
+### Changed
+
+- Updated definitions.
+
+
+## 6.0.1
+
+### Changed
+
+- Updated definitions.
+
+
+## 6.0.0
+
+Same as 5.1.0. Re-releasing as a major version change due to a major ruby version requirement change.
+
+### Changed
+
+- Updated definitions.
+- Minimum Ruby version is 3.0
+
+
 ## 5.1.1
 
 No significant changes. Releasing a mini version to address 5.1.0 release with major ruby requirement change (GH-315).
 
 
+## 5.1.0
+
+### Changed
+
+- Updated definitions.
+- Minimum Ruby version is 3.0
+
+
 ## 5.0.5
 
 ### Changed
 
 - Updated definitions.
 
+
 ## 5.0.4
 
 ### Changed
@@ -20,18 +62,21 @@ No significant changes. Releasing a mini version to address 5.1.0 release with m
 - Reduced .gem file size (GH-258). [Thanks @ybiquitous]
 - Updated definitions.
 
+
 ## 5.0.3
 
 ### Fixed
 
 - Fixed automated release workflow.
 
+
 ## 5.0.2
 
 ### Changed
 
 - Updated definitions.
 
+
 ## 5.0.1
 
 ### Changed
@@ -44,7 +89,6 @@ No significant changes. Releasing a mini version to address 5.1.0 release with m
 ### Changed
 
 - Minimum Ruby version is 2.6
-
 - Updated definitions.
 
 

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2009-2024 Simone Carletti <weppos@weppos.net>
+Copyright (c) 2009-2025 Simone Carletti <weppos@weppos.net>
 
 MIT License
 

data/README.md

@@ -1,6 +1,6 @@
-# Public Suffix <small>for Ruby</small>
+# PublicSuffix for Ruby
 
-<tt>PublicSuffix</tt> is a Ruby domain name parser based on the [Public Suffix List](https://publicsuffix.org/).
+`PublicSuffix` is a Ruby domain name parser based on the [Public Suffix List](https://publicsuffix.org/).
 
 [![Build Status](https://github.com/weppos/publicsuffix-ruby/actions/workflows/tests.yml/badge.svg)](https://github.com/weppos/publicsuffix-ruby/actions/workflows/tests.yml)
 [![Tidelift dependencies](https://tidelift.com/badges/package/rubygems/public_suffix)](https://tidelift.com/subscription/pkg/rubygems-public-suffix?utm_source=rubygems-public-suffix&utm_medium=referral&utm_campaign=enterprise)
@@ -16,7 +16,7 @@
 
 ## Requirements
 
-<tt>PublicSuffix</tt> requires **Ruby >= 2.6**. For an older versions of Ruby use a previous release.
+`PublicSuffix` requires **Ruby >= 3.2**. For older versions of Ruby, use a previous release.
 
 
 ## Installation
@@ -33,8 +33,6 @@ Or use Bundler and define it as a dependency in your `Gemfile`:
 gem 'public_suffix'
 ```
 
-If you are upgrading to 2.0, see [2.0-Upgrade.md](2.0-Upgrade.md).
-
 ## Usage
 
 Extract the domain out from a name:
@@ -108,9 +106,9 @@ PublicSuffix.valid?("example.tldnotlisted", default_rule: nil)
 ```
 
 
-## Fully Qualified Domain Names
+## Fully qualified domain names
 
-This library automatically recognizes Fully Qualified Domain Names. A FQDN is a domain name that end with a trailing dot.
+This library automatically recognizes Fully Qualified Domain Names. A FQDN is a domain name that ends with a trailing dot.
 
 ```ruby
 # Parse a standard domain name
@@ -124,7 +122,7 @@ PublicSuffix.domain("www.google.com.")
 
 ## Private domains
 
-This library has support for switching off support for private (non-ICANN).
+This library supports toggling private (non-ICANN) domain handling.
 
 ```ruby
 # Extract a domain including private domains (by default)
@@ -150,15 +148,15 @@ PublicSuffix.domain("something.blogspot.com")
 # => "blogspot.com"
 ```
 
-## Add domain to list
+## Adding custom domains
 
-If you want to manually add a domain to the list just run:
+To manually add a domain to the list:
 
 ```ruby
 PublicSuffix::List.default << PublicSuffix::Rule.factory('onmicrosoft.com')
 ```
 
-## What is the Public Suffix List?
+## What is the public suffix list?
 
 The [Public Suffix List](https://publicsuffix.org) is a cross-vendor initiative to provide an accurate list of domain name suffixes.
 
@@ -167,7 +165,7 @@ The Public Suffix List is an initiative of the Mozilla Project, but is maintaine
 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.
 
 
-## Why the Public Suffix List is better than any available Regular Expression parser?
+## Why use the public suffix list instead of regular expressions?
 
 Previously, browsers used an algorithm which basically only denied setting wide-ranging cookies for top-level domains with no dots (e.g. com or org). However, this did not work for top-level domains where only third-level registrations are allowed (e.g. co.uk). In these cases, websites could set a cookie for co.uk which will be passed onto every website registered under co.uk.
 
@@ -182,43 +180,52 @@ Source: https://wiki.mozilla.org/Public_Suffix_List
 Not convinced yet? Check out [this real world example](https://stackoverflow.com/q/288810/123527).
 
 
-## Does <tt>PublicSuffix</tt> make requests to Public Suffix List website?
+## Does PublicSuffix make network requests?
 
-No. <tt>PublicSuffix</tt> comes with a bundled list. It does not make any HTTP requests to parse or validate a domain.
+No. `PublicSuffix` comes with a bundled list. It does not make any HTTP requests to parse or validate a domain.
 
 
-## Support
+## Terminology
 
-Library documentation is auto-generated from the [README](https://github.com/weppos/publicsuffix-ruby/blob/master/README.md) and the source code, and it's available at https://rubydoc.info/gems/public_suffix.
+- **TLD** (Top-Level Domain): The last segment of a domain name. For example, in `mozilla.org`, the `.org` portion is the TLD.
 
-- The PublicSuffix bug tracker is here: https://github.com/weppos/publicsuffix-ruby/issues
-- The PublicSuffix code repository is here: https://github.com/weppos/publicsuffix-ruby. Contributions are welcome! Please include tests and/or feature coverage for every patch, and create a topic branch for every separate change you make.
+- **SLD** (Second-Level Domain): A domain directly below a top-level domain. For example, in `https://www.mozilla.org/en-US/`, `mozilla` is the second-level domain of the `.org` TLD.
 
-[Consider subscribing to Tidelift which provides Enterprise support for this project](https://tidelift.com/subscription/pkg/rubygems-public-suffix?utm_source=rubygems-public-suffix&utm_medium=referral&utm_campaign=readme) as part of the Tidelift Subscription. Tidelift subscriptions also help the maintainers by funding the project, which in turn allows us to ship releases, bugfixes, and security updates more often.
+- **TRD** (Third-Level Domain): Also known as a subdomain, this is the part of the domain before the SLD or root domain. For example, in `https://www.mozilla.org/en-US/`, `www` is the TRD.
 
+- **FQDN** (Fully Qualified Domain Name): A complete domain name that includes the hostname, domain, and top-level domain, ending with a trailing dot. The format is `[hostname].[domain].[tld].` (e.g., `www.mozilla.org.`).
 
-## Security and Vulnerability Reporting
 
-Full information and description of our security policy please visit [`SECURITY.md`](SECURITY.md)
+## Documentation and support
 
+### Documentation
 
-## Changelog
+Library documentation is auto-generated from the [README](https://github.com/weppos/publicsuffix-ruby/blob/master/README.md) and source code, and is available at https://rubydoc.info/gems/public_suffix.
 
-See the [CHANGELOG.md](CHANGELOG.md) file for details.
+### Bug reports and contributions
 
+- **Bug Tracker**: https://github.com/weppos/publicsuffix-ruby/issues
+- **Code Repository**: https://github.com/weppos/publicsuffix-ruby
 
-## License
+Contributions are welcome! Please include tests and/or feature coverage for every patch, and create a topic branch for every separate change you make.
 
-Copyright (c) 2009-2024 Simone Carletti. This is Free Software distributed under the MIT license.
+### Enterprise support
 
-The [Public Suffix List source](https://publicsuffix.org/list/) is subject to the terms of the Mozilla Public License, v. 2.0.
+[Consider subscribing to Tidelift](https://tidelift.com/subscription/pkg/rubygems-public-suffix?utm_source=rubygems-public-suffix&utm_medium=referral&utm_campaign=readme), which provides enterprise support for this project as part of the Tidelift Subscription. Tidelift subscriptions help fund the project, allowing us to ship releases, bugfixes, and security updates more frequently.
+
+
+## Security and vulnerability reporting
 
-## Definitions
+For full information and details about our security policy, please visit [`SECURITY.md`](SECURITY.md).
 
-tld = Top level domain, this is in reference to the last segment of a domain, sometimes the part that is directly after the "dot" symbol. For example, `mozilla.org`, the `.org` portion is the tld.
 
-sld = Second level domain, a domain that is directly below a top-level domain. For example, in `https://www.mozilla.org/en-US/`, `mozilla` is the second-level domain of the .org tld.
+## Changelog
+
+See [CHANGELOG.md](CHANGELOG.md) for details.
+
 
-trd = Transit routing domain, or known as a subdomain. This is the part of the domain that is before the sld or root domain. For example, in `https://www.mozilla.org/en-US/`, `www` is the trd.
+## License
+
+Copyright (c) 2009-2025 Simone Carletti. This is Free Software distributed under the MIT license.
 
-FQDN = Fully Qualified Domain Names, are domain names that are written with the hostname and the domain name, and include the top-level domain, the format looks like `[hostname].[domain].[tld].` for ex. `[www].[mozilla].[org]`.
+The [Public Suffix List source](https://publicsuffix.org/list/) is subject to the terms of the Mozilla Public License, v. 2.0.

data/RELEASING.md

@@ -0,0 +1,95 @@
+# Releasing
+
+This document describes the steps to release a new version of PublicSuffix.
+
+## Prerequisites
+
+- You have commit access to the repository
+- You have push access to the repository
+- You have a GPG key configured for signing tags
+- You have permission to publish to RubyGems
+
+## Release process
+
+1. **Determine the new version** using [Semantic Versioning](https://semver.org/)
+
+   ```shell
+   VERSION=X.Y.Z
+   ```
+
+   - **MAJOR** version for incompatible API changes
+   - **MINOR** version for backwards-compatible functionality additions
+   - **PATCH** version for backwards-compatible bug fixes
+
+2. **Update the version file** with the new version
+
+   Edit `lib/public_suffix/version.rb` and update the `VERSION` constant:
+
+   ```ruby
+   VERSION = "X.Y.Z"
+   ```
+
+3. **Update the changelog** with the new version
+
+   Edit `CHANGELOG.md` and add a new section for the release:
+
+   ```markdown
+   ## vX.Y.Z
+
+   - Description of changes
+   ```
+
+4. **Install dependencies**
+
+   ```shell
+   bundle install
+   ```
+
+   or simply:
+
+   ```shell
+   bundle
+   ```
+
+5. **Run tests** and confirm they pass
+
+   ```shell
+   bundle exec rake test
+   ```
+
+6. **Commit the new version**
+
+   ```shell
+   git add lib/public_suffix/version.rb CHANGELOG.md Gemfile.lock
+   git commit -m "Release $VERSION"
+   ```
+
+7. **Create a signed tag**
+
+   ```shell
+   git tag -a v$VERSION -s -m "Release $VERSION"
+   ```
+
+8. **Push the changes and tag**
+
+   ```shell
+   git push origin main
+   git push origin v$VERSION
+   ```
+
+9. **Build and publish the gem**
+
+   ```shell
+   bundle exec rake release
+   ```
+
+   This will:
+   - Build the gem
+   - Push it to RubyGems
+   - Create a GitHub release
+
+## Post-release
+
+- Verify the new version appears on [RubyGems](https://rubygems.org/gems/public_suffix)
+- Verify the GitHub release was created
+- Announce the release if necessary

data/SECURITY.md

@@ -4,8 +4,7 @@
 
 Security updates are provided only for the current minor version.
 
-If you are using a previous minor version, we recommend to upgrade to the current minor version.
-This project uses [semantic versioning](https://semver.org/), therefore you can upgrade to a more recent minor version without incurring into breaking changes.
+If you are using a previous minor version, we recommend to upgrade to the current minor version. This project uses [semantic versioning](https://semver.org/), therefore you can upgrade to a more recent minor version without incurring into breaking changes.
 
 Exceptionally, we may support previous minor versions upon request if there are significant reasons preventing to immediately switch the latest minor version.