Update to a newer version of Scalaz and associated libraries. Closes #110

Author: adamretter

csv-validator-cmd/src/main/scala/uk/gov/nationalarchives/csv/validator/cmd/CsvValidatorCmdApp.scala

@@ -149,16 +149,16 @@ object CsvValidatorCmdApp extends App {
 
   private def containsError(l: NonEmptyList[FailMessage]) : Boolean = {
     l.list.find(_ match {
-      case ErrorMessage(_, _, _) => true
+      case FailMessage(ValidationError, _, _, _) => true
       case _ => false
     }).nonEmpty
   }
 
   private def prettyPrint(l: NonEmptyList[FailMessage]): String = l.list.map { i =>
     i match {
-      case WarningMessage(err,_,_) => "Warning: " + err
-      case ErrorMessage(err,_,_) =>   "Error:   " + err
-      case SchemaMessage(err,_,_) =>  err
+      case FailMessage(ValidationWarning, err,_,_) => "Warning: " + err
+      case FailMessage(ValidationError, err,_,_) =>   "Error:   " + err
+      case FailMessage(SchemaDefinitionError, err,_,_) =>  err
     }
-  }.mkString(sys.props("line.separator"))
+  }.toList.mkString(sys.props("line.separator"))
 }

csv-validator-core/pom.xml

@@ -99,18 +99,13 @@
         <dependency>
             <groupId>org.scalaz.stream</groupId>
             <artifactId>scalaz-stream_${scala.version}</artifactId>
-            <version>0.6a</version>     <!-- version 0.5a is compatible with scalaz-core 7.1.0 -->
+            <version>0.7.3a</version>
         </dependency>
         <dependency>
-            <groupId>org.typelevel</groupId>
-            <artifactId>scodec-bits_${scala.version}</artifactId>
-            <version>1.0.4</version>
-        </dependency>
-        <!-- dependency>
             <groupId>org.scodec</groupId>
             <artifactId>scodec-bits_${scala.version}</artifactId>
             <version>1.0.6</version>
-        </dependency -->
+        </dependency>
         <dependency>
             <groupId>org.scalaz</groupId>
             <artifactId>scalaz-concurrent_${scala.version}</artifactId>

csv-validator-core/src/main/scala/uk/gov/nationalarchives/csv/validator/FailFastMetaDataValidator.scala

@@ -22,9 +22,11 @@ import uk.gov.nationalarchives.csv.validator.metadata.Row
 
 trait FailFastMetaDataValidator extends MetaDataValidator {
 
+  //TODO(AR) work on removing use of `Any`
+
   override def validateRows(rows: Iterator[Row], schema: Schema): MetaDataValidation[Any] = {
 
-    def containsErrors(e: MetaDataValidation[Any]): Boolean = e.fold(_.list.exists(_.isInstanceOf[ErrorMessage]), _ => false)
+    def containsErrors(e: MetaDataValidation[Any]): Boolean = e.fold(_.list.collectFirst(FailMessage.isError).nonEmpty, _ => false)
 
     @tailrec
     def validateRows(results: List[MetaDataValidation[Any]] = List.empty[MetaDataValidation[Any]]) : List[MetaDataValidation[Any]] = {

csv-validator-core/src/main/scala/uk/gov/nationalarchives/csv/validator/MetaDataValidator.scala

@@ -25,10 +25,26 @@ import uk.gov.nationalarchives.csv.validator.metadata.Row
 import scala.annotation.tailrec
 import uk.gov.nationalarchives.csv.validator.api.TextFile
 
-sealed abstract class FailMessage(val msg:String, val lineNr:Option[Int], val colIdx:Option[Int])
-case class WarningMessage(message:String, lineNumber: Option[Int] = None, columnIndex: Option[Int] = None) extends FailMessage(message, lineNumber, columnIndex)
-case class ErrorMessage(message:String, lineNumber: Option[Int] = None, columnIndex: Option[Int] = None) extends FailMessage(message, lineNumber, columnIndex)
-case class SchemaMessage(message:String, lineNumber: Option[Int] = None, columnIndex: Option[Int] = None) extends FailMessage(message, lineNumber, columnIndex)
+
+//error reporting classes
+sealed trait ErrorType
+case object ValidationWarning extends ErrorType
+case object ValidationError extends ErrorType
+case object SchemaDefinitionError extends ErrorType
+case class FailMessage(`type`: ErrorType, message : String, lineNumber: Option[Int] = None, columnIndex: Option[Int] = None) //TODO(AR) consider a better name, e.g. CsvValidationFailure
+object FailMessage {
+  def isWarning : PartialFunction[FailMessage, FailMessage] = {
+    case fm @ FailMessage(ValidationWarning, _, _, _) => fm
+  }
+
+  def isError : PartialFunction[FailMessage, FailMessage] = {
+    case fm @ FailMessage(ValidationError, _, _, _) => fm
+  }
+
+  def isSchemaDefinitionError : PartialFunction[FailMessage, FailMessage] = {
+    case fm @ FailMessage(SchemaDefinitionError, _, _, _) => fm
+  }
+}
 
 case class ProgressFor(rowsToValidate: Int, progress: ProgressCallback)
 
@@ -88,16 +104,16 @@ trait MetaDataValidator {
         val maybeNoData =
           if (schema.globalDirectives.contains(NoHeader())) {
             if (!rowIt.hasNext && !schema.globalDirectives.contains(PermitEmpty())) {
-              Some(ErrorMessage("metadata file is empty but this has not been permitted").failNel[Any])
+              Some(FailMessage(ValidationError, "metadata file is empty but this has not been permitted").failureNel[Any])
             } else {
               None
             }
           } else {
             if(!rowIt.hasNext) {
-              Some(ErrorMessage("metadata file is empty but should contain at least a header").failNel[Any])
+              Some(FailMessage(ValidationError, "metadata file is empty but should contain at least a header").failureNel[Any])
             } else {
               if(!rowIt.hasNext && !schema.globalDirectives.contains(PermitEmpty())) {
-                Some(ErrorMessage("metadata file has a header but no data and this has not been permitted").failNel[Any])
+                Some(FailMessage(ValidationError, "metadata file has a header but no data and this has not been permitted").failureNel[Any])
               } else {
                 None
               }
@@ -143,19 +159,19 @@ trait MetaDataValidator {
         val maybeNoData =
           if (schema.globalDirectives.contains(NoHeader())) {
             if (!rowIt.hasNext && !schema.globalDirectives.contains(PermitEmpty())) {
-              Some(ErrorMessage("metadata file is empty but this has not been permitted").failureNel[Any])
+              Some(FailMessage(ValidationError, "metadata file is empty but this has not been permitted").failureNel[Any])
             } else {
               None
             }
           } else {
             if(!rowIt.hasNext) {
-              Some(ErrorMessage("metadata file is empty but should contain at least a header").failureNel[Any])
+              Some(FailMessage(ValidationError, "metadata file is empty but should contain at least a header").failureNel[Any])
             } else {
               val header = rowIt.skipHeader()
               val headerValidation = validateHeader(header, schema)
-              headerValidation.orElse{
+              headerValidation.orElse {
                 if(!rowIt.hasNext && !schema.globalDirectives.contains(PermitEmpty())) {
-                  Some(ErrorMessage("metadata file has a header but no data and this has not been permitted").failureNel[Any])
+                  Some(FailMessage(ValidationError, "metadata file has a header but no data and this has not been permitted").failureNel[Any])
                 } else {
                   None
                 }
@@ -175,9 +191,9 @@ trait MetaDataValidator {
         metadataValidation
 
       case Left(ts) =>
-        //TODO emit all errors not just first!
-        ErrorMessage(ts(0).toString).failureNel[Any]
-      //ts.toList.map(t => ErrorMessage(t.toString).failureNel[Any]).sequence[MetaDataValidation, Any]
+        //TODO(AR) emit all errors not just first!
+        FailMessage(ValidationError, ts(0).toString).failureNel[Any]
+//      ts.toList.map(t => FailMessage(ValidationError, t.toString).failureNel[Any]).sequence[MetaDataValidation, Any]
     }
   }
 
@@ -211,7 +227,7 @@ trait MetaDataValidator {
     if (headerList.sameElements(schemaHeader))
       None
     else
-      Some(ErrorMessage(s"Metadata header, cannot find the column headers - ${Util.diff(schemaHeader.toSet, headerList.toSet).mkString(", ")} - .${if (icnc.isEmpty) "  (Case sensitive)" else ""}").failNel[Any])
+      Some(FailMessage(ValidationError, s"Metadata header, cannot find the column headers - ${Util.diff(schemaHeader.toSet, headerList.toSet).mkString(", ")} - .${if (icnc.isEmpty) "  (Case sensitive)" else ""}").failureNel[Any])
   }
 
   def validateRow(row: Row,  schema: Schema, mayBeLast: Option[Boolean] = None): MetaDataValidation[Any] = {
@@ -236,7 +252,7 @@ trait MetaDataValidator {
       case None => true.successNel
       case Some(nel) => {
         val ret = nel.reverse.map {
-          case (offset, message) => ErrorMessage(s"[UTF-8 Error][@$offset] ${message}")
+          case (offset, message) => FailMessage(ValidationError, s"[UTF-8 Error][@$offset] ${message}")
         }
         ret.failure
       }
@@ -249,20 +265,20 @@ trait MetaDataValidator {
     }
 
     if (tc.isEmpty || tc.get.numberOfColumns == row.cells.length) true.successNel[FailMessage]
-    else ErrorMessage(s"Expected @totalColumns of ${tc.get.numberOfColumns} and found ${row.cells.length} on line ${row.lineNumber}", Some(row.lineNumber), Some(row.cells.length)).failureNel[Any]
+    else FailMessage(ValidationError, s"Expected @totalColumns of ${tc.get.numberOfColumns} and found ${row.cells.length} on line ${row.lineNumber}", Some(row.lineNumber), Some(row.cells.length)).failureNel[Any]
   }
 
   protected def rules(row: Row, schema: Schema, mayBeLast: Option[Boolean] = None): MetaDataValidation[List[Any]]
 
   protected def validateCell(columnIndex: Int, cells: (Int) => Option[Cell], row: Row, schema: Schema, mayBeLast: Option[Boolean] = None): MetaDataValidation[Any] = {
     cells(columnIndex) match {
       case Some(c) => rulesForCell(columnIndex, row, schema, mayBeLast)
-      case _ => ErrorMessage(s"Missing value at line: ${row.lineNumber}, column: ${schema.columnDefinitions(columnIndex).id}", Some(row.lineNumber), Some(columnIndex)).failureNel[Any]
+      case _ => FailMessage(ValidationError, s"Missing value at line: ${row.lineNumber}, column: ${schema.columnDefinitions(columnIndex).id}", Some(row.lineNumber), Some(columnIndex)).failureNel[Any]
     }
   }
 
-  protected def toWarnings(results: Rule#RuleValidation[Any], lineNumber: Int, columnIndex: Int): MetaDataValidation[Any] = results.leftMap(_.map(WarningMessage(_, Some(lineNumber), Some(columnIndex))))
-  protected def toErrors(results: Rule#RuleValidation[Any], lineNumber: Int, columnIndex: Int): MetaDataValidation[Any] = results.leftMap(_.map(ErrorMessage(_, Some(lineNumber), Some(columnIndex))))
+  protected def toWarnings(results: Rule#RuleValidation[Any], lineNumber: Int, columnIndex: Int): MetaDataValidation[Any] = results.leftMap(_.map(FailMessage(ValidationWarning, _, Some(lineNumber), Some(columnIndex))))
+  protected def toErrors(results: Rule#RuleValidation[Any], lineNumber: Int, columnIndex: Int): MetaDataValidation[Any] = results.leftMap(_.map(FailMessage(ValidationError, _, Some(lineNumber), Some(columnIndex))))
 
   protected def rulesForCell(columnIndex: Int, row: Row, schema: Schema, mayBeLast: Option[Boolean] = None): MetaDataValidation[Any]
 

csv-validator-core/src/main/scala/uk/gov/nationalarchives/csv/validator/Util.scala

@@ -26,9 +26,9 @@ object Util {
 
   def checkFilesReadable(files: List[Path]) = files.map(fileReadable).sequence[AppValidation, FailMessage]
 
-  def fileReadable(file: Path): AppValidation[FailMessage] = if (file.exists && file.canRead) SchemaMessage(file.path).successNel[FailMessage] else fileNotReadableMessage(file).failureNel[FailMessage]
+  def fileReadable(file: Path): AppValidation[FailMessage] = if (file.exists && file.canRead) FailMessage(SchemaDefinitionError, file.path).successNel[FailMessage] else fileNotReadableMessage(file).failureNel[FailMessage]
 
-  def fileNotReadableMessage(file: Path) = SchemaMessage("Unable to read file : " + file.path)
+  def fileNotReadableMessage(file: Path) = FailMessage(SchemaDefinitionError, "Unable to read file : " + file.path)
 
   /**
     * Check if the list l1 contain all element in l2

csv-validator-core/src/main/scala/uk/gov/nationalarchives/csv/validator/schema/SchemaParser.scala

@@ -18,13 +18,14 @@ import java.io.Reader
 import scalaz._
 import Scalaz._
 
-import uk.gov.nationalarchives.csv.validator.{SchemaMessage, FailMessage}
+import uk.gov.nationalarchives.csv.validator.{SchemaDefinitionError, FailMessage}
 
 /**
   * CSV Schema Parser
   *
   * Uses Scala Parser Combinators to parse the CSV Schema language defined in
   * the specification document
+  *
   * @see http://digital-preservation.github.io/csv-validator/csv-schema-1.0.html
   */
 trait SchemaParser extends RegexParsers
@@ -122,9 +123,9 @@ with TraceableParsers {
     parse(reader) match {
       case s @ Success(schema: Schema, next) => {
         val errors = SchemaValidator.validate(schema)
-        if (errors.isEmpty) schema.successNel[FailMessage] else SchemaMessage(errors).failureNel[Schema]
+        if (errors.isEmpty) schema.successNel[FailMessage] else FailMessage(SchemaDefinitionError, errors).failureNel[Schema]
       }
-      case n: NoSuccess => SchemaMessage(formatNoSuccessMessageForPlatform(n.toString)).failureNel[Schema]
+      case n: NoSuccess => FailMessage(SchemaDefinitionError, formatNoSuccessMessageForPlatform(n.toString)).failureNel[Schema]
     }
   }