Add option to sort passwords (#924)

* Add DS_Store to gitignore

* Add ordered passcode

* Also match activities with only 1 group

* Recognize simonkellly as inspiration for sorted passwords

* Remove redundant helper class

* Simplify matching algorithm

---------

Co-authored-by: Gregor Billing <[email protected]>

Author: campos20

.gitignore

@@ -26,3 +26,4 @@ gradle.properties
 
 .idea/
 .vscode/
+.DS_Store

server/src/main/kotlin/org/worldcubeassociation/tnoodle/server/zip/ComputerDisplayZip.kt

@@ -1,13 +1,13 @@
 package org.worldcubeassociation.tnoodle.server.zip
 
 import org.worldcubeassociation.tnoodle.server.pdf.ScrambleSheet
-import org.worldcubeassociation.tnoodle.server.zip.util.StringUtil.randomPasscode
 import org.worldcubeassociation.tnoodle.server.zip.model.ZipArchive
 import org.worldcubeassociation.tnoodle.server.zip.model.dsl.zipArchive
 
-data class ComputerDisplayZip(val scrambleSets: Map<String, ScrambleSheet>, val competitionTitle: String) {
-    val passcodes = scrambleSets.mapValues { randomPasscode() }
-
+data class ComputerDisplayZip(
+    val scrambleSheetsWithCode: Map<String, Pair<ScrambleSheet, String>>,
+    val competitionTitle: String
+) {
     /**
      * Computer display zip
      *
@@ -17,8 +17,8 @@ data class ComputerDisplayZip(val scrambleSets: Map<String, ScrambleSheet>, val
      */
     fun assemble(): ZipArchive {
         return zipArchive {
-            for ((uniqueTitle, scrambleDoc) in scrambleSets) {
-                val passcode = passcodes.getValue(uniqueTitle)
+            for ((uniqueTitle, scrambleDocWithCode) in scrambleSheetsWithCode) {
+                val (scrambleDoc, passcode) = scrambleDocWithCode
                 val pdfBytes = scrambleDoc.render(passcode)
 
                 file("$uniqueTitle.pdf", pdfBytes)

server/src/main/kotlin/org/worldcubeassociation/tnoodle/server/zip/ScrambleZip.kt

@@ -1,12 +1,13 @@
 package org.worldcubeassociation.tnoodle.server.zip
 
 import org.worldcubeassociation.tnoodle.server.pdf.ScrambleSheet
-import org.worldcubeassociation.tnoodle.server.zip.util.StringUtil.toFileSafeString
 import org.worldcubeassociation.tnoodle.server.wcif.model.Competition
 import org.worldcubeassociation.tnoodle.server.zip.model.ZipArchive
 import org.worldcubeassociation.tnoodle.server.zip.model.dsl.zipArchive
+import org.worldcubeassociation.tnoodle.server.zip.util.StringUtil.randomPasscode
+import org.worldcubeassociation.tnoodle.server.zip.util.StringUtil.toFileSafeString
 import java.time.LocalDateTime
-import java.util.Locale
+import java.util.*
 
 data class ScrambleZip(
     val wcif: Competition,
@@ -16,8 +17,15 @@ data class ScrambleZip(
 ) {
     private val globalTitle get() = wcif.shortName
 
-    fun assemble(generationDate: LocalDateTime, versionTag: String, pdfPassword: String?, generationUrl: String?): ZipArchive {
-        val computerDisplayZip = ComputerDisplayZip(namedSheets, globalTitle)
+    fun assemble(
+        generationDate: LocalDateTime,
+        versionTag: String,
+        pdfPassword: String?,
+        generationUrl: String?
+    ): ZipArchive {
+        val sheetsWithRandomCode = namedSheets.mapValues { it.value to randomPasscode() }
+
+        val computerDisplayZip = ComputerDisplayZip(sheetsWithRandomCode, globalTitle)
         val computerDisplayZipBytes = computerDisplayZip.assemble()
 
         val interchangeFolder = InterchangeFolder(wcif, namedSheets, globalTitle)
@@ -26,13 +34,34 @@ data class ScrambleZip(
         val printingFolder = PrintingFolder(wcif, namedSheets, fmcTranslations, watermark)
         val printingFolderNode = printingFolder.assemble(pdfPassword)
 
-        val passcodeList = computerDisplayZip.passcodes.entries
-            .joinToString("\r\n") { "${it.key}: ${it.value}" }
-
-        val passcodeListingTxt = this::class.java.getResourceAsStream(TXT_PASSCODE_TEMPLATE)
+        val resourceTemplate = this::class.java.getResourceAsStream(TXT_PASSCODE_TEMPLATE)
             .bufferedReader().readText()
             .replace("%%GLOBAL_TITLE%%", globalTitle)
-            .replace("%%PASSCODES%%", passcodeList)
+
+        val passcodeList = sheetsWithRandomCode.entries
+            .joinToString("\r\n") { "${it.key}: ${it.value.second}" }
+
+        val passcodeListingTxt =
+            resourceTemplate.replace("%%PASSCODES%%", passcodeList)
+
+        // This sorts passwords so delegates can linearly read them.
+        // This is inspired by https://github.com/simonkellly/scramble-organizer
+        // which may become deprecated after this so we are giving credit here.
+
+        val passcodesOrdered = wcif.schedule.activitiesWithLocalStartTimes.entries
+            .sortedBy { it.value }
+            .mapNotNull {
+                sheetsWithRandomCode.values.find { v ->
+                    v.first.scrambleSetId == it.key.scrambleSetId
+                }
+            }
+            .distinct()
+
+        val orderedPasscodeList = passcodesOrdered
+            .joinToString("\r\n") { "${it.first.title}: ${it.second}" }
+
+        val orderedPasscodeListingTxt =
+            resourceTemplate.replace("%%PASSCODES%%", orderedPasscodeList)
 
         val filesafeGlobalTitle = globalTitle.toFileSafeString()
 
@@ -42,6 +71,7 @@ data class ScrambleZip(
 
             file("$filesafeGlobalTitle - Computer Display PDFs.zip", computerDisplayZipBytes.compress())
             file("$filesafeGlobalTitle - Computer Display PDF Passcodes - SECRET.txt", passcodeListingTxt)
+            file("$filesafeGlobalTitle - Ordered Computer Display PDF Passcodes - SECRET.txt", orderedPasscodeListingTxt)
         }
     }