defmodule Mix.Tasks.Mandarin.Gen.Html do @shortdoc "Generates controller, views, and context for an HTML resource" @moduledoc """ Generates controller, views, and context for an HTML resource. mix mandarin.gen.html Admin User users name:string age:integer The first argument is the context module followed by the schema module and its plural name (used as the schema table name). 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. > Note: A resource may also be split > over distinct contexts (such as `admin.User` and `Payments.User`). The schema is responsible for mapping the database fields into an Elixir struct. Overall, this generator will add the following files to `lib/`: * a context module in `lib/app/admin/admin.ex` for the admin API * a schema in `lib/app/admin/user.ex`, with an `users` table * a view in `lib/app_web/views/user_view.ex` * a controller in `lib/app_web/controllers/user_controller.ex` * default CRUD templates in `lib/app_web/templates/user` A migration file for the repository and test files for the context and controller features will also be generated. The location of the web files (controllers, views, templates, etc) in an umbrella application will vary based on the `:context_app` config located in your applications `:generators` configuration. When set, the Mandarin generators will generate web files directly in your lib and test folders since the application is assumed to be isolated to web specific functionality. If `:context_app` is not set, the generators will place web related lib and test files in a `web/` directory since the application is assumed to be handling both web and domain specific functionality. Example configuration: config :my_app_web, :generators, context_app: :my_app Alternatively, the `--context-app` option may be supplied to the generator: mix mandarin.gen.html Sales User users --context-app warehouse ## Web namespace By default, the controller and 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 mandarin.gen.html Sales User users --web Sales Which would generate a `lib/app_web/controllers/sales/user_controller.ex` and `lib/app_web/views/sales/user_view.ex`. ## Generating without a schema or context file 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. ## table By default, the table name for the migration and schema will be the plural name provided for the resource. To customize this value, a `--table` option may be provided. For example: mix mandarin.gen.html admin User users --table cms_users ## binary_id Generated migration can use `binary_id` for schema's primary key and its references with option `--binary-id`. ## Default options This generator uses default options provided in the `:generators` configuration of your application. These are the defaults: config :your_app, :generators, migration: true, binary_id: false, sample_binary_id: "11111111-1111-1111-1111-111111111111" You can override those options per invocation by providing corresponding switches, e.g. `--no-binary-id` to use normal ids despite the default configuration or `--migration` to force generation of the migration. Read the documentation for `mandarin.gen.schema` for more information on attributes. """ use Mix.Task alias Mandarin.Naming alias Mandarin.Injector alias Mix.Mandarin.Context alias Mix.Tasks.Mandarin.Gen require EEx @doc false def run(args) do if Mix.Project.umbrella?() do Mix.raise("mix mandarin.gen.html can only be run inside an application directory") end {context, schema} = Gen.Context.build(args) # The user can disable the prompt by supplying the --yes switch unless "--yes" in args do Gen.Context.prompt_for_code_injection(context) end binding = [ context: context, schema: schema, inputs: inputs(context), filters: filters(context) ] paths = Mix.Mandarin.generator_paths() prompt_for_conflicts(context) routes_injection_result = inject_routes(context) new_context = context |> maybe_add_links_to_sidebar() |> copy_new_files(paths, binding) # Now we tell the user which manual steps are required. # The only step that might require manual intervention is adding # the new routes to the router, but in the usual case this # step is not required because Mandarin is smart enough to add # the routes in the right place print_shell_instructions(new_context, routes_injection_result) end @spec inject_routes(Context.t()) :: Injector.file_injection_result() defp inject_routes(%Context{schema: schema, context_app: ctx_app} = context) do ctx_web_path = Mix.Mandarin.web_path(ctx_app) router_path = "#{ctx_web_path}/router.ex" routes_marker = "# %% Mandarin Routes - #{inspect(context.alias)} %%" skip_marker = "# Routes for #{inspect(context.alias)}.#{inspect(schema.alias)}\n" routes_code = """ #{skip_marker}\ get "/#{schema.singular}/select", #{inspect(schema.alias)}Controller, :select resources "/#{schema.singular}", #{inspect(schema.alias)}Controller\ """ Injector.inject_below_in_file( router_path, routes_marker, routes_code, skip_marker: skip_marker ) end @links_end "\n <%# %% Resource Links - END %% %>" defp maybe_insert_links(file, context, schema) do contents = File.read!(file) link_header = "<%# * Sidebar link for #{inspect(schema.alias)} %>" case String.contains?(contents, link_header) do # The sidebar already contains a link to this resource # (probably because we're regenerating the files for the resource) true -> nil false -> case String.split(contents, @links_end, parts: 2) do [part1, part2] -> link = sidebar_link(context, schema) # Use the fact that `File.write!/2` works with iolists new_contents = [ part1, "\n", [" ", link_header], "\n", String.trim_trailing(link), @links_end, part2 ] File.write!(file, new_contents) _other -> # The user has deleted the link markers... nil end end end EEx.function_from_file( :defp, :sidebar_link, "priv/templates/mandarin.gen.html/sidebar-link.html.heex", [:context, :schema] ) defp maybe_add_links_to_sidebar(%Context{schema: schema, context_app: context_app} = context) do sidebar_template_path = Mix.Tasks.Mandarin.Install.sidebar_path(context_app, context.basename) if File.exists?(sidebar_template_path) do maybe_insert_links(sidebar_template_path, context, schema) end context end defp prompt_for_conflicts(context) do context |> files_to_be_generated() |> Kernel.++(context_files(context)) |> Mix.Mandarin.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} = context) do web_prefix = Mix.Mandarin.web_path(context_app) test_prefix = Mix.Mandarin.web_test_path(context_app) # web_path = to_string(schema.web_path) ctx_basename = context.basename feature_dir = Path.join([web_prefix, ctx_basename, schema.singular]) template_dir = Path.join(feature_dir, "templates") controller_path = Path.join(feature_dir, "#{schema.singular}_controller.ex") view_path = Path.join(feature_dir, "#{schema.singular}_view.ex") controller_test_path = Path.join([ test_prefix, ctx_basename, "controllers", "#{schema.singular}_controller_test.exs" ]) html_templates = for name <- ~w(edit filters form index new show table) do filename = "#{name}.html.heex" output_path = Path.join(template_dir, filename) {:eex, filename, output_path} end [ {:eex, "controller.ex", controller_path}, {:eex, "view.ex", view_path}, {:eex, "controller_test.exs", controller_test_path} ] ++ html_templates end @doc false def copy_new_files(%Context{} = context, paths, binding) do files = files_to_be_generated(context) Mix.Mandarin.copy_from(paths, "priv/templates/mandarin.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, :ok) do # We were able to add the routes automatically ctx_web_path = Mix.Mandarin.web_path(ctx_app) Mix.shell().info(""" Mandarin has added the resource to your #{schema.web_namespace} :browser scope in #{ctx_web_path}/router.ex: #{scope_code(context)} You probably want to put these routes behind some kind of authentication. """) end def print_shell_instructions( %Context{schema: schema, context_app: ctx_app} = context, :marker_not_found ) do # We were unable to add the routes automatically ctx_web_path = Mix.Mandarin.web_path(ctx_app) Mix.shell().info(""" Mandarin couldn't add the new routes to your router. You'll need to add them yourself. Add the resource to your #{schema.web_namespace} :browser scope in #{ctx_web_path}/router.ex: #{scope_code(context)} You probably want to put these routes behind some kind of authentication. """) end def print_shell_instructions( _context, result ) when result in [:already_injected, :skip] do # No need to add new routes because they were already there Mix.shell().info(""" Mandarin didn't add new routes to your router because they were already there. If you haven't done so already, you might want to put these routes behind some kind of authentication. """) end defp scope_code(%Context{schema: schema} = context) do """ scope "/#{schema.web_path}", #{inspect(context.basename)}, as: :#{context.basename} do pipe_through([:browser, :#{context.basename}_layout]) ... get "/#{schema.pluralized}/select", #{inspect(schema.alias)}Controller, :select resources "/#{schema.pluralized}", #{inspect(schema.alias)}Controller end """ end def routes_for_context(%Context{schema: schema} = _context) do """ get "/#{schema.pluralized}/select", #{inspect(schema.alias)}Controller, :select resources "/#{schema.pluralized}", #{inspect(schema.alias)}Controller """ end defp label_for(key) do key |> to_string() # Turn the field name into something human-readable |> Naming.humanize() # Inspect the string (this will surround it in quotes and escape the special characters) |> inspect() end defp i18n_label_for(context, key) do ~s[dgettext("mandarin.#{context.basename}", #{label_for(key)})] end def inputs(%Context{schema: schema} = context) do attrs = Enum.map(schema.attrs, fn {_, {:references, _}} -> nil {key, :integer} -> """ <%= forage_form_group(f, #{inspect(key)}, #{i18n_label_for(context, key)}, [], &forage_text_input/3) %>\ """ {key, :float} -> """ <%= forage_form_group(f, #{inspect(key)}, #{i18n_label_for(context, key)}, [], &forage_text_input/3) %>\ """ {key, :decimal} -> """ <%= forage_form_group(f, #{inspect(key)}, #{i18n_label_for(context, key)}, [], &forage_text_input/3) %>\ """ {key, :boolean} -> """ <%= forage_form_check(f, #{inspect(key)}, #{i18n_label_for(context, key)}, [], &forage_checkbox/3) %>\ """ {key, :text} -> """ <%= forage_form_group(f, #{inspect(key)}, #{i18n_label_for(context, key)}, [], &forage_textarea/3) %>\ """ {key, :date} -> """ <%= forage_form_group(f, #{inspect(key)}, #{i18n_label_for(context, key)}, [], &forage_date_input/3) %>\ """ {key, :time} -> """ <%= forage_form_group(f, #{inspect(key)}, #{i18n_label_for(context, key)}, [], &forage_time_select/3) %>\ """ {key, :utc_datetime} -> """ <%= forage_form_group(f, #{inspect(key)}, #{i18n_label_for(context, key)}, [], &forage_datetime_select/3) %>\ """ {key, :naive_datetime} -> """ <%= forage_form_group(f, #{inspect(key)}, #{i18n_label_for(context, key)}, [], &forage_datetime_select/3) %>\ """ {key, {:array, :integer}} -> """ <%= forage_form_group(f, #{inspect(key)}, #{i18n_label_for(context, key)}, [], fn form, field, _opts -> multiple_select(form, field, ["1": 1, "2": 2], class: "form-control") end) %>\ """ {key, {:array, _}} -> """ <%= forage_form_group(f, #{inspect(key)}, #{i18n_label_for(context, key)}, [], fn form, field, _opts -> multiple_select(&1, &2, ["Option 1": "option1", "Option 2": "option2"], class: "form-control") end) %>\ """ {key, _} -> """ <%= forage_form_group(f, #{inspect(key)}, #{i18n_label_for(context, key)}, [], &forage_text_input/3) %>\ """ end) assocs = Enum.map(schema.assocs, fn {key, atom_singular_id, _full_module_name, _atom_plural} -> path = "Routes.#{context.basename}_#{atom_singular_id}_path(@conn, :select)" """ <%= forage_form_group(f, :#{atom_singular_id}, #{i18n_label_for(context, key)}, [], fn form, field, opts -> forage_select(form, field, #{path}, opts) end) %>\ """ end) attrs ++ assocs end defp filters(%Context{schema: schema} = context) do simple_filters = Enum.map(schema.attrs, fn {key, field_type} -> type = case field_type do {:references, _} -> nil :integer -> :numeric :float -> :numeric :decimal -> :numeric :boolean -> nil :text -> :text :string -> :text :date -> :date :time -> :time :utc_datetime -> :numeric :naive_datetime -> :numeric _ -> nil end case type do nil -> "" :numeric -> """ <%= forage_horizontal_form_group(f, #{inspect(key)}, #{i18n_label_for(context, key)}, [], &forage_numeric_filter/3) %>\ """ :date -> """ <%= forage_horizontal_form_group(f, #{inspect(key)}, #{i18n_label_for(context, key)}, [], &forage_date_filter/3) %>\ """ :text -> """ <%= forage_horizontal_form_group(f, #{inspect(key)}, #{i18n_label_for(context, key)}, [], &forage_text_filter/3) %>\ """ end end) assoc_filters = Enum.map(schema.assocs, fn {key, atom_singular_id, _full_module_name, _atom_plural} -> path = "Routes.#{context.basename}_#{atom_singular_id}_path(@conn, :select)" """ <%= forage_horizontal_form_group(f, #{inspect(key)}, #{i18n_label_for(context, key)}, [], fn form, field, opts -> forage_select_filter(form, field, #{path}, opts) end) %>\ """ end) simple_filters ++ assoc_filters end end