Update with flow delegation and address TODOs

cbullinger · cbullinger · commit 90e7fe4716db · 2023-06-13T08:24:10.000-04:00
diff --git a/examples/src/test/kotlin/FlowTest.kt b/examples/src/test/kotlin/FlowTest.kt
@@ -2,7 +2,7 @@
 
 import com.mongodb.ExplainVerbosity
 import com.mongodb.kotlin.client.coroutine.MongoClient
-import io.github.cdimascio.dotenv.dotenv
+import config.getConfig
 import kotlinx.coroutines.flow.*
 import kotlinx.coroutines.runBlocking
 import org.bson.Document
@@ -23,8 +23,8 @@ internal class FlowTest {
         val qty: Int
     )
     companion object {
-        val dotenv = dotenv()
-        val client = MongoClient.create(dotenv["MONGODB_CONNECTION_URI"])
+        val config = getConfig()
+        val client = MongoClient.create(config.connectionUri)
         val database = client.getDatabase("paint_store")
         val collection = database.getCollection<PaintOrder>("paint_order")
 
diff --git a/examples/src/test/kotlin/TimeSeriesTest.kt b/examples/src/test/kotlin/TimeSeriesTest.kt
@@ -5,7 +5,7 @@ import com.mongodb.client.model.Filters.*
 import com.mongodb.client.model.Projections.*
 import com.mongodb.client.model.TimeSeriesOptions
 import com.mongodb.kotlin.client.coroutine.MongoClient
-import io.github.cdimascio.dotenv.dotenv
+import config.getConfig
 import kotlinx.coroutines.flow.toList
 import kotlinx.coroutines.runBlocking
 import org.bson.json.JsonWriterSettings
@@ -20,8 +20,8 @@ import kotlin.test.*
 internal class TimeSeriesTest {
     
     companion object {
-        val dotenv = dotenv()
-        val mongoClient = MongoClient.create(dotenv["MONGODB_CONNECTION_URI"])
+        val config = getConfig()
+        val mongoClient = MongoClient.create(config.connectionUri)
 
         @AfterAll
         @JvmStatic
diff --git a/source/fundamentals/crud/read-operations/flow.txt b/source/fundamentals/crud/read-operations/flow.txt
@@ -4,8 +4,6 @@
 Access Data From a Flow
 =======================
 
-.. default-domain:: mongodb
-
 .. contents:: On this page
    :local:
    :backlinks: none
diff --git a/source/quick-reference.txt b/source/quick-reference.txt
@@ -4,8 +4,6 @@
 Quick Reference
 ===============
 
-.. default-domain:: mongodb
-
 This page shows the driver syntax for several MongoDB commands and links to
 their related reference and API documentation.
 
@@ -350,21 +348,20 @@ The examples on the page use the following data class to represent MongoDB docum
 
      - .. include:: /includes/kotlin-driver-coroutine-gradle-versioned.rst
 
-.. TODO:(DOCSP-29167) add back as part of this ticket. needs refactoring b/c cursor not thing for coroutines driver
-..  * - | **Access Data from a Flow Iteratively**
-..      |
-..      | `API Documentation <{+api-kotlin+}/apidocs/mongodb-driver-sync/com/mongodb/client/MongoCursor.html>`__
-..      | :ref:`Fundamentals <kotlin-fundamentals-cursor-conditional-iteration>`
-..    - .. io-code-block::
-..         :copyable: true
-..         .. input:: 
-..            :language: kotlin
-..         .. output::
-..            :language: console
-              :visible: false
-..
-..            [
-..              { title: '2001: A Space Odyssey', ... },
-..              { title: 'The Sound of Music', ... },
-..              ...
-..            ]
+   * - | **Access Data from a Flow Iteratively**
+       |
+       | `API Documentation <{+api-kotlin+}/apidocs/mongodb-driver-kotlin-coroutine/mongodb-driver-kotlin-coroutine/com.mongodb.kotlin.client.coroutine/-find-flow/index.html>`__
+       | :ref:`Fundamentals <kotlin-fundamentals-flow>`
+
+     - .. io-code-block::
+          :copyable: true
+
+          .. input:: /examples/generated/FlowTest.snippet.iterate.kt
+             :language: kotlin
+
+          .. output::
+             :language: console
+             :visible: false
+
+             Movie(title=2001: A Space Odyssey, ...)
+             Movie(title=The Sound of Music, ...)
diff --git a/source/usage-examples/distinct.txt b/source/usage-examples/distinct.txt
@@ -38,14 +38,13 @@ distinct values with a query filter as a second parameter, as follows:
    :language: kotlin
 
 The ``distinct()`` method returns an object that implements the
-``DistinctFlow`` class, which contains methods to access,organize, and traverse 
-the results. ``DistinctFlow`` also inherits methods from its parent class 
-``Flow`` from the Kotlin Coroutines library, such as ``first()`` and 
+``DistinctFlow`` class, which contains methods to access, organize, and traverse 
+the results. ``DistinctFlow`` delegates to the ``Flow`` interface
+from the Kotlin Coroutines library, allowing access to methods such as ``first()`` and 
 ``firstOrNull()``.
 
-.. TODO (DOCSP-29176) Add link to Flow documentation when available
-.. For more information, see our
-.. :doc:`guide on Accessing Data From a Flow </fundamentals/crud/read-operations/flow/>`.
+For more information, see our
+:doc:`guide on Accessing Data From a Flow </fundamentals/crud/read-operations/flow/>`.
 
 Example
 -------
diff --git a/source/usage-examples/find.txt b/source/usage-examples/find.txt
@@ -28,19 +28,16 @@ For more information on the ``projection()`` method, see our
 The ``find()`` method returns an instance of ``FindFlow``, a class
 that offers several methods to access, organize, and traverse the results.
 
-.. TODO (DOCSP-29176) Update with accurate inheritance information when available
-.. ``FindFlow`` also inherits methods from its parent class ``Flow`` from the
-.. Kotlin Coroutines library.
-
+``FindFlow`` also obtains methods from its delegate interface ``Flow`` from the
+Kotlin Coroutines library.
 You can call the ``collect()`` method to iterate through the fetched results.
 You can also call terminal methods, such as ``firstOrNull()`` to return either 
 the first document or ``null`` if there are no results, or ``first()`` to return 
 the first document in the collection. If no documents match the query, 
 calling ``first()`` throws a ``NoSuchElementException`` exception.
 
-.. TODO (DOCSP-29176) Add link to Flow documentation when available
-.. For more information on accessing data from a flow with the Kotlin driver, see our
-.. :doc:`guide on Accessing Data From a Flow </fundamentals/crud/read-operations/flow/>`.
+For more information on accessing data from a flow with the Kotlin driver, see our
+:doc:`guide on Accessing Data From a Flow </fundamentals/crud/read-operations/flow/>`.
 
 Example
 -------
diff --git a/source/usage-examples/findOne.txt b/source/usage-examples/findOne.txt
@@ -27,18 +27,15 @@ For more information on the ``projection()`` method, see our
 The ``find()`` method returns an instance of ``FindFlow``, a class
 that offers several methods to access, organize, and traverse the results.
 
-.. TODO (DOCSP-29176) Update with accurate inheritance information when available
-.. ``FindFlow`` also inherits methods from its parent class ``Flow`` from the
-.. Kotlin Coroutines library, such as ``first()`` and ``firstOrNull()``.
-
+``FindFlow`` also obtains methods from its delegate interface ``Flow`` from the
+Kotlin Coroutines library, such as ``first()`` and ``firstOrNull()``.
 The ``firstOrNull()`` method returns the first document from the retrieved results
 or ``null`` if there are no results. The ``first()`` method returns 
 the first document or throws a ``NoSuchElementException`` exception if no 
 documents match the query.
 
-.. TODO (DOCSP-29176) Add link to Flow documentation when available
-.. For more information on accessing data from a flow with the Kotlin driver, see our
-.. :doc:`guide on Accessing Data From a Flow </fundamentals/crud/read-operations/flow/>`.
+For more information on accessing data from a flow with the Kotlin driver, see our
+:doc:`guide on Accessing Data From a Flow </fundamentals/crud/read-operations/flow/>`.
 
 Example
 -------
