Add samples for SequenceExpectation (#1000)

Author: loge1998

apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/main/kotlin/ch/tutteli/atrium/api/fluent/en_GB/sequenceAssertions.kt

@@ -12,6 +12,8 @@ import ch.tutteli.atrium.logic.changeSubject
  * Use `feature(Sequence::asIterable)` if you want to show the transformation in reporting.
  *
  * @return The newly created [Expect] for the transformed subject.
+ *
+ * @sample ch.tutteli.atrium.api.fluent.en_GB.samples.SequenceExpectationSamples.asIterableFeature
  */
 fun <E, T : Sequence<E>> Expect<T>.asIterable(): Expect<Iterable<E>> =
     _logic.changeSubject.unreported { it.asIterable() }
@@ -24,6 +26,8 @@ fun <E, T : Sequence<E>> Expect<T>.asIterable(): Expect<Iterable<E>> =
  * Use `feature(Sequence::asIterable, assertionCreator)` if you want to show the transformation in reporting.
  *
  * @return an [Expect] for the subject of `this` expectation.
+ *
+ * @sample ch.tutteli.atrium.api.fluent.en_GB.samples.SequenceExpectationSamples.asIterable
  */
 fun <E, T : Sequence<E>> Expect<T>.asIterable(assertionCreator: Expect<Iterable<E>>.() -> Unit): Expect<T> =
     apply { asIterable()._logic.appendAsGroup(assertionCreator) }
@@ -37,6 +41,8 @@ fun <E, T : Sequence<E>> Expect<T>.asIterable(assertionCreator: Expect<Iterable<
  * @return The newly created [Expect] for the transformed subject.
  *
  * @since 0.14.0
+ *
+ * @sample ch.tutteli.atrium.api.fluent.en_GB.samples.SequenceExpectationSamples.asListFeature
  */
 fun <E, T : Sequence<E>> Expect<T>.asList(): Expect<List<E>> = _logic.changeSubject.unreported { it.toList() }
 
@@ -50,6 +56,8 @@ fun <E, T : Sequence<E>> Expect<T>.asList(): Expect<List<E>> = _logic.changeSubj
  * @return an [Expect] for the subject of `this` expectation.
  *
  * @since 0.14.0
+ *
+ * @sample ch.tutteli.atrium.api.fluent.en_GB.samples.SequenceExpectationSamples.asList
  */
 fun <E, T : Sequence<E>> Expect<T>.asList(assertionCreator: Expect<List<E>>.() -> Unit): Expect<T> =
     apply { asList()._logic.appendAsGroup(assertionCreator) }

apis/fluent-en_GB/atrium-api-fluent-en_GB-common/src/test/kotlin/ch/tutteli/atrium/api/fluent/en_GB/samples/SequenceExpectationSamples.kt

@@ -0,0 +1,57 @@
+package ch.tutteli.atrium.api.fluent.en_GB.samples
+
+import ch.tutteli.atrium.api.fluent.en_GB.*
+import ch.tutteli.atrium.api.verbs.internal.expect
+import kotlin.test.Test
+
+class SequenceExpectationSamples {
+
+    @Test
+    fun asIterableFeature() {
+        expect(sequenceOf(1, 2, 3))
+            .asIterable() // subject is now of type Iterable<Int>
+            .toContain
+            .inOrder // order specifier
+            .only
+            .values(1, 2, 3)
+
+        fails {
+            expect(sequenceOf(1, 2, 3))
+                .asIterable() // subject is now of type Iterable<Int>
+                .toContain(4)
+        }
+
+    }
+
+    @Test
+    fun asIterable() {
+        expect(sequenceOf(1, 2, 3))
+            .asIterable { // subject within this block is of type Iterable<Int>
+                toContain(1)
+                toContain(2)
+                toContain(3)
+            } // subject here is back to type Sequence<Int>
+
+        fails {
+            expect(sequenceOf(1, 2, 3))
+                .asIterable { // subject within this block is of type Iterable<Int>
+                    toContain(4)
+                } // subject here is back to type Sequence<Int>
+        }
+    }
+
+    @Test
+    fun asListFeature() {
+        expect(sequenceOf(1, 2, 3))
+            .asList() // subject is now of type List<Int>
+            .toEqual(listOf(1, 2, 3))
+    }
+
+    @Test
+    fun asList() {
+        expect(sequenceOf(1, 2, 3))
+            .asList { // subject within this block is of type List<Int>
+                toEqual(listOf(1, 2, 3))
+            } // subject here is back to type Sequence<Int>
+    }
+}