Merge pull request #81 from entur/cleanup

Cleanup

Author: testower

README.md

@@ -6,6 +6,47 @@ Validate GBFS feeds. Intended as Java native alternative to https://github.com/M
 
 Uses the official json schema to validate files.
 
+## Usage
+
+Create an instance of `GbfsValidator`:
+
+    GbfsValidator gbfsValidator = GbfsValidatorFactory.getGbfsJsonValidator();
+
+The `GbfsValidator` interface has two methods:
+
+### Validate a set of GBFS Files
+
+Validate a set of GBFS files by providing a map of InputStreams, keyed by filename. 
+The input streams maybe come from an HTTP response or from files. This validation
+method will apply custom rules (see below), by dynamically patching the static JSON
+schemas using data from the files themselves.
+
+    gbfsValidator.validate(
+      Map.of(
+        "gbfs", gbfsInputStream,
+        "system_information", systemInformationInputStream
+        ...
+      )
+    );
+
+
+### Validate a single GBFS file
+
+Validate a single GBFS file by providing a filename and an InputStream. This validation
+method will not apply any custom rules, but will validate only using the static JSON
+schemas.
+
+
+    gbfsValidator.validate(
+      "system_information", systemInformationInputStream
+    ); 
+
+### Using the validation results
+
+The validation methods above will return the `ValidationResult` record. This will contain a summary of the
+validation process, as well as a map of validation results per file. See javadocs in `model` for details.
+
+
 ## Additional validation rules
 
 The interface `CustomRuleSchemaPatcher` enables adding additional rules dynamically by schema patching:

pom.xml

@@ -4,7 +4,7 @@
 
     <groupId>org.entur.gbfs</groupId>
     <artifactId>gbfs-validator-java</artifactId>
-    <version>1.1.4-SNAPSHOT</version>
+    <version>2.0.0-SNAPSHOT</version>
 
     <name>gbfs-validator-java</name>
     <description>Validate GBFS feeds</description>

src/main/java/org/entur/gbfs/validation/GbfsValidator.java

@@ -24,7 +24,25 @@
 import java.io.InputStream;
 import java.util.Map;
 
+/**
+ * Represents a validator of GBFS files
+ */
 public interface GbfsValidator {
+
+    /**
+     * Validate all files in the map of GBFS files, keyed by the name of the file. Will validate using
+     * custom rules in addition to the static schema
+     * @param fileMap
+     * @return
+     */
     ValidationResult validate(Map<String, InputStream> fileMap);
+
+    /**
+     * Validate the GBFS file with the given name and the file itself as an InputStream. Will not apply
+     * custom rules, but only validate using the static schema
+     * @param fileName
+     * @param file
+     * @return
+     */
     FileValidationResult validateFile(String fileName, InputStream file);
 }

src/main/java/org/entur/gbfs/validation/GbfsValidatorFactory.java

@@ -20,9 +20,15 @@
 
 import org.entur.gbfs.validation.validator.GbfsJsonValidator;
 
+/**
+ * Main library entrypoint
+ */
 public class GbfsValidatorFactory {
     private GbfsValidatorFactory() {}
 
+    /**
+     * Get a GbfsValidator instance
+     */
     public static GbfsValidator getGbfsJsonValidator() {
         return new GbfsJsonValidator();
     }

src/main/java/org/entur/gbfs/validation/model/FileValidationError.java

@@ -20,34 +20,17 @@
 
 import java.util.Objects;
 
-public class FileValidationError implements ValidationResultComponentIdentity<FileValidationError> {
-    private String schemaPath;
-    private String violationPath;
-    private String message;
-
-    public String getSchemaPath() {
-        return schemaPath;
-    }
-
-    public void setSchemaPath(String schemaPath) {
-        this.schemaPath = schemaPath;
-    }
-
-    public String getViolationPath() {
-        return violationPath;
-    }
-
-    public void setViolationPath(String violationPath) {
-        this.violationPath = violationPath;
-    }
-
-    public String getMessage() {
-        return message;
-    }
-
-    public void setMessage(String message) {
-        this.message = message;
-    }
+/**
+ * Representing a single validation error in a GBFS file
+ * @param schemaPath The path in the schema that was violated
+ * @param violationPath The path in the file containing the error
+ * @param message An error message
+ */
+public record FileValidationError(
+        String schemaPath,
+        String violationPath,
+        String message
+) implements ValidationResultComponentIdentity<FileValidationError>  {
 
     @Override
     public String toString() {

src/main/java/org/entur/gbfs/validation/model/FileValidationResult.java

@@ -18,84 +18,31 @@
 
 package org.entur.gbfs.validation.model;
 
-import java.util.Collections;
 import java.util.List;
 import java.util.Objects;
 import java.util.stream.IntStream;
 
-public class FileValidationResult implements ValidationResultComponentIdentity<FileValidationResult> {
-    private String file;
-    private boolean required;
-    private boolean exists;
-    private int errorsCount;
-    private String schema;
-    private String fileContents;
-    private String version;
-    private List<FileValidationError> errors = Collections.emptyList();
-
-    public String getFile() {
-        return file;
-    }
-
-    public void setFile(String file) {
-        this.file = file;
-    }
-
-    public boolean isRequired() {
-        return required;
-    }
-
-    public void setRequired(boolean required) {
-        this.required = required;
-    }
-
-    public boolean isExists() {
-        return exists;
-    }
-
-    public void setExists(boolean exists) {
-        this.exists = exists;
-    }
-
-    public int getErrorsCount() {
-        return errorsCount;
-    }
-
-    public void setErrorsCount(int errorsCount) {
-        this.errorsCount = errorsCount;
-    }
-
-    public String getSchema() {
-        return schema;
-    }
-
-    public void setSchema(String schema) {
-        this.schema = schema;
-    }
-
-    public String getFileContents() {
-        return fileContents;
-    }
-
-    public void setFileContents(String fileContents) {
-        this.fileContents = fileContents;
-    }
-
-    public String getVersion() {
-        return version;
-    }
-
-    public void setVersion(String version) {
-        this.version = version;
-    }
-
-    public List<FileValidationError> getErrors() {
-        return errors;
-    }
-
-    public void setErrors(List<FileValidationError> errors) {
-        this.errors = errors;
-    }
+/**
+ * The result of validating a single GBFS file
+ * @param file The name of the file that was validated
+ * @param required Whether the file is required in the given version of GBFS
+ * @param exists Whether the file existed in the validation input
+ * @param errorsCount The number of errors found while validating the file
+ * @param schema The schema used to validate the file
+ * @param fileContents The contents of the file
+ * @param version The version of the file
+ * @param errors A list of errors encountered while validating the file
+ */
+public record FileValidationResult(
+        String file,
+         boolean required,
+         boolean exists,
+         int errorsCount,
+         String schema,
+         String fileContents,
+         String version,
+         List<FileValidationError> errors
+) implements ValidationResultComponentIdentity<FileValidationResult> {
 
     @Override
     public String toString() {

src/main/java/org/entur/gbfs/validation/model/ValidationResult.java

@@ -18,29 +18,17 @@
 
 package org.entur.gbfs.validation.model;
 
-import java.util.HashMap;
 import java.util.Map;
 
-public class ValidationResult implements ValidationResultComponentIdentity<ValidationResult> {
-    private ValidationSummary summary = new ValidationSummary();
-    private Map<String, FileValidationResult> files = new HashMap<>();
-
-    public ValidationSummary getSummary() {
-        return summary;
-    }
-
-    public void setSummary(ValidationSummary summary) {
-        this.summary = summary;
-    }
-
-    public Map<String, FileValidationResult> getFiles() {
-        return files;
-    }
-
-    public void setFiles(Map<String, FileValidationResult> files) {
-        this.files = files;
-    }
-
+/**
+ * This record contains the result of validating a set of GBFS files
+ * @param summary A summary of the validation
+ * @param files A map of files that were validated
+ */
+public record ValidationResult(
+     ValidationSummary summary,
+     Map<String, FileValidationResult> files
+) implements ValidationResultComponentIdentity<ValidationResult> {
     @Override
     public String toString() {
         return "ValidationResult{" +
@@ -52,7 +40,7 @@ public String toString() {
     @Override
     public boolean sameAs(ValidationResult other) {
         if (other == null) return false;
-        if (!summary.sameAs(other.getSummary())) return false;
+        if (!summary.sameAs(other.summary())) return false;
         return files.entrySet().stream().allMatch(entry -> other.files.get(entry.getKey()).sameAs(entry.getValue()));
     }
 }

src/main/java/org/entur/gbfs/validation/model/ValidationSummary.java

@@ -20,34 +20,17 @@
 
 import java.util.Objects;
 
-public class ValidationSummary implements ValidationResultComponentIdentity<ValidationSummary> {
-    private String version;
-    private long timestamp;
-    private int errorsCount;
-
-    public String getVersion() {
-        return version;
-    }
-
-    public void setVersion(String version) {
-        this.version = version;
-    }
-
-    public long getTimestamp() {
-        return timestamp;
-    }
-
-    public void setTimestamp(long timestamp) {
-        this.timestamp = timestamp;
-    }
-
-    public int getErrorsCount() {
-        return errorsCount;
-    }
-
-    public void setErrorsCount(int errorsCount) {
-        this.errorsCount = errorsCount;
-    }
+/**
+ * A summary of the validation of a set of GBFS files
+ * @param version The version the files were validated against
+ * @param timestamp The time when validation was performed
+ * @param errorsCount The total amount of errors encountered during validation
+ */
+public record ValidationSummary(
+         String version,
+         long timestamp,
+         int errorsCount
+) implements ValidationResultComponentIdentity<ValidationSummary> {
 
     @Override
     public String toString() {