Adding CI, making the library available to older elixir versions

Author: Milan Rougemont

.formatter.exs

@@ -0,0 +1,9 @@
+# .formatter.exs
+[
+  import_deps: [:credo, :ex_doc],
+  inputs: [
+    "{mix,.formatter}.exs",
+    "{config,lib,test}/**/*.{ex,exs}"
+  ],
+  line_length: 100
+]

.github/workflows/ci.yml

@@ -0,0 +1,65 @@
+# .github/workflows/ci.yml
+name: CI
+
+on:
+  push:
+  pull_request:
+  workflow_dispatch:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  lint:
+    name: Lint & Docs (latest)
+    runs-on: ubuntu-latest
+    env:
+      MIX_ENV: dev
+    steps:
+      - uses: actions/checkout@v4
+      - uses: erlef/setup-beam@v1
+        with:
+          elixir-version: "1.18.4"
+          otp-version: "27.0"
+          install-hex: true
+          install-rebar: true
+      - run: mix deps.get
+      - run: mix format --check-formatted
+      - run: mix credo --strict
+      - run: mix docs
+      - run: mix hex.build
+
+  test:
+    name: Test (Elixir 1.12, 1.15, 1.18)
+    needs: lint
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          # Elixir 1.12: use ubuntu-22.04 + OTP 24.3 (non-legacy on 22.04)
+          - elixir: "1.12.3"
+            otp: "24.3"
+            runner: ubuntu-22.04
+          # Modern combos on ubuntu-latest
+          - elixir: "1.15.8"
+            otp: "26.2"
+            runner: ubuntu-latest
+          - elixir: "1.18.4"
+            otp: "27.0"
+            runner: ubuntu-latest
+    runs-on: ${{ matrix.runner }}
+    env:
+      MIX_ENV: test
+    steps:
+      - uses: actions/checkout@v4
+      - uses: erlef/setup-beam@v1
+        with:
+          elixir-version: ${{ matrix.elixir }}
+          otp-version: ${{ matrix.otp }}
+          install-hex: true
+          install-rebar: true
+      - run: mix deps.get --only $MIX_ENV
+      - run: mix compile --warnings-as-errors
+      - run: mix test --color --trace
+

.gitignore

@@ -21,7 +21,3 @@ calque-*.tar
 
 # Temporary files, for example, from tests.
 /tmp/
-
-.DS_Store
-.formatter.exs
-mix.lock

lib/calque.ex

@@ -28,7 +28,7 @@ defmodule Calque do
   ---
   """
 
-  alias Calque.{Snapshot, Diff, Error, Levenshtein}
+  alias Calque.{Diff, Error, Levenshtein, Snapshot}
 
   @type snapshot :: Snapshot.t()
 
@@ -195,7 +195,7 @@ defmodule Calque do
   end
 
   # -------------------------
-  # FILE OPERATIONS 
+  # FILE OPERATIONS
   # -------------------------
 
   @doc false
@@ -297,7 +297,7 @@ defmodule Calque do
   defp to_accepted_path(path), do: String.replace_suffix(path, ".snap", ".accepted.snap")
 
   # -------------------------
-  # SNAPSHOT DE/SERIALIZATION 
+  # SNAPSHOT DE/SERIALIZATION
   # -------------------------
 
   @doc false
@@ -351,7 +351,7 @@ defmodule Calque do
   end
 
   # -------------------------
-  # SNAPSHOT DIFFING  
+  # SNAPSHOT DIFFING
   # -------------------------
 
   @doc false
@@ -376,7 +376,7 @@ defmodule Calque do
   end
 
   # -------------------------
-  # PRETTY PRINTING 
+  # PRETTY PRINTING
   # -------------------------
 
   @doc false

lib/levenshtein.ex

@@ -40,8 +40,7 @@ defmodule Calque.Levenshtein do
     up_left0 = hd(prev_row)
 
     {row_rev, _last_up} =
-      Enum.reduce(Enum.with_index(t, 1), {[first_cell], up_left0}, fn {tc, j},
-                                                                      {row_rev, up_left} ->
+      Enum.reduce(Enum.with_index(t, 1), {[first_cell], up_left0}, fn {tc, j}, {row_rev, up_left} ->
         left = hd(row_rev)
         up = Enum.at(prev_row, j)
         cost = if sc == tc, do: 0, else: 1

lib/snapshot.ex

@@ -1,4 +1,22 @@
 defmodule Calque.Snapshot do
+  @moduledoc """
+  Represents a **snapshot** — a saved version of output data used by Calque’s
+  snapshot testing system.
+
+  A snapshot encapsulates:
+  - `:title` — A human-readable identifier, often matching the test name.
+  - `:content` — The stringified output captured during the test run.
+  - `:status` — Either `:new` (freshly generated and unreviewed) or `:accepted`
+    (already validated and stored).
+
+  This module provides simple constructors to ensure consistent initialization:
+  - `new/2` — Creates a new, unaccepted snapshot.
+  - `accepted/2` — Builds an accepted snapshot loaded from disk.
+
+  Snapshots are immutable data structures; their lifecycle and comparison logic
+  are handled by higher-level modules such as `Calque` and `Calque.Diff`.
+  """
+
   @enforce_keys [:title, :content, :status]
   defstruct [:title, :content, :status]
 

mix.exs

@@ -5,9 +5,8 @@ defmodule Calque.MixProject do
     [
       app: :calque,
       version: "1.3.0",
-      elixir: "~> 1.15",
-      description:
-        "A simple snapshot testing library inspired by Birdie (Gleam) and Insta (Rust).",
+      elixir: "~> 1.12",
+      description: "A simple snapshot testing library inspired by Birdie (Gleam) and Insta (Rust).",
       package: package(),
       deps: deps(),
       source_url: "https://github.com/milaneuh/calque",

mix.lock

@@ -1,3 +1,13 @@
 %{
+  "bunt": {:hex, :bunt, "1.0.0", "081c2c665f086849e6d57900292b3a161727ab40431219529f13c4ddcf3e7a44", [:mix], [], "hexpm", "dc5f86aa08a5f6fa6b8096f0735c4e76d54ae5c9fa2c143e5a1fc7c1cd9bb6b5"},
+  "credo": {:hex, :credo, "1.7.13", "126a0697df6b7b71cd18c81bc92335297839a806b6f62b61d417500d1070ff4e", [:mix], [{:bunt, "~> 0.2.1 or ~> 1.0", [hex: :bunt, repo: "hexpm", optional: false]}, {:file_system, "~> 0.2 or ~> 1.0", [hex: :file_system, repo: "hexpm", optional: false]}, {:jason, "~> 1.0", [hex: :jason, repo: "hexpm", optional: false]}], "hexpm", "47641e6d2bbff1e241e87695b29f617f1a8f912adea34296fb10ecc3d7e9e84f"},
+  "earmark_parser": {:hex, :earmark_parser, "1.4.44", "f20830dd6b5c77afe2b063777ddbbff09f9759396500cdbe7523efd58d7a339c", [:mix], [], "hexpm", "4778ac752b4701a5599215f7030989c989ffdc4f6df457c5f36938cc2d2a2750"},
+  "ex_doc": {:hex, :ex_doc, "0.38.4", "ab48dff7a8af84226bf23baddcdda329f467255d924380a0cf0cee97bb9a9ede", [:mix], [{:earmark_parser, "~> 1.4.44", [hex: :earmark_parser, repo: "hexpm", optional: false]}, {:makeup_c, ">= 0.1.0", [hex: :makeup_c, repo: "hexpm", optional: true]}, {:makeup_elixir, "~> 0.14 or ~> 1.0", [hex: :makeup_elixir, repo: "hexpm", optional: false]}, {:makeup_erlang, "~> 0.1 or ~> 1.0", [hex: :makeup_erlang, repo: "hexpm", optional: false]}, {:makeup_html, ">= 0.1.0", [hex: :makeup_html, repo: "hexpm", optional: true]}], "hexpm", "f7b62346408a83911c2580154e35613eb314e0278aeea72ed7fedef9c1f165b2"},
   "exdiff": {:hex, :exdiff, "0.1.5", "3e55bd840214508fd478d91fb07f1671d90d2f0d6f5266296e3b596e07d92305", [:mix], [], "hexpm", "b1ccef642edc28ed3acf1b08c8dbc6e42852d18dfe51b453529588e53c733eba"},
+  "file_system": {:hex, :file_system, "1.1.1", "31864f4685b0148f25bd3fbef2b1228457c0c89024ad67f7a81a3ffbc0bbad3a", [:mix], [], "hexpm", "7a15ff97dfe526aeefb090a7a9d3d03aa907e100e262a0f8f7746b78f8f87a5d"},
+  "jason": {:hex, :jason, "1.4.4", "b9226785a9aa77b6857ca22832cffa5d5011a667207eb2a0ad56adb5db443b8a", [:mix], [{:decimal, "~> 1.0 or ~> 2.0", [hex: :decimal, repo: "hexpm", optional: true]}], "hexpm", "c5eb0cab91f094599f94d55bc63409236a8ec69a21a67814529e8d5f6cc90b3b"},
+  "makeup": {:hex, :makeup, "1.2.1", "e90ac1c65589ef354378def3ba19d401e739ee7ee06fb47f94c687016e3713d1", [:mix], [{:nimble_parsec, "~> 1.4", [hex: :nimble_parsec, repo: "hexpm", optional: false]}], "hexpm", "d36484867b0bae0fea568d10131197a4c2e47056a6fbe84922bf6ba71c8d17ce"},
+  "makeup_elixir": {:hex, :makeup_elixir, "1.0.1", "e928a4f984e795e41e3abd27bfc09f51db16ab8ba1aebdba2b3a575437efafc2", [:mix], [{:makeup, "~> 1.0", [hex: :makeup, repo: "hexpm", optional: false]}, {:nimble_parsec, "~> 1.2.3 or ~> 1.3", [hex: :nimble_parsec, repo: "hexpm", optional: false]}], "hexpm", "7284900d412a3e5cfd97fdaed4f5ed389b8f2b4cb49efc0eb3bd10e2febf9507"},
+  "makeup_erlang": {:hex, :makeup_erlang, "1.0.2", "03e1804074b3aa64d5fad7aa64601ed0fb395337b982d9bcf04029d68d51b6a7", [:mix], [{:makeup, "~> 1.0", [hex: :makeup, repo: "hexpm", optional: false]}], "hexpm", "af33ff7ef368d5893e4a267933e7744e46ce3cf1f61e2dccf53a111ed3aa3727"},
+  "nimble_parsec": {:hex, :nimble_parsec, "1.4.2", "8efba0122db06df95bfaa78f791344a89352ba04baedd3849593bfce4d0dc1c6", [:mix], [], "hexpm", "4b21398942dda052b403bbe1da991ccd03a053668d147d53fb8c4e0efe09c973"},
 }