Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jap-company/fields
Scala validation library
https://github.com/jap-company/fields
cats functional-programming library macros scala short-circuit validation validation-library zio
Last synced: 2 months ago
JSON representation
Scala validation library
- Host: GitHub
- URL: https://github.com/jap-company/fields
- Owner: jap-company
- License: apache-2.0
- Created: 2022-05-29T10:37:51.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2022-08-09T21:26:10.000Z (over 2 years ago)
- Last Synced: 2024-08-04T00:06:06.489Z (6 months ago)
- Topics: cats, functional-programming, library, macros, scala, short-circuit, validation, validation-library, zio
- Language: Scala
- Homepage: https://jap-company.github.io/fields/
- Size: 4.47 MB
- Stars: 47
- Watchers: 2
- Forks: 4
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Contributing: docs/contributing.md
- License: LICENSE
Awesome Lists containing this project
- awesome-scala - fields - company/fields)  (Table of Contents / Data Binding and Validation)
README
[](https://stand-with-ukraine.pp.ua)
# Fields
[![badge-scaladex]][link-scaladex] [![badge-maven]][link-maven] [![badge-ci]][link-ci] [![badge-scaladoc]][link-scaladoc] [![badge-scala-ukraine]][link-scala-ukraine]
Fields is a Scala validation library that you should use because it is:
- _**F**inal Tagless_. Choose any Effect, Validated, or Error types.
- _**I**nformative_. Error paths help understanding where the error occurred.
- _**E**xpressive_. Rich, extendable validation syntax.
- _**L**ightweight_. The core module has no-dependencies.
- _**D**auntless_. Have no fear of complex validations with `Rule` type.
- _**S**hort-circuit_. Avoid running undesired validation side-effects.
# Teaser
```scala
// Here we pass validation dependencies using implicits, but you could be doing this the way you prefer
def policy(implicit tokenService: TokenService, userService: UserService): Policy[RegisterRequest] = Policy
.builder[RegisterRequest]
.subRule(_.age)(_ >= 18, _ <= 110)
.subRule(_.email)(_.map(_.value).matchesRegex(EmailRegex))
.subRule(_.password)(_.nonEmpty, _.minSize(4), _.maxSize(100))
.subRule(_.password, _.passwordRepeat)(_ equalTo _)
.subRule(_.username)(validateUsername)
.subRule(_.token)(_.ensureF(tokenService.validateToken, _.failMessage("invalid-token")))
.build
// Extract complex validations to reusable methods.
def validateUsername(username: Field[String])(implicit userService: UserService): MRule =
username.minSize(1) &&
username.maxSize(10) &&
MRule.flatten {
userService.findByUsername(username.value).map {
case Some(_) => username.failMessage("username-already-exists")
case None => MRule.valid
}
}
```
## Quicklinks
- [Microsite](https://jap-company.github.io/fields)
- [Medium](https://medium.com/@oleh.dubynskiy/fields-scala-validation-library-86ac818cd704)
- [Contributor's Guide](https://jap-company.github.io/fields/docs/contributing)
- [License](LICENSE)
- [Issues](https://github.com/jap-company/fields/issues)
- [Pull Requests](https://github.com/jap-company/fields/pulls)
# [Learn More on the Fields Microsite](https://jap-company.github.io/fields)
[link-scaladex]: https://index.scala-lang.org/jap-company/fields/fields-core "Scaladex"
[link-maven]: https://maven-badges.herokuapp.com/maven-central/company.jap/fields-core_2.13 "Maven"
[link-ci]: https://github.com/jap-company/fields/actions?query=workflow%3A%22CI%22 "CI"
[link-scala-ukraine]: https://github.com/scala-ukraine/knowledge-base "Scala Ukraine"
[link-scaladoc]: https://jap-company.github.io/fields/api "Scaladoc"
[badge-ci]: https://github.com/jap-company/fields/workflows/CI/badge.svg "CI"
[badge-maven]: https://maven-badges.herokuapp.com/maven-central/company.jap/fields-core_2.13/badge.svg "Maven"
[badge-scaladex]: https://index.scala-lang.org/jap-company/fields/fields-core/latest-by-scala-version.svg?platform=jvm "Scaladex"
[badge-scala-ukraine]: https://img.shields.io/badge/Scala-Ukraine-EBD038?labelColor=4172CC "Scala Ukraine"
[badge-scaladoc]: https://img.shields.io/badge/scaladoc-read-brightgreen "Scaladoc"