-
Notifications
You must be signed in to change notification settings - Fork 4
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
Changes from 1 commit
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
// 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: | ||
val accept: String = ".pdf" // only PDF files are currently allowed | ||
|
||
object ProposalAttachmentType: | ||
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 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. We might be able to. 🤔 I'll probably have to add |
||
.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) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can we have this as a constant on the object?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah. We can. I was just anticipating the day when
they
decide that we need to support different file types for different attachment types, like we do for obs attachments. But, that's probably a bit too paranoid and easy to fix, anyway.