Add linking for phone numbers (#52)

Author: Senne021

README.md

@@ -1,6 +1,6 @@
 # `linkify` [![pub package](https://img.shields.io/pub/v/linkify.svg)](https://pub.dartlang.org/packages/linkify)
 
-Low-level link (text, URLs, emails) parsing library in Dart.
+Low-level link (text, URLs, emails, phone numbers) parsing library in Dart.
 
 Required Dart >=2.12 (has null-safety support).
 

lib/src/phone_number.dart

@@ -0,0 +1,71 @@
+import 'package:linkify/linkify.dart';
+
+final _phoneNumberRegex = RegExp(
+  r'^(.*?)((tel:)?[+]*[\s/0-9]{8,15})',
+  caseSensitive: false,
+  dotAll: true,
+);
+
+class PhoneNumberLinkifier extends Linkifier {
+  const PhoneNumberLinkifier();
+
+  @override
+  List<LinkifyElement> parse(elements, options) {
+    final list = <LinkifyElement>[];
+
+    elements.forEach((element) {
+      if (element is TextElement) {
+        var match = _phoneNumberRegex.firstMatch(element.text);
+
+        if (match == null) {
+          list.add(element);
+        } else {
+          final text = element.text.replaceFirst(match.group(0)!, '');
+
+          if (match.group(1)?.isNotEmpty == true) {
+            list.add(TextElement(match.group(1)!));
+          }
+
+          if (match.group(2)?.isNotEmpty == true) {
+            list.add(PhoneNumberElement(
+              match.group(2)!.replaceFirst(RegExp(r'tel:'), ''),
+            ));
+          }
+
+          if (text.isNotEmpty) {
+            list.addAll(parse([TextElement(text)], options));
+          }
+        }
+      } else {
+        list.add(element);
+      }
+    });
+
+    return list;
+  }
+}
+
+/// Represents an element containing a phone number
+class PhoneNumberElement extends LinkableElement {
+  final String phoneNumber;
+
+  PhoneNumberElement(this.phoneNumber)
+      : super(
+          phoneNumber,
+          'tel:$phoneNumber',
+        );
+
+  @override
+  String toString() {
+    return "PhoneNumberElement: '$phoneNumber' ($text)";
+  }
+
+  @override
+  bool operator ==(other) => equals(other);
+
+  @override
+  bool equals(other) =>
+      other is PhoneNumberElement &&
+      super.equals(other) &&
+      other.phoneNumber == phoneNumber;
+}

test/linkify_test.dart

@@ -2,6 +2,8 @@ import 'package:collection/collection.dart';
 import 'package:linkify/linkify.dart';
 import 'package:test/test.dart';
 
+import '../lib/src/phone_number.dart';
+
 final listEqual = const ListEquality().equals;
 
 void expectListEqual(List actual, List expected) {
@@ -215,14 +217,28 @@ void main() {
 
   test('Parses user tag', () {
     expectListEqual(
-      linkify("@example"),
+      linkify(
+        "@example",
+        linkifiers: [
+          UrlLinkifier(),
+          EmailLinkifier(),
+          UserTagLinkifier(),
+        ],
+      ),
       [UserTagElement("@example")],
     );
   });
 
   test('Parses email, link, and user tag', () {
     expectListEqual(
-      linkify("person@example.com at https://google.com @example"),
+      linkify(
+        "person@example.com at https://google.com @example",
+        linkifiers: [
+          UrlLinkifier(),
+          EmailLinkifier(),
+          UserTagLinkifier(),
+        ],
+      ),
       [
         EmailElement("person@example.com"),
         TextElement(" at "),
@@ -232,4 +248,71 @@ void main() {
       ],
     );
   });
+
+  test('Parses invalid phone number', () {
+    expectListEqual(
+      linkify(
+        "This is an invalid numbers 17.00",
+        linkifiers: [
+          UrlLinkifier(),
+          EmailLinkifier(),
+          PhoneNumberLinkifier(),
+        ],
+      ),
+      [
+        TextElement("This is an invalid numbers 17.00"),
+      ],
+    );
+  });
+
+  test('Parses german phone number', () {
+    expectListEqual(
+      linkify(
+        "This is a german example number +49 30 901820",
+        linkifiers: [
+          UrlLinkifier(),
+          EmailLinkifier(),
+          PhoneNumberLinkifier(),
+        ],
+      ),
+      [
+        TextElement("This is a german example number "),
+        PhoneNumberElement("+49 30 901820"),
+      ],
+    );
+  });
+
+  test('Parses seattle phone number', () {
+    expectListEqual(
+      linkify(
+        "This is a seattle example number +1 206 555 0100",
+        linkifiers: [
+          UrlLinkifier(),
+          EmailLinkifier(),
+          PhoneNumberLinkifier(),
+        ],
+      ),
+      [
+        TextElement("This is a seattle example number "),
+        PhoneNumberElement("+1 206 555 0100"),
+      ],
+    );
+  });
+
+  test('Parses uk phone number', () {
+    expectListEqual(
+      linkify(
+        "This is an example number from uk: +44 113 496 0000",
+        linkifiers: [
+          UrlLinkifier(),
+          EmailLinkifier(),
+          PhoneNumberLinkifier(),
+        ],
+      ),
+      [
+        TextElement("This is an example number from uk: "),
+        PhoneNumberElement("+44 113 496 0000"),
+      ],
+    );
+  });
 }