feat(elixir/phoenix): update phoenix to 1.7 (#8004)

Author: cgarvis

frameworks/Elixir/phoenix/lib/hello_web.ex

@@ -1,65 +1,104 @@
 defmodule HelloWeb do
   @moduledoc """
-  A module that keeps using definitions for controllers,
-  views and so on.
+  The entrypoint for defining your web interface, such
+  as controllers, views, channels and so on.
 
   This can be used in your application as:
 
       use HelloWeb, :controller
-      use HelloWeb, :view
+      use HelloWeb, :html
 
-  The definitions below will be executed for every view,
-  controller, etc, so keep them short and clean, focused
+  The definitions below will be executed for every controller,
+  component, etc, so keep them short and clean, focused
   on imports, uses and aliases.
 
   Do NOT define functions inside the quoted expressions
-  below. Instead, define any helper function in modules
-  and import those modules here.
+  below. Instead, define additional modules and import
+  those modules here.
   """
 
+  def static_paths,
+    do: ~w(assets favicon.svg apple-touch-icon.png robots.txt font-files mask-icon.svg)
+
   def controller do
     quote do
-      use Phoenix.Controller, namespace: HelloWeb, log: false
+      use Phoenix.Controller,
+        namespace: HelloWeb,
+        formats: [:html, :json],
+        layouts: [html: HelloWeb.Layouts],
+        log: false
+
+      import Plug.Conn
+      import HelloWeb.Gettext
+
+      unquote(verified_routes())
+    end
+  end
+
+  def component do
+    quote do
+      use Phoenix.Component
 
-      # Alias the data repository and import query/model functions
-      alias Hello.Repo
-      import Ecto
-      import Ecto.Query
+      import HelloWeb.Gettext
 
-      # Import URL helpers from the router
-      import HelloWeb.Router.Helpers
+      # Routes generation with the ~p sigil
+      unquote(verified_routes())
     end
   end
 
-  def view do
+  def html do
     quote do
-      use Phoenix.View,
-        root: "lib/hello_web/templates",
-        namespace: HelloWeb
+      use Phoenix.Component
+
+      # Import convenience functions from controllers
+      import Phoenix.Controller,
+        only: [get_csrf_token: 0, view_module: 1, view_template: 1]
 
-      alias HelloWeb.Router.Helpers, as: Routes
+      # Include general helpers for rendering HTML
+      unquote(html_helpers())
+    end
+  end
+
+  defp html_helpers do
+    quote do
+      # Use all HTML functionality (forms, tags, etc)
+      use Phoenix.HTML
+      # Core UI Components and translation
+      import HelloWeb.Gettext
+
+      # Routes generation with the ~p sigil
+      unquote(verified_routes())
+    end
+  end
+
+  def verified_routes do
+    quote do
+      use Phoenix.VerifiedRoutes,
+        endpoint: HelloWeb.Endpoint,
+        router: HelloWeb.Router,
+        statics: HelloWeb.static_paths()
     end
   end
 
   def router do
     quote do
-      use Phoenix.Router
+      use Phoenix.Router, helpers: false
+
+      # Import common connection and controller functions to use in pipelines
+      import Plug.Conn
+      import Phoenix.Controller
     end
   end
 
   def channel do
     quote do
       use Phoenix.Channel
-      # Alias the data repository and import query/model functions
-      alias Hello.Repo
-      import Ecto
-      import Ecto.Query
     end
   end
 
   @doc """
-  When used, dispatch to the appropriate controller/view/etc.
-  """
+    When used, dispatch to the appropriate controller/view/etc.
+    """
   defmacro __using__(which) when is_atom(which) do
     apply(__MODULE__, which, [])
   end

frameworks/Elixir/phoenix/lib/hello_web/views/error_view.ex renamed to frameworks/Elixir/phoenix/lib/hello_web/controllers/error_html.ex

@@ -1,5 +1,5 @@
-defmodule HelloWeb.ErrorView do
-  use HelloWeb, :view
+defmodule HelloWeb.ErrorHTML do
+  use HelloWeb, :html
 
   def render("404.html", _assigns) do
     "Page not found - 404"

frameworks/Elixir/phoenix/lib/hello_web/controllers/error_json.ex

@@ -0,0 +1,19 @@
+defmodule HelloWeb.ErrorJSON do
+  @moduledoc """
+  JSON error pages
+  """
+
+  # If you want to customize a particular status code,
+  # you may add your own clauses, such as:
+  #
+  # def render("500.json", _assigns) do
+  #   %{errors: %{detail: "Internal Server Error"}}
+  # end
+
+  # By default, Phoenix returns the status message from
+  # the template name. For example, "404.json" becomes
+  # "Not Found".
+  def render(template, _assigns) do
+    %{errors: %{detail: Phoenix.Controller.status_message_from_template(template)}}
+  end
+end

frameworks/Elixir/phoenix/lib/hello_web/controllers/page_controller.ex

@@ -3,6 +3,7 @@ defmodule HelloWeb.PageController do
 
   use HelloWeb, :controller
 
+  alias Hello.Repo
   alias Hello.Cache
 
   @json "application/json"
@@ -59,7 +60,7 @@ defmodule HelloWeb.PageController do
 
     fortunes = [additional_fortune | Repo.all(Fortune)]
 
-    render(conn, "fortunes.html",
+    render(conn, :fortunes,
       fortunes: Enum.sort(fortunes, fn f1, f2 -> f1.message < f2.message end)
     )
   end

frameworks/Elixir/phoenix/lib/hello_web/controllers/page_html.ex

@@ -0,0 +1,9 @@
+defmodule HelloWeb.PageHTML do
+  use HelloWeb, :html
+
+  @moduledoc """
+  Standard Page HTML Helper
+  """
+
+  embed_templates "page_html/*"
+end

frameworks/Elixir/phoenix/lib/hello_web/templates/page/fortunes.html.eex renamed to frameworks/Elixir/phoenix/lib/hello_web/controllers/page_html/fortunes.html.eex

@@ -0,0 +1,24 @@
+defmodule HelloWeb.Gettext do
+  @moduledoc """
+  A module providing Internationalization with a gettext-based API.
+
+  By using [Gettext](https://hexdocs.pm/gettext),
+  your module gains a set of macros for translations, for example:
+
+      import HelloWeb.Gettext
+
+      # Simple translation
+      gettext("Here is the string to translate")
+
+      # Plural translation
+      ngettext("Here is the string to translate",
+               "Here are the strings to translate",
+               3)
+
+      # Domain-based translation
+      dgettext("errors", "Here is the error message to translate")
+
+  See the [Gettext Docs](https://hexdocs.pm/gettext) for detailed usage.
+  """
+  use Gettext, otp_app: :hello
+end

frameworks/Elixir/phoenix/lib/hello_web/gettext.ex

@@ -0,0 +1,7 @@
+defmodule HelloWeb.Layouts do
+  use HelloWeb, :html
+
+  @moduledoc false
+
+  embed_templates "layouts/*"
+end

frameworks/Elixir/phoenix/lib/hello_web/layouts.ex

@@ -1,14 +1,20 @@
 defmodule HelloWeb.Router do
   use HelloWeb, :router
 
+  pipeline :browser do
+    plug :accepts, ~w(html json)
+  end
+
   scope "/", HelloWeb do
-    get("/json", PageController, :_json)
-    get("/db", PageController, :db)
-    get("/queries", PageController, :queries)
-    get("/fortunes", PageController, :fortunes)
-    get("/updates", PageController, :updates)
-    get("/plaintext", PageController, :plaintext)
-    get("/cached-queries", PageController, :cached)
-    get("/", PageController, :index)
+    pipe_through [:browser]
+
+    get "/json", PageController, :_json
+    get "/db", PageController, :db
+    get "/queries", PageController, :queries
+    get "/fortunes", PageController, :fortunes
+    get "/updates", PageController, :updates
+    get "/plaintext", PageController, :plaintext
+    get "/cached-queries", PageController, :cached
+    get "/", PageController, :index
   end
 end