Add tests and benchmarks for the new advance(by:) function of bit readers

Author: tsolomko

Tests/BitByteDataBenchmarks/LsbBitReaderBenchmarks.swift

@@ -8,6 +8,16 @@ import BitByteData
 
 class LsbBitReaderBenchmarks: XCTestCase {
 
+    func testAdvance() {
+        self.measure {
+            let bitReader = LsbBitReader(data: Data(count: 10_485_760)) // 10 MB
+
+            for _ in 0..<5_000_000 * 8 {
+                bitReader.advance()
+            }
+        }
+    }
+
     func testBit() {
         self.measure {
             let bitReader = LsbBitReader(data: Data(count: 10_485_760)) // 10 MB

Tests/BitByteDataBenchmarks/MsbBitReaderBenchmarks.swift

@@ -8,6 +8,16 @@ import BitByteData
 
 class MsbBitReaderBenchmarks: XCTestCase {
 
+    func testAdvance() {
+        self.measure {
+            let bitReader = MsbBitReader(data: Data(count: 10_485_760)) // 10 MB
+
+            for _ in 0..<5_000_000 * 8 {
+                bitReader.advance()
+            }
+        }
+    }
+
     func testBit() {
         self.measure {
             let bitReader = MsbBitReader(data: Data(count: 10_485_760)) // 10 MB

Tests/BitByteDataTests/LsbBitReaderTests.swift

@@ -10,6 +10,21 @@ class LsbBitReaderTests: XCTestCase {
 
     private static let data = Data(bytes: [0x5A, 0xD6, 0x57, 0x14, 0xAB, 0xCC, 0x2D, 0x88, 0xEA, 0x00])
 
+    func testAdvance() {
+        let bitReader = LsbBitReader(data: LsbBitReaderTests.data)
+
+        XCTAssertEqual(bitReader.bit(), 0)
+        bitReader.advance()
+        XCTAssertEqual(bitReader.bit(), 0)
+        bitReader.advance()
+        bitReader.advance()
+        XCTAssertEqual(bitReader.bit(), 0)
+        bitReader.advance(by: 4)
+        XCTAssertEqual(bitReader.bit(), 1)
+
+        XCTAssertFalse(bitReader.isAligned)
+    }
+
     func testBit() {
         let bitReader = LsbBitReader(data: LsbBitReaderTests.data)
 

Tests/BitByteDataTests/MsbBitReaderTests.swift

@@ -10,6 +10,21 @@ class MsbBitReaderTests: XCTestCase {
 
     private static let data = Data(bytes: [0x5A, 0xD6, 0x57, 0x14, 0xAB, 0xCC, 0x2D, 0x88, 0xEA, 0x00])
 
+    func testAdvance() {
+        let bitReader = MsbBitReader(data: MsbBitReaderTests.data)
+
+        XCTAssertEqual(bitReader.bit(), 0)
+        bitReader.advance()
+        XCTAssertEqual(bitReader.bit(), 0)
+        bitReader.advance()
+        bitReader.advance()
+        XCTAssertEqual(bitReader.bit(), 0)
+        bitReader.advance(by: 4)
+        XCTAssertEqual(bitReader.bit(), 0)
+
+        XCTAssertFalse(bitReader.isAligned)
+    }
+
     func testBit() {
         let bitReader = MsbBitReader(data: MsbBitReaderTests.data)
 

Tests/LinuxMain.swift

@@ -30,6 +30,7 @@ extension ByteReaderTests {
 extension LsbBitReaderTests {
 	static var allTests: [(String, (LsbBitReaderTests) -> () -> Void)] {
 		return [
+            ("testAdvance", testAdvance),
             ("testBit", testBit),
 			("testBits", testBits),
 			("testIntFromBits", testIntFromBits),
@@ -57,6 +58,7 @@ extension LsbBitReaderTests {
 extension MsbBitReaderTests {
 	static var allTests: [(String, (MsbBitReaderTests) -> () -> Void)] {
 		return [
+            ("testAdvance", testAdvance),
 			("testBit", testBit),
 			("testBits", testBits),
 			("testIntFromBits", testIntFromBits),
@@ -130,6 +132,7 @@ extension ByteReaderBenchmarks {
 extension LsbBitReaderBenchmarks {
     static var allTests: [(String, (LsbBitReaderBenchmarks) -> () -> Void)] {
         return [
+            ("testAdvance", testAdvance),
             ("testBit", testBit),
             ("testBits", testBits),
             ("testIntFromBits", testIntFromBits),
@@ -144,6 +147,7 @@ extension LsbBitReaderBenchmarks {
 extension MsbBitReaderBenchmarks {
     static var allTests: [(String, (MsbBitReaderBenchmarks) -> () -> Void)] {
         return [
+            ("testAdvance", testAdvance),
             ("testBit", testBit),
             ("testBits", testBits),
             ("testIntFromBits", testIntFromBits),