SWIFT-971 Rename BSONEncoder.encode which returns a BSON (#34)

Author: nspektor

Sources/BSON/BSONEncoder.swift

@@ -139,7 +139,7 @@ public class BSONEncoder {
      * - Throws: `EncodingError` if any value throws an error during encoding.
      */
     public func encode<T: Encodable>(_ value: T) throws -> BSONDocument {
-        let encodedBSON: BSON = try self.encode(value)
+        let encodedBSON: BSON = try self.encodeFragment(value)
         switch encodedBSON {
         case let .document(doc):
             return doc
@@ -201,7 +201,7 @@ public class BSONEncoder {
      * - Returns: A new `BSON` containing the encoded BSON data.
      * - Throws: `EncodingError` if any value throws an error during encoding.
      */
-    internal func encode<T: Encodable>(_ value: T) throws -> BSON {
+    internal func encodeFragment<T: Encodable>(_ value: T) throws -> BSON {
         let encoder = _BSONEncoder(options: self.options)
 
         do {

Sources/BSON/ExtendedJSONEncoder.swift

@@ -40,7 +40,7 @@ public class ExtendedJSONEncoder {
         // The `JSON` is then passed through a `JSONEncoder` and outputted as `Data`.
         let encoder = BSONEncoder()
         encoder.userInfo = self.userInfo
-        let bson: BSON = try encoder.encode(value)
+        let bson: BSON = try encoder.encodeFragment(value)
 
         let json: JSON
         switch self.mode {

Tests/BSONTests/BSONCorpusTests.swift

@@ -108,7 +108,9 @@ final class BSONCorpusTests: BSONTestCase {
                     "OK2",
                     // TODO: SWIFT-965
                     "[decq438] clamped zeros... (Clamped)",
-                    "[decq418] clamped zeros... (Clamped)"
+                    "[decq418] clamped zeros... (Clamped)",
+                    // TODO: SWIFT-972
+                    "Special - Negative NaN"
                 ],
             "Array":
                 [

Tests/BSONTests/CodecTests.swift

@@ -53,8 +53,8 @@ final class CodecTests: BSONTestCase {
         expect(try decoder.decode(Array.self, fromBSON: [BSON.int32(1), BSON.int32(2)]))
             .to(equal([1, 2]))
 
-        expect(try encoder.encode(oid)).to(equal(BSON.objectID(oid)))
-        expect(try encoder.encode([Int32(1), Int32(2)])).to(equal([BSON.int32(1), BSON.int32(2)]))
+        expect(try encoder.encodeFragment(oid)).to(equal(BSON.objectID(oid)))
+        expect(try encoder.encodeFragment([Int32(1), Int32(2)])).to(equal([BSON.int32(1), BSON.int32(2)]))
     }
 
     /// Test encoding/decoding a variety of structs containing simple types that have