https://github.com/kubukoz/vivalidi

[abandoned] A crazy man's effect-agnostic validations for Scala DTOs
https://github.com/kubukoz/vivalidi

cats effect fp pure-fp pure-scala scala shapeless validation zio

Last synced: 28 days ago
JSON representation

[abandoned] A crazy man's effect-agnostic validations for Scala DTOs

• Host: GitHub
• URL: https://github.com/kubukoz/vivalidi
• Owner: kubukoz
• License: apache-2.0
• Created: 2018-04-08T23:58:28.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2019-12-28T18:42:22.000Z (about 5 years ago)
• Last Synced: 2024-12-17T16:47:32.259Z (about 1 month ago)
• Topics: cats, effect, fp, pure-fp, pure-scala, scala, shapeless, validation, zio
• Language: Scala
• Homepage:
• Size: 84 KB
• Stars: 2
• Watchers: 2
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# vivalidi [abandoned]

[![Build Status](https://travis-ci.org/kubukoz/vivalidi.svg?branch=master)](https://travis-ci.org/kubukoz/vivalidi)

[![Latest version](https://index.scala-lang.org/kubukoz/vivalidi/vivalidi/latest.svg)](https://index.scala-lang.org/kubukoz/vivalidi/vivalidi)

[![Maven Central](https://img.shields.io/maven-central/v/com.kubukoz/vivalidi_2.12.svg)](http://search.maven.org/#search%7Cga%7C1%7Cvivalidi)

[![License](http://img.shields.io/:license-Apache%202-green.svg)](http://www.apache.org/licenses/LICENSE-2.0.txt)

## This project is not actively developed. Use `Parallel` from cats.

A crazy man's effect-agnostic validations for Scala DTOs. Mostly extra syntax for cats' parMapN that's less red-squiggly in IntelliJ IDEA.

**Warning: this library is as experimental as they come (it doesn't even have a logo yet).

You're highly discouraged from using it in production**, although you might want to check it out in side projects

or contribute to the upcoming planning for a more stable API.

## SBT dependency

```scala

"com.kubukoz" %% "vivalidi" % "x.x.x"

```

Replace x.x.x with the version you want (the latest non-snapshot release version can be seen on the top of this README).

The library is cross-compiled to Scala 2.12 and Scala.js - for the latter, replace `%%` with `%%%`.

## Usage

Coming soon - until then, please enjoy this example from tests:

```scala

import vivalidi.Vivalidi, vivalidi.syntax.all._

type EitherNelT[F[_], E, T] = EitherT[F, NonEmptyList[E], T]

type E[A] = EitherNelT[IO, String, A]

val validation: Person => EitherNelT[IO, String, Person] = Vivalidi[Person, E].init

  .sync(_.id)(_ => "wrong id".leftNel[Long])

  .just(_.name)

  .async(_.age)(_ => "wrong age".leftNel[Int].liftTo[E])

  .to[Person]

  .run

val person = Person(1, "hello", 21)

validation(person).value.unsafeRunSync()

```

tl;dr `CreateV[_] : Applicative` - so far the validators (e.g. `validateLength`, a custom function taking String and returning

`CreateV[String]`) are responsible for raising errors, but in the future there might be no type parameter for errors, just

an appropriate `MonadError` context bound. `F[_]` is just an applicative (like `Future`), and `TransactionToCreate` is

the input type (which `toCreate` matches).

## FAQ

1. Can I use this in production?

![I mean you can, but you'll be on your own, as the API will change tens of times before it gets anywhere near stable](https://media.tenor.co/images/a8b0a72b4d23609c7f30b3ff2c3e9095/tenor.gif)

2. Does this have any external dependencies?

Yes, there's a direct dependency on `cats-core` and `shapeless`.

3. Tests?

lmao