Add samples for pathExpectations of api-infix (#999) (#1003)

robstoll · Oct 12, 2021 · f766284 · f766284
1 parent 1d8ffce
commit f766284
Show file tree

Hide file tree

Showing 3 changed files with 500 additions and 3 deletions.
diff --git a/...m-api-infix-en_GB-jvm/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/pathAssertions.kt b/...m-api-infix-en_GB-jvm/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/pathAssertions.kt
@@ -74,6 +74,8 @@ infix fun <T : Path> Expect<T>.endsNotWith(expected: Path): Expect<T> =
  *
  * @return an [Expect] for the subject of `this` expectation.
  *
+ * @sample ch.tutteli.atrium.api.infix.en_GB.samples.PathExpectationSamples.toExist
+ *
  * @since 0.12.0
  */
 infix fun <T : Path> Expect<T>.toBe(@Suppress("UNUSED_PARAMETER") existing: existing): Expect<T> =
@@ -89,6 +91,8 @@ infix fun <T : Path> Expect<T>.toBe(@Suppress("UNUSED_PARAMETER") existing: exis
  *
  * @return an [Expect] for the subject of `this` expectation.
  *
+ * @sample ch.tutteli.atrium.api.infix.en_GB.samples.PathExpectationSamples.notToExist
+ *
  * @since 0.12.0
  */
 infix fun <T : Path> Expect<T>.notToBe(@Suppress("UNUSED_PARAMETER") existing: existing): Expect<T> =
@@ -102,6 +106,8 @@ infix fun <T : Path> Expect<T>.notToBe(@Suppress("UNUSED_PARAMETER") existing: e
  *
  * @return The newly created [Expect] for the extracted feature.
  *
+ * @sample ch.tutteli.atrium.api.infix.en_GB.samples.PathExpectationSamples.extensionFeature
+ *
  * @since 0.12.0
  */
 val <T : Path> Expect<T>.extension: Expect<String>
@@ -116,6 +122,8 @@ val <T : Path> Expect<T>.extension: Expect<String>
  *
  * @return an [Expect] for the subject of `this` expectation.
  *
+ * @sample ch.tutteli.atrium.api.infix.en_GB.samples.PathExpectationSamples.extension
+ *
  * @since 0.12.0
  */
 infix fun <T : Path> Expect<T>.extension(assertionCreator: Expect<String>.() -> Unit): Expect<T> =
@@ -129,6 +137,8 @@ infix fun <T : Path> Expect<T>.extension(assertionCreator: Expect<String>.() ->
  *
  * @return The newly created [Expect] for the extracted feature.
  *
+ * @sample ch.tutteli.atrium.api.infix.en_GB.samples.PathExpectationSamples.fileNameFeature
+ *
  * @since 0.12.0
  */
 val <T : Path> Expect<T>.fileName: Expect<String>
@@ -143,6 +153,8 @@ val <T : Path> Expect<T>.fileName: Expect<String>
  *
  * @return an [Expect] for the subject of `this` expectation.
  *
+ * @sample ch.tutteli.atrium.api.infix.en_GB.samples.PathExpectationSamples.fileName
+ *
  * @since 0.12.0
  */
 infix fun <T : Path> Expect<T>.fileName(assertionCreator: Expect<String>.() -> Unit): Expect<T> =
@@ -156,6 +168,8 @@ infix fun <T : Path> Expect<T>.fileName(assertionCreator: Expect<String>.() -> U
  *
  * @return The newly created [Expect] for the extracted feature.
  *
+ * @sample ch.tutteli.atrium.api.infix.en_GB.samples.PathExpectationSamples.fileNameWithoutExtension
+ *
  * @since 0.12.0
  */
 val <T : Path> Expect<T>.fileNameWithoutExtension: Expect<String>
@@ -182,6 +196,8 @@ infix fun <T : Path> Expect<T>.fileNameWithoutExtension(assertionCreator: Expect
  *
  * @return The newly created [Expect] for the extracted feature.
  *
+ * @sample ch.tutteli.atrium.api.infix.en_GB.samples.PathExpectationSamples.parentFeature
+ *
  * @since 0.12.0
  */
 val <T : Path> Expect<T>.parent: Expect<Path>
@@ -194,6 +210,8 @@ val <T : Path> Expect<T>.parent: Expect<Path>
  *
  * @return an [Expect] for the subject of `this` expectation.
  *
+ * @sample ch.tutteli.atrium.api.infix.en_GB.samples.PathExpectationSamples.parent
+ *
  * @since 0.12.0
  */
 infix fun <T : Path> Expect<T>.parent(assertionCreator: Expect<Path>.() -> Unit): Expect<T> =
@@ -206,6 +224,8 @@ infix fun <T : Path> Expect<T>.parent(assertionCreator: Expect<Path>.() -> Unit)
  *
  * @return The newly created [Expect] for the extracted feature.
  *
+ * @sample ch.tutteli.atrium.api.infix.en_GB.samples.PathExpectationSamples.resolveFeature
+ *
  * @since 0.12.0
  */
 infix fun <T : Path> Expect<T>.resolve(other: String): Expect<Path> =
@@ -221,6 +241,8 @@ infix fun <T : Path> Expect<T>.resolve(other: String): Expect<Path> =
  *
  * @return The newly created [Expect] for the extracted feature.
  *
+ * @sample ch.tutteli.atrium.api.infix.en_GB.samples.PathExpectationSamples.resolve
+ *
  * @since 0.12.0
  */
 infix fun <T : Path> Expect<T>.resolve(path: PathWithCreator<Path>): Expect<T> =
@@ -249,6 +271,8 @@ fun <E> path(path: String, assertionCreator: Expect<E>.() -> Unit): PathWithCrea
  *
  * @return an [Expect] for the subject of `this` expectation.
  *
+ * @sample ch.tutteli.atrium.api.infix.en_GB.samples.PathExpectationSamples.toBeReadable
+ *
  * @since 0.12.0
  */
 infix fun <T : Path> Expect<T>.toBe(@Suppress("UNUSED_PARAMETER") readable: readable): Expect<T> =
@@ -266,6 +290,8 @@ infix fun <T : Path> Expect<T>.toBe(@Suppress("UNUSED_PARAMETER") readable: read
  *
  * @return an [Expect] for the subject of `this` expectation.
  *
+ * @sample ch.tutteli.atrium.api.infix.en_GB.samples.PathExpectationSamples.toBeWritable
+ *
  * @since 0.12.0
  */
 infix fun <T : Path> Expect<T>.toBe(@Suppress("UNUSED_PARAMETER") writable: writable): Expect<T> =
@@ -287,6 +313,8 @@ infix fun <T : Path> Expect<T>.toBe(@Suppress("UNUSED_PARAMETER") writable: writ
  *
  * @return an [Expect] for the subject of `this` expectation.
  *
+ * @sample ch.tutteli.atrium.api.infix.en_GB.samples.PathExpectationSamples.toBeExecutable
+ *
  * @since 0.14.0
  */
 infix fun <T : Path> Expect<T>.toBe(@Suppress("UNUSED_PARAMETER") executable: executable): Expect<T> =
@@ -307,6 +335,8 @@ infix fun <T : Path> Expect<T>.toBe(@Suppress("UNUSED_PARAMETER") executable: ex
  *
  * @return an [Expect] for the subject of `this` expectation.
  *
+ * @sample ch.tutteli.atrium.api.infix.en_GB.samples.PathExpectationSamples.toBeARegularFile
+ *
  * @since 0.12.0
  */
 infix fun <T : Path> Expect<T>.toBe(@Suppress("UNUSED_PARAMETER") aRegularFile: aRegularFile): Expect<T> =
@@ -327,6 +357,8 @@ infix fun <T : Path> Expect<T>.toBe(@Suppress("UNUSED_PARAMETER") aRegularFile:
  *
  * @return an [Expect] for the subject of `this` expectation.
  *
+ * @sample ch.tutteli.atrium.api.infix.en_GB.samples.PathExpectationSamples.toBeADirectory
+ *
  * @since 0.12.0
  */
 infix fun <T : Path> Expect<T>.toBe(@Suppress("UNUSED_PARAMETER") aDirectory: aDirectory): Expect<T> =
@@ -343,7 +375,7 @@ infix fun <T : Path> Expect<T>.toBe(@Suppress("UNUSED_PARAMETER") aDirectory: aD
  *
  * @return an [Expect] for the subject of `this` expectation.
  *
- * @sample ch.tutteli.atrium.api.infix.en_GB.samples.deprecated.PathAssertionSamples.toBeASymbolicLink
+ * @sample ch.tutteli.atrium.api.infix.en_GB.samples.PathExpectationSamples.toBeASymbolicLink
  *
  * @since 0.16.0
  */
@@ -357,6 +389,8 @@ infix fun <T : Path> Expect<T>.toBe(@Suppress("UNUSED_PARAMETER") aSymbolicLink:
  *
  * @return an [Expect] for the subject of `this` expectation.
  *
+ * @sample ch.tutteli.atrium.api.infix.en_GB.samples.PathExpectationSamples.toBeAbsolute
+ *
  * @since 0.14.0
  */
 infix fun <T : Path> Expect<T>.toBe(@Suppress("UNUSED_PARAMETER") absolute: absolute): Expect<T> =
@@ -369,6 +403,8 @@ infix fun <T : Path> Expect<T>.toBe(@Suppress("UNUSED_PARAMETER") absolute: abso
  *
  * @return an [Expect] for the subject of `this` expectation.
  *
+ * @sample ch.tutteli.atrium.api.infix.en_GB.samples.PathExpectationSamples.toBeRelative
+ *
  * @since 0.14.0
  */
 infix fun <T : Path> Expect<T>.toBe(@Suppress("UNUSED_PARAMETER") relative: relative): Expect<T> =
@@ -446,7 +482,7 @@ fun directoryEntries(entry: String, vararg otherEntries: String) = DirectoryEntr
  *
  * @return an [Expect] for the subject of `this` expectation.
  *
- * @sample ch.tutteli.atrium.api.infix.en_GB.samples.deprecated.PathAssertionSamples.toBeAnEmptyDirectory
+ * @sample ch.tutteli.atrium.api.infix.en_GB.samples.PathExpectationSamples.toBeAnEmptyDirectory
  *
  * @since 0.16.0
  */

diff --git a/...api-infix-en_GB-jvm/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/pathExpectations.kt b/...api-infix-en_GB-jvm/src/main/kotlin/ch/tutteli/atrium/api/infix/en_GB/pathExpectations.kt
@@ -16,6 +16,8 @@ import java.nio.file.Path
  *
  * @return an [Expect] for the subject of `this` expectation.
  *
+ * @sample ch.tutteli.atrium.api.infix.en_GB.samples.PathExpectationSamples.toStartWith
+ *
  * @since 0.17.0
  */
 infix fun <T : Path> Expect<T>.toStartWith(expected: Path): Expect<T> =
@@ -26,6 +28,8 @@ infix fun <T : Path> Expect<T>.toStartWith(expected: Path): Expect<T> =
  *
  * @return an [Expect] for the subject of `this` expectation.
  *
+ * @sample ch.tutteli.atrium.api.infix.en_GB.samples.PathExpectationSamples.notToStartWith
+ *
  * @since 0.17.0
  */
 infix fun <T : Path> Expect<T>.notToStartWith(expected: Path): Expect<T> =
@@ -36,6 +40,8 @@ infix fun <T : Path> Expect<T>.notToStartWith(expected: Path): Expect<T> =
  *
  * @return an [Expect] for the subject of `this` expectation.
  *
+ * @sample ch.tutteli.atrium.api.infix.en_GB.samples.PathExpectationSamples.toEndWith
+ *
  * @since 0.17.0
  */
 infix fun <T : Path> Expect<T>.toEndWith(expected: Path): Expect<T> =
@@ -47,6 +53,8 @@ infix fun <T : Path> Expect<T>.toEndWith(expected: Path): Expect<T> =
  * @param expected The [Path] provided to the assertion
  * @return an [Expect] for the subject of `this` expectation.
  *
+ * @sample ch.tutteli.atrium.api.infix.en_GB.samples.PathExpectationSamples.notToEndWith
+ *
  * @since 0.17.0
  */
 infix fun <T : Path> Expect<T>.notToEndWith(expected: Path): Expect<T> =
@@ -70,6 +78,8 @@ infix fun <T : Path> Expect<T>.notToEndWith(expected: Path): Expect<T> =
  * @see [directoryEntries]
  * @see [hasDirectoryEntry]
  *
+ * @sample ch.tutteli.atrium.api.infix.en_GB.samples.PathExpectationSamples.toHaveTheDirectoryEntries
+ *
  * @since 0.17.0
  */
 infix fun <T : Path> Expect<T>.toHave(directoryEntries: DirectoryEntries) =
@@ -81,6 +91,8 @@ infix fun <T : Path> Expect<T>.toHave(directoryEntries: DirectoryEntries) =
  *
  * @return an [Expect] for the subject of `this` expectation.
  *
+ * @sample ch.tutteli.atrium.api.infix.en_GB.samples.PathExpectationSamples.toHaveTheSameTextualContentAs
+ *
  * @since 0.17.0
  */
 infix fun <T : Path> Expect<T>.toHaveTheSameTextualContentAs(
@@ -95,7 +107,9 @@ infix fun <T : Path> Expect<T>.toHaveTheSameTextualContentAs(
  *
  * @return an [Expect] for the subject of `this` expectation.
  *
- * @since 0.17.0
+ * @sample ch.tutteli.atrium.api.infix.en_GB.samples.PathExpectationSamples.toHaveTheSameTextualContentAsPathWithEncoding
+ *
+@since 0.17.0
  */
 infix fun <T : Path> Expect<T>.toHaveTheSameTextualContentAs(pathWithEncoding: PathWithEncoding): Expect<T> =
     _logicAppend {
@@ -108,6 +122,8 @@ infix fun <T : Path> Expect<T>.toHaveTheSameTextualContentAs(pathWithEncoding: P
  *
  * @return an [Expect] for the subject of `this` expectation.
  *
+ * @sample ch.tutteli.atrium.api.infix.en_GB.samples.PathExpectationSamples.toHaveTheSameBinaryContentAs
+ *
  * @since 0.17.0
  */
 infix fun <T : Path> Expect<T>.toHaveTheSameBinaryContentAs(targetPath: Path): Expect<T> =