1 /*
2  *  Make.org Core API
3  *  Copyright (C) 2021 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.demographics
21 
22 import org.make.core.StringValue
23 import org.make.core.technical.{Multilingual, MultilingualUtils}
24 import org.make.core.reference.Language
25 import org.make.core.question.QuestionId
26 
27 import cats.data.NonEmptyList
28 import enumeratum.{CirceEnum, Enum, EnumEntry}
29 import io.circe.generic.semiauto.deriveCodec
30 import io.circe.{Codec, Decoder, Encoder}
31 
32 import java.time.ZonedDateTime
33 
34 final case class DemographicsCardId(value: String) extends StringValue
35 
36 object DemographicsCardId {
37   implicit val codec: Codec[DemographicsCardId] =
38     Codec.from(Decoder[String].map(DemographicsCardId.apply), Encoder[String].contramap(_.value))
39 }
40 
41 final case class DemographicsCard(
42   id: DemographicsCardId,
43   name: String,
44   questionId: QuestionId,
45   layout: DemographicsCard.Layout,
46   dataType: String,
47   languages: NonEmptyList[Language],
48   titles: Multilingual[String],
49   parameters: NonEmptyList[LabelsValue],
50   createdAt: ZonedDateTime,
51   updatedAt: ZonedDateTime
52 ) {
53 
54   MultilingualUtils.hasRequiredTranslations(languages.toList.toSet, (titles -> "title") :: parameters.map {
55     case LabelsValue(key, value) => key -> s"Translations for parameter $value"
56   }.toList)
57 }
58 
59 object DemographicsCard {
60 
61   sealed abstract class Layout extends EnumEntry
62 
63   object Layout extends Enum[Layout] with CirceEnum[Layout] {
64     case object Select extends Layout
65     case object OneColumnRadio extends Layout
66     case object ThreeColumnsRadio extends Layout
67 
68     override val values: IndexedSeq[Layout] = findValues
69     final val swaggerAllowableValues = "Select,OneColumnRadio,ThreeColumnsRadio"
70   }
71 
72   val SKIPPED = "SKIPPED"
73 }
74 
75 final case class LabelsValue(label: Multilingual[String], value: String)
76 
77 object LabelsValue {
78   implicit val codec: Codec[LabelsValue] = deriveCodec
79 }
80 
81 final case class LabelValue(label: String, value: String)
82 
83 object LabelValue {
84   implicit val codec: Codec[LabelValue] = deriveCodec
85 }