Merge pull request #522 from digital-preservation/DR2-2044_replaceSaveButtonWithOk

DR2 2044 replace save button with ok

Author: techncl

csv-validator-ui/src/main/scala/uk/gov/nationalarchives/csv/validator/ui/CsvValidatorUi.scala

@@ -24,8 +24,9 @@ import java.net.URL
 import java.nio.charset.Charset
 import java.nio.charset.StandardCharsets.UTF_8
 import java.nio.file.{Files, Path, Paths, StandardOpenOption}
+import java.text.SimpleDateFormat
 import java.util
-import java.util.Properties
+import java.util.{Date, Properties}
 import java.util.jar.{Attributes, Manifest}
 import javax.swing.SpringLayout.Constraints
 import javax.swing._
@@ -187,14 +188,9 @@ object CsvValidatorUi extends SimpleSwingApplication {
    * @param s String to save to the file
    * @param f File to which the associated string is saved
    */
-  private def saveToFile(s: String, f: Path) : Option[IOException] = {
-    val data : Array[Byte] =  s.getBytes(UTF_8)
-    try {
-      Files.write(f, data, StandardOpenOption.WRITE, StandardOpenOption.CREATE_NEW)
-      None
-    } catch {
-      case ioe: IOException => Some(ioe)
-    }
+  private def saveToFile(s: String, f: Path) : Try[String] = {
+    val data : Array[Byte] = s.getBytes(UTF_8)
+    Try(Files.write(f, data, StandardOpenOption.WRITE, StandardOpenOption.CREATE_NEW)).map(_ => "s has been written to file")
   }
 
   case class Settings(lastCsvPath: Path, lastCsvSchemaPath: Path, lastReportPath: Path)
@@ -293,6 +289,7 @@ object CsvValidatorUi extends SimpleSwingApplication {
       case None =>
         userDir.toFile
     })
+    csvFileChooser.title = "Select a .csv file"
     csvFileChooser.fileFilter = new FileNameExtensionFilter("CSV file (*.csv)", "csv")
     private val btnChooseCsvFile = new Button("...")
 
@@ -318,6 +315,7 @@ object CsvValidatorUi extends SimpleSwingApplication {
       case None =>
         userDir.toFile
     })
+    csvSchemaFileChooser.title = "Select a .csvs file"
     csvSchemaFileChooser.fileFilter = new FileNameExtensionFilter("CSV Schema file (*.csvs)", "csvs" +
       "")
 
@@ -423,9 +421,14 @@ object CsvValidatorUi extends SimpleSwingApplication {
       case None =>
         userDir.toFile
     })
-    private val btnSave = new Button("Save")
+    val dateFormat = new SimpleDateFormat("dd-mm-yy_HH-mm-ss")
+    reportFileChooser.selectedFile = new File(s"csv_validator_report_${dateFormat.format(new Date())}.txt")
+
+    val saveLabel = "Save Results"
+    reportFileChooser.title = saveLabel
+    private val btnSave = new Button(saveLabel)
     btnSave.reactions += onClick {
-      chooseFile(reportFileChooser, saveToFile(txtArReport.text, _), btnSave)
+      saveFile(reportFileChooser, saveToFile(txtArReport.text, _), btnSave, btnSave.text)
       updateLastPath(reportFileChooser, {
         path =>
           loadSettings match {
@@ -515,19 +518,21 @@ object CsvValidatorUi extends SimpleSwingApplication {
         if (uri.endsWith("/")) uri else s"$uri/"
       }
 
-      def updateFileText(path: Path): Option[IOException] = {
+      def updateFileText(path: Path): Try[String] = {
         fileTextField.text = pathToUri(path)
-        None
+        Success("Text updated")
       }
 
       val okButton = new Button("OK")
       val fileButton = new Button("...")
       fileButton.reactions += {
         case ev: ButtonClicked =>
           val startingDir = if(fileTextField.text.isEmpty) userDir.toFile else Path.of(fileTextField.text).toFile
+          val helpText = s"Select the ${fromPath.split("/").last} folder"
           val fileChooser = new FileChooser(startingDir)
+          fileChooser.title = helpText
           fileChooser.fileSelectionMode = SelectionMode.FilesAndDirectories
-          chooseFile(fileChooser, f => updateFileText(f), fileButton, s"Select the ${fromPath.split("/").last} folder")
+          chooseFile(fileChooser, f => updateFileText(f), fileButton, helpText)
       }
 
       val rows = List(

csv-validator-ui/src/main/scala/uk/gov/nationalarchives/csv/validator/ui/ScalaSwingHelpers.scala

@@ -17,12 +17,24 @@ import java.nio.file.Path
 import scala.swing.Dialog.Message
 import java.io.IOException
 import javax.swing.JTextField
+import scala.util.{Failure, Success, Try}
 
 /**
  * Some simple helpers to ease
  * the use of scala.swing
  */
 object ScalaSwingHelpers {
+  private def handleSelectedFile(dialogAction: Result.Value, fileChooser: FileChooser, result: Path => Try[String], fileAction: String): Unit =
+    dialogAction match {
+      case Result.Approve =>
+        result(fileChooser.selectedFile.toPath) match {
+          case Failure(e) =>
+            e.printStackTrace()
+            Dialog.showMessage(fileChooser, s"${e.getClass.getName}: ${e.getMessage}", s"Unable to ${fileAction.toLowerCase()} file", Message.Error)
+          case _ => ()
+        }
+      case _ => ()
+    }
 
   /**
    * Opens a FileChooser and sets the path of the chosen file as the text of a Text Component
@@ -31,28 +43,33 @@ object ScalaSwingHelpers {
    * @param output A text component which displays the absolute path of the chosen file
    * @param locateOver A component over which the FileChooser dialog should be located
    */
-  def chooseFile(fileChooser: FileChooser, output: JTextField, locateOver: Component) : Unit = {
-    chooseFile(fileChooser, {f => output.setText(f.toAbsolutePath.toString); None}, locateOver)
-  }
+  def chooseFile(fileChooser: FileChooser, output: JTextField, locateOver: Component) : Unit =
+    chooseFile(fileChooser, f => Try(output.setText(f.toAbsolutePath.toString)).map(_ => "Path updated"), locateOver)
 
   /**
    * Opens a FileChooser and sends the result to a function
    *
    * @param fileChooser FileChooser which is Used to open file dialogs
    * @param result A function which takes the chosen file
    * @param locateOver A component over which the FileChooser dialog should be located
+   * @param approveBtnText The text to appear on the approval button of the dialog box
    */
-  def chooseFile(fileChooser: FileChooser, result: Path => Option[IOException], locateOver: Component, dialogText: String = "Save") : Unit = {
-    fileChooser.showDialog(locateOver, dialogText) match {
-      case Result.Approve =>
-        result(fileChooser.selectedFile.toPath) match {
-          case Some(ioe) =>
-            ioe.printStackTrace()
-            Dialog.showMessage(fileChooser, s"${ioe.getClass.getName}: ${ioe.getMessage}", "Unable to Save file", Message.Error)
-          case None =>
-        }
-      case Result.Cancel =>
-    }
+  def chooseFile(fileChooser: FileChooser, result: Path => Try[String], locateOver: Component, approveBtnText: String = "OK") : Unit = {
+    val showDialogAction = fileChooser.showDialog(locateOver, approveBtnText)
+    handleSelectedFile(showDialogAction, fileChooser, result, "get")
+  }
+
+  /**
+   * Opens a FileChooser and sends the result to a function
+   *
+   * @param fileChooser FileChooser which is Used to open file dialogs
+   * @param result A function which writes the report out
+   * @param locateOver A component over which the FileChooser dialog should be located
+   * @param approveBtnText The text to appear on the approval button of the dialog box
+   */
+  def saveFile(fileChooser: FileChooser, result: Path => Try[String], locateOver: Component, approveBtnText: String) : Unit = {
+    val saveDialogAction = fileChooser.showSaveDialog(locateOver)
+    handleSelectedFile(saveDialogAction, fileChooser, result, approveBtnText)
   }
 
   /**
@@ -68,7 +85,7 @@ object ScalaSwingHelpers {
   val c = List()
   def addToTableDialog(owner: Window, title: String, rows: List[Row], result: Array[String] => Unit) : Unit = {
 
-    val btnOk = new Button("Ok")
+    val btnOk = new Button("OK")
 
     val optionLayout: GridBagPanel = new GridBagPanel {
       val c = new Constraints