Merge branch 'develop'

Author: tsolomko

.jazzy.yaml

@@ -3,11 +3,11 @@ sourcekitten_sourcefile: docs.json
 clean: false
 author: Timofey Solomko
 module: BitByteData
-module_version: 2.0.0
+module_version: 2.0.1
 copyright: '© 2021 Timofey Solomko'
 readme: README.md
 github_url: https://github.com/tsolomko/BitByteData
-github_file_prefix: https://github.com/tsolomko/BitByteData/tree/2.0.0
+github_file_prefix: https://github.com/tsolomko/BitByteData/tree/2.0.1
 theme: fullwidth
 
 custom_categories:

BitByteData.podspec

@@ -1,7 +1,7 @@
 Pod::Spec.new do |s|
 
   s.name         = "BitByteData"
-  s.version      = "2.0.0"
+  s.version      = "2.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>2.0.0</string>
+	<string>2.0.1</string>
 	<key>CFBundleVersion</key>
-	<string>26</string>
+	<string>27</string>
 	<key>NSHumanReadableCopyright</key>
 	<string>Copyright © 2021 Timofey Solomko</string>
 </dict>

BitByteData.xcodeproj/BitByteDataBenchmarks.plist

@@ -15,8 +15,8 @@
 	<key>CFBundlePackageType</key>
 	<string>BNDL</string>
 	<key>CFBundleShortVersionString</key>
-	<string>2.0.0</string>
+	<string>2.0.1</string>
 	<key>CFBundleVersion</key>
-	<string>26</string>
+	<string>27</string>
 </dict>
 </plist>

BitByteData.xcodeproj/TestBitByteData.plist

@@ -15,8 +15,8 @@
 	<key>CFBundlePackageType</key>
 	<string>BNDL</string>
 	<key>CFBundleShortVersionString</key>
-	<string>2.0.0</string>
+	<string>2.0.1</string>
 	<key>CFBundleVersion</key>
-	<string>26</string>
+	<string>27</string>
 </dict>
 </plist>

BitByteData.xcodeproj/project.pbxproj

@@ -406,7 +406,7 @@
 				CLANG_WARN_SUSPICIOUS_MOVE = YES;
 				CLANG_WARN_UNREACHABLE_CODE = YES;
 				CLANG_WARN__DUPLICATE_METHOD_MATCH = YES;
-				CURRENT_PROJECT_VERSION = 26;
+				CURRENT_PROJECT_VERSION = 27;
 				DEBUG_INFORMATION_FORMAT = dwarf;
 				ENABLE_STRICT_OBJC_MSGSEND = YES;
 				ENABLE_TESTABILITY = YES;
@@ -455,7 +455,7 @@
 				CLANG_WARN_SUSPICIOUS_MOVE = YES;
 				CLANG_WARN_UNREACHABLE_CODE = YES;
 				CLANG_WARN__DUPLICATE_METHOD_MATCH = YES;
-				CURRENT_PROJECT_VERSION = 26;
+				CURRENT_PROJECT_VERSION = 27;
 				DEBUG_INFORMATION_FORMAT = "dwarf-with-dsym";
 				ENABLE_STRICT_OBJC_MSGSEND = YES;
 				GCC_NO_COMMON_BLOCKS = YES;
@@ -484,7 +484,7 @@
 				APPLICATION_EXTENSION_API_ONLY = YES;
 				DEFINES_MODULE = YES;
 				DYLIB_COMPATIBILITY_VERSION = 1;
-				DYLIB_CURRENT_VERSION = 26;
+				DYLIB_CURRENT_VERSION = 27;
 				DYLIB_INSTALL_NAME_BASE = "@rpath";
 				INFOPLIST_FILE = BitByteData.xcodeproj/BitByteData.plist;
 				INSTALL_PATH = "$(LOCAL_LIBRARY_DIR)/Frameworks";
@@ -508,7 +508,7 @@
 				APPLICATION_EXTENSION_API_ONLY = YES;
 				DEFINES_MODULE = YES;
 				DYLIB_COMPATIBILITY_VERSION = 1;
-				DYLIB_CURRENT_VERSION = 26;
+				DYLIB_CURRENT_VERSION = 27;
 				DYLIB_INSTALL_NAME_BASE = "@rpath";
 				INFOPLIST_FILE = BitByteData.xcodeproj/BitByteData.plist;
 				INSTALL_PATH = "$(LOCAL_LIBRARY_DIR)/Frameworks";

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 2.0.1
+
+- Added an explicit precondition on `bitsCount` argument in the default implementation of the
+`BitWriter.write(signedNumber:bitsCount:representation:)` function.
+- Added missing documentation about a precondition in `L/MsbBitWriter.write(unsignedNumber:bitsCount:)`.
+
 ## 2.0.0
 
 - Swift 4.2 is no longer supported.
@@ -11,10 +17,8 @@
 - Added a `ByteReader` protocol which inherits `AnyObject`.
   - Most of the methods and properties of the previously existing `ByteReader` _class_ are now requirements of the new
   protocol.
-  - `ByteReader` provides a default implementation for the initializer which implements conversion from a `BitReader`
-  (this initializer is not a protocol requirement).
-  - `ByteReader` provides default implementations for the `bytesLeft`, `bytesRead`, and `isFinished` properties (these
-  properties are not protocol requirements).
+  - `ByteReader` provides default implementations for the initializer, which implements conversion from a `BitReader`,
+  and for the `bytesLeft`, `bytesRead`, and `isFinished` properties (all of these are not protocol requirements).
   - `ByteReader` provides a default implementation for the `int(fromBytes:)` method.
   - Both `LittleEndianByteReader` and `BigEndianByteReader` now conform to the `ByteReader` protocol.
 - Added a `SignedNumberRepresentation` enum with five cases and two instance methods.
@@ -30,9 +34,9 @@ with the default value of `SignedNumberRepresentation.twoComplementNegatives` fo
 `write(signedNumber:bitsCount:representation:)`.
 - `BitWriter` now provides default implementations for `write(signedNumber:bitsCount:representation:)` and
 `write(number:bitsCount:)`.
-  - The default implementation of the `write(number:bitsCount:)` function has a precondition crash if the `bitsCount`
+  - The default implementation of the `write(number:bitsCount:)` function now has a precondition crash if the `bitsCount`
   argument exceeds the bit width of the integer type on the current platform.
-- The `write(unsignedNumber:bitsCount:)` function of the `LsbBitWriter` and `MsbBitWriter` classes functions now have a
+- The `write(unsignedNumber:bitsCount:)` function of the `LsbBitWriter` and `MsbBitWriter` classes now has a
 precondition crash if the `bitsCount` argument exceeds the bit width of the integer type on the current platform.
 - Documentation has been updated.
   - Added documentation for new APIs.

Sources/BitWriter.swift

@@ -81,11 +81,13 @@ extension BitWriter {
      - Precondition: The `signedNumber` must be representable within `bitsCount` bits using the `representation`, i.e.
      it must be in the `representation.minRepresentableNumber...representation.maxRepresentableNumber` range.
      - Precondition: For the `SignedNumberRepresentation.biased` representation, the `bias` must be non-negative.
+     - Precondition: Parameter `bitsCount` must be in the `0...Int.bitWidth` range.
      */
     public func write(signedNumber: Int, bitsCount: Int, representation: SignedNumberRepresentation = .twoComplementNegatives) {
         precondition(signedNumber >= representation.minRepresentableNumber(bitsCount: bitsCount) &&
                         signedNumber <= representation.maxRepresentableNumber(bitsCount: bitsCount),
                      "\(signedNumber) cannot be represented by \(representation) using \(bitsCount) bits")
+        precondition(0...Int.bitWidth ~= bitsCount)
 
         var magnitude = signedNumber.magnitude
         switch representation {

Sources/LsbBitWriter.swift

@@ -51,6 +51,7 @@ public final class LsbBitWriter: BitWriter {
      - Note: The `number` will be truncated if the `bitsCount` is less than the amount of bits required to fully
      represent the value of `number`.
      - Note: Bits of the `number` are processed using the same bit-numbering scheme as of the writer (i.e. "LSB 0").
+     - Precondition: Parameter `bitsCount` must be in the `0...UInt.bitWidth` range.
      */
     public func write(unsignedNumber: UInt, bitsCount: Int) {
         precondition(0...UInt.bitWidth ~= bitsCount)

Sources/MsbBitWriter.swift

@@ -51,6 +51,7 @@ public final class MsbBitWriter: BitWriter {
      - Note: The `number` will be truncated if the `bitsCount` is less than the amount of bits required to fully
      represent the value of `number`.
      - Note: Bits of the `number` are processed using the same bit-numbering scheme as of the writer (i.e. "MSB 0").
+     - Precondition: Parameter `bitsCount` must be in the `0...UInt.bitWidth` range.
      */
     public func write(unsignedNumber: UInt, bitsCount: Int) {
         precondition(0...UInt.bitWidth ~= bitsCount)