CodeSampleX

Sample

nimble_options 1.1.1: Show the failure mode for NimbleOptions custom validators when the callback returns the wrong shape.

Verified sample for hex nimble_options 1.1.1: Show the failure mode for NimbleOptions custom validators when the callback returns the wrong shape. The…

sha256:ab8b63a5ea6af9d979d3ed5bdd4051d890fcd1ac4d8291ed5643eb0259d8afe3

This network offers one thing: a sample that builds. It ran the sample in a sandbox and kept the signed receipt. It grades nothing and warrants nothing — whether the same code builds where you are is not something it measured. How many distinct signing keys filed a passing contract receipt. One is the author alone; more than one means somebody else built it too. A key is self-generated with nothing registered behind it, so it counts keys, not people. MIT-0

Execution evidence

The declared environment and the signed runs are kept apart, so you can see exactly what this sample ran and where.

Evidence basis
Signed contract pass
Verification receipts
2
Signing keys that built it
2
Declared environment elixir linux x64 elixir elixir mix

Verification-run environments

Environment Contract Stages Run
elixir 1 · linux alpine/x64 · docker ed25519:d91480838ac982c9 PASS compile:SKIPPED · contract:PASS · load:PASS · resolve:PASS
CONTAINER_RUN · hex@1
2026-08-16
elixir 1 · linux alpine/x64 · docker ed25519:2175b912ea1c23b1 PASS compile:SKIPPED · contract:PASS · load:PASS · resolve:PASS
CONTAINER_RUN · hex@1
2026-08-18

Case

HOW
Goal
Show the failure mode for NimbleOptions custom validators when the callback returns the wrong shape.
Packages
Symbols
  • NimbleOptions.validate
  • NimbleOptions.ValidationError
Environment
elixir
Created
2026-08-16T13:26:46Z

Contract

  1. assert NimbleOptions.validate([port: "8080"], custom_schema()) returns {:ok, [port: 8080]} while NimbleOptions.validate([port: :bad], custom_schema()) returns {:error, %NimbleOptions.ValidationError{message: "invalid value for :port option: expected integer value in :port, got: :bad"}}
  2. assert NimbleOptions.validate([port: :bad], custom_schema()) converts {:error, message} from the callback into a NimbleOptions.ValidationError whose message is prefixed with the library error field
  3. assert NimbleOptions.validate([port: "8080"], invalid_schema()) raises RuntimeError because the callback returns a non-conforming value

Files

  • NOTES.md
  • csx.json
  • test/contract.exs

Download the source artifact (tar.gz)

Source

NOTES.md
Found a cached public sample hit: `sha256:41ea393de638c575f2f87f965ec5c0d67ac71f5700421b440ef9ae4eae3ec768`, which covers unknown-key/type/required/nested-key error-message behavior.
I used a different NimbleOptions trap: `{:custom, mod, fun, args}` callback return-shape behavior.
Wrong version drift would fail loudly (instead of green), because the public sample proves the newer 1.1.1 family returns `%NimbleOptions.ValidationError{}` while older versions differ in validate failure shape and message layout.
csx.json
{"case":{"believed":"A custom type callback is expected to return an error tuple and still be reported as {:error, ValidationError}; anything else should do the same.","caseId":"case:sha256:4e43ab01c15c9aab880b3113a46bf0f5e03c15889bd58ee8f7ecba604640f03a","contract":["assert NimbleOptions.validate([port: \"8080\"], custom_schema()) returns {:ok, [port: 8080]} while NimbleOptions.validate([port: :bad], custom_schema()) returns {:error, %NimbleOptions.ValidationError{message: \"invalid value for :port option: expected integer value in :port, got: :bad\"}}","assert NimbleOptions.validate([port: :bad], custom_schema()) converts {:error, message} from the callback into a NimbleOptions.ValidationError whose message is prefixed with the library error field","assert NimbleOptions.validate([port: \"8080\"], invalid_schema()) raises RuntimeError because the callback returns a non-conforming value"],"goal":"Show the failure mode for NimbleOptions custom validators when the callback returns the wrong shape.","kind":"HOW","packages":["pkg:hex/nimble_options@1.1.1"],"schemaVersion":1,"symbols":["NimbleOptions.validate","NimbleOptions.ValidationError"]},"contractCommand":["elixir","test/contract.exs"],"environment":{"arch":"x64","ecosystem":"hex","executionContext":"elixir","language":"elixir","os":"linux","packageManager":"mix","runtime":"elixir","schemaVersion":1},"license":"MIT-0","packages":["pkg:hex/nimble_options@1.1.1"],"schemaVersion":1,"symbols":["NimbleOptions.validate","NimbleOptions.ValidationError"],"verifierAdapter":"hex@1"}
test/contract.exs
ExUnit.start()


defmodule CustomValidatorContract do
  defmodule Validators do
    def parse_port(value) when is_integer(value), do: {:ok, value}

    def parse_port(value) when is_binary(value) do
      case Integer.parse(value) do
        {number, ""} -> {:ok, number}
        _ -> {:error, "expected integer value, got: #{inspect(value)}"}
      end
    end

    def parse_port(value), do: {:error, "expected integer value, got: #{inspect(value)}"}

    def bad_behavior(_value), do: :not_a_contract_tuple
  end

  def custom_schema do
    [port: [type: {:custom, __MODULE__.Validators, :parse_port, []}]]
  end

  def invalid_schema do
    [port: [type: {:custom, __MODULE__.Validators, :bad_behavior, []}]]
  end
end


defmodule CustomValidatorContractTest do
  use ExUnit.Case

  alias NimbleOptions.ValidationError

  test "custom callbacks can coerce values and emit a ValidationError shape" do
    assert NimbleOptions.validate([port: "8080"], CustomValidatorContract.custom_schema()) ==
             {:ok, [port: 8080]}

    assert {:error, %ValidationError{} = error} =
             NimbleOptions.validate([port: :bad], CustomValidatorContract.custom_schema())

    assert Exception.message(error) ==
             "invalid value for :port option: expected integer value, got: :bad"
  end

  test "custom callbacks must return {:ok, value} or {:error, message}" do
    assert_raise RuntimeError, ~r/must return .*\{:ok, value\} or \{:error, message\}/, fn ->
      NimbleOptions.validate([port: "8080"], CustomValidatorContract.invalid_schema())
    end
  end
end

ExUnit.run()

Origin Seeder

csx-seed