Talos

Talos is simple parameters validation library

Documentation can be found at ExDoc

Why another one validation library?

I needed more checks than just whether the value belonged to a particular data type.

This library allows you to define your own checks and use typical checks with a simple setup.

Usage

  defmodule CheckUserSignUp do
    import Talos

    @schema map(fields: [
      field(key: "action", type: const(value: "sign-up")),
      field(key: "email", type: string(min_length: 5, max_length: 255, regexp: ~r/.*@.*/)),
      field(key: "age", type: integer(gteq: 18, allow_nil: true))
    ])

    def validate(%{} = map_data) do
      params = Talos.permit(map_data)
      errors = Talos.errors(@schema, params)

      case errors == %{} do
        true -> {:ok, params}
        false -> {:error, errors}
      end
    end
  end

Somewhere in UserController

  ...

  def sign_up(conn, params)
    case CheckUserSignUp.valid?(params) do
       :ok -> 
          result = MyApp.register_user!(params)
          render_json(%{"ok" => true | result})
       {:error, errors} -> 
          render_errors(errors)
    end
  end
  
  ...

Flow

Own Type definition

If you want define own Type, just create module with Talos.Types behavior

defmodule ZipCodeType do
  @behaviour Talos.Types
  defstruct [length: 6]

  def valid?(%__MODULE__{length: len}, value) do
    String.valid?(value) && String.match?(value, ~r/\d{len}/)
  end

  def errors(__MODULE__, value) do
    case valid?(__MODULE__,value) do
      true -> []
      false -> ["#{value} is not zipcode"]
    end
  end
end

# And use it

Talos.valid?(%ZipCodeType{}, "123456") # => true
Talos.valid?(%ZipCodeType{}, "1234") # => false
Talos.valid?(%ZipCodeType{}, 123456) # => false

Installation

def deps do
  [
    {:talos, "~> 1.12"}
  ]
end

Contribution

Feel free to make a pull request. All contributions are appreciated!