From bd9ebce30e5e0dfb62136fd1c6999298ed581b42 Mon Sep 17 00:00:00 2001 From: egor Date: Mon, 18 Feb 2019 16:49:08 +0000 Subject: [PATCH] Small fixes and improvements --- .gitignore | 1 + lib/auto_linker.ex | 12 ++--- lib/auto_linker/builder.ex | 16 +++--- lib/auto_linker/parser.ex | 46 ++++++++++++----- mix.exs | 5 +- mix.lock | 14 +++++- test/auto_linker_test.exs | 100 ++++++++++++++++++++----------------- test/parser_test.exs | 5 +- 8 files changed, 119 insertions(+), 80 deletions(-) diff --git a/.gitignore b/.gitignore index b6012c7..a0ad33a 100644 --- a/.gitignore +++ b/.gitignore @@ -18,3 +18,4 @@ erl_crash.dump # Also ignore archive artifacts (built via "mix archive.build"). *.ez +.elixir_ls diff --git a/lib/auto_linker.ex b/lib/auto_linker.ex index 8bc43be..222cd79 100644 --- a/lib/auto_linker.ex +++ b/lib/auto_linker.ex @@ -3,24 +3,24 @@ defmodule AutoLinker do Create url links from text containing urls. Turns an input string like `"Check out google.com"` into - `Check out "google.com"` + `Check out "google.com"` ## Examples iex> AutoLinker.link("google.com") - "google.com" + ~s(google.com) iex> AutoLinker.link("google.com", new_window: false, rel: false) - "google.com" + ~s(google.com) iex> AutoLinker.link("google.com", new_window: false, rel: false, class: false) - "google.com" + ~s(google.com) iex> AutoLinker.link("[Google](http://google.com)", markdown: true, new_window: false, rel: false, class: false) - "Google" + ~s(Google) iex> AutoLinker.link("[Google Search](http://google.com)", markdown: true) - "Google Search" + ~s(Google Search) """ import AutoLinker.Parser diff --git a/lib/auto_linker/builder.ex b/lib/auto_linker/builder.ex index 22d1758..a46ccf4 100644 --- a/lib/auto_linker/builder.ex +++ b/lib/auto_linker/builder.ex @@ -53,7 +53,7 @@ defmodule AutoLinker.Builder do defp format_attrs(attrs) do attrs - |> Enum.map(fn {key, value} -> ~s(#{key}='#{value}') end) + |> Enum.map(fn {key, value} -> ~s(#{key}="#{value}") end) |> Enum.join(" ") end @@ -117,24 +117,22 @@ defmodule AutoLinker.Builder do url = mention_prefix <> name - [] + [href: url] |> build_attrs(url, opts, :rel) |> build_attrs(url, opts, :target) |> build_attrs(url, opts, :class) - |> build_attrs(url, opts, :scheme) |> format_mention(name, opts) end - def create_hashtag_link(tag, _buffer, opts) do + def create_hashtag_link("#" <> tag, _buffer, opts) do hashtag_prefix = opts[:hashtag_prefix] url = hashtag_prefix <> tag - [] + [href: url] |> build_attrs(url, opts, :rel) |> build_attrs(url, opts, :target) |> build_attrs(url, opts, :class) - |> build_attrs(url, opts, :scheme) |> format_hashtag(tag, opts) end @@ -162,12 +160,12 @@ defmodule AutoLinker.Builder do def format_email(attrs, email, _opts) do attrs = format_attrs(attrs) - "#{email}" + ~s(#{email}) end def format_extra(attrs, uri, _opts) do - attrs = format_attrs(attrs) - "#{uri}" + attrs = format_attributes(attrs) + ~s(#{uri}) end defp format_attributes(attrs) do diff --git a/lib/auto_linker/parser.ex b/lib/auto_linker/parser.ex index be32b59..0448cdd 100644 --- a/lib/auto_linker/parser.ex +++ b/lib/auto_linker/parser.ex @@ -13,7 +13,7 @@ defmodule AutoLinker.Parser do ## Examples iex> AutoLinker.Parser.parse("Check out google.com") - "Check out google.com" + ~s{Check out google.com} iex> AutoLinker.Parser.parse("call me at x9999", phone: true) ~s{call me at x9999} @@ -40,12 +40,12 @@ defmodule AutoLinker.Parser do # @user # @user@example.com - @match_mention ~r/^@[a-zA-Z0-9.!#$%&'*+\/=?^_`{|}~-]+@?[a-zA-Z0-9_-](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*/u + @match_mention ~r/^@[a-zA-Z\d_-]+@[a-zA-Z0-9_-](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*|@[a-zA-Z\d_-]+/u # https://www.w3.org/TR/html5/forms.html#valid-e-mail-address @match_email ~r/^[a-zA-Z0-9.!#$%&'*+\/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$/u - @match_hashtag ~r/^\#(?\w+)/u + @match_hashtag ~r/^(?\#\w+)/u @prefix_extra [ "magnet:?", @@ -100,10 +100,10 @@ defmodule AutoLinker.Parser do |> do_parse(Map.delete(opts, :phone)) end - defp do_parse(input, %{mention: true} = opts) do + defp do_parse(input, %{hashtag: true} = opts) do input - |> do_parse(opts, {"", "", :parsing}, &check_and_link_mention/3) - |> do_parse(Map.delete(opts, :mention)) + |> do_parse(opts, {"", "", :parsing}, &check_and_link_hashtag/3) + |> do_parse(Map.delete(opts, :hashtag)) end defp do_parse(input, %{extra: true} = opts) do @@ -144,10 +144,10 @@ defmodule AutoLinker.Parser do do_parse(input, Map.delete(opts, :url)) end - defp do_parse(input, %{hashtag: true} = opts) do + defp do_parse(input, %{mention: true} = opts) do input - |> do_parse(opts, {"", "", :parsing}, &check_and_link_hashtag/3) - |> do_parse(Map.delete(opts, :hashtag)) + |> do_parse(opts, {"", "", :parsing}, &check_and_link_mention/3) + |> do_parse(Map.delete(opts, :mention)) end defp do_parse(input, _), do: input @@ -378,23 +378,43 @@ defmodule AutoLinker.Parser do def link_hashtag(nil, buffer, _, _user_acc), do: buffer def link_hashtag(hashtag, buffer, %{hashtag_handler: hashtag_handler} = opts, user_acc) do - hashtag_handler.(hashtag, buffer, opts, user_acc) + hashtag + |> hashtag_handler.(buffer, opts, user_acc) + |> maybe_update_buffer(hashtag, buffer) end def link_hashtag(hashtag, buffer, opts, _user_acc) do - Builder.create_hashtag_link(hashtag, buffer, opts) + hashtag + |> Builder.create_hashtag_link(buffer, opts) + |> maybe_update_buffer(hashtag, buffer) end def link_mention(nil, buffer, _, user_acc), do: {buffer, user_acc} def link_mention(mention, buffer, %{mention_handler: mention_handler} = opts, user_acc) do - mention_handler.(mention, buffer, opts, user_acc) + mention + |> mention_handler.(buffer, opts, user_acc) + |> maybe_update_buffer(mention, buffer) end def link_mention(mention, buffer, opts, _user_acc) do - Builder.create_mention_link(mention, buffer, opts) + mention + |> Builder.create_mention_link(buffer, opts) + |> maybe_update_buffer(mention, buffer) + end + + defp maybe_update_buffer(out, match, buffer) when is_binary(out) do + maybe_update_buffer({out, nil}, match, buffer) + end + + defp maybe_update_buffer({out, user_acc}, match, buffer) + when match != buffer and out != buffer do + out = String.replace(buffer, match, out) + {out, user_acc} end + defp maybe_update_buffer(out, _match, _buffer), do: out + def link_phone(nil, buffer, _), do: buffer def link_phone(list, buffer, opts) do diff --git a/mix.exs b/mix.exs index 572d1c9..d73175c 100644 --- a/mix.exs +++ b/mix.exs @@ -29,8 +29,9 @@ defmodule AutoLinker.Mixfile do # Dependencies can be Hex packages: defp deps do [ - {:ex_doc, "~> 0.18", only: :dev}, - {:earmark, "~> 1.2", only: :dev, override: true} + {:ex_doc, "~> 0.19", only: :dev, runtime: false}, + {:earmark, "~> 1.2", only: :dev, override: true}, + {:credo, "~> 1.0.0", only: [:dev, :test], runtime: false} ] end diff --git a/mix.lock b/mix.lock index da8bc52..a265551 100644 --- a/mix.lock +++ b/mix.lock @@ -1,2 +1,12 @@ -%{"earmark": {:hex, :earmark, "1.2.3", "206eb2e2ac1a794aa5256f3982de7a76bf4579ff91cb28d0e17ea2c9491e46a4", [:mix], [], "hexpm"}, - "ex_doc": {:hex, :ex_doc, "0.18.1", "37c69d2ef62f24928c1f4fdc7c724ea04aecfdf500c4329185f8e3649c915baf", [:mix], [{:earmark, "~> 1.1", [hex: :earmark, repo: "hexpm", optional: false]}], "hexpm"}} +%{ + "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"}, + "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"}, +} diff --git a/test/auto_linker_test.exs b/test/auto_linker_test.exs index 968c847..ad26d81 100644 --- a/test/auto_linker_test.exs +++ b/test/auto_linker_test.exs @@ -9,12 +9,12 @@ defmodule AutoLinkerTest do test "default link" do assert AutoLinker.link("google.com") == - "google.com" + "google.com" end test "markdown" do assert AutoLinker.link("[google.com](http://google.com)", markdown: true) == - "google.com" + "google.com" end test "does on link existing links" do @@ -25,24 +25,20 @@ defmodule AutoLinkerTest do test "phone number and markdown link" do assert AutoLinker.link("888 888-8888 [ab](a.com)", phone: true, markdown: true) == "888 888-8888" <> - " ab" + " ab" end test "all kinds of links" do text = - "hello @user google.com https://ddg.com 888 888-8888 #tag user@email.com [google.com](http://google.com) irc:///mIRC" + "hello google.com https://ddg.com 888 888-8888 user@email.com [google.com](http://google.com) irc:///mIRC" expected = - "hello @user google.com ddg.com 888 888-8888 #tag user@email.com google.com irc:///mIRC" + "hello google.com ddg.com 888 888-8888 user@email.com google.com irc:///mIRC" assert AutoLinker.link(text, phone: true, markdown: true, email: true, - mention: true, - mention_prefix: "https://example.com/user/", - hashtag: true, - hashtag_prefix: "https://example.com/tag/", scheme: true, extra: true, class: false, @@ -72,7 +68,7 @@ defmodule AutoLinkerTest do ) assert result_text == - "hello @user @valid_user and @invalid_user" + "hello @user, @valid_user and @invalid_user" assert mentions |> MapSet.to_list() |> Enum.map(&elem(&1, 1)) == valid_users end @@ -96,40 +92,47 @@ defmodule AutoLinkerTest do ) assert result_text == - "#hello #world" + "#hello #world" - assert MapSet.to_list(tags) == ["hello", "world"] + assert MapSet.to_list(tags) == ["#hello", "#world"] end - end - describe "mentions" do - test "simple mentions" do + 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(@#{mention}) + end + expected = - ~s{hello @user and @anotherUser} + "Hello again, @@user.<script></script>\nThis is on another :moominmamma: line. #2hu #epic #phantasmagoric" - assert AutoLinker.link("hello @user and @anotherUser", + assert AutoLinker.link(text, mention: true, - mention_prefix: "https://example.com/user/" + mention_handler: handler, + hashtag: true, + hashtag_prefix: "/tag/" ) == expected end + end - test "metion @user@example.com" do - text = "hey @user@example.com" - + describe "mentions" do + test "simple mentions" do expected = - "hey @user@example.com" + ~s{hello @user and @anotherUser.} - assert AutoLinker.link(text, + assert AutoLinker.link("hello @user and @anotherUser.", mention: true, mention_prefix: "https://example.com/user/" ) == expected end - test "skip if starts with @@" do - text = "hello @@user and @anotherUser" + test "metion @user@example.com" do + text = "hey @user@example.com" expected = - "hello @@user and @anotherUser" + "hey @user@example.com" assert AutoLinker.link(text, mention: true, @@ -141,9 +144,9 @@ defmodule AutoLinkerTest do describe "hashtag links" do test "hashtag" do expected = - "one #two three #four" + " one #2two three #four." - assert AutoLinker.link("one #two three #four", + assert AutoLinker.link(" one #2two three #four.", hashtag: true, hashtag_prefix: "https://example.com/tag/" ) == expected @@ -153,7 +156,7 @@ defmodule AutoLinkerTest do text = "google.com#test #test google.com/#test #tag" expected = - "google.com#test #test google.com/#test #tag" + "google.com#test #test google.com/#test #tag" assert AutoLinker.link(text, scheme: true, @@ -169,7 +172,7 @@ defmodule AutoLinkerTest do text = "#漢字 #は #тест #ทดสอบ" expected = - "#漢字 #は #тест #ทดสอบ" + "#漢字 #は #тест #ทดสอบ" assert AutoLinker.link(text, scheme: true, @@ -187,7 +190,7 @@ defmodule AutoLinkerTest do text = "Hey, check out http://www.youtube.com/watch?v=8Zg1-TufF%20zY?x=1&y=2#blabla ." expected = - "Hey, check out youtube.com/watch?v=8Zg1-TufF%20zY?x=1&y=2#blabla ." + "Hey, check out youtube.com/watch?v=8Zg1-TufF%20zY?x=1&y=2#blabla ." assert AutoLinker.link(text, scheme: true) == expected @@ -200,21 +203,21 @@ defmodule AutoLinkerTest do text = "https://example.com/@user" expected = - "example.com/@user" + "example.com/@user" assert AutoLinker.link(text, scheme: true) == expected text = "https://example.com:4000/@user" expected = - "example.com:4000/@user" + "example.com:4000/@user" assert AutoLinker.link(text, scheme: true) == expected text = "https://example.com:4000/@user" expected = - "example.com:4000/@user" + "example.com:4000/@user" assert AutoLinker.link(text, scheme: true) == expected @@ -225,28 +228,28 @@ defmodule AutoLinkerTest do text = "http://www.cs.vu.nl/~ast/intel/" expected = - "cs.vu.nl/~ast/intel/" + "cs.vu.nl/~ast/intel/" assert AutoLinker.link(text, scheme: true) == expected text = "https://forum.zdoom.org/viewtopic.php?f=44&t=57087" expected = - "forum.zdoom.org/viewtopic.php?f=44&t=57087" + "forum.zdoom.org/viewtopic.php?f=44&t=57087" assert AutoLinker.link(text, scheme: true) == expected text = "https://en.wikipedia.org/wiki/Sophia_(Gnosticism)#Mythos_of_the_soul" expected = - "en.wikipedia.org/wiki/Sophia_(Gnosticism)#Mythos_of_the_soul" + "en.wikipedia.org/wiki/Sophia_(Gnosticism)#Mythos_of_the_soul" assert AutoLinker.link(text, scheme: true) == expected text = "https://en.wikipedia.org/wiki/Duff's_device" expected = - "en.wikipedia.org/wiki/Duff's_device" + "en.wikipedia.org/wiki/Duff's_device" assert AutoLinker.link(text, scheme: true) == expected end @@ -255,13 +258,16 @@ defmodule AutoLinkerTest do describe "non http links" do test "xmpp" do text = "xmpp:user@example.com" - expected = "xmpp:user@example.com" + + expected = + "xmpp:user@example.com" + assert AutoLinker.link(text, extra: true) == expected end test "email" do text = "user@example.com" - expected = "user@example.com" + expected = "user@example.com" assert AutoLinker.link(text, email: true) == expected end @@ -270,7 +276,7 @@ defmodule AutoLinkerTest do "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 = - "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" assert AutoLinker.link(text, extra: true) == expected end @@ -280,7 +286,7 @@ defmodule AutoLinkerTest do "dweb://584faa05d394190ab1a3f0240607f9bf2b7e2bd9968830a11cf77db0cea36a21+v1.0.0/path/to/file.txt" expected = - "dweb://584faa05d394190ab1a3f0240607f9bf2b7e2bd9968830a11cf77db0cea36a21+v1.0.0/path/to/file.txt" + "dweb://584faa05d394190ab1a3f0240607f9bf2b7e2bd9968830a11cf77db0cea36a21+v1.0.0/path/to/file.txt" assert AutoLinker.link(text, extra: true) == expected end @@ -291,7 +297,7 @@ defmodule AutoLinkerTest do text = "https://google.com" expected = - "google.com" + "google.com" assert AutoLinker.link(text, scheme: true) == expected end @@ -305,7 +311,7 @@ defmodule AutoLinkerTest do text = "this url https://google.foobar.com/ has valid TLD" expected = - "this url google.foobar.com/ has valid TLD" + "this url google.foobar.com/ has valid TLD" assert AutoLinker.link(text, scheme: true) == expected end @@ -318,7 +324,7 @@ defmodule AutoLinkerTest do text = "this url google.foobar.com/ has valid TLD" expected = - "this url google.foobar.com/ has valid TLD" + "this url google.foobar.com/ has valid TLD" assert AutoLinker.link(text, scheme: false) == expected end @@ -327,14 +333,14 @@ defmodule AutoLinkerTest do text = "this url http://google.foobar.com/ has valid TLD" expected = - "this url google.foobar.com/ has valid TLD" + "this url google.foobar.com/ has valid TLD" assert AutoLinker.link(text, scheme: true) == expected text = "this url google.foobar.com/ has valid TLD" expected = - "this url google.foobar.com/ has valid TLD" + "this url google.foobar.com/ has valid TLD" assert AutoLinker.link(text, scheme: true) == expected end diff --git a/test/parser_test.exs b/test/parser_test.exs index f15c600..998b8f4 100644 --- a/test/parser_test.exs +++ b/test/parser_test.exs @@ -62,7 +62,10 @@ defmodule AutoLinker.ParserTest do test "links url inside html" do text = "Check out
google.com
" - expected = "Check out
google.com
" + + expected = + "Check out
google.com
" + assert parse(text, class: false, rel: false, new_window: false) == expected end