Cross-compile to Play 2.8 (#10)

Author: jeffmay

build.sbt

@@ -43,11 +43,13 @@ def playModuleJsonErrorHandler(includePlayVersion: String): Project = {
     case Play_2_5 => "25"
     case Play_2_6 => "26"
     case Play_2_7 => "27"
+    case Play_2_8 => "28"
   }
   val scalaVersions = includePlayVersion match {
     case Play_2_5 => Seq(Scala_2_11)
     case Play_2_6 => Seq(Scala_2_11, Scala_2_12)
     case Play_2_7 => Seq(Scala_2_11, Scala_2_12, Scala_2_13)
+    case Play_2_8 => Seq(Scala_2_12, Scala_2_13)
   }
   val projectPath = "code"
   commonProject(s"play$playSuffix-module-json-error-handler", s"play$playSuffix")
@@ -72,3 +74,8 @@ def playModuleJsonErrorHandler(includePlayVersion: String): Project = {
 lazy val play25 = playModuleJsonErrorHandler(Play_2_5)
 lazy val play26 = playModuleJsonErrorHandler(Play_2_6)
 lazy val play27 = playModuleJsonErrorHandler(Play_2_7)
+lazy val play28 = playModuleJsonErrorHandler(Play_2_8).settings(
+  // this artifact is new, so don't try to download older artifacts
+  mimaPreviousArtifacts := Set(),
+  mimaFailOnNoPrevious := false,
+)

code/src/main/scala/com/rallyhealth/playmodule/jsonerrors/JsonHttpErrorConfig.scala

@@ -13,6 +13,14 @@ case class JsonHttpErrorConfig(showDevErrors: Boolean, showRoutes: Boolean, play
 
 object JsonHttpErrorConfig {
 
+  // This only exists for source compatibility with Play 2.8 and older verions of Play Config
+  private implicit class ConfigSourceCompat(private val config: Configuration) extends AnyVal {
+    def getString(path: String): Option[String] = {
+      if (config.underlying.hasPath(path)) Some(config.underlying.getString(path))
+      else None
+    }
+  }
+
   def fromEnvironment(env: Environment, config: Configuration): JsonHttpErrorConfig = {
     val isDev = env.mode != Mode.Prod
     val editor = config.getString("play.editor")

code/src/test/scala/com/rallyhealth/playmodule/jsonerrors/PlayJsonHttpErrorHandlerSpec.scala

@@ -1,8 +1,10 @@
 package com.rallyhealth.playmodule.jsonerrors
 
+import akka.util.ByteString
 import org.scalatest.freespec.AsyncFreeSpec
 import play.api.http._
 import play.api.libs.json.{JsObject, Json}
+import play.api.libs.streams.Accumulator
 import play.api.mvc._
 import play.api.routing.Router
 import play.api.routing.Router.Routes
@@ -94,8 +96,8 @@ class PlayJsonHttpErrorHandlerSpec extends AsyncFreeSpec with AsyncResultExtract
 
     s"$it should return a list of routes for 404 when $showDevErrorIsSet and $showRoutesIsSet" in {
       val fixture = newFixture(DocumentedRouter.fromRegexMap(
-        ("GET", "/unmatched/1".r, "test 1 documentation") -> Action(Results.Ok),
-        ("GET", "/unmatched/2".r, "test 2 documentation") -> Action(Results.Ok)
+        ("GET", "/unmatched/1".r, "test 1 documentation") -> PlayAction(Results.Ok),
+        ("GET", "/unmatched/2".r, "test 2 documentation") -> PlayAction(Results.Ok)
       ))
       import fixture._
       val expectedMessage = "test exception"
@@ -294,3 +296,8 @@ object DocumentedRouter {
     new DocumentedRouter(Function.unlift(router), documentation)
   }
 }
+
+// Used for source compatibility with Play 2.8 and earlier versions that used Action.apply()
+object PlayAction {
+  def apply(result: => Result): EssentialAction = EssentialAction(_ => Accumulator.done(result))
+}

project/Dependencies.scala

@@ -9,11 +9,13 @@ object Dependencies {
   final val Play_2_5 = "2.5.18"
   final val Play_2_6 = "2.6.19"
   final val Play_2_7 = "2.7.9"
+  final val Play_2_8 = "2.8.8"
 
   private final val guice4Version = "4.2.3"
   private final val play25JsonVersion = Play_2_5
   private final val play26JsonVersion = "2.6.9"
   private final val play27JsonVersion = "2.7.4"
+  private final val play28JsonVersion = "2.8.1"
   private final val playTestOpsVersion = "1.5.0"
   private final val scalatestVersion = "3.2.7"
 
@@ -30,6 +32,7 @@ object Dependencies {
       case Play_2_5 => play25JsonVersion
       case Play_2_6 => play26JsonVersion
       case Play_2_7 => play27JsonVersion
+      case Play_2_8 => play28JsonVersion
     }
     "com.typesafe.play" %% "play-json" % version
   }
@@ -43,6 +46,7 @@ object Dependencies {
       case Play_2_5 => "25"
       case Play_2_6 => "26"
       case Play_2_7 => "27"
+      case Play_2_8 => "28"
     }
     "com.rallyhealth" %% s"play$playSuffix-test-ops-core" % playTestOpsVersion
   }