Create FUUID macro annotation to auto-generate Id types

[alejandrohdezma]

What has been done in this PR?

• Create a @FUUID annotation that can be used on any kind of object to automatically create an inner Id tagged FUUID type with convenient methods for its creation. It also provides implicit instances for cats' Show, Hash and Order.

Example:

//This...
@FUUID object Institution

//...is transformed into this...
object Institution {

  trait IdTag
     
  type Id = shapeless.tag.@@[FUUID, IdTag]
   
  object Id {
   	
  	//Creates a new `Id` from a `FUUID`
  	def apply(fuuid: FUUID): Institution.Id =
  		shapeless.tag[IdTag][FUUID](fuuid)
   
  	//Creates a new `Id` from an `UUID` literal. This method
  	//uses a macro to compile check the literal value
  	def apply(s: String): Institution.Id =
  		macro FUUIDMacros.fuuidLiteral
   
  	//Creates a random `Id` wrapped in an `F`
  	def random[F[_]: Sync]: F[Institution.Id] =
  		FUUID.randomFUUID[F].map(apply)
  
  	object Unsafe {
      
  		//Creates an unwrapped random `Id`
  		def random: Institution.Id =
  			random.unsafeRunSync())

		}
       
  }

  implicit val IdHashOrderShowInstances: Hash[Institution.Id] with Order[Institution.Id] with Show[Institution.Id] = ???

}

IntelliJ IDEA users

If you are trying to review this PR using IntelliJ IDEA IDE you will probable be thinking that the FUUID annotation is not working, since all references to Id appear red:

No problem at all! This is caused by a known issue in IntelliJ IDEA Scala plugin. But it's easily solved with the help of a small plugin, and, guess what? This PR comes with its own support plugin. Just:

• Download the plugin
• Inside IntelliJ Preferences -> Plugins -> ... -> Install plugin from disk ... and select the downloaded jar

And all those nasty red lines will disappear:

References

• Macro Annotations
• FUUID

Future work

• Contribute the IntelliJ IDEA plugin as another module

[ChristopherDavenport]

Will this conflict on import?

[alejandrohdezma]

Mmmm, with FUUID, yep.

Maybe we can think of another name for the annotation... DeriveId?

[ChristopherDavenport]

Yeah, that seems reasonable.

[alejandrohdezma]

Updated to @DeriveId ef5aabb

[ChristopherDavenport]

Any objections to getting a base out?

[alejandrohdezma]

Nope :)