defmodule Mix.Tasks.Phx.Gen.Html do @shortdoc "Generates context and controller for an HTML resource" @moduledoc """ Generates controller with view, templates, schema and context for an HTML resource. mix phx.gen.html Accounts User users name:string age:integer The first argument, `Accounts`, is the resource's context. A context is an Elixir module that serves as an API boundary for closely related resources. The second argument, `User`, is the resource's schema. A schema is an Elixir module responsible for mapping database fields into an Elixir struct. The `User` schema above specifies two fields with their respective colon-delimited data types: `name:string` and `age:integer`. See `mix phx.gen.schema` for more information on attributes. > Note: A resource may also be split > over distinct contexts (such as `Accounts.User` and `Payments.User`). This generator adds the following files to `lib/`: * a controller in `lib/my_app_web/controllers/user_controller.ex` * default CRUD HTML templates in `lib/my_app_web/controllers/user_html` * an HTML view collocated with the controller in `lib/my_app_web/controllers/user_html.ex` * a schema in `lib/my_app/accounts/user.ex`, with an `users` table * a context module in `lib/my_app/accounts.ex` for the accounts API Additionally, this generator creates the following files: * a migration for the schema in `priv/repo/migrations` * a controller test module in `test/my_app/controllers/user_controller_test.exs` * a context test module in `test/my_app/accounts_test.exs` * a context test helper module in `test/support/fixtures/accounts_fixtures.ex` If the context already exists, this generator injects functions for the given resource into the context, context test, and context test helper modules. ## Umbrella app configuration By default, Phoenix injects both web and domain specific functionality into the same application. When using umbrella applications, those concerns are typically broken into two separate apps, your context application - let's call it `my_app` - and its web layer, which Phoenix assumes to be `my_app_web`. You can teach Phoenix to use this style via the `:context_app` configuration option in your `my_app_umbrella/config/config.exs`: config :my_app_web, ecto_repos: [Stuff.Repo], generators: [context_app: :my_app] Alternatively, the `--context-app` option may be supplied to the generator: mix phx.gen.html Sales User users --context-app my_app If you delete the `:context_app` configuration option, Phoenix will automatically put generated web files in `my_app_umbrella/apps/my_app_web_web`. If you change the value of `:context_app` to `:new_value`, `my_app_umbrella/apps/new_value_web` must already exist or you will get the following error: ** (Mix) no directory for context_app :new_value found in my_app_web's deps. ## Web namespace By default, the controller and HTML view will be namespaced by the schema name. You can customize the web module namespace by passing the `--web` flag with a module name, for example: mix phx.gen.html Sales User users --web Sales Which would generate a `lib/app_web/controllers/sales/user_controller.ex` and `lib/app_web/controllers/sales/user_html.ex`. ## Customizing the context, schema, tables and migrations In some cases, you may wish to bootstrap HTML templates, controllers, and controller tests, but leave internal implementation of the context or schema to yourself. You can use the `--no-context` and `--no-schema` flags for file generation control. You can also change the table name or configure the migrations to use binary ids for primary keys, see `mix phx.gen.schema` for more information. """ use Mix.Task alias Mix.Phoenix.{Context, Schema} alias Mix.Tasks.Phx.Gen @doc false def run(args) do if Mix.Project.umbrella?() do Mix.raise( "mix phx.gen.html must be invoked from within your *_web application root directory" ) end Mix.Phoenix.ensure_live_view_compat!(__MODULE__) {context, schema} = Gen.Context.build(args) Gen.Context.prompt_for_code_injection(context) binding = [context: context, schema: schema, inputs: inputs(schema)] paths = Mix.Phoenix.generator_paths() prompt_for_conflicts(context) context |> copy_new_files(paths, binding) |> print_shell_instructions() end defp prompt_for_conflicts(context) do context |> files_to_be_generated() |> Kernel.++(context_files(context)) |> Mix.Phoenix.prompt_for_conflicts() end defp context_files(%Context{generate?: true} = context) do Gen.Context.files_to_be_generated(context) end defp context_files(%Context{generate?: false}) do [] end @doc false def files_to_be_generated(%Context{schema: schema, context_app: context_app}) do singular = schema.singular web_prefix = Mix.Phoenix.web_path(context_app) test_prefix = Mix.Phoenix.web_test_path(context_app) web_path = to_string(schema.web_path) controller_pre = Path.join([web_prefix, "controllers", web_path]) test_pre = Path.join([test_prefix, "controllers", web_path]) [ {:eex, "controller.ex", Path.join([controller_pre, "#{singular}_controller.ex"])}, {:eex, "edit.html.heex", Path.join([controller_pre, "#{singular}_html", "edit.html.heex"])}, {:eex, "index.html.heex", Path.join([controller_pre, "#{singular}_html", "index.html.heex"])}, {:eex, "new.html.heex", Path.join([controller_pre, "#{singular}_html", "new.html.heex"])}, {:eex, "show.html.heex", Path.join([controller_pre, "#{singular}_html", "show.html.heex"])}, {:eex, "resource_form.html.heex", Path.join([controller_pre, "#{singular}_html", "#{singular}_form.html.heex"])}, {:eex, "html.ex", Path.join([controller_pre, "#{singular}_html.ex"])}, {:eex, "controller_test.exs", Path.join([test_pre, "#{singular}_controller_test.exs"])} ] end @doc false def copy_new_files(%Context{} = context, paths, binding) do files = files_to_be_generated(context) Mix.Phoenix.copy_from(paths, "priv/templates/phx.gen.html", binding, files) if context.generate?, do: Gen.Context.copy_new_files(context, paths, binding) context end @doc false def print_shell_instructions(%Context{schema: schema, context_app: ctx_app} = context) do if schema.web_namespace do Mix.shell().info(""" Add the resource to your #{schema.web_namespace} :browser scope in #{Mix.Phoenix.web_path(ctx_app)}/router.ex: scope "/#{schema.web_path}", #{inspect(Module.concat(context.web_module, schema.web_namespace))}, as: :#{schema.web_path} do pipe_through :browser ... resources "/#{schema.plural}", #{inspect(schema.alias)}Controller end """) else Mix.shell().info(""" Add the resource to your browser scope in #{Mix.Phoenix.web_path(ctx_app)}/router.ex: resources "/#{schema.plural}", #{inspect(schema.alias)}Controller """) end if context.generate?, do: Gen.Context.print_shell_instructions(context) end @doc false def inputs(%Schema{} = schema) do schema.attrs |> Enum.reject(fn {_key, type} -> type == :map end) |> Enum.map(fn {key, :integer} -> ~s(<.input field={f[#{inspect(key)}]} type="number" label="#{label(key)}" />) {key, :float} -> ~s(<.input field={f[#{inspect(key)}]} type="number" label="#{label(key)}" step="any" />) {key, :decimal} -> ~s(<.input field={f[#{inspect(key)}]} type="number" label="#{label(key)}" step="any" />) {key, :boolean} -> ~s(<.input field={f[#{inspect(key)}]} type="checkbox" label="#{label(key)}" />) {key, :text} -> ~s(<.input field={f[#{inspect(key)}]} type="text" label="#{label(key)}" />) {key, :date} -> ~s(<.input field={f[#{inspect(key)}]} type="date" label="#{label(key)}" />) {key, :time} -> ~s(<.input field={f[#{inspect(key)}]} type="time" label="#{label(key)}" />) {key, :utc_datetime} -> ~s(<.input field={f[#{inspect(key)}]} type="datetime-local" label="#{label(key)}" />) {key, :naive_datetime} -> ~s(<.input field={f[#{inspect(key)}]} type="datetime-local" label="#{label(key)}" />) {key, {:array, _} = type} -> ~s""" <.input field={f[#{inspect(key)}]} type="select" multiple label="#{label(key)}" options={#{inspect(default_options(type))}} /> """ {key, {:enum, _}} -> ~s""" <.input field={f[#{inspect(key)}]} type="select" label="#{label(key)}" prompt="Choose a value" options={Ecto.Enum.values(#{inspect(schema.module)}, #{inspect(key)})} /> """ {key, _} -> ~s(<.input field={f[#{inspect(key)}]} type="text" label="#{label(key)}" />) end) end defp default_options({:array, :string}), do: Enum.map([1, 2], &{"Option #{&1}", "option#{&1}"}) defp default_options({:array, :integer}), do: Enum.map([1, 2], &{"#{&1}", &1}) defp default_options({:array, _}), do: [] defp label(key), do: Phoenix.Naming.humanize(to_string(key)) @doc false def indent_inputs(inputs, column_padding) do columns = String.duplicate(" ", column_padding) inputs |> Enum.map(fn input -> lines = input |> String.split("\n") |> Enum.reject(&(&1 == "")) case lines do [] -> [] [line] -> [columns, line] [first_line | rest] -> rest = Enum.map_join(rest, "\n", &(columns <> &1)) [columns, first_line, "\n", rest] end end) |> Enum.intersperse("\n") end end