Add ChronoUnit ConfigReader (#1117)

pureconfig · Aug 29, 2021 · 7e536dd · 7e536dd
1 parent 6cc794d
commit 7e536dd
Show file tree

Hide file tree

Showing 5 changed files with 32 additions and 5 deletions.
diff --git a/core/src/main/scala/pureconfig/BasicReaders.scala b/core/src/main/scala/pureconfig/BasicReaders.scala
@@ -5,6 +5,7 @@ import java.math.{BigDecimal => JavaBigDecimal, BigInteger}
 import java.net.{URI, URL}
 import java.nio.file.{Path, Paths}
 import java.time._
+import java.time.temporal.ChronoUnit
 import java.time.{Duration => JavaDuration}
 import java.util.UUID
 import java.util.regex.Pattern
@@ -67,10 +68,7 @@ trait PrimitiveReaders {
 trait JavaEnumReader {
 
   implicit def javaEnumReader[A <: java.lang.Enum[A]](implicit tag: ClassTag[A]): ConfigReader[A] =
-    ConfigReader.fromString(catchReadError(s => {
-      val enumClass = tag.runtimeClass.asInstanceOf[Class[A]]
-      Enum.valueOf(enumClass, s)
-    }))
+    configurable.genericJavaEnumReader[A](identity)
 }
 
 /** Trait containing `ConfigReader` instances for classes related to file system paths and URIs.
@@ -109,6 +107,9 @@ trait JavaTimeReaders {
   implicit val periodConfigReader: ConfigReader[Period] =
     ConfigReader.fromNonEmptyString[Period](PeriodUtils.fromString)
 
+  implicit val chronoUnitReader: ConfigReader[ChronoUnit] =
+    configurable.genericJavaEnumReader[ChronoUnit](ConfigFieldMapping(KebabCase, ScreamingSnakeCase))
+
   implicit val javaDurationConfigReader: ConfigReader[JavaDuration] =
     ConfigReader.fromNonEmptyString[JavaDuration](catchReadError(JavaDuration.parse))
 

diff --git a/core/src/main/scala/pureconfig/BasicWriters.scala b/core/src/main/scala/pureconfig/BasicWriters.scala
@@ -5,6 +5,7 @@ import java.math.{BigDecimal => JavaBigDecimal, BigInteger}
 import java.net.{URI, URL}
 import java.nio.file.Path
 import java.time._
+import java.time.temporal.ChronoUnit
 import java.time.{Duration => JavaDuration}
 import java.util.UUID
 import java.util.regex.Pattern
@@ -65,11 +66,16 @@ trait JavaTimeWriters {
   implicit val zoneOffsetConfigWriter: ConfigWriter[ZoneOffset] = ConfigWriter.toDefaultString[ZoneOffset]
   implicit val zoneIdConfigWriter: ConfigWriter[ZoneId] = ConfigWriter.toDefaultString[ZoneId]
   implicit val periodConfigWriter: ConfigWriter[Period] = ConfigWriter.toDefaultString[Period]
+  implicit val chronoUnitConfigWriter: ConfigWriter[ChronoUnit] =
+    ConfigWriter.toString[ChronoUnit](chronoUnitToString)
 
   // see documentation for [[java.time.Year.parse]]
   private[this] def yearToString(year: Year): String =
     if (year.getValue > 9999) "+" + year else year.toString
 
+  private[this] def chronoUnitToString(chronoUnit: ChronoUnit): String =
+    ConfigFieldMapping(ScreamingSnakeCase, KebabCase)(chronoUnit.name)
+
   implicit val yearConfigWriter: ConfigWriter[Year] = ConfigWriter.toString[Year](yearToString)
   implicit val javaDurationConfigWriter: ConfigWriter[JavaDuration] = ConfigWriter.toDefaultString[JavaDuration]
 }

diff --git a/core/src/main/scala/pureconfig/configurable/package.scala b/core/src/main/scala/pureconfig/configurable/package.scala
@@ -4,10 +4,12 @@ import java.time._
 import java.time.format.DateTimeFormatter
 
 import scala.collection.JavaConverters._
+import scala.reflect.ClassTag
 
 import com.typesafe.config.ConfigValueFactory
 
-import pureconfig.ConfigConvert.{catchReadError, viaNonEmptyString}
+import pureconfig.ConfigConvert.viaNonEmptyString
+import pureconfig.ConvertHelpers.catchReadError
 import pureconfig.error.FailureReason
 
 /** Provides methods that create [[ConfigConvert]] instances from a set of parameters used to configure the instances.
@@ -74,4 +76,12 @@ package object configurable {
         keyFormatter(key) -> writerV.to(value)
       }.asJava)
     )
+
+  def genericJavaEnumReader[A <: java.lang.Enum[A]](
+      transformValue: String => String
+  )(implicit tag: ClassTag[A]): ConfigReader[A] =
+    ConfigReader.fromString(catchReadError(s => {
+      val enumClass = tag.runtimeClass.asInstanceOf[Class[A]]
+      Enum.valueOf(enumClass, transformValue(s))
+    }))
 }
diff --git a/testkit/src/main/scala/pureconfig/arbitrary/package.scala b/testkit/src/main/scala/pureconfig/arbitrary/package.scala
@@ -3,6 +3,7 @@ package pureconfig
 import java.io.File
 import java.math.BigInteger
 import java.nio.file.Path
+import java.time.temporal.ChronoUnit
 import java.time.{Duration => JavaDuration, _}
 import java.util.UUID
 
@@ -20,6 +21,7 @@ package object arbitrary {
   implicit val arbFiniteDuration: Arbitrary[FiniteDuration] = Arbitrary(genFiniteDuration)
   implicit val arbInstant: Arbitrary[Instant] = Arbitrary(genInstant)
   implicit val arbPeriod: Arbitrary[Period] = Arbitrary(genPeriod)
+  implicit val arbChronoUnit: Arbitrary[ChronoUnit] = Arbitrary(Gen.oneOf(ChronoUnit.values()))
   implicit val arbYear: Arbitrary[Year] = Arbitrary(genYear)
   implicit val arbUUID: Arbitrary[UUID] = Arbitrary(Gen.uuid)
   implicit val arbPath: Arbitrary[Path] = Arbitrary(genPath)

diff --git a/tests/src/test/scala/pureconfig/BasicConvertersSuite.scala b/tests/src/test/scala/pureconfig/BasicConvertersSuite.scala
@@ -4,6 +4,7 @@ import java.io.File
 import java.math.{BigDecimal => JavaBigDecimal, BigInteger}
 import java.net.{URI, URL}
 import java.nio.file.Path
+import java.time.temporal.ChronoUnit
 import java.time.{Duration => JavaDuration, _}
 import java.util.UUID
 import java.util.regex.Pattern
@@ -71,6 +72,8 @@ class BasicConvertersSuite extends BaseSuite {
 
   checkArbitrary[Period]
 
+  checkArbitrary[ChronoUnit]
+
   checkReadString[Period](
     "1d" -> Period.ofDays(1),
     "42" -> Period.ofDays(42),
@@ -79,6 +82,11 @@ class BasicConvertersSuite extends BaseSuite {
     "2y" -> Period.ofYears(2)
   )
 
+  checkReadString[ChronoUnit](
+    "half-days" -> ChronoUnit.HALF_DAYS,
+    "weeks" -> ChronoUnit.WEEKS
+  )
+
   checkRead[Period](ConfigValueFactory.fromAnyRef(42) -> Period.ofDays(42))
 
   checkFailure[Period, CannotConvert](ConfigValueFactory.fromAnyRef("4kb"), ConfigValueFactory.fromAnyRef("x weeks"))