testrun

Author: joladev

.github/workflows/ci.yml

@@ -0,0 +1,64 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    name: Test (Elixir ${{ matrix.elixir }} / OTP ${{ matrix.otp }}${{ matrix.unlock && ' / unlock' || '' }})
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        include:
+          - elixir: "1.19"
+            otp: "27"
+            unlock: false
+          - elixir: "1.19"
+            otp: "28"
+            unlock: false
+          - elixir: "1.19"
+            otp: "28"
+            unlock: true
+
+    env:
+      MIX_ENV: test
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: erlef/setup-beam@v1
+        with:
+          elixir-version: ${{ matrix.elixir }}
+          otp-version: ${{ matrix.otp }}
+
+      - uses: actions/cache@v4
+        with:
+          path: |
+            deps
+            _build
+          key: ${{ runner.os }}-mix-${{ matrix.elixir }}-${{ matrix.otp }}-${{ hashFiles('**/mix.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-mix-${{ matrix.elixir }}-${{ matrix.otp }}-
+
+      - name: Unlock deps
+        if: matrix.unlock
+        run: mix deps.unlock --all
+
+      - name: Install dependencies
+        run: mix deps.get
+
+      - name: Check formatting
+        run: mix format --check-formatted
+
+      - name: Compile with warnings as errors
+        run: mix compile --warnings-as-errors
+
+      - name: Run Credo
+        run: mix credo --strict
+
+      - name: Run tests
+        run: mix test

.github/workflows/dependabot.yml

@@ -0,0 +1,16 @@
+version: 2
+
+updates:
+  - package-ecosystem: "mix"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    cooldown:
+      default-days: 7
+
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    cooldown:
+      default-days: 7

lib/og_mate.ex

@@ -3,7 +3,7 @@ defmodule OGMate do
   Compile-time OG image generation for Elixir content sites.
 
   A NimblePublisher-style library that bakes PNG images at compile time.
-  Always returns `{:ok, bytes}` — unknown slugs resolve to the default image.
+  Always returns `{:ok, bytes}` — unknown keys resolve to the default image.
 
   ## Example
 
@@ -43,41 +43,41 @@ defmodule OGMate do
   # ── Callbacks ────────────────────────────────────────────────────
 
   @doc """
-  Returns a list of all slugs that should have images.
+  Returns a list of all keys that should have images.
 
   These are enumerated and baked at compile time.
   """
   @callback all_keys() :: [String.t()]
 
   @doc """
-  Given a slug, return `{title, description}`, or `:error` if the slug
+  Given a key, return `{title, description}`, or `:error` if the key
   shouldn't produce an image.
 
-  Slugs that return `:error` are listed by `all_keys/0` but are skipped
+  keys that return `:error` are listed by `all_keys/0` but are skipped
   during baking (they resolve to the default image at runtime).
   """
-  @callback content_for(slug :: String.t()) :: {String.t(), String.t()} | :error
+  @callback content_for(key :: String.t()) :: {String.t(), String.t()} | :error
 
   @doc """
   Custom rendering escape hatch.
 
   Override this function to take full control. Receives the title and
-  description for the current slug, plus the theme map. Must return a
+  description for the current key, plus the theme map. Must return a
   PNG binary wrapped in `{:ok, ...}` or `{:error, reason}`.
 
-  If rendering fails (`{:error, _}`), the slug is skipped during baking.
+  If rendering fails (`{:error, _}`), the key is skipped during baking.
   If not implemented, the default renderer is used.
   """
   @callback render(title :: String.t(), desc :: String.t(), theme()) ::
               {:ok, binary()} | {:error, term()}
 
   @doc """
-  Returns the PNG bytes for `slug`.
+  Returns the PNG bytes for `key`.
 
-  Always returns `{:ok, png_binary}`. Unknown slugs fall through to the
+  Always returns `{:ok, png_binary}`. Unknown keys fall through to the
   pre-baked default image — never an error at the public API.
   """
-  @callback image_for(slug :: String.t()) :: {:ok, binary()}
+  @callback image_for(key :: String.t()) :: {:ok, binary()}
 
   @optional_callbacks render: 3
 
@@ -117,11 +117,11 @@ defmodule OGMate do
 
       # ── Content images (baked in prod, lazy in dev) ──────────────
       @og_images if(not @og_dev_mode) do
-        Map.new(all_keys(), fn slug ->
-          case content_for(slug) do
-            {t, d} ->
-              case OGMate.__bake__(__MODULE__, t, d, @og_theme) do
-                {:ok, bytes} -> {slug, bytes}
+        Map.new(all_keys(), fn key ->
+          case content_for(key) do
+            {title, description} ->
+              case OGMate.__bake__(__MODULE__, title, description, @og_theme) do
+                {:ok, bytes} -> {key, bytes}
                 {:error, _} -> :skip
               end
 
@@ -132,31 +132,34 @@ defmodule OGMate do
       end
 
       # ── Public API: total, never errors ──────────────────────────
-      @doc "Returns the PNG bytes for `slug`. Unknown slugs resolve to the default."
+      @doc "Returns the PNG bytes for `key`. Unknown keys resolve to the default."
       @spec image_for(String.t()) :: {:ok, binary()}
-      def image_for(slug) do
+      def image_for(key) do
         case @og_images do
           nil ->
             # Dev mode: render on demand
-            {t, d} = content_for(slug)
+            {title, description} = content_for(key)
 
-            case OGMate.__bake__(__MODULE__, t, d, @og_theme) do
+            case OGMate.__bake__(__MODULE__, title, description, @og_theme) do
               {:ok, bytes} ->
                 {:ok, bytes}
 
               {:error, reason} ->
-                IO.warn("render failed for #{inspect(slug)}: #{inspect(reason)}, using default")
+                IO.warn("render failed for #{inspect(key)}: #{inspect(reason)}, using default")
                 {:ok, @og_default}
             end
 
           map ->
-            case Map.fetch(map, slug) do
+            case Map.fetch(map, key) do
               {:ok, bytes} -> {:ok, bytes}
               :error -> {:ok, @og_default}
             end
         end
       end
 
+      @doc "Returns the pre-baked default PNG binary."
+      def default_image(), do: @og_default
+
       # ── Recompile hook ───────────────────────────────────────────
       def __mix_recompile__(), do: all_keys()
     end
@@ -171,8 +174,8 @@ defmodule OGMate do
   """
   @spec __bake__(module(), String.t(), String.t(), map()) ::
           {:ok, binary()} | {:error, term()}
-  def __bake__(module, title, desc, theme) do
-    case render(module, title, desc, theme) do
+  def __bake__(module, title, description, theme) do
+    case render(module, title, description, theme) do
       {:ok, bytes} -> {:ok, bytes}
       {:error, reason} -> {:error, reason}
     end
@@ -181,11 +184,11 @@ defmodule OGMate do
   # Internal dispatch: user render or default renderer.
   @spec render(module(), String.t(), String.t(), map()) ::
           {:ok, binary()} | {:error, term()}
-  defp render(module, title, desc, theme) do
+  defp render(module, title, description, theme) do
     if function_exported?(module, :render, 3) do
-      module.render(title, desc, theme)
+      module.render(title, description, theme)
     else
-      OGMate.Renderer.render(title, desc, theme)
+      OGMate.Renderer.render(title, description, theme)
     end
   end
 end