Skip to content

Commit

Permalink
smallfix
Browse files Browse the repository at this point in the history
  • Loading branch information
odd-poet committed Dec 13, 2024
1 parent d90d041 commit f76ff29
Showing 1 changed file with 31 additions and 26 deletions.
57 changes: 31 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,27 @@
# kotlin-expect
# kotlin-expect

[![Build Status](https://travis-ci.org/odd-poet/kotlin-expect.svg?branch=master)](https://travis-ci.org/odd-poet/kotlin-expect)[![codecov](https://codecov.io/gh/odd-poet/kotlin-expect/branch/master/graph/badge.svg)](https://codecov.io/gh/odd-poet/kotlin-expect)

`kotlin-expect` is a assertion library for kotlin test. it's inspried by [Rspec Expectation].


## Setup
## Setup

```gradle
dependencies {
testCompile("net.oddpoet:kotlin-expect:1.3.1")
testCompile("net.oddpoet:kotlin-expect:1.3.2")
}
```

## Basic Usage
## Basic Usage

### `expect(s).to`

You can write an assertion for a subject in the form `expect(subject).to`.
You can write an assertion for a subject in the form `expect(subject).to`.

```kotlin
val list = listOf(1, 2, 3)
expect(list).to.haveSizeOf(3)
expect(list).to.satisfy { size == 3}
expect(list).to.satisfy { size == 3 }
expect(list).to.not.contain(5)
expect(list).to.containAll { it < 10 }
expect(list).to.not.beInstanceOf(Set::class)
Expand Down Expand Up @@ -49,6 +49,7 @@ expect(aList) {
it.should.containAny { it.lenngth < 2 }
}
```

### `expect { }.throws()`

An assertion for an exception can be written in the form `expect { ... }.throws()`.
Expand All @@ -67,7 +68,7 @@ expect {
```

## Write own your assertion

`Kotlin-expect` has built-in assertions for java base types(`String`, `Collection`, `Map`, `Number` and so on).
You can define new assertions for your class.
An assertion for a class is defined as an extension of the `Expect` class.
Expand All @@ -77,39 +78,43 @@ An assertion for a class is defined as an extension of the `Expect` class.
```kotlin
// for your classes
abstract class Person(
val name: String,
val birthdate: LocalDate)
val name: String,
val birthdate: LocalDate
)

class Employee(
name: String, birthdate: LocalDate,
val empNo: String?,
val dept: String?) : Person(name, birthdate)
name: String, birthdate: LocalDate,
val empNo: String?,
val dept: String?
) : Person(name, birthdate)
```

```kotlin
// you can write your own assertion
fun <T : Person> Expect<T>.beUnderage() =
satisfyThat("be underage") {
it.birthdate.plusYears(19) > LocalDate.now()
}
satisfyThat("be underage") {
it.birthdate.plusYears(19) > LocalDate.now()
}

fun Expect<Employee>.beValid() =
satisfyThat("be valid") {
it.empNo != null && it.dept != null
}
satisfyThat("be valid") {
it.empNo != null && it.dept != null
}

fun Expect<Employee>.beAssignedTo(dept: String) =
satisfyThat("be assigned to $dept") {
it.dept == dept
}
satisfyThat("be assigned to $dept") {
it.dept == dept
}
```

```kotlin
// then you can use your assertion.
val emp = Employee(
"yunsang.choi",
LocalDate.of(1976, 4, 2),
"X00000",
"DevTeam")
"yunsang.choi",
LocalDate.of(1976, 4, 2),
"X00000",
"DevTeam"
)
expect(emp) {
it.should.beValid()
it.should.not.beUnderage()
Expand Down

0 comments on commit f76ff29

Please sign in to comment.