Packages
phoenix
1.7.21
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/mix/tasks/phx.gen.channel.ex
defmodule Mix.Tasks.Phx.Gen.Channel do
@shortdoc "Generates a Phoenix channel"
@moduledoc """
Generates a Phoenix channel.
$ mix phx.gen.channel Room
Accepts the module name for the channel
The generated files will contain:
For a regular application:
* a channel in `lib/my_app_web/channels`
* a channel test in `test/my_app_web/channels`
For an umbrella application:
* a channel in `apps/my_app_web/lib/app_name_web/channels`
* a channel test in `apps/my_app_web/test/my_app_web/channels`
"""
use Mix.Task
alias Mix.Tasks.Phx.Gen
@doc false
def run(args) do
if Mix.Project.umbrella?() do
Mix.raise(
"mix phx.gen.channel must be invoked from within your *_web application root directory"
)
end
[channel_name] = validate_args!(args)
context_app = Mix.Phoenix.context_app()
web_prefix = Mix.Phoenix.web_path(context_app)
web_test_prefix = Mix.Phoenix.web_test_path(context_app)
binding = Mix.Phoenix.inflect(channel_name)
binding = Keyword.put(binding, :module, "#{binding[:web_module]}.#{binding[:scoped]}")
Mix.Phoenix.check_module_name_availability!(binding[:module] <> "Channel")
test_path = Path.join(web_test_prefix, "channels/#{binding[:path]}_channel_test.exs")
case_path = Path.join(Path.dirname(web_test_prefix), "support/channel_case.ex")
maybe_case =
if File.exists?(case_path) do
[]
else
[{:eex, "channel_case.ex", case_path}]
end
Mix.Phoenix.copy_from(
paths(),
"priv/templates/phx.gen.channel",
binding,
[
{:eex, "channel.ex", Path.join(web_prefix, "channels/#{binding[:path]}_channel.ex")},
{:eex, "channel_test.exs", test_path}
] ++ maybe_case
)
user_socket_path = Mix.Phoenix.web_path(context_app, "channels/user_socket.ex")
if File.exists?(user_socket_path) do
Mix.shell().info("""
Add the channel to your `#{user_socket_path}` handler, for example:
channel "#{binding[:singular]}:lobby", #{binding[:module]}Channel
""")
else
Mix.shell().info("""
The default socket handler - #{binding[:web_module]}.UserSocket - was not found.
""")
if Mix.shell().yes?("Do you want to create it?") do
Gen.Socket.run(~w(User --from-channel #{channel_name}))
else
Mix.shell().info("""
To create it, please run the mix task:
mix phx.gen.socket User
Then add the channel to the newly created file, at `#{user_socket_path}`:
channel "#{binding[:singular]}:lobby", #{binding[:module]}Channel
""")
end
end
end
@spec raise_with_help() :: no_return()
defp raise_with_help do
Mix.raise("""
mix phx.gen.channel expects just the module name, following capitalization:
mix phx.gen.channel Room
""")
end
defp validate_args!(args) do
unless length(args) == 1 and args |> hd() |> valid_name?() do
raise_with_help()
end
args
end
defp valid_name?(name) do
name =~ ~r/^[A-Z]\w*(\.[A-Z]\w*)*$/
end
defp paths do
[".", :phoenix]
end
end