RubyGems - public_suffix - Versions diffs - 6.0.2 → 7.0.1 - Mend

public_suffix 6.0.2 → 7.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (16) hide show

data/CLAUDE.md ADDED Viewed

	@@ -0,0 +1 @@
1	+ AGENTS.md

data/CONTRIBUTING.md ADDED Viewed

@@ -0,0 +1,129 @@
+# Contributing to PublicSuffix for Ruby
+Thank you for your interest in contributing to PublicSuffix for Ruby!
+## Development Workflow
+1. Fork and clone the repository
+2. Install dependencies: `bundle install`
+3. Create a branch: `git checkout -b feature/your-feature`
+4. Make your changes
+5. Run tests: `rake test`
+6. Commit using Conventional Commits format (see below)
+7. Push and create a pull request
+## Commit Message Guidelines
+We follow the [Conventional Commits](https://www.conventionalcommits.org/) specification for commit messages.
+We follow the [Common Changelog](https://common-changelog.org/) format for changelog entries.
+### Format
+```
+<type>(<scope>): <subject>
+<body>
+<footer>
+```
+Use lowercase for `<type>`. Capitalize the first letter of `<subject>` (sentence-style). See examples below.
+### Type
+- **feat**: A new feature
+- **fix**: A bug fix
+- **chore**: Other changes that don't modify src or test files
+- **docs**: Documentation only changes
+- **style**: Code style changes (formatting, etc.)
+- **refactor**: Code change that neither fixes a bug nor adds a feature
+- **perf**: Performance improvement
+- **test**: Adding or updating tests
+- **build**: Changes to build system or external dependencies
+- **ci**: Changes to CI configuration files and scripts
+### Scope
+- **parser**: List parsing and rule handling
+- **domain**: Domain parsing and validation
+- **list**: List management and operations
+- **rule**: Rule definitions and matching
+### Examples
+```bash
+feat(parser): Add support for wildcard exceptions
+fix(domain): Handle FQDN trailing dots correctly
+docs: Update usage examples in README
+refactor(list): Simplify rule lookup logic
+```
+### Breaking Changes
+Add `BREAKING CHANGE:` in the footer:
+```
+feat(domain): Change parse return type
+BREAKING CHANGE: Domain#parse now returns nil for invalid domains instead of raising.
+Update code to check for nil returns.
+```
+## Testing
+### Running Tests
+```bash
+rake test                        # Run all tests
+rake test TEST=test/domain_test.rb  # Run specific test file
+```
+### Writing Tests
+- Tests use Minitest framework
+- Place tests in `test/` directory
+- Use descriptive test names
+- Test both happy paths and error cases
+- Include tests for edge cases (empty strings, unicode, etc.)
+## Pull Request Process
+1. Update documentation for API changes
+2. Add tests for new features or bug fixes
+3. Ensure all tests pass: `rake test`
+4. Use Conventional Commits format
+5. Provide clear PR description with context
+6. Reference related issues if applicable
+## Code Style
+- Follow [Ruby Style Guide](https://rubystyle.guide/)
+- Use RuboCop configuration if present
+- Add YARD documentation for public methods
+- Keep methods focused and small
+### Ruby-Specific Guidelines
+- Follow idiomatic Ruby patterns
+- Use meaningful variable and method names
+- Prefer `raise` over `fail`
+- Use blocks and iterators effectively
+- Follow the principle of least surprise
+- Prefer methods that return values over side effects
+### Documentation
+- Add YARD comments for public methods
+- Include usage examples in documentation
+- Update README.md for user-facing changes
+- Keep inline comments minimal - prefer self-documenting code
+## Questions?
+Open an issue for questions, feature discussions, or bug reports.
+Thank you for contributing!

data/LICENSE.txt CHANGED Viewed

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

data/README.md CHANGED Viewed

@@ -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-2026 Simone Carletti. [MIT License](LICENSE.txt).
+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 ADDED Viewed

@@ -0,0 +1,96 @@
+# 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 following the [Common Changelog](https://common-changelog.org/) format (see [CONTRIBUTING.md](CONTRIBUTING.md) for details):
+   ```markdown
+   ## X.Y.Z - YYYY-MM-DD
+   ### Changed
+   - 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 commit -am "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