README.MD

PureValidator

PureValidator is a Scala library implementing typesafe validation mechanism. With help of it, you will get compile-time guarantee on validness of data.

Idea

Its a tricky question where in application we should validate data. Some developers prefer defensive development with data checking in every function, while on other side we can check data only in application controllers. Both ways have their pros and cons, but what if we want to get benefits from both? In PureValidator we think that we can write our code in defensive way without tons of boilerplate code and runtime overhead.

Example

To demonstrate how PureValidator works, let's create test data model:

final case class User(firstName: String, lastName: String, age: Int)

To define validation rules, create companion object and extend it from Validatable trait:

object User extends Validatable[User] {
    override implicit val validator: Validator[User] =
      Validator[User]
        .check(_.firstName.nonEmpty, "firstName-is-empty")
        .check(_.lastName.nonEmpty, "lastName-is-empty")
        .check(_.age > 0, "age-lower-that-0")      
}

To validate your entity, use Validation object or special syntax package:

import me.archdev.purevalidator.syntax._

User("", "", 0).validate // Left(Seq("firstName-is-empty", "lastName-is-empty", "age-lower-that-0"))
User("A", "K", 1).validate // Right(User.Valid("A", "K", 1))

As you can see, if validation was successful, user model type was changed. User.Valid type is a same User object but with special mark. We can use it as just User object or ensure that our functions will accept only valid entities:

def saveUser(user: User.Valid): Future[Id] = ???

User("A", "K", 1).validate.map(saveUser) // OK
saveUser(User("A", "K", 1)) // Type missmatch during compilation

With help of .Valid type, we can be totally sure that nobody will use our codebase with non-validated data.

Features

Internal objects validation

implicit val userValidator: Validator[User] = ???
final case class Party(owner: User)

object Party extends Validatable[Party] {
  override implicit val validator: Validator[Party] =
    Validator[Party].check(_.owner) // Validator will be passed in implicit scope
}

Different validators

object User extends TypeValidatable[T] {
  val validatorA: Validator[User] = ???
  val validatorB: Validator[User] = ???
}

someUser.validate(User.validatorA) // Right(User.Valid)

ADT validation

sealed trait MyADT
final case class Multiply(x: Int, y: Int) extends MyADT
final case class Divide(x: Int, y: Int) extends MyADT

object MyADT extends TypeValidatable[MyADT] {
  implicit val divideValidator =
    Validator[Divide]
      .check(_.y > 0, "cannot divide on zero")
}

import me.archdev.purevalidator.syntax._
Divide(1, 1).validate // Right(MyADT.Valid)
Divide(1, 0).validate // Left(Seq("cannot divide on zero"))