formatting

Author: btoms20

Package.swift

@@ -19,36 +19,39 @@ let package = Package(
     name: "swift-multicodec",
     platforms: [
         .macOS(.v10_10),
-        .iOS(.v10)
+        .iOS(.v10),
     ],
     products: [
         // Products define the executables and libraries produced by a package, and make them visible to other packages.
         .executable(
             name: "update-codecs",
-            targets: ["Updater"]),
+            targets: ["Updater"]
+        ),
         .library(
             name: "Multicodec",
-            targets: ["Multicodec"]),
+            targets: ["Multicodec"]
+        ),
     ],
     dependencies: [
         // Dependencies declare other packages that this package depends on.
-        // .package(url: /* package url */, from: "1.0.0"),
-        //.package(name: "VarInt", path: "../VarInt") //Use this when attempting to run update-codecs (until our repo is public)
         .package(url: "https://github.com/swift-libp2p/swift-varint.git", from: "0.0.1")
     ],
     targets: [
         // Targets are the basic building blocks of a package. A target can define a module or a test suite.
         // Targets can depend on other targets in this package, and on products in packages which this package depends on.
         .executableTarget(
             name: "Updater",
-            dependencies: []),
+            dependencies: []
+        ),
         .target(
             name: "Multicodec",
             dependencies: [
-                .product(name: "VarInt", package: "swift-varint"),
-            ]),
+                .product(name: "VarInt", package: "swift-varint")
+            ]
+        ),
         .testTarget(
             name: "MulticodecTests",
-            dependencies: ["Multicodec"]),
+            dependencies: ["Multicodec"]
+        ),
     ]
 )

Sources/Multicodec/Codecs+Equatable.swift

@@ -14,24 +14,24 @@
 
 import Foundation
 
-public extension Codecs {
-    static func ==(lhs: Codecs, rhs: Codecs) -> Bool {
-        return lhs.rawValue == rhs.rawValue
+extension Codecs {
+    public static func == (lhs: Codecs, rhs: Codecs) -> Bool {
+        lhs.rawValue == rhs.rawValue
     }
-    
-    static func ==(lhs: Codecs, rhs: Int64) -> Bool {
-        return lhs.rawValue == rhs
+
+    public static func == (lhs: Codecs, rhs: Int64) -> Bool {
+        lhs.rawValue == rhs
     }
 
-    static func ==(lhs: Codecs, rhs: Int) -> Bool {
-        return lhs.rawValue == Int64(rhs)
+    public static func == (lhs: Codecs, rhs: Int) -> Bool {
+        lhs.rawValue == Int64(rhs)
     }
 
-    static func ==(lhs: Codecs, rhs: String) -> Bool {
-        return lhs.name == rhs
+    public static func == (lhs: Codecs, rhs: String) -> Bool {
+        lhs.name == rhs
     }
-    
-    func isEqual(object: AnyObject?) -> Bool {
+
+    public func isEqual(object: AnyObject?) -> Bool {
         if let obj = object as? Codecs {
             return self.rawValue == obj.rawValue
         } else if let obj = object as? Int64 {
@@ -64,4 +64,3 @@ public extension Codecs {
 //        return lhs.rawValue == rhs
 //    }
 //}
-

Sources/Multicodec/Codecs.swift

@@ -18,6 +18,7 @@
 import Foundation
 import VarInt
 
+// swift-format-ignore
 /// An Enum for navigating supported Multiformat Codecs and their properties, most importantly their Name and Integer Code
 ///
 /// - Warning: Do not use the Codecs `rawValue` directly, instead make sure to use the `code` property to ensure backward compatibility with deprecated codecs.
@@ -568,7 +569,7 @@ public enum Codecs:UInt64, CaseIterable, Equatable {
 	case es512                          = 0xd01202
 	case rs256                          = 0xd01205
 	case scion                          = 0xd02000
-    
+
 
     /// Allows instantiation of a Codec based on it's name
     /// ```
@@ -591,17 +592,17 @@ public enum Codecs:UInt64, CaseIterable, Equatable {
             self = s
         } else { throw MulticodecError.UnknownCodecId }
     }
-    
+
     public init(_ code:Int) throws {
         guard let s = Codecs(rawValue: UInt64(code)) else { throw MulticodecError.UnknownCodecId }
         self = s
     }
-    
+
     public init(_ code:Int64) throws {
         guard let s = Codecs(rawValue: UInt64(code)) else { throw MulticodecError.UnknownCodecId }
         self = s
     }
-    
+
     public init(_ code:UInt64) throws {
         guard let s = Codecs(rawValue: code) else { throw MulticodecError.UnknownCodecId }
         self = s
@@ -615,18 +616,18 @@ public enum Codecs:UInt64, CaseIterable, Equatable {
 
     /// Returns a list of all known Codec codes
     public static var codecCodes:[UInt64] { return Codecs.allCases.map { $0.rawValue } }
-    
+
     /// Returns the code for this Codec
     public var code:UInt64 {
         return self.rawValue
     }
-    
+
     /// Returns the name for this Codec
     public var name:String { return "\(self)".replacingOccurrences(of: "_", with: "-") }
-    
+
     /// Returns the code for this Codec as a VarInt Byte Buffer
     public var asVarInt:[UInt8] { return putUVarInt(self.rawValue) }
-    
+
 	public var tag:String {
 	    switch self {
 	    case .identity:
@@ -1707,7 +1708,7 @@ public enum Codecs:UInt64, CaseIterable, Equatable {
 		    return "varsig"
 		case .scion:
 		    return "multiaddr"
-	    
+	
 	    }
 	}
 

Sources/Multicodec/Multicodec.swift

@@ -18,14 +18,13 @@
 import Foundation
 import VarInt
 
-enum MulticodecError : Error {
+enum MulticodecError: Error {
     case PrefixExtractionBufferTooSmall
     case PrefixExtractionValueOverflow
     case UnknownCodecString
     case UnknownCodecId
 }
 
-
 /// Extract the prefix value from a multicodec prefixed byte buffer
 ///
 /// - Parameter bytes: a multicodec prefixed byte buffer
@@ -38,7 +37,7 @@ public func extractPrefix(bytes: [UInt8]) throws -> UInt64 {
         if bytesRead == 0 { throw MulticodecError.PrefixExtractionBufferTooSmall }
         throw MulticodecError.PrefixExtractionValueOverflow
     }
-    
+
     return prefix
 }
 
@@ -48,7 +47,7 @@ public func extractPrefix(bytes: [UInt8]) throws -> UInt64 {
 /// - Returns: the prefix value for the given multicodec as bytes
 /// - Throws: UnknownCodecString if the name was invalid
 public func getPrefix(multiCodec: String) throws -> [UInt8] {
-    return putUVarInt(try Codecs(multiCodec).rawValue)
+    putUVarInt(try Codecs(multiCodec).rawValue)
 }
 
 /// Return the prefix value for a given multicodec string
@@ -57,10 +56,9 @@ public func getPrefix(multiCodec: String) throws -> [UInt8] {
 /// - Returns: the prefix value for the given multicodec as bytes
 /// - Throws: UnknownCodecString if the name was invalid
 public func getPrefix(multiCodec: Codecs) -> [UInt8] {
-    return putUVarInt(multiCodec.rawValue)
+    putUVarInt(multiCodec.rawValue)
 }
 
-
 /// Add multicodec prefix to the front of the given byte buffer
 ///
 /// - Parameters:
@@ -69,7 +67,7 @@ public func getPrefix(multiCodec: Codecs) -> [UInt8] {
 /// - Returns: the prefixed byte buffer
 /// - Throws: UnknownCodecString if given an invalid multicodec name
 public func addPrefix(multiCodec: String, bytes: [UInt8]) throws -> [UInt8] {
-    return try getPrefix(multiCodec: multiCodec) + bytes
+    try getPrefix(multiCodec: multiCodec) + bytes
 }
 
 /// Add multicodec prefix to the front of the given byte buffer
@@ -80,7 +78,7 @@ public func addPrefix(multiCodec: String, bytes: [UInt8]) throws -> [UInt8] {
 /// - Returns: the prefixed byte buffer
 /// - Throws: UnknownCodecString if given an invalid multicodec name
 public func addPrefix(code: Int64, bytes: [UInt8]) throws -> [UInt8] {
-    return try getPrefix(multiCodec: try Codecs(code).name) + bytes
+    try getPrefix(multiCodec: try Codecs(code).name) + bytes
 }
 
 /// Add multicodec prefix to the front of the given byte buffer
@@ -91,7 +89,7 @@ public func addPrefix(code: Int64, bytes: [UInt8]) throws -> [UInt8] {
 /// - Returns: the prefixed byte buffer
 /// - Throws: UnknownCodecString if given an invalid multicodec name
 public func addPrefix(code: UInt64, bytes: [UInt8]) throws -> [UInt8] {
-    return try getPrefix(multiCodec: try Codecs(code).name) + bytes
+    try getPrefix(multiCodec: try Codecs(code).name) + bytes
 }
 
 /// Add multicodec prefix to the front of the given byte buffer
@@ -101,8 +99,8 @@ public func addPrefix(code: UInt64, bytes: [UInt8]) throws -> [UInt8] {
 ///   - bytes: the byte buffer to prefix
 /// - Returns: the prefixed byte buffer
 /// - Throws: UnknownCodecString if given an invalid multicodec name
-public func addPrefix(code:   Int, bytes: [UInt8]) throws -> [UInt8] {
-    return try getPrefix(multiCodec: try Codecs(code).name) + bytes
+public func addPrefix(code: Int, bytes: [UInt8]) throws -> [UInt8] {
+    try getPrefix(multiCodec: try Codecs(code).name) + bytes
 }
 
 /// Add multicodec prefix to the front of the given byte buffer
@@ -112,10 +110,9 @@ public func addPrefix(code:   Int, bytes: [UInt8]) throws -> [UInt8] {
 ///   - bytes: the byte buffer to prefix
 /// - Returns: the prefixed byte buffer
 public func addPrefix(codec: Codecs, bytes: [UInt8]) -> [UInt8] {
-    return getPrefix(multiCodec: codec) + bytes
+    getPrefix(multiCodec: codec) + bytes
 }
 
-
 /// Remove the prefix from a prefixed byte buffer
 ///
 /// - Parameter bytes: the prefixed byte buffer
@@ -126,7 +123,6 @@ public func removePrefix(bytes: [UInt8]) throws -> [UInt8] {
     return Array(bytes[prefix.count...])
 }
 
-
 /// Get the codec name of the codec in the given byte buffer
 ///
 /// - Parameter bytes: the multicodec prefixed byte buffer
@@ -141,27 +137,29 @@ public func getCodecEnum(bytes: [UInt8]) throws -> Codecs {
     return try Codecs(prefix)
 }
 
-public extension String {
+extension String {
     /// Encodes a String into it's UTF8 Byte Array with the specified Multicodec prefix
-    func encodeUTF8(as codec:Codecs) -> [UInt8] {
-        return addPrefix(codec: codec, bytes: Array(self.utf8))
+    public func encodeUTF8(as codec: Codecs) -> [UInt8] {
+        addPrefix(codec: codec, bytes: Array(self.utf8))
     }
 }
 
-public extension Array where Element == UInt8 {
-    func multiCodec() throws -> (codec:Codecs, bytes:[UInt8]) {
+extension Array where Element == UInt8 {
+    public func multiCodec() throws -> (codec: Codecs, bytes: [UInt8]) {
         let codec = try getCodecEnum(bytes: self)
         return (codec: codec, bytes: try removePrefix(bytes: self))
     }
-    
-    func extractCodec() throws -> (codec:Codecs, bytes:[UInt8]) {
+
+    public func extractCodec() throws -> (codec: Codecs, bytes: [UInt8]) {
         let codec = try getCodecEnum(bytes: self)
         return (codec: codec, bytes: try removePrefix(bytes: self))
     }
-    
-    func decodeMulticodec(using encoding:String.Encoding) throws -> (codec:Codecs, contents:String) {
+
+    public func decodeMulticodec(using encoding: String.Encoding) throws -> (codec: Codecs, contents: String) {
         let codec = try getCodecEnum(bytes: self)
-        guard let str = String(bytes: try removePrefix(bytes: self), encoding: encoding) else { throw MulticodecError.UnknownCodecId } //Better Error
+        guard let str = String(bytes: try removePrefix(bytes: self), encoding: encoding) else {
+            throw MulticodecError.UnknownCodecId
+        }  //Better Error
         return (codec: codec, contents: str)
     }
 }