public_suffix 6.0.2 → 7.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 04ff8ba3506464503a796f29cf86abe2c495ed69d83c702e3e1394a76ff53a38
-  data.tar.gz: 4818f5ce2d34c646bb3f25ebfba6cc830983f03609f957550173f8d8381d993a
+  metadata.gz: '084a35b60185cb9effa86043e48492bbdef04d05f0f25b022cd4814b812b3de2'
+  data.tar.gz: 70c513a2c19d770c0d6d929a9bb8fe868a9df87b899af6eaf4ffe24a4acfc903
 SHA512:
-  metadata.gz: f984cc18b6e52a2da58568c0c60a40b316437191f56a016684080cba1107c98c41712184b77d67dbe89dadb8b09aa52d999d789ed52e795fc3329a960b3ed20c
-  data.tar.gz: 39d3e8228b45a8e940edd1b6fc1646e9eaad6a51d4c4227c46b88c305ed4e4452b201b05c4978fde502243b82d3ebc9baab4b339d75e4899b8648574d8e31c49
+  metadata.gz: 867e2369292df3275da727802270527999530fff53b9683228edf4f183e9f8fd7592cb3da2d2bf0923f2b7c727e778dbc45e329f234e7f1869d74f298994bf5a
+  data.tar.gz: 9fbbcf8839be0685d98d91e6fb44ec010f3dd2c3e80469b57b1138465701b3b0168da508aa3f7c8a3e46897c8135b337b2b64e1d17fb058e4de02a11efc4e984

data/CHANGELOG.md

@@ -3,6 +3,14 @@
 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

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 >= 3.0**. 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
@@ -106,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
@@ -122,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)
@@ -148,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.
 
@@ -165,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.
 
@@ -180,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-2025 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.
 
-## Definitions
 
-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.
+## Security and vulnerability reporting
 
-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.
+For full information and details about our security policy, please visit [`SECURITY.md`](SECURITY.md).
+
+
+## Changelog
 
-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.
+See [CHANGELOG.md](CHANGELOG.md) for details.
 
-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]`.
+
+## License
+
+Copyright (c) 2009-2025 Simone Carletti. This is Free Software distributed under the MIT license.
+
+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