Simplify warnings as errors handling

Author: josevalim

lib/ex_doc/cli.ex

@@ -92,7 +92,7 @@ defmodule ExDoc.CLI do
       quiet? ||
         IO.puts(IO.ANSI.format([:green, "View #{inspect(formatter)} docs at #{inspect(index)}"]))
 
-      if opts[:warnings_as_errors] == true and ExDoc.Utils.warned?() do
+      if opts[:warnings_as_errors] == true and ExDoc.Utils.unset_warned() do
         {:error, %{reason: :warnings_as_errors, formatter: formatter}}
       else
         {:ok, index}

lib/ex_doc/formatter/epub.ex

@@ -12,8 +12,6 @@ defmodule ExDoc.Formatter.EPUB do
   """
   @spec run([ExDoc.ModuleNode.t()], [ExDoc.ModuleNode.t()], ExDoc.Config.t()) :: String.t()
   def run(project_nodes, filtered_modules, config) when is_map(config) do
-    Utils.unset_warned()
-
     config = normalize_config(config)
     File.rm_rf!(config.output)
     File.mkdir_p!(Path.join(config.output, "OEBPS"))

lib/ex_doc/formatter/html.ex

@@ -12,8 +12,6 @@ defmodule ExDoc.Formatter.HTML do
   """
   @spec run([ExDoc.ModuleNode.t()], [ExDoc.ModuleNode.t()], ExDoc.Config.t()) :: String.t()
   def run(project_nodes, filtered_modules, config) when is_map(config) do
-    Utils.unset_warned()
-
     config = normalize_config(config)
     config = %{config | output: Path.expand(config.output)}
 

lib/ex_doc/utils.ex

@@ -5,35 +5,17 @@ defmodule ExDoc.Utils do
   Emits a warning.
   """
   def warn(message, stacktrace_info) do
-    set_warned()
+    :persistent_term.put({__MODULE__, :warned?}, true)
     IO.warn(message, stacktrace_info)
   end
 
   @doc """
-  Stores that a warning has been generated.
-  """
-  def set_warned() do
-    unless warned?() do
-      :persistent_term.put({__MODULE__, :warned?}, true)
-    end
-
-    true
-  end
-
-  @doc """
-  Removes that a warning has been generated.
+  Removes that a warning has been generated and returns its previous value.
   """
   def unset_warned() do
-    if warned?() do
-      :persistent_term.put({__MODULE__, :warned?}, false)
-    end
-  end
-
-  @doc """
-  Returns `true` if any warning has been generated during the document building. Otherwise returns `false`.
-  """
-  def warned?() do
-    :persistent_term.get({__MODULE__, :warned?}, false)
+    warned? = :persistent_term.get({__MODULE__, :warned?}, false)
+    :persistent_term.erase({__MODULE__, :warned?})
+    warned?
   end
 
   @doc """

lib/mix/tasks/docs.ex

@@ -404,7 +404,7 @@ defmodule Mix.Tasks.Docs do
           browser_open(index)
         end
 
-        if options[:warnings_as_errors] == true and ExDoc.Utils.warned?() do
+        if options[:warnings_as_errors] == true and ExDoc.Utils.unset_warned() do
           {:error, %{reason: :warnings_as_errors, formatter: formatter}}
         else
           {:ok, index}

test/ex_doc/formatter/epub_test.exs

@@ -266,7 +266,7 @@ defmodule ExDoc.Formatter.EPUBTest do
         assert output =~ ~S|doc `Warnings.bar/0`|
       end
 
-      assert Utils.warned?() == true
+      assert Utils.unset_warned()
     end
 
     test "warnings are registered even with warnings_as_errors: false", context do
@@ -281,7 +281,7 @@ defmodule ExDoc.Formatter.EPUBTest do
         )
       end)
 
-      assert Utils.warned?() == true
+      assert Utils.unset_warned()
     end
   end
 end

test/ex_doc/formatter/html_test.exs

@@ -158,7 +158,7 @@ defmodule ExDoc.Formatter.HTMLTest do
       assert output =~
                ~r"warning:(\e\[0m)? .*index.html redirects to DoesNotExist.html, which does not exist\n"
 
-      assert Utils.warned?() == true
+      assert Utils.unset_warned()
     end
 
     test "multiple warnings are registered when using warnings_as_errors: true", context do
@@ -182,7 +182,7 @@ defmodule ExDoc.Formatter.HTMLTest do
         assert output =~ ~S|doc `Warnings.bar/0`|
       end
 
-      assert Utils.warned?() == true
+      assert Utils.unset_warned()
     end
 
     test "warnings are registered even with warnings_as_errors: false", context do
@@ -197,7 +197,7 @@ defmodule ExDoc.Formatter.HTMLTest do
         )
       end)
 
-      assert Utils.warned?() == true
+      assert Utils.unset_warned()
     end
   end