Merge branch 'release-1.3.0' into develop

Author: tsolomko

.jazzy.yaml

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

.travis.yml

@@ -25,7 +25,9 @@ jobs:
       script:
       # On macOS swift test (i.e. XCTest) outputs to stderr so we need to redirect pipes.
       - swift test -c release -Xswiftc -enable-testing --filter BitByteDataBenchmarks 2>&1 | ./ppbenchmarks.py 
-    - language: generic
+    - stage: benchmark
+      if: NOT (tag IS present)
+      language: generic
       os: linux
       dist: trusty
       install:

BitByteData.podspec

@@ -1,7 +1,7 @@
 Pod::Spec.new do |s|
 
   s.name         = "BitByteData"
-  s.version      = "1.2.0"
+  s.version      = "1.3.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."
@@ -20,7 +20,7 @@ Pod::Spec.new do |s|
   s.tvos.deployment_target = "9.0"
   s.watchos.deployment_target = "2.0"
 
-  s.swift_version = "4.1"
+  s.swift_version = "4.2"
 
   s.source_files = "Sources/*.swift"
 

BitByteData.xcodeproj/BitByteData.plist

@@ -15,9 +15,9 @@
 	<key>CFBundlePackageType</key>
 	<string>FMWK</string>
 	<key>CFBundleShortVersionString</key>
-	<string>1.2.0</string>
+	<string>1.3.0</string>
 	<key>CFBundleVersion</key>
-	<string>13</string>
+	<string>15</string>
 	<key>NSHumanReadableCopyright</key>
 	<string>Copyright © 2018 Timofey Solomko. All rights reserved.</string>
 </dict>

BitByteData.xcodeproj/BitByteDataBenchmarks.plist

@@ -15,8 +15,8 @@
 	<key>CFBundlePackageType</key>
 	<string>BNDL</string>
 	<key>CFBundleShortVersionString</key>
-	<string>1.2.0</string>
+	<string>1.3.0</string>
 	<key>CFBundleVersion</key>
-	<string>13</string>
+	<string>15</string>
 </dict>
 </plist>

BitByteData.xcodeproj/TestBitByteData.plist

@@ -15,8 +15,8 @@
 	<key>CFBundlePackageType</key>
 	<string>BNDL</string>
 	<key>CFBundleShortVersionString</key>
-	<string>1.2.0</string>
+	<string>1.3.0</string>
 	<key>CFBundleVersion</key>
-	<string>13</string>
+	<string>15</string>
 </dict>
 </plist>

BitByteData.xcodeproj/project.pbxproj

@@ -370,7 +370,7 @@
 				CLANG_WARN_SUSPICIOUS_MOVE = YES;
 				CLANG_WARN_UNREACHABLE_CODE = YES;
 				CLANG_WARN__DUPLICATE_METHOD_MATCH = YES;
-				CURRENT_PROJECT_VERSION = 13;
+				CURRENT_PROJECT_VERSION = 15;
 				DEBUG_INFORMATION_FORMAT = dwarf;
 				ENABLE_STRICT_OBJC_MSGSEND = YES;
 				ENABLE_TESTABILITY = YES;
@@ -416,7 +416,7 @@
 				CLANG_WARN_SUSPICIOUS_MOVE = YES;
 				CLANG_WARN_UNREACHABLE_CODE = YES;
 				CLANG_WARN__DUPLICATE_METHOD_MATCH = YES;
-				CURRENT_PROJECT_VERSION = 13;
+				CURRENT_PROJECT_VERSION = 15;
 				DEBUG_INFORMATION_FORMAT = "dwarf-with-dsym";
 				ENABLE_STRICT_OBJC_MSGSEND = YES;
 				GCC_NO_COMMON_BLOCKS = YES;
@@ -444,7 +444,7 @@
 				APPLICATION_EXTENSION_API_ONLY = YES;
 				DEFINES_MODULE = YES;
 				DYLIB_COMPATIBILITY_VERSION = 1;
-				DYLIB_CURRENT_VERSION = 13;
+				DYLIB_CURRENT_VERSION = 15;
 				DYLIB_INSTALL_NAME_BASE = "@rpath";
 				INFOPLIST_FILE = BitByteData.xcodeproj/BitByteData.plist;
 				INSTALL_PATH = "$(LOCAL_LIBRARY_DIR)/Frameworks";
@@ -469,7 +469,7 @@
 				APPLICATION_EXTENSION_API_ONLY = YES;
 				DEFINES_MODULE = YES;
 				DYLIB_COMPATIBILITY_VERSION = 1;
-				DYLIB_CURRENT_VERSION = 13;
+				DYLIB_CURRENT_VERSION = 15;
 				DYLIB_INSTALL_NAME_BASE = "@rpath";
 				INFOPLIST_FILE = BitByteData.xcodeproj/BitByteData.plist;
 				INSTALL_PATH = "$(LOCAL_LIBRARY_DIR)/Frameworks";

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 1.3.0
+
+- Updated to support Swift 4.2.
+- Added `advance(by:)` function to both `LsbBitReader` and `MsbBitReader`.
+- Added `write(unsignedNumber:bitsCount:)` function to both `LsbBitWriter` and `MsbBitWriter` (PR #1 by @cowgp).
+
 ## 1.2.0
 
 - Updated to support Swift 4.1.

README.md

@@ -1,6 +1,6 @@
 # BitByteData
 
-[![Swift 4.1](https://img.shields.io/badge/Swift-4.1-blue.svg)](https://developer.apple.com/swift/)
+[![Swift 4.2](https://img.shields.io/badge/Swift-4.2-blue.svg)](https://developer.apple.com/swift/)
 [![GitHub license](https://img.shields.io/badge/license-MIT-lightgrey.svg)](https://raw.githubusercontent.com/tsolomko/BitByteData/master/LICENSE)
 [![Build Status](https://travis-ci.org/tsolomko/BitByteData.svg?branch=develop)](https://travis-ci.org/tsolomko/BitByteData)
 
@@ -22,7 +22,7 @@ let package = Package(
     name: "PackageName",
     dependencies: [
         .package(url: "https://github.com/tsolomko/BitByteData.git",
-                 from: "1.2.0")
+                 from: "1.3.0")
     ],
     targets: [
         .target(
@@ -37,13 +37,13 @@ More details you can find in [Swift Package Manager's Documentation](https://git
 
 ### CocoaPods
 
-Add `pod 'BitByteData', '~> 1.2'` and `use_frameworks!` to your Podfile.
+Add `pod 'BitByteData', '~> 1.3'` and `use_frameworks!` to your Podfile.
 
 To complete installation, run `pod install`.
 
 ### Carthage
 
-Add to your Cartfile `github "tsolomko/BitByteData" ~> 1.2`.
+Add to your Cartfile `github "tsolomko/BitByteData" ~> 1.3`.
 
 Then run `carthage update`.
 

Sources/LsbBitReader.swift

@@ -42,6 +42,12 @@ public final class LsbBitReader: ByteReader, BitReader {
         self.offset = byteReader.offset
     }
 
+    /**
+     Advances reader's BIT pointer by specified amount of bits (default is 1).
+
+     - Warning: Doesn't check if there is any data left. It is advised to use `isFinished` AFTER calling this method
+     to check if the end was reached.
+     */
     public func advance(by count: Int = 1) {
         for _ in 0..<count {
             if self.bitMask == 128 {