SWIFT-513 Standardize ordering of options parameters (#329)

Author: kaywux

Sources/MongoSwift/BSON/CodingStrategies.swift

@@ -17,19 +17,19 @@ public protocol CodingStrategyProvider {
 
 /// Options struct used for configuring the coding strategies on `BSONEncoder` and `BSONDecoder`.
 public struct BSONCoderOptions: CodingStrategyProvider {
+    public var dataCodingStrategy: DataCodingStrategy?
+
     public var dateCodingStrategy: DateCodingStrategy?
 
     public var uuidCodingStrategy: UUIDCodingStrategy?
 
-    public var dataCodingStrategy: DataCodingStrategy?
-
     /// Initializes a new `BSONCoderOptions`.
-    public init(dateCodingStrategy: DateCodingStrategy? = nil,
-                uuidCodingStrategy: UUIDCodingStrategy? = nil,
-                dataCodingStrategy: DataCodingStrategy? = nil) {
+    public init(dataCodingStrategy: DataCodingStrategy? = nil,
+                dateCodingStrategy: DateCodingStrategy? = nil,
+                uuidCodingStrategy: UUIDCodingStrategy? = nil) {
+        self.dataCodingStrategy = dataCodingStrategy
         self.dateCodingStrategy = dateCodingStrategy
         self.uuidCodingStrategy = uuidCodingStrategy
-        self.dataCodingStrategy = dataCodingStrategy
     }
 }
 

Sources/MongoSwift/ChangeStreamOptions.swift

@@ -28,6 +28,14 @@ public enum FullDocument: RawRepresentable, Codable {
 
 /// Options to use when creating a `ChangeStream`.
 public struct ChangeStreamOptions: Codable {
+    /// The number of documents to return per batch. If omitted, the server will use its default batch size.
+    /// - SeeAlso: https://docs.mongodb.com/manual/reference/command/aggregate
+    public var batchSize: Int32?
+
+    /// Specifies a collation.
+    /// - SeeAlso: https://docs.mongodb.com/manual/reference/command/aggregate
+    public var collation: Document?
+
     /**
      * Indicates how the `fullDocument` field of a change stream document should be filled out by the server.
      * By default (indicated by a nil value for this option), the `fullDocument` field in the change stream document
@@ -36,6 +44,10 @@ public struct ChangeStreamOptions: Codable {
      */
     public var fullDocument: FullDocument?
 
+    /// The maximum amount of time in milliseconds for the server to wait on new documents to satisfy a
+    /// change stream query. If omitted, the server will use its default timeout.
+    public var maxAwaitTimeMS: Int64?
+
     /**
      * A `ResumeToken` that manually specifies the logical starting point for the new change stream.
      * The change stream will attempt to resume notifications starting after the operation associated with
@@ -45,23 +57,6 @@ public struct ChangeStreamOptions: Codable {
      */
     public var resumeAfter: ResumeToken?
 
-    /// The maximum amount of time in milliseconds for the server to wait on new documents to satisfy a
-    /// change stream query. If omitted, the server will use its default timeout.
-    public var maxAwaitTimeMS: Int64?
-
-    /// The number of documents to return per batch. If omitted, the server will use its default batch size.
-    /// - SeeAlso: https://docs.mongodb.com/manual/reference/command/aggregate
-    public var batchSize: Int32?
-
-    /// Specifies a collation.
-    /// - SeeAlso: https://docs.mongodb.com/manual/reference/command/aggregate
-    public var collation: Document?
-
-    /// The change stream will only provide changes that occurred at or after the specified timestamp.
-    /// Any command run against the server will return an operation time that can be used here.
-    /// - SeeAlso: https://docs.mongodb.com/manual/reference/method/db.runCommand/
-    public var startAtOperationTime: Timestamp?
-
     /**
      * Similar to `resumeAfter`, this option takes a `ResumeToken` which will serve as the logical starting
      * point for the new change stream. This option differs from `resumeAfter` in that it will allow a change stream
@@ -73,19 +68,24 @@ public struct ChangeStreamOptions: Codable {
      // TODO: SWIFT-519 - Make this public when support is added for 4.2 change stream features.
     internal var startAfter: ResumeToken?
 
+    /// The change stream will only provide changes that occurred at or after the specified timestamp.
+    /// Any command run against the server will return an operation time that can be used here.
+    /// - SeeAlso: https://docs.mongodb.com/manual/reference/method/db.runCommand/
+    public var startAtOperationTime: Timestamp?
+
     /// Initializes a `ChangeStreamOptions`.
-    public init(fullDocument: FullDocument? = nil,
-                resumeAfter: ResumeToken? = nil,
-                maxAwaitTimeMS: Int64? = nil,
-                batchSize: Int32? = nil,
+    public init(batchSize: Int32? = nil,
                 collation: Document? = nil,
+                fullDocument: FullDocument? = nil,
+                maxAwaitTimeMS: Int64? = nil,
+                resumeAfter: ResumeToken? = nil,
                 startAtOperationTime: Timestamp? = nil) {
-        self.fullDocument = fullDocument
-        self.resumeAfter = resumeAfter
-        self.maxAwaitTimeMS = maxAwaitTimeMS
         self.batchSize = batchSize
         self.collation = collation
-        self.startAtOperationTime = startAtOperationTime
+        self.fullDocument = fullDocument
+        self.maxAwaitTimeMS = maxAwaitTimeMS
+        self.resumeAfter = resumeAfter
         self.startAfter = nil
+        self.startAtOperationTime = startAtOperationTime
     }
 }

Sources/MongoSwift/MongoClient.swift

@@ -3,13 +3,6 @@ import mongoc
 
 /// Options to use when creating a `MongoClient`.
 public struct ClientOptions: CodingStrategyProvider, Decodable {
-    /// Determines whether the client should retry supported read operations.
-    /// TODO SWIFT-587 make this public.
-    internal var retryReads: Bool?
-
-    /// Determines whether the client should retry supported write operations.
-    public var retryWrites: Bool?
-
     /**
      * Indicates whether this client should publish command monitoring events. If true, the following event types will
      * be published, under the listed names (which are defined as static properties of `Notification.Name`):
@@ -19,6 +12,33 @@ public struct ClientOptions: CodingStrategyProvider, Decodable {
      */
     public var commandMonitoring: Bool = false
 
+    // swiftlint:disable redundant_optional_initialization
+
+    /// Specifies the `DataCodingStrategy` to use for BSON encoding/decoding operations performed by this client and any
+    /// databases or collections that derive from it.
+    public var dataCodingStrategy: DataCodingStrategy? = nil
+
+    /// Specifies the `DateCodingStrategy` to use for BSON encoding/decoding operations performed by this client and any
+    /// databases or collections that derive from it.
+    public var dateCodingStrategy: DateCodingStrategy? = nil
+
+    /// If command and/or server monitoring is enabled, indicates the `NotificationCenter` events are posted to. If one
+    /// is not specified, the application's default `NotificationCenter` will be used.
+    public var notificationCenter: NotificationCenter?
+
+    /// Specifies a ReadConcern to use for the client.
+    public var readConcern: ReadConcern?
+
+    /// Specifies a ReadPreference to use for the client.
+    public var readPreference: ReadPreference? = nil
+
+    /// Determines whether the client should retry supported read operations.
+    /// TODO SWIFT-587 make this public.
+    internal var retryReads: Bool?
+
+    /// Determines whether the client should retry supported write operations.
+    public var retryWrites: Bool?
+
     /**
      * Indicates whether this client should publish command monitoring events. If true, the following event types will
      * be published, under the listed names (which are defined as static properties of `Notification.Name`):
@@ -34,135 +54,115 @@ public struct ClientOptions: CodingStrategyProvider, Decodable {
      */
     public var serverMonitoring: Bool = false
 
-    /// If command and/or server monitoring is enabled, indicates the `NotificationCenter` events are posted to. If one
-    /// is not specified, the application's default `NotificationCenter` will be used.
-    public var notificationCenter: NotificationCenter?
-
-    /// Specifies a ReadConcern to use for the client.
-    public var readConcern: ReadConcern?
-
-    /// Specifies a WriteConcern to use for the client.
-    public var writeConcern: WriteConcern?
-
-    // swiftlint:disable redundant_optional_initialization
-
-    /// Specifies a ReadPreference to use for the client.
-    public var readPreference: ReadPreference? = nil
-
-    /// Specifies the `DateCodingStrategy` to use for BSON encoding/decoding operations performed by this client and any
-    /// databases or collections that derive from it.
-    public var dateCodingStrategy: DateCodingStrategy? = nil
+    /// Specifies the TLS/SSL options to use for database connections.
+    public var tlsOptions: TLSOptions? = nil
 
     /// Specifies the `UUIDCodingStrategy` to use for BSON encoding/decoding operations performed by this client and any
     /// databases or collections that derive from it.
     public var uuidCodingStrategy: UUIDCodingStrategy? = nil
 
-    /// Specifies the `DataCodingStrategy` to use for BSON encoding/decoding operations performed by this client and any
-    /// databases or collections that derive from it.
-    public var dataCodingStrategy: DataCodingStrategy? = nil
-
-    /// Specifies the TLS/SSL options to use for database connections.
-    public var tlsOptions: TLSOptions? = nil
-
     // swiftlint:enable redundant_optional_initialization
 
+    /// Specifies a WriteConcern to use for the client.
+    public var writeConcern: WriteConcern?
+
     private enum CodingKeys: CodingKey {
         case retryWrites, readConcern, writeConcern
     }
 
     /// Convenience initializer allowing any/all to be omitted or optional.
-    public init(readConcern: ReadConcern? = nil,
+    public init(commandMonitoring: Bool = false,
+                dataCodingStrategy: DataCodingStrategy? = nil,
+                dateCodingStrategy: DateCodingStrategy? = nil,
+                notificationCenter: NotificationCenter? = nil,
+                readConcern: ReadConcern? = nil,
                 readPreference: ReadPreference? = nil,
                 retryWrites: Bool? = nil,
-                writeConcern: WriteConcern? = nil,
-                commandMonitoring: Bool = false,
                 serverMonitoring: Bool = false,
-                notificationCenter: NotificationCenter? = nil,
-                dateCodingStrategy: DateCodingStrategy? = nil,
+                tlsOptions: TLSOptions? = nil,
                 uuidCodingStrategy: UUIDCodingStrategy? = nil,
-                dataCodingStrategy: DataCodingStrategy? = nil,
-                tlsOptions: TLSOptions? = nil) {
-        self.retryWrites = retryWrites
+                writeConcern: WriteConcern? = nil) {
         self.commandMonitoring = commandMonitoring
-        self.serverMonitoring = serverMonitoring
+        self.dataCodingStrategy = dataCodingStrategy
+        self.dateCodingStrategy = dateCodingStrategy
         self.notificationCenter = notificationCenter
         self.readConcern = readConcern
         self.readPreference = readPreference
-        self.writeConcern = writeConcern
-        self.dateCodingStrategy = dateCodingStrategy
-        self.uuidCodingStrategy = uuidCodingStrategy
-        self.dataCodingStrategy = dataCodingStrategy
+        self.retryWrites = retryWrites
+        self.serverMonitoring = serverMonitoring
         self.tlsOptions = tlsOptions
+        self.uuidCodingStrategy = uuidCodingStrategy
+        self.writeConcern = writeConcern
     }
 }
 
 /// Options to use when retrieving a `MongoDatabase` from a `MongoClient`.
 public struct DatabaseOptions: CodingStrategyProvider {
+    /// Specifies the `DateCodingStrategy` to use for BSON encoding/decoding operations performed by this database and
+    /// any collections that derive from it.
+    public var dataCodingStrategy: DataCodingStrategy?
+
+    /// Specifies the `DateCodingStrategy` to use for BSON encoding/decoding operations performed by this database and
+    /// any collections that derive from it.
+    public var dateCodingStrategy: DateCodingStrategy?
+
     /// A read concern to set on the retrieved database.
     public var readConcern: ReadConcern?
 
     /// A read preference to set on the retrieved database.
     public var readPreference: ReadPreference?
 
-    /// A write concern to set on the retrieved database.
-    public var writeConcern: WriteConcern?
-
-    /// Specifies the `DateCodingStrategy` to use for BSON encoding/decoding operations performed by this database and
-    /// any collections that derive from it.
-    public var dateCodingStrategy: DateCodingStrategy?
-
     /// Specifies the `DateCodingStrategy` to use for BSON encoding/decoding operations performed by this database and
     /// any collections that derive from it.
     public var uuidCodingStrategy: UUIDCodingStrategy?
 
-    /// Specifies the `DateCodingStrategy` to use for BSON encoding/decoding operations performed by this database and
-    /// any collections that derive from it.
-    public var dataCodingStrategy: DataCodingStrategy?
+    /// A write concern to set on the retrieved database.
+    public var writeConcern: WriteConcern?
 
     /// Convenience initializer allowing any/all arguments to be omitted or optional.
-    public init(readConcern: ReadConcern? = nil,
-                readPreference: ReadPreference? = nil,
-                writeConcern: WriteConcern? = nil,
+    public init(dataCodingStrategy: DataCodingStrategy? = nil,
                 dateCodingStrategy: DateCodingStrategy? = nil,
+                readConcern: ReadConcern? = nil,
+                readPreference: ReadPreference? = nil,
                 uuidCodingStrategy: UUIDCodingStrategy? = nil,
-                dataCodingStrategy: DataCodingStrategy? = nil) {
+                writeConcern: WriteConcern? = nil) {
+        self.dataCodingStrategy = dataCodingStrategy
+        self.dateCodingStrategy = dateCodingStrategy
         self.readConcern = readConcern
         self.readPreference = readPreference
-        self.writeConcern = writeConcern
-        self.dateCodingStrategy = dateCodingStrategy
         self.uuidCodingStrategy = uuidCodingStrategy
-        self.dataCodingStrategy = dataCodingStrategy
+        self.writeConcern = writeConcern
     }
 }
 
 /// Options used to configure TLS/SSL connections to the database.
 public struct TLSOptions {
+    /// Indicates whether invalid hostnames are allowed. By default this is set to false.
+    public var allowInvalidHostnames: Bool?
+
+    /// Specifies the path to the certificate authority file.
+    public var caFile: URL?
+
     /// Specifies the path to the client certificate key file.
     public var pemFile: URL?
 
     /// Specifies the client certificate key password.
     public var pemPassword: String?
 
-    /// Specifies the path to the certificate authority file.
-    public var caFile: URL?
-
     /// Indicates whether invalid certificates are allowed. By default this is set to false.
     public var weakCertValidation: Bool?
 
-    /// Indicates whether invalid hostnames are allowed. By default this is set to false.
-    public var allowInvalidHostnames: Bool?
-
     /// Convenience initializer allowing any/all arguments to be omitted or optional.
-    public init(pemFile: URL? = nil,
-                pemPassword: String? = nil,
+    public init(allowInvalidHostnames: Bool? = nil,
                 caFile: URL? = nil,
-                weakCertValidation: Bool? = nil,
-                allowInvalidHostnames: Bool? = nil) {
+                pemFile: URL? = nil,
+                pemPassword: String? = nil,
+                weakCertValidation: Bool? = nil) {
+        self.allowInvalidHostnames = allowInvalidHostnames
+        self.caFile = caFile
         self.pemFile = pemFile
         self.pemPassword = pemPassword
-        self.caFile = caFile
         self.weakCertValidation = weakCertValidation
-        self.allowInvalidHostnames = allowInvalidHostnames
     }
 }