Merge pull request #11 from lloydmeta/feature/use-name

Feature/use name

Author: lloydmeta

.travis.yml

@@ -7,6 +7,5 @@ jdk:
   - oraclejdk8
 scala:
   - 2.11.6
-  - 2.10.5
 script: "sbt clean coverage test"
 after_success: "sbt coveralls"

README.md

@@ -20,23 +20,23 @@ Compatible with Scala 2.10.x and 2.11.x
 For basic enumeratum (with no Play support):
 ```scala
 libraryDependencies ++= Seq(
-    "com.beachape" %% "enumeratum" % "1.1.0"
+    "com.beachape" %% "enumeratum" % "1.2.0"
 )
 ```
 
 For enumeratum with Play JSON:
 ```scala
 libraryDependencies ++= Seq(
-    "com.beachape" %% "enumeratum" % "1.1.0",
-    "com.beachape" %% "enumeratum-play-json" % "1.1.0"
+    "com.beachape" %% "enumeratum" % "1.2.0",
+    "com.beachape" %% "enumeratum-play-json" % "1.2.0"
 )
 ```
 
 For enumeratum with full Play support:
 ```scala
 libraryDependencies ++= Seq(
-    "com.beachape" %% "enumeratum" % "1.1.0",
-    "com.beachape" %% "enumeratum-play" % "1.1.0"
+    "com.beachape" %% "enumeratum" % "1.2.0",
+    "com.beachape" %% "enumeratum-play" % "1.2.0"
 )
 ```
 
@@ -51,9 +51,9 @@ the `values` method. If you don't care about ordinality, just pass `findValues`
 
 ```scala
 
-import enumeratum.Enum
+import enumeratum._
 
-sealed trait Greeting
+sealed trait Greeting extends EnumEntry
 
 object Greeting extends Enum[Greeting] {
 
@@ -107,9 +107,9 @@ For example:
 ```scala
 package enums._
 
-import enumeratum.PlayEnum
+import enumeratum._
 
-sealed trait Greeting
+sealed trait Greeting extends EnumEntry
 
 object Greeting extends PlayEnum[Greeting] {
 

enumeratum-core/src/main/scala/enumeratum/Enum.scala

@@ -10,7 +10,7 @@ import scala.language.postfixOps
  * This is yet another one.
  *
  * Oh yeah, [[Enum]] is BYOO (bring your own ordinality). Take care of that when
- * you implement the value method.
+ * you implement the values method.
  *
  * How to use:
  *
@@ -34,7 +34,7 @@ import scala.language.postfixOps
  * }}}
  * @tparam A The sealed trait
  */
-trait Enum[A] {
+trait Enum[A <: EnumEntry] {
 
   /**
    * The sequence of values for your [[Enum]]. You will typically want
@@ -57,12 +57,12 @@ trait Enum[A] {
   /**
    * Map of [[A]] object names to [[A]]s
    */
-  lazy final val namesToValuesMap: Map[String, A] = values map (v => v.toString -> v) toMap
+  lazy final val namesToValuesMap: Map[String, A] = values map (v => v.entryName -> v) toMap
 
   /**
    * Map of [[A]] object names in lower case to [[A]]s for case-insensitive comparison
    */
-  lazy final val lowerCaseNamesToValuesMap: Map[String, A] = values map (v => v.toString.toLowerCase -> v) toMap
+  lazy final val lowerCaseNamesToValuesMap: Map[String, A] = values map (v => v.entryName.toLowerCase -> v) toMap
 
   /**
    * Optionally returns an [[A]] for a given name.
@@ -75,11 +75,11 @@ trait Enum[A] {
   def withNameInsensitiveOption(name: String): Option[A] = lowerCaseNamesToValuesMap get name.toLowerCase
 
   /**
-   * Tries to get an [[A]] by the supplied name. The name corresponds to the .toString
+   * Tries to get an [[A]] by the supplied name. The name corresponds to the .name
    * of the case objects implementing [[A]]
    *
    * Like [[Enumeration]]'s `withName`, this method will throw if the name does not match any of the values'
-   * .toString names.
+   * .entryName values.
    */
   def withName(name: String): A =
     withNameOption(name) getOrElse (throw new NoSuchElementException(s"$name is not a member of Enum $this"))

enumeratum-core/src/main/scala/enumeratum/EnumEntry.scala

@@ -0,0 +1,18 @@
+package enumeratum
+
+/**
+ * Base type for an enum entry for [[Enum]]
+ *
+ * By default, the entryName method used for serialising and deseralising Enum values uses
+ * toString, but feel free to override to fit your needs
+ */
+trait EnumEntry {
+
+  /**
+   * String representation of this Enum Entry.
+   *
+   * Override in your implementation if needed
+   */
+  def entryName: String = toString
+
+}

enumeratum-core/src/test/scala/enumeratum/EnumSpec.scala

@@ -132,7 +132,7 @@ class EnumSpec extends FunSpec with Matchers {
 
     it("should fail to compile for unsealed traits") {
       """
-        trait NotSealed
+        trait NotSealed extends EnumEntry
 
         object NotSealed extends Enum[NotSealed] {
           val values = findValues
@@ -142,7 +142,7 @@ class EnumSpec extends FunSpec with Matchers {
 
     it("should fail to compile for unsealed abstract classes") {
       """
-        abstract class Abstract
+        abstract class Abstract extends EnumEntry
 
         object Abstract extends Enum[Abstract] {
           val values = findValues
@@ -152,7 +152,7 @@ class EnumSpec extends FunSpec with Matchers {
 
     it("should fail to compile for classes") {
       """
-        class Class
+        class Class extends EnumEntry
 
         object Class extends Enum[Class] {
           val values = findValues
@@ -162,7 +162,7 @@ class EnumSpec extends FunSpec with Matchers {
 
     it("should fail to compile if the enum is not an object") {
       """
-      sealed trait Foo
+      sealed trait Foo extends EnumEntry
 
       class Class extends Enum[Foo] {
         val values = findValues

enumeratum-core/src/test/scala/enumeratum/Models.scala

@@ -1,6 +1,6 @@
 package enumeratum
 
-sealed trait DummyEnum
+sealed trait DummyEnum extends EnumEntry
 
 object DummyEnum extends Enum[DummyEnum] {
 
@@ -14,7 +14,7 @@ object DummyEnum extends Enum[DummyEnum] {
 
 object Wrapper {
 
-  sealed trait SmartEnum
+  sealed trait SmartEnum extends EnumEntry
 
   object SmartEnum extends Enum[SmartEnum] {
 
@@ -29,7 +29,7 @@ object Wrapper {
 }
 
 object InTheWoods {
-  sealed abstract class Mushroom(val toxic: Boolean)
+  sealed abstract class Mushroom(val toxic: Boolean) extends EnumEntry
 
   object Mushroom extends Enum[Mushroom] {
 

enumeratum-play-json/src/main/scala/enumeratum/Json.scala

@@ -13,7 +13,7 @@ object Json {
    * @param enum The enum
    * @param insensitive bind in a case-insensitive way, defaults to false
    */
-  def reads[A](enum: Enum[A], insensitive: Boolean = false): Reads[A] = new Reads[A] {
+  def reads[A <: EnumEntry](enum: Enum[A], insensitive: Boolean = false): Reads[A] = new Reads[A] {
     def reads(json: JsValue): JsResult[A] = json match {
       case JsString(s) => {
         val maybeBound = if (insensitive) enum.withNameInsensitiveOption(s) else enum.withNameOption(s)
@@ -29,8 +29,8 @@ object Json {
   /**
    * Returns a Json writes for a given enum [[Enum]]
    */
-  def writes[A](enum: Enum[A]): Writes[A] = new Writes[A] {
-    def writes(v: A): JsValue = JsString(v.toString)
+  def writes[A <: EnumEntry](enum: Enum[A]): Writes[A] = new Writes[A] {
+    def writes(v: A): JsValue = JsString(v.entryName)
   }
 
   /**
@@ -39,7 +39,7 @@ object Json {
    * @param enum The enum
    * @param insensitive bind in a case-insensitive way, defaults to false
    */
-  def formats[A](enum: Enum[A], insensitive: Boolean = false): Format[A] = {
+  def formats[A <: EnumEntry](enum: Enum[A], insensitive: Boolean = false): Format[A] = {
     Format(reads(enum, insensitive), writes(enum))
   }
 

enumeratum-play-json/src/main/scala/enumeratum/PlayJsonEnum.scala

@@ -2,6 +2,6 @@ package enumeratum
 
 import play.api.libs.json.Format
 
-trait PlayJsonEnum[A] { self: Enum[A] =>
+trait PlayJsonEnum[A <: EnumEntry] { self: Enum[A] =>
   implicit val jsonFormat: Format[A] = Json.formats(this)
 }

enumeratum-play-json/src/test/scala/enumeratum/Dummy.scala

@@ -3,7 +3,7 @@ package enumeratum
 /**
  * Created by Lloyd on 2/4/15.
  */
-sealed trait Dummy
+sealed trait Dummy extends EnumEntry
 object Dummy extends Enum[Dummy] with PlayJsonEnum[Dummy] {
   case object A extends Dummy
   case object B extends Dummy

enumeratum-play/src/main/scala/enumeratum/Forms.scala

@@ -19,15 +19,15 @@ object Forms {
    * @param enum The enum
    * @param insensitive bind in a case-insensitive way, defaults to false
    */
-  def enum[A](enum: Enum[A], insensitive: Boolean = false): Mapping[A] = PlayForms.of(format(enum, insensitive))
+  def enum[A <: EnumEntry](enum: Enum[A], insensitive: Boolean = false): Mapping[A] = PlayForms.of(format(enum, insensitive))
 
   /**
    * Returns a Formatter for [[Enum]]
    *
    * @param enum The enum
    * @param insensitive bind in a case-insensitive way, defaults to false
    */
-  private[enumeratum] def format[A](enum: Enum[A], insensitive: Boolean = false): Formatter[A] = new Formatter[A] {
+  private[enumeratum] def format[A <: EnumEntry](enum: Enum[A], insensitive: Boolean = false): Formatter[A] = new Formatter[A] {
     def bind(key: String, data: Map[String, String]) = {
       play.api.data.format.Formats.stringFormat.bind(key, data).right.flatMap { s =>
         val maybeBound = if (insensitive) enum.withNameInsensitiveOption(s) else enum.withNameOption(s)
@@ -37,7 +37,7 @@ object Forms {
         }
       }
     }
-    def unbind(key: String, value: A) = Map(key -> value.toString)
+    def unbind(key: String, value: A) = Map(key -> value.entryName)
   }
 
 }