https://github.com/natiginfo/checkpoint
🛂 An easy to use input validator ✅
https://github.com/natiginfo/checkpoint
checkpoint dsl java kotlin kotlin-dsl validator
Last synced: 2 months ago
JSON representation
🛂 An easy to use input validator ✅
- Host: GitHub
- URL: https://github.com/natiginfo/checkpoint
- Owner: natiginfo
- License: apache-2.0
- Created: 2020-03-18T16:34:34.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-09-06T06:37:22.000Z (10 months ago)
- Last Synced: 2025-04-12T04:41:41.310Z (3 months ago)
- Topics: checkpoint, dsl, java, kotlin, kotlin-dsl, validator
- Language: Kotlin
- Homepage: https://www.natigbabayev.com/Checkpoint
- Size: 315 KB
- Stars: 23
- Watchers: 1
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://www.codefactor.io/repository/github/natiginfo/checkpoint)
# Checkpoint
Multipurpose and customizable validation library.
## Getting started
### Download
Maven:
```xml
com.natigbabayev.checkpoint
checkpoint-core
0.6.0
com.natigbabayev.checkpoint
checkpoint-rxjava2
0.6.0
```
Gradle:
Core:
```groovy
implementation 'com.natigbabayev.checkpoint:checkpoint-core:0.6.0'
// Optional RxJava 2 support:
implementation 'com.natigbabayev.checkpoint:checkpoint-rxjava2:0.6.0'
```
Snapshots of the development version are available in [Sonatype's `snapshots` repository][snap].
### Usage
Checkpoint allows you to perform validation checks for given input. [`Checkpoint`][checkpoint] is generic collection of
[rules with boolean output][default-rule]. You can create a new instance of Checkpoint either by using builder or DSL:
#### DSL
```kotlin
fun main() {
val pinCheckpoint = checkpoint {
addRule(
lengthRangeRule(minLength = 4, maxLength = 6) {
println("Must contain min. 4, max 6 characters")
}
)
addRule {
isValid { it.contains("@") || it.contains("!") }
whenInvalid { println("Must contain at least one of the @ or ! characters.") }
}
}
pinCheckpoint.canPass("123") // returns false and invokes whenInvalid()
pinCheckpoint.canPass("1234") // returns false and invokes whenInvalid()
pinCheckpoint.canPass("1234@6!") // returns false and invokes whenInvalid()
pinCheckpoint.canPass("1234@6") // returns true
}
```
#### Builder
```kotlin
fun main() {
val pinCheckpoint = Checkpoint.Builder()
.addRule(
LengthRangeRule.Builder()
.minLength(4)
.maxLength(6)
.whenInvalid { println("Must contain min. 4, max 6 characters") }
.build()
)
.addRule(
DefaultRuleBuilder()
.isValid { it.contains("@") || it.contains("!") }
.whenInvalid { println("Must contain at least one of the @ or ! characters.") }
.build()
)
.build()
pinCheckpoint.canPass("123") // returns false and invokes whenInvalid()
pinCheckpoint.canPass("1234") // returns false and invokes whenInvalid()
pinCheckpoint.canPass("1234@6!") // returns false and invokes whenInvalid()
pinCheckpoint.canPass("1234@6") // returns true
}
```
### Base classes
Checkpoint has several base classes which can be used for creating custom checkpoints and rules:
- [`com.natigbabayev.checkpoint.core.Rule`][rule]
- [`com.natigbabayev.checkpoint.core.DefaultRule`][default-rule]
Creating new rule:
```kotlin
class NotEmpty(override val callback: Callback) : DefaultRule() {
override fun isValid(input: String): Boolean {
return input.isNotEmpty()
}
}
fun main() {
val rule = NotEmpty(
Rule.Callback { println("Cannot be empty") }
)
val checkpoint = Checkpoint.Builder()
.addRule(rule)
.build()
}
```
## License
```
Copyright 2020 Natig Babayev
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
```
[snap]: https://oss.sonatype.org/content/repositories/snapshots/
[rule]: https://www.natigbabayev.com/Checkpoint/javadoc/checkpoint-core-abstraction/com.natigbabayev.checkpoint.core/-rule/index.html
[default-rule]: https://www.natigbabayev.com/Checkpoint/javadoc/checkpoint-core-abstraction/com.natigbabayev.checkpoint.core/-default-rule/index.html
[checkpoint]: https://www.natigbabayev.com/Checkpoint/javadoc/checkpoint-core-abstraction/com.natigbabayev.checkpoint.core/-checkpoint/index.html