Packages
corex
0.1.0-alpha.32
0.1.2
0.1.1
0.1.0
0.1.0-rc.1
0.1.0-rc.0
0.1.0-beta.5
0.1.0-beta.4
0.1.0-beta.3
0.1.0-beta.2
0.1.0-beta.1
0.1.0-alpha.33
0.1.0-alpha.32
0.1.0-alpha.31
0.1.0-alpha.30
0.1.0-alpha.29
0.1.0-alpha.28
0.1.0-alpha.27
0.1.0-alpha.26
0.1.0-alpha.25
0.1.0-alpha.24
0.1.0-alpha.23
0.1.0-alpha.22
0.1.0-alpha.21
0.1.0-alpha.20
0.1.0-alpha.19
0.1.0-alpha.18
0.1.0-alpha.17
0.1.0-alpha.16
0.1.0-alpha.15
0.1.0-alpha.14
0.1.0-alpha.13
0.1.0-alpha.12
0.1.0-alpha.11
0.1.0-alpha.10
0.1.0-alpha.9
0.1.0-alpha.8
0.1.0-alpha.7
0.1.0-alpha.6
0.1.0-alpha.5
0.1.0-alpha.4
0.1.0-alpha.3
0.1.0-alpha.2
0.1.0-alpha.1
Accessible and unstyled UI components library written in Elixir and TypeScript that integrates Zag.js state machines into the Phoenix Framework.
Current section
Files
Jump to
Current section
Files
lib/mix/tasks/corex.gen.html.ex
defmodule Mix.Tasks.Corex.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.
The format is:
```console
$ mix corex.gen.html [<context>] <schema> <table> <attr:type> [<attr:type>...]
```
For example:
```console
$ mix corex.gen.html User users name:string age:integer
```
Will generate a `User` schema for the `users` table within the `Users` context,
with the attributes `name` (as a string) and `age` (as an integer).
You can also explicitly pass the context name as argument, whenever the context
is well defined:
```console
$ mix corex.gen.html Accounts User users name:string age:integer
```
The first argument is the context module (`Accounts`) followed by
the schema module (`User`), table name (`users`), and attributes.
The context is an Elixir module that serves as an API boundary for
the given resource. A context often holds many related resources.
Therefore, if the context already exists, it will be augmented with
functions for the given resource.
The schema is responsible for mapping the database fields into an
Elixir struct. It is followed by a list of attributes with their
respective names and types. See `mix phx.gen.schema` for more
information on attributes.
Overall, this generator will add 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.
## Scopes
If your application configures its own default [scope](https://hexdocs.pm/phoenix/scopes.html), then this generator
will automatically make sure all of your context operations are correctly scoped.
You can pass the `--no-scope` flag to disable the scoping.
## 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:
```console
$ mix corex.gen.html Accounts User users --context-app my_app
```
## Web namespace
By default, the controller and HTML views are not namespaced but you can add
a namespace by passing the `--web` flag with a module name, for example:
```console
$ mix corex.gen.html Accounts User users --web Accounts
```
Which would generate a `lib/app_web/controllers/accounts/user_controller.ex` and
`lib/app_web/controllers/accounts/user_html.ex`.
## Customizing generated output
To override the default controller and HTML templates, copy the generator
templates from Corex into your project at `priv/corex_templates/corex.gen.html/`.
The generator looks there first, then `priv/templates/corex.gen.html/`, then
Corex's bundled templates. Adjust the copied `.ex`, `.heex`, and `.exs` EEx
files to match your style; they use the same bindings as the originals.
## 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. Note `--no-context` implies `--no-schema`:
```console
$ mix corex.gen.live Accounts User users --no-context name:string
```
In the cases above, tests are still generated, but they will all fail.
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. Context and schema generation use Phoenix; run `mix phx.gen.context`
or `mix phx.gen.schema` when you need only context or schema.
"""
use Mix.Task
alias Mix.Phoenix.{Context, Schema, Scope}
alias Mix.Tasks.Phx.Gen
@doc false
def run(args) do
if Mix.Project.umbrella?() do
Mix.raise(
"mix corex.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, name_optional: true)
if schema.attrs == [] do
Mix.raise("""
No attributes provided. The corex.gen.html generator requires at least one attribute. For example:
mix corex.gen.html Accounts User users name:string
""")
end
Gen.Context.prompt_for_code_injection(context)
{conn_scope, context_scope_prefix} =
if schema.scope do
base = "conn.assigns.#{schema.scope.assign_key}"
{base, "#{base}, "}
else
{"", ""}
end
layout_opts = layout_generators_opts(context, web_app_name(context))
binding = [
context: context,
schema: schema,
primary_key: schema.opts[:primary_key] || :id,
scope: schema.scope,
layout_mode: layout_mode?(layout_opts),
layout_theme: layout_theme?(layout_opts),
layout_themes: layout_themes?(layout_opts),
layout_locale: layout_locale?(layout_opts),
inputs: inputs(schema),
conn_scope: conn_scope,
context_scope_prefix: context_scope_prefix,
scope_conn_route_prefix: Scope.route_prefix(conn_scope, schema),
scope_param_route_prefix: Scope.route_prefix("scope", schema),
scope_assign_route_prefix: scope_assign_route_prefix(schema),
test_context_scope:
if(schema.scope && schema.scope.route_prefix, do: ", scope: scope", else: "")
]
prompt_for_conflicts(context)
context
|> copy_new_files(binding)
|> print_shell_instructions()
end
defp prompt_for_conflicts(context) do
context
|> files_to_be_generated()
|> Kernel.++(context_files(context))
|> Mix.Corex.prompt_for_conflicts()
end
defp context_files(%Context{generate?: true} = context) do
Mix.Corex.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.Corex.web_path(context_app)
test_prefix = Mix.Corex.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, binding) do
files = files_to_be_generated(context)
template_dirs = Mix.Corex.generator_template_dirs("corex.gen.html")
Mix.Corex.copy_from(template_dirs, "", binding, files)
if context.generate?, do: Mix.Corex.Gen.Context.copy_new_files(context, binding)
context
end
@doc false
def print_shell_instructions(%Context{schema: schema, context_app: ctx_app} = context) do
layout_opts = layout_generators_opts(context, web_app_name(context))
layout_locale = layout_locale?(layout_opts)
resource_path =
if schema.scope && schema.scope.route_prefix do
"#{schema.scope.route_prefix}/#{schema.plural}"
else
"/#{schema.plural}"
end
scope_instruction =
if layout_locale do
"Add the resource inside the existing scope \"/:locale\" block in #{Mix.Phoenix.web_path(ctx_app)}/router.ex:"
else
"Add the resource to your browser scope in #{Mix.Phoenix.web_path(ctx_app)}/router.ex:"
end
if schema.web_namespace do
Mix.shell().info("""
#{scope_instruction}
scope "/#{schema.web_path}", #{inspect(Module.concat(context.web_module, schema.web_namespace))} do
pipe_through :browser
...
resources "#{resource_path}", #{inspect(schema.alias)}Controller#{if schema.opts[:primary_key], do: ~s[, param: "#{schema.opts[:primary_key]}"]}
end
""")
else
Mix.shell().info("""
#{scope_instruction}
resources "#{resource_path}", #{inspect(schema.alias)}Controller#{if schema.opts[:primary_key], do: ~s[, param: "#{schema.opts[:primary_key]}"]}
""")
end
if schema.scope do
Mix.shell().info(
"Ensure the routes are defined in a block that sets the `#{inspect(context.scope.assign_key)}` assign."
)
end
if context.generate?, do: Mix.Corex.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} ->
number_input_block(key, nil)
{key, :float} ->
number_input_block(key, 0.1)
{key, :decimal} ->
number_input_block(key, 0.1)
{key, :boolean} ->
checkbox_block(key)
{key, :text} ->
native_input_block("textarea", key, error_slot: true)
{key, :date} ->
date_picker_block(key)
{key, :time} ->
native_input_block("time", key, error_slot: true)
{key, :utc_datetime} ->
native_input_block("datetime-local", key, error_slot: true)
{key, :naive_datetime} ->
native_input_block("datetime-local", key, error_slot: true)
{key, {:array, _} = type} ->
native_input_select_multiple_block(key, type)
{key, {:enum, _}} ->
select_enum_block(schema, key)
{key, _} ->
native_input_block("text", key, error_slot: true)
end)
end
defp number_input_block(key, step) do
step_attr = if step, do: " step={0.1}", else: ""
~s"""
<.number_input field={f[#{inspect(key)}]} class="number-input"#{step_attr}>
<:label>#{label(key)}</:label>
<:decrement_trigger><.heroicon name="hero-chevron-down" class="icon" /></:decrement_trigger>
<:increment_trigger><.heroicon name="hero-chevron-up" class="icon" /></:increment_trigger>
<:error :let={msg}>
<.heroicon name="hero-exclamation-circle" class="icon" />
{msg}
</:error>
</.number_input>
"""
end
defp checkbox_block(key) do
~s"""
<.checkbox field={f[#{inspect(key)}]} class="checkbox">
<:label>#{label(key)}</:label>
<:indicator>
<.heroicon name="hero-check" class="data-checked" />
</:indicator>
<:error :let={msg}>
<.heroicon name="hero-exclamation-circle" class="icon" />
{msg}
</:error>
</.checkbox>
"""
end
defp date_picker_block(key) do
~s"""
<.date_picker field={f[#{inspect(key)}]} class="date-picker">
<:label>#{label(key)}</:label>
<:trigger>
<.heroicon name="hero-calendar" class="icon" />
</:trigger>
<:prev_trigger>
<.heroicon name="hero-chevron-left" class="icon" />
</:prev_trigger>
<:next_trigger>
<.heroicon name="hero-chevron-right" class="icon" />
</:next_trigger>
<:error :let={msg}>
<.heroicon name="hero-exclamation-circle" class="icon" />
{msg}
</:error>
</.date_picker>
"""
end
defp native_input_select_multiple_block(key, type) do
opts = default_options(type)
opts_inspect = inspect(opts)
~s"""
<.native_input
field={f[#{inspect(key)}]}
type="select"
multiple
options={#{opts_inspect}}
class="native-input"
>
<:label>#{label(key)}</:label>
<:error :let={msg}>
<.heroicon name="hero-exclamation-circle" class="icon" />
{msg}
</:error>
</.native_input>
"""
end
defp select_enum_block(%Schema{} = schema, key) do
~s"""
<.select
field={f[#{inspect(key)}]}
class="select"
items={
Enum.map(Ecto.Enum.values(#{inspect(schema.module)}, #{inspect(key)}), fn v ->
%{id: v, label: Phoenix.Naming.humanize(to_string(v))}
end)
}
translation={%Corex.Select.Translation{placeholder: "Choose a value"}}
>
<:label>#{label(key)}</:label>
<:trigger>
<.heroicon name="hero-chevron-down" />
</:trigger>
<:error :let={msg}>
<.heroicon name="hero-exclamation-circle" class="icon" />
{msg}
</:error>
</.select>
"""
end
defp native_input_block(type, key, opts) do
error = if Keyword.get(opts, :error_slot, false), do: "\n " <> error_slot(), else: ""
~s"""
<.native_input
field={f[#{inspect(key)}]}
type="#{type}"
class="native-input"
>
<:label>#{label(key)}</:label>#{error}
</.native_input>
"""
end
defp error_slot do
~s"""
<:error :let={msg}>
<.heroicon name="hero-exclamation-circle" class="icon" />
{msg}
</:error>
"""
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))
defp scope_assign_route_prefix(
%{scope: %{route_prefix: route_prefix, assign_key: assign_key}} = schema
)
when not is_nil(route_prefix) do
Scope.route_prefix("@#{assign_key}", schema)
end
defp scope_assign_route_prefix(_), do: ""
defp web_app_name(%Context{} = context) do
context.web_module
|> inspect()
|> Phoenix.Naming.underscore()
end
defp layout_generators_opts(_context, _web_app_name) do
Application.get_env(:corex, :generators, [])[:layout] || []
end
defp layout_locale?(opts), do: Keyword.has_key?(opts, :locale)
defp layout_theme?(opts), do: Keyword.has_key?(opts, :theme)
defp layout_mode?(opts), do: Keyword.has_key?(opts, :mode)
defp layout_themes?(opts) do
layout_theme?(opts) and app_has_themes?()
end
defp app_has_themes? do
app = Mix.Project.config()[:app]
str = to_string(app)
root_app =
if String.ends_with?(str, "_web") do
String.to_atom(String.replace_suffix(str, "_web", ""))
else
app
end
themes = Application.get_env(app, :themes) || Application.get_env(root_app, :themes)
is_list(themes)
end
@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