Merge pull request #310 from nimblehq/release/4.6.0

Release - 4.6.0

.github/CODEOWNERS

@@ -1,8 +1,5 @@
-# Team Lead
-* @byhbt
-
 # Team Members
-* @andyduong1920 @bterone @hanam1ni @longnd @rosle @topnimble @Nihisil @nvminhtue @liamstevens111
+* @byhbt @andyduong1920 @bterone @hanam1ni @longnd @rosle @topnimble @Nihisil @nvminhtue @liamstevens111
 
 # Engineering Leads
 CODEOWNERS @nimblehq/engineering-leads

.github/wiki/Contribution.md

@@ -18,25 +18,25 @@ defmodule NimbleTemplate.Addons.Phoenix.Web.SampleAddon do
   use NimbleTemplate.Addons.Addon
 
   @impl true
-  def do_apply(%Project{} = project, opts) do
+  def do_apply!(%Project{} = project, opts) do
     project
   end
 end
 ```
 
-The module should implement `do_apply` callbacks of a behaviour.
+The module should implement `do_apply!` callbacks of a behaviour.
 
 With a new corresponding test file at `test/nimble_template/addons/variants/phoenix/web/addon_test.exs`.
 
-Then call `NimbleTemplate.Addons.Phoenix.Web.SampleAddon.apply(project)` inside `lib/nimble_template/templates/variants/phoenix/web/template.ex` file which will be executed on Terminal prompt.
+Then call `NimbleTemplate.Addons.Phoenix.Web.SampleAddon.apply!(project)` inside `lib/nimble_template/templates/variants/phoenix/web/template.ex` file which will be executed on Terminal prompt.
 
 ## Functions
 
 These are functions from `NimbleTemplate.Generator` which can be called.
 
 ---
 
-`copy_directory(source_path, target_path, binding \\ [])`
+`copy_directory!(source_path, target_path, binding \\ [])`
 
 Copy a directory and its content from source path to target path.
 
@@ -48,12 +48,12 @@ Copy a directory and its content from source path to target path.
 
 Example
 ```elixir
-Generator.copy_directory("assets/nimble_js", "assets/js")
+Generator.copy_directory!("assets/nimble_js", "assets/js")
 ```
 
 ---
 
-`copy_file(files, binding \\ [])`
+`copy_file!(files, binding \\ [])`
 
 Copy a list of files from source path to target path.
 
@@ -64,15 +64,15 @@ Copy a list of files from source path to target path.
 
 Example
 ```elixir
-Generator.copy_file([
+Generator.copy_file!([
   {:eex, "bin/start.sh.eex", "bin/start.sh"},
   {:text, "assets/bootstrap_css/vendor/_bootstrap.scss", "assets/css/vendor/_bootstrap.scss"}
 ])
 ```
 
 ---
 
-`rename_file(old_path, new_path)`
+`rename_file!(old_path, new_path)`
 
 Rename a file from old path to new path.
 
@@ -83,12 +83,12 @@ Rename a file from old path to new path.
 
 Example
 ```elixir
-Generator.rename_file("assets/css/app.css", "assets/css/app.scss")
+Generator.rename_file!("assets/css/app.css", "assets/css/app.scss")
 ```
 
 ---
 
-`replace_content(file_path, anchor, content)`
+`replace_content!(file_path, anchor, content)`
 
 Find and replace specified content of an existing file.
 
@@ -100,7 +100,7 @@ Find and replace specified content of an existing file.
 
 Example
 ```elixir
-Generator.replace_content(
+Generator.replace_content!(
   "test/test_helper.exs",
   """
   ExUnit.start()
@@ -113,7 +113,7 @@ Generator.replace_content(
 
 ---
 
-`delete_content(file_path, anchor)`
+`delete_content!(file_path, anchor)`
 
 Find and remove specified content of an existing file.
 
@@ -124,7 +124,7 @@ Find and remove specified content of an existing file.
 
 Example
 ```elixir
-Generator.delete_content(
+Generator.delete_content!(
   "assets/js/app.js",
   """
   // We import the CSS which is extracted to its own file by esbuild.
@@ -137,7 +137,7 @@ Generator.delete_content(
 
 ---
 
-`inject_content(file_path, anchor, content)`
+`inject_content!(file_path, anchor, content)`
 
 Inject a specified content below a specified content of an existing file.
 
@@ -149,7 +149,7 @@ Inject a specified content below a specified content of an existing file.
 
 Example
 ```elixir
-Generator.inject_content(
+Generator.inject_content!(
   support_case_path,
   """
     use ExUnit.CaseTemplate
@@ -163,7 +163,7 @@ Generator.inject_content(
 
 ---
 
-`append_content(file_path, content)`
+`append_content!(file_path, content)`
 
 Append a specified content to the end of an existing file.
 
@@ -174,7 +174,7 @@ Append a specified content to the end of an existing file.
 
 Example
 ```elixir
-Generator.append_content(
+Generator.append_content!(
   "assets/css/_variables.scss",
   """
   Content
@@ -184,7 +184,7 @@ Generator.append_content(
 
 ---
 
-`inject_mix_dependency(dependency)`
+`inject_mix_dependency!(dependency)`
 
 Inject a new mix dependency into `mix.exs` file.
 
@@ -196,14 +196,14 @@ Inject a new mix dependency into `mix.exs` file.
 
 Example
 ```elixir
-Generator.inject_mix_dependency(
+Generator.inject_mix_dependency!(
   {:credo, latest_package_version(:credo), only: [:dev, :test], runtime: false}
 )
 ```
 
 ---
 
-`make_directory(path, touch_directory \\ true)`
+`make_directory!(path, touch_directory \\ true)`
 
 Create a new directory.
 
@@ -214,12 +214,12 @@ Create a new directory.
 
 Example
 ```elixir
-Generator.make_directory("assets/css/vendor/", false)
+Generator.make_directory!("assets/css/vendor/", false)
 ```
 
 ---
 
-`create_file(path, content)`
+`create_file!(path, content)`
 
 Create a new file with specified content.
 
@@ -230,7 +230,7 @@ Create a new file with specified content.
 
 Example
 ```elixir
-Generator.create_file(
+Generator.create_file!(
   "assets/css/_variables.scss",
   """
   Content

.github/workflows/reusable_mix_project.yml

@@ -9,7 +9,7 @@ on:
 
 env:
   BASE_PROJECT_DIRECTORY: sample_project
-  MIX_ENV: test
+  MIX_ENV: dev
 
 jobs:
   unit_test:
@@ -62,6 +62,10 @@ jobs:
 
       - name: Run mix codebase
         run: cd $BASE_PROJECT_DIRECTORY && mix codebase
+        env:
+          MIX_ENV: test
 
       - name: Run mix test
         run: cd $BASE_PROJECT_DIRECTORY && mix test
+        env:
+          MIX_ENV: test

.github/workflows/reusable_phoenix_project.yml

@@ -14,6 +14,7 @@ env:
   PHOENIX_VERSION: 1.6.11
   BASE_PROJECT_DIRECTORY: sample_project
   DB_HOST: localhost
+  MIX_ENV: dev
 
 jobs:
   unit_test:
@@ -94,9 +95,13 @@ jobs:
 
       - name: Run mix codebase
         run: cd $BASE_PROJECT_DIRECTORY && mix codebase
+        env:
+          MIX_ENV: test
 
       - name: Run mix test
         run: cd $BASE_PROJECT_DIRECTORY && mix coverage
+        env:
+          MIX_ENV: test
 
       - name: Remove nimble_template dependency
         run: make remove_nimble_template PROJECT_DIRECTORY=$BASE_PROJECT_DIRECTORY

README.md

@@ -31,7 +31,7 @@ Step 2: Add `nimble_template` dependency to `mix.exs`:
 ```elixir
 def deps do
   [
-    {:nimble_template, "~> 4.5.0", only: :dev, runtime: false},
+    {:nimble_template, "~> 4.6.0", only: :dev, runtime: false},
     # other dependencies ...
   ]
 end

config/config.exs

@@ -1,3 +1,9 @@
 import Config
 
 config :phoenix, :json_library, Jason
+
+config :nimble_template, hex_package_resource: NimbleTemplate.Hex.Package
+
+if File.exists?("config/#{config_env()}.exs") do
+  import_config "#{config_env()}.exs"
+end

config/test.exs

@@ -0,0 +1,3 @@
+import Config
+
+config :nimble_template, hex_package_resource: NimbleTemplate.Hex.PackageMock

lib/mix/tasks/nimble_template.bump_version.ex

@@ -20,7 +20,7 @@ defmodule Mix.Tasks.NimbleTemplate.BumpVersion do
   def run(args) do
     new_version = parse_opts(args)
 
-    Version.bump(new_version)
+    Version.bump!(new_version)
   end
 
   defp parse_opts(args) do

lib/mix/tasks/nimble_template.gen.ex

@@ -42,7 +42,9 @@ defmodule Mix.Tasks.NimbleTemplate.Gen do
 
     {:ok, _} = Application.ensure_all_started(:httpoison)
 
-    Template.apply(Project.new(opts))
+    opts
+    |> Project.new()
+    |> Template.apply!()
   end
 
   defp parse_opts(args) do

lib/mix/tasks/nimble_template.upgrade_stack.ex

@@ -24,7 +24,7 @@ defmodule Mix.Tasks.NimbleTemplate.UpgradeStack do
   def run(args) do
     stack_versions = parse_opts(args)
 
-    Version.upgrade_stack(stack_versions)
+    Version.upgrade_stack!(stack_versions)
   end
 
   defp parse_opts(args) do

lib/nimble_template/addons/addon.ex

@@ -4,8 +4,8 @@ defmodule NimbleTemplate.Addons.Addon do
   alias __MODULE__
   alias NimbleTemplate.Projects.Project
 
-  @callback apply(%Project{}, %{}) :: %Project{}
-  @callback do_apply(%Project{}, %{}) :: %Project{}
+  @callback apply!(%Project{}, %{}) :: %Project{}
+  @callback do_apply!(%Project{}, %{}) :: %Project{}
 
   defmacro __using__(opts) do
     quote location: :keep, bind_quoted: [opts: opts] do
@@ -18,21 +18,22 @@ defmodule NimbleTemplate.Addons.Addon do
       alias NimbleTemplate.Projects.Project
       alias NimbleTemplate.ProjectHelper
 
-      def apply(%Project{} = project, opts \\ %{}) when is_map(opts) do
+      def apply!(%Project{} = project, opts \\ %{}) when is_map(opts) do
         Generator.info_log("* applying ", inspect(__MODULE__))
 
-        project
-        |> do_apply(opts)
-        |> ProjectHelper.append_installed_addon(__MODULE__)
+        do_apply!(project, opts)
       end
 
-      def do_apply(%Project{} = project, opts) when is_map(opts), do: project
+      def do_apply!(%Project{} = project, opts) when is_map(opts), do: project
 
-      defp latest_package_version(package) do
-        "~> " <> Package.get_latest_version(package)
-      end
+      defp latest_package_version(package),
+        do: "~> " <> hex_package_resource().get_latest_version(package)
+
+      # TODO: `Application.get_env(:nimble_template, :hex_package_resource)` returns nil on runtime, temporary fix by fallback to `Package`
+      defp hex_package_resource,
+        do: Application.get_env(:nimble_template, :hex_package_resource, Package)
 
-      defoverridable do_apply: 2
+      defoverridable do_apply!: 2
     end
   end
 end

lib/nimble_template/addons/asdf_tool_version.ex

@@ -4,7 +4,7 @@ defmodule NimbleTemplate.Addons.AsdfToolVersion do
   use NimbleTemplate.Addons.Addon
 
   @impl true
-  def do_apply(
+  def do_apply!(
         %Project{
           erlang_version: erlang_version,
           elixir_asdf_version: elixir_asdf_version,
@@ -13,13 +13,13 @@ defmodule NimbleTemplate.Addons.AsdfToolVersion do
         } = project,
         _opts
       ) do
-    Generator.copy_file([{:eex, ".tool-versions.eex", ".tool-versions"}],
+    Generator.copy_file!([{:eex, ".tool-versions.eex", ".tool-versions"}],
       erlang_version: erlang_version,
       elixir_asdf_version: elixir_asdf_version
     )
 
     if web_project? do
-      Generator.append_content(
+      Generator.append_content!(
         ".tool-versions",
         """
         nodejs #{node_asdf_version}