Merge branch 'develop'

Author: tsolomko

.jazzy.yaml

@@ -3,11 +3,11 @@ sourcekitten_sourcefile: docs.json
 clean: true
 author: Timofey Solomko
 module: BitByteData
-module_version: 1.0.0
+module_version: 1.0.1
 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.0
+github_file_prefix: https://github.com/tsolomko/BitByteData/tree/1.0.1
 theme: fullwidth
 
 custom_categories:

.travis.yml

@@ -32,14 +32,18 @@ jobs:
       - brew install sourcekitten
       - gem install -N jazzy
       before_deploy:
-      # Necessary for correct SourceKitten processing.
-      - swift build
-      # Build Carthage archive.
-      - carthage build --no-skip-current
-      - carthage archive BitByteData
-      # Generate documentation.
-      - sourcekitten doc --spm-module BitByteData > docs.json
-      - jazzy
+      - >
+        if ! [ "$BEFORE_DEPLOY_RUN" ]; then
+          export BEFORE_DEPLOY_RUN=1;
+          # Necessary for correct SourceKitten processing.
+          swift build
+          # Build Carthage archive.
+          carthage build --no-skip-current
+          carthage archive BitByteData
+          # Generate documentation.
+          sourcekitten doc --spm-module BitByteData > docs.json
+          jazzy
+        fi
       deploy:
       - provider: releases
         skip_cleanup: true

BitByteData.podspec

@@ -1,7 +1,7 @@
 Pod::Spec.new do |s|
 
   s.name         = "BitByteData"
-  s.version      = "1.0.0"
+  s.version      = "1.0.1"
   s.summary      = "Read and write bits and bytes in Swift."
 
   s.description  = "A Swift framework with classes for reading and writing bits and bytes."

BitByteData.xcodeproj/BitByteData.plist

@@ -15,9 +15,9 @@
 	<key>CFBundlePackageType</key>
 	<string>FMWK</string>
 	<key>CFBundleShortVersionString</key>
-	<string>1.0.0</string>
+	<string>1.0.1</string>
 	<key>CFBundleVersion</key>
-	<string>4</string>
+	<string>5</string>
 	<key>NSHumanReadableCopyright</key>
 	<string>Copyright © 2018 Timofey Solomko. All rights reserved.</string>
 </dict>

BitByteData.xcodeproj/TestBitByteData.plist

@@ -15,8 +15,8 @@
 	<key>CFBundlePackageType</key>
 	<string>BNDL</string>
 	<key>CFBundleShortVersionString</key>
-	<string>1.0.0</string>
+	<string>1.0.1</string>
 	<key>CFBundleVersion</key>
-	<string>4</string>
+	<string>5</string>
 </dict>
 </plist>

BitByteData.xcodeproj/project.pbxproj

@@ -76,14 +76,14 @@
 		06F065561FFAEA1F00312A82 /* Sources */ = {
 			isa = PBXGroup;
 			children = (
-				06F065571FFAEA1F00312A82 /* LsbBitReader.swift */,
-				06F065581FFAEA1F00312A82 /* BitReader.swift */,
+				06F0655B1FFAEA1F00312A82 /* Extensions.swift */,
 				06F065591FFAEA1F00312A82 /* ByteReader.swift */,
+				06F065581FFAEA1F00312A82 /* BitReader.swift */,
+				06F065571FFAEA1F00312A82 /* LsbBitReader.swift */,
 				06F0655A1FFAEA1F00312A82 /* MsbBitReader.swift */,
-				06F0655B1FFAEA1F00312A82 /* Extensions.swift */,
-				06F0655C1FFAEA1F00312A82 /* MsbBitWriter.swift */,
 				06F0655D1FFAEA1F00312A82 /* BitWriter.swift */,
 				06F0655E1FFAEA1F00312A82 /* LsbBitWriter.swift */,
+				06F0655C1FFAEA1F00312A82 /* MsbBitWriter.swift */,
 			);
 			path = Sources;
 			sourceTree = "<group>";
@@ -100,11 +100,11 @@
 		06F065611FFAEA1F00312A82 /* BitByteDataTests */ = {
 			isa = PBXGroup;
 			children = (
-				06F065621FFAEA1F00312A82 /* MsbBitWriterTests.swift */,
+				06F065661FFAEA1F00312A82 /* ByteReaderTests.swift */,
+				06F065651FFAEA1F00312A82 /* LsbBitReaderTests.swift */,
 				06F065631FFAEA1F00312A82 /* MsbBitReaderTests.swift */,
 				06F065641FFAEA1F00312A82 /* LsbBitWriterTests.swift */,
-				06F065651FFAEA1F00312A82 /* LsbBitReaderTests.swift */,
-				06F065661FFAEA1F00312A82 /* ByteReaderTests.swift */,
+				06F065621FFAEA1F00312A82 /* MsbBitWriterTests.swift */,
 			);
 			path = BitByteDataTests;
 			sourceTree = "<group>";
@@ -248,7 +248,7 @@
 				CLANG_WARN_SUSPICIOUS_MOVE = YES;
 				CLANG_WARN_UNREACHABLE_CODE = YES;
 				CLANG_WARN__DUPLICATE_METHOD_MATCH = YES;
-				CURRENT_PROJECT_VERSION = 4;
+				CURRENT_PROJECT_VERSION = 5;
 				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 = 4;
+				CURRENT_PROJECT_VERSION = 5;
 				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 = 4;
+				DYLIB_CURRENT_VERSION = 5;
 				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 = 4;
+				DYLIB_CURRENT_VERSION = 5;
 				DYLIB_INSTALL_NAME_BASE = "@rpath";
 				INFOPLIST_FILE = BitByteData.xcodeproj/BitByteData.plist;
 				INSTALL_PATH = "$(LOCAL_LIBRARY_DIR)/Frameworks";

CHANGELOG.md

@@ -1,6 +1,12 @@
 # Changelog
 
-## v1.0.0
+## 1.0.1
+
+- Increased performance of `bit()`, `bits(count:)` and `int(fromBits:)` functions for both `LsbBitReader` and `MsbBitReader`.
+- More consistent behaviour (precondition failures) for situtations when there is not enough data left.
+- Small updates to documentation.
+
+## 1.0.0
 
 - `ByteReader` class for reading bytes.
 - `BitReader` protocol, `LsbBitReader` and `MsbBitReader` classes for reading bits (and bytes).

Sources/BitReader.swift

@@ -11,7 +11,7 @@ public protocol BitReader: class {
     /// True, if reader's BIT pointer is aligned with the BYTE border.
     var isAligned: Bool { get }
 
-    /// Creates an instance for reading `data`.
+    /// Creates an instance for reading bits (and bytes) from `data`.
     init(data: Data)
 
     /// Reads bit and returns it, advancing by one BIT position.
@@ -44,23 +44,3 @@ public protocol BitReader: class {
     func uint16() -> UInt16
 
 }
-
-extension BitReader {
-
-    /**
-     - Warning: Doesn't check if there is any data left.
-     */
-    public func bits(count: Int) -> [UInt8] {
-        guard count > 0
-            else { return [] }
-
-        var array = [UInt8]()
-        array.reserveCapacity(count)
-        for _ in 0..<count {
-            array.append(self.bit())
-        }
-
-        return array
-    }
-
-}

Sources/BitWriter.swift

@@ -14,7 +14,7 @@ public protocol BitWriter {
     /// True, if writer's BIT pointer is aligned with the BYTE border.
     var isAligned: Bool { get }
 
-    /// Creates an instance for writing.
+    /// Creates an instance for writing bits (and bytes).
     init()
 
     /// Writes `bit`, advancing by one BIT position.

Sources/ByteReader.swift

@@ -27,7 +27,7 @@ public class ByteReader {
         return self.data.endIndex <= self.offset
     }
 
-    /// Creates an instance for reading `data`.
+    /// Creates an instance for reading bytes from `data`.
     public init(data: Data) {
         self.size = data.count
         self.data = data
@@ -37,21 +37,25 @@ public class ByteReader {
     /**
      Reads byte and returns it, advancing by one position.
 
-     - Warning: Doesn't check if there is any data left. It is advisable to use `isFinished` BEFORE calling this method
-     to check if the end is reached.
+     - Precondition: There MUST be enough data left.
      */
     public func byte() -> UInt8 {
+        precondition(self.offset < self.size)
         self.offset += 1
         return self.data[self.offset - 1]
     }
 
     /**
      Reads `count` bytes and returns them as an array of `UInt8`, advancing by `count` positions.
 
-     - Warning: Doesn't check if there is any data left. It is advisable to use `isFinished` BEFORE calling this method
-     to check if the end is reached.
+     - Precondition: Parameter `count` MUST not be less than 0.
+     - Precondition: There MUST be enough data left.
      */
     public func bytes(count: Int) -> [UInt8] {
+        precondition(count >= 0)
+        guard count > 0
+            else { return [] }
+        precondition(self.offset + count <= self.size)
         let result = self.data[self.offset..<self.offset + count].toArray(type: UInt8.self, count: count)
         self.offset += count
         return result
@@ -60,10 +64,10 @@ public class ByteReader {
     /**
      Reads 8 bytes and returns them as a `UInt64` number, advancing by 8 positions.
 
-     - Warning: Doesn't check if there is any data left. It is advisable to use `isFinished` BEFORE calling this method
-     to check if the end is reached.
+     - Precondition: There MUST be enough data left.
      */
     public func uint64() -> UInt64 {
+        precondition(self.offset + 8 <= self.size)
         let result = self.data[self.offset..<self.offset + 8].to(type: UInt64.self)
         self.offset += 8
         return result
@@ -72,10 +76,10 @@ public class ByteReader {
     /**
      Reads 4 bytes and returns them as a `UInt32` number, advancing by 4 positions.
 
-     - Warning: Doesn't check if there is any data left. It is advisable to use `isFinished` BEFORE calling this method
-     to check if the end is reached.
+     - Precondition: There MUST be enough data left.
      */
     public func uint32() -> UInt32 {
+        precondition(self.offset + 4 <= self.size)
         let result = self.data[self.offset..<self.offset + 4].to(type: UInt32.self)
         self.offset += 4
         return result
@@ -84,10 +88,10 @@ public class ByteReader {
     /**
      Reads 2 bytes and returns them as a `UInt16` number, advancing by 2 positions.
 
-     - Warning: Doesn't check if there is any data left. It is advisable to use `isFinished` BEFORE calling this method
-     to check if the end is reached.
+     - Precondition: There MUST be enough data left.
      */
     public func uint16() -> UInt16 {
+        precondition(self.offset + 2 <= self.size)
         let result = self.data[self.offset..<self.offset + 2].to(type: UInt16.self)
         self.offset += 2
         return result