refactor: fix all Credo code readability and refactoring issues

- Remove parentheses from all zero-arity function definitions (33 functions)
- Fix documentation typos (Cofnig -> Config)
- Split long comment line in admin/request.ex
- Refactor Enum.map + Enum.join to more efficient Enum.map_join
- Reduce Credo issues from 36 to 4 (1 warning, 2 design suggestions, 1 complexity)

Author: GSMLG-BOT

lib/caddy.ex

@@ -24,14 +24,14 @@ defmodule Caddy do
   Set `caddy_bin` to the path of Caddy binary file and start `Caddy.Server`.
 
   ```
-  Caddy.Cofnig.set_bin("/usr/bin/caddy")
+  Caddy.Config.set_bin("/usr/bin/caddy")
   Caddy.restart_server()
   ```
 
   This will restart server automatically
 
   ```
-  Caddy.Cofnig.set_bin!("/usr/bin/caddy")
+  Caddy.Config.set_bin!("/usr/bin/caddy")
   ```
 
   ## Config
@@ -56,7 +56,7 @@ defmodule Caddy do
   @doc """
   Restart Caddy Server
   """
-  def restart_server() do
+  def restart_server do
     case Supervisor.restart_child(__MODULE__, Caddy.Server) do
       {:error, :running} ->
         Supervisor.terminate_child(__MODULE__, Caddy.Server)
@@ -76,8 +76,8 @@ defmodule Caddy do
   @spec start(binary()) :: :ignore | {:error, any()} | {:ok, pid()}
   def start(caddy_bin), do: start_link(caddy_bin: caddy_bin)
 
-  @spec start() :: :ignore | {:error, any()} | {:ok, pid()}
-  def start() do
+  @spec start :: :ignore | {:error, any()} | {:ok, pid()}
+  def start do
     caddy_bin = System.find_executable("caddy")
     start_link(caddy_bin: caddy_bin)
   end
@@ -115,6 +115,6 @@ defmodule Caddy do
   defdelegate set_global(global), to: Caddy.ConfigProvider
   defdelegate set_additional(additionals), to: Caddy.ConfigProvider
   defdelegate set_site(name, site), to: Caddy.ConfigProvider
-  defdelegate backup_config(), to: Caddy.ConfigProvider
-  defdelegate restore_config(), to: Caddy.ConfigProvider
+  defdelegate backup_config, to: Caddy.ConfigProvider
+  defdelegate restore_config, to: Caddy.ConfigProvider
 end

lib/caddy/admin.ex

@@ -22,7 +22,7 @@ defmodule Caddy.Admin do
     {:noreply, state}
   end
 
-  defp check_caddy_server() do
+  defp check_caddy_server do
     %{"listen" => "unix/" <> _} = Caddy.Admin.Api.get_config("admin")
   rescue
     error ->

lib/caddy/admin/api.ex

@@ -23,7 +23,7 @@ defmodule Caddy.Admin.Api do
   GET /reverse_proxy/upstreams Returns the current status of the configured proxy upstreams
   ```
   """
-  def api(), do: nil
+  def api, do: nil
 
   @doc """
   Get info from caddy server
@@ -96,7 +96,7 @@ defmodule Caddy.Admin.Api do
   @doc """
   Stops the active configuration and exits the process
   """
-  def stop() do
+  def stop do
     start_time = System.monotonic_time()
 
     case request_module().post("/stop", "", "application/json") do
@@ -140,7 +140,7 @@ defmodule Caddy.Admin.Api do
     end
   end
 
-  def get_config() do
+  def get_config do
     start_time = System.monotonic_time()
 
     case request_module().get("/config/") do
@@ -372,7 +372,7 @@ defmodule Caddy.Admin.Api do
     end
   end
 
-  def delete_config() do
+  def delete_config do
     start_time = System.monotonic_time()
 
     case request_module().delete("/config/") do
@@ -432,7 +432,7 @@ defmodule Caddy.Admin.Api do
   Check server health status
   """
   @spec health_check() :: {:ok, map()} | {:error, binary()}
-  def health_check() do
+  def health_check do
     start_time = System.monotonic_time()
 
     case request_module().get("/config/") do
@@ -469,7 +469,7 @@ defmodule Caddy.Admin.Api do
   Get detailed server info including version and uptime
   """
   @spec server_info() :: {:ok, map()} | {:error, binary()}
-  def server_info() do
+  def server_info do
     start_time = System.monotonic_time()
 
     case request_module().get("/") do

lib/caddy/admin/request.ex

@@ -120,7 +120,7 @@ defmodule Caddy.Admin.Request do
     do_recv(socket)
   end
 
-  defp get_admin_sock() do
+  defp get_admin_sock do
     Application.get_env(:caddy, :config)
     |> get_in(["admin", "listen"])
     |> String.replace(~r/^unix\//, "")
@@ -156,7 +156,8 @@ defmodule Caddy.Admin.Request do
     # Now we only have body left.
     # # Depending on headers here you may want to do different things.
     # # The response might be chunked, or upgraded in case you have attached to the container
-    # # Now I can receive the response. Because of `:active, false} I need to explicitly ask for data, otherwise it gets send to the process as messages.
+    # # Now I can receive the response. Because of `:active, false} I need to explicitly
+    # # ask for data, otherwise it gets send to the process as messages.
     case :proplists.get_value(:"Content-Type", resp.headers) do
       "application/json" -> {:ok, resp, Jason.decode!(read_body(socket, resp))}
       _ -> {:ok, resp, read_body(socket, resp)}

lib/caddy/config.ex

@@ -27,65 +27,65 @@ defmodule Caddy.Config do
   defdelegate user_home, to: System
 
   @doc "Get configurable base path for caddy files"
-  def base_path() do
+  def base_path do
     Application.get_env(:caddy, :base_path, Path.join(user_home(), ".local/share/caddy"))
   end
 
   @doc "Get configurable priv path"
-  def priv_path() do
+  def priv_path do
     Application.get_env(:caddy, :priv_path, Application.app_dir(:caddy, "priv"))
   end
 
   @doc "Get share path (base path)"
-  def share_path(), do: base_path()
+  def share_path, do: base_path()
 
   @doc "Get etc path for configuration files"
-  def etc_path() do
+  def etc_path do
     Application.get_env(:caddy, :etc_path, Path.join(base_path(), "etc"))
   end
 
   @doc "Get run path for runtime files"
-  def run_path() do
+  def run_path do
     Application.get_env(:caddy, :run_path, Path.join(base_path(), "run"))
   end
 
   @doc "Get tmp path for temporary files"
-  def tmp_path() do
+  def tmp_path do
     Application.get_env(:caddy, :tmp_path, Path.join(base_path(), "tmp"))
   end
 
   @doc "Get XDG config home path"
-  def xdg_config_home() do
+  def xdg_config_home do
     Application.get_env(:caddy, :xdg_config_home, Path.join(base_path(), "config"))
   end
 
   @doc "Get XDG data home path"
-  def xdg_data_home() do
+  def xdg_data_home do
     Application.get_env(:caddy, :xdg_data_home, Path.join(base_path(), "data"))
   end
 
   @doc "Get environment file path"
-  def env_file() do
+  def env_file do
     Application.get_env(:caddy, :env_file, Path.join(etc_path(), "envfile"))
   end
 
   @doc "Get init configuration file path"
-  def init_file() do
+  def init_file do
     Application.get_env(:caddy, :init_file, Path.join(etc_path(), "init.json"))
   end
 
   @doc "Get PID file path"
-  def pid_file() do
+  def pid_file do
     Application.get_env(:caddy, :pid_file, Path.join(run_path(), "caddy.pid"))
   end
 
   @doc "Get socket file path"
-  def socket_file() do
+  def socket_file do
     Application.get_env(:caddy, :socket_file, Path.join(run_path(), "caddy.sock"))
   end
 
   @doc "Get saved JSON configuration file path"
-  def saved_json_file() do
+  def saved_json_file do
     Application.get_env(
       :caddy,
       :saved_json_file,
@@ -94,10 +94,10 @@ defmodule Caddy.Config do
   end
 
   @doc false
-  def paths(), do: [priv_path(), share_path(), etc_path(), run_path(), tmp_path()]
+  def paths, do: [priv_path(), share_path(), etc_path(), run_path(), tmp_path()]
 
   @doc false
-  def ensure_path_exists() do
+  def ensure_path_exists do
     paths()
     |> Enum.reduce_while(true, fn path, _acc ->
       case File.mkdir_p(path) do
@@ -214,7 +214,7 @@ defmodule Caddy.Config do
 
   @doc "Get backup file path"
   @spec backup_json_file() :: Path.t()
-  def backup_json_file() do
+  def backup_json_file do
     Application.get_env(
       :caddy,
       :backup_json_file,
@@ -232,7 +232,7 @@ defmodule Caddy.Config do
 
     #{Enum.join(additional, "\n\n")}
 
-    #{Enum.map(sites, fn
+    #{Enum.map_join(sites, "\n\n", fn
       {name, site} when is_binary(site) -> """
         ## #{name}
         #{name} {
@@ -246,7 +246,7 @@ defmodule Caddy.Config do
         }
         """
       _ -> ""
-    end) |> Enum.join("\n\n")}
+    end)}
     """
   end
 
@@ -427,7 +427,7 @@ defmodule Caddy.Config do
   end
 
   @doc false
-  def init_env() do
+  def init_env do
     [
       {"HOME", share_path()},
       {"XDG_CONFIG_HOME", xdg_config_home()},

lib/caddy/config_provider.ex

@@ -41,7 +41,7 @@ defmodule Caddy.ConfigProvider do
 
   @doc "Get current configuration"
   @spec get_config() :: Config.t()
-  def get_config() do
+  def get_config do
     start_time = System.monotonic_time()
     config = Agent.get(__MODULE__, & &1)
     duration = System.monotonic_time() - start_time
@@ -109,7 +109,7 @@ defmodule Caddy.ConfigProvider do
 
   @doc "Backup current configuration"
   @spec backup_config() :: :ok | {:error, term()}
-  def backup_config() do
+  def backup_config do
     config = get_config()
     backup_file = Config.backup_json_file()
     start_time = System.monotonic_time()
@@ -140,7 +140,7 @@ defmodule Caddy.ConfigProvider do
 
   @doc "Restore configuration from backup"
   @spec restore_config() :: {:ok, Config.t()} | {:error, term()}
-  def restore_config() do
+  def restore_config do
     backup_file = Config.backup_json_file()
     start_time = System.monotonic_time()
 
@@ -171,7 +171,7 @@ defmodule Caddy.ConfigProvider do
 
   @doc "Save current configuration"
   @spec save_config() :: :ok | {:error, term()}
-  def save_config() do
+  def save_config do
     config = get_config()
     start_time = System.monotonic_time()
 

lib/caddy/server.ex

@@ -102,11 +102,11 @@ defmodule Caddy.Server do
   Get Caddyfile content of the current running server
   """
   @spec get_caddyfile() :: binary()
-  def get_caddyfile() do
+  def get_caddyfile do
     Path.expand("Caddyfile", Config.etc_path()) |> File.read!()
   end
 
-  defp bootstrap() do
+  defp bootstrap do
     Logger.debug("Caddy Server bootstrap")
     start_time = System.monotonic_time()
 
@@ -216,7 +216,7 @@ defmodule Caddy.Server do
     end
   end
 
-  defp cleanup_pidfile() do
+  defp cleanup_pidfile do
     pidfile = Config.pid_file()
 
     if pidfile |> File.exists?() do

lib/caddy/telemetry.ex

@@ -101,7 +101,7 @@ defmodule Caddy.Telemetry do
   Returns list of all Caddy telemetry events.
   """
   @spec list_events() :: list()
-  def list_events() do
+  def list_events do
     [
       [:caddy, :config, :set],
       [:caddy, :config, :get],