Do a clean separation between data class used in export/import feature.

jarkkoka · jarkkoka · commit 89395875ab22 · 2023-11-15T15:41:14.000+02:00
diff --git a/src/main/kotlin/fi/hsl/jore4/hastus/data/hastus/IHastusData.kt b/src/main/kotlin/fi/hsl/jore4/hastus/data/hastus/IHastusData.kt
diff --git a/src/main/kotlin/fi/hsl/jore4/hastus/data/hastus/exp/IExportableItem.kt b/src/main/kotlin/fi/hsl/jore4/hastus/data/hastus/exp/IExportableItem.kt
@@ -0,0 +1,13 @@
+package fi.hsl.jore4.hastus.data.hastus.exp
+
+/**
+ * Hastus data interface which represents a line of CSV data to be exported to Hastus.
+ */
+sealed interface IExportableItem {
+    /**
+     * Get the data fields of the data, can be string or number
+     *
+     * @return
+     */
+    fun getFields(): List<Any>
+}
diff --git a/src/main/kotlin/fi/hsl/jore4/hastus/data/hastus/exp/Place.kt b/src/main/kotlin/fi/hsl/jore4/hastus/data/hastus/exp/Place.kt
@@ -1,4 +1,4 @@
-package fi.hsl.jore4.hastus.data.hastus
+package fi.hsl.jore4.hastus.data.hastus.exp
 
 /**
  * Represents a Hastus Place element
@@ -10,7 +10,7 @@ package fi.hsl.jore4.hastus.data.hastus
 data class Place(
     val identifier: String,
     val description: String
-) : HastusData() {
+) : IExportableItem {
 
     override fun getFields(): List<Any> = listOf(identifier, description)
 }
diff --git a/src/main/kotlin/fi/hsl/jore4/hastus/data/hastus/exp/Route.kt b/src/main/kotlin/fi/hsl/jore4/hastus/data/hastus/exp/Route.kt
@@ -1,4 +1,4 @@
-package fi.hsl.jore4.hastus.data.hastus
+package fi.hsl.jore4.hastus.data.hastus.exp
 
 /**
  * A Route Hastus element, represents a Jore4 Line
@@ -16,7 +16,7 @@ data class Route(
     val serviceType: Int = 0,
     val direction: Int = 0,
     val serviceMode: Int
-) : HastusData() {
+) : IExportableItem {
 
     override fun getFields(): List<Any> = listOf(identifier, description, serviceType, direction, serviceMode)
 }
diff --git a/src/main/kotlin/fi/hsl/jore4/hastus/data/hastus/exp/RouteVariant.kt b/src/main/kotlin/fi/hsl/jore4/hastus/data/hastus/exp/RouteVariant.kt
@@ -1,4 +1,4 @@
-package fi.hsl.jore4.hastus.data.hastus
+package fi.hsl.jore4.hastus.data.hastus.exp
 
 /**
  * A Route variant Hastus element, represents a Jore4 route
@@ -18,7 +18,7 @@ data class RouteVariant(
     val reversible: Boolean = false,
     val routeIdAndVariantId: String,
     val routeId: String
-) : HastusData() {
+) : IExportableItem {
 
     override fun getFields(): List<Any> =
         listOf(identifier, description, direction, reversible, routeIdAndVariantId, routeId)
diff --git a/src/main/kotlin/fi/hsl/jore4/hastus/data/hastus/exp/RouteVariantPoint.kt b/src/main/kotlin/fi/hsl/jore4/hastus/data/hastus/exp/RouteVariantPoint.kt
@@ -1,4 +1,4 @@
-package fi.hsl.jore4.hastus.data.hastus
+package fi.hsl.jore4.hastus.data.hastus.exp
 
 import fi.hsl.jore4.hastus.data.format.NumberWithAccuracy
 
@@ -23,7 +23,7 @@ data class RouteVariantPoint(
     val regulatedTp: Boolean,
     val stopLabel: String,
     val routeIdAndVariantId: String
-) : HastusData() {
+) : IExportableItem {
 
     init {
         if (isTimingPoint) {
diff --git a/src/main/kotlin/fi/hsl/jore4/hastus/data/hastus/exp/Stop.kt b/src/main/kotlin/fi/hsl/jore4/hastus/data/hastus/exp/Stop.kt
@@ -1,4 +1,4 @@
-package fi.hsl.jore4.hastus.data.hastus
+package fi.hsl.jore4.hastus.data.hastus.exp
 
 import fi.hsl.jore4.hastus.data.format.NumberWithAccuracy
 
@@ -28,7 +28,7 @@ data class Stop(
     val gpsX: NumberWithAccuracy,
     val gpsY: NumberWithAccuracy,
     val shortIdentifier: String
-) : HastusData() {
+) : IExportableItem {
 
     override fun getFields(): List<Any> = listOf(
         identifier,
diff --git a/src/main/kotlin/fi/hsl/jore4/hastus/data/hastus/exp/StopDistance.kt b/src/main/kotlin/fi/hsl/jore4/hastus/data/hastus/exp/StopDistance.kt
@@ -1,4 +1,4 @@
-package fi.hsl.jore4.hastus.data.hastus
+package fi.hsl.jore4.hastus.data.hastus.exp
 
 /**
  * Stop distance Hastus element. Distances between stops.
@@ -14,7 +14,7 @@ data class StopDistance(
     val stopEnd: String,
     val baseInService: Boolean = true,
     val editedDistance: Int
-) : HastusData() {
+) : IExportableItem {
 
     override fun getFields(): List<Any> = listOf(
         stopStart,
diff --git a/src/main/kotlin/fi/hsl/jore4/hastus/data/hastus/imp/ApplicationRecord.kt b/src/main/kotlin/fi/hsl/jore4/hastus/data/hastus/imp/ApplicationRecord.kt
@@ -1,4 +1,4 @@
-package fi.hsl.jore4.hastus.data.hastus
+package fi.hsl.jore4.hastus.data.hastus.imp
 
 import java.time.LocalDate
 import java.time.LocalTime
@@ -19,7 +19,7 @@ data class ApplicationRecord(
     val vscVersion: Number,
     val jobDate: LocalDate,
     val jobTime: LocalTime
-) : HastusData() {
+) : ImportableItem() {
 
     constructor(elements: List<String>) : this(
         hastus = elements[1],
@@ -28,6 +28,4 @@ data class ApplicationRecord(
         jobDate = LocalDate.parse(elements[4], dateFormatter()),
         jobTime = LocalTime.parse(elements[5].substring(0, 6), timeFormatter())
     )
-
-    override fun getFields(): List<Any> = emptyList()
 }
diff --git a/src/main/kotlin/fi/hsl/jore4/hastus/data/hastus/imp/BlockRecord.kt b/src/main/kotlin/fi/hsl/jore4/hastus/data/hastus/imp/BlockRecord.kt
@@ -1,4 +1,4 @@
-package fi.hsl.jore4.hastus.data.hastus
+package fi.hsl.jore4.hastus.data.hastus.imp
 
 /**
  * Block record
@@ -24,7 +24,7 @@ data class BlockRecord(
     val prepOutTime: Int,
     val prepInTime: Int,
     val vehicleType: Int
-) : HastusData() {
+) : ImportableItem() {
 
     constructor(elements: List<String>) : this(
         internalNumber = elements[1],
@@ -37,6 +37,4 @@ data class BlockRecord(
         prepInTime = parseToInt(elements[8]),
         vehicleType = parseToInt(elements[9])
     )
-
-    override fun getFields(): List<Any> = emptyList()
 }
diff --git a/src/main/kotlin/fi/hsl/jore4/hastus/data/hastus/imp/BookingRecord.kt b/src/main/kotlin/fi/hsl/jore4/hastus/data/hastus/imp/BookingRecord.kt
@@ -1,4 +1,4 @@
-package fi.hsl.jore4.hastus.data.hastus
+package fi.hsl.jore4.hastus.data.hastus.imp
 
 import java.time.LocalDate
 
@@ -22,7 +22,7 @@ data class BookingRecord(
     val startDate: LocalDate,
     val endDate: LocalDate,
     val contract: String
-) : HastusData() {
+) : ImportableItem() {
 
     constructor(elements: List<String>) : this(
         booking = elements[1],
@@ -33,6 +33,4 @@ data class BookingRecord(
         endDate = LocalDate.parse(elements[6], dateFormatter()),
         contract = elements[7]
     )
-
-    override fun getFields(): List<Any> = emptyList()
 }
diff --git a/src/main/kotlin/fi/hsl/jore4/hastus/data/hastus/imp/ImportableItem.kt b/src/main/kotlin/fi/hsl/jore4/hastus/data/hastus/imp/ImportableItem.kt
@@ -1,10 +1,12 @@
-package fi.hsl.jore4.hastus.data.hastus
+package fi.hsl.jore4.hastus.data.hastus.imp
 
 import fi.hsl.jore4.hastus.Constants
 import java.time.format.DateTimeFormatter
 
-sealed class HastusData : IHastusData {
-
+/**
+ * Hastus data class which represents a line of CSV data to be imported from Hastus.
+ */
+sealed class ImportableItem {
     companion object {
         private val DATE_FORMATTER: DateTimeFormatter =
             DateTimeFormatter.ofPattern(Constants.DEFAULT_HASTUS_DATE_FORMAT)
diff --git a/src/main/kotlin/fi/hsl/jore4/hastus/data/hastus/imp/TripRecord.kt b/src/main/kotlin/fi/hsl/jore4/hastus/data/hastus/imp/TripRecord.kt
@@ -1,4 +1,4 @@
-package fi.hsl.jore4.hastus.data.hastus
+package fi.hsl.jore4.hastus.data.hastus.imp
 
 /**
  * Trip record
@@ -50,7 +50,7 @@ data class TripRecord(
     val isVehicleTypeMandatory: Boolean,
     val isBackupTrip: Boolean,
     val isExtraTrip: Boolean
-) : HastusData() {
+) : ImportableItem() {
 
     constructor(elements: List<String>) : this(
         contract = elements[1],
@@ -76,6 +76,4 @@ data class TripRecord(
         isBackupTrip = parseToBoolean(elements[21]),
         isExtraTrip = parseToBoolean(elements[22])
     )
-
-    override fun getFields(): List<Any> = emptyList()
 }
diff --git a/src/main/kotlin/fi/hsl/jore4/hastus/data/hastus/imp/TripStopRecord.kt b/src/main/kotlin/fi/hsl/jore4/hastus/data/hastus/imp/TripStopRecord.kt
@@ -1,4 +1,4 @@
-package fi.hsl.jore4.hastus.data.hastus
+package fi.hsl.jore4.hastus.data.hastus.imp
 
 /**
  * Hastus trip stop record
@@ -32,7 +32,7 @@ data class TripStopRecord(
     val distanceFromPreviousStop: Double?,
     val stopType: String,
     val note: String
-) : HastusData() {
+) : ImportableItem() {
 
     val isUsedAsTimingPoint: Boolean
         get() = stopType == "T" || stopType == "R"
@@ -55,6 +55,4 @@ data class TripStopRecord(
         stopType = elements[10],
         note = elements[11]
     )
-
-    override fun getFields(): List<Any> = emptyList()
 }
diff --git a/src/main/kotlin/fi/hsl/jore4/hastus/data/hastus/imp/VehicleScheduleRecord.kt b/src/main/kotlin/fi/hsl/jore4/hastus/data/hastus/imp/VehicleScheduleRecord.kt
@@ -1,4 +1,4 @@
-package fi.hsl.jore4.hastus.data.hastus
+package fi.hsl.jore4.hastus.data.hastus.imp
 
 import java.time.LocalDate
 import java.time.LocalTime
@@ -25,7 +25,7 @@ data class VehicleScheduleRecord(
     val endDate: LocalDate,
     val editDate: LocalDate,
     val editTime: LocalTime
-) : HastusData() {
+) : ImportableItem() {
 
     constructor(elements: List<String>) : this(
         name = elements[1],
@@ -37,6 +37,4 @@ data class VehicleScheduleRecord(
         editDate = LocalDate.parse(elements[7], dateFormatter()),
         editTime = LocalTime.parse(elements[8], timeFormatter())
     )
-
-    override fun getFields(): List<Any> = emptyList()
 }
diff --git a/src/main/kotlin/fi/hsl/jore4/hastus/service/exporting/ConversionsToHastus.kt b/src/main/kotlin/fi/hsl/jore4/hastus/service/exporting/ConversionsToHastus.kt
@@ -6,13 +6,13 @@ import fi.hsl.jore4.hastus.Constants.MAX_LENGTH_HASTUS_STOP_NAME
 import fi.hsl.jore4.hastus.Constants.MAX_LENGTH_HASTUS_STOP_STREET_NAME
 import fi.hsl.jore4.hastus.data.format.JoreRouteDirection
 import fi.hsl.jore4.hastus.data.format.NumberWithAccuracy
-import fi.hsl.jore4.hastus.data.hastus.IHastusData
-import fi.hsl.jore4.hastus.data.hastus.Place
-import fi.hsl.jore4.hastus.data.hastus.Route
-import fi.hsl.jore4.hastus.data.hastus.RouteVariant
-import fi.hsl.jore4.hastus.data.hastus.RouteVariantPoint
-import fi.hsl.jore4.hastus.data.hastus.Stop
-import fi.hsl.jore4.hastus.data.hastus.StopDistance
+import fi.hsl.jore4.hastus.data.hastus.exp.IExportableItem
+import fi.hsl.jore4.hastus.data.hastus.exp.Place
+import fi.hsl.jore4.hastus.data.hastus.exp.Route
+import fi.hsl.jore4.hastus.data.hastus.exp.RouteVariant
+import fi.hsl.jore4.hastus.data.hastus.exp.RouteVariantPoint
+import fi.hsl.jore4.hastus.data.hastus.exp.Stop
+import fi.hsl.jore4.hastus.data.hastus.exp.StopDistance
 import fi.hsl.jore4.hastus.data.jore.JoreDistanceBetweenTwoStopPoints
 import fi.hsl.jore4.hastus.data.jore.JoreLine
 import fi.hsl.jore4.hastus.data.jore.JoreRoute
@@ -22,7 +22,7 @@ import fi.hsl.jore4.hastus.data.jore.JoreTimingPlace
 
 object ConversionsToHastus {
 
-    fun convertJoreLinesToHastus(lines: List<JoreLine>): List<IHastusData> = lines.flatMap { joreLine ->
+    fun convertJoreLinesToHastus(lines: List<JoreLine>): List<IExportableItem> = lines.flatMap { joreLine ->
         listOf(
             convertJoreLineToHastus(joreLine)
         ).plus(
@@ -46,7 +46,7 @@ object ConversionsToHastus {
     private fun convertJoreRoutesToHastusRouteVariants(
         joreRoutes: List<JoreRoute>,
         joreLineLabel: String
-    ): List<IHastusData> {
+    ): List<IExportableItem> {
         return joreRoutes.flatMap { joreRoute ->
             val hastusRouteVariant = convertJoreRouteToHastusRouteVariant(joreRoute, joreLineLabel)
 
diff --git a/src/main/kotlin/fi/hsl/jore4/hastus/service/exporting/ExportService.kt b/src/main/kotlin/fi/hsl/jore4/hastus/service/exporting/ExportService.kt
@@ -1,6 +1,6 @@
 package fi.hsl.jore4.hastus.service.exporting
 
-import fi.hsl.jore4.hastus.data.hastus.IHastusData
+import fi.hsl.jore4.hastus.data.hastus.exp.IExportableItem
 import fi.hsl.jore4.hastus.data.jore.JoreDistanceBetweenTwoStopPoints
 import fi.hsl.jore4.hastus.data.jore.JoreJourneyPatternRef
 import fi.hsl.jore4.hastus.data.jore.JoreLine
@@ -59,7 +59,7 @@ class ExportService(
         // validate lines
         lines.forEach { lineValidator.validateLine(it) }
 
-        val hastusData: List<IHastusData> =
+        val hastusData: List<IExportableItem> =
             ConversionsToHastus.convertJoreLinesToHastus(lines) +
                 ConversionsToHastus.convertJoreStopPointsToHastus(stopPoints) +
                 ConversionsToHastus.convertJoreTimingPlacesToHastus(timingPlaces) +
diff --git a/src/main/kotlin/fi/hsl/jore4/hastus/service/importing/ConversionsFromHastus.kt b/src/main/kotlin/fi/hsl/jore4/hastus/service/importing/ConversionsFromHastus.kt
@@ -3,12 +3,12 @@ package fi.hsl.jore4.hastus.service.importing
 import fi.hsl.jore4.hastus.data.format.JoreJourneyType
 import fi.hsl.jore4.hastus.data.format.JoreRouteDirection
 import fi.hsl.jore4.hastus.data.format.RouteLabelAndDirection
-import fi.hsl.jore4.hastus.data.hastus.BlockRecord
-import fi.hsl.jore4.hastus.data.hastus.BookingRecord
-import fi.hsl.jore4.hastus.data.hastus.IHastusData
-import fi.hsl.jore4.hastus.data.hastus.TripRecord
-import fi.hsl.jore4.hastus.data.hastus.TripStopRecord
-import fi.hsl.jore4.hastus.data.hastus.VehicleScheduleRecord
+import fi.hsl.jore4.hastus.data.hastus.imp.BlockRecord
+import fi.hsl.jore4.hastus.data.hastus.imp.BookingRecord
+import fi.hsl.jore4.hastus.data.hastus.imp.ImportableItem
+import fi.hsl.jore4.hastus.data.hastus.imp.TripRecord
+import fi.hsl.jore4.hastus.data.hastus.imp.TripStopRecord
+import fi.hsl.jore4.hastus.data.hastus.imp.VehicleScheduleRecord
 import fi.hsl.jore4.hastus.data.jore.JoreBlock
 import fi.hsl.jore4.hastus.data.jore.JoreJourneyPatternRef
 import fi.hsl.jore4.hastus.data.jore.JoreJourneyPatternStopRef
@@ -29,7 +29,7 @@ object ConversionsFromHastus {
     private val LOGGER = KotlinLogging.logger {}
 
     fun convertHastusDataToJore(
-        hastusData: List<IHastusData>,
+        hastusData: List<ImportableItem>,
         vehicleTypeIndex: Map<Int, UUID>,
         dayTypeIndex: Map<String, UUID>,
         journeyPatternRefIndex: Map<RouteLabelAndDirection, JoreJourneyPatternRef>
diff --git a/src/main/kotlin/fi/hsl/jore4/hastus/service/importing/ImportService.kt b/src/main/kotlin/fi/hsl/jore4/hastus/service/importing/ImportService.kt
@@ -1,10 +1,10 @@
 package fi.hsl.jore4.hastus.service.importing
 
 import fi.hsl.jore4.hastus.data.format.RouteLabelAndDirection
-import fi.hsl.jore4.hastus.data.hastus.BookingRecord
-import fi.hsl.jore4.hastus.data.hastus.IHastusData
-import fi.hsl.jore4.hastus.data.hastus.TripRecord
-import fi.hsl.jore4.hastus.data.hastus.TripStopRecord
+import fi.hsl.jore4.hastus.data.hastus.imp.BookingRecord
+import fi.hsl.jore4.hastus.data.hastus.imp.ImportableItem
+import fi.hsl.jore4.hastus.data.hastus.imp.TripRecord
+import fi.hsl.jore4.hastus.data.hastus.imp.TripStopRecord
 import fi.hsl.jore4.hastus.data.jore.JoreJourneyPatternRef
 import fi.hsl.jore4.hastus.data.jore.JoreVehicleScheduleFrame
 import fi.hsl.jore4.hastus.graphql.GraphQLService
@@ -24,7 +24,7 @@ class ImportService(private val graphQLServiceFactory: GraphQLServiceFactory) {
         csv: String,
         hasuraHeaders: Map<String, String>
     ): UUID? {
-        val hastusItems: List<IHastusData> = getHastusDataItems(csv)
+        val hastusItems: List<ImportableItem> = getHastusDataItems(csv)
         val graphQLService: GraphQLService = graphQLServiceFactory.createForSession(hasuraHeaders)
 
         val hastusBookingRecord: BookingRecord = hastusItems.filterIsInstance<BookingRecord>().first()
@@ -63,7 +63,7 @@ class ImportService(private val graphQLServiceFactory: GraphQLServiceFactory) {
         return graphQLService.persistVehicleScheduleFrame(vehicleScheduleFrame, selectedJourneyPatternRefs)
     }
 
-    private fun getHastusDataItems(csv: String): List<IHastusData> = filterOutDeadRunItems(READER.parseCsv(csv))
+    private fun getHastusDataItems(csv: String): List<ImportableItem> = filterOutDeadRunItems(READER.parseCsv(csv))
 
     companion object {
 
@@ -192,7 +192,7 @@ class ImportService(private val graphQLServiceFactory: GraphQLServiceFactory) {
             }
         }
 
-        private fun filterOutDeadRunItems(hastusItems: List<IHastusData>): List<IHastusData> {
+        private fun filterOutDeadRunItems(hastusItems: List<ImportableItem>): List<ImportableItem> {
             val internalNumbersOfDeadRuns: List<String> = hastusItems
                 .filterIsInstance<TripRecord>()
                 .filter { trip ->
diff --git a/src/main/kotlin/fi/hsl/jore4/hastus/util/CsvReader.kt b/src/main/kotlin/fi/hsl/jore4/hastus/util/CsvReader.kt
diff --git a/src/main/kotlin/fi/hsl/jore4/hastus/util/CsvWriter.kt b/src/main/kotlin/fi/hsl/jore4/hastus/util/CsvWriter.kt
diff --git a/src/test/kotlin/fi/hsl/jore4/hastus/service/exporting/ConversionsToCsvTest.kt b/src/test/kotlin/fi/hsl/jore4/hastus/service/exporting/ConversionsToCsvTest.kt
diff --git a/src/test/kotlin/fi/hsl/jore4/hastus/service/exporting/ConversionsToHastusTest.kt b/src/test/kotlin/fi/hsl/jore4/hastus/service/exporting/ConversionsToHastusTest.kt
diff --git a/src/test/kotlin/fi/hsl/jore4/hastus/service/importing/ConversionsFromHastusTest.kt b/src/test/kotlin/fi/hsl/jore4/hastus/service/importing/ConversionsFromHastusTest.kt
diff --git a/src/test/kotlin/fi/hsl/jore4/hastus/util/CsvReaderTest.kt b/src/test/kotlin/fi/hsl/jore4/hastus/util/CsvReaderTest.kt
