Many to one #175

neilchaudhuri · 2018-02-19T16:59:57Z

Adds support for MultiEnum, which maps multiple entries to a single enum. Also uses breakOut for some minor memory optimization.

lloydmeta

The compilation failure is real; but otherwise looks ok to me :)

lloydmeta · 2018-02-20T00:11:35Z

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

@@ -227,6 +227,19 @@ object UncapitalisedEnum extends Enum[UncapitalisedEnum] {

 }

+case object MultiEnum extends Enum[MultiEnum] {
+  import scala.collection.breakOut
+  val values = findValues


You can't do this because the type parameter passed to Enum must be a sealed trait.

Compilation error https://travis-ci.org/lloydmeta/enumeratum/jobs/343456716#L844

[error] /home/travis/build/lloydmeta/enumeratum/enumeratum-core/src/test/scala/enumeratum/Models.scala:232:16: You can only use findValues on sealed traits or classes [error] val values = findValues [error] ^

lloydmeta · 2018-02-20T00:12:18Z

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

@@ -167,6 +175,9 @@ object EnumEntry {
    */
  trait LowerCamelcase extends EnumEntry with Camelcase with Uncapitalised

+  abstract class MultiEnum(override val entryName: String,


I don't think this is needed (at least not here); looks like something you want in your tests.

lloydmeta · 2018-02-20T00:13:08Z

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

@@ -31,8 +31,8 @@ object EnumEntry {
   *
   * http://stackoverflow.com/a/19832063/1814775
   */
-  private val regexp1: Pattern    = Pattern.compile("([A-Z]+)([A-Z][a-z])")
-  private val regexp2: Pattern    = Pattern.compile("([a-z\\d])([A-Z])")
+  private val regexp1: Pattern = Pattern.compile("([A-Z]+)([A-Z][a-z])")


Since we don't need the class you added, please revert these formatting changes.

lloydmeta · 2018-02-20T00:16:33Z

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

-  lazy final val namesToValuesMap: Map[String, A] =
-    values.map(v => v.entryName -> v).toMap
+  lazy val namesToValuesMap: Map[String, A] =
+    values.map(v => v.entryName -> v)(breakOut)


I'm not a fan of using breakOut here; I know what it does, but:

It's not obvious to beginners how it works;

It'll likely be gone with the new collections lib

This is a cached value; the so gains are pretty minimal.

tl;dr Removed breakOut.

breakOut is definitely complex since CanBuildFrom isn't exactly the most intuitive concept, and I know that its days are numbered in Scala collections--though it isn't deprecated and probably won't be for some time. It just won't be necessary with the new views.

Also, breakOut is a memory optimization to eliminate the need for an intermediate sequence--cached values or not. I worry that might matter when people use enums in "Big Data" (as with Apache Spark) scenarios, but it is definitely true that the sequences for most cases are so small that breakOut probably doesn't change the world.

lloydmeta

First of all thanks so much ! This is great work. Just one small suggestion and I think we should be good to go.

For sanity, we should update the other Maps, otherwise things can get weird.

lloydmeta · 2018-02-21T12:18:49Z

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

@@ -38,7 +37,7 @@ trait Enum[A <: EnumEntry] {
  /**
    * Map of [[A]] object names to [[A]]s
    */
-  lazy final val namesToValuesMap: Map[String, A] =
+  lazy val namesToValuesMap: Map[String, A] =


Nice.

I think we should probably modify these Maps to be in terms of namesToValuesMap as well (I'd like to keep them final for now)

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

Lines 47 to 54 in c895c32

lazy final val lowerCaseNamesToValuesMap: Map[String, A] =

values.map(v => v.entryName.toLowerCase -> v).toMap

/**

* Map of [[A]] object names in upper case to [[A]]s for case-insensitive comparison

*/

lazy final val upperCaseNameValuesToMap: Map[String, A] =

values.map(v => v.entryName.toUpperCase -> v).toMap

Can you clarify what you mean here?

Right now, they're built in terms of values directly, whereas I think they should be built in terms of namesToValuesMap so that they can have the same values (in case the user overrides namesToValuesMap and wants to use functions that call lowerCaseNamesToValuesMap)

I think I got it.

lloydmeta · 2018-02-21T13:28:08Z

Actually, the tests are failing with valid failures,

See: https://travis-ci.org/lloydmeta/enumeratum/jobs/343869470#L2751


[info]   - should return the proper object when passed the proper string *** FAILED ***
[info]     java.util.NoSuchElementException: One is not a member of Enum (one, two)
[info]     at $c_ju_NoSuchElementException.$c_jl_Throwable.fillInStackTrace__jl_Throwable(/home/travis/build/lloydmeta/enumeratum/enumeratum-core/.js/target/scala-2.12/enumeratum-test-fastopt.js:27434:14)
[info]     at $c_ju_NoSuchElementException.$c_jl_Throwable.init___T__jl_Throwable(/home/travis/build/lloydmeta/enumeratum/enumeratum-core/.js/target/scala-2.12/enumeratum-test-fastopt.js:27466:8)
[info]     at java.util.NoSuchElementException.<init>(/home/travis/build/lloydmeta/enumeratum/enumeratum-core/.js/target/scala-2.12/enumeratum-test-fastopt.js:43347:52)
[info]     at enumeratum.Enum.withName(/home/travis/build/lloydmeta/enumeratum/enumeratum-core/.js/target/scala-2.12/enumeratum-test-fastopt.js:1193:46)
[info]     at {anonymous}()(/home/travis/build/lloydmeta/enumeratum/enumeratum-core/.js/target/scala-2.12/enumeratum-test-fastopt.js:75695:27)
[info]     at scala.scalajs.runtime.AnonFunction0.apply(/home/travis/build/lloydmeta/enumeratum/enumeratum-core/.js/target/scala-2.12/enumeratum-test-fastopt.js:36528:23)
[info]     at org.scalatest.OutcomeOf.outcomeOf(/home/travis/build/lloydmeta/enumeratum/enumeratum-core/.js/target/scala-2.12/enumeratum-test-fastopt.js:1852:7)
[info]     at org.scalatest.Transformer.apply(/home/travis/build/lloydmeta/enumeratum/enumeratum-core/.js/target/scala-2.12/enumeratum-test-fastopt.js:48096:10)
[info]     at org.scalatest.FunSpecLike$$anon$1.apply(/home/travis/build/lloydmeta/enumeratum/enumeratum-core/.js/target/scala-2.12/enumeratum-test-fastopt.js:38048:72)
[info]     at org.scalatest.FunSpecLike.invokeWithFixture$1(/home/travis/build/lloydmeta/enumeratum/enumeratum-core/.js/target/scala-2.12/enumeratum-test-fastopt.js:71598:15)

Pretty sure that's a fresh failure. Have you tried running the tests locally??

neilchaudhuri · 2018-02-22T05:49:15Z

I ran test and got a message that all the tests passed. However, I didn't realize other tests failed to run because of an OutOfMemoryError. Meanwhile, the test in question failed because of bad setup. Sorry for the carelessness on both counts.

The tests should pass now.

coveralls · 2018-02-23T05:11:27Z

Coverage remained the same at 100.0% when pulling 2c604d3 on neilchaudhuri:many-to-one into 6595742 on lloydmeta:master.

neilchaudhuri · 2018-03-01T05:26:47Z

Everything should be in order except with regard to that one clarification I need. Can you elaborate on that? Thanks.

lloydmeta · 2018-03-01T05:33:14Z

@neilchaudhuri sorry for the radio silence I'm currently away on a business trip. Will take a closer look and answer any questions when I'm back !!

neilchaudhuri · 2018-03-01T14:43:53Z

Oh OK. Good luck with the business and safe travels!

lloydmeta

LGTM!

lloydmeta · 2018-03-14T23:44:57Z

I've just released this as part of 1.5.13 :)

neilchaudhuri · 2018-03-14T23:45:33Z

Awesome. Thanks. I hope people find the feature useful.

drewboardman · 2021-11-01T20:17:30Z

Is there any documentation on how to use this? I'm not seeing MultiEnum available. Was this removed - or are we intended to also override nameToValuesMap?

lloydmeta · 2021-11-02T08:48:14Z

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

Lines 438 to 442 in 87c4096

    
           MultiEnum.withName("one") shouldBe MultiEnum.One 
        
           MultiEnum.withName("1") shouldBe MultiEnum.One 
        
           a[NoSuchElementException] should be thrownBy MultiEnum.withName("One") 
        
           MultiEnum.withName("eins") shouldBe MultiEnum.One 
        
           MultiEnum.withName("two") shouldBe MultiEnum.Two

^ should show usage?

ChernikovP · 2021-11-30T17:54:46Z

@drewboardman , apparently this MultiEnum is still and was always under test directory, rather than src, thus it's not actually available...

neilchaudhuri added 5 commits February 18, 2018 20:12

Spec for MultiEnum

62b9a67

Add MultiEnum

fe050ae

Add MultiEnum

6bd23b5

Add breakOut for memory optimization

8b46940

Merge branch 'master' into many-to-one

e48eb12

neilchaudhuri mentioned this pull request Feb 19, 2018

Question: Many-to-One Relationships #165

Closed

lloydmeta requested changes Feb 20, 2018

View reviewed changes

lloydmeta reviewed Feb 20, 2018

View reviewed changes

neilchaudhuri added 3 commits February 20, 2018 09:56

Reverted

d76f40d

Removed breakOut

9441907

Brought MultiEnum here; removed breakOut

67984ff

lloydmeta requested changes Feb 21, 2018

View reviewed changes

neilchaudhuri added 3 commits February 22, 2018 01:15

Fix spec setup

21dd9b1

Syntactic sugar

cf7cad8

Add exception test

79d8ad6

lloydmeta and others added 3 commits March 12, 2018 08:28

Merge branch 'master' into many-to-one

7871c68

Use namesToValuesMap instead of values

308716d

Merge remote-tracking branch 'origin/many-to-one' into many-to-one

5e27c6b

lloydmeta approved these changes Mar 14, 2018

View reviewed changes

Merge branch 'master' into many-to-one

2c604d3

lloydmeta merged commit d328c23 into lloydmeta:master Mar 14, 2018

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Many to one #175

Many to one #175

neilchaudhuri commented Feb 19, 2018

lloydmeta left a comment

lloydmeta Feb 20, 2018

neilchaudhuri Feb 20, 2018

lloydmeta Feb 20, 2018

neilchaudhuri Feb 20, 2018

lloydmeta Feb 20, 2018

neilchaudhuri Feb 20, 2018

lloydmeta Feb 20, 2018

neilchaudhuri Feb 20, 2018

lloydmeta left a comment •

edited

Loading

lloydmeta Feb 21, 2018

neilchaudhuri Feb 22, 2018

lloydmeta Mar 11, 2018

neilchaudhuri Mar 14, 2018

lloydmeta commented Feb 21, 2018

neilchaudhuri commented Feb 22, 2018 •

edited

Loading

coveralls commented Feb 23, 2018 •

edited

Loading

neilchaudhuri commented Mar 1, 2018

lloydmeta commented Mar 1, 2018

neilchaudhuri commented Mar 1, 2018

lloydmeta left a comment

lloydmeta commented Mar 14, 2018

neilchaudhuri commented Mar 14, 2018

drewboardman commented Nov 1, 2021

lloydmeta commented Nov 2, 2021

ChernikovP commented Nov 30, 2021

	lazy final val lowerCaseNamesToValuesMap: Map[String, A] =
	values.map(v => v.entryName.toLowerCase -> v).toMap

	/**
	* Map of [[A]] object names in upper case to [[A]]s for case-insensitive comparison
	*/
	lazy final val upperCaseNameValuesToMap: Map[String, A] =
	values.map(v => v.entryName.toUpperCase -> v).toMap

Many to one #175

Many to one #175

Conversation

neilchaudhuri commented Feb 19, 2018

lloydmeta left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lloydmeta left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lloydmeta commented Feb 21, 2018

neilchaudhuri commented Feb 22, 2018 • edited Loading

coveralls commented Feb 23, 2018 • edited Loading

neilchaudhuri commented Mar 1, 2018

lloydmeta commented Mar 1, 2018

neilchaudhuri commented Mar 1, 2018

lloydmeta left a comment

Choose a reason for hiding this comment

lloydmeta commented Mar 14, 2018

neilchaudhuri commented Mar 14, 2018

drewboardman commented Nov 1, 2021

lloydmeta commented Nov 2, 2021

ChernikovP commented Nov 30, 2021

lloydmeta left a comment •

edited

Loading

neilchaudhuri commented Feb 22, 2018 •

edited

Loading

coveralls commented Feb 23, 2018 •

edited

Loading