uts58 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 94090cf157a1aad3bbaad182f23ac8041f24ef2636f5899cab3059729d675bcc
+  data.tar.gz: 5c0147a99c2a7ed929e17756a1c16db2d32080c8a19ea9792aeabc40041b4e89
+SHA512:
+  metadata.gz: 8bd0c865a3222e5129c364aa95d5f6efe03a0860457f07095a083a1e203bf13dde564601aaf8fa2e861f106a6df54cb61728f2ba37a5603a819b7c59ef4d4d66
+  data.tar.gz: 61ad2bd233f2ac2266c02a5acce5caf66d2f07b8d23e37a8a75ea5ebe27388b8149a6e77822db63ed9606b6bf75c845ef1efc7a9389313fdfb0525fd6f954de3

data/.github/workflows/ci.yml

@@ -0,0 +1,21 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: ["3.1", "3.2", "3.3", "3.4"]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - run: bundle exec rspec

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec

data/README.md

@@ -0,0 +1,76 @@
+# uts58
+
+A Ruby implementation of [UTS #58](https://www.unicode.org/reports/tr58/),
+the Unicode spec for finding links in running text. Given a chunk of text,
+it returns the URLs in it along with their character offsets.
+
+This covers the **web link** half of UTS #58 only. Email address recognition
+is not implemented here since at the moment it's unclear whether that's
+desirable on generally visible web pages.
+
+Tested extensively on relevant OSes: [![CI](https://github.com/arnt/uts58/actions/workflows/ci.yml/badge.svg)](https://github.com/arnt/uts58/actions/workflows/ci.yml)
+
+## Install
+
+```ruby
+gem "uts58"
+```
+
+## Usage
+
+```ruby
+require "uts58"
+
+Uts58.extract_urls_with_indices("see https://example.com/ for details")
+# => [{ url: "https://example.com/", indices: [4, 24] }]
+
+Uts58.extract_urls("see https://example.com/ for details")
+# => ["https://example.com/"]
+```
+
+The API mirrors `Twitter::TwitterText::Extractor#extract_urls_with_indices`
+closely; it was written to provide what Mastodon uses. The two module-level
+methods above also strip partly overlapping matches; you can use
+`Uts58::Extractor` directly if you'd rather merge with other extractors
+(mentions, hashtags, …) and resolve overlap across all of them yourself.
+
+Input without a scheme is recognised, and `https://` is prepended in the
+returned `:url`:
+
+```ruby
+Uts58.extract_urls_with_indices("blogspot.com is still a thing")
+# => [{ url: "https://blogspot.com", indices: [0, 12] }]
+```
+
+IDNs are decoded to use UTF8 in the output, for better readability:
+
+```ruby
+Uts58.extract_urls("xn-----ctdbabcfhu9c2b9l1acccr4c.xn--mgbah1a3hjkrd").first
+# => "https://تجربة-القبول-الشامل.موريتانيا"
+```
+
+(Admittedly that output isn't very readable if you can't read Arabic.
+But the input wasn't readable to anyone, no matter what languages they
+can read.)
+
+Trailing punctuation, balanced brackets, ports, paths, queries and fragments
+are handled per the spec.
+
+## What's not here
+
+- **Email addresses.** UTS #58 covers them; this gem doesn't. If you
+  need that, send me mail and explain what you need.
+- **Link validation.** Recognised URLs are not fetched, normalised beyond
+  IDN decoding, or their hostnames checked in the DNS. Again, if you
+  need this, send me mail.
+
+## Roadmap
+
+My immediate need is UTS58 conformant link detection suitable for
+public web pages. If you need something more, I rather think that an
+item can be added to this roadmap, so long as the description in the
+rdoc remains short and simple. Send mail to arnt@gulbrandsen.priv.no.
+
+## License
+
+BSD-2-Clause. See `LICENSE`.