Skip to content

Rename encodeBytes to encodeToBytes, encodeString to encodeToString #33

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 13, 2024
Merged

Rename encodeBytes to encodeToBytes, encodeString to encodeToString #33

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion IntegrationTests/tests_04_performance/test_01_resources/test_base32_encoding.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ func run(identifier: String) {

measure(identifier: identifier) {
for _ in 0 ..< 1000 {
base32 = Base32.encodeString(bytes: bytes)
base32 = Base32.encodeToString(bytes: bytes)
}

return base32?.count ?? 0
Expand Down
2 changes: 1 addition & 1 deletion IntegrationTests/tests_04_performance/test_01_resources/test_base64_encoding.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ func run(identifier: String) {

measure(identifier: identifier) {
for _ in 0 ..< 1000 {
base64 = Base64.encodeString(bytes: bytes)
base64 = Base64.encodeToString(bytes: bytes)
}

return base64?.count ?? 0
Expand Down
16 changes: 8 additions & 8 deletions Sources/ExtrasBase64/Base32.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
public extension String {
/// Create a base32 encoded string from a buffer
init<Buffer: Collection>(base32Encoding bytes: Buffer, options: Base32.EncodingOptions = []) where Buffer.Element == UInt8 {
self = Base32.encodeString(bytes: bytes, options: options)
self = Base32.encodeToString(bytes: bytes, options: options)
}

/// Decode base32 encoded strin
Expand All @@ -19,15 +19,15 @@
public let rawValue: UInt
public init(rawValue: UInt) { self.rawValue = rawValue }

public static let includePadding = EncodingOptions(rawValue: UInt(1 << 0))
public static let omitPaddingCharacter = EncodingOptions(rawValue: UInt(1 << 0))
}

public enum DecodingError: Swift.Error, Equatable {
case invalidCharacter(UInt8)
}

/// Base32 Encode a buffer to an array of bytes
public static func encodeBytes<Buffer: Collection>(
public static func encodeToBytes<Buffer: Collection>(
bytes: Buffer,
options: EncodingOptions = []
) -> [UInt8] where Buffer.Element == UInt8 {
Expand All @@ -42,11 +42,11 @@
return result
}

return self.encodeBytes(bytes: Array(bytes))
return self.encodeToBytes(bytes: Array(bytes))

Check warning on line 45 in Sources/ExtrasBase64/Base32.swift

View check run for this annotation

Codecov / codecov/patch

Sources/ExtrasBase64/Base32.swift#L45 

Added line #L45 was not covered by tests
}

/// Base32 Encode a buffer to a string
public static func encodeString<Buffer: Collection>(
public static func encodeToString<Buffer: Collection>(
bytes: Buffer,
options: EncodingOptions = []
) -> String where Buffer.Element == UInt8 {
Expand All @@ -62,9 +62,9 @@
return result
}

return self.encodeString(bytes: Array(bytes))
return self.encodeToString(bytes: Array(bytes))

Check warning on line 65 in Sources/ExtrasBase64/Base32.swift

View check run for this annotation

Codecov / codecov/patch

Sources/ExtrasBase64/Base32.swift#L65 

Added line #L65 was not covered by tests
} else {
let bytes: [UInt8] = self.encodeBytes(bytes: bytes)
let bytes: [UInt8] = self.encodeToBytes(bytes: bytes)

Check warning on line 67 in Sources/ExtrasBase64/Base32.swift

View check run for this annotation

Codecov / codecov/patch

Sources/ExtrasBase64/Base32.swift#L67 

Added line #L67 was not covered by tests
return String(decoding: bytes, as: Unicode.UTF8.self)
}
}
Expand Down Expand Up @@ -249,7 +249,7 @@
preconditionFailure("Shouldn't get here")
}
outputIndex += (remainingBytes * 8 + 4) / 5
if options.contains(.includePadding) {
if !options.contains(.omitPaddingCharacter) {
let fullOutputSize = ((outputIndex + 7) / 8) * 8
while outputIndex < fullOutputSize {
output[outputIndex] = UInt8(ascii: "=")
Expand Down
12 changes: 6 additions & 6 deletions Sources/ExtrasBase64/Base64.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@
init<Buffer: Collection>(base64Encoding bytes: Buffer, options: Base64.EncodingOptions = [])
where Buffer.Element == UInt8
{
self = Base64.encodeString(bytes: bytes, options: options)
self = Base64.encodeToString(bytes: bytes, options: options)

Check warning on line 65 in Sources/ExtrasBase64/Base64.swift

View check run for this annotation

Codecov / codecov/patch

Sources/ExtrasBase64/Base64.swift#L65 

Added line #L65 was not covered by tests
}

func base64decoded(options: Base64.DecodingOptions = []) throws -> [UInt8] {
Expand Down Expand Up @@ -207,7 +207,7 @@
]

@inlinable
public static func encodeBytes<Buffer: Collection>(bytes: Buffer, options: EncodingOptions = [])
public static func encodeToBytes<Buffer: Collection>(bytes: Buffer, options: EncodingOptions = [])
-> [UInt8] where Buffer.Element == UInt8
{
let newCapacity = ((bytes.count + 2) / 3) * 4
Expand All @@ -220,11 +220,11 @@
return result
}

return self.encodeBytes(bytes: Array(bytes), options: options)
return self.encodeToBytes(bytes: Array(bytes), options: options)

Check warning on line 223 in Sources/ExtrasBase64/Base64.swift

View check run for this annotation

Codecov / codecov/patch

Sources/ExtrasBase64/Base64.swift#L223 

Added line #L223 was not covered by tests
}

@inlinable
public static func encodeString<Buffer: Collection>(bytes: Buffer, options: EncodingOptions = [])
public static func encodeToString<Buffer: Collection>(bytes: Buffer, options: EncodingOptions = [])
-> String where Buffer.Element == UInt8
{
let newCapacity = ((bytes.count + 2) / 3) * 4
Expand All @@ -241,9 +241,9 @@
return result
}

return self.encodeString(bytes: Array(bytes), options: options)
return self.encodeToString(bytes: Array(bytes), options: options)

Check warning on line 244 in Sources/ExtrasBase64/Base64.swift

View check run for this annotation

Codecov / codecov/patch

Sources/ExtrasBase64/Base64.swift#L244 

Added line #L244 was not covered by tests
} else {
let bytes: [UInt8] = self.encodeBytes(bytes: bytes, options: options)
let bytes: [UInt8] = self.encodeToBytes(bytes: bytes, options: options)

Check warning on line 246 in Sources/ExtrasBase64/Base64.swift

View check run for this annotation

Codecov / codecov/patch

Sources/ExtrasBase64/Base64.swift#L246 

Added line #L246 was not covered by tests
return String(decoding: bytes, as: Unicode.UTF8.self)
}
#else
Expand Down
6 changes: 3 additions & 3 deletions Sources/PerformanceTest/main.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,19 +35,19 @@ let foundationEncodingData = timing(name: "Foundation: Data to Data ") {

let chromeEncodingBytes = timing(name: "Chromium: [UInt8] to [UInt8]") {
for _ in 1 ... runs {
let _: [UInt8] = Base64.encodeBytes(bytes: bytes)
let _: [UInt8] = Base64.encodeToBytes(bytes: bytes)
}
}

let chromeEncodingString = timing(name: "Chromium: [UInt8] to String ") {
for _ in 1 ... runs {
let _: String = Base64.encodeString(bytes: bytes)
let _: String = Base64.encodeToString(bytes: bytes)
}
}

let chromeEncodingData = timing(name: "Chromium: Data to [UInt8]") {
for _ in 1 ... runs {
let _: String = Base64.encodeString(bytes: data)
let _: String = Base64.encodeToString(bytes: data)
}
}

Expand Down
46 changes: 23 additions & 23 deletions Tests/ExtrasBase64Tests/Base32Tests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,20 +6,20 @@ class Base32Tests: XCTestCase {

func testEncodeEmptyData() {
let data = [UInt8]()
let encodedData: [UInt8] = Base32.encodeBytes(bytes: data)
let encodedData: [UInt8] = Base32.encodeToBytes(bytes: data)
XCTAssertEqual(encodedData.count, 0)
}

func testBase32EncodingArrayOfNulls() {
let data = Array(repeating: UInt8(0), count: 10)
let encodedData: [UInt8] = Base32.encodeBytes(bytes: data)
let encodedData: [UInt8] = Base32.encodeToBytes(bytes: data)
XCTAssertEqual(encodedData, [UInt8]("AAAAAAAAAAAAAAAA".utf8))
}

func testBase32EncodingAllTheBytesSequentially() {
let data = Array(UInt8(0) ... UInt8(255))
let encodedData = Base32.encodeBytes(bytes: data)
XCTAssertEqual(encodedData, [UInt8]("AAAQEAYEAUDAOCAJBIFQYDIOB4IBCEQTCQKRMFYYDENBWHA5DYPSAIJCEMSCKJRHFAUSUKZMFUXC6MBRGIZTINJWG44DSOR3HQ6T4P2AIFBEGRCFIZDUQSKKJNGE2TSPKBIVEU2UKVLFOWCZLJNVYXK6L5QGCYTDMRSWMZ3INFVGW3DNNZXXA4LSON2HK5TXPB4XU634PV7H7AEBQKBYJBMGQ6EITCULRSGY5D4QSGJJHFEVS2LZRGM2TOOJ3HU7UCQ2FI5EUWTKPKFJVKV2ZLNOV6YLDMVTWS23NN5YXG5LXPF5X274BQOCYPCMLRWHZDE4VS6MZXHM7UGR2LJ5JVOW27MNTWW33TO55X7A4HROHZHF43T6R2PK5PWO33XP6DY7F47U6X3PP6HZ7L57Z7P674".utf8))
let encodedData = Base32.encodeToBytes(bytes: data)
XCTAssertEqual(encodedData, [UInt8]("AAAQEAYEAUDAOCAJBIFQYDIOB4IBCEQTCQKRMFYYDENBWHA5DYPSAIJCEMSCKJRHFAUSUKZMFUXC6MBRGIZTINJWG44DSOR3HQ6T4P2AIFBEGRCFIZDUQSKKJNGE2TSPKBIVEU2UKVLFOWCZLJNVYXK6L5QGCYTDMRSWMZ3INFVGW3DNNZXXA4LSON2HK5TXPB4XU634PV7H7AEBQKBYJBMGQ6EITCULRSGY5D4QSGJJHFEVS2LZRGM2TOOJ3HU7UCQ2FI5EUWTKPKFJVKV2ZLNOV6YLDMVTWS23NN5YXG5LXPF5X274BQOCYPCMLRWHZDE4VS6MZXHM7UGR2LJ5JVOW27MNTWW33TO55X7A4HROHZHF43T6R2PK5PWO33XP6DY7F47U6X3PP6HZ7L57Z7P674======".utf8))
}

// MARK: Decoding
Expand Down Expand Up @@ -61,54 +61,54 @@ class Base32Tests: XCTestCase {
}

func testBase32DecodingOneTwoThreeFour() {
let base32 = "AEBAGBA"
let base32 = "AEBAGBA="
let bytes: [UInt8] = [1, 2, 3, 4]

XCTAssertEqual(Base32.encodeString(bytes: bytes), base32)
XCTAssertEqual(Base32.encodeToString(bytes: bytes), base32)
XCTAssertEqual(try Base32.decode(string: base32), bytes)
}

func testBase32DecodingOneTwoThreeFourFive() {
let base32 = "AEBAGBAF"
let bytes: [UInt8] = [1, 2, 3, 4, 5]

XCTAssertEqual(Base32.encodeString(bytes: bytes), base32)
XCTAssertEqual(Base32.encodeToString(bytes: bytes), base32)
XCTAssertEqual(try Base32.decode(string: base32), bytes)
}

func testBase32DecodingOneTwoThreeFourFiveSix() {
let base32 = "AEBAGBAFAY"
let bytes: [UInt8] = [1, 2, 3, 4, 5, 6]

XCTAssertEqual(Base32.encodeString(bytes: bytes), base32)
XCTAssertEqual(Base32.encodeToString(bytes: bytes, options: .omitPaddingCharacter), base32)
XCTAssertEqual(try Base32.decode(string: base32), bytes)
}

func testBase32DecodingPadding() {
let base32 = "AEBAGBAFAY======"
let bytes: [UInt8] = [1, 2, 3, 4, 5, 6]

XCTAssertEqual(Base32.encodeString(bytes: bytes, options: .includePadding), base32)
XCTAssertEqual(Base32.encodeToString(bytes: bytes), base32)
XCTAssertEqual(try base32.base32decoded(), bytes)
}

func testBase32EncodeFoobar() {
XCTAssertEqual(String(base32Encoding: "".utf8), "")
XCTAssertEqual(String(base32Encoding: "f".utf8), "MY")
XCTAssertEqual(String(base32Encoding: "fo".utf8), "MZXQ")
XCTAssertEqual(String(base32Encoding: "foo".utf8), "MZXW6")
XCTAssertEqual(String(base32Encoding: "foob".utf8), "MZXW6YQ")
XCTAssertEqual(String(base32Encoding: "fooba".utf8), "MZXW6YTB")
XCTAssertEqual(String(base32Encoding: "foobar".utf8), "MZXW6YTBOI")
XCTAssertEqual(String(base32Encoding: "".utf8, options: .omitPaddingCharacter), "")
XCTAssertEqual(String(base32Encoding: "f".utf8, options: .omitPaddingCharacter), "MY")
XCTAssertEqual(String(base32Encoding: "fo".utf8, options: .omitPaddingCharacter), "MZXQ")
XCTAssertEqual(String(base32Encoding: "foo".utf8, options: .omitPaddingCharacter), "MZXW6")
XCTAssertEqual(String(base32Encoding: "foob".utf8, options: .omitPaddingCharacter), "MZXW6YQ")
XCTAssertEqual(String(base32Encoding: "fooba".utf8, options: .omitPaddingCharacter), "MZXW6YTB")
XCTAssertEqual(String(base32Encoding: "foobar".utf8, options: .omitPaddingCharacter), "MZXW6YTBOI")
}

func testBase32EncodeFoobarWithPadding() {
XCTAssertEqual(String(base32Encoding: "".utf8, options: .includePadding), "")
XCTAssertEqual(String(base32Encoding: "f".utf8, options: .includePadding), "MY======")
XCTAssertEqual(String(base32Encoding: "fo".utf8, options: .includePadding), "MZXQ====")
XCTAssertEqual(String(base32Encoding: "foo".utf8, options: .includePadding), "MZXW6===")
XCTAssertEqual(String(base32Encoding: "foob".utf8, options: .includePadding), "MZXW6YQ=")
XCTAssertEqual(String(base32Encoding: "fooba".utf8, options: .includePadding), "MZXW6YTB")
XCTAssertEqual(String(base32Encoding: "foobar".utf8, options: .includePadding), "MZXW6YTBOI======")
XCTAssertEqual(String(base32Encoding: "".utf8), "")
XCTAssertEqual(String(base32Encoding: "f".utf8), "MY======")
XCTAssertEqual(String(base32Encoding: "fo".utf8), "MZXQ====")
XCTAssertEqual(String(base32Encoding: "foo".utf8), "MZXW6===")
XCTAssertEqual(String(base32Encoding: "foob".utf8), "MZXW6YQ=")
XCTAssertEqual(String(base32Encoding: "fooba".utf8), "MZXW6YTB")
XCTAssertEqual(String(base32Encoding: "foobar".utf8), "MZXW6YTBOI======")
}
}
16 changes: 8 additions & 8 deletions Tests/ExtrasBase64Tests/ChromiumTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,31 +6,31 @@ class ChromiumTests: XCTestCase {

func testEncodeEmptyData() {
let data = [UInt8]()
let encodedData: [UInt8] = Base64.encodeBytes(bytes: data)
let encodedData: [UInt8] = Base64.encodeToBytes(bytes: data)
XCTAssertEqual(encodedData.count, 0)
}

func testBase64EncodingArrayOfNulls() {
let data = Array(repeating: UInt8(0), count: 10)
let encodedData: [UInt8] = Base64.encodeBytes(bytes: data)
let encodedData: [UInt8] = Base64.encodeToBytes(bytes: data)
XCTAssertEqual(encodedData, [UInt8]("AAAAAAAAAAAAAA==".utf8))
}

func testBase64EncodingAllTheBytesSequentially() {
let data = Array(UInt8(0) ... UInt8(255))
let encodedData: [UInt8] = Base64.encodeBytes(bytes: data)
let encodedData: [UInt8] = Base64.encodeToBytes(bytes: data)
XCTAssertEqual(encodedData, [UInt8]("AAECAwQFBgcICQoLDA0ODxAREhMUFRYXGBkaGxwdHh8gISIjJCUmJygpKissLS4vMDEyMzQ1Njc4OTo7PD0+P0BBQkNERUZHSElKS0xNTk9QUVJTVFVWV1hZWltcXV5fYGFiY2RlZmdoaWprbG1ub3BxcnN0dXZ3eHl6e3x9fn+AgYKDhIWGh4iJiouMjY6PkJGSk5SVlpeYmZqbnJ2en6ChoqOkpaanqKmqq6ytrq+wsbKztLW2t7i5uru8vb6/wMHCw8TFxsfIycrLzM3Oz9DR0tPU1dbX2Nna29zd3t/g4eLj5OXm5+jp6uvs7e7v8PHy8/T19vf4+fr7/P3+/w==".utf8))
}

func testBase64UrlEncodingAllTheBytesSequentially() {
let data = Array(UInt8(0) ... UInt8(255))
let encodedData: [UInt8] = Base64.encodeBytes(bytes: data, options: .base64UrlAlphabet)
let encodedData: [UInt8] = Base64.encodeToBytes(bytes: data, options: .base64UrlAlphabet)
XCTAssertEqual(encodedData, [UInt8]("AAECAwQFBgcICQoLDA0ODxAREhMUFRYXGBkaGxwdHh8gISIjJCUmJygpKissLS4vMDEyMzQ1Njc4OTo7PD0-P0BBQkNERUZHSElKS0xNTk9QUVJTVFVWV1hZWltcXV5fYGFiY2RlZmdoaWprbG1ub3BxcnN0dXZ3eHl6e3x9fn-AgYKDhIWGh4iJiouMjY6PkJGSk5SVlpeYmZqbnJ2en6ChoqOkpaanqKmqq6ytrq-wsbKztLW2t7i5uru8vb6_wMHCw8TFxsfIycrLzM3Oz9DR0tPU1dbX2Nna29zd3t_g4eLj5OXm5-jp6uvs7e7v8PHy8_T19vf4-fr7_P3-_w==".utf8))
}

func testBase64UrlEncodingAllTheBytesSequentiallyOmitPadding() {
let data = Array(UInt8(0) ... UInt8(255))
let encodedData: [UInt8] = Base64.encodeBytes(bytes: data, options: [.base64UrlAlphabet, .omitPaddingCharacter])
let encodedData: [UInt8] = Base64.encodeToBytes(bytes: data, options: [.base64UrlAlphabet, .omitPaddingCharacter])
XCTAssertEqual(encodedData, [UInt8]("AAECAwQFBgcICQoLDA0ODxAREhMUFRYXGBkaGxwdHh8gISIjJCUmJygpKissLS4vMDEyMzQ1Njc4OTo7PD0-P0BBQkNERUZHSElKS0xNTk9QUVJTVFVWV1hZWltcXV5fYGFiY2RlZmdoaWprbG1ub3BxcnN0dXZ3eHl6e3x9fn-AgYKDhIWGh4iJiouMjY6PkJGSk5SVlpeYmZqbnJ2en6ChoqOkpaanqKmqq6ytrq-wsbKztLW2t7i5uru8vb6_wMHCw8TFxsfIycrLzM3Oz9DR0tPU1dbX2Nna29zd3t_g4eLj5OXm5-jp6uvs7e7v8PHy8_T19vf4-fr7_P3-_w".utf8))
}

Expand Down Expand Up @@ -96,23 +96,23 @@ class ChromiumTests: XCTestCase {
let base64 = "AQIDBA=="
let bytes: [UInt8] = [1, 2, 3, 4]

XCTAssertEqual(Base64.encodeString(bytes: bytes), base64)
XCTAssertEqual(Base64.encodeToString(bytes: bytes), base64)
XCTAssertEqual(try Base64.decode(string: base64), bytes)
}

func testBase64DecodingOneTwoThreeFourFive() {
let base64 = "AQIDBAU="
let bytes: [UInt8] = [1, 2, 3, 4, 5]

XCTAssertEqual(Base64.encodeString(bytes: bytes), base64)
XCTAssertEqual(Base64.encodeToString(bytes: bytes), base64)
XCTAssertEqual(try Base64.decode(string: base64), bytes)
}

func testBase64DecodingOneTwoThreeFourFiveSix() {
let base64 = "AQIDBAUG"
let bytes: [UInt8] = [1, 2, 3, 4, 5, 6]

XCTAssertEqual(Base64.encodeString(bytes: bytes), base64)
XCTAssertEqual(Base64.encodeToString(bytes: bytes), base64)
XCTAssertEqual(try Base64.decode(string: base64), bytes)
}

Expand Down
2 changes: 1 addition & 1 deletion Tests/ExtrasBase64Tests/IntegrationTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ class IntegrationTests: XCTestCase {
func testEncodeAndDecodingĨ() throws {
var input = "Ĩ"
let encoded = input.withUTF8 { ptr -> String in
Base64.encodeString(bytes: ptr)
Base64.encodeToString(bytes: ptr)
}

let decoded = try Base64.decode(string: encoded)
Expand Down
Loading