Merge pull request #911 from gemini-hlsw/sys-type

Add program type system
gemini-hlsw · Jun 18, 2024 · e0abb58 · e0abb58
2 parents c1f61b3 + 8afc227
commit e0abb58
Show file tree

Hide file tree

Showing 5 changed files with 41 additions and 7 deletions.
diff --git a/build.sbt b/build.sbt
@@ -1,4 +1,4 @@
-ThisBuild / tlBaseVersion                         := "0.99"
+ThisBuild / tlBaseVersion                         := "0.100"
 ThisBuild / tlCiReleaseBranches                   := Seq("master")
 ThisBuild / githubWorkflowEnv += "MUNIT_FLAKY_OK" -> "true"
 

diff --git a/modules/core/shared/src/main/scala/lucuma/core/enums/ProgramType.scala b/modules/core/shared/src/main/scala/lucuma/core/enums/ProgramType.scala
@@ -18,6 +18,7 @@ enum ProgramType(val tag: String, val abbreviation: String) derives Enumerated:
   case Library       extends ProgramType("library",       "LIB")
   case Monitoring    extends ProgramType("monitoring",    "MON")
   case Science       extends ProgramType("science",       "SCI")
+  case System        extends ProgramType("system",        "SYS")
 
 object ProgramType {
 
@@ -27,4 +28,4 @@ object ProgramType {
   given Ordering[ProgramType] =
     Order[ProgramType].toOrdering
 
-}
+}
diff --git a/modules/core/shared/src/main/scala/lucuma/core/model/ProgramReference.scala b/modules/core/shared/src/main/scala/lucuma/core/model/ProgramReference.scala
@@ -176,6 +176,23 @@ object ProgramReference {
       Format(s => parse.program.parseAll(s).toOption, _.label)
   }
 
+  case class System(description: Description) extends ProgramReference {
+    override def programType: ProgramType = ProgramType.System
+
+    override def label: String =
+      s"${programType.abbreviation}-${description.value}"
+  }
+
+  object System {
+
+    given Order[System] =
+      Order.by(_.description.value)
+
+    val fromString: Prism[String, System] =
+      Prism[String, System](s => parse.system.parseAll(s).toOption)(_.label)
+
+  }
+
   object parse {
 
     import lucuma.core.enums.parser.EnumParsers.scienceSubtype
@@ -216,6 +233,9 @@ object ProgramReference {
         Science(proposal, scienceSubtype)
       }
 
+    val system: Parser[System] =
+      (string(s"SYS-") *> description).map { description => System(description) }
+
     val programReference: Parser[ProgramReference] =
       oneOf(
         parse.program.backtrack       ::
@@ -224,7 +244,8 @@ object ProgramReference {
         parse.engineering.backtrack   ::
         parse.example.backtrack       ::
         parse.library.backtrack       ::
-        parse.monitoring              ::
+        parse.monitoring.backtrack    ::
+        parse.system                  ::
         Nil
       )
   }
@@ -251,10 +272,11 @@ object ProgramReference {
       case (a @ Library(_, _),          b @ Library(_, _))          => Order.compare(a, b)
       case (a @ Monitoring(_, _, _),    b @ Monitoring(_, _, _))    => Order.compare(a, b)
       case (a @ Science(_, _),          b @ Science(_, _))          => Order.compare(a, b)
-      case (a, b) => Order.compare(a.programType, b.programType)
+      case (a @ System(_),              b @ System(_))              => Order.compare(a, b)
+      case (a, b)                                                   => Order.compare(a.programType, b.programType)
     }
 
   given Ordering[ProgramReference] =
     Order[ProgramReference].toOrdering
 
-}
+}
diff --git a/modules/testkit/src/main/scala/lucuma/core/model/arb/ArbProgramReference.scala b/modules/testkit/src/main/scala/lucuma/core/model/arb/ArbProgramReference.scala
@@ -67,6 +67,9 @@ trait ArbProgramReference extends ArbReference {
   val engineeringStrings: Gen[String] =
     referenceStrings[Engineering](_.label)
 
+  val calibrationLibraryStrings: Gen[String] =
+    referenceStrings[System](_.label)
+
   given Arbitrary[Example] =
     Arbitrary {
       arbitrary[Instrument].map(Example.apply)
@@ -107,6 +110,12 @@ trait ArbProgramReference extends ArbReference {
   given Cogen[Monitoring] =
     cogSemesterlyInstrument[Monitoring]
 
+  given Arbitrary[System] =
+    Arbitrary(arbitrary[Description].map(System(_)))
+
+  given Cogen[System] =
+    Cogen[Description].contramap(_.description)
+
   val monitoringStrings: Gen[String] =
     referenceStrings[Monitoring](_.label)
 
@@ -136,7 +145,8 @@ trait ArbProgramReference extends ArbReference {
         arbitrary[Example],
         arbitrary[Library],
         arbitrary[Monitoring],
-        arbitrary[Science]
+        arbitrary[Science],
+        arbitrary[System]
       )
     }
 

diff --git a/modules/tests/shared/src/test/scala/lucuma/core/model/ProgramReferenceSuite.scala b/modules/tests/shared/src/test/scala/lucuma/core/model/ProgramReferenceSuite.scala
@@ -21,6 +21,7 @@ final class ProgramReferenceSuite extends munit.DisciplineSuite {
   checkAll("Example.fromString",     PrismTests(Example.fromString))
   checkAll("Library.fromString",     PrismTests(Library.fromString))
   checkAll("Science.fromString",     FormatTests(Science.fromString).formatWith(scienceStrings))
+  checkAll("System.fromString",      PrismTests(System.fromString))
 
-  checkAll("ProgramReference", FormatTests(ProgramReference.fromString).formatWith(programReferenceStrings))
+  checkAll("ProgramReference",       FormatTests(ProgramReference.fromString).formatWith(programReferenceStrings))
 }