Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add ProposalAttachmentType dynamic enum. #389

Merged
merged 2 commits into from
Dec 12, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion build.sbt
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ val munitCatsEffectVersion = "1.0.7"
val lucumaCoreVersion = "0.88.2"
val lucumaODBSchema = "0.7.0"

ThisBuild / tlBaseVersion := "0.65"
ThisBuild / tlBaseVersion := "0.66"
ThisBuild / tlCiReleaseBranches := Seq("main")
ThisBuild / crossScalaVersions := Seq("3.3.1")
ThisBuild / tlVersionIntroduced := Map("3" -> "0.29.0")
Expand Down
64 changes: 34 additions & 30 deletions lucuma-schemas/src/clue/scala/lucuma/schemas/ObservationDB.scala
Original file line number Diff line number Diff line change
Expand Up @@ -20,41 +20,44 @@ import lucuma.core.math.BrightnessUnits._
trait ObservationDB {
object Scalars {
// Ids
type AtomId = Atom.Id
type ExecutionEventId = ExecutionEvent.Id
type GroupId = Group.Id
type ObsAttachmentId = ObsAttachment.Id
type ObservationId = Observation.Id
type ProgramId = Program.Id
type StepId = Step.Id
type DatasetId = Dataset.Id
type TargetId = Target.Id
type UserId = User.Id
type VisitId = Visit.Id
type AtomId = Atom.Id
type ExecutionEventId = ExecutionEvent.Id
type GroupId = Group.Id
type ObsAttachmentId = ObsAttachment.Id
type ObservationId = Observation.Id
type ProgramId = Program.Id
type StepId = Step.Id
type DatasetId = Dataset.Id
type TargetId = Target.Id
type UserId = User.Id
type VisitId = Visit.Id
// Basic types
type BigDecimal = scala.BigDecimal
type Long = scala.Long
type BigDecimal = scala.BigDecimal
type Long = scala.Long
// Formatted strings
type DatasetFilename = String
type DmsString = String
type EpochString = String
type HmsString = String
type DatasetFilename = String
type DmsString = String
type EpochString = String
type HmsString = String
// Refined
type Extinction = NonNegBigDecimal // """Non-negative floating-point value."""
type NonEmptyString = eu.timepit.refined.types.string.NonEmptyString
type NonNegBigDecimal = eu.timepit.refined.types.numeric.NonNegBigDecimal
type NonNegInt = eu.timepit.refined.types.numeric.NonNegInt
type NonNegLong = eu.timepit.refined.types.numeric.NonNegLong
type NonNegShort = eu.timepit.refined.types.numeric.NonNegShort
type PosBigDecimal = eu.timepit.refined.types.numeric.PosBigDecimal
type PosInt = eu.timepit.refined.types.numeric.PosInt
type PosLong = eu.timepit.refined.types.numeric.PosLong
type PosShort = eu.timepit.refined.types.numeric.PosShort
type Extinction = NonNegBigDecimal // """Non-negative floating-point value."""
type NonEmptyString = eu.timepit.refined.types.string.NonEmptyString
type NonNegBigDecimal = eu.timepit.refined.types.numeric.NonNegBigDecimal
type NonNegInt = eu.timepit.refined.types.numeric.NonNegInt
type NonNegLong = eu.timepit.refined.types.numeric.NonNegLong
type NonNegShort = eu.timepit.refined.types.numeric.NonNegShort
type PosBigDecimal = eu.timepit.refined.types.numeric.PosBigDecimal
type PosInt = eu.timepit.refined.types.numeric.PosInt
type PosLong = eu.timepit.refined.types.numeric.PosLong
type PosShort = eu.timepit.refined.types.numeric.PosShort
// Core Types
type SignalToNoise = lucuma.core.math.SignalToNoise
type Timestamp = lucuma.core.util.Timestamp
type SignalToNoise = lucuma.core.math.SignalToNoise
type Timestamp = lucuma.core.util.Timestamp
// Enum Meta
type ObsAttachmentTypeMeta = lucuma.schemas.enums.ObsAttachmentType
// These mappings cannot be used, because the decoder is for the
// Enumerated instances, but this prevents a spurious codec from being generated.
type ObsAttachmentTypeMeta = lucuma.schemas.enums.ObsAttachmentType
type ProposalAttachmentTypeMeta = lucuma.schemas.enums.ProposalAttachmentType
}

object Enums {
Expand Down Expand Up @@ -113,6 +116,7 @@ trait ObservationDB {
type Partner = model.Partner
type PlanetSpectrum = enums.PlanetSpectrum
type PlanetaryNebulaSpectrum = enums.PlanetaryNebulaSpectrum
type ProposalAttachmentType = lucuma.schemas.enums.ProposalAttachmentType
type QuasarSpectrum = enums.QuasarSpectrum
type ScienceMode = enums.ScienceMode
type SequenceCommand = enums.SequenceCommand
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ import cats.Eq
import cats.derived.*
import io.circe.*
import io.circe.generic.semiauto
import io.circe.generic.semiauto.*
import lucuma.core.util.Display
import lucuma.core.util.Enumerated
import lucuma.core.util.NewType
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
// Copyright (c) 2016-2023 Association of Universities for Research in Astronomy, Inc. (AURA)
// For license information see LICENSE or https://opensource.org/licenses/BSD-3-Clause

package lucuma.schemas.enums

import cats.Eq
import cats.derived.*
import io.circe.*
import io.circe.generic.semiauto
import lucuma.core.util.Display
import lucuma.core.util.Enumerated
import monocle.Focus
import monocle.Lens

case class ProposalAttachmentType(
tag: String,
shortName: String,
longName: String
) derives Eq

object ProposalAttachmentType:
val accept: String = ".pdf" // only PDF files are currently allowed

given Display[ProposalAttachmentType] = Display.by(_.shortName, _.longName)

val tag: Lens[ProposalAttachmentType, String] = Focus[ProposalAttachmentType](_.tag)
val shortName: Lens[ProposalAttachmentType, String] = Focus[ProposalAttachmentType](_.shortName)
val longName: Lens[ProposalAttachmentType, String] = Focus[ProposalAttachmentType](_.longName)

val values: List[ProposalAttachmentType] =
// This is a meta decoder, not a decoder for enum instances (which comes from the `Enumerated` instance)
given Decoder[ProposalAttachmentType] = semiauto.deriveDecoder

DynamicEnums.parsedEnums
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wonder if we can abstract away the common logic of all dynamic enums.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We might be able to. 🤔 I'll probably have to add Partner at some point soon. I'll look at it then.

.downField("proposalAttachmentTypeMeta")
.as[List[ProposalAttachmentType]] match
case Left(err) => err.printStackTrace; throw err
case Right(json) => json

// The givens are apparently (probably) constructed lazily.
// See https://alexn.org/blog/2022/05/11/implicit-vs-scala-3-given/
// We want to fail immediately if there is a problem, so we'll reference
// the enumerated givens here.
Enumerated[ProposalAttachmentType]

given Enumerated[ProposalAttachmentType] =
Enumerated.from(values.head, values.tail: _*).withTag(_.tag)