Stuff

General information

Stuff is a collection of code 'snippets' that are too small to create a library for and which do not fit in an other library. Run the unit tests to see the code in action.

• Print - For creating a nice output log
• Enum - Adding functionality to an enum
• TODO - Adding a TODO helper function
• Codable - Adding Codable helper functions (Swift 4)

To install all parts via Swift Package Manager, add version 1.1.4 or higher with URL https://github.com/evermeer/Stuff to your project file.

Print

You can install this by adding the following line to your Podfile:

pod "Stuff/Print"

The Stuff.print function is meant to be a replacement for the standard .print function. It will give you extra information about when and where the print function was executed. Besides that there is also support for different log levels and you can specify the minimum log level that should be in the output.

Here are some samples:

    Stuff.print("Just as the standard print but now with detailed information")
    Stuff.print("Now it's a warning", .warn)
    Stuff.print("Or even an error", .error)

    Stuff.minimumLogLevel = .error
    Stuff.print("Now you won't see normal log output")
    Stuff.print("Only errors are shown", .error)

    Stuff.minimumLogLevel = .none
    Stuff.print("Or if it's disabled you won't see any log", .error)    

The output of the code above is:

✳️ .debug ⏱ 02/13/2017 09:52:51:852 📱 xctest [18960:?] 📂 PrintStuffTests.swift(15) ⚙️ testExample() ➡️
    Just as the standard print but now with detailed information

⚠️ .warn ⏱ 02/13/2017 09:52:51:855 📱 xctest [18960:?] 📂 PrintStuffTests.swift(16) ⚙️ testExample() ➡️
    Now it's a warning

🚫 .error ⏱ 02/13/2017 09:52:51:855 📱 xctest [18960:?] 📂 PrintStuffTests.swift(17) ⚙️ testExample() ➡️
    Or even an error

🚫 .error ⏱ 02/13/2017 09:52:51:855 📱 xctest [18960:?] 📂 PrintStuffTests.swift(21) ⚙️ testExample() ➡️
    Only errors are shown

There is also a shortcut print statement for an error object. This will print the localizedDescription and set the warning level to .error.

    Stuff.print(error)

Update: From now on printing .error will also give you a stacktrace.

Update 04-04-2019 : You can now also set the minimumLogLevel to productionLogAll. This will make sure you can also see the logging in the console (menu 'Window', 'Devices and Simulators', 'Open Console') In most cases you should only use this if you want to see logging for an app that you distributed using Testflight.

Enum

You can install this by adding the following line to your Podfile:

pod "Stuff/Enum"

• getting all possible enum values in an arry
• getting the associated value of any enum
• converting an array of enums with associated values to a dictionary or an query string.
• get the raw value of an enum even it it was passed in an any

// You have to extend the enum with the Enum protocol (and RawEnum if you want the raw value when it's an Any)
enum test1: String, Enum, RawEnum {
    case option1
    case option2
    case option3
}

enum test2: Enum {
    case option4(String)
    case option5(Int)
    case option6(Int, String)
}

XCTAssert(test1.allValues.count == 3, "There should be 3 values")
for value in test1.allValues {
    print("value = \(value)")
}

let v1: test2 = .option4("test")
print("v1 = \(v1.associated.label), \(v1.associated.value!)")
let v2: test2 = .option5(3)
print("v2 = \(v2.associated.label), \(v2.associated.value!)")
let v3: test2 = .option6(4, "more")
print("v3 = \(v3.associated.label), \(v3.associated.value!)")

let array = [v1, v2, v3]
let dict = [String:Any](array)
print("Array of enums as dictionary:\n \(dict)")

print("query = \(array.queryString))")

let v = getRawValue(test1.option2)
print("raw value = \(v)")

func getRawValue(_ value: Any) -> Any {
    return (value as? RawEnum)?.anyRawValue ?? ""
}

The output is:

value = option1
value = option2
value = option3
v1 = option4, test
v2 = option5, 3
v3 = option6, (4, "more")
Array of enums as dictionary:
["option5": 3, "option4": "test", "option6": (4, "more")]
query = option4=test,option5=3,option6=(4, "more"))
raw value = option2

TODO

You can install this by adding the following line to your Podfile:

pod "Stuff/TODO"

Whenever you add a function to your project and postpone implementing it, you should add a TODO. Whenever you temporarilly change functioning code in order to debug something, you should add a TODO Before commiting/pushing your code, you should evaluate/solve your TODO's Usually you just add a TODO comment in your code like this:

    //TODO: This needs to be fixed

With the Stuff/TODO helper, you can get compile time and run time support for helping to find your TODO's. Here is an overview of the variants that you can use:

    // We need to fix something, but this code can run (compiler warning)
    TODO()

    // Now output extra info when this code is executed.
    TODO("An other todo, now giving some detailed info")

    // We need to fix this. Otherwise just fail. The code will crash here. See the stacktrace,
    TODO_

The code above will put the following in your output. Besides that, you will also see depricated warnings when you have the code open in Xcode.

⚠️ TODO code is still in use! ⚠️

⚠️ TODO code is still in use! ⚠️
An other todo, now giving some detailed info
fatal error: TODO left in code: file /Users/evermeer/Desktop/dev/GitHub/Stuff/Source/TODO/TODO.swift, line 15

But... It might be nicer to just add the following build phase script which will also give you compile time warnings:

KEYWORDS="TODO|FIXME|\?\?\?:|\!\!\!:"
find "${SRCROOT}" \( -name "*.swift" \) -print0 | \
xargs -0 egrep --with-filename --line-number --only-matching "($KEYWORDS).*\$" | \
perl -p -e "s/($KEYWORDS)/ warning: \$1/"

Codable

You can install this by adding the following line to your Podfile:

pod "Stuff/Codable"

Swift 4 added the Codable (EnCodable and DeCodable) protocol which you can add to a class or struct. The swift compile will then add coding and decoding functionality to your object. With the JSONEncoder and JSONDecoder classes you can then convert an object from and to json. The Stuff Codable extension will let you do these things in a 1 liner. Here is Apple documentaion about Codable The one liners that you can use are:

let json = yourEncodableObjectInstance.toJsonString()
let data = yourEncodableObjectInstance.toJsonData()
let newObject = try? YourCodableObject(json: json)
let newObject2 = try? YourCodableObject(data: data)
let objectArray = try? [YourCodableObject](json: json)
let objectArray2 = try? [YourCodableObject](data: data)
let newJson = objectArray.toJsonString()
let innerObject = try? TestCodable(json: "{\"user\":{\"id\":1,\"naam\":\"Edwin\"}}", keyPath: "user")
try initialObject.saveToDocuments("myFile.dat")
let readObject = try? TestCodable(fileNameInDocuments: "myFile.dat")
try objectArray.saveToDocuments("myFile2.dat")
let objectArray3 = try? [TestCodable](fileNameInDocuments: "myFile2.dat")

And here you can see how you can use these Stuff/Codable functions:

func test() {
   let initialObject = TestCodable(naam: "Edwin", id: 1, testField: "tst")

   guard let json = initialObject.toJsonString() else {
      print("Could not create json from object")
      return
   }
   print("Json string of object = \n\t\(json)")

   guard let newObject = try? TestCodable(json: json) else {
      print("Could not create object from json")
      return
   }
   print("Object created with json = \n\t\(newObject)")
   
   let json2 = "[{\"id\":1,\"naam\":\"Edwin\"},{\"id\":2,\"naam\":\"Vermeer\"}]"
   guard let array = try? [TestCodable](jsonArray: json2) else {
      print("Could not create object array from json")
      return
   }
   print("Object array created with json = \(array)")
   
   let newJson = array.toJsonString()
   print("Json from object array = \n\t\(newJson)")
   
   guard let innerObject = try? TestCodable(json: "{\"user\":{\"id\":1,\"naam\":\"Edwin\"}}", keyPath: "user") else {
      print("Could not create object from json")
      return
   }
   print("inner object from json \(String(describing: innerObject))")
   
   guard let custom = try TestCodable(json: "{\"Naam\":\"UpperN\", \"Id\":5, \"Test_field\":\"lowerSnake\"}", keyPath: nil, codingStrategy: customCodingStragegy) else {
      print("Could not custom case convert")
      return
   }
   print("read object with custom key coding from json to \(String(describing:    
}

struct TestCodable : Codable {
   var naam: String?
   var id: Int?
    var testField: String?    
}

besides the keyPath a shown in the sample code above you could also add one or more of the folowing parameters which are part of the standard JSONDecoder. If these parameters are not supplied, then the default value (see what's after the =) will be used.

keyDecodingStrategy: JSONDecoder.KeyDecodingStrategy = .convertFromSnakeCase,
dateDecodingStrategy: JSONDecoder.DateDecodingStrategy = .deferredToDate,
dataDecodingStrategy: JSONDecoder.DataDecodingStrategy = .base64,
nonConformingFloatDecodingStrategy: JSONDecoder.NonConformingFloatDecodingStrategy = .throw

License

Stuff is available under the MIT 3 license. See the LICENSE file for more info.

My other libraries:

Also see my other public source iOS libraries:

• EVReflection - Reflection based (Dictionary, CKRecord, JSON and XML) object mapping with extensions for Alamofire and Moya with RxSwift or ReactiveSwift
• EVCloudKitDao - Simplified access to Apple's CloudKit
• EVFaceTracker - Calculate the distance and angle of your device with regards to your face in order to simulate a 3D effect
• EVURLCache - a NSURLCache subclass for handling all web requests that use NSURLReques
• AlamofireOauth2 - A swift implementation of OAuth2 using Alamofire
• EVWordPressAPI - Swift Implementation of the WordPress (Jetpack) API using AlamofireOauth2, EVReflection and Alamofire (work in progress)
• PassportScanner - Scan the MRZ code of a passport and extract the firstname, lastname, passport number, nationality, date of birth, expiration date and personal numer.
• AttributedTextView - Easiest way to create an attributed UITextView with support for multiple links (url, hashtags, mentions).
• UITestHelper - UI test helper functions.