feat: atom schematic (#34)

mhanberg · web-flow · commit b524b5a0bb5b · 2024-10-10T22:34:22.000-04:00
diff --git a/README.md b/README.md
@@ -15,6 +15,7 @@ There are 12 builtin schematics that you can use to build new schematics that fi
 
 - `bool/0`
 - `str/0`
+- `atom/0`
 - `int/0`
 - `float/0`
 - `list/1`
diff --git a/lib/schematic.ex b/lib/schematic.ex
@@ -168,6 +168,37 @@ defmodule Schematic do
     }
   end
 
+  @doc """
+  Specifies that the data is an atom.
+
+  ## Usage
+
+  Any string.
+
+  ```elixir
+  iex> schematic = atom()
+  iex> {:ok, :hi} = unify(schematic, :hi)
+  iex> {:error, "expected an atom"} = unify(schematic, "boom")
+  ```
+  """
+  @spec atom() :: t()
+  def atom() do
+    message = fn -> "an atom" end
+
+    %Schematic{
+      kind: "atom",
+      message: message,
+      unify:
+        telemetry_wrap(:str, %{}, fn input, _dir ->
+          if is_atom(input) do
+            {:ok, input}
+          else
+            {:error, "expected #{message.()}"}
+          end
+        end)
+    }
+  end
+
   @doc """
   Specifies that the data is an integer or a specific integer.
 
