enumeratum.SlickEnumColumnSupport.scala Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of enumeratum-slick_3 Show documentation

enumeratum-slick

There is a newer version: 1.7.8

package enumeratum

import scala.reflect.ClassTag

/** When mixed in, allows creation of Slick mapped column types for enumeratum.Enum instances
  *
  * {{{
  * scala> import enumeratum._
  *
  * scala> sealed trait TrafficLight extends EnumEntry
  * scala> object TrafficLight extends Enum[TrafficLight] {
  *     |   case object Red    extends TrafficLight
  *     |   case object Yellow extends TrafficLight
  *     |   case object Green  extends TrafficLight
  *     |   val values = findValues
  *     | }
  * scala> trait TrafficLightMappers extends SlickEnumSupport {
  *     |   implicit val trafficLightColumnType = mappedColumnTypeForEnum(TrafficLight)
  *     |   val trafficLightLowercaseColumnType = mappedColumnTypeForLowercaseEnum(TrafficLight)
  *     |   val trafficLightUppercaseColumnType = mappedColumnTypeForUppercaseEnum(TrafficLight)
  *     | }
  * }}}
  */
trait SlickEnumColumnSupport {

  val profile: slick.relational.RelationalProfile

  def mappedColumnTypeForEnum[E <: EnumEntry](
      @deprecatedName(Symbol("enum")) e: Enum[E]
  )(implicit tag: ClassTag[E]): profile.BaseColumnType[E] = {
    /* This import has a purpose - it brings the proper
    implicit profile.BaseColumnType[String] into scope */
    import profile.api._
    profile.MappedColumnType.base[E, String](
      { _.entryName },
      { e.namesToValuesMap }
    )
  }

  def mappedColumnTypeForLowercaseEnum[E <: EnumEntry](
      @deprecatedName(Symbol("enum")) e: Enum[E]
  )(implicit tag: ClassTag[E]): profile.BaseColumnType[E] = {
    /* This import has a purpose - it brings the proper
    implicit profile.BaseColumnType[String] into scope */
    import profile.api._
    profile.MappedColumnType.base[E, String](
      { _.entryName.toLowerCase },
      { e.lowerCaseNamesToValuesMap }
    )
  }

  def mappedColumnTypeForUppercaseEnum[E <: EnumEntry](
      @deprecatedName(Symbol("enum")) e: Enum[E]
  )(implicit tag: ClassTag[E]): profile.BaseColumnType[E] = {
    /* This import has a purpose - it brings the proper
    implicit profile.BaseColumnType[String] into scope */
    import profile.api._
    profile.MappedColumnType.base[E, String](
      { _.entryName.toUpperCase },
      { e.upperCaseNameValuesToMap }
    )
  }
}