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._
24 import io.circe.{Decoder, Encoder, Json}
25 import io.swagger.annotations.ApiModelProperty
26 import org.make.core.operation.OperationId
27 import org.make.core.question.QuestionId
28 import org.make.core.technical.enumeratum.FallbackingCirceEnum.FallbackingStringCirceEnum
29 import org.make.core.{MakeSerializable, SprayJsonFormatters, StringValue}
30 import spray.json.JsonFormat
31 import com.github.plokhotnyuk.jsoniter_scala.core._
32 
33 import scala.annotation.meta.field
34 
35 final case class TagId(value: String) extends StringValue
36 
37 object TagId {
38   implicit lazy val tagIdEncoder: Encoder[TagId] =
39     (a: TagId) => Json.fromString(a.value)
40   implicit lazy val tagIdDecoder: Decoder[TagId] =
41     Decoder.decodeString.map(TagId(_))
42 
43   implicit val tagIdFormatter: JsonFormat[TagId] = SprayJsonFormatters.forStringValue(TagId.apply)
44 
45   implicit val tagIdCodec: JsonValueCodec[TagId] =
46     StringValue.makeCodec(TagId.apply)
47 }
48 
49 sealed abstract class TagDisplay(val value: String) extends StringEnumEntry with Product with Serializable
50 
51 object TagDisplay extends StringEnum[TagDisplay] with FallbackingStringCirceEnum[TagDisplay] {
52 
53   override def default(value: String): TagDisplay = Inherit
54 
55   case object Displayed extends TagDisplay("DISPLAYED")
56   case object Hidden extends TagDisplay("HIDDEN")
57   case object Inherit extends TagDisplay("INHERIT")
58 
59   override val values: IndexedSeq[TagDisplay] = findValues
60   final val swaggerAllowableValues = "DISPLAYED,HIDDEN,INHERIT"
61 }
62 
63 final case class Tag(
64   @(ApiModelProperty @field)(dataType = "string", example = "11111111-2222-3333-4444-555555555555", required = true) tagId: TagId,
65   label: String,
66   @(ApiModelProperty @field)(dataType = "string", allowableValues = TagDisplay.swaggerAllowableValues, required = true) display: TagDisplay,
67   @(ApiModelProperty @field)(dataType = "string", example = "11111111-2222-3333-4444-555555555555", required = true) tagTypeId: TagTypeId,
68   @(ApiModelProperty @field)(dataType = "float", example = "50", required = true) weight: Float,
69   @(ApiModelProperty @field)(dataType = "string", example = "11111111-2222-3333-4444-555555555555")
70   operationId: Option[OperationId],
71   @(ApiModelProperty @field)(dataType = "string", example = "11111111-2222-3333-4444-555555555555")
72   questionId: Option[QuestionId]
73 ) extends MakeSerializable
74 
75 object Tag {
76   implicit val encoder: Encoder[Tag] = deriveEncoder[Tag]
77   implicit val decoder: Decoder[Tag] = deriveDecoder[Tag]
78 }