[gh315] Support Phoenix 1.7.x

.github/wiki/Generation.md

@@ -11,7 +11,7 @@
 5. Edit `mix.exs` file and add this line to the dependencies.
 
 ```elixir
-{:nimble_template, "~> 3.0", path: "~/elixir-templates", only: :dev, runtime: false}
+{:nimble_template, "~> 4.7", path: "~/elixir-templates", only: :dev, runtime: false}
 ```
 
 Modify the path to locate the `elixir-templates` directory. For example `~/elixir-templates` if inside the home directory.
@@ -36,7 +36,7 @@ Modify the path to locate the `elixir-templates` directory. For example `~/elixi
 
 - Web project: `make create_phoenix_project PROJECT_DIRECTORY=sample_project OPTIONS="--no-live"`
 - Live project: `make create_phoenix_project PROJECT_DIRECTORY=sample_project OPTIONS=""`
-- API project: `make create_phoenix_project PROJECT_DIRECTORY=sample_project OPTIONS="--no-html --no-assets --no-live"`
+- API project: `make create_phoenix_project PROJECT_DIRECTORY=sample_project OPTIONS="--no-html --no-assets"`
 
 3. Answer the prompt `Fetch and install dependencies? [Yn]` with `n` (not install)
 

.github/wiki/Testing.md

@@ -83,7 +83,7 @@ mix phx.new awesome_project
 - API variants do NOT support HTML and Assets configuration.
 
 ```bash
-mix phx.new awesome_project --no-html --no-assets --no-live
+mix phx.new awesome_project --no-html --no-assets
 ```
 
 - Custom project variants allow us to modify the app name or module name.
@@ -108,8 +108,8 @@ Web project
 
 API project
 
-- Standard (`mix phx.new awesome_project --no-html --no-assets --no-live`)
-- Custom (`mix phx.new awesome_project --no-html --no-assets --no-live --module=CustomModuleName --app=custom_otp_app_name`)
+- Standard (`mix phx.new awesome_project --no-html --no-assets`)
+- Custom (`mix phx.new awesome_project --no-html --no-assets --module=CustomModuleName --app=custom_otp_app_name`)
 
 LiveView project
 

.github/workflows/apply_api_variant.yml

@@ -7,14 +7,14 @@ jobs:
     name: Test on a Standard API project
     uses: ./.github/workflows/reusable_phoenix_project.yml
     with:
-      new_project_options: "--no-html --no-assets --no-live"
+      new_project_options: "--no-html --no-assets"
       variant: "api"
 
   long_custom_name_api_project:
     name: Test on a long custom name API project
     uses: ./.github/workflows/reusable_phoenix_project.yml
     with:
-      new_project_options: "--no-html --no-assets --no-live --module=SampleCustomModule --app=sample_custom_app"
+      new_project_options: "--no-html --no-assets --module=SampleCustomModule --app=sample_custom_app"
       variant: "api"
 
   short_custom_name_api_project:

.github/workflows/bump_version.yml

@@ -9,7 +9,7 @@ on:
         type: string
 
 env:
-  PHOENIX_VERSION: 1.6.11
+  PHOENIX_VERSION: 1.7.1
   MIX_ENV: test
 
 jobs:

.github/workflows/reusable_phoenix_project.yml

@@ -11,7 +11,7 @@ on:
         type: string
 
 env:
-  PHOENIX_VERSION: 1.6.11
+  PHOENIX_VERSION: 1.7.1
   BASE_PROJECT_DIRECTORY: sample_project
   DB_HOST: localhost
   MIX_ENV: dev

.github/workflows/test_template.yml

@@ -3,7 +3,7 @@ name: Test template
 on: push
 
 env:
-  PHOENIX_VERSION: 1.6.11
+  PHOENIX_VERSION: 1.7.1
   MIX_ENV: test
 
 jobs:

.github/workflows/upgrade_stack.yml

@@ -24,7 +24,7 @@ on:
         type: string
 
 env:
-  PHOENIX_VERSION: 1.6.11
+  PHOENIX_VERSION: 1.7.1
   MIX_ENV: test
 
 jobs:

.github/workflows/verify_release_version.yml

@@ -6,7 +6,7 @@ on:
       - 'release/**'
 
 env:
-  PHOENIX_VERSION: 1.6.11
+  PHOENIX_VERSION: 1.7.1
   MIX_ENV: test
 
 jobs:

.gitignore

@@ -30,3 +30,6 @@ nimble_template-*.tar
 nimble_template.iml
 
 **/tmp
+
+# The sample generated project on local
+sample_project/

README.md

@@ -9,7 +9,7 @@ NimbleTemplate has been developed and actively tested with the below environment
 - Mix 1.13.3
 - Elixir 1.14.0
 - Erlang/OTP 25.0.4
-- Phoenix 1.6.11
+- Phoenix 1.7.1
 - Node 16.15.0
 
 ## Installation

lib/nimble_template/addons/variants/phoenix/api/config.ex

@@ -8,32 +8,16 @@ defmodule NimbleTemplate.Addons.Phoenix.Api.Config do
     edit_files!(project)
   end
 
-  def edit_config_prod!(%Project{otp_app: otp_app, web_module: web_module} = project) do
+  def edit_config_prod!(%Project{} = project) do
     Generator.delete_content!(
       "config/prod.exs",
       """
       # For production, don't forget to configure the url host
       # to something meaningful, Phoenix uses this information
       # when generating URLs.
-      #
-      # Note we also include the path to a cache manifest
-      # containing the digested version of static files. This
-      # manifest is generated by the `mix phx.digest` task,
-      # which you should run after static files are built and
-      # before starting your production server.
       """
     )
 
-    Generator.delete_content!(
-      "config/prod.exs",
-      "config :#{otp_app}, #{web_module}.Endpoint,"
-    )
-
-    Generator.delete_content!(
-      "config/prod.exs",
-      "cache_static_manifest: \"priv/static/cache_manifest.json\""
-    )
-
     project
   end
 

lib/nimble_template/addons/variants/phoenix/api/empty_body_params_plug.ex

@@ -5,50 +5,56 @@ defmodule NimbleTemplate.Addons.Phoenix.Api.EmptyBodyParamsPlug do
 
   @impl true
   def do_apply!(%Project{} = project, _opts) do
+    # TODO: Revisit on the next PR
     project
-    |> copy_files!()
-    |> edit_files!()
   end
 
-  defp copy_files!(
-         %Project{
-           web_module: web_module,
-           web_path: web_path,
-           web_test_path: web_test_path
-         } = project
-       ) do
-    binding = [
-      web_module: web_module
-    ]
-
-    files = [
-      {:eex, "lib/otp_app_web/plugs/check_empty_body_params_plug.ex.eex",
-       "#{web_path}/plugs/check_empty_body_params_plug.ex"},
-      {:eex, "test/otp_app_web/plugs/check_empty_body_params_plug_test.exs.eex",
-       "#{web_test_path}/plugs/check_empty_body_params_plug_test.exs"}
-    ]
-
-    Generator.copy_file!(files, binding)
-
-    project
-  end
-
-  defp edit_files!(%Project{web_path: web_path, web_module: web_module} = project) do
-    Generator.replace_content!(
-      "#{web_path}/router.ex",
-      """
-        pipeline :api do
-          plug :accepts, ["json"]
-        end
-      """,
-      """
-        pipeline :api do
-          plug :accepts, ["json"]
-          plug #{web_module}.CheckEmptyBodyParamsPlug
-        end
-      """
-    )
-
-    project
-  end
+  # @impl true
+  # def do_apply!(%Project{} = project, _opts) do
+  #   project
+  #   |> copy_files!()
+  #   |> edit_files!()
+  # end
+
+  # defp copy_files!(
+  #        %Project{
+  #          web_module: web_module,
+  #          web_path: web_path,
+  #          web_test_path: web_test_path
+  #        } = project
+  #      ) do
+  #   binding = [
+  #     web_module: web_module
+  #   ]
+
+  #   files = [
+  #     {:eex, "lib/otp_app_web/plugs/check_empty_body_params_plug.ex.eex",
+  #      "#{web_path}/plugs/check_empty_body_params_plug.ex"},
+  #     {:eex, "test/otp_app_web/plugs/check_empty_body_params_plug_test.exs.eex",
+  #      "#{web_test_path}/plugs/check_empty_body_params_plug_test.exs"}
+  #   ]
+
+  #   Generator.copy_file!(files, binding)
+
+  #   project
+  # end
+
+  # defp edit_files!(%Project{web_path: web_path, web_module: web_module} = project) do
+  #   Generator.replace_content!(
+  #     "#{web_path}/router.ex",
+  #     """
+  #       pipeline :api do
+  #         plug :accepts, ["json"]
+  #       end
+  #     """,
+  #     """
+  #       pipeline :api do
+  #         plug :accepts, ["json"]
+  #         plug #{web_module}.CheckEmptyBodyParamsPlug
+  #       end
+  #     """
+  #   )
+
+  #   project
+  # end
 end

lib/nimble_template/addons/variants/phoenix/api/error_json.ex

@@ -0,0 +1,44 @@
+defmodule NimbleTemplate.Addons.Phoenix.Api.ErrorJSON do
+  @moduledoc false
+
+  use NimbleTemplate.Addons.Addon
+
+  @impl true
+  def do_apply!(%Project{} = project, _opts) do
+    project
+    |> delete_files!()
+    |> copy_files!()
+  end
+
+  defp delete_files!(%Project{web_path: web_path, web_test_path: web_test_path} = project) do
+    File.rm!("#{web_path}/controllers/error_json.ex")
+    File.rm!("#{web_test_path}/controllers/error_json_test.exs")
+
+    project
+  end
+
+  defp copy_files!(
+         %Project{
+           base_module: base_module,
+           web_module: web_module,
+           web_path: web_path,
+           web_test_path: web_test_path
+         } = project
+       ) do
+    binding = [
+      web_module: web_module,
+      base_module: base_module
+    ]
+
+    files = [
+      {:eex, "lib/otp_app_web/controllers/error_json.ex.eex",
+       "#{web_path}/controllers/error_json.ex"},
+      {:eex, "test/otp_app_web/controllers/error_json_test.exs.eex",
+       "#{web_test_path}/controllers/error_json_test.exs"}
+    ]
+
+    Generator.copy_file!(files, binding)
+
+    project
+  end
+end

lib/nimble_template/addons/variants/phoenix/api/fallback_controller.ex

@@ -31,24 +31,26 @@ defmodule NimbleTemplate.Addons.Phoenix.Api.FallbackController do
       """
         def controller do
           quote do
-            use Phoenix.Controller, namespace: #{web_module}
+            use Phoenix.Controller,
+              formats: [:html, :json],
+              layouts: [html: #{web_module}.Layouts]
 
             import Plug.Conn
             import #{web_module}.Gettext
 
             alias #{web_module}.ParamsValidator
-            alias #{web_module}.Router.Helpers, as: Routes
       """,
       """
         def controller do
           quote do
-            use Phoenix.Controller, namespace: #{web_module}
+            use Phoenix.Controller,
+              formats: [:html, :json],
+              layouts: [html: #{web_module}.Layouts]
 
             import Plug.Conn
             import #{web_module}.Gettext
 
             alias #{web_module}.ParamsValidator
-            alias #{web_module}.Router.Helpers, as: Routes
 
             action_fallback #{web_module}.Api.FallbackController
       """