AkkomaGang/linkify
Archived
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

add formatter

Browse source
This commit is contained in:
Egor Kislitsyn 2019-02-05 18:22:51 +07:00
parent 0d72ff37a4
commit 34e4e2f953
8 changed files with 165 additions and 114 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
.formatter.exs Normal file
View file

@ -0,0 +1,4 @@
# Used by "mix format"
[
inputs: ["{mix,.formatter}.exs", "{config,lib,test}/**/*.{ex,exs}"]
]

3
lib/auto_linker.ex
View file

@ -51,7 +51,6 @@ defmodule AutoLinker do
Note that passing opts to `link/2` will override the configuration settings. Note that passing opts to `link/2` will override the configuration settings.
""" """
def link(text, opts \\ []) do def link(text, opts \\ []) do
parse text, opts parse(text, opts)
end end
end end

27
lib/auto_linker/builder.ex
View file

@ -24,20 +24,21 @@ defmodule AutoLinker.Builder do
end end
defp build_attrs(attrs, _, opts, :rel) do defp build_attrs(attrs, _, opts, :rel) do
if rel = Map.get(opts, :rel, "noopener noreferrer"), if rel = Map.get(opts, :rel, "noopener noreferrer"), do: [{:rel, rel} | attrs], else: attrs
do: [{:rel, rel} | attrs], else: attrs
end end
defp build_attrs(attrs, _, opts, :target) do defp build_attrs(attrs, _, opts, :target) do
if Map.get(opts, :new_window, true), if Map.get(opts, :new_window, true), do: [{:target, :_blank} | attrs], else: attrs
do: [{:target, :_blank} | attrs], else: attrs
end end
defp build_attrs(attrs, _, opts, :class) do defp build_attrs(attrs, _, opts, :class) do
if cls = Map.get(opts, :class, "auto-linker"), if cls = Map.get(opts, :class, "auto-linker"), do: [{:class, cls} | attrs], else: attrs
do: [{:class, cls} | attrs], else: attrs
end end
defp build_attrs(attrs, url, _opts, :scheme) do defp build_attrs(attrs, url, _opts, :scheme) do
if String.starts_with?(url, ["http://", "https://"]), if String.starts_with?(url, ["http://", "https://"]),
do: [{:href, url} | attrs], else: [{:href, "http://" <> url} | attrs] do: [{:href, url} | attrs],
else: [{:href, "http://" <> url} | attrs]
end end
defp format_url(attrs, url, opts) do defp format_url(attrs, url, opts) do
@ -45,6 +46,7 @@ defmodule AutoLinker.Builder do
url url
|> strip_prefix(Map.get(opts, :strip_prefix, true)) |> strip_prefix(Map.get(opts, :strip_prefix, true))
|> truncate(Map.get(opts, :truncate, false)) |> truncate(Map.get(opts, :truncate, false))
attrs = format_attrs(attrs) attrs = format_attrs(attrs)
"<a #{attrs}>" <> url <> "</a>" "<a #{attrs}>" <> url <> "</a>"
end end
@ -61,11 +63,13 @@ defmodule AutoLinker.Builder do
"" -> "" "" -> ""
attrs -> " " <> attrs attrs -> " " <> attrs
end end
Regex.replace(~r/\[(.+?)\]\((.+?)\)/, text, "<a href='\\2'#{attrs}>\\1</a>") Regex.replace(~r/\[(.+?)\]\((.+?)\)/, text, "<a href='\\2'#{attrs}>\\1</a>")
end end
defp truncate(url, false), do: url defp truncate(url, false), do: url
defp truncate(url, len) when len < 3, do: url defp truncate(url, len) when len < 3, do: url
defp truncate(url, len) do defp truncate(url, len) do
if String.length(url) > len, do: String.slice(url, 0, len - 2) <> "..", else: url if String.length(url) > len, do: String.slice(url, 0, len - 2) <> "..", else: url
end end
@ -75,13 +79,15 @@ defmodule AutoLinker.Builder do
|> String.replace(~r/^https?:\/\//, "") |> String.replace(~r/^https?:\/\//, "")
|> String.replace(~r/^www\./, "") |> String.replace(~r/^www\./, "")
end end
defp strip_prefix(url, _), do: url defp strip_prefix(url, _), do: url
def create_phone_link([], buffer, _) do def create_phone_link([], buffer, _) do
buffer buffer
end end
def create_phone_link([h | t], buffer, opts) do def create_phone_link([h | t], buffer, opts) do
create_phone_link t, format_phone_link(h, buffer, opts), opts create_phone_link(t, format_phone_link(h, buffer, opts), opts)
end end
def format_phone_link([h | _], buffer, opts) do def format_phone_link([h | _], buffer, opts) do
@ -89,6 +95,7 @@ defmodule AutoLinker.Builder do
h h
|> String.replace(~r/[\.\+\- x\(\)]+/, "") |> String.replace(~r/[\.\+\- x\(\)]+/, "")
|> format_phone_link(h, opts) |> format_phone_link(h, opts)
# val = ~s'<a href="#" class="phone-number" data-phone="#{number}">#{h}</a>' # val = ~s'<a href="#" class="phone-number" data-phone="#{number}">#{h}</a>'
String.replace(buffer, h, val) String.replace(buffer, h, val)
end end
@ -100,7 +107,9 @@ defmodule AutoLinker.Builder do
attrs = format_attributes(opts[:attributes] || []) attrs = format_attributes(opts[:attributes] || [])
href = opts[:href] || "#" href = opts[:href] || "#"
~s'<#{tag} href="#{href}" class="#{class}" #{data_phone}="#{number}"#{attrs}>#{original}</#{tag}>' ~s'<#{tag} href="#{href}" class="#{class}" #{data_phone}="#{number}"#{attrs}>#{original}</#{
tag
}>'
end end
defp format_attributes(attrs) do defp format_attributes(attrs) do

70
lib/auto_linker/parser.ex
View file

@ -43,20 +43,21 @@ defmodule AutoLinker.Parser do
:auto_linker :auto_linker
|> Application.get_env(:opts, []) |> Application.get_env(:opts, [])
|> Enum.into(%{}) |> Enum.into(%{})
|> Map.put(:attributes, |> Map.put(
:attributes,
Application.get_env(:auto_linker, :attributes, []) Application.get_env(:auto_linker, :attributes, [])
) )
opts = opts =
Enum.reduce @default_opts, opts, fn opt, acc -> Enum.reduce(@default_opts, opts, fn opt, acc ->
if is_nil(opts[opt]) and is_nil(config[opt]) do if is_nil(opts[opt]) and is_nil(config[opt]) do
Map.put acc, opt, true Map.put(acc, opt, true)
else else
acc acc
end end
end end)
do_parse text, Map.merge(config, opts) do_parse(text, Map.merge(config, opts))
end end
defp do_parse(text, %{phone: false} = opts), do: do_parse(text, Map.delete(opts, :phone)) defp do_parse(text, %{phone: false} = opts), do: do_parse(text, Map.delete(opts, :phone))
@ -85,11 +86,12 @@ defmodule AutoLinker.Parser do
defp do_parse(text, _), do: text defp do_parse(text, _), do: text
defp do_parse("", _scheme, _opts ,{"", acc, _}, _handler), defp do_parse("", _scheme, _opts, {"", acc, _}, _handler),
do: acc do: acc
defp do_parse("", scheme, opts ,{buffer, acc, _}, handler), defp do_parse("", scheme, opts, {buffer, acc, _}, handler),
do: acc <> handler.(buffer, scheme, opts) do: acc <> handler.(buffer, scheme, opts)
defp do_parse("<a" <> text, scheme, opts, {buffer, acc, :parsing}, handler), defp do_parse("<a" <> text, scheme, opts, {buffer, acc, :parsing}, handler),
do: do_parse(text, scheme, opts, {"", acc <> buffer <> "<a", :skip}, handler) do: do_parse(text, scheme, opts, {"", acc <> buffer <> "<a", :skip}, handler)
@ -106,8 +108,14 @@ defmodule AutoLinker.Parser do
do: do_parse(text, scheme, opts, {"", acc <> <<ch::8>>, {:attrs, level}}, handler) do: do_parse(text, scheme, opts, {"", acc <> <<ch::8>>, {:attrs, level}}, handler)
defp do_parse("</" <> text, scheme, opts, {buffer, acc, {:html, level}}, handler), defp do_parse("</" <> text, scheme, opts, {buffer, acc, {:html, level}}, handler),
do: do_parse(text, scheme, opts, do:
{"", acc <> handler.(buffer, scheme, opts) <> "</", {:close, level}}, handler) do_parse(
text,
scheme,
opts,
{"", acc <> handler.(buffer, scheme, opts) <> "</", {:close, level}},
handler
)
defp do_parse(">" <> text, scheme, opts, {buffer, acc, {:close, 1}}, handler), defp do_parse(">" <> text, scheme, opts, {buffer, acc, {:close, 1}}, handler),
do: do_parse(text, scheme, opts, {"", acc <> buffer <> ">", :parsing}, handler) do: do_parse(text, scheme, opts, {"", acc <> buffer <> ">", :parsing}, handler)
@ -126,16 +134,34 @@ defmodule AutoLinker.Parser do
do: do_parse(text, scheme, opts, {buffer <> " ", acc, state}, handler) do: do_parse(text, scheme, opts, {buffer <> " ", acc, state}, handler)
defp do_parse(" " <> text, scheme, opts, {buffer, acc, state}, handler), defp do_parse(" " <> text, scheme, opts, {buffer, acc, state}, handler),
do: do_parse(text, scheme, opts, do:
{"", acc <> handler.(buffer, scheme, opts) <> " ", state}, handler) do_parse(
text,
scheme,
opts,
{"", acc <> handler.(buffer, scheme, opts) <> " ", state},
handler
)
defp do_parse("\n" <> text, scheme, opts, {buffer, acc, state}, handler), defp do_parse("\n" <> text, scheme, opts, {buffer, acc, state}, handler),
do: do_parse(text, scheme, opts, do:
{"", acc <> handler.(buffer, scheme, opts) <> "\n", state}, handler) do_parse(
text,
scheme,
opts,
{"", acc <> handler.(buffer, scheme, opts) <> "\n", state},
handler
)
defp do_parse(<<ch::8>>, scheme, opts, {buffer, acc, state}, handler), defp do_parse(<<ch::8>>, scheme, opts, {buffer, acc, state}, handler),
do: do_parse("", scheme, opts, do:
{"", acc <> handler.(buffer <> <<ch::8>>, scheme, opts), state}, handler) do_parse(
"",
scheme,
opts,
{"", acc <> handler.(buffer <> <<ch::8>>, scheme, opts), state},
handler
)
defp do_parse(<<ch::8>> <> text, scheme, opts, {buffer, acc, state}, handler), defp do_parse(<<ch::8>> <> text, scheme, opts, {buffer, acc, state}, handler),
do: do_parse(text, scheme, opts, {buffer <> <<ch::8>>, acc, state}, handler) do: do_parse(text, scheme, opts, {buffer <> <<ch::8>>, acc, state}, handler)
@ -154,24 +180,24 @@ defmodule AutoLinker.Parser do
@doc false @doc false
def is_url?(buffer, true) do def is_url?(buffer, true) do
if Regex.match? @invalid_url, buffer do if Regex.match?(@invalid_url, buffer) do
false false
else else
Regex.match? @match_scheme, buffer Regex.match?(@match_scheme, buffer)
end end
end end
def is_url?(buffer, _) do def is_url?(buffer, _) do
if Regex.match? @invalid_url, buffer do if Regex.match?(@invalid_url, buffer) do
false false
else else
Regex.match? @match_url, buffer Regex.match?(@match_url, buffer)
end end
end end
@doc false @doc false
def match_phone(buffer) do def match_phone(buffer) do
case Regex.scan @match_phone, buffer do case Regex.scan(@match_phone, buffer) do
[] -> nil [] -> nil
other -> other other -> other
end end
@ -180,13 +206,13 @@ defmodule AutoLinker.Parser do
def link_phone(nil, buffer, _), do: buffer def link_phone(nil, buffer, _), do: buffer
def link_phone(list, buffer, opts) do def link_phone(list, buffer, opts) do
Builder.create_phone_link list, buffer, opts Builder.create_phone_link(list, buffer, opts)
end end
@doc false @doc false
def link_url(true, buffer, opts) do def link_url(true, buffer, opts) do
Builder.create_link(buffer, opts) Builder.create_link(buffer, opts)
end end
def link_url(_, buffer, _opts), do: buffer
def link_url(_, buffer, _opts), do: buffer
end end

16
mix.exs
View file

@ -8,8 +8,8 @@ defmodule AutoLinker.Mixfile do
app: :auto_linker, app: :auto_linker,
version: @version, version: @version,
elixir: "~> 1.4", elixir: "~> 1.4",
build_embedded: Mix.env == :prod, build_embedded: Mix.env() == :prod,
start_permanent: Mix.env == :prod, start_permanent: Mix.env() == :prod,
deps: deps(), deps: deps(),
docs: [extras: ["README.md"]], docs: [extras: ["README.md"]],
package: package(), package: package(),
@ -17,7 +17,7 @@ defmodule AutoLinker.Mixfile do
description: """ description: """
AutoLinker is a basic package for turning website names into links. AutoLinker is a basic package for turning website names into links.
""" """
] ]
end end
# Configuration for the OTP application # Configuration for the OTP application
@ -30,14 +30,16 @@ defmodule AutoLinker.Mixfile do
defp deps do defp deps do
[ [
{:ex_doc, "~> 0.18", only: :dev}, {:ex_doc, "~> 0.18", only: :dev},
{:earmark, "~> 1.2", only: :dev, override: true}, {:earmark, "~> 1.2", only: :dev, override: true}
] ]
end end
defp package do defp package do
[ maintainers: ["Stephen Pallen"], [
maintainers: ["Stephen Pallen"],
licenses: ["MIT"], licenses: ["MIT"],
links: %{ "Github" => "https://github.com/smpallen99/auto_linker" }, links: %{"Github" => "https://github.com/smpallen99/auto_linker"},
files: ~w(lib README.md mix.exs LICENSE)] files: ~w(lib README.md mix.exs LICENSE)
]
end end
end end

14
test/auto_linker_test.exs
View file

@ -2,31 +2,29 @@ defmodule AutoLinkerTest do
use ExUnit.Case use ExUnit.Case
doctest AutoLinker doctest AutoLinker
test "phone number" do test "phone number" do
assert AutoLinker.link(", work (555) 555-5555", phone: true) == assert AutoLinker.link(", work (555) 555-5555", phone: true) ==
~s{, work <a href="#" class="phone-number" data-phone="5555555555">(555) 555-5555</a>} ~s{, work <a href="#" class="phone-number" data-phone="5555555555">(555) 555-5555</a>}
end end
test "default link" do test "default link" do
assert AutoLinker.link("google.com") == assert AutoLinker.link("google.com") ==
"<a href='http://google.com' class='auto-linker' target='_blank' rel='noopener noreferrer'>google.com</a>" "<a href='http://google.com' class='auto-linker' target='_blank' rel='noopener noreferrer'>google.com</a>"
end end
test "markdown" do test "markdown" do
assert AutoLinker.link("[google.com](http://google.com)", markdown: true) == 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>" "<a href='http://google.com' class='auto-linker' target='_blank' rel='noopener noreferrer'>google.com</a>"
end end
test "does on link existing links" do test "does on link existing links" do
assert AutoLinker.link("<a href='http://google.com'>google.com</a>") == assert AutoLinker.link("<a href='http://google.com'>google.com</a>") ==
"<a href='http://google.com'>google.com</a>" "<a href='http://google.com'>google.com</a>"
end end
test "phone number and markdown link" do test "phone number and markdown link" do
assert AutoLinker.link("888 888-8888 [ab](a.com)", phone: true, markdown: true) == assert AutoLinker.link("888 888-8888 [ab](a.com)", phone: true, markdown: true) ==
"<a href=\"#\" class=\"phone-number\" data-phone=\"8888888888\">888 888-8888</a>" <> "<a href=\"#\" class=\"phone-number\" data-phone=\"8888888888\">888 888-8888</a>" <>
" <a href='a.com' class='auto-linker' target='_blank' rel='noopener noreferrer'>ab</a>" " <a href='a.com' class='auto-linker' target='_blank' rel='noopener noreferrer'>ab</a>"
end end
end end

15
test/builder_test.exs
View file

@ -8,17 +8,24 @@ defmodule AutoLinker.BuilderTest do
test "finishes" do test "finishes" do
assert create_phone_link([], "", []) == "" assert create_phone_link([], "", []) == ""
end end
test "handles one link" do test "handles one link" do
phrase = "my exten is x888. Call me." phrase = "my exten is x888. Call me."
expected = ~s'my exten is <a href="#" class="phone-number" data-phone="888">x888</a>. Call me.'
expected =
~s'my exten is <a href="#" class="phone-number" data-phone="888">x888</a>. Call me.'
assert create_phone_link([["x888", ""]], phrase, []) == expected assert create_phone_link([["x888", ""]], phrase, []) == expected
end end
test "handles multiple links" do test "handles multiple links" do
phrase = "555.555.5555 or (555) 888-8888" phrase = "555.555.5555 or (555) 888-8888"
expected = ~s'<a href="#" class="phone-number" data-phone="5555555555">555.555.5555</a> or ' <>
~s'<a href="#" class="phone-number" data-phone="5558888888">(555) 888-8888</a>' expected =
~s'<a href="#" class="phone-number" data-phone="5555555555">555.555.5555</a> or ' <>
~s'<a href="#" class="phone-number" data-phone="5558888888">(555) 888-8888</a>'
assert create_phone_link([["555.555.5555", ""], ["(555) 888-8888"]], phrase, []) == expected assert create_phone_link([["555.555.5555", ""], ["(555) 888-8888"]], phrase, []) == expected
end end
end end
end end

130
test/parser_test.exs
View file

@ -11,18 +11,21 @@ defmodule AutoLinker.ParserTest do
assert is_url?(url, true) assert is_url?(url, true)
end) end)
end end
test "invalid scheme true" do test "invalid scheme true" do
invalid_scheme_urls() invalid_scheme_urls()
|> Enum.each(fn url -> |> Enum.each(fn url ->
refute is_url?(url, true) refute is_url?(url, true)
end) end)
end end
test "valid scheme false" do test "valid scheme false" do
valid_non_scheme_urls() valid_non_scheme_urls()
|> Enum.each(fn url -> |> Enum.each(fn url ->
assert is_url?(url, false) assert is_url?(url, false)
end) end)
end end
test "invalid scheme false" do test "invalid scheme false" do
invalid_non_scheme_urls() invalid_non_scheme_urls()
|> Enum.each(fn url -> |> Enum.each(fn url ->
@ -47,7 +50,6 @@ defmodule AutoLinker.ParserTest do
end end
end end
describe "parse" do describe "parse" do
test "does not link attributes" do test "does not link attributes" do
text = "Check out <a href='google.com'>google</a>" text = "Check out <a href='google.com'>google</a>"
@ -61,7 +63,7 @@ defmodule AutoLinker.ParserTest do
test "links url inside html" do test "links url inside html" do
text = "Check out <div class='section'>google.com</div>" text = "Check out <div class='section'>google.com</div>"
expected = "Check out <div class='section'><a href='http://google.com'>google.com</a></div>" expected = "Check out <div class='section'><a href='http://google.com'>google.com</a></div>"
assert parse(text, class: false, rel: false, new_window: false) == expected assert parse(text, class: false, rel: false, new_window: false) == expected
end end
test "excludes html with specified class" do test "excludes html with specified class" do
@ -76,69 +78,73 @@ defmodule AutoLinker.ParserTest do
def valid_number?(_, _), do: false def valid_number?(_, _), do: false
def valid_scheme_urls, do: [ def valid_scheme_urls,
"https://www.example.com", do: [
"http://www2.example.com", "https://www.example.com",
"http://home.example-site.com", "http://www2.example.com",
"http://blog.example.com", "http://home.example-site.com",
"http://www.example.com/product", "http://blog.example.com",
"http://www.example.com/products?id=1&page=2", "http://www.example.com/product",
"http://www.example.com#up", "http://www.example.com/products?id=1&page=2",
"http://255.255.255.255", "http://www.example.com#up",
"http://www.site.com:8008" "http://255.255.255.255",
] "http://www.site.com:8008"
]
def invalid_scheme_urls, do: [ def invalid_scheme_urls,
"http://invalid.com/perl.cgi?key= | http://web-site.com/cgi-bin/perl.cgi?key1=value1&key2", do: [
] "http://invalid.com/perl.cgi?key= | http://web-site.com/cgi-bin/perl.cgi?key1=value1&key2"
]
def valid_non_scheme_urls, do: [ def valid_non_scheme_urls,
"www.example.com", do: [
"www2.example.com", "www.example.com",
"www.example.com:2000", "www2.example.com",
"www.example.com?abc=1", "www.example.com:2000",
"example.example-site.com", "www.example.com?abc=1",
"example.com", "example.example-site.com",
"example.ca", "example.com",
"example.tv", "example.ca",
"example.com:999?one=one", "example.tv",
"255.255.255.255", "example.com:999?one=one",
"255.255.255.255:3000?one=1&two=2", "255.255.255.255",
] "255.255.255.255:3000?one=1&two=2"
]
def invalid_non_scheme_urls, do: [ def invalid_non_scheme_urls,
"invalid.com/perl.cgi?key= | web-site.com/cgi-bin/perl.cgi?key1=value1&key2", do: [
"invalid.", "invalid.com/perl.cgi?key= | web-site.com/cgi-bin/perl.cgi?key1=value1&key2",
"hi..there", "invalid.",
"555.555.5555" "hi..there",
] "555.555.5555"
]
def valid_phone_nunbers, do: [ def valid_phone_nunbers,
"x55", do: [
"x555", "x55",
"x5555", "x555",
"x12345", "x5555",
"+1 555 555-5555", "x12345",
"555 555-5555", "+1 555 555-5555",
"555.555.5555", "555 555-5555",
"613-555-5555", "555.555.5555",
"1 (555) 555-5555", "613-555-5555",
"(555) 555-5555", "1 (555) 555-5555",
"1.555.555.5555", "(555) 555-5555",
"800 555-5555", "1.555.555.5555",
"1.800.555.5555", "800 555-5555",
"1 (800) 555-5555", "1.800.555.5555",
"888 555-5555", "1 (800) 555-5555",
"887 555-5555", "888 555-5555",
"1-877-555-5555", "887 555-5555",
"1 800 710-5515" "1-877-555-5555",
] "1 800 710-5515"
]
def invalid_phone_numbers, do: [
"5555",
"x5",
"(555) 555-55",
]
def invalid_phone_numbers,
do: [
"5555",
"x5",
"(555) 555-55"
]
end end