How does Addressable handle international domain names?

Addressable supports IDN through normalization, converting non-ASCII domains to Punycode. For native support, you need to install libidn and the idn-ruby gem, as specified in the README, which enhances processing efficiency.

Addressable vs Ruby URI: which is better for web scraping?

Use Addressable if you encounter URIs with non-ASCII characters or need heuristic parsing for malformed links. Ruby URI is sufficient for simple, well-formed ASCII URIs and avoids extra dependencies.

How to expand URI templates with query parameters in Addressable?

Create an Addressable::Template with a pattern like 'http://example.com/{?query*}' and call expand with a hash. The README shows examples for complex expansions, including nested parameters and partial expansions.

Does Addressable support IPv6 addresses in URIs?

Yes, as it's RFC 3986 compliant, Addressable correctly parses and handles IPv6 addresses enclosed in brackets, ensuring compatibility with modern network standards.

How to install Addressable on macOS with full IDN support?

Install libidn via Homebrew (brew install libidn), then install the idn-ruby gem alongside Addressable. The README provides OS-specific commands, but this adds steps beyond a basic gem install.

Is Addressable compatible with Rails applications?

Yes, it works seamlessly with Rails, but you may need to replace stdlib URI usage in existing code. It's often used in gems like HTTParty for robust URI handling in API clients.

Open-Awesome

Addressable

Apache-2.0Ruby

A flexible Ruby URI library with heuristic parsing, IRI support, and RFC-compliant URI templates.

GitHub

1.6k stars279 forks0 contributors

What is Addressable?

Addressable is a Ruby library that provides an alternative implementation to Ruby's standard URI module. It offers enhanced parsing flexibility, support for Internationalized Resource Identifiers (IRIs), and comprehensive URI template functionality based on RFC standards. It solves the limitations of Ruby's built-in URI handling for modern web applications requiring robust URI manipulation.

Target Audience

Ruby developers building web applications, APIs, or tools that require reliable URI parsing, internationalization support, or dynamic URI generation using templates.

Value Proposition

Developers choose Addressable for its strict RFC compliance, heuristic parsing that handles edge cases, and advanced features like IRI support and URI templates not available in Ruby's standard library, making it a more robust and future-proof solution.

Overview

Addressable is an alternative implementation to the URI implementation that is part of Ruby's standard library. It is flexible, offers heuristic parsing, and additionally provides extensive support for IRIs and URI templates.

Use Cases

Best For

Parsing and normalizing URIs with non-ASCII characters (IRIs)
Generating dynamic URIs using RFC 6570 compliant templates
Replacing Ruby's standard URI library with a more flexible alternative
Handling edge-case URIs with heuristic parsing
Building web crawlers or API clients that need robust URI manipulation
Internationalized applications requiring IDN (Internationalized Domain Name) support

Not Ideal For

Projects handling only simple, ASCII-only URIs with no need for templates or internationalization
Applications with strict dependency minimization policies avoiding external gems
Legacy systems deeply integrated with Ruby's stdlib URI where migration would be disruptive
Performance-critical microservices parsing millions of URIs where stdlib URI's speed suffices

Pros & Cons

Pros

Heuristic Parsing

Intelligently handles URIs that don't strictly conform to standards, as highlighted in the README, reducing parsing errors for edge-case inputs.

IRI Support

Full support for Internationalized Resource Identifiers allows non-ASCII characters in URIs, essential for global applications with international domain names.

URI Templates

Implements RFC 6570 Level 4 for dynamic URI construction and extraction, enabling advanced templating features like partial expansion and extraction from existing URIs.

RFC Compliance

Closely conforms to RFC 3986, 3987, and 6570, ensuring strict standards adherence for reliable URI handling in modern web development.

Cons

Native IDN Dependency

For full IDN support, requires installing libidn and the idn-ruby gem, adding installation complexity and potential cross-platform issues, as admitted in the README.

Performance Overhead

The heuristic parsing and additional features likely introduce performance costs compared to Ruby's lighter stdlib URI, which could impact high-volume applications.

API Learning Curve

Developers familiar with Ruby's standard URI module must learn a new API, slowing adoption and increasing initial development time for simple use cases.

Frequently Asked Questions

Related Projects

Virtus

[DISCONTINUED ] Attributes on Steroids for Plain Old Ruby Objects

Stars3,746

Forks231

Last commit5 years ago

Hashie

Hashie is a collection of classes and mixins that make Ruby hashes more powerful.

Stars3,038

Forks315

Last commit1 month ago

Hamster

Efficient, Immutable, Thread-Safe Collection classes for Ruby

Stars1,911

Forks92

Last commit4 years ago

ActiveAttr

What ActiveModel left out

Stars1,196

Forks91

Last commit4 months ago

Community-curated · Updated weekly · 100% open source

Found a gem we're missing?

Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.

Submit a project Star on GitHub