add typealias, make types encodable, use collectiontype in find and modify ops

Author: kmahar

Sources/MongoSwift/MongoCollection+BulkWrite.swift

@@ -9,20 +9,20 @@ extension MongoCollection {
      *   - requests: a `[WriteModel]` containing the writes to perform
      *   - options: optional `BulkWriteOptions` to use while executing the operation
      *
-     * - Returns: a `BulkWriteResult`
+     * - Returns: a `BulkWriteResult`, or `nil` if the write concern is unacknowledged.
      *
      * - Throws:
      *   - `MongoError.invalidArgument` if `requests` is empty
      *   - `MongoError.commandError` if any error occurs while performing the writes
      */
     @discardableResult
-    public func bulkWrite(_ requests: [WriteModel], options: BulkWriteOptions? = nil) throws -> BulkWriteResult {
+    public func bulkWrite(_ requests: [WriteModel], options: BulkWriteOptions? = nil) throws -> BulkWriteResult? {
         throw MongoError.commandError(message: "Unimplemented command")
     }
 }
 
 /// Options to use when performing a bulk write operation on a `MongoCollection`.
-public struct BulkWriteOptions {
+public struct BulkWriteOptions: Encodable {
     /// If `true` (the default), when an insert fails, return without performing the remaining writes.
     /// If `false`, when a write fails, continue with the remaining writes, if any.
     public var ordered: Bool = true
@@ -32,7 +32,7 @@ public struct BulkWriteOptions {
 }
 
 /// A protocol indicating write types that can be batched together using `MongoCollection.bulkWrite`.
-public protocol WriteModel {}
+public protocol WriteModel: Encodable {}
 
 /// A model for an `insertOne` command.
 public struct InsertOneModel: WriteModel {

Sources/MongoSwift/MongoCollection+FindAndModify.swift

@@ -9,10 +9,10 @@ extension MongoCollection {
      *   - filter: `Document` representing the match criteria
      *   - options: Optional `FindOneAndDeleteOptions` to use when executing the command
      *
-     * - Returns: The deleted document, or `nil` if no document was deleted.
+     * - Returns: The deleted document, represented as a `CollectionType`, or `nil` if no document was deleted.
      */
     @discardableResult
-    public func findOneAndDelete(_ filter: Document, options: FindOneAndDeleteOptions? = nil) throws -> Document? {
+    public func findOneAndDelete(_ filter: Document, options: FindOneAndDeleteOptions? = nil) throws -> CollectionType? {
         throw MongoError.commandError(message: "Unimplemented command")
     }
 
@@ -21,15 +21,15 @@ extension MongoCollection {
      * 
      * - Parameters:
      *   - filter: `Document` representing the match criteria
-     *   - replacement: a `Document` to replace the found one
+     *   - replacement: a `CollectionType` to replace the found document
      *   - options: Optional `FindOneAndReplaceOptions` to use when executing the command
      *
-     * - Returns: Either the original document or its replacement depending on selected options, 
-     *            or `nil` if there was no match.
+     * - Returns: A `CollectionType`, representing either the original document or its replacement,
+     *      depending on selected options, or `nil` if there was no match.
      */
     @discardableResult
-    public func findOneAndReplace(filter: Document, replacement: Document,
-                                  options: FindOneAndDeleteOptions? = nil) throws -> Document? {
+    public func findOneAndReplace(filter: Document, replacement: T,
+                                  options: FindOneAndDeleteOptions? = nil) throws -> CollectionType? {
         throw MongoError.commandError(message: "Unimplemented command")
     }
 
@@ -38,7 +38,7 @@ extension MongoCollection {
      * 
      * - Parameters:
      *   - filter: `Document` representing the match criteria
-     *   - replacement: a `Document` to replace the found one
+     *   - update: a `Document` containing updates to apply
      *   - options: Optional `FindOneAndUpdateOptions` to use when executing the command
      *
      * - Returns: Either the original or updated document depending on selected options, 
@@ -52,16 +52,20 @@ extension MongoCollection {
 }
 
 /// Indicates which document to return in a find and modify operation.
-public enum ReturnDocument {
+public enum ReturnDocument: Encodable {
     /// Indicates to return the document before the update, replacement, or insert occured.
     case before
 
     ///  Indicates to return the document after the update, replacement, or insert occured.
     case after
+
+    public func encode(to encoder: Encoder) throws {
+        // fill in later on
+    }
 }
 
 /// Options to use when executing a `findOneAndDelete` command on a `MongoCollection`. 
-public struct FindOneAndDeleteOptions {
+public struct FindOneAndDeleteOptions: Encodable {
     /// Specifies a collation to use.
     public let collation: Document?
 
@@ -73,10 +77,13 @@ public struct FindOneAndDeleteOptions {
 
     /// Determines which document the operation modifies if the query selects multiple documents.
     public let sort: Document?
+
+    /// An optional `WriteConcern` to use for the command.
+    public let writeConcern: WriteConcern?
 }
 
 /// Options to use when executing a `findOneAndReplace` command on a `MongoCollection`. 
-public struct FindOneAndReplaceOptions {
+public struct FindOneAndReplaceOptions: Encodable {
     /// If `true`, allows the write to opt-out of document level validation.
     public let bypassDocumentValidation: Bool?
 
@@ -97,10 +104,13 @@ public struct FindOneAndReplaceOptions {
 
     /// When `true`, creates a new document if no document matches the query.
     public let upsert: Bool?
+
+    /// An optional `WriteConcern` to use for the command.
+    public let writeConcern: WriteConcern?
 }
 
 /// Options to use when executing a `findOneAndUpdate` command on a `MongoCollection`. 
-public struct FindOneAndUpdateOptions {
+public struct FindOneAndUpdateOptions: Encodable {
     /// A set of filters specifying to which array elements an update should apply.
     public let arrayFilters: [Document]?
 
@@ -124,4 +134,7 @@ public struct FindOneAndUpdateOptions {
 
     /// When `true`, creates a new document if no document matches the query.
     public let upsert: Bool?
+
+    /// An optional `WriteConcern` to use for the command.
+    public let writeConcern: WriteConcern?
 }

Sources/MongoSwift/MongoCollection+Read.swift

@@ -72,11 +72,11 @@ extension MongoCollection {
      *
      * - Parameters:
      *   - filter: a `Document`, the filter that documents must match in order to be counted
-     *   - options: Optional `CountOptions` to use when executing the command
+     *   - options: Optional `CountDocumentsOptions` to use when executing the command
      *
      * - Returns: The count of the documents that matched the filter
      */
-    public func countDocuments(_ filter: Document = [:], options: CountOptions? = nil) throws -> Int {
+    public func countDocuments(_ filter: Document = [:], options: CountDocumentsOptions? = nil) throws -> Int {
         // TODO SWIFT-133: implement this https://jira.mongodb.org/browse/SWIFT-133
         throw MongoError.commandError(message: "Unimplemented command")
     }
@@ -243,6 +243,9 @@ public struct CountOptions: Encodable {
     }
 }
 
+/// The `countDocuments` command takes the same options as the deprecated `count`. 
+public typealias CountDocumentsOptions = CountOptions
+
 /// Options to use when executing an `estimatedDocumentCount` command on a `MongoCollection`.
 public struct EstimatedDocumentCountOptions {
     /// The maximum amount of time to allow the query to run.