1 /*
2  *  Make.org Core API
3  *  Copyright (C) 2018 Make.org
4  *
5  * This program is free software: you can redistribute it and/or modify
6  *  it under the terms of the GNU Affero General Public License as
7  *  published by the Free Software Foundation, either version 3 of the
8  *  License, or (at your option) any later version.
9  *
10  *  This program is distributed in the hope that it will be useful,
11  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
12  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  *  GNU Affero General Public License for more details.
14  *
15  *  You should have received a copy of the GNU Affero General Public License
16  *  along with this program.  If not, see <https://www.gnu.org/licenses/>.
17  *
18  */
19 
20 package org.make.core.tag
21 
22 import enumeratum.values.{StringEnum, StringEnumEntry}
23 import io.circe.generic.semiauto.{deriveDecoder, deriveEncoder}
24 import io.circe.{Decoder, Encoder, Json}
25 import org.make.core.{SprayJsonFormatters, StringValue}
26 import org.make.core.technical.enumeratum.FallbackingCirceEnum.FallbackingStringCirceEnum
27 import spray.json.JsonFormat
28 
29 final case class TagTypeId(value: String) extends StringValue
30 
31 object TagTypeId {
32   implicit lazy val tagIdEncoder: Encoder[TagTypeId] = (a: TagTypeId) => Json.fromString(a.value)
33   implicit lazy val tagIdDecoder: Decoder[TagTypeId] = Decoder.decodeString.map(TagTypeId(_))
34 
35   implicit val tagIdFormatter: JsonFormat[TagTypeId] = SprayJsonFormatters.forStringValue(TagTypeId.apply)
36 
37 }
38 
39 sealed abstract class TagTypeDisplay(val value: String) extends StringEnumEntry
40 
41 object TagTypeDisplay extends StringEnum[TagTypeDisplay] with FallbackingStringCirceEnum[TagTypeDisplay] {
42 
43   override def default(value: String): TagTypeDisplay = Hidden
44 
45   case object Displayed extends TagTypeDisplay("DISPLAYED")
46   case object Hidden extends TagTypeDisplay("HIDDEN")
47 
48   override val values: IndexedSeq[TagTypeDisplay] = findValues
49   final val swaggerAllowableValues = "HIDDEN,DISPLAYED"
50 }
51 
52 final case class TagType(
53   tagTypeId: TagTypeId,
54   label: String,
55   display: TagTypeDisplay,
56   weight: Int = 0,
57   requiredForEnrichment: Boolean
58 )
59 
60 object TagType {
61   implicit val encoder: Encoder[TagType] = deriveEncoder[TagType]
62   implicit val decoder: Decoder[TagType] = deriveDecoder[TagType]
63 
64   val LEGACY: TagType = TagType(
65     tagTypeId = TagTypeId("8405aba4-4192-41d2-9a0d-b5aa6cb98d37"),
66     label = "Legacy",
67     display = TagTypeDisplay.Displayed,
68     requiredForEnrichment = false
69   )
70 }