Lenses and prisms in Swift

Understanding optics

Optics is a sample borrowed from Haskell, that lets you zoom down into objects. In different phrases, you possibly can set or get a property of an object in a useful means. By useful I imply you possibly can set a property with out inflicting mutation, so as a substitute of altering the unique object, a brand new one shall be created with the up to date property. Belief me it isn’t that sophisticated as it would sounds. 😅

We’ll want only a little bit of Swift code to grasp every little thing.

struct Tackle {
    let avenue: String
    let metropolis: String
}

struct Firm {
    let title: String
    let handle: Tackle
}

struct Particular person {
    let title: String
    let firm: Firm
}

As you possibly can see it’s potential to construct up a hierarchy utilizing these structs. An individual can have an organization and the corporate has an handle, for instance:

let oneInfiniteLoop = Tackle(avenue: "One Infinite Loop", metropolis: "Cupertino")
let appleInc = Firm(title: "Apple Inc.", handle: oneInfiniteLoop)
let steveJobs = Particular person(title: "Steve Jobs", firm: appleInc)

Now we could say that the road title of the handle modifications, how will we alter this one subject and propagate the property change for your entire construction? 🤔

struct Tackle {
    var avenue: String
    let metropolis: String
}

struct Firm {
    let title: String
    var handle: Tackle
}

struct Particular person {
    let title: String
    var firm: Firm
}

var oneInfiniteLoop = Tackle(avenue: "One Infinite Loop", metropolis: "Cupertino")
var appleInc = Firm(title: "Apple Inc.", handle: oneInfiniteLoop)
var steveJobs = Particular person(title: "Steve Jobs", firm: appleInc)

oneInfiniteLoop.avenue = "Apple Park Method"
appleInc.handle = oneInfiniteLoop
steveJobs.firm = appleInc

print(steveJobs) 

To be able to replace the road property we needed to do various work, first we needed to change among the properties to variables, and we additionally needed to manually replace all of the references, since structs aren’t reference varieties, however worth varieties, therefore copies are getting used throughout.

This appears actually dangerous, we have additionally brought on various mutation and now others can even change these variable properties, which we do not essential need. Is there a greater means? Properly…

let newSteveJobs = Particular person(title: steveJobs.title,
                      firm: Firm(title: appleInc.title,
                                       handle: Tackle(avenue: "Apple Park Method",
                                                        metropolis: oneInfiniteLoop.metropolis)))

Okay, that is ridiculous, can we really do one thing higher? 🙄

Lenses

We are able to use a lens to zoom on a property and use that lens to assemble complicated varieties. A lens is a worth representing maps between a posh sort and one among its property.

Let’s maintain it easy and outline a Lens struct that may remodel a complete object to a partial worth utilizing a getter, and set the partial worth on your entire object utilizing a setter, then return a brand new “entire object”. That is how the lens definition appears like in Swift.

struct Lens<Entire, Half> {
    let get: (Entire) -> Half
    let set: (Half, Entire) -> Entire
}

Now we are able to create a lens that zooms on the road property of an handle and assemble a brand new handle utilizing an current one.

let oneInfiniteLoop = Tackle(avenue: "One Infinite Loop", metropolis: "Cupertino")
let appleInc = Firm(title: "Apple Inc.", handle: oneInfiniteLoop)
let steveJobs = Particular person(title: "Steve Jobs", firm: appleInc)

let addressStreetLens = Lens<Tackle, String>(get: { $0.avenue },
                                              set: { Tackle(avenue: $0, metropolis: $1.metropolis) })


let newSteveJobs = Particular person(title: steveJobs.title,
                          firm: Firm(title: appleInc.title,
                                           handle: addressStreetLens.set("Apple Park Method", oneInfiniteLoop)))

Let’s attempt to construct lenses for the opposite properties as properly.

let oneInfiniteLoop = Tackle(avenue: "One Infinite Loop", metropolis: "Cupertino")
let appleInc = Firm(title: "Apple Inc.", handle: oneInfiniteLoop)
let steveJobs = Particular person(title: "Steve Jobs", firm: appleInc)

let addressStreetLens = Lens<Tackle, String>(get: { $0.avenue },
                                              set: { Tackle(avenue: $0, metropolis: $1.metropolis) })

let companyAddressLens = Lens<Firm, Tackle>(get: { $0.handle },
                                                set: { Firm(title: $1.title, handle: $0) })

let personCompanyLens = Lens<Particular person, Firm>(get: { $0.firm },
                                              set: { Particular person(title: $1.title, firm: $0) })

let newAddress = addressStreetLens.set("Apple Park Method", oneInfiniteLoop)
let newCompany = companyAddressLens.set(newAddress, appleInc)
let newPerson = personCompanyLens.set(newCompany, steveJobs)

print(newPerson)

This may appears a bit unusual at first sight, however we’re simply scratching the floor right here. It’s potential to compose lenses and create a transition from an object to a different property contained in the hierarchy.

struct Lens<Entire, Half> {
    let get: (Entire) -> Half
    let set: (Half, Entire) -> Entire
}

extension Lens {
    func transition<NewPart>(_ to: Lens<Half, NewPart>) -> Lens<Entire, NewPart> {
        .init(get: { to.get(get($0)) },
              set: { set(to.set($0, get($1)), $1) })
    }

}



let personStreetLens = personCompanyLens.transition(companyAddressLens)
                                        .transition(addressStreetLens)


let newPerson = personStreetLens.set("Apple Park Method", steveJobs)

print(newPerson)

So in our case we are able to give you a transition methodology and create a lens between the particular person and the road property, this can enable us to straight modify the road utilizing this newly created lens.

Oh, by the best way, we are able to additionally prolong the unique structs to supply these lenses by default. 👍

extension Tackle {
    struct Lenses {
        static var avenue: Lens<Tackle, String> {
            .init(get: { $0.avenue },
                  set: { Tackle(avenue: $0, metropolis: $1.metropolis) })
        }
    }
}

extension Firm {

    struct Lenses {
        static var handle: Lens<Firm, Tackle> {
            .init(get: { $0.handle },
                  set: { Firm(title: $1.title, handle: $0) })
        }
    }
}

extension Particular person {

    struct Lenses {
        static var firm: Lens<Particular person, Firm> {
            .init(get: { $0.firm },
                  set: { Particular person(title: $1.title, firm: $0) })
        }
        
        static var companyAddressStreet: Lens<Particular person, String> {
            Particular person.Lenses.firm
                .transition(Firm.Lenses.handle)
                .transition(Tackle.Lenses.avenue)
        }
    }

}

let oneInfiniteLoop = Tackle(avenue: "One Infinite Loop", metropolis: "Cupertino")
let appleInc = Firm(title: "Apple Inc.", handle: oneInfiniteLoop)
let steveJobs = Particular person(title: "Steve Jobs", firm: appleInc)

let newPerson = Particular person.Lenses.companyAddressStreet.set("Apple Park Method", steveJobs)

print(newPerson)

On the decision website we had been ready to make use of one single line to replace the road property of an immutable construction, in fact we’re creating a brand new copy of your entire object, however that is good since we needed to keep away from mutations. In fact we now have to create various lenses to make this magic occur below the hood, however typically it’s definitely worth the effort. ☺️

Prisms

Now that we all know learn how to set properties of a struct hierarchy utilizing a lens, let me present you yet another information sort that we are able to use to change enum values. Prisms are similar to lenses, however they work with sum varieties. Lengthy story quick, enums are sum varieties, structs are product varieties, and the primary distinction is what number of distinctive values are you able to signify with them.

struct ProductExample {
    let a: Bool 
    let b: Int8 
}



enum SumExample {
    case a(Bool) 
    case b(Int8) 
}

One other distinction is {that a} prism getter can return a zero worth and the setter can “fail”, this implies if it’s not potential to set the worth of the property it will return the unique information worth as a substitute.

struct Prism<Entire, Half> {
    let tryGet: (Entire) -> Half?
    let inject: (Half) -> Entire
}

That is how we are able to implement a prism, we name the getter tryGet, because it returns an optionally available worth, the setter is known as inject as a result of we attempt to inject a brand new partial worth and return the entire if potential. Let me present you an instance so it will make extra sense.

enum State {
    case loading
    case prepared(String)
}

extension State {

    enum Prisms {
        static var loading: Prism<State, Void> {
            .init(tryGet: {
                guard case .loading = $0 else {
                    return nil
                }
                return ()
            },
            inject: { .loading })
        }
        
        static var prepared: Prism<State, String> {
            .init(tryGet: {
                guard case let .prepared(message) = $0 else {
                    return nil
                }
                return message
            },
            inject: { .prepared($0) })
        }
    }
}

we have created a easy State enum, plus we have prolonged it and added a brand new Prism namespace as an enum with two static properties. ExactlyOne static prism for each case that we now have within the unique State enum. We are able to use these prisms to verify if a given state has the correct worth or assemble a brand new state utilizing the inject methodology.

let loadingState = State.loading
let readyState = State.prepared("I am prepared.")


let newLoadingState = State.Prisms.loading.inject(())

let newReadyState = State.Prisms.prepared.inject("Hurray!")



let nilMessage = State.Prisms.prepared.tryGet(loadingState)
print(nilMessage)


let message = State.Prisms.prepared.tryGet(readyState)
print(message)

The syntax looks like a bit unusual on the first sight, however belief me Prisms will be very helpful. You may as well apply transformations on prisms, however that is a extra superior matter for one more day.

Anyway, this time I would wish to cease right here, since optics are fairly an enormous matter and I merely cannot cowl every little thing in a single article. Hopefully this little article will enable you to to grasp lenses and prisms only a bit higher utilizing the Swift programming language. 🙂