Skip to content
This repository was archived by the owner on Mar 7, 2024. It is now read-only.

Commit a0be4b4

Browse files
author
h1alexbel
committed
1 parent c31cf7b commit a0be4b4

1 file changed

Lines changed: 82 additions & 16 deletions

File tree

README.md

Lines changed: 82 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,82 @@
1-
# elegant
2-
This is a pre-configured template for your projects in Java, you can use it with any language, [more about it](https://h1alexbel.github.io/2023/01/21/maintainable-project-template.html)
3-
4-
## Tools:
5-
- [Rultor](https://www.rultor.com/) for CI/CD.
6-
- [0pdd](https://www.0pdd.com/) for issue management.
7-
- [Renovate](https://www.mend.io/free-developer-tools/renovate/) for dependency control.
8-
- [xcop](https://www.yegor256.com/2017/08/29/xcop.html) GitHub action for XML style check.
9-
10-
## How to use?
11-
- Configure actions in `workflows` folder.
12-
- [Configure](https://doc.rultor.com/reference.html) the `@rultor`.
13-
- [Configure](https://www.yegor256.com/2017/04/05/pdd-in-action.html) the `0pdd`.
14-
- [Configure](https://github.com/marketplace/renovate) the `renovate`.
15-
16-
And you're good to go!
1+
<img alt="logo" src="https://eo-cqrs.github.io/.github/eo-cqrs.svg" height="100px" />
2+
3+
[![Managed By Self XDSD](https://self-xdsd.com/b/mbself.svg)](https://self-xdsd.com/p/eo-cqrs/json-matchers?provider=github)
4+
5+
[![EO principles respected here](https://www.elegantobjects.org/badge.svg)](https://www.elegantobjects.org)
6+
[![DevOps By Rultor.com](https://www.rultor.com/b/eo-cars/json-matchers)](https://www.rultor.com/p/eo-cqrs/json-matchers)
7+
[![We recommend IntelliJ IDEA](https://www.elegantobjects.org/intellij-idea.svg)](https://www.jetbrains.com/idea/)
8+
<br>
9+
10+
[![mvn](https://github.com/eo-cqrs/json-matchers/actions/workflows/mvn.yaml/badge.svg)](https://github.com/eo-cqrs/json-matchers/actions/workflows/mvn.yaml)
11+
[![maven central](http://maven-badges.herokuapp.com/maven-central/io.github.eo-cqrs/json-matchers/badge.svg)](https://search.maven.org/artifact/io.github.eo-cqrs/json-matchers)
12+
[![javadoc](https://javadoc.io/badge2/io.github.eo-cqrs/json-matchers/javadoc.svg)](https://javadoc.io/doc/io.github.eo-cqrs/json-matchers)
13+
[![codecov](https://codecov.io/gh/eo-cqrs/json-matchers/branch/master/graph/badge.svg?token=biuAgXDIEX)](https://codecov.io/gh/eo-cqrs/json-matchers)
14+
15+
[![Hits-of-Code](https://hitsofcode.com/github/eo-cqrs/json-matchers)](https://hitsofcode.com/view/github/eo-cqrs/json-matchers)
16+
[![Lines-of-Code](https://tokei.rs/b1/github/eo-cqrs/json-matchers)](https://github.com/eo-cqrs/json-matchers)
17+
[![PDD status](http://www.0pdd.com/svg?name=eo-cqrs/json-matchers)](http://www.0pdd.com/p?name=eo-cqrs/json-matchers)
18+
[![License](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/eo-cqrs/json-matchers/blob/master/LICENSE.txt)
19+
20+
Project architect: [@h1alexbel](https://github.com/h1alexbel)
21+
22+
Hamcrest JSON Matchers.
23+
24+
**Motivation**. We are not happy dealing with JSON matching and assertions in procedural way.
25+
<br>
26+
We offer everything through simple, declarative Hamcrest Matchers.
27+
28+
**Principles**. These are the [design principles](https://www.elegantobjects.org/#principles) behind EOkson.
29+
30+
**How to use**. All you need is this (get the latest
31+
version [here](https://search.maven.org/artifact/io.github.eo-cqrs/json-matchers)):
32+
33+
Maven:
34+
```xml
35+
<dependency>
36+
<groupId>io.github.eo-cqrs</groupId>
37+
<artifactId>json-matchers</artifactId>
38+
<scope>test</scope>
39+
</dependency>
40+
```
41+
42+
Gradle:
43+
```groovy
44+
dependencies {
45+
testCompile 'io.github.eo-cqrs:json-matchers:<version>'
46+
}
47+
```
48+
49+
### `JsonEqualTo`
50+
Simple, Equality Matcher:
51+
52+
```java
53+
new JsonEqualTo(json)
54+
.matches("{\"test\": \"123\"}")
55+
);
56+
```
57+
```java
58+
final String compare = new SmartJson(
59+
new MutableJson()
60+
.with("test", "123")
61+
.with("test-node", "true")
62+
).pretty();
63+
new JsonEqualTo(json)
64+
.matches(compare);
65+
```
66+
67+
Each submitted JSON to `JsonEqualTo` transformed into **pretty string**.
68+
69+
## How to Contribute
70+
71+
Fork repository, make changes, send us a [pull request](https://www.yegor256.com/2014/04/15/github-guidelines.html).
72+
We will review your changes and apply them to the `master` branch shortly,
73+
provided they don't violate our quality standards. To avoid frustration,
74+
before sending us your pull request please run full Maven build:
75+
76+
```bash
77+
$ mvn clean install
78+
```
79+
80+
You will need Maven 3.8.7+ and Java 17+.
81+
82+
Our [rultor image](https://github.com/eo-cqrs/eo-kafka-rultor-image) for CI/CD.

0 commit comments

Comments
 (0)