feat: new version of scala-distances

BREAKING CHANGE: now returns elevationProfile and does not return/save all subpaths anymore

Author: simooonb

.gitlab-ci.yml

@@ -5,7 +5,6 @@ include:
 compile scala-distances:
   extends:
     - .sbt-compile-cross
-  tags: []
 
 unused-dependencies:
   extends: .sbt-unused-dependencies
@@ -14,12 +13,9 @@ test scala-distances:
   extends:
   - .sbt-test-cross
   - .redis
-  tags: []
 
 version:
   extends: .version
-  tags: []
 
 publish on sonatype:
   extends: .sonatype-publish
-  tags: []

build.sbt

@@ -2,23 +2,28 @@ import CompileFlags._
 import sbt.Keys.crossScalaVersions
 import DependenciesScopesHandler._
 import Dependencies._
+import PublishSettings.localCacheSettings
 
 lazy val scala212               = "2.12.13"
 lazy val scala213               = "2.13.10"
 lazy val supportedScalaVersions = List(scala213, scala212)
 
-Global / onChangedBuildSource  := ReloadOnSourceChanges
-ThisBuild / organization       := "com.colisweb"
-ThisBuild / scalaVersion       := scala213
-ThisBuild / crossScalaVersions := supportedScalaVersions
-ThisBuild / scalafmtOnCompile  := true
-ThisBuild / scalafmtCheck      := true
-ThisBuild / scalafmtSbtCheck   := true
-ThisBuild / scalacOptions ++= crossScalacOptions(scalaVersion.value)
 
-ThisBuild / pushRemoteCacheTo := Some(
-  MavenCache("local-cache", baseDirectory.value / sys.env.getOrElse("CACHE_PATH", "sbt-cache"))
-)
+Global / onChangedBuildSource := ReloadOnSourceChanges
+
+inThisBuild {
+  List(
+    organization       := "com.colisweb",
+    scalaVersion      := scala213,
+    crossScalaVersions := supportedScalaVersions,
+    scalafmtOnCompile  := true,
+    scalafmtCheck      := true,
+    scalafmtSbtCheck   := true,
+    Test / fork        := true,
+    scalacOptions ++= crossScalacOptions(scalaVersion.value),
+    localCacheSettings
+  )
+}
 //// Main projects
 
 lazy val root = Project(id = "scala-distances", base = file("."))
@@ -29,12 +34,9 @@ lazy val root = Project(id = "scala-distances", base = file("."))
 
 lazy val core = project
   .settings(moduleName := "scala-distances-core")
+  .settings(libraryDependencies ++= compileDependencies(cats, scalaCache, squants))
   .settings(
-    libraryDependencies ++= compileDependencies(
-      cats,
-      scalaCache,
-      squants
-    ) ++ testDependencies(
+    libraryDependencies ++= testDependencies(
       monix,
       mockitoScalaScalatest,
       scalacheck,
@@ -49,13 +51,7 @@ lazy val `google-provider` = project
   .in(file("providers/google"))
   .settings(moduleName := "scala-distances-provider-google")
   .settings(
-    libraryDependencies ++= compileDependencies(
-      catsEffect,
-      enumeratum,
-      googleMaps,
-      loggingInterceptor,
-      refined
-    )
+    libraryDependencies ++= compileDependencies(catsEffect, enumeratum, googleMaps, loggingInterceptor, refined)
   )
   .dependsOn(core)
 
@@ -96,10 +92,9 @@ lazy val `caffeine-cache` = project
 lazy val tests = project
   .settings(noPublishSettings)
   .dependsOn(core % "test->test;compile->compile", `google-provider`, `here-provider`, `redis-cache`, `caffeine-cache`)
-  .settings(libraryDependencies ++= testDependencies(pureconfig, refinedPureconfig, scalaCacheCatsEffect))
+  .settings(libraryDependencies ++= testDependencies(pureconfig, refinedPureconfig, scalaCacheCatsEffect, approvals))
 
-/** Copied from Cats
-  */
+/** Copied from Cats */
 lazy val noPublishSettings = Seq(
   publish         := {},
   publishLocal    := {},

core/src/main/scala/com/colisweb/distances/bird/HaversineDistanceApi.scala

@@ -2,18 +2,18 @@ package com.colisweb.distances.bird
 
 import cats.Applicative
 import com.colisweb.distances.DistanceApi
-import com.colisweb.distances.model.path.DirectedPath
 import com.colisweb.distances.model.{FixedSpeedTransportation, OriginDestination, PathResult}
 
 class HaversineDistanceApi[F[_]: Applicative, P: OriginDestination: FixedSpeedTransportation]
     extends DistanceApi[F, P] {
   import com.colisweb.distances.model.syntax._
 
   override def distance(path: P): F[PathResult] = {
-    val distanceInKilometers = Haversine.distanceInKm(path.origin, path.destination)
-    val timeInSeconds        = DurationFromSpeed.durationForDistance(distanceInKilometers, path.speed)
-    Applicative[F].pure(
-      PathResult(distanceInKilometers, timeInSeconds, List(DirectedPath(path.origin, path.destination)))
-    )
+    val distanceInKilometers         = Haversine.distanceInKm(path.origin, path.destination)
+    val timeInSeconds                = DurationFromSpeed.durationForDistance(distanceInKilometers, path.speed)
+    val rollingResistanceCoefficient = 0.0125
+    // we don't know the elevation so only the distance is taken into account
+    val elevationProfile = distanceInKilometers * 1000 * rollingResistanceCoefficient
+    Applicative[F].pure(PathResult(distanceInKilometers, timeInSeconds, Some(elevationProfile)))
   }
 }

core/src/main/scala/com/colisweb/distances/model/PathResult.scala

@@ -1,5 +1,10 @@
 package com.colisweb.distances.model
 
-import com.colisweb.distances.model.path.DirectedPath
-
-final case class PathResult(distance: DistanceInKm, duration: DurationInSeconds, paths: List[DirectedPath])
+final case class PathResult(
+    distance: DistanceInKm,
+    duration: DurationInSeconds,
+    elevationProfile: Option[Double] = None
+) {
+  val speedInKmPerHour: SpeedInKmH   = distance / (duration / 3600)
+  val speedInMetersPerSecond: Double = distance * 1000 / duration
+}

core/src/test/scala/com/colisweb/distances/cache/CacheSpec.scala

@@ -19,7 +19,7 @@ class CacheSpec extends AnyWordSpec with Matchers {
     }
 
   private val path: DirectedPath     = DirectedPath(Point(0, 0), Point(0, 0))
-  private val pathResult: PathResult = PathResult(1, 1, List(path))
+  private val pathResult: PathResult = PathResult(1, 1)
 
   private val distanceMap: Distances[Try, DirectedPath] =
     FromMapDistances[Try]

core/src/test/scala/com/colisweb/distances/correction/CorrectPastDepartureTimeSpec.scala

@@ -35,7 +35,7 @@ class CorrectPastDepartureTimeSpec
 
   override protected def beforeEach(): Unit = {
     Mockito.reset(base)
-    base.distance(any[DirectedPathWithModeAt]) returns PathResult(0d, 0, Nil)
+    base.distance(any[DirectedPathWithModeAt]) returns PathResult(0d, 0)
     ()
   }
 

core/src/test/scala/com/colisweb/distances/generator/Generators.scala

@@ -65,7 +65,7 @@ object Generators {
       path                <- genPathBetween
       distanceAndDuration <- genDistanceAndDurationUnrelated
       (distance, duration) = distanceAndDuration
-    } yield (path, PathResult(distance, duration, List(DirectedPath(path.origin, path.destination))))
+    } yield (path, PathResult(distance, duration))
 
   def genPathSimpleAndDistanceUnrelatedSet: Gen[Map[DirectedPath, PathResult]] =
     Gen.listOf(genPathSimpleAndDistanceUnrelated).map(_.toMap)

project/Dependencies.scala

@@ -1,6 +1,7 @@
 import sbt._
 
 object Versions {
+  final val approvals          = "1.3.1"
   final val cats               = "2.9.0"
   final val catsEffect         = "2.3.3"
   final val circe              = "0.14.2"
@@ -15,14 +16,15 @@ object Versions {
   final val requests           = "0.7.1"
   final val scalaCache         = "0.28.0"
   final val scalacheck         = "1.17.0"
-  final val scalaCompat        = "2.8.1"
+  final val scalaCompat        = "2.9.0"
   final val scalatest          = "3.2.13"
   final val scalatestPlus      = "3.1.0.0-RC2"
   final val squants            = "1.8.3"
 }
 
 object Dependencies {
 
+  final val approvals             = "com.colisweb"           %% "approvals-scala"          % Versions.approvals
   final val cats                  = "org.typelevel"          %% "cats-core"                % Versions.cats
   final val catsEffect            = "org.typelevel"          %% "cats-effect"              % Versions.catsEffect
   final val circe                 = "io.circe"               %% "circe-core"               % Versions.circe

project/PublishSettings.scala

@@ -0,0 +1 @@
+../scala-common/scala/PublishSettings.scala

providers/google/src/main/scala/com/colisweb/distances/providers/google/GoogleDistanceDirectionsProvider.scala

@@ -35,7 +35,7 @@ class GoogleDistanceDirectionsProvider[F[_]](
       bestRoute            = chooseBestRoute(response.routes.toList)
       distancesAndDuration = extractResponse(bestRoute)
       (distance, duration) = distancesAndDuration
-    } yield PathResult(distance, duration, Nil)
+    } yield PathResult(distance, duration)
 
   }
 

providers/google/src/main/scala/com/colisweb/distances/providers/google/GoogleDistanceMatrixProvider.scala

@@ -35,7 +35,7 @@ class GoogleDistanceMatrixProvider[F[_]](
       response                <- requestExecutor.run(requestMaybeWithTraffic)
       distanceAndDuration     <- extractSingleResponse(response)
       (distance, duration) = distanceAndDuration
-    } yield PathResult(distance, duration, Nil)
+    } yield PathResult(distance, duration)
   }
 
   private def requestWithPossibleTraffic(

providers/here/src/main/scala/com/colisweb/distances/providers/here/HereRoutingProvider.scala

@@ -83,9 +83,10 @@ class HereRoutingProvider[F[_]](hereRoutingContext: HereRoutingContext, executor
 
   private def parseResult(origin: Point, destination: Point, r: Response): F[PathResult] =
     if (r.routes.nonEmpty) {
-      val bestRoute    = routingMode.best(r.routes)
-      val roadSegments = parseRoadSegments(origin, destination, bestRoute)
-      F.pure(PathResult(bestRoute.distance, bestRoute.duration, roadSegments))
+      val bestRoute        = routingMode.best(r.routes)
+      val roadSegments     = parseRoadSegments(origin, destination, bestRoute)
+      val elevationProfile = computeElevationProfile(roadSegments, bestRoute.distance)
+      F.pure(PathResult(bestRoute.distance, bestRoute.duration, Some(elevationProfile)))
     } else {
       F.raiseError(NoRouteFoundError(origin, destination))
     }
@@ -132,6 +133,20 @@ class HereRoutingProvider[F[_]](hereRoutingContext: HereRoutingContext, executor
         case _              => None
       }
   }
+
+  // unit is in meters
+  // it is part of a modified version of the formula from:
+  // A new model and approach to electric and diesel-powered vehicle routing, Murakami (2017)
+  private[here] def computeElevationProfile(subPaths: List[DirectedPath], totalDistance: DistanceInKm): Double = {
+    val totalBirdDistanceInKm        = subPaths.foldLeft(0d) { case (acc, path) => acc + path.birdDistanceInKm }
+    val rollingResistanceCoefficient = 0.0125
+
+    subPaths.foldLeft(0d) { case (acc, path) =>
+      val approxSubPathDistanceInKm = totalDistance * (path.birdDistanceInKm / totalBirdDistanceInKm)
+      val angle                     = path.elevationAngleInRadians
+      acc + (approxSubPathDistanceInKm * 1000 * (math.sin(angle) + rollingResistanceCoefficient * math.cos(angle)))
+    }
+  }
 }
 
 private[here] object HereRoutingProvider {

tests/src/test/resources/com/colisweb/distances/providers/here/HereRoutingProviderTest.files/HereRoutingProviderTest_computeElevationProfile_should_be_compliant.approved

@@ -0,0 +1,18 @@
+elevation profile - angles
+0.0 <== , List()
+125.09469 <== , List(0.0)
+250.18939 <== , List(0.0, 0.0)
+375.28408 <== , List(0.0, 0.0, 0.0)
+2806.61649 <== , List(15.0)
+5902.97115 <== , List(30.0)
+10132.67027 <== , List(45.0)
+-2556.4271 <== , List(-15.0)
+-5652.78176 <== , List(-30.0)
+-9882.48088 <== , List(-45.0)
+250.18939 <== , List(15.0, -15.0)
+250.18939 <== , List(45.0, -45.0)
+250.18939 <== , List(89.0, -89.0)
+-974.037 <== , List(3.0, -10.0)
+5454.51693 <== , List(30.0, -1.0)
+10063.93017 <== , List(10.0, 45.0, -2.0)
+-7469.65678 <== , List(-45.0, 0.0, 1.0)

tests/src/test/scala/com/colisweb/distances/DistanceApiSpec.scala

@@ -351,7 +351,7 @@ class DistanceApiSpec extends AnyWordSpec with Matchers with ScalaFutures with B
       results: Map[(Point, Point), (DistanceInKm, DurationInSeconds)],
       trafficTime: Option[Instant],
       run: RunSync[F],
-      checkPolyline: Boolean = false
+      checkElevationProfile: Boolean = false
   ): Unit = {
 
     "return approximate distance and duration from Paris 01 to Marseille 01" in {
@@ -364,8 +364,8 @@ class DistanceApiSpec extends AnyWordSpec with Matchers with ScalaFutures with B
       val distanceFrom01to02   = run(api.distance(driveFrom01to02))
       val (distance, duration) = results(paris01 -> marseille01)
 
-      if (checkPolyline)
-        distanceFrom01to02.paths should not be empty
+      if (checkElevationProfile)
+        distanceFrom01to02.elevationProfile should not be empty
 
       distanceFrom01to02.distance shouldBe distance +- distance / 8
       distanceFrom01to02.duration shouldBe duration +- duration / 8
@@ -376,7 +376,7 @@ class DistanceApiSpec extends AnyWordSpec with Matchers with ScalaFutures with B
       api: DistanceApi[F, DirectedPathWithModeAt],
       trafficTime: Option[Instant],
       run: RunSync[F],
-      checkPolyline: Boolean = false
+      checkElevationProfile: Boolean = false
   ): Unit = {
 
     "return zero between the same points" in {
@@ -389,8 +389,8 @@ class DistanceApiSpec extends AnyWordSpec with Matchers with ScalaFutures with B
 
       val distance = run(api.distance(path))
 
-      if (checkPolyline)
-        distance.paths should not be empty
+      if (checkElevationProfile)
+        distance.elevationProfile should not be empty
 
       distance.distance shouldBe 0d
       distance.duration shouldBe 0
@@ -451,14 +451,14 @@ class DistanceApiSpec extends AnyWordSpec with Matchers with ScalaFutures with B
         hereApi,
         trafficTime = Some(futureTime),
         run,
-        checkPolyline = true
+        checkElevationProfile = true
       )
       approximateTests(
         hereApi,
         hereResults,
         trafficTime = None,
         run,
-        checkPolyline = true
+        checkElevationProfile = true
       )
     }