Make pdf_redlines a required dependency

Precompiled NIF, no Rust toolchain needed. Removes the runtime
Code.ensure_loaded? detection in favour of direct calls.

Author: neilberkman

CHANGELOG.md

@@ -2,7 +2,9 @@
 
 ## 0.5.0
 
-- Stable public release.
+- `pdf_redlines` is now a required dependency (precompiled NIF, no toolchain needed).
+- Removed runtime detection of `PDFRedlines` module availability.
+- Expanded README with badges, full API docs, and usage examples.
 
 ## 0.1.0
 

README.md

@@ -6,7 +6,7 @@
 
 Extract and normalize tracked changes ("redlines") from DOCX and PDF documents into a single unified shape.
 
-Redlines parses `<w:ins>` and `<w:del>` elements from DOCX files and integrates with the optional [`pdf_redlines`](https://hex.pm/packages/pdf_redlines) NIF for PDF extraction. All changes are normalized into `Redlines.Change` structs regardless of source format.
+Redlines parses `<w:ins>` and `<w:del>` elements from DOCX files and uses [`pdf_redlines`](https://hex.pm/packages/pdf_redlines) (precompiled Rust/MuPDF NIF) for PDF extraction. All changes are normalized into `Redlines.Change` structs regardless of source format.
 
 ## Installation
 
@@ -20,15 +20,7 @@ def deps do
 end
 ```
 
-### PDF Support
-
-PDF extraction requires the [`pdf_redlines`](https://hex.pm/packages/pdf_redlines) package (Rust/MuPDF NIF). Add it alongside `redlines` if you need PDF support:
-
-```elixir
-{:pdf_redlines, "~> 0.6"}
-```
-
-If `pdf_redlines` is not installed, DOCX extraction works standalone with no additional dependencies beyond `sweet_xml`.
+PDF support is included out of the box via the precompiled [`pdf_redlines`](https://hex.pm/packages/pdf_redlines) NIF -- no Rust toolchain required.
 
 ## Usage
 
@@ -39,7 +31,7 @@ If `pdf_redlines` is not installed, DOCX extraction works standalone with no add
 {:ok, %Redlines.Result{changes: changes, source: :docx}} =
   Redlines.extract("contract_v2.docx")
 
-# PDF - requires :pdf_redlines dependency
+# PDF
 {:ok, %Redlines.Result{changes: changes, source: :pdf}} =
   Redlines.extract("contract_v2.pdf")
 

lib/redlines.ex

@@ -6,9 +6,6 @@ defmodule Redlines do
 
   - DOCX track changes (`<w:ins>`, `<w:del>`)
   - PDFs with embedded tracked-changes markup (via [`pdf_redlines`](https://hex.pm/packages/pdf_redlines))
-
-  PDF support is optional: if you want PDF extraction, add `:pdf_redlines` to your
-  application's dependencies.
   """
 
   alias Redlines.{Change, DOCX, Format, PDF, Result}

lib/redlines/pdf.ex

@@ -1,39 +1,29 @@
 defmodule Redlines.PDF do
   @moduledoc """
-  PDF adapter.
-
-  This module integrates with the `pdf_redlines` package (Rust/MuPDF NIF) if it
-  is available at runtime.
+  PDF adapter using the `pdf_redlines` package (precompiled Rust/MuPDF NIF).
   """
 
   alias Redlines.Change
 
   @doc """
   Extract redlines from a PDF file path.
-
-  Requires the `pdf_redlines` package to be present in the caller's dependency
-  tree.
   """
-  @spec extract_redlines(Path.t(), keyword() | map()) :: {:ok, list()} | {:error, term()}
+  @spec extract_redlines(Path.t(), keyword()) :: {:ok, list()} | {:error, term()}
   def extract_redlines(pdf_path, opts \\ []) when is_binary(pdf_path) do
-    with {:ok, arity} <- ensure_pdf_redlines_loaded(:extract_redlines),
-         {:ok, result} <- do_apply(PDFRedlines, :extract_redlines, arity, [pdf_path, opts]) do
-      case result do
-        %{redlines: redlines} when is_list(redlines) -> {:ok, redlines}
-        %_{redlines: redlines} when is_list(redlines) -> {:ok, redlines}
-        other -> {:error, {:unexpected_pdf_redlines_result, other}}
-      end
+    case PDFRedlines.extract_redlines(pdf_path, opts) do
+      {:ok, %{redlines: redlines}} when is_list(redlines) -> {:ok, redlines}
+      {:ok, %_{redlines: redlines}} when is_list(redlines) -> {:ok, redlines}
+      {:ok, other} -> {:error, {:unexpected_pdf_redlines_result, other}}
+      {:error, _} = error -> error
     end
   end
 
   @doc """
-  Fast redline presence check for PDFs (early-exit in `pdf_redlines`).
+  Fast redline presence check for PDFs (early-exit).
   """
-  @spec has_redlines?(Path.t(), keyword() | map()) :: {:ok, boolean()} | {:error, term()}
+  @spec has_redlines?(Path.t(), keyword()) :: {:ok, boolean()} | {:error, term()}
   def has_redlines?(pdf_path, opts \\ []) when is_binary(pdf_path) do
-    with {:ok, arity} <- ensure_pdf_redlines_loaded(:has_redlines?) do
-      do_apply(PDFRedlines, :has_redlines?, arity, [pdf_path, opts])
-    end
+    PDFRedlines.has_redlines?(pdf_path, opts)
   end
 
   @doc """
@@ -59,20 +49,4 @@ defmodule Redlines.PDF do
   end
 
   defp to_change(_), do: nil
-
-  defp ensure_pdf_redlines_loaded(fun) when is_atom(fun) do
-    cond do
-      Code.ensure_loaded?(PDFRedlines) and function_exported?(PDFRedlines, fun, 2) ->
-        {:ok, 2}
-
-      Code.ensure_loaded?(PDFRedlines) and function_exported?(PDFRedlines, fun, 1) ->
-        {:ok, 1}
-
-      true ->
-        {:error, :pdf_redlines_not_available}
-    end
-  end
-
-  defp do_apply(mod, fun, 2, [path, opts]), do: apply(mod, fun, [path, opts])
-  defp do_apply(mod, fun, 1, [path, _opts]), do: apply(mod, fun, [path])
 end

mix.exs

@@ -33,6 +33,7 @@ defmodule Redlines.MixProject do
   defp deps do
     [
       {:sweet_xml, "~> 0.7"},
+      {:pdf_redlines, "~> 0.6"},
       {:credo, "~> 1.7", only: [:dev, :test], runtime: false},
       {:dialyxir, "~> 1.4", only: [:dev, :test], runtime: false},
       {:ex_doc, "~> 0.39.3", only: :dev, runtime: false},

mix.lock

@@ -1,5 +1,6 @@
 %{
   "bunt": {:hex, :bunt, "1.0.0", "081c2c665f086849e6d57900292b3a161727ab40431219529f13c4ddcf3e7a44", [:mix], [], "hexpm", "dc5f86aa08a5f6fa6b8096f0735c4e76d54ae5c9fa2c143e5a1fc7c1cd9bb6b5"},
+  "castore": {:hex, :castore, "1.0.17", "4f9770d2d45fbd91dcf6bd404cf64e7e58fed04fadda0923dc32acca0badffa2", [:mix], [], "hexpm", "12d24b9d80b910dd3953e165636d68f147a31db945d2dcb9365e441f8b5351e5"},
   "credo": {:hex, :credo, "1.7.16", "a9f1389d13d19c631cb123c77a813dbf16449a2aebf602f590defa08953309d4", [: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", "d0562af33756b21f248f066a9119e3890722031b6d199f22e3cf95550e4f1579"},
   "dialyxir": {:hex, :dialyxir, "1.4.7", "dda948fcee52962e4b6c5b4b16b2d8fa7d50d8645bbae8b8685c3f9ecb7f5f4d", [:mix], [{:erlex, ">= 0.2.8", [hex: :erlex, repo: "hexpm", optional: false]}], "hexpm", "b34527202e6eb8cee198efec110996c25c5898f43a4094df157f8d28f27d9efe"},
   "earmark_parser": {:hex, :earmark_parser, "1.4.44", "f20830dd6b5c77afe2b063777ddbbff09f9759396500cdbe7523efd58d7a339c", [:mix], [], "hexpm", "4778ac752b4701a5599215f7030989c989ffdc4f6df457c5f36938cc2d2a2750"},
@@ -11,6 +12,8 @@
   "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.3", "4252d5d4098da7415c390e847c814bad3764c94a814a0b4245176215615e1035", [:mix], [{:makeup, "~> 1.0", [hex: :makeup, repo: "hexpm", optional: false]}], "hexpm", "953297c02582a33411ac6208f2c6e55f0e870df7f80da724ed613f10e6706afd"},
   "nimble_parsec": {:hex, :nimble_parsec, "1.4.2", "8efba0122db06df95bfaa78f791344a89352ba04baedd3849593bfce4d0dc1c6", [:mix], [], "hexpm", "4b21398942dda052b403bbe1da991ccd03a053668d147d53fb8c4e0efe09c973"},
+  "pdf_redlines": {:hex, :pdf_redlines, "0.6.2", "59b3d836be79880d988c4db4cbfe503ed4ecd572daa8dd4188da2f1417b07126", [:mix], [{:rustler, "~> 0.37.1", [hex: :rustler, repo: "hexpm", optional: true]}, {:rustler_precompiled, "~> 0.8.4", [hex: :rustler_precompiled, repo: "hexpm", optional: false]}], "hexpm", "b2eac630c8abc851c2d9a1726c1e812c6e1eeb1571d5dac1b1a6f949002e16c5"},
   "quokka": {:hex, :quokka, "2.11.2", "2856118154425f18547720d997199be54febed771a740ba3c988a17762328287", [:mix], [{:credo, "~> 1.7", [hex: :credo, repo: "hexpm", optional: false]}], "hexpm", "8208f5d814007cb35a2eb278462464d083fca8c463f62517ab94eef982f181cc"},
+  "rustler_precompiled": {:hex, :rustler_precompiled, "0.8.4", "700a878312acfac79fb6c572bb8b57f5aae05fe1cf70d34b5974850bbf2c05bf", [:mix], [{:castore, "~> 0.1 or ~> 1.0", [hex: :castore, repo: "hexpm", optional: false]}, {:rustler, "~> 0.23", [hex: :rustler, repo: "hexpm", optional: true]}], "hexpm", "3b33d99b540b15f142ba47944f7a163a25069f6d608783c321029bc1ffb09514"},
   "sweet_xml": {:hex, :sweet_xml, "0.7.5", "803a563113981aaac202a1dbd39771562d0ad31004ddbfc9b5090bdcd5605277", [:mix], [], "hexpm", "193b28a9b12891cae351d81a0cead165ffe67df1b73fe5866d10629f4faefb12"},
 }