Rillit (without Dynamic)

This is a fork of Aki Saarinen's Rillit that provides exactly the same API and usage but does not use Dynamic.

The only changes are to the Lenser object, and the original examples will run without modification.

This fork was developed by Travis Brown as a proof of concept, and was adapted by Kevin Wright to use shapeless.Lens. Aki Saarinen's original documentation for Rillit continues below.

Rillit

Rillit provides experimental functional lenses for Scala 2.10.

Right now it is mostly an experiment in providing minimum effort creation of lenses using a Lenser, implemented with Scala 2.10 macros and Dynamic. Longer-term aim of rillit is to be a stand-alone functional lens implementation.

Here is my blog post explaining shortly what Rillit does.

Installation

Rillit is published in a Maven repository if you want to try it out. However, please note that rillit is still very much an experimental project (everything may break, or not even work in the first place).

Add the following to your SBT project to start experimenting with rillit:

resolvers += "rillit-repository" at "http://akisaarinen.github.com/rillit/maven"

libraryDependencies += "fi.akisaarinen" %% "rillit" % "0.1.0"

Why?

Functional lenses are composable getters and setters for immutable data structures, i.e. usually case classes in Scala.

Say you have the following case class structure for describing a person. The nesting seems unncessary in this small example, but that's what you need to do with larger data structures, so bear with me:

case class Email(user: String, domain: String)
case class Contact(email: Email, web: String)
case class Person(name: String, contact: Contact)

val person = Person(
  name = "Aki Saarinen",
  contact = Contact(
    email = Email("aki", "akisaarinen.fi"),
    web   = "http://akisaarinen.fi"
  )
)

Now, say you want to modify the user of the email address from 'aki' to 'john'. And because we're working with immutable data structures, we can't just assign a new value, but we want to create a new instance of Person with the user field updated.

This pattern comes up very often when writing functional code with immutable data structures.

Using pure Scala, you would do this:

scala> person.copy(contact = person.contact.copy(email = person.contact.email.copy(user = "john")))
res0: Person = Person(Aki Saarinen,Contact(Email(john,akisaarinen.fi),http://akisaarinen.fi))

The field gets updated, but the syntax is very verbose and ugly.

Functional lenses can ease the situation. Rillit provides a Lenser, which creates a new functional lens for your user field, hence making its update an easy task:

scala> Lenser[Person].contact.email.user.set(person)("john")
res1: Person = Person(Aki Saarinen,Contact(Email(john,akisaarinen.fi),http://akisaarinen.fi))

This performs the exact same thing as our long nested copy soup above, but looks a lot more civilized.

There is a whole lot more we can do with lenses (i.e. you can for example compose your lenses together, forming new lenses), but just solving this case is great on its own. Rillit focuses on implementing a boilerplate-free Lenser for the lens creation.

Difference to other implementations

The lenses themselves are very bare-bones here, the main point is to demonstrate the ability to create lenses in a boilerplate-free way for nested case classes. Lenser does just that, using macros and Dynamic.

Lens features included in e.g. Scalaz or Shapeless lenses could be combined with the functionality of Lenser, to make lens both lens creation and usage as convenient as possible. At the moment of writing this, creation of lenses in both Scalaz and Shapeless contains more boilerplate than in Rillit.

An example use of Lenser (which does not actually produce a Lens but a Lenser[A,B] which can be implicitly converted to Lens[A,B]):

val lens = Lenser[Person].contact.email

Also, this being a very early proof-of-concept experiment, the code is not very pretty (luckily there's not very much of it).

A longer example

package example

import rillit._

object Main {
  // A simple instance of Person class used for examples
  val person = Person(
    name    = Name("Aki", "Saarinen"),
    contact = Contact(
      email = Email("aki", "akisaarinen.fi"),
      web   = "http://akisaarinen.fi"
    )
  )

  // Simplest possible
  def getterExample() {
    val lens = Lenser[Person].contact.email
    println("Getter example:")
    println("  Email: %s".format(lens.get(person))) // '[email protected]'
  }

  // Use lens created on-the-fly to set a value into nested case classes.
  // The traditional way of doing this without lenses is this:
  //   val updated = person.copy(contact = person.contact.copy(email = something))
  def setterExample() {
    val updated = Lenser[Person].contact.email.set(person)(Email("foo", "foobar.com"))

    println("Setter example:")
    println("  Original person: %s".format(person))  // email = '[email protected]'
    println("  Updated person:  %s".format(updated)) // email = '[email protected]'
  }

  // Here we create two simple lenses and demonstrate the ability to compose
  // them; this is very useful in practice with functional lenses. Of course in
  // this case we could just `Lenser[Person].contact.email.user` but that wouldn't
  // demonstrate composition :)
  def lensCompositionExample() {
    val user  = Lenser[Email].user
    val email = Lenser[Person].contact.email

    val lens = user compose email

    println("Composed lens example:")
    println("  Getter: %s".format(lens.get(person)))         // 'aki'
    println("  Setter: %s".format(lens.set(person)("john"))) // email = '[email protected]'
  }

  case class Person(name: Name,  contact: Contact)
  case class Name(first: String, last: String)
  case class Contact(email: Email, web: String)
  case class Email(user: String, domain: String) {
    override def toString = "%s@%s".format(user, domain)
  }

  def main(args: Array[String]) {
    getterExample()
    setterExample()
    lensCompositionExample()
  }
}

When run, this will produce the following:

Getter example:
  Email: [email protected]
Setter example:
  Original person: Person(Name(Aki,Saarinen),Contact([email protected],http://akisaarinen.fi))
  Updated person:  Person(Name(Aki,Saarinen),Contact([email protected],http://akisaarinen.fi))
Composed lens example:
  Getter: aki
  Setter: Person(Name(Aki,Saarinen),Contact([email protected],http://akisaarinen.fi))

Requirements

Scala 2.10 (tested with 2.10.0-RC5, but will probably work with older release candidates as well)
SBT 0.12
A bit of love for functional lenses

Usage

Rillit is not currently distributed as a library, as this is just an experiment on how the functional lenses could be implemented. To try it out, install SBT 0.12, and just run the example with:

sbt "project rillit-testing" run

Caveats

Macros are an experimental feature of 2.10, so it is probably not a good idea to use something like this in critical production code just yet. Also, the code is not very pretty as-is, it's just a proof-of-concept I made to convince myself that this is even possible with Dynamic and macros.

Inspiration

Following projects motivated me to create Rillit, either because of their lens implementations, use of Scala macros, or both:

Scalaz: https://github.com/scalaz/scalaz
Shapeless: https://github.com/milessabin/shapeless
Macrocosm: https://github.com/retronym/macrocosm
sqltyped: https://github.com/jonifreeman/sqltyped

License

Rillit is released under the Apache License, Version 2.0.

Cheap and reliable Node.js hosting starts at $3/month, and $1/month static HTML hosting

travisbrown / rillit