jrest 0.1.1

The equivalent of Jest for Rust.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136

# Jrest

[![Crates.io Package](https://img.shields.io/crates/v/jrest?style=for-the-badge)](https://crates.io/crates/jrest)
[![Docs.rs Documentation](https://img.shields.io/docsrs/jrest/latest?style=for-the-badge)](https://docs.rs/jrest/latest/jrest)
[![Test Workflow Status](https://img.shields.io/github/actions/workflow/status/ivangabriele/jrest/test.yml?label=Tests&style=for-the-badge)](https://github.com/ivangabriele/jrest/actions?query=branch%3Amain+workflow%3ATest++)
[![Code Coverage](https://img.shields.io/codecov/c/github/ivangabriele/jrest/main?style=for-the-badge)](https://app.codecov.io/github/ivangabriele/jrest)

The equivalent of [Jest](https://jestjs.io) for Rust.

**Jrest** is a testing framework project for Rust, inspired by [Jest](https://jestjs.io),
easy to write and easy to read, with fancy diffs when tests fail.

> ⚠️ Be aware that this is a work in progress.
 
But it should get regular updates since I'm using it every week on my own open-source projects.

---

- [Installation](#installation)
- [Usage](#usage)
  - [`.to_be()`](#to_be)
  - [Primitives](#primitives)
    - [`.to_be_greater_than()`](#to_be_greater_than)
    - [`.to_be_greater_than_or_equal()`](#to_be_greater_than_or_equal)
    - [`.to_be_less_than()`](#to_be_less_than)
    - [`.to_be_less_than_or_equal()`](#to_be_less_than_or_equal)
  - [Strings](#strings)
    - [`.to_start_with()`](#to_start_with)
    - [`.to_start_with()`](#to_start_with-1)
- [Roadmap](#roadmap)

---

## Installation

```sh
cargo add --dev jrest
```

> **Note**<br>
> [https://crates.io/crates/rest](https://crates.io/crates/rest) is unfortunately squatted by a ghost.<br>
> That's why I had to name it **Jrest** instead of **Rest**.

## Usage

### `.to_be()`

```rust
use jrest::expect;

#[test]
fn test_something() {
    expect!("A &str").to_be("A &str");
    expect!("A String".to_string()).to_be("A String".to_string());
}
```

### Primitives

#### `.to_be_greater_than()`

```rust
use jrest::expect;

#[test]
fn test_something() {
    expect!(3).to_be_greater_than(2);
}
```

#### `.to_be_greater_than_or_equal()`

```rust
use jrest::expect;

#[test]
fn test_something() {
    expect!(3).to_be_greater_than_or_equal(2);
    expect!(3).to_be_greater_than_or_equal(3);
}
```

#### `.to_be_less_than()`

```rust
use jrest::expect;

#[test]
fn test_something() {
    expect!(2).to_be_less_than(3);
}
```

#### `.to_be_less_than_or_equal()`

```rust
use jrest::expect;

#[test]
fn test_something() {
    expect!(2).to_be_less_than_or_equal(3);
    expect!(2).to_be_less_than_or_equal(2);
}
```

### Strings

#### `.to_start_with()`

```rust
use jrest::expect;

#[test]
fn test_something() {
    expect!("cargo").to_end_with("go");
}
```

#### `.to_start_with()`

```rust
use jrest::expect;

#[test]
fn test_something() {
    expect!("cargo").to_start_with("car");
}
```

## Roadmap

- [ ] `.toContain()`
- [ ] `.toHaveLength()`
- [ ] `.toMatch()`
- [ ] `.toMatchObject()`
- [ ] `.toThrow()`