Skip to content
This repository was archived by the owner on Jan 24, 2025. It is now read-only.

Commit 3570798

Browse files
ghostbuster91ghostbuster91
committed
Release 0.5.4
1 parent b9027e4 commit 3570798

File tree

9 files changed

+42
-23
lines changed

9 files changed

+42
-23
lines changed

‎generated-docs/out/integrations/cats.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,13 @@ This module contains integration layer between [org.typelevel.cats](https://gith
55
## sbt
66

77
```scala
8-
"com.softwaremill.diffx" %% "diffx-cats" % "0.5.3" % Test
8+
"com.softwaremill.diffx" %% "diffx-cats" % "0.5.4" % Test
99
```
1010

1111
## mill
1212

1313
```scala
14-
ivy"com.softwaremill.diffx::diffx-cats::0.5.3"
14+
ivy"com.softwaremill.diffx::diffx-cats::0.5.4"
1515
```
1616

1717
## Usage
@@ -39,7 +39,13 @@ compare(t1, t2)
3939
// "ints" -> DiffResultObject(
4040
// name = "List",
4141
// fields = ListMap(
42-
// "0" -> DiffResultString(diffs = List(DiffResultValue(left = "a", right = "b")))
42+
// "0" -> DiffResultString(
43+
// diffs = List(
44+
// DiffResultStringLine(
45+
// diffs = List(DiffResultValue(left = "a", right = "b"))
46+
// )
47+
// )
48+
// )
4349
// )
4450
// )
4551
// )

‎generated-docs/out/integrations/refined.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,13 @@ This module contains integration layer between [eu.timepit.refined](https://gith
55
## sbt
66

77
```scala
8-
"com.softwaremill.diffx" %% "diffx-refined" % "0.5.3" % Test
8+
"com.softwaremill.diffx" %% "diffx-refined" % "0.5.4" % Test
99
```
1010

1111
## mill
1212

1313
```scala
14-
ivy"com.softwaremill.diffx::diffx-refined::0.5.3"
14+
ivy"com.softwaremill.diffx::diffx-refined::0.5.4"
1515
```
1616

1717
## Usage
@@ -42,7 +42,11 @@ compare(t1, t2)
4242
// fields = ListMap(
4343
// "posInt" -> IdenticalValue(value = 1),
4444
// "nonEmptyString" -> DiffResultString(
45-
// diffs = List(DiffResultValue(left = "foo", right = "bar"))
45+
// diffs = List(
46+
// DiffResultStringLine(
47+
// diffs = List(DiffResultValue(left = "foo", right = "bar"))
48+
// )
49+
// )
4650
// )
4751
// )
4852
// )

‎generated-docs/out/integrations/tagging.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,13 @@ This module contains integration layer between [com.softwaremill.common.tagging]
55
## sbt
66

77
```scala
8-
"com.softwaremill.diffx" %% "diffx-tagging" % "0.5.3"
8+
"com.softwaremill.diffx" %% "diffx-tagging" % "0.5.4"
99
```
1010

1111
## mill
1212

1313
```scala
14-
ivy"com.softwaremill.diffx::diffx-tagging::0.5.3"
14+
ivy"com.softwaremill.diffx::diffx-tagging::0.5.4"
1515
```
1616

1717
## Usage

‎generated-docs/out/test-frameworks/munit.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,13 @@ To use with munit, add following dependency:
55
## sbt
66

77
```scala
8-
"com.softwaremill.diffx" %% "diffx-munit" % "0.5.3" % Test
8+
"com.softwaremill.diffx" %% "diffx-munit" % "0.5.4" % Test
99
```
1010

1111
## mill
1212

1313
```scala
14-
ivy"com.softwaremill.diffx::diffx-munit::0.5.3"
14+
ivy"com.softwaremill.diffx::diffx-munit::0.5.4"
1515
```
1616

1717
## Usage

‎generated-docs/out/test-frameworks/scalatest.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,13 @@ To use with scalatest, add the following dependency:
55
## sbt
66

77
```scala
8-
"com.softwaremill.diffx" %% "diffx-scalatest" % "0.5.3" % Test
8+
"com.softwaremill.diffx" %% "diffx-scalatest" % "0.5.4" % Test
99
```
1010

1111
## mill
1212

1313
```scala
14-
ivy"com.softwaremill.diffx::diffx-scalatest::0.5.3"
14+
ivy"com.softwaremill.diffx::diffx-scalatest::0.5.4"
1515
```
1616

1717
## Usage

‎generated-docs/out/test-frameworks/specs2.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,13 @@ To use with specs2, add the following dependency:
55
## sbt
66

77
```scala
8-
"com.softwaremill.diffx" %% "diffx-specs2" % "0.5.3" % Test
8+
"com.softwaremill.diffx" %% "diffx-specs2" % "0.5.4" % Test
99
```
1010

1111
## mill
1212

1313
```scala
14-
ivy"com.softwaremill.diffx::diffx-specs2::0.5.3"
14+
ivy"com.softwaremill.diffx::diffx-specs2::0.5.4"
1515
```
1616

1717
## Usage

‎generated-docs/out/test-frameworks/utest.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,13 @@ To use with utest, add following dependency:
55
## sbt
66

77
```scala
8-
"com.softwaremill.diffx" %% "diffx-utest" % "0.5.3" % Test
8+
"com.softwaremill.diffx" %% "diffx-utest" % "0.5.4" % Test
99
```
1010

1111
## mill
1212

1313
```scala
14-
ivy"com.softwaremill.diffx::diffx-utest::0.5.3"
14+
ivy"com.softwaremill.diffx::diffx-utest::0.5.4"
1515
```
1616

1717
## Usage

‎generated-docs/out/usage/output.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,17 +15,16 @@ In <b>File | Settings | Editor | Color Scheme | Console Colors | Console | Error
1515

1616
## colors & signs
1717

18-
I found it confusing to use the terms `expected`/`actual` as there seems to be no golden rule whether to keep expected on the right side or on the left side.
19-
Because of that, diffx refers to the values that are compared as `left` and `right` value.
18+
Diffx refers to the values that are compared as `left` and `right`, but you can think of them as `actual` and `expected`.
2019

2120
By default, the difference is shown in the following form:
2221

2322
`leftColor(leftValue) -> rightColor(rightValue)`
2423

25-
which in terms of missing/additional values e.g. in collections looks as follows:
24+
When comparing collection types the difference is calculated against the `right` value
2625

27-
`leftColor(additionalValue)` in case the value was present on the left-hand side and absent on the right side
28-
`rightColor(missingValue)` in case the value was absent on the left-hand side and present on the right side
26+
`rightColor(additionalValue)` when there is an additional entity on the left-hand side
27+
`leftColor(missingValue)` when there is a missing entity on the left-hand side
2928

3029

3130
Where, by default, `rightColor` is green and `leftColor` is red.
@@ -54,7 +53,11 @@ val result = compare(Person("Bob", 23), Person("Alice", 23))
5453
// name = "Person",
5554
// fields = ListMap(
5655
// "name" -> DiffResultString(
57-
// diffs = List(DiffResultValue(left = "Bob", right = "Alice"))
56+
// diffs = List(
57+
// DiffResultStringLine(
58+
// diffs = List(DiffResultValue(left = "Bob", right = "Alice"))
59+
// )
60+
// )
5861
// ),
5962
// "age" -> IdenticalValue(value = 23)
6063
// )

‎generated-docs/out/usage/sequences.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,13 @@ val bob = Person("1","Bob")
5858
compare(Map("1" -> bob), Map("2" -> bob))
5959
// res3: DiffResult = DiffResultMap(
6060
// entries = Map(
61-
// DiffResultString(diffs = List(DiffResultValue(left = "1", right = "2"))) -> DiffResultObject(
61+
// DiffResultString(
62+
// diffs = List(
63+
// DiffResultStringLine(
64+
// diffs = List(DiffResultValue(left = "1", right = "2"))
65+
// )
66+
// )
67+
// ) -> DiffResultObject(
6268
// name = "Person",
6369
// fields = ListMap(
6470
// "id" -> IdenticalValue(value = "1"),

0 commit comments

Comments
 (0)