Packages
phoenix
1.8.9
1.8.9
1.8.8
1.8.7
1.8.6
1.8.5
1.8.4
1.8.3
1.8.2
1.8.1
1.8.0
1.8.0-rc.4
1.8.0-rc.3
1.8.0-rc.2
1.8.0-rc.1
1.8.0-rc.0
1.7.24
1.7.23
1.7.22
1.7.21
1.7.20
1.7.19
1.7.18
1.7.17
1.7.16
1.7.15
1.7.14
1.7.13
1.7.12
1.7.11
1.7.10
1.7.9
1.7.8
1.7.7
1.7.6
1.7.5
1.7.4
1.7.3
1.7.2
1.7.1
1.7.0
1.7.0-rc.3
1.7.0-rc.2
1.7.0-rc.1
1.7.0-rc.0
1.6.17
1.6.16
1.6.15
1.6.14
1.6.13
1.6.12
1.6.11
1.6.10
1.6.9
1.6.8
1.6.7
1.6.6
1.6.5
1.6.4
1.6.3
1.6.2
1.6.1
1.6.0
1.6.0-rc.1
1.6.0-rc.0
1.5.15
1.5.14
1.5.13
1.5.12
1.5.11
1.5.10
1.5.9
1.5.8
1.5.7
1.5.6
1.5.5
1.5.4
1.5.3
1.5.2
1.5.1
1.5.0
1.5.0-rc.0
1.4.18
1.4.17
1.4.16
1.4.15
1.4.14
1.4.13
1.4.12
1.4.11
1.4.10
1.4.9
1.4.8
1.4.7
1.4.6
1.4.5
1.4.4
1.4.3
1.4.2
1.4.1
1.4.0
1.4.0-rc.3
1.4.0-rc.2
1.4.0-rc.1
1.4.0-rc.0
1.3.5
1.3.4
1.3.3
1.3.2
1.3.1
1.3.0
1.3.0-rc.3
1.3.0-rc.2
1.3.0-rc.1
1.3.0-rc.0
1.2.5
1.2.4
1.2.3
1.2.2
1.2.1
1.2.0
1.2.0-rc.1
1.2.0-rc.0
1.1.9
1.1.8
1.1.7
1.1.6
1.1.5
1.1.4
1.1.3
1.1.2
1.1.1
1.1.0
1.0.6
1.0.5
1.0.4
1.0.3
1.0.2
1.0.1
1.0.0
0.17.1
0.17.0
0.16.1
0.16.0
0.15.0
0.14.0
0.13.1
0.13.0
0.12.0
0.11.0
0.10.0
0.9.0
0.8.0
0.7.2
0.7.1
0.7.0
0.6.2
0.6.1
0.6.0
0.5.0
0.4.1
0.4.0
0.3.1
0.3.0
0.2.11
0.2.10
0.2.9
0.2.8
0.2.7
0.2.6
0.2.5
0.2.4
0.2.3
0.2.2
0.2.1
0.2.0
0.1.0
Productive. Reliable. Fast. A productive web framework that does not compromise speed or maintainability.
Current section
Files
Jump to
Current section
Files
lib/phoenix/router/console_formatter.ex
defmodule Phoenix.Router.ConsoleFormatter do
@moduledoc false
@doc """
Format the routes for printing.
"""
@socket_verb "WS"
@longpoll_verbs ["GET", "POST"]
def format(router, endpoint \\ nil) do
routes = router.formatted_routes([])
column_widths = calculate_column_widths(router, routes, endpoint)
IO.iodata_to_binary([
Enum.map(routes, &format_route(&1, router, column_widths)),
format_endpoint(endpoint, column_widths)
])
end
defp format_endpoint(nil, _router), do: ""
defp format_endpoint(endpoint, widths) do
case endpoint.__sockets__() do
[] ->
""
sockets ->
Enum.map(sockets, fn socket ->
[format_websocket(socket, widths), format_longpoll(socket, widths)]
end)
end
end
defp format_websocket({_path, Phoenix.LiveReloader.Socket, _opts}, _), do: ""
defp format_websocket({path, module, opts}, widths) do
if opts[:websocket] != false do
{verb_len, path_len, route_name_len} = widths
String.duplicate(" ", route_name_len) <>
" " <>
String.pad_trailing(@socket_verb, verb_len) <>
" " <>
String.pad_trailing(path <> "/websocket", path_len) <>
" " <>
inspect(module) <>
"\n"
else
""
end
end
defp format_longpoll({_path, Phoenix.LiveReloader.Socket, _opts}, _), do: ""
defp format_longpoll({path, module, opts}, widths) do
if opts[:longpoll] != false do
for method <- @longpoll_verbs, into: "" do
{verb_len, path_len, route_name_len} = widths
String.duplicate(" ", route_name_len) <>
" " <>
String.pad_trailing(method, verb_len) <>
" " <>
String.pad_trailing(path <> "/longpoll", path_len) <>
" " <>
inspect(module) <>
"\n"
end
else
""
end
end
defp calculate_column_widths(router, routes, endpoint) do
sockets = (endpoint && endpoint.__sockets__()) || []
widths =
Enum.reduce(routes, {0, 0, 0}, fn route, acc ->
%{verb: verb, path: path, helper: helper} = route
verb = verb_name(verb)
{verb_len, path_len, route_name_len} = acc
route_name = route_name(router, helper)
{max(verb_len, String.length(verb)), max(path_len, String.length(path)),
max(route_name_len, String.length(route_name))}
end)
Enum.reduce(sockets, widths, fn {path, _mod, opts}, acc ->
{verb_len, path_len, route_name_len} = acc
verb_length =
socket_verbs(opts)
|> Enum.map(&String.length/1)
|> Enum.max(&>=/2, fn -> 0 end)
{max(verb_len, verb_length), max(path_len, String.length(path <> "/websocket")),
route_name_len}
end)
end
defp format_route(route, router, column_widths) do
%{
verb: verb,
path: path,
label: label
} = route
verb = verb_name(verb)
route_name = route_name(router, Map.get(route, :helper))
{verb_len, path_len, route_name_len} = column_widths
String.pad_leading(route_name, route_name_len) <>
" " <>
String.pad_trailing(verb, verb_len) <>
" " <>
String.pad_trailing(path, path_len) <>
" " <>
label <> "\n"
end
defp route_name(_router, nil), do: ""
defp route_name(router, name) do
if router.__helpers__() do
name <> "_path"
else
""
end
end
defp verb_name(verb), do: verb |> to_string() |> String.upcase()
defp socket_verbs(socket_opts) do
if socket_opts[:longpoll] != false do
[@socket_verb | @longpoll_verbs]
else
[@socket_verb]
end
end
end