https://github.com/simy4/coregex
A handy utility for generating strings that match given regular expression criteria.
https://github.com/simy4/coregex
jqwik junit-quickcheck regex regex-match regex-pattern regexp scalacheck scalacheck-gen scalacheck-generators vavr-test
Last synced: 3 months ago
JSON representation
A handy utility for generating strings that match given regular expression criteria.
- Host: GitHub
- URL: https://github.com/simy4/coregex
- Owner: SimY4
- License: apache-2.0
- Created: 2021-03-19T02:58:30.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2025-01-30T10:46:10.000Z (5 months ago)
- Last Synced: 2025-01-30T11:30:39.746Z (5 months ago)
- Topics: jqwik, junit-quickcheck, regex, regex-match, regex-pattern, regexp, scalacheck, scalacheck-gen, scalacheck-generators, vavr-test
- Language: Java
- Homepage:
- Size: 564 KB
- Stars: 3
- Watchers: 3
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# coregex
[](https://github.com/SimY4/coregex/actions?query=workflow%3A"Build+and+Test")
[](https://codecov.io/gh/SimY4/coregex)
[](https://opensource.org/licenses/Apache-2.0)
[](https://search.maven.org/search?q=g:com.github.simy4.coregex)
[](http://www.javadoc.io/doc/com.github.simy4.coregex/coregex-core)
A handy utility for generating strings that match given regular expression criteria.
# Supported generators
- [functionaljava-quickcheck](https://github.com/functionaljava/functionaljava)
- [Jqwik](https://jqwik.net/)
- [JUnit Quickcheck](https://pholser.github.io/junit-quickcheck)
- [Kotest](https://kotest.io/)
- [scalacheck](https://scalacheck.org/)
- [vavr-test](https://github.com/vavr-io/vavr-test)
# Usage
## Functionaljava Quickcheck
Include the following dependency into your project:
```groovy
testImplementation "com.github.simy4.coregex:coregex-functionaljava-quickcheck"
```
Use the provided `CoregexArbirary` class to generate a string that would match the regular expression predicate:
```java
@RunWith(PropertyTestRunner.class)
public class MyTest {
public Property myProperty() {
return property(CoregexArbitrary.of("[a-zA-Z]{3}"), str -> prop(3 == str.length()));
}
}
```
## Jqwik
Include the following dependency into your project:
```groovy
testImplementation "com.github.simy4.coregex:coregex-jqwik"
```
Use the provided `Regex` annotation to generate a string that would match the regular expression predicate:
```java
class MyTest {
@Property
void myProperty(@ForAll @Regex("[a-zA-Z]{3}") String str) {
assertThat(str).hasLength(3);
}
}
```
## JUnit Quickcheck
Include the following dependency into your project:
```groovy
testImplementation "com.github.simy4.coregex:coregex-junit-quickcheck"
```
Use the provided `Regex` annotation to generate a string that would match the regular expression predicate:
```java
@RunWith(JUnitQuickcheck.class)
public class MyTest {
@Property
public void myProperty(@Regex("[a-zA-Z]{3}") String str) {
assertThat(str).hasLength(3);
}
}
```
## Kotest
Include the following dependency into your project:
```groovy
testImplementation "com.github.simy4.coregex:coregex-kotest"
```
Use the provided `CoregexArbirary` class to generate a string that would match the regular expression predicate:
```kotlin
class MyTest : DescribeSpec({
describe("my property") {
it("should hold") {
checkAll(CoregexArbitrary.of("[a-zA-Z]{3}")) { str ->
str.length shouldBe 3
}
}
}
})
```
## scalacheck
Include the following dependency into your project:
```scala
libraryDependencies ++= Seq("com.github.simy4.coregex" %% "coregex-scalacheck" % Test)
```
Use the provided `CoregexInstances` trait to constrain string arbitraries:
```scala
object MySpecification extends Properties("MySpecification") with CoregexInstances {
property("my property") = forAll { (str: String Matching "[a-zA-Z]{3}") =>
3 == str.length
}
}
```
## vavr test
Include the following dependency into your project:
```groovy
testImplementation "com.github.simy4.coregex:coregex-vavr-test"
```
Use the provided `CoregexArbirary` class to generate a string that would match the regular expression predicate:
```java
class MyTest {
@Test
void myProperty() {
Property.def("my property")
.forAll(CoregexArbitrary.of("[a-zA-Z]{3}"))
.suchThat(str -> 3 == str.length())
.check();
}
}
```