Linkify See merge request pleroma/linkify!18merge-requests/19/head
@ -1,30 +0,0 @@ | |||
# This file is responsible for configuring your application | |||
# and its dependencies with the aid of the Mix.Config module. | |||
use Mix.Config | |||
# This configuration is loaded before any dependency and is restricted | |||
# to this project. If another project depends on this project, this | |||
# file won't be loaded nor affect the parent project. For this reason, | |||
# if you want to provide default values for your application for | |||
# 3rd-party users, it should be done in your "mix.exs" file. | |||
# You can configure for your application as: | |||
# | |||
# config :auto_linker, key: :value | |||
# | |||
# And access this configuration in your application as: | |||
# | |||
# Application.get_env(:auto_linker, :key) | |||
# | |||
# Or configure a 3rd-party app: | |||
# | |||
# config :logger, level: :info | |||
# | |||
# It is also possible to import configuration files, relative to this | |||
# directory. For example, you can emulate configuration per environment | |||
# by uncommenting the line below and defining dev.exs, test.exs and such. | |||
# Configuration from the imported file will override the ones defined | |||
# here (which is why it is important to import them last). | |||
# | |||
# import_config "#{Mix.env}.exs" |
@ -1,69 +0,0 @@ | |||
defmodule AutoLinker do | |||
@moduledoc """ | |||
Create url links from text containing urls. | |||
Turns an input string like `"Check out google.com"` into | |||
`Check out "<a href=\"http://google.com\" target=\"_blank\" rel=\"noopener noreferrer\">google.com</a>"` | |||
## Examples | |||
iex> AutoLinker.link("google.com") | |||
~s(<a href="http://google.com" class="auto-linker" target="_blank" rel="noopener noreferrer">google.com</a>) | |||
iex> AutoLinker.link("google.com", new_window: false, rel: false) | |||
~s(<a href="http://google.com" class="auto-linker">google.com</a>) | |||
iex> AutoLinker.link("google.com", new_window: false, rel: false, class: false) | |||
~s(<a href="http://google.com">google.com</a>) | |||
iex> AutoLinker.link("[Google](http://google.com)", markdown: true, new_window: false, rel: false, class: false) | |||
~s(<a href='http://google.com'>Google</a>) | |||
iex> AutoLinker.link("[Google Search](http://google.com)", markdown: true) | |||
~s(<a href='http://google.com' class="auto-linker" target="_blank" rel="noopener noreferrer">Google Search</a>) | |||
""" | |||
import AutoLinker.Parser | |||
@doc """ | |||
Auto link a string. | |||
Options: | |||
* `class: "auto-linker"` - specify the class to be added to the generated link. false to clear | |||
* `rel: "noopener noreferrer"` - override the rel attribute. false to clear | |||
* `new_window: true` - set to false to remove `target='_blank'` attribute | |||
* `scheme: false` - Set to true to link urls with schema `http://google` | |||
* `truncate: false` - Set to a number to truncate urls longer then the number. Truncated urls will end in `..` | |||
* `strip_prefix: true` - Strip the scheme prefix | |||
* `exclude_class: false` - Set to a class name when you don't want urls auto linked in the html of the give class | |||
* `exclude_id: false` - Set to an element id when you don't want urls auto linked in the html of the give element | |||
* `exclude_patterns: ["```"]` - Don't link anything between the the pattern | |||
* `markdown: false` - link markdown style links | |||
* `email: false` - link email links | |||
* `mention: false` - link @mentions (when `true`, requires `mention_prefix` or `mention_handler` options to be set) | |||
* `mention_prefix: nil` - a prefix to build a link for a mention (example: `https://example.com/user/`) | |||
* `mention_handler: nil` - a custom handler to validate and formart a mention | |||
* `hashtag: false` - link #hashtags (when `true`, requires `hashtag_prefix` or `hashtag_handler` options to be set) | |||
* `hashtag_prefix: nil` - a prefix to build a link for a hashtag (example: `https://example.com/tag/`) | |||
* `hashtag_handler: nil` - a custom handler to validate and formart a hashtag | |||
* `extra: false` - link urls with rarely used schemes (magnet, ipfs, irc, etc.) | |||
* `validate_tld: true` - Set to false to disable TLD validation for urls/emails, also can be set to :no_scheme to validate TLDs only for urls without a scheme (e.g `example.com` will be validated, but `http://example.loki` won't) | |||
Each of the above options can be specified when calling `link(text, opts)` | |||
or can be set in the `:auto_linker`'s configuration. For example: | |||
config :auto_linker, | |||
class: false, | |||
new_window: false | |||
Note that passing opts to `link/2` will override the configuration settings. | |||
""" | |||
def link(text, opts \\ []) do | |||
parse(text, opts) | |||
end | |||
def link_map(text, acc, opts \\ []) do | |||
parse({text, acc}, opts) | |||
end | |||
end |
@ -0,0 +1,51 @@ | |||
defmodule Linkify do | |||
@moduledoc """ | |||
Create url links from text containing urls. | |||
Turns an input string like `"Check out google.com"` into | |||
`Check out "<a href=\"http://google.com\">google.com</a>"` | |||
## Examples | |||
iex> Linkify.link("google.com") | |||
~s(<a href="http://google.com">google.com</a>) | |||
iex> Linkify.link("google.com", new_window: true, rel: "noopener noreferrer") | |||
~s(<a href="http://google.com" target="_blank" rel="noopener noreferrer">google.com</a>) | |||
iex> Linkify.link("google.com", class: "linkified") | |||
~s(<a href="http://google.com" class="linkified">google.com</a>) | |||
""" | |||
import Linkify.Parser | |||
@doc """ | |||
Finds links and turns them into HTML `<a>` tag. | |||
Options: | |||
* `class` - specify the class to be added to the generated link. | |||
* `rel` - specify the rel attribute. | |||
* `new_window` - set to `true` to add `target="_blank"` attribute | |||
* `truncate` - Set to a number to truncate urls longer then the number. Truncated urls will end in `...` | |||
* `strip_prefix` - Strip the scheme prefix (default: `false`) | |||
* `exclude_class` - Set to a class name when you don't want urls auto linked in the html of the give class (default: `false`) | |||
* `exclude_id` - Set to an element id when you don't want urls auto linked in the html of the give element (default: `false`) | |||
* `email` - link email links (default: `false`) | |||
* `mention` - link @mentions (when `true`, requires `mention_prefix` or `mention_handler` options to be set) (default: `false`) | |||
* `mention_prefix` - a prefix to build a link for a mention (example: `https://example.com/user/`, default: `nil`) | |||
* `mention_handler` - a custom handler to validate and formart a mention (default: `nil`) | |||
* `hashtag: false` - link #hashtags (when `true`, requires `hashtag_prefix` or `hashtag_handler` options to be set) | |||
* `hashtag_prefix: nil` - a prefix to build a link for a hashtag (example: `https://example.com/tag/`) | |||
* `hashtag_handler: nil` - a custom handler to validate and formart a hashtag | |||
* `extra: false` - link urls with rarely used schemes (magnet, ipfs, irc, etc.) | |||
* `validate_tld: true` - Set to false to disable TLD validation for urls/emails, also can be set to :no_scheme to validate TLDs only for urls without a scheme (e.g `example.com` will be validated, but `http://example.loki` won't) | |||
""" | |||
def link(text, opts \\ []) do | |||
parse(text, opts) | |||
end | |||
def link_map(text, acc, opts \\ []) do | |||
parse({text, acc}, opts) | |||
end | |||
end |
@ -1,12 +1,10 @@ | |||
%{ | |||
"bunt": {:hex, :bunt, "0.2.0", "951c6e801e8b1d2cbe58ebbd3e616a869061ddadcc4863d0a2182541acae9a38", [:mix], [], "hexpm"}, | |||
"credo": {:hex, :credo, "1.0.2", "88bc918f215168bf6ce7070610a6173c45c82f32baa08bdfc80bf58df2d103b6", [:mix], [{:bunt, "~> 0.2.0", [hex: :bunt, repo: "hexpm", optional: false]}, {:jason, "~> 1.0", [hex: :jason, repo: "hexpm", optional: false]}], "hexpm"}, | |||
"earmark": {:hex, :earmark, "1.3.1", "73812f447f7a42358d3ba79283cfa3075a7580a3a2ed457616d6517ac3738cb9", [:mix], [], "hexpm"}, | |||
"ex_doc": {:hex, :ex_doc, "0.19.3", "3c7b0f02851f5fc13b040e8e925051452e41248f685e40250d7e40b07b9f8c10", [:mix], [{:earmark, "~> 1.2", [hex: :earmark, repo: "hexpm", optional: false]}, {:makeup_elixir, "~> 0.10", [hex: :makeup_elixir, repo: "hexpm", optional: false]}], "hexpm"}, | |||
"file_system": {:hex, :file_system, "0.2.6", "fd4dc3af89b9ab1dc8ccbcc214a0e60c41f34be251d9307920748a14bf41f1d3", [:mix], [], "hexpm"}, | |||
"credo": {:hex, :credo, "1.1.0", "e0c07b2fd7e2109495f582430a1bc96b2c71b7d94c59dfad120529f65f19872f", [:mix], [{:bunt, "~> 0.2.0", [hex: :bunt, repo: "hexpm", optional: false]}, {:jason, "~> 1.0", [hex: :jason, repo: "hexpm", optional: false]}], "hexpm"}, | |||
"earmark": {:hex, :earmark, "1.3.2", "b840562ea3d67795ffbb5bd88940b1bed0ed9fa32834915125ea7d02e35888a5", [:mix], [], "hexpm"}, | |||
"ex_doc": {:hex, :ex_doc, "0.20.2", "1bd0dfb0304bade58beb77f20f21ee3558cc3c753743ae0ddbb0fd7ba2912331", [:mix], [{:earmark, "~> 1.3", [hex: :earmark, repo: "hexpm", optional: false]}, {:makeup_elixir, "~> 0.10", [hex: :makeup_elixir, repo: "hexpm", optional: false]}], "hexpm"}, | |||
"jason": {:hex, :jason, "1.1.2", "b03dedea67a99223a2eaf9f1264ce37154564de899fd3d8b9a21b1a6fd64afe7", [:mix], [{:decimal, "~> 1.0", [hex: :decimal, repo: "hexpm", optional: true]}], "hexpm"}, | |||
"makeup": {:hex, :makeup, "0.8.0", "9cf32aea71c7fe0a4b2e9246c2c4978f9070257e5c9ce6d4a28ec450a839b55f", [:mix], [{:nimble_parsec, "~> 0.5.0", [hex: :nimble_parsec, repo: "hexpm", optional: false]}], "hexpm"}, | |||
"makeup_elixir": {:hex, :makeup_elixir, "0.13.0", "be7a477997dcac2e48a9d695ec730b2d22418292675c75aa2d34ba0909dcdeda", [:mix], [{:makeup, "~> 0.8", [hex: :makeup, repo: "hexpm", optional: false]}], "hexpm"}, | |||
"mix_test_watch": {:hex, :mix_test_watch, "0.9.0", "c72132a6071261893518fa08e121e911c9358713f62794a90c95db59042af375", [:mix], [{:file_system, "~> 0.2.1 or ~> 0.3", [hex: :file_system, repo: "hexpm", optional: false]}], "hexpm"}, | |||
"nimble_parsec": {:hex, :nimble_parsec, "0.5.0", "90e2eca3d0266e5c53f8fbe0079694740b9c91b6747f2b7e3c5d21966bba8300", [:mix], [], "hexpm"}, | |||
} |
@ -1,448 +0,0 @@ | |||
defmodule AutoLinkerTest do | |||
use ExUnit.Case, async: true | |||
doctest AutoLinker | |||
test "phone number" do | |||
assert AutoLinker.link(", work (555) 555-5555", phone: true) == | |||
~s{, work <a href="#" class="phone-number" data-phone="5555555555">(555) 555-5555</a>} | |||
end | |||
test "default link" do | |||
assert AutoLinker.link("google.com") == | |||
"<a href=\"http://google.com\" class=\"auto-linker\" target=\"_blank\" rel=\"noopener noreferrer\">google.com</a>" | |||
end | |||
test "markdown" do | |||
assert AutoLinker.link("[google.com](http://google.com)", markdown: true) == | |||
"<a href='http://google.com' class=\"auto-linker\" target=\"_blank\" rel=\"noopener noreferrer\">google.com</a>" | |||
end | |||
test "does on link existing links" do | |||
assert AutoLinker.link("<a href='http://google.com'>google.com</a>") == | |||
"<a href='http://google.com'>google.com</a>" | |||
end | |||
test "phone number and markdown link" do | |||
assert AutoLinker.link("888 888-8888 [ab](a.com)", phone: true, markdown: true) == | |||
~s(<a href="#" class="phone-number" data-phone="8888888888">888 888-8888</a>) <> | |||
~s( <a href='a.com' class="auto-linker" target="_blank" rel="noopener noreferrer">ab</a>) | |||
end | |||
test "all kinds of links" do | |||
text = | |||
"hello google.com https://ddg.com 888 888-8888 user@email.com [google.com](http://google.com) irc:///mIRC" | |||
expected = | |||
"hello <a href=\"http://google.com\">google.com</a> <a href=\"https://ddg.com\">ddg.com</a> <a href=\"#\" class=\"phone-number\" data-phone=\"8888888888\">888 888-8888</a> <a href=\"mailto:user@email.com\">user@email.com</a> <a href='http://google.com'>google.com</a> <a href=\"irc:///mIRC\">irc:///mIRC</a>" | |||
assert AutoLinker.link(text, | |||
phone: true, | |||
markdown: true, | |||
email: true, | |||
scheme: true, | |||
extra: true, | |||
class: false, | |||
new_window: false, | |||
rel: false | |||
) == expected | |||
end | |||
test "rel as function" do | |||
text = "google.com" | |||
expected = "<a href=\"http://google.com\" rel=\"com\">google.com</a>" | |||
custom_rel = fn url -> | |||
url |> String.split(".") |> List.last() | |||
end | |||
assert AutoLinker.link(text, | |||
class: false, | |||
new_window: false, | |||
rel: custom_rel | |||
) == expected | |||
text = "google.com" | |||
expected = "<a href=\"http://google.com\">google.com</a>" | |||
custom_rel = fn _ -> nil end | |||
assert AutoLinker.link(text, | |||
class: false, | |||
new_window: false, | |||
rel: custom_rel | |||
) == expected | |||
end | |||
test "link_map/2" do | |||
assert AutoLinker.link_map("google.com", []) == | |||
{"<a href=\"http://google.com\" class=\"auto-linker\" target=\"_blank\" rel=\"noopener noreferrer\">google.com</a>", | |||
[]} | |||
end | |||
describe "custom handlers" do | |||
test "mentions handler" do | |||
text = "hello @user, @valid_user and @invalid_user" | |||
valid_users = ["user", "valid_user"] | |||
handler = fn "@" <> user = mention, buffer, _opts, acc -> | |||
if Enum.member?(valid_users, user) do | |||
link = ~s(<a href="https://example.com/user/#{user}" data-user="#{user}">#{mention}</a>) | |||
{link, %{acc | mentions: MapSet.put(acc.mentions, {mention, user})}} | |||
else | |||
{buffer, acc} | |||
end | |||
end | |||
{result_text, %{mentions: mentions}} = | |||
AutoLinker.link_map(text, %{mentions: MapSet.new()}, | |||
mention: true, | |||
mention_handler: handler | |||
) | |||
assert result_text == | |||
"hello <a href=\"https://example.com/user/user\" data-user=\"user\">@user</a>, <a href=\"https://example.com/user/valid_user\" data-user=\"valid_user\">@valid_user</a> and @invalid_user" | |||
assert mentions |> MapSet.to_list() |> Enum.map(&elem(&1, 1)) == valid_users | |||
end | |||
test "hashtags handler" do | |||
text = "#hello #world" | |||
handler = fn hashtag, buffer, opts, acc -> | |||
link = AutoLinker.Builder.create_hashtag_link(hashtag, buffer, opts) | |||
{link, %{acc | tags: MapSet.put(acc.tags, hashtag)}} | |||
end | |||
{result_text, %{tags: tags}} = | |||
AutoLinker.link_map(text, %{tags: MapSet.new()}, | |||
hashtag: true, | |||
hashtag_handler: handler, | |||
hashtag_prefix: "https://example.com/user/", | |||
class: false, | |||
new_window: false, | |||
rel: false | |||
) | |||
assert result_text == | |||
"<a href=\"https://example.com/user/hello\">#hello</a> <a href=\"https://example.com/user/world\">#world</a>" | |||
assert MapSet.to_list(tags) == ["#hello", "#world"] | |||
end | |||
test "mention handler and hashtag prefix" do | |||
text = | |||
"Hello again, @user.<script></script>\nThis is on another :moominmamma: line. #2hu #epic #phantasmagoric" | |||
handler = fn "@" <> user = mention, _, _, _ -> | |||
~s(<span class='h-card'><a href='#/user/#{user}'>@<span>#{mention}</span></a></span>) | |||
end | |||
expected = | |||
"Hello again, <span class='h-card'><a href='#/user/user'>@<span>@user</span></a></span>.<script></script>\nThis is on another :moominmamma: line. <a href=\"/tag/2hu\" class=\"auto-linker\" target=\"_blank\" rel=\"noopener noreferrer\">#2hu</a> <a href=\"/tag/epic\" class=\"auto-linker\" target=\"_blank\" rel=\"noopener noreferrer\">#epic</a> <a href=\"/tag/phantasmagoric\" class=\"auto-linker\" target=\"_blank\" rel=\"noopener noreferrer\">#phantasmagoric</a>" | |||
assert AutoLinker.link(text, | |||
mention: true, | |||
mention_handler: handler, | |||
hashtag: true, | |||
hashtag_prefix: "/tag/" | |||
) == expected | |||
end | |||
end | |||
describe "mentions" do | |||
test "simple mentions" do | |||
expected = | |||
~s{hello <a href="https://example.com/user/user" class="auto-linker" target="_blank" rel="noopener noreferrer">@user</a> and <a href="https://example.com/user/anotherUser" class="auto-linker" target="_blank" rel="noopener noreferrer">@anotherUser</a>.} | |||
assert AutoLinker.link("hello @user and @anotherUser.", | |||
mention: true, | |||
mention_prefix: "https://example.com/user/" | |||
) == expected | |||
end | |||
test "mentions inside html tags" do | |||
text = | |||
"<p><strong>hello world</strong></p>\n<p><`em>another @user__test and @user__test google.com paragraph</em></p>\n" | |||
expected = | |||
"<p><strong>hello world</strong></p>\n<p><`em>another <a href=\"u/user__test\">@user__test</a> and <a href=\"u/user__test\">@user__test</a> <a href=\"http://google.com\">google.com</a> paragraph</em></p>\n" | |||
assert AutoLinker.link(text, | |||
mention: true, | |||
mention_prefix: "u/", | |||
class: false, | |||
rel: false, | |||
new_window: false | |||
) == expected | |||
end | |||
test "metion @user@example.com" do | |||
text = "hey @user@example.com" | |||
expected = | |||
"hey <a href=\"https://example.com/user/user@example.com\" class=\"auto-linker\" target=\"_blank\" rel=\"noopener noreferrer\">@user@example.com</a>" | |||
assert AutoLinker.link(text, | |||
mention: true, | |||
mention_prefix: "https://example.com/user/" | |||
) == expected | |||
end | |||
end | |||
describe "hashtag links" do | |||
test "hashtag" do | |||
expected = | |||
" one <a href=\"https://example.com/tag/2two\" class=\"auto-linker\" target=\"_blank\" rel=\"noopener noreferrer\">#2two</a> three <a href=\"https://example.com/tag/four\" class=\"auto-linker\" target=\"_blank\" rel=\"noopener noreferrer\">#four</a>." | |||
assert AutoLinker.link(" one #2two three #four.", | |||
hashtag: true, | |||
hashtag_prefix: "https://example.com/tag/" | |||
) == expected | |||
end | |||
test "must have non-numbers" do | |||
expected = "<a href=\"/t/1ok\">#1ok</a> #42 #7" | |||
assert AutoLinker.link("#1ok #42 #7", | |||
hashtag: true, | |||
hashtag_prefix: "/t/", | |||
class: false, | |||
rel: false, | |||
new_window: false | |||
) == expected | |||
end | |||
test "support French" do | |||
text = "#administrateur·rice·s #ingénieur·e·s" | |||
expected = | |||
"<a href=\"/t/administrateur·rice·s\">#administrateur·rice·s</a> <a href=\"/t/ingénieur·e·s\">#ingénieur·e·s</a>" | |||
assert AutoLinker.link(text, | |||
hashtag: true, | |||
hashtag_prefix: "/t/", | |||
class: false, | |||
rel: false, | |||
new_window: false | |||
) == expected | |||
end | |||
test "support Telugu" do | |||
text = "#చక్రం #కకకకక్ #కకకకాక #కకకక్రకకకక" | |||
expected = | |||
"<a href=\"/t/చక్రం\">#చక్రం</a> <a href=\"/t/కకకకక్\">#కకకకక్</a> <a href=\"/t/కకకకాక\">#కకకకాక</a> <a href=\"/t/కకకక్రకకకక\">#కకకక్రకకకక</a>" | |||
assert AutoLinker.link(text, | |||
hashtag: true, | |||
hashtag_prefix: "/t/", | |||
class: false, | |||
rel: false, | |||
new_window: false | |||
) == expected | |||
end | |||
test "do not turn urls with hashes into hashtags" do | |||
text = "google.com#test #test google.com/#test #tag" | |||
expected = | |||
"<a href=\"http://google.com#test\">google.com#test</a> <a href=\"https://example.com/tag/test\">#test</a> <a href=\"http://google.com/#test\">google.com/#test</a> <a href=\"https://example.com/tag/tag\">#tag</a>" | |||
assert AutoLinker.link(text, | |||
scheme: true, | |||
hashtag: true, | |||
class: false, | |||
new_window: false, | |||
rel: false, | |||
hashtag_prefix: "https://example.com/tag/" | |||
) == expected | |||
end | |||
test "works with non-latin characters" do | |||
text = "#漢字 #は #тест #ทดสอบ" | |||
expected = | |||
"<a href=\"https://example.com/tag/漢字\">#漢字</a> <a href=\"https://example.com/tag/は\">#は</a> <a href=\"https://example.com/tag/тест\">#тест</a> <a href=\"https://example.com/tag/ทดสอบ\">#ทดสอบ</a>" | |||
assert AutoLinker.link(text, | |||
scheme: true, | |||
class: false, | |||
new_window: false, | |||
rel: false, | |||
hashtag: true, | |||
hashtag_prefix: "https://example.com/tag/" | |||
) == expected | |||
end | |||
end | |||
describe "links" do | |||
test "turning urls into links" do | |||
text = "Hey, check out http://www.youtube.com/watch?v=8Zg1-TufF%20zY?x=1&y=2#blabla ." | |||
expected = | |||
"Hey, check out <a href=\"http://www.youtube.com/watch?v=8Zg1-TufF%20zY?x=1&y=2#blabla\" class=\"auto-linker\" target=\"_blank\" rel=\"noopener noreferrer\">youtube.com/watch?v=8Zg1-TufF%20zY?x=1&y=2#blabla</a> ." | |||
assert AutoLinker.link(text, scheme: true) == expected | |||
# no scheme | |||
text = "Hey, check out www.youtube.com/watch?v=8Zg1-TufF%20zY?x=1&y=2#blabla ." | |||
assert AutoLinker.link(text, scheme: true) == expected | |||
end | |||
test "turn urls with schema into urls" do | |||
text = "📌https://google.com" | |||
expected = "📌<a href=\"https://google.com\">google.com</a>" | |||
assert AutoLinker.link(text, scheme: true, class: false, new_window: false, rel: false) == | |||
expected | |||
end | |||
test "hostname/@user" do | |||
text = "https://example.com/@user" | |||
expected = | |||
"<a href=\"https://example.com/@user\" class=\"auto-linker\" target=\"_blank\" rel=\"noopener noreferrer\">example.com/@user</a>" | |||
assert AutoLinker.link(text, scheme: true) == expected | |||
text = "https://example.com:4000/@user" | |||
expected = | |||
"<a href=\"https://example.com:4000/@user\" class=\"auto-linker\" target=\"_blank\" rel=\"noopener noreferrer\">example.com:4000/@user</a>" | |||
assert AutoLinker.link(text, scheme: true) == expected | |||
text = "https://example.com:4000/@user" | |||
expected = | |||
"<a href=\"https://example.com:4000/@user\" class=\"auto-linker\" target=\"_blank\" rel=\"noopener noreferrer\">example.com:4000/@user</a>" | |||
assert AutoLinker.link(text, scheme: true) == expected | |||
text = "@username" | |||
expected = "@username" | |||
assert AutoLinker.link(text, scheme: true) == expected | |||
text = "http://www.cs.vu.nl/~ast/intel/" | |||
expected = | |||
"<a href=\"http://www.cs.vu.nl/~ast/intel/\" class=\"auto-linker\" target=\"_blank\" rel=\"noopener noreferrer\">cs.vu.nl/~ast/intel/</a>" | |||
assert AutoLinker.link(text, scheme: true) == expected | |||
text = "https://forum.zdoom.org/viewtopic.php?f=44&t=57087" | |||
expected = | |||
"<a href=\"https://forum.zdoom.org/viewtopic.php?f=44&t=57087\" class=\"auto-linker\" target=\"_blank\" rel=\"noopener noreferrer\">forum.zdoom.org/viewtopic.php?f=44&t=57087</a>" | |||
assert AutoLinker.link(text, scheme: true) == expected | |||
text = "https://en.wikipedia.org/wiki/Sophia_(Gnosticism)#Mythos_of_the_soul" | |||
expected = | |||
"<a href=\"https://en.wikipedia.org/wiki/Sophia_(Gnosticism)#Mythos_of_the_soul\" class=\"auto-linker\" target=\"_blank\" rel=\"noopener noreferrer\">en.wikipedia.org/wiki/Sophia_(Gnosticism)#Mythos_of_the_soul</a>" | |||
assert AutoLinker.link(text, scheme: true) == expected | |||
text = "https://en.wikipedia.org/wiki/Duff's_device" | |||
expected = | |||
"<a href=\"https://en.wikipedia.org/wiki/Duff's_device\" class=\"auto-linker\" target=\"_blank\" rel=\"noopener noreferrer\">en.wikipedia.org/wiki/Duff's_device</a>" | |||
assert AutoLinker.link(text, scheme: true) == expected | |||
end | |||
end | |||
describe "non http links" do | |||
test "xmpp" do | |||
text = "xmpp:user@example.com" | |||
expected = | |||
"<a href=\"xmpp:user@example.com\" class=\"auto-linker\">xmpp:user@example.com</a>" | |||
assert AutoLinker.link(text, extra: true, new_window: false, rel: false) == expected | |||
end | |||
test "email" do | |||
text = "user@example.com" | |||
expected = "<a href=\"mailto:user@example.com\" class=\"auto-linker\">user@example.com</a>" | |||
assert AutoLinker.link(text, email: true) == expected | |||
end | |||
test "magnet" do | |||
text = | |||
"magnet:?xt=urn:btih:a4104a9d2f5615601c429fe8bab8177c47c05c84&dn=ubuntu-18.04.1.0-live-server-amd64.iso&tr=http%3A%2F%2Ftorrent.ubuntu.com%3A6969%2Fannounce&tr=http%3A%2F%2Fipv6.torrent.ubuntu.com%3A6969%2Fannounce" | |||
expected = | |||
"<a href=\"magnet:?xt=urn:btih:a4104a9d2f5615601c429fe8bab8177c47c05c84&dn=ubuntu-18.04.1.0-live-server-amd64.iso&tr=http%3A%2F%2Ftorrent.ubuntu.com%3A6969%2Fannounce&tr=http%3A%2F%2Fipv6.torrent.ubuntu.com%3A6969%2Fannounce\" class=\"auto-linker\">magnet:?xt=urn:btih:a4104a9d2f5615601c429fe8bab8177c47c05c84&dn=ubuntu-18.04.1.0-live-server-amd64.iso&tr=http%3A%2F%2Ftorrent.ubuntu.com%3A6969%2Fannounce&tr=http%3A%2F%2Fipv6.torrent.ubuntu.com%3A6969%2Fannounce</a>" | |||
assert AutoLinker.link(text, extra: true, new_window: false, rel: false) == expected | |||
end | |||
test "dweb" do | |||
text = | |||
"dweb://584faa05d394190ab1a3f0240607f9bf2b7e2bd9968830a11cf77db0cea36a21+v1.0.0/path/to/file.txt" | |||
expected = | |||
"<a href=\"dweb://584faa05d394190ab1a3f0240607f9bf2b7e2bd9968830a11cf77db0cea36a21+v1.0.0/path/to/file.txt\" class=\"auto-linker\">dweb://584faa05d394190ab1a3f0240607f9bf2b7e2bd9968830a11cf77db0cea36a21+v1.0.0/path/to/file.txt</a>" | |||
assert AutoLinker.link(text, extra: true, new_window: false, rel: false) == expected | |||
end | |||
end | |||
describe "TLDs" do | |||
test "parse with scheme" do | |||
text = "https://google.com" | |||
expected = | |||
"<a href=\"https://google.com\" class=\"auto-linker\" target=\"_blank\" rel=\"noopener noreferrer\">google.com</a>" | |||
assert AutoLinker.link(text, scheme: true) == expected | |||
end | |||
test "only existing TLDs with scheme" do | |||
text = "this url https://google.foobar.blah11blah/ has invalid TLD" | |||
expected = "this url https://google.foobar.blah11blah/ has invalid TLD" | |||
assert AutoLinker.link(text, scheme: true) == expected | |||
text = "this url https://google.foobar.com/ has valid TLD" | |||
expected = | |||
"this url <a href=\"https://google.foobar.com/\" class=\"auto-linker\" target=\"_blank\" rel=\"noopener noreferrer\">google.foobar.com/</a> has valid TLD" | |||
assert AutoLinker.link(text, scheme: true) == expected | |||
end | |||
test "only existing TLDs without scheme" do | |||
text = "this url google.foobar.blah11blah/ has invalid TLD" | |||
expected = "this url google.foobar.blah11blah/ has invalid TLD" | |||
assert AutoLinker.link(text, scheme: false) == expected | |||
text = "this url google.foobar.com/ has valid TLD" | |||
expected = | |||
"this url <a href=\"http://google.foobar.com/\" class=\"auto-linker\" target=\"_blank\" rel=\"noopener noreferrer\">google.foobar.com/</a> has valid TLD" | |||
assert AutoLinker.link(text, scheme: false) == expected | |||
end | |||
test "only existing TLDs with and without scheme" do | |||
text = "this url http://google.foobar.com/ has valid TLD" | |||
expected = | |||
"this url <a href=\"http://google.foobar.com/\" class=\"auto-linker\" target=\"_blank\" rel=\"noopener noreferrer\">google.foobar.com/</a> has valid TLD" | |||
assert AutoLinker.link(text, scheme: true) == expected | |||
text = "this url google.foobar.com/ has valid TLD" | |||
expected = | |||
"this url <a href=\"http://google.foobar.com/\" class=\"auto-linker\" target=\"_blank\" rel=\"noopener noreferrer\">google.foobar.com/</a> has valid TLD" | |||
assert AutoLinker.link(text, scheme: true) == expected | |||
end | |||
end | |||
end |
@ -0,0 +1,404 @@ | |||
defmodule LinkifyTest do | |||
use ExUnit.Case, async: true | |||
doctest Linkify | |||
test "default link" do | |||
assert Linkify.link("google.com") == | |||
"<a href=\"http://google.com\">google.com</a>" | |||
end | |||
test "does on link existing links" do | |||
text = ~s(<a href="http://google.com">google.com</a>) | |||
assert Linkify.link(text) == text | |||
end | |||
test "all kinds of links" do | |||
text = "hello google.com https://ddg.com user@email.com irc:///mIRC" | |||
expected = | |||
"hello <a href=\"http://google.com\">google.com</a> <a href=\"https://ddg.com\">ddg.com</a> <a href=\"mailto:user@email.com\">user@email.com</a> <a href=\"irc:///mIRC\">irc:///mIRC</a>" | |||
assert Linkify.link(text, | |||
email: true, | |||
extra: true | |||
) == expected | |||
end | |||
test "class attribute" do | |||
assert Linkify.link("google.com", class: "linkified") == | |||
"<a href=\"http://google.com\" class=\"linkified\">google.com</a>" | |||
end | |||
test "rel attribute" do | |||
assert Linkify.link("google.com", rel: "noopener noreferrer") == | |||
"<a href=\"http://google.com\" rel=\"noopener noreferrer\">google.com</a>" | |||
end | |||
test "rel as function" do | |||
text = "google.com" | |||
expected = "<a href=\"http://google.com\" rel=\"com\">google.com</a>" | |||
custom_rel = fn url -> | |||
url |> String.split(".") |> List.last() | |||
end | |||
assert Linkify.link(text, rel: custom_rel) == expected | |||
text = "google.com" | |||
expected = "<a href=\"http://google.com\">google.com</a>" | |||
custom_rel = fn _ -> nil end | |||
assert Linkify.link(text, rel: custom_rel) == expected | |||
end | |||
test "link_map/2" do | |||
assert Linkify.link_map("google.com", []) == | |||
{"<a href=\"http://google.com\">google.com</a>", []} | |||
end | |||
describe "custom handlers" do | |||
test "mentions handler" do | |||
text = "hello @user, @valid_user and @invalid_user" | |||
valid_users = ["user", "valid_user"] | |||
handler = fn "@" <> user = mention, buffer, _opts, acc -> | |||
if Enum.member?(valid_users, user) do | |||
link = ~s(<a href="https://example.com/user/#{user}" data-user="#{user}">#{mention}</a>) | |||
{link, %{acc | mentions: MapSet.put(acc.mentions, {mention, user})}} | |||
else | |||
{buffer, acc} | |||
end | |||
end | |||
{result_text, %{mentions: mentions}} = | |||
Linkify.link_map(text, %{mentions: MapSet.new()}, | |||
mention: true, | |||
mention_handler: handler | |||
) | |||
assert result_text == | |||
"hello <a href=\"https://example.com/user/user\" data-user=\"user\">@user</a>, <a href=\"https://example.com/user/valid_user\" data-user=\"valid_user\">@valid_user</a> and @invalid_user" | |||
assert mentions |> MapSet.to_list() |> Enum.map(&elem(&1, 1)) == valid_users | |||
end | |||
test "hashtags handler" do | |||
text = "#hello #world" | |||
handler = fn hashtag, buffer, opts, acc -> | |||
link = Linkify.Builder.create_hashtag_link(hashtag, buffer, opts) | |||
{link, %{acc | tags: MapSet.put(acc.tags, hashtag)}} | |||
end | |||
{result_text, %{tags: tags}} = | |||
Linkify.link_map(text, %{tags: MapSet.new()}, | |||
hashtag: true, | |||
hashtag_handler: handler, | |||
hashtag_prefix: "https://example.com/user/", | |||
rel: false | |||
) | |||
assert result_text == | |||
"<a href=\"https://example.com/user/hello\">#hello</a> <a href=\"https://example.com/user/world\">#world</a>" | |||
assert MapSet.to_list(tags) == ["#hello", "#world"] | |||
end | |||
test "mention handler and hashtag prefix" do | |||
text = | |||
"Hello again, @user.<script></script>\nThis is on another :moominmamma: line. #2hu #epic #phantasmagoric" | |||
handler = fn "@" <> user = mention, _, _, _ -> | |||
~s(<span class="h-card"><a href="#/user/#{user}">@<span>#{mention}</span></a></span>) | |||
end | |||
expected = | |||
~s(Hello again, <span class="h-card"><a href="#/user/user">@<span>@user</span></a></span>.<script></script>\nThis is on another :moominmamma: line. <a href="/tag/2hu" target="_blank">#2hu</a> <a href="/tag/epic" target="_blank">#epic</a> <a href="/tag/phantasmagoric" target="_blank">#phantasmagoric</a>) | |||
assert Linkify.link(text, | |||
mention: true, | |||
mention_handler: handler, | |||
hashtag: true, | |||
hashtag_prefix: "/tag/", | |||
new_window: true | |||
) == expected | |||
end | |||
end | |||
describe "mentions" do | |||
test "simple mentions" do | |||
expected = | |||
~s{hello <a href="https://example.com/user/user" target="_blank">@user</a> and <a href="https://example.com/user/anotherUser" target="_blank">@anotherUser</a>.} | |||
assert Linkify.link("hello @user and @anotherUser.", | |||
mention: true, | |||
mention_prefix: "https://example.com/user/", | |||
new_window: true | |||
) == expected | |||
end | |||
test "mentions inside html tags" do | |||
text = | |||
"<p><strong>hello world</strong></p>\n<p><`em>another @user__test and @user__test google.com paragraph</em></p>\n" | |||
expected = | |||
"<p><strong>hello world</strong></p>\n<p><`em>another <a href=\"u/user__test\">@user__test</a> and <a href=\"u/user__test\">@user__test</a> <a href=\"http://google.com\">google.com</a> paragraph</em></p>\n" | |||
assert Linkify.link(text, mention: true, mention_prefix: "u/") == expected | |||
end | |||
test "metion @user@example.com" do | |||
text = "hey @user@example.com" | |||
expected = | |||
"hey <a href=\"https://example.com/user/user@example.com\" target=\"_blank\">@user@example.com</a>" | |||
assert Linkify.link(text, | |||
mention: true, | |||
mention_prefix: "https://example.com/user/", | |||
new_window: true | |||
) == expected | |||
end | |||
end | |||
describe "hashtag links" do | |||
test "hashtag" do | |||
expected = | |||
" one <a href=\"https://example.com/tag/2two\" target=\"_blank\">#2two</a> three <a href=\"https://example.com/tag/four\" target=\"_blank\">#four</a>." | |||
assert Linkify.link(" one #2two three #four.", | |||
hashtag: true, | |||
hashtag_prefix: "https://example.com/tag/", | |||
new_window: true | |||
) == expected | |||
end | |||
test "must have non-numbers" do | |||
expected = "<a href=\"/t/1ok\">#1ok</a> #42 #7" | |||
assert Linkify.link("#1ok #42 #7", | |||
hashtag: true, | |||
hashtag_prefix: "/t/", | |||
rel: false | |||
) == expected | |||
end | |||
test "support French" do | |||
text = "#administrateur·rice·s #ingénieur·e·s" | |||
expected = | |||
"<a href=\"/t/administrateur·rice·s\">#administrateur·rice·s</a> <a href=\"/t/ingénieur·e·s\">#ingénieur·e·s</a>" | |||
assert Linkify.link(text, | |||
hashtag: true, | |||
hashtag_prefix: "/t/", | |||
rel: false | |||
) == expected | |||
end | |||
test "support Telugu" do | |||
text = "#చక్రం #కకకకక్ #కకకకాక #కకకక్రకకకక" | |||
expected = | |||
"<a href=\"/t/చక్రం\">#చక్రం</a> <a href=\"/t/కకకకక్\">#కకకకక్</a> <a href=\"/t/కకకకాక\">#కకకకాక</a> <a href=\"/t/కకకక్రకకకక\">#కకకక్రకకకక</a>" | |||
assert Linkify.link(text, | |||
hashtag: true, | |||
hashtag_prefix: "/t/", | |||
rel: false | |||
) == expected | |||
end | |||
test "do not turn urls with hashes into hashtags" do | |||
text = "google.com#test #test google.com/#test #tag" | |||
expected = | |||
"<a href=\"http://google.com#test\">google.com#test</a> <a href=\"https://example.com/tag/test\">#test</a> <a href=\"http://google.com/#test\">google.com/#test</a> <a href=\"https://example.com/tag/tag\">#tag</a>" | |||
assert Linkify.link(text, | |||
hashtag: true, | |||
rel: false, | |||
hashtag_prefix: "https://example.com/tag/" | |||
) == expected | |||
end | |||
test "works with non-latin characters" do | |||
text = "#漢字 #は #тест #ทดสอบ" | |||
expected = | |||
"<a href=\"https://example.com/tag/漢字\">#漢字</a> <a href=\"https://example.com/tag/は\">#は</a> <a href=\"https://example.com/tag/тест\">#тест</a> <a href=\"https://example.com/tag/ทดสอบ\">#ทดสอบ</a>" | |||
assert Linkify.link(text, | |||
rel: false, | |||
hashtag: true, | |||
hashtag_prefix: "https://example.com/tag/" | |||
) == expected | |||
end | |||
end | |||
describe "links" do | |||
test "turning urls into links" do | |||
text = "Hey, check out http://www.youtube.com/watch?v=8Zg1-TufF%20zY?x=1&y=2#blabla ." | |||
expected = | |||
"Hey, check out <a href=\"http://www.youtube.com/watch?v=8Zg1-TufF%20zY?x=1&y=2#blabla\" target=\"_blank\">youtube.com/watch?v=8Zg1-TufF%20zY?x=1&y=2#blabla</a> ." | |||
assert Linkify.link(text, new_window: true) == expected | |||
# no scheme | |||
text = "Hey, check out www.youtube.com/watch?v=8Zg1-TufF%20zY?x=1&y=2#blabla ." | |||
assert Linkify.link(text, new_window: true) == expected | |||
end | |||
test "turn urls with schema into urls" do | |||
text = "📌https://google.com" | |||
expected = "📌<a href=\"https://google.com\">google.com</a>" | |||
assert Linkify.link(text, rel: false) == expected | |||
end | |||
test "hostname/@user" do | |||
text = "https://example.com/@user" | |||
expected = "<a href=\"https://example.com/@user\" target=\"_blank\">example.com/@user</a>" | |||
assert Linkify.link(text, new_window: true) == expected | |||
text = "https://example.com:4000/@user" | |||
expected = | |||
"<a href=\"https://example.com:4000/@user\" target=\"_blank\">example.com:4000/@user</a>" | |||
assert Linkify.link(text, new_window: true) == expected | |||
text = "https://example.com:4000/@user" | |||
expected = | |||
"<a href=\"https://example.com:4000/@user\" target=\"_blank\">example.com:4000/@user</a>" | |||
assert Linkify.link(text, new_window: true) == expected | |||
text = "@username" | |||
expected = "@username" | |||
assert Linkify.link(text, new_window: true) == expected | |||
text = "http://www.cs.vu.nl/~ast/intel/" | |||
expected = "<a href=\"http://www.cs.vu.nl/~ast/intel/\">cs.vu.nl/~ast/intel/</a>" | |||
assert Linkify.link(text) == expected | |||
text = "https://forum.zdoom.org/viewtopic.php?f=44&t=57087" | |||
expected = | |||
"<a href=\"https://forum.zdoom.org/viewtopic.php?f=44&t=57087\">forum.zdoom.org/viewtopic.php?f=44&t=57087</a>" | |||
assert Linkify.link(text) == expected | |||
text = "https://en.wikipedia.org/wiki/Sophia_(Gnosticism)#Mythos_of_the_soul" | |||
expected = | |||
"<a href=\"https://en.wikipedia.org/wiki/Sophia_(Gnosticism)#Mythos_of_the_soul\">en.wikipedia.org/wiki/Sophia_(Gnosticism)#Mythos_of_the_soul</a>" | |||
assert Linkify.link(text) == expected | |||
text = "https://en.wikipedia.org/wiki/Duff's_device" | |||
expected = | |||
"<a href=\"https://en.wikipedia.org/wiki/Duff's_device\">en.wikipedia.org/wiki/Duff's_device</a>" | |||
assert Linkify.link(text) == expected | |||
end | |||
end | |||
describe "non http links" do | |||
test "xmpp" do | |||
text = "xmpp:user@example.com" | |||
expected = "<a href=\"xmpp:user@example.com\">xmpp:user@example.com</a>" | |||
assert Linkify.link(text, extra: true) == expected | |||
end | |||
test "email" do | |||
text = "user@example.com" | |||
expected = "<a href=\"mailto:user@example.com\">user@example.com</a>" | |||
assert Linkify.link(text, email: true) == expected | |||
end | |||
test "magnet" do | |||
text = | |||
"magnet:?xt=urn:btih:a4104a9d2f5615601c429fe8bab8177c47c05c84&dn=ubuntu-18.04.1.0-live-server-amd64.iso&tr=http%3A%2F%2Ftorrent.ubuntu.com%3A6969%2Fannounce&tr=http%3A%2F%2Fipv6.torrent.ubuntu.com%3A6969%2Fannounce" | |||
expected = | |||
"<a href=\"magnet:?xt=urn:btih:a4104a9d2f5615601c429fe8bab8177c47c05c84&dn=ubuntu-18.04.1.0-live-server-amd64.iso&tr=http%3A%2F%2Ftorrent.ubuntu.com%3A6969%2Fannounce&tr=http%3A%2F%2Fipv6.torrent.ubuntu.com%3A6969%2Fannounce\">magnet:?xt=urn:btih:a4104a9d2f5615601c429fe8bab8177c47c05c84&dn=ubuntu-18.04.1.0-live-server-amd64.iso&tr=http%3A%2F%2Ftorrent.ubuntu.com%3A6969%2Fannounce&tr=http%3A%2F%2Fipv6.torrent.ubuntu.com%3A6969%2Fannounce</a>" | |||
assert Linkify.link(text, extra: true) == expected | |||
end | |||
test "dweb" do | |||
text = | |||
"dweb://584faa05d394190ab1a3f0240607f9bf2b7e2bd9968830a11cf77db0cea36a21+v1.0.0/path/to/file.txt" | |||
expected = | |||
"<a href=\"dweb://584faa05d394190ab1a3f0240607f9bf2b7e2bd9968830a11cf77db0cea36a21+v1.0.0/path/to/file.txt\">dweb://584faa05d394190ab1a3f0240607f9bf2b7e2bd9968830a11cf77db0cea36a21+v1.0.0/path/to/file.txt</a>" | |||
assert Linkify.link(text, extra: true) == expected | |||
end | |||
end | |||
describe "TLDs" do | |||
test "parse with scheme" do | |||
text = "https://google.com" | |||
expected = "<a href=\"https://google.com\">google.com</a>" | |||
assert Linkify.link(text) == expected | |||
end | |||
test "only existing TLDs with scheme" do | |||
text = "this url https://google.foobar.blah11blah/ has invalid TLD" | |||
expected = "this url https://google.foobar.blah11blah/ has invalid TLD" | |||
assert Linkify.link(text) == expected | |||
text = "this url https://google.foobar.com/ has valid TLD" | |||
expected = | |||
"this url <a href=\"https://google.foobar.com/\">google.foobar.com/</a> has valid TLD" | |||
assert Linkify.link(text) == expected | |||
end | |||
test "only existing TLDs without scheme" do | |||
text = "this url google.foobar.blah11blah/ has invalid TLD" | |||
assert Linkify.link(text) == text | |||
text = "this url google.foobar.com/ has valid TLD" | |||
expected = | |||
"this url <a href=\"http://google.foobar.com/\">google.foobar.com/</a> has valid TLD" | |||
assert Linkify.link(text) == expected | |||
end | |||
test "only existing TLDs with and without scheme" do | |||
text = "this url http://google.foobar.com/ has valid TLD" | |||
expected = | |||
"this url <a href=\"http://google.foobar.com/\">google.foobar.com/</a> has valid TLD" | |||
assert Linkify.link(text) == expected | |||
text = "this url google.foobar.com/ has valid TLD" | |||
expected = | |||
"this url <a href=\"http://google.foobar.com/\">google.foobar.com/</a> has valid TLD" | |||
assert Linkify.link(text) == expected | |||
end | |||
end | |||
end |