ReflectedStringConvertible
A protocol that extends CustomStringConvertible and uses reflection to add a detailed textual representation to any class. Two styles are supported:
normal: Similar to Swift's default textual representation of structs.json: Pretty JSON representation.
Installation
Cocoapods
Add the following to your Podfile:
pod 'ReflectedStringConvertible'
Carthage
Add the following to your Cartfile:
github "mattcomi/ReflectedStringConvertible"
Usage
Simply import ReflectedStringConvertible and conform to the ReflectedStringConvertible protocol:
import ReflectedStringConvertible
class YourClass: ReflectedStringConvertible {
// that's all.
}
For example:
class Person: ReflectedStringConvertible {
var name: String
var age: Int
init(name: String, age: Int) {
self.name = name
self.age = age
}
}
print(Person(name: "Matt", age: 33)) outputs:
Person(name: "Matt", age: 33)
A style may be specified with reflectedDescription(style:). The default style is normal. That is, calling description is the same as calling reflectedDescription(.normal).
For example, print(Person(name: "Matt", age: 33).reflectedDescription(.json)) outputs:
{
"age" : 33,
"name" : "Matt"
}
Refer to the API Documentation for further information.
Features
ReflectedStringConvertible stored properties
ReflectedStringConvertible objects with ReflectedStringConvertible stored properties are handled correctly:
class Movie: ReflectedStringConvertible {
var title: String
var year: Int
// another ReflectedStringConvertible
var director: Person
init(title: String, year: Int, director: Person) {
self.title = title
self.year = year
self.director = director
}
}
let george = Person(name: "George Miller", age: 71)
let movie = Movie(title: "Mad Max", year: 2015, director: george)
print(movie.reflectedDescription(.normal)) (or just print(movie)) outputs:
Movie(title: "Mad Max", year: 2015, director: Person(name: "George Miller", age: 71))
And print(movie.reflectedDescription(.json)) outputs:
{
"title" : "Mad Max",
"year" : 2015,
"director" : {
"age" : 71,
"name" : "George Miller"
}
}
Collections
ReflectedStringConvertible objects within Array, Dictionary and Set collections are handled correctly:
class Series: ReflectedStringConvertible {
var title: String
var cast: [Person]
init(title: String, cast: [Person]) {
self.cast = cast
}
}
var cast = [Person]()
cast.append(Person(name: "Justin Theroux", age: 44))
cast.append(Person(name: "Carrie Coon", age: 35))
let series = Series(title: "The Leftovers", cast: cast)
print(series) outputs:
TVShow(title: "The Leftovers", cast: [Person(name: "Justin Theroux", age: 44), Person(name: "Carrie Coon", age: 35)])
print(series.reflectedDescription(.json)) outputs:
{
"title" : "The Leftovers",
"cast" : [
{
"age" : 44,
"name" : "Justin Theroux"
},
{
"age" : 35,
"name" : "Carrie Coon"
}
]
}
Credits
Developed by Matt Comi (@mattcomi)
643 Dec 20, 2022
9 Nov 30, 2022
62 Feb 2, 2022
22 Oct 29, 2020
3.3k Dec 22, 2022
103 Nov 24, 2022
3k Dec 22, 2022
1 Feb 25, 2022
15.9k Jan 8, 2023
964 Dec 14, 2022
0 Dec 17, 2021
11 Oct 17, 2022
9k Jan 2, 2023
19 Nov 25, 2022
509 Jun 29, 2022
788 Jul 19, 2022
11.4k Jan 1, 2023
2 Apr 12, 2022
1.8k Dec 6, 2022
3.8k Jan 5, 2023
7 May 16, 2022
8.5k Jan 3, 2023
17 Sep 24, 2022
489 Sep 9, 2022
793 Dec 14, 2022
0 Jan 24, 2022
0 Feb 7, 2022