format/lint

Author: kmahar

Sources/MongoSwift/BSON/BSONDocument+Collection.swift

@@ -51,8 +51,8 @@ extension BSONDocument: Collection {
         return (iter.currentKey, iter.currentValue)
     }
 
-    /// Allows access to a `KeyValuePair` from the `BSONDocument`, given a range of indices of the desired `KeyValuePair`'s
-    /// held within. This method does not guarantee constant-time (O(1)) access.
+    /// Allows access to a `KeyValuePair` from the `BSONDocument`, given a range of indices of the desired
+    /// `KeyValuePair`'s held within. This method does not guarantee constant-time (O(1)) access.
     public subscript(bounds: Range<Index>) -> BSONDocument {
         // TODO: SWIFT-252 should provide a more efficient implementation for this.
         BSONDocumentIterator.subsequence(of: self, startIndex: bounds.lowerBound, endIndex: bounds.upperBound)

Sources/MongoSwift/BSON/BSONDocumentIterator.swift

@@ -116,7 +116,11 @@ public class BSONDocumentIterator: IteratorProtocol {
     // uses an iterator to copy (key, value) pairs of the provided document from range [startIndex, endIndex) into a new
     // document. starts at the startIndex-th pair and ends at the end of the document or the (endIndex-1)th index,
     // whichever comes first.
-    internal static func subsequence(of doc: BSONDocument, startIndex: Int = 0, endIndex: Int = Int.max) -> BSONDocument {
+    internal static func subsequence(
+        of doc: BSONDocument,
+        startIndex: Int = 0,
+        endIndex: Int = Int.max
+    ) -> BSONDocument {
         guard endIndex >= startIndex else {
             fatalError("endIndex must be >= startIndex")
         }

Sources/MongoSwift/BSON/BSONValue.swift

@@ -1253,7 +1253,8 @@ private func bsonDecodingDirectlyError<T: BSONValue>(type _: T.Type, at codingPa
  *
  * Some example cases:
  *   - Decoding directly from the BSONDecoder top-level (e.g. BSONDecoder().decode(BSONObjectID.self, from: ...))
- *   - Encountering the wrong type of BSONValue (e.g. expected "_id" to be an `BSONObjectID`, got a `BSONDocument` instead)
+ *   - Encountering the wrong type of BSONValue (e.g. expected "_id" to be an `BSONObjectID`, got a `BSONDocument`
+ *     instead)
  *   - Attempting to decode a driver-introduced BSONValue with a non-BSONDecoder
  */
 internal func getDecodingError<T: BSONValue>(type _: T.Type, decoder: Decoder) -> DecodingError {

Sources/MongoSwift/BSON/CodingStrategies.swift

@@ -38,7 +38,8 @@ public struct BSONCoderOptions: CodingStrategyProvider {
 /**
  * Enum representing the various encoding/decoding strategy pairs for `Date`s.
  * Set these on a `MongoClient`, `MongoDatabase`, or `MongoCollection` so that the strategies will be applied when
- * converting `Date`s between their BSON representations and their representations in (non `BSONDocument`) `Codable` types.
+ * converting `Date`s between their BSON representations and their representations in (non `BSONDocument`) `Codable`
+ * types.
  *
  * As per the BSON specification, the default strategy is to encode `Date`s as BSON datetime objects.
  *
@@ -123,7 +124,8 @@ public enum DateCodingStrategy: RawRepresentable {
 /**
  * Enum representing the various encoding/decoding strategy pairs for `Date`s.
  * Set these on a `MongoClient`, `MongoDatabase`, or `MongoCollection` so that the strategies will be applied when
- * converting `UUID`s between their BSON representations and their representations in (non `BSONDocument`) `Codable` types.
+ * converting `UUID`s between their BSON representations and their representations in (non `BSONDocument`) `Codable`
+ * types.
  *
  * As per the BSON specification, the default strategy is to encode `UUID`s as BSON binary types with the UUID
  * subtype.
@@ -163,7 +165,8 @@ public enum UUIDCodingStrategy: RawRepresentable {
 /**
  * Enum representing the various encoding/decoding strategy pairs for `Date`s.
  * Set these on a `MongoClient`, `MongoDatabase`, or `MongoCollection` so that the strategies will be applied when
- * converting `Data`s between their BSON representations and their representations in (non `BSONDocument`) `Codable` types.
+ * converting `Data`s between their BSON representations and their representations in (non `BSONDocument`) `Codable`
+ * types.
  *
  * As per the BSON specification, the default strategy is to encode `Data`s as BSON binary types with the generic
  * binary subtype.

Sources/MongoSwift/ClientSession.swift

@@ -227,7 +227,7 @@ public final class ClientSession {
                     }
 
                     // swiftlint:disable:next force_unwrapping
-                    self.id = BSONDocument(copying: mongoc_client_session_get_lsid(sessionPtr)!) // always returns a value
+                    self.id = BSONDocument(copying: mongoc_client_session_get_lsid(sessionPtr)!) // never returns nil
                 }
         case .started:
             return self.client.operationExecutor.makeSucceededFuture(Void())

Sources/MongoSwift/MongoClient.swift

@@ -363,8 +363,8 @@ public class MongoClient {
      * Retrieves a list of databases in this client's MongoDB deployment.
      *
      * - Parameters:
-     *   - filter: Optional `BSONDocument` specifying a filter that the listed databases must pass. This filter can be based
-     *     on the "name", "sizeOnDisk", "empty", or "shards" fields of the output.
+     *   - filter: Optional `BSONDocument` specifying a filter that the listed databases must pass. This filter can be
+     *      based on the "name", "sizeOnDisk", "empty", or "shards" fields of the output.
      *   - options: Optional `ListDatabasesOptions` specifying options for listing databases.
      *   - session: Optional `ClientSession` to use when executing this command.
      *

Sources/MongoSwift/MongoCollection+Read.swift

@@ -139,7 +139,8 @@ extension MongoCollection {
      *
      * - Parameters:
      *   - fieldName: The field for which the distinct values will be found
-     *   - filter: a `BSONDocument` representing the filter documents must match in order to be considered for the operation
+     *   - filter: a `BSONDocument` representing the filter documents must match in order to be considered for the
+     *             operation
      *   - options: Optional `DistinctOptions` to use when executing the command
      *   - session: Optional `ClientSession` to use when executing this command
      *

Sources/MongoSwift/Operations/FindAndModifyOperation.swift

@@ -163,22 +163,23 @@ internal struct FindAndModifyOperation<T: Codable>: Operation {
 
         var error = bson_error_t()
 
-        let (success, reply) = self.collection.withMongocCollection(from: connection) { collPtr -> (Bool, BSONDocument) in
-            self.filter.withBSONPointer { filterPtr in
-                opts.withMongocOptions { optsPtr in
-                    withStackAllocatedMutableBSONPointer { replyPtr in
-                        let success = mongoc_collection_find_and_modify_with_opts(
-                            collPtr,
-                            filterPtr,
-                            optsPtr,
-                            replyPtr,
-                            &error
-                        )
-                        return (success, BSONDocument(copying: replyPtr))
+        let (success, reply) = self.collection
+            .withMongocCollection(from: connection) { collPtr -> (Bool, BSONDocument) in
+                self.filter.withBSONPointer { filterPtr in
+                    opts.withMongocOptions { optsPtr in
+                        withStackAllocatedMutableBSONPointer { replyPtr in
+                            let success = mongoc_collection_find_and_modify_with_opts(
+                                collPtr,
+                                filterPtr,
+                                optsPtr,
+                                replyPtr,
+                                &error
+                            )
+                            return (success, BSONDocument(copying: replyPtr))
+                        }
                     }
                 }
             }
-        }
 
         guard success else {
             throw extractMongoError(error: error, reply: reply)

Tests/BSONTests/BSONCorpusTests.swift

@@ -160,7 +160,8 @@ final class BSONCorpusTests: MongoSwiftTestCase {
 
                     // for cEJ input:
                     // native_to_canonical_extended_json( json_to_native(cEJ) ) = cEJ
-                    expect(try BSONDocument(fromJSON: cEJData).canonicalExtendedJSON).to(cleanEqual(test.canonicalExtJSON))
+                    expect(try BSONDocument(fromJSON: cEJData).canonicalExtendedJSON)
+                        .to(cleanEqual(test.canonicalExtJSON))
 
                     // native_to_bson( json_to_native(cEJ) ) = cB (unless lossy)
                     if !lossy {
@@ -187,7 +188,8 @@ final class BSONCorpusTests: MongoSwiftTestCase {
                     // for dEJ input (if it exists):
                     if let dEJ = test.degenerateExtJSON {
                         // native_to_canonical_extended_json( json_to_native(dEJ) ) = cEJ
-                        expect(try BSONDocument(fromJSON: dEJ).canonicalExtendedJSON).to(cleanEqual(test.canonicalExtJSON))
+                        expect(try BSONDocument(fromJSON: dEJ).canonicalExtendedJSON)
+                            .to(cleanEqual(test.canonicalExtJSON))
 
                         // native_to_bson( json_to_native(dEJ) ) = cB (unless lossy)
                         if !lossy {

Tests/BSONTests/BSONValueTests.swift

@@ -39,7 +39,10 @@ final class BSONValueTests: MongoSwiftTestCase {
         // Double
         self.checkTrueAndFalse(val: 1.618, alternate: 2.718)
         // Decimal128
-        self.checkTrueAndFalse(val: .decimal128(BSONDecimal128("1.618")!), alternate: .decimal128(BSONDecimal128("2.718")!))
+        self.checkTrueAndFalse(
+            val: .decimal128(BSONDecimal128("1.618")!),
+            alternate: .decimal128(BSONDecimal128("2.718")!)
+        )
         // Bool
         self.checkTrueAndFalse(val: true, alternate: false)
         // String
@@ -217,7 +220,13 @@ final class BSONValueTests: MongoSwiftTestCase {
 
         let cases = [
             BSONNumberTestCase(int: 5, double: 5.0, int32: Int32(5), int64: Int64(5), decimal: BSONDecimal128("5")!),
-            BSONNumberTestCase(int: -5, double: -5.0, int32: Int32(-5), int64: Int64(-5), decimal: BSONDecimal128("-5")!),
+            BSONNumberTestCase(
+                int: -5,
+                double: -5.0,
+                int32: Int32(-5),
+                int64: Int64(-5),
+                decimal: BSONDecimal128("-5")!
+            ),
             BSONNumberTestCase(int: 0, double: 0.0, int32: Int32(0), int64: Int64(0), decimal: BSONDecimal128("0")!),
             BSONNumberTestCase(int: nil, double: 1.234, int32: nil, int64: nil, decimal: BSONDecimal128("1.234")!),
             BSONNumberTestCase(int: nil, double: -31.234, int32: nil, int64: nil, decimal: BSONDecimal128("-31.234")!)