SWIFT-935 Fix API breakages from old BSON library (#45)

Author: patrickfreed

Sources/SwiftBSON/BSONBinary.swift

@@ -10,7 +10,7 @@ public struct BSONBinary: Equatable, Hashable {
     public let subtype: Subtype
 
     /// Subtypes for BSON Binary values.
-    public struct Subtype: Equatable, Hashable, RawRepresentable {
+    public struct Subtype: Equatable, Hashable, RawRepresentable, Codable {
         // swiftlint:disable force_unwrapping
         /// Generic binary subtype
         public static let generic = Subtype(rawValue: 0x00)!

Sources/SwiftBSON/BSONDocument+Collection.swift

@@ -38,7 +38,7 @@ extension BSONDocument: Collection {
         // criticism also applies to key-based subscripting via `String`.
         // See SWIFT-250.
         self.failIndexCheck(position)
-        var iter = BSONDocumentIterator(over: self)
+        let iter = BSONDocumentIterator(over: self)
 
         for pos in 0..<position {
             guard (try? iter.nextThrowing()) != nil else {

Sources/SwiftBSON/BSONDocument.swift

@@ -259,7 +259,7 @@ public struct BSONDocument {
             return
         }
 
-        var iter = BSONDocumentIterator(over: self.storage.buffer)
+        let iter = BSONDocumentIterator(over: self.storage.buffer)
 
         guard let range = iter.findByteRange(for: key) else {
             throw BSONError.InternalError(message: "Cannot find \(key) to delete")
@@ -342,7 +342,7 @@ public struct BSONDocument {
                 )
             }
 
-            var iter = BSONDocumentIterator(over: self.buffer)
+            let iter = BSONDocumentIterator(over: self.buffer)
             // Implicitly validate with iterator
             do {
                 while let (_, value) = try iter.nextThrowing() {

Sources/SwiftBSON/BSONDocumentIterator.swift

@@ -3,7 +3,7 @@ import NIO
 
 /// Iterator over a `BSONDocument`. This type is not meant to be used directly; please use `Sequence` protocol methods
 /// instead.
-public struct BSONDocumentIterator: IteratorProtocol {
+public class BSONDocumentIterator: IteratorProtocol {
     /// The buffer we are iterating over.
     private var buffer: ByteBuffer
     private var exhausted: Bool
@@ -15,12 +15,12 @@ public struct BSONDocumentIterator: IteratorProtocol {
         self.buffer.moveReaderIndex(to: 4)
     }
 
-    internal init(over doc: BSONDocument) {
-        self = BSONDocumentIterator(over: doc.buffer)
+    internal convenience init(over doc: BSONDocument) {
+        self.init(over: doc.buffer)
     }
 
     /// Advances to the next element and returns it, or nil if no next element exists.
-    public mutating func next() -> BSONDocument.KeyValuePair? {
+    public func next() -> BSONDocument.KeyValuePair? {
         // The only time this would crash is when the document is incorrectly formatted
         do {
             return try self.nextThrowing()
@@ -34,7 +34,7 @@ public struct BSONDocumentIterator: IteratorProtocol {
      * - Throws:
      *   - `InternalError` if the underlying buffer contains invalid BSON
      */
-    internal mutating func nextThrowing() throws -> BSONDocument.KeyValuePair? {
+    internal func nextThrowing() throws -> BSONDocument.KeyValuePair? {
         guard self.buffer.readableBytes != 0 else {
             // Iteration has been exhausted
             guard self.exhausted else {
@@ -88,7 +88,7 @@ public struct BSONDocumentIterator: IteratorProtocol {
 
     /// Finds the key in the underlying buffer, and returns the [startIndex, endIndex) containing the corresponding
     /// element.
-    internal mutating func findByteRange(for searchKey: String) -> Range<Int>? {
+    internal func findByteRange(for searchKey: String) -> Range<Int>? {
         while true {
             let startIndex = self.buffer.readerIndex
             guard let (key, _) = self.next() else {
@@ -116,7 +116,7 @@ public struct BSONDocumentIterator: IteratorProtocol {
             fatalError("endIndex must be >= startIndex")
         }
 
-        var iter = BSONDocumentIterator(over: doc)
+        let iter = BSONDocumentIterator(over: doc)
 
         var excludedKeys: [String] = []
 

Sources/SwiftBSON/BSONTimestamp.swift

@@ -18,6 +18,12 @@ public struct BSONTimestamp: BSONValue, Equatable, Hashable {
         self.increment = inc
     }
 
+    /// Initializes a new  `BSONTimestamp` with the provided `timestamp` and `increment` values. Assumes
+    /// the values can successfully be converted to `UInt32`s without loss of precision.
+    public init(timestamp: Int, inc: Int) {
+        self.init(timestamp: UInt32(timestamp), inc: UInt32(inc))
+    }
+
     /*
      * Initializes a `BSONTimestamp` from ExtendedJSON.
      *

Tests/SwiftBSONTests/BSONDocument+SequenceTests.swift

@@ -21,7 +21,7 @@ final class Document_SequenceTests: BSONTestCase {
         ]
 
         // create and use iter manually
-        var iter = doc.makeIterator()
+        let iter = doc.makeIterator()
 
         let stringTup = iter.next()!
         expect(stringTup.key).to(equal("string"))

Tests/SwiftBSONTests/BSONDocumentIteratorTests.swift

@@ -6,14 +6,14 @@ import XCTest
 final class DocumentIteratorTests: BSONTestCase {
     func testFindByteRangeEmpty() {
         let d: BSONDocument = [:]
-        var iter = d.makeIterator()
+        let iter = d.makeIterator()
         let range = iter.findByteRange(for: "item")
         expect(range).to(beNil())
     }
 
     func testFindByteRangeItemsInt32() {
         let d: BSONDocument = ["item0": .int32(32), "item1": .int32(32)]
-        var iter = d.makeIterator()
+        let iter = d.makeIterator()
         let maybeRange = iter.findByteRange(for: "item1")
 
         expect(maybeRange).toNot(beNil())