Packages
phoenix
0.1.0
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.
Security advisory:
This version has known vulnerabilities.
View advisories
Current section
Files
Jump to
Current section
Files
lib/phoenix/router/path.ex
defmodule Phoenix.Router.Path do
def split(path), do: String.split(path, "/")
def join([]), do: ""
def join(split_path), do: Elixir.Path.join(split_path)
def split_from_conn(conn) do
conn.path_info |> join |> split
end
@doc """
Returns the AST binding of the given variable with var_name
var_name - The String or Atom variable name to be bound
# Examples
iex> Phoenix.Router.Path.var_ast("my_var")
{:var!, [context: Phoenix.Router.Path, import: Kernel], [:my_var]}
iex> Phoenix.Router.Path.var_ast(:my_var)
{:var!, [context: Phoenix.Router.Path, import: Kernel], [:my_var]}
"""
def var_ast(var_name) when is_binary(var_name) do
var_ast(binary_to_atom(var_name))
end
def var_ast(var_name) do
quote do: var!(unquote(var_name))
end
@doc """
Splits parameterized String path into list of arguments for defmatch route.
Named params beginning with ":" are injected into the argument list as
an AST binding matching the param name.
Examples
iex> Path.matched_arg_list_with_ast_bindings("users/:user_id/comments/:id")
["users", {:var!, [context: Phoenix.Router.Path, import: Kernel], [:user_id]},
"comments", {:var!, [context: Phoenix.Router.Path, import: Kernel], [:id]}]
iex> Path.matched_arg_list_with_ast_bindings("/pages")
["pages"]
iex> Path.matched_arg_list_with_ast_bindings("/")
[""]
Generated as:
def match(:get, ["users", user_id, "comments", id])
"""
def matched_arg_list_with_ast_bindings(path) do
path
|> ensure_no_leading_slash
|> split
|> Enum.chunk(2, 1, [nil])
|> Enum.map(fn [part, next] -> part_to_ast_binding(part, next) end)
|> Enum.filter(fn part -> part end)
end
defp part_to_ast_binding(<<"*" <> _splat_name>>, nil), do: nil
defp part_to_ast_binding(<<":" <> param_name>>, <<"*" <> splat_name>>) do
{:|, [], [var_ast(param_name), var_ast(splat_name)]}
end
defp part_to_ast_binding(<<":" <> param_name>>, _next) do
var_ast(param_name)
end
defp part_to_ast_binding(part, <<"*" <> splat_name>>) do
{:|, [], [part, var_ast(splat_name)]}
end
defp part_to_ast_binding(part, _next), do: part
@doc """
Returns Keyword List of parameters from URL matched with
AST of associationed bindings for inclusion in defmatch route
Examples
iex> Path.params_with_ast_bindings("users/:user_id/comments/:id")
[{"user_id", {:var!, [context: Phoenix.Router.Path, import: Kernel], [:user_id]}},
{"id", {:var!, [context: Phoenix.Router.Path, import: Kernel], [:id]}}]
"""
def params_with_ast_bindings(path) do
Enum.zip(param_names(path), matched_param_ast_bindings(path))
end
def matched_param_ast_bindings(path) do
path
|> split
|> Enum.map(fn
<<":" <> param>> -> var_ast(param)
<<"*" <> param>> -> quote do: Phoenix.Router.Path.join(unquote(var_ast(param)))
_part ->
end)
|> Enum.filter(&is_tuple(&1))
end
@doc """
Returns List of atoms of contained named parameters in route
Examples
iex> Phoenix.Router.Path.param_names("users/:user_id/comments/:id")
["user_id", "id"]
iex> Phoenix.Router.Path.param_names("/pages/about")
[]
"""
def param_names(path) do
Regex.scan(~r/[\:\*]{1}\w+/, path)
|> List.flatten
|> Enum.map(&String.strip(&1, ?:))
|> Enum.map(&String.strip(&1, ?*))
end
@doc """
Builds String Path replacing named params with keyword list of values
# Examples
iex> Path.build("users/:user_id/comments/:id", user_id: 1, id: 123)
"/users/1/comments/123"
iex> Path.build("pages/about", [])
"/pages/about"
"""
def build(path, []), do: ensure_leading_slash(path)
def build(path, param_values) do
path
|> param_names
|> replace_param_names_with_values(param_values, path)
|> ensure_leading_slash
end
defp replace_param_names_with_values(param_names, param_values, path) do
Enum.reduce param_names, path, fn param_name, path_acc ->
value = param_values[binary_to_atom(param_name)] |> to_string
String.replace(path_acc, ~r/[\:\*]{1}#{param_name}/, value)
end
end
@doc """
Adds leading forward slash to string path if missing
# Examples
iex> Path.ensure_leading_slash("users/1")
"/users/1"
iex> Path.ensure_leading_slash("/users/2")
"/users/2"
"""
def ensure_leading_slash(path = <<"/" <> _rest>>), do: path
def ensure_leading_slash(path), do: "/" <> path
@doc """
Removes leading forward slash from string path if present
# Examples
iex> Path.ensure_no_leading_slash("users/1")
"users/1"
iex> Path.ensure_no_leading_slash("/users/2")
"users/2"
"""
def ensure_no_leading_slash(<<"/" <> rest>>), do: rest
def ensure_no_leading_slash(path), do: path
end