Merge branch 'release-1.1.0'

tsolomko · tsolomko · commit a16e37d508cf · 2018-03-02T21:56:28.000+03:00
diff --git a/.jazzy.yaml b/.jazzy.yaml
@@ -3,11 +3,11 @@ sourcekitten_sourcefile: docs.json
 clean: true
 author: Timofey Solomko
 module: BitByteData
-module_version: 1.0.2
+module_version: 1.1.0
 copyright: '© 2018 Timofey Solomko'
 readme: README.md
 github_url: https://github.com/tsolomko/BitByteData
-github_file_prefix: https://github.com/tsolomko/BitByteData/tree/1.0.2
+github_file_prefix: https://github.com/tsolomko/BitByteData/tree/1.1.0
 theme: fullwidth
 
 custom_categories:
diff --git a/.swiftlint.yml b/.swiftlint.yml
@@ -1,10 +1,13 @@
+excluded:
+  - .build/
 opt_in_rules:
   - array_init
   - block_based_kvo
   - conditional_returns_on_newline
   - contains_over_first_not_nil
   - discouraged_direct_init
   - discouraged_object_literal
+  - discouraged_optional_boolean
   - explicit_init
   - fatal_error_message
   - first_where
diff --git a/.travis.yml b/.travis.yml
@@ -2,6 +2,7 @@ jobs:
   include:
     - stage: test
       language: objective-c
+      os: osx
       osx_image: xcode9.2
       script:
       - swift build
@@ -19,6 +20,7 @@ jobs:
     - stage: deploy
       if: tag IS present
       language: objective-c
+      os: osx
       osx_image: xcode9.2
       env:
         secure: fmKQgrPRx2iisNPzxDhOTfXPsnQMJxDgIMItVNjl1AKByraOpiDAGVESySvy+vwQqITCB/BfvdkW7smAPcvFJxIPRx1v4J0VY9kGHdnafMw35XY0Vj9soYkzNS4zrUebxY2gWkGM6Q6dgLOGT/9MSEyWqXBTtVz9sLwA7yr3ZI72yZDbcSz3XGa1fFZRVfwv3I+bmuozG7dq7tyqcSKgRZnHg1VvaRdxcaGqSGSUsNu0YLzmNedujNcU+gTXcxMdrXA1eaheHc2pwNA0TDf3KkefJpaVMXrA/Un8e9MaJ1lMnPlIiEI3dPTuogtQY7p59vgulBNBPEJovTHI0jCaNyLUkTkHgGcUuOwHqwUIKZCEiiqM1j12sdLo4O2tAdNaNHDtd8D3bCakrdJxXlUWVfjrCwvBB555gd0drRirQgYX+5gGFwnTQE8tOcjK4qUvJaOAouHsnm/DmW+fLJPX76KoU6QOtGJt6PQ92yBgKRhaSg/sQ28WPuCmF2p7BuUSuULxcM2LU5eA5aFxayoZvR2E9uvfFxnFh01iV6clcZo25U03AuxJmuI7Mhl83amj8bm5CRBbuRw5sIljXfBujFUel+kz/HXalS7lStqH9iPyiQvh24WkPzHKNQdjRI7v3kyrVSXJ3Xl6+fopXqr/25MwqD4bt57QgglJ2IQtnLM=
diff --git a/BitByteData.podspec b/BitByteData.podspec
@@ -1,7 +1,7 @@
 Pod::Spec.new do |s|
 
   s.name         = "BitByteData"
-  s.version      = "1.0.2"
+  s.version      = "1.1.0"
   s.summary      = "Read and write bits and bytes in Swift."
   
   s.description  = "A Swift framework with classes for reading and writing bits and bytes."
diff --git a/BitByteData.xcodeproj/BitByteData.plist b/BitByteData.xcodeproj/BitByteData.plist
@@ -15,9 +15,9 @@
 	<key>CFBundlePackageType</key>
 	<string>FMWK</string>
 	<key>CFBundleShortVersionString</key>
-	<string>1.0.2</string>
+	<string>1.1.0</string>
 	<key>CFBundleVersion</key>
-	<string>6</string>
+	<string>8</string>
 	<key>NSHumanReadableCopyright</key>
 	<string>Copyright © 2018 Timofey Solomko. All rights reserved.</string>
 </dict>
diff --git a/BitByteData.xcodeproj/TestBitByteData.plist b/BitByteData.xcodeproj/TestBitByteData.plist
@@ -15,8 +15,8 @@
 	<key>CFBundlePackageType</key>
 	<string>BNDL</string>
 	<key>CFBundleShortVersionString</key>
-	<string>1.0.2</string>
+	<string>1.1.0</string>
 	<key>CFBundleVersion</key>
-	<string>6</string>
+	<string>8</string>
 </dict>
 </plist>
diff --git a/BitByteData.xcodeproj/project.pbxproj b/BitByteData.xcodeproj/project.pbxproj
@@ -248,7 +248,7 @@
 				CLANG_WARN_SUSPICIOUS_MOVE = YES;
 				CLANG_WARN_UNREACHABLE_CODE = YES;
 				CLANG_WARN__DUPLICATE_METHOD_MATCH = YES;
-				CURRENT_PROJECT_VERSION = 6;
+				CURRENT_PROJECT_VERSION = 8;
 				DEBUG_INFORMATION_FORMAT = dwarf;
 				ENABLE_STRICT_OBJC_MSGSEND = YES;
 				ENABLE_TESTABILITY = YES;
@@ -290,7 +290,7 @@
 				CLANG_WARN_SUSPICIOUS_MOVE = YES;
 				CLANG_WARN_UNREACHABLE_CODE = YES;
 				CLANG_WARN__DUPLICATE_METHOD_MATCH = YES;
-				CURRENT_PROJECT_VERSION = 6;
+				CURRENT_PROJECT_VERSION = 8;
 				DEBUG_INFORMATION_FORMAT = "dwarf-with-dsym";
 				ENABLE_STRICT_OBJC_MSGSEND = YES;
 				GCC_NO_COMMON_BLOCKS = YES;
@@ -318,7 +318,7 @@
 				APPLICATION_EXTENSION_API_ONLY = YES;
 				DEFINES_MODULE = YES;
 				DYLIB_COMPATIBILITY_VERSION = 1;
-				DYLIB_CURRENT_VERSION = 6;
+				DYLIB_CURRENT_VERSION = 8;
 				DYLIB_INSTALL_NAME_BASE = "@rpath";
 				INFOPLIST_FILE = BitByteData.xcodeproj/BitByteData.plist;
 				INSTALL_PATH = "$(LOCAL_LIBRARY_DIR)/Frameworks";
@@ -337,7 +337,7 @@
 				APPLICATION_EXTENSION_API_ONLY = YES;
 				DEFINES_MODULE = YES;
 				DYLIB_COMPATIBILITY_VERSION = 1;
-				DYLIB_CURRENT_VERSION = 6;
+				DYLIB_CURRENT_VERSION = 8;
 				DYLIB_INSTALL_NAME_BASE = "@rpath";
 				INFOPLIST_FILE = BitByteData.xcodeproj/BitByteData.plist;
 				INSTALL_PATH = "$(LOCAL_LIBRARY_DIR)/Frameworks";
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,11 @@
 # Changelog
 
+## 1.1.0
+
+- Added converting from `ByteReader` initializers to `LsbBitReader` and `MsbBitReader`, as well as `BitReader` protocol.
+- Added `bitsLeft` and `bitsRead` computed properties to `LsbBitReader` and `MsbBitReader`, as well as `BitReader`
+  protocol.
+
 ## 1.0.2
 
 - Fix several problems causing incorrect preconditions failures.
diff --git a/Sources/BitReader.swift b/Sources/BitReader.swift
@@ -11,9 +11,21 @@ public protocol BitReader: class {
     /// True, if reader's BIT pointer is aligned with the BYTE border.
     var isAligned: Bool { get }
 
+    // Amount of bits left to read.
+    var bitsLeft: Int { get }
+
+    // Amount of bits that were already read.
+    var bitsRead: Int { get }
+
     /// Creates an instance for reading bits (and bytes) from `data`.
     init(data: Data)
 
+    /**
+     Converts a `ByteReader` instance into `BitReader`, enabling bits reading capabilities. Current `offset` value of
+     `byteReader` is preserved.
+     */
+    init(_ byteReader: ByteReader)
+
     /// Reads bit and returns it, advancing by one BIT position.
     func bit() -> UInt8
 
diff --git a/Sources/ByteReader.swift b/Sources/ByteReader.swift
@@ -41,8 +41,8 @@ public class ByteReader {
      */
     public func byte() -> UInt8 {
         precondition(self.offset < self.data.endIndex)
-        self.offset += 1
-        return self.data[self.offset - 1]
+        defer { self.offset += 1 }
+        return self.data[self.offset]
     }
 
     /**
@@ -56,9 +56,8 @@ public class ByteReader {
         guard count > 0
             else { return [] }
         precondition(self.offset + count <= self.data.endIndex)
-        let result = self.data[self.offset..<self.offset + count].toArray(type: UInt8.self, count: count)
-        self.offset += count
-        return result
+        defer { self.offset += count }
+        return self.data[self.offset..<self.offset + count].toArray(type: UInt8.self, count: count)
     }
 
     /**
@@ -68,9 +67,8 @@ public class ByteReader {
      */
     public func uint64() -> UInt64 {
         precondition(self.offset + 8 <= self.data.endIndex)
-        let result = self.data[self.offset..<self.offset + 8].to(type: UInt64.self)
-        self.offset += 8
-        return result
+        defer { self.offset += 8 }
+        return self.data[self.offset..<self.offset + 8].to(type: UInt64.self)
     }
 
     /**
@@ -80,9 +78,8 @@ public class ByteReader {
      */
     public func uint32() -> UInt32 {
         precondition(self.offset + 4 <= self.data.endIndex)
-        let result = self.data[self.offset..<self.offset + 4].to(type: UInt32.self)
-        self.offset += 4
-        return result
+        defer { self.offset += 4 }
+        return self.data[self.offset..<self.offset + 4].to(type: UInt32.self)
     }
 
     /**
@@ -92,9 +89,8 @@ public class ByteReader {
      */
     public func uint16() -> UInt16 {
         precondition(self.offset + 2 <= self.data.endIndex)
-        let result = self.data[self.offset..<self.offset + 2].to(type: UInt16.self)
-        self.offset += 2
-        return result
+        defer { self.offset += 2 }
+        return self.data[self.offset..<self.offset + 2].to(type: UInt16.self)
     }
 
 }
diff --git a/Sources/LsbBitReader.swift b/Sources/LsbBitReader.swift
@@ -5,32 +5,50 @@
 
 import Foundation
 
-/**
- A type that contains functions for reading `Data` bit-by-bit and byte-by-byte,
- assuming "LSB 0" bit numbering scheme.
- */
+/// A type that contains functions for reading `Data` bit-by-bit and byte-by-byte, assuming "LSB0" bit numbering scheme.
 public final class LsbBitReader: ByteReader, BitReader {
 
     private var bitMask: UInt8 = 1
     private var currentByte: UInt8
 
-    private var bitsLeft: Int {
-        if isFinished {
+    /// True, if reader's BIT pointer is aligned with the BYTE border.
+    public var isAligned: Bool {
+        return self.bitMask == 1
+    }
+
+    // Amount of bits left to read.
+    public var bitsLeft: Int {
+        if self.isFinished {
             return 0
         } else {
-            return (self.data.endIndex - self.offset) * 8 + 8 - bitMask.trailingZeroBitCount
+            return (self.data.endIndex - self.offset) * 8 - self.bitMask.trailingZeroBitCount
         }
     }
 
+    // Amount of bits that were already read.
+    public var bitsRead: Int {
+        if self.isFinished {
+            return 8 * self.size
+        } else {
+            return (self.offset - self.data.startIndex) * 8 + self.bitMask.trailingZeroBitCount
+        }
+
+    }
+
     /// Creates an instance for reading bits (and bytes) from `data`.
     public override init(data: Data) {
         self.currentByte = data.first ?? 0
         super.init(data: data)
     }
 
-    /// True, if reader's BIT pointer is aligned with the BYTE border.
-    public var isAligned: Bool {
-        return self.bitMask == 1
+    /**
+     Converts a `ByteReader` instance into `LsbBitReader`, enabling bit reading capabilities. Current `offset` value of
+     `byteReader` is preserved.
+     */
+    public init(_ byteReader: ByteReader) {
+        self.currentByte = byteReader.offset < byteReader.data.endIndex ? byteReader.data[byteReader.offset] : 0
+        super.init(data: byteReader.data)
+        self.offset = byteReader.offset
     }
 
     /**
diff --git a/Sources/MsbBitReader.swift b/Sources/MsbBitReader.swift
@@ -5,32 +5,50 @@
 
 import Foundation
 
-/**
- A type that contains functions for reading `Data` bit-by-bit and byte-by-byte,
- assuming "MSB 0" bit numbering scheme.
- */
+/// A type that contains functions for reading `Data` bit-by-bit and byte-by-byte, assuming "MSB0" bit numbering scheme.
 public final class MsbBitReader: ByteReader, BitReader {
 
     private var bitMask: UInt8 = 128
     private var currentByte: UInt8
 
-    private var bitsLeft: Int {
-        if isFinished {
+    /// True, if reader's BIT pointer is aligned with the BYTE border.
+    public var isAligned: Bool {
+        return self.bitMask == 128
+    }
+
+    // Amount of bits left to read.
+    public var bitsLeft: Int {
+        if self.isFinished {
             return 0
         } else {
-            return (self.data.endIndex - self.offset) * 8 + 8 - bitMask.leadingZeroBitCount
+            return (self.data.endIndex - self.offset) * 8 - self.bitMask.leadingZeroBitCount
         }
     }
 
+    // Amount of bits that were already read.
+    public var bitsRead: Int {
+        if self.isFinished {
+            return 8 * self.size
+        } else {
+            return (self.offset - self.data.startIndex) * 8 + self.bitMask.leadingZeroBitCount
+        }
+
+    }
+
     /// Creates an instance for reading bits (and bytes) from `data`.
     public override init(data: Data) {
         self.currentByte = data.first ?? 0
         super.init(data: data)
     }
 
-    /// True, if reader's BIT pointer is aligned with the BYTE border.
-    public var isAligned: Bool {
-        return self.bitMask == 128
+    /**
+     Converts a `ByteReader` instance into `MsbBitReader`, enabling bit reading capabilities. Current `offset` value of
+     `byteReader` is preserved.
+     */
+    public init(_ byteReader: ByteReader) {
+        self.currentByte = byteReader.offset < byteReader.data.endIndex ? byteReader.data[byteReader.offset] : 0
+        super.init(data: byteReader.data)
+        self.offset = byteReader.offset
     }
 
     /**
diff --git a/Tests/BitByteDataTests/LsbBitReaderTests.swift b/Tests/BitByteDataTests/LsbBitReaderTests.swift
@@ -120,4 +120,40 @@ class LsbBitReaderTests: XCTestCase {
         XCTAssertEqual(bitReader.int(fromBits: 4), 13)
     }
 
+    func testConvertedByteReader() {
+        let byteReader = ByteReader(data: LsbBitReaderTests.data)
+        _ = byteReader.byte()
+        let bitReader = LsbBitReader(byteReader)
+        XCTAssertEqual(bitReader.bits(count: 4), [0, 1, 1, 0])
+        XCTAssertEqual(bitReader.int(fromBits: 4), 13)
+    }
+
+    func testBitsLeft() {
+        let bitReader = LsbBitReader(data: LsbBitReaderTests.data)
+
+        XCTAssertEqual(bitReader.bitsLeft, 16)
+        _ = bitReader.bits(count: 4)
+        XCTAssertEqual(bitReader.bitsLeft, 12)
+        _ = bitReader.bits(count: 4)
+        XCTAssertEqual(bitReader.bitsLeft, 8)
+        _ = bitReader.bits(count: 2)
+        XCTAssertEqual(bitReader.bitsLeft, 6)
+        _ = bitReader.bits(count: 6)
+        XCTAssertEqual(bitReader.bitsLeft, 0)
+    }
+
+    func testBitsRead() {
+        let bitReader = LsbBitReader(data: LsbBitReaderTests.data)
+
+        XCTAssertEqual(bitReader.bitsRead, 0)
+        _ = bitReader.bits(count: 4)
+        XCTAssertEqual(bitReader.bitsRead, 4)
+        _ = bitReader.bits(count: 4)
+        XCTAssertEqual(bitReader.bitsRead, 8)
+        _ = bitReader.bits(count: 2)
+        XCTAssertEqual(bitReader.bitsRead, 10)
+        _ = bitReader.bits(count: 6)
+        XCTAssertEqual(bitReader.bitsRead, 16)
+    }
+
 }
diff --git a/Tests/BitByteDataTests/MsbBitReaderTests.swift b/Tests/BitByteDataTests/MsbBitReaderTests.swift
diff --git a/Tests/LinuxMain.swift b/Tests/LinuxMain.swift
