Merge branch 'release-candidate' into stable

Author: jverkoey

.github/workflows/deploy_to_cocoapods.yaml

@@ -0,0 +1,17 @@
+name: deploy_to_cocoapods
+
+on:
+  push:
+    tags:
+      - '*'
+
+jobs:
+  build:
+    runs-on: macOS-latest
+    steps:
+    - uses: actions/checkout@v1
+    - name: Install Cocoapods
+      run: gem install cocoapods
+    - uses: michaelhenry/[email protected]
+      env:
+        COCOAPODS_TRUNK_TOKEN: ${{ secrets.COCOAPODS_TRUNK_TOKEN }}

.github/workflows/presubmit.yaml

@@ -0,0 +1,31 @@
+name: presubmit
+on:
+  pull_request:
+    branches:
+      - develop
+
+jobs:
+  mac_test:
+    runs-on: macOS-latest
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v2
+    - run: swift test
+
+  linux_test:
+    container:
+      image: swift:5.2
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - run: swift test --enable-test-discovery --enable-code-coverage
+    - uses: mattpolzin/[email protected]
+
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Run SwiftLint
+        uses: norio-nomura/[email protected]
+        with:
+          args: --strict

.swift-version

@@ -1 +1 @@
-4.2
+5.2

.travis.yml

@@ -1,15 +1,15 @@
 Pod::Spec.new do |s|
   s.name = 'BinaryCodable'
-  s.version = '0.2.1'
+  s.version = '0.3.0'
   s.license = 'Apache 2.0'
   s.summary = 'Codable-like interfaces for binary representations.'
   s.homepage = 'https://github.com/jverkoey/BinaryCodable'
   s.authors = { 'BinaryCodable authors' => '[email protected]' }
   s.source = { :git => 'https://github.com/jverkoey/BinaryCodable.git', :tag => s.version }
   s.documentation_url = 'https://github.com/jverkoey/BinaryCodable/'
 
-  s.ios.deployment_target = '12.0'
-  s.osx.deployment_target = '10.12'
+  s.ios.deployment_target = '13.0'
+  s.osx.deployment_target = '10.15'
 
   s.source_files = ['Sources/**/*.swift']
 end

BinaryCodable.podspec

@@ -1,3 +1,15 @@
+# 0.3.0
+
+This minor release adds a `decodeRemainder` method to `BinaryDecodingContainer` and drops support for iOS 12, macOS 10.12-10.14, and Swift 4.
+
+## Breaking changes
+
+iOS 12, macOS 10.12-10.14, and Swift 4 are no longer supported.
+
+## New features
+
+* [Add decodeRemainder to BinaryDecodingContainer. (#47)](https://github.com/jverkoey/BinaryCodable/commit/2d4834e4972c46bdb3ec59d025ba29b7e9b7522b) (featherless)
+
 # 0.2.1
 
 This patch releases updates the CocoaPods spec to include all BinaryCodable source. It was previously missing the coder implementations.

CHANGELOG.md

@@ -1,4 +1,4 @@
-// swift-tools-version:4.2
+// swift-tools-version:5.2
 // Copyright 2019-present the BinaryCodable authors. All Rights Reserved.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
@@ -31,6 +31,6 @@ let package = Package(
     .testTarget(
       name: "BinaryCodableTests",
       dependencies: ["BinaryCodable"]
-    ),
+    )
   ]
 )

Package.swift

@@ -37,15 +37,12 @@ This is not an official Google product.
 - [BinaryCookies](https://github.com/interstateone/BinaryCookies): Read and write Apple's .binarycookies files.
 - [MySqlConnector](https://github.com/jverkoey/MySqlConnector): A pure Swift implementation of the MySql client/server protocol.
 
-## Requirements
-
-- Swift 4.2.2+
-
 ## Supported technologies
 
-- iOS 12.0+ / macOS 10.12+
-- Xcode 10.1+
+- iOS 13.0+ / macOS 10.15+
+- Xcode 11.5+
 - Ubuntu 16.04
+- Swift 5.2
 
 ## License
 

README.md

@@ -111,8 +111,8 @@ private class BinaryDataDecodingContainer: BinaryDecodingContainer {
       throw BinaryDecodingError.dataCorrupted(.init(debugDescription:
         "Not enough data to create a a type of \(type). Needed: \(byteWidth). Received: \(bytes.count)."))
     }
-    let value = bytes.withUnsafeBytes { (ptr: UnsafePointer<T>) -> T in
-      return ptr.pointee
+    let value = bytes.withUnsafeBytes { ptr -> T in
+      return ptr.load(as: T.self)
     }
     return value
   }
@@ -124,8 +124,8 @@ private class BinaryDataDecodingContainer: BinaryDecodingContainer {
       throw BinaryDecodingError.dataCorrupted(.init(debugDescription:
         "Not enough data to create a a type of \(type). Needed: \(byteWidth). Received: \(bytes.count)."))
     }
-    let value = bytes.withUnsafeBytes { (ptr: UnsafePointer<T>) -> T in
-      return ptr.pointee
+    let value = bytes.withUnsafeBytes { ptr -> T in
+      return ptr.load(as: T.self)
     }
     return value
   }
@@ -165,6 +165,10 @@ private class BinaryDataDecodingContainer: BinaryDecodingContainer {
     return data
   }
 
+  func decodeRemainder() throws -> Data {
+    return try pullData(length: Int.max)
+  }
+
   func nestedContainer(maxLength: Int?) -> BinaryDecodingContainer {
     let length: Int?
     let bufferedData: BufferedData

Sources/BinaryCodable/BinaryDataCoders/BinaryDataDecoder.swift

@@ -29,8 +29,6 @@ extension BinaryFloatingPoint {
    Returns a byte array representation of a floating point number.
    */
   public var bytes: [UInt8] {
-    var value = self
-    let data = Data(buffer: UnsafeBufferPointer(start: &value, count: 1))
-    return [UInt8](data)
+    return [UInt8](withUnsafeBytes(of: self) { Data($0) })
   }
 }

Sources/BinaryCodable/BinaryDataCoders/ByteRepresentations.swift

@@ -135,6 +135,13 @@ public protocol BinaryDecodingContainer {
    */
   mutating func decode(length: Int) throws -> Data
 
+  /**
+   Decodes the remainder of available data.
+
+   - returns: A Data representation of the decoded bytes.
+   */
+  mutating func decodeRemainder() throws -> Data
+
   /**
    Reads `length` bytes without affecting the `decode` cursor.
 

Sources/BinaryCodable/BinaryDecodable.swift

@@ -0,0 +1,69 @@
+// Copyright 2019-present the BinaryCodable authors. All Rights Reserved.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+import BinaryCodable
+import XCTest
+
+private struct Packet: BinaryDecodable {
+  let data: Data
+  let decoderWasAtEnd: Bool
+  init(from decoder: BinaryDecoder) throws {
+    var container = decoder.container(maxLength: nil)
+    self.data = try container.decodeRemainder()
+    self.decoderWasAtEnd = container.isAtEnd
+  }
+}
+
+private struct NestedPacket: BinaryDecodable {
+  let data: Data
+  let decoderWasAtEnd: Bool
+  let nestedDecoderWasAtEnd: Bool
+  init(from decoder: BinaryDecoder) throws {
+    var container = decoder.container(maxLength: nil)
+    var nestedContainer = container.nestedContainer(maxLength: 2)
+    self.data = try nestedContainer.decodeRemainder()
+    self.decoderWasAtEnd = container.isAtEnd
+    self.nestedDecoderWasAtEnd = nestedContainer.isAtEnd
+  }
+}
+
+final class DecodeRemainderTests: XCTestCase {
+
+  func testDecodesAllBytes() throws {
+    // Given
+    let packetData: [UInt8] = [0, 0, 0, 0]
+    let decoder = BinaryDataDecoder()
+
+    // When
+    let packet = try decoder.decode(Packet.self, from: packetData)
+
+    // Then
+    XCTAssertEqual([UInt8](packet.data), [0, 0, 0, 0])
+    XCTAssertTrue(packet.decoderWasAtEnd)
+  }
+
+  func testDecodesAllContainerBytes() throws {
+    // Given
+    let packetData: [UInt8] = [0, 0, 0, 0]
+    let decoder = BinaryDataDecoder()
+
+    // When
+    let packet = try decoder.decode(NestedPacket.self, from: packetData)
+
+    // Then
+    XCTAssertEqual([UInt8](packet.data), [0, 0])
+    XCTAssertFalse(packet.decoderWasAtEnd)
+    XCTAssertTrue(packet.nestedDecoderWasAtEnd)
+  }
+}

Tests/BinaryCodableTests/DecodeRemainderTests.swift

@@ -54,7 +54,17 @@ struct GIFHeader: BinaryCodable {
   let backgroundColorIndex: UInt8
   let aspectRatio: UInt8
 
-  init(version: Version, width: UInt16, height: UInt16, numberOfGlobalColorTableEntries: Int, colorTableEntriesSortedByImportance: Bool, colorResolution: UInt8, hasGlobalColorTable: Bool, backgroundColorIndex: UInt8, aspectRatio: UInt8) {
+  init(
+    version: Version,
+    width: UInt16,
+    height: UInt16,
+    numberOfGlobalColorTableEntries: Int,
+    colorTableEntriesSortedByImportance: Bool,
+    colorResolution: UInt8,
+    hasGlobalColorTable: Bool,
+    backgroundColorIndex: UInt8,
+    aspectRatio: UInt8
+  ) {
     self.version = version
     self.screenWidth = width
     self.screenHeight = height
@@ -145,7 +155,17 @@ final class GIFDecoderTests: XCTestCase {
 
   func testEncoding() throws {
     // Given
-    let header = GIFHeader(version: .gif89a, width: 46, height: 37, numberOfGlobalColorTableEntries: 4, colorTableEntriesSortedByImportance: false, colorResolution: 8, hasGlobalColorTable: true, backgroundColorIndex: 0, aspectRatio: 0)
+    let header = GIFHeader(
+      version: .gif89a,
+      width: 46,
+      height: 37,
+      numberOfGlobalColorTableEntries: 4,
+      colorTableEntriesSortedByImportance: false,
+      colorResolution: 8,
+      hasGlobalColorTable: true,
+      backgroundColorIndex: 0,
+      aspectRatio: 0
+    )
     let encoder = BinaryDataEncoder()
 
     // When