ClinQ
Simple yet interesting validation mini-framework
Features
- Declarative checks
ClinQ.checker(Integer.class)
.with(i -> i % 2 == 0)
.with(i -> i > 100)
.with(i -> i < 1000)
.check(myInteger)
- Mapping on checks addition
ClinQ.checker(Integer.class)
.and(i -> i % 2 == 0)
.map(Double::valueOf) // Map integer to double and do further checks with it
.and(d -> Math.pow(d, 3.5) > 500)
.check(myInteger);
- Nested checks
For example we have a sample data transfer object:
public class SampleDto {
private final String name;
private final List<Integer> scores;
public String getName() {
return name;
}
public List<Integer> getScores() {
return scores;
}
public SampleDto(String name, List<Integer> scores) {
this.name = name;
this.scores = scores;
}
}
Then we can validate field-by-field using the nested checkers:
var checker =
ClinQ.checker(SampleDto.class)
.with(Objects::nonNull)
.with(SampleDto::getName, nameChecker ->
nameChecker
.with(Objects::nonNull)
.with(str -> str.length() > 2))
.with(SampleDto::getScores, scoresChecker ->
scoresChecker
.with(Objects::nonNull)
.with(scores -> scores.size() > 2)
.with(scores -> scores.stream().allMatch(score -> score > 0)))
.with(dto -> dto.getName().length() == dto.getScores().size());
SampleDto one = new SampleDto("hi!", List.of(1, 2, 3));
Assertions.assertTrue(checker.check(one));
Use it
Currently, this library can be fetched via JitPack:
Here are specified instructions for Gradle (for maven etc. they can be found at JitPack - just click on the badge above)
Step 1. Add the JitPack repository to your build file
allprojects {
repositories {
...
maven { url 'https://jitpack.io' }
}
}
Step 2. Add the dependency
dependencies {
implementation 'com.github.theseems:ClinQ:v1.0-SNAPSHOT'
}
Todo
- Debug tools (peek tokens, trace, etc.)
- Propagation strategy: should we fail? where?
- Dependent checks: make check depend on others.
31 Jan 3, 2023
2 Feb 18, 2022
2 Oct 19, 2021
6 Mar 4, 2022
15 Dec 27, 2022
41 Dec 25, 2022
8 Jul 17, 2022
188 Dec 17, 2022
10 Sep 17, 2022
1k Jan 1, 2023