Protocol::URL

Provides abstractions for working with URLs.

Usage

Please browse the source code index or refer to the guides below.

Getting Started

This guide explains how to get started with protocol-url for parsing, manipulating, and constructing URLs in Ruby.

Working with References

This guide explains how to use for managing URLs with query parameters and fragments.

Contributing

We welcome contributions to this project.

Fork the repository.
Create your feature branch (git checkout -b my-new-feature).
Commit your changes (git commit -am 'Add some feature.').
Push to the branch (git push origin my-new-feature).
Create a new pull request.

Running Tests

To run the test suite:

bundle exec sus

Making Releases

Please browse the releases for more details.

v0.18.0

Support explicit URL serialization for mixed grammars, and remove explicit prefixes from relative path calculation.

v0.17.0

Add optional explicit ./ prefixes when generating same-directory relative URLs.

v0.16.0

Preserve directory and file semantics when generating relative URL paths.

v0.15.0

Add Protocol::URL::Relative#relative_to for expressing root-relative URLs relative to a base path.

v0.14.0

Allow paths to compare with their encoded string representation.

v0.13.0

Add conservative normalization of encoded URL paths.

v0.12.0

Allow unfrozen relative and absolute URLs to replace their components.

v0.10.0

Rename Protocol::URL::FormData::Parser::CONTENT_TYPE to MEDIA_TYPE.

v0.9.0

Add Protocol::URL::LimitError for configured processing limits.

v0.8.0

Use consistent limit naming for form data parser constraints.

v0.18.0

Support explicit URL serialization for mixed grammars, and remove explicit prefixes from relative path calculation.

v0.17.0

Add optional explicit ./ prefixes when generating same-directory relative URLs.

v0.16.0

Preserve directory and file semantics when generating relative URL paths.

v0.15.0

Add Protocol::URL::Relative#relative_to for expressing root-relative URLs relative to a base path.

v0.14.0

Allow paths to compare with their encoded string representation.

v0.13.0

Add conservative normalization of encoded URL paths.

v0.12.0

Allow unfrozen relative and absolute URLs to replace their components.

v0.10.0

Rename Protocol::URL::FormData::Parser::CONTENT_TYPE to MEDIA_TYPE.

v0.9.0

Add Protocol::URL::LimitError for configured processing limits.

v0.8.0

Use consistent limit naming for form data parser constraints.

v0.17.0

Add optional explicit ./ prefixes when generating same-directory relative URLs.

v0.16.0

Preserve directory and file semantics when generating relative URL paths.

v0.15.0

Add Protocol::URL::Relative#relative_to for expressing root-relative URLs relative to a base path.

v0.14.0

Allow paths to compare with their encoded string representation.

v0.13.0

Add conservative normalization of encoded URL paths.

v0.12.0

Allow unfrozen relative and absolute URLs to replace their components.

v0.10.0

Rename Protocol::URL::FormData::Parser::CONTENT_TYPE to MEDIA_TYPE.

v0.9.0

Add Protocol::URL::LimitError for configured processing limits.

v0.8.0

Use consistent limit naming for form data parser constraints.

v0.7.0

Allow Protocol::URL::FormData::Parser#parse to populate a supplied result object.

v0.16.0

Preserve directory and file semantics when generating relative URL paths.

v0.15.0

Add Protocol::URL::Relative#relative_to for expressing root-relative URLs relative to a base path.

v0.14.0

Allow paths to compare with their encoded string representation.

v0.13.0

Add conservative normalization of encoded URL paths.

v0.12.0

Allow unfrozen relative and absolute URLs to replace their components.

v0.10.0

Rename Protocol::URL::FormData::Parser::CONTENT_TYPE to MEDIA_TYPE.

v0.9.0

Add Protocol::URL::LimitError for configured processing limits.

v0.8.0

Use consistent limit naming for form data parser constraints.

v0.7.0

Allow Protocol::URL::FormData::Parser#parse to populate a supplied result object.

v0.6.0

Add Protocol::URL::FormData::Parser for incremental, limited parsing of application/x-www-form-urlencoded form data.
Add Protocol::URL::FormData::Nested for consistently building nested form data while preserving absent and empty values.

v0.15.0

Add Protocol::URL::Relative#relative_to for expressing root-relative URLs relative to a base path.

v0.14.0

Allow paths to compare with their encoded string representation.

v0.13.0

Add conservative normalization of encoded URL paths.

v0.12.0

Allow unfrozen relative and absolute URLs to replace their components.

v0.10.0

Rename Protocol::URL::FormData::Parser::CONTENT_TYPE to MEDIA_TYPE.

v0.9.0

Add Protocol::URL::LimitError for configured processing limits.

v0.8.0

Use consistent limit naming for form data parser constraints.

v0.7.0

Allow Protocol::URL::FormData::Parser#parse to populate a supplied result object.

v0.6.0

Add Protocol::URL::FormData::Parser for incremental, limited parsing of application/x-www-form-urlencoded form data.
Add Protocol::URL::FormData::Nested for consistently building nested form data while preserving absent and empty values.

v0.5.0

Add Protocol::URL::Encoding.decode_www_form for decoding HTML form data where + represents a space.

v0.14.0

Allow paths to compare with their encoded string representation.

v0.13.0

Add conservative normalization of encoded URL paths.

v0.12.0

Allow unfrozen relative and absolute URLs to replace their components.

v0.10.0

Rename Protocol::URL::FormData::Parser::CONTENT_TYPE to MEDIA_TYPE.

v0.9.0

Add Protocol::URL::LimitError for configured processing limits.

v0.8.0

Use consistent limit naming for form data parser constraints.

v0.7.0

Allow Protocol::URL::FormData::Parser#parse to populate a supplied result object.

v0.6.0

Add Protocol::URL::FormData::Parser for incremental, limited parsing of application/x-www-form-urlencoded form data.
Add Protocol::URL::FormData::Nested for consistently building nested form data while preserving absent and empty values.

v0.5.0

Add Protocol::URL::Encoding.decode_www_form for decoding HTML form data where + represents a space.

v0.4.0

Add comparison methods to Protocol::URL::Relative (and by inheritance to Protocol::URL::Absolute):
- #== for structural equality comparison (compares path, query, fragment components).
- #=== for string equality comparison (enables case statement matching).
- #<=> for ordering and sorting.
- #hash for hash key support.
- #equal? for component-based equality checking.
Add JSON serialization support to Protocol::URL::Relative:
- #as_json returns the string representation.
- #to_json returns a JSON-encoded string.

v0.13.0

Add conservative normalization of encoded URL paths.

v0.12.0

Allow unfrozen relative and absolute URLs to replace their components.

v0.10.0

Rename Protocol::URL::FormData::Parser::CONTENT_TYPE to MEDIA_TYPE.

v0.9.0

Add Protocol::URL::LimitError for configured processing limits.

v0.8.0

Use consistent limit naming for form data parser constraints.

v0.7.0

Allow Protocol::URL::FormData::Parser#parse to populate a supplied result object.

v0.6.0

Add Protocol::URL::FormData::Parser for incremental, limited parsing of application/x-www-form-urlencoded form data.
Add Protocol::URL::FormData::Nested for consistently building nested form data while preserving absent and empty values.

v0.5.0

Add Protocol::URL::Encoding.decode_www_form for decoding HTML form data where + represents a space.

v0.4.0

Add comparison methods to Protocol::URL::Relative (and by inheritance to Protocol::URL::Absolute):
- #== for structural equality comparison (compares path, query, fragment components).
- #=== for string equality comparison (enables case statement matching).
- #<=> for ordering and sorting.
- #hash for hash key support.
- #equal? for component-based equality checking.
Add JSON serialization support to Protocol::URL::Relative:
- #as_json returns the string representation.
- #to_json returns a JSON-encoded string.

v0.3.0

Add relative(target, from) for computing relative paths between URLs.

v0.12.0

Allow unfrozen relative and absolute URLs to replace their components.

v0.10.0

Rename Protocol::URL::FormData::Parser::CONTENT_TYPE to MEDIA_TYPE.

v0.9.0

Add Protocol::URL::LimitError for configured processing limits.

v0.8.0

Use consistent limit naming for form data parser constraints.

v0.7.0

Allow Protocol::URL::FormData::Parser#parse to populate a supplied result object.

v0.6.0

Add Protocol::URL::FormData::Parser for incremental, limited parsing of application/x-www-form-urlencoded form data.
Add Protocol::URL::FormData::Nested for consistently building nested form data while preserving absent and empty values.

v0.5.0

Add Protocol::URL::Encoding.decode_www_form for decoding HTML form data where + represents a space.

v0.4.0

Add comparison methods to Protocol::URL::Relative (and by inheritance to Protocol::URL::Absolute):
- #== for structural equality comparison (compares path, query, fragment components).
- #=== for string equality comparison (enables case statement matching).
- #<=> for ordering and sorting.
- #hash for hash key support.
- #equal? for component-based equality checking.
Add JSON serialization support to Protocol::URL::Relative:
- #as_json returns the string representation.
- #to_json returns a JSON-encoded string.

v0.3.0

Add relative(target, from) for computing relative paths between URLs.

v0.2.0

Move Protocol::URL::PATTERN to protocol/url/pattern.rb so it can be shared more easily.

v0.10.0

Rename Protocol::URL::FormData::Parser::CONTENT_TYPE to MEDIA_TYPE.

v0.9.0

Add Protocol::URL::LimitError for configured processing limits.

v0.8.0

Use consistent limit naming for form data parser constraints.

v0.7.0

Allow Protocol::URL::FormData::Parser#parse to populate a supplied result object.

v0.6.0

Add Protocol::URL::FormData::Parser for incremental, limited parsing of application/x-www-form-urlencoded form data.
Add Protocol::URL::FormData::Nested for consistently building nested form data while preserving absent and empty values.

v0.5.0

Add Protocol::URL::Encoding.decode_www_form for decoding HTML form data where + represents a space.

v0.4.0

Add comparison methods to Protocol::URL::Relative (and by inheritance to Protocol::URL::Absolute):
- #== for structural equality comparison (compares path, query, fragment components).
- #=== for string equality comparison (enables case statement matching).
- #<=> for ordering and sorting.
- #hash for hash key support.
- #equal? for component-based equality checking.
Add JSON serialization support to Protocol::URL::Relative:
- #as_json returns the string representation.
- #to_json returns a JSON-encoded string.

v0.3.0

Add relative(target, from) for computing relative paths between URLs.

v0.2.0

Move Protocol::URL::PATTERN to protocol/url/pattern.rb so it can be shared more easily.

v0.1.0

Initial implementation.

Developer Certificate of Origin

In order to protect users of this project, we require all contributors to comply with the Developer Certificate of Origin. This ensures that all contributions are properly licensed and attributed.

Community Guidelines

This project is best served by a collaborative and respectful environment. Treat each other professionally, respect differing viewpoints, and engage constructively. Harassment, discrimination, or harmful behavior is not tolerated. Communicate clearly, listen actively, and support one another. If any issues arise, please inform the project maintainers.

Releases

Please see the project releases for all releases.

v0.10.0

Rename Protocol::URL::FormData::Parser::CONTENT_TYPE to MEDIA_TYPE.

v0.9.0

Add Protocol::URL::LimitError for configured processing limits.

v0.8.0

Use consistent limit naming for form data parser constraints.

v0.7.0

Allow Protocol::URL::FormData::Parser#parse to populate a supplied result object.

v0.6.0

Add Protocol::URL::FormData::Parser for incremental, limited parsing of application/x-www-form-urlencoded form data.
Add Protocol::URL::FormData::Nested for consistently building nested form data while preserving absent and empty values.

v0.5.0

Add Protocol::URL::Encoding.decode_www_form for decoding HTML form data where + represents a space.

v0.4.0

Add comparison methods to Protocol::URL::Relative (and by inheritance to Protocol::URL::Absolute):
- #== for structural equality comparison (compares path, query, fragment components).
- #=== for string equality comparison (enables case statement matching).
- #<=> for ordering and sorting.
- #hash for hash key support.
- #equal? for component-based equality checking.
Add JSON serialization support to Protocol::URL::Relative:
- #as_json returns the string representation.
- #to_json returns a JSON-encoded string.

v0.3.0

Add relative(target, from) for computing relative paths between URLs.

v0.2.0

Move Protocol::URL::PATTERN to protocol/url/pattern.rb so it can be shared more easily.

v0.1.0

Initial implementation.