refactor!:Make implicit ConfigReader field names as unique as possible

jakubjanecek · jakubjanecek · commit 56978731a686 · 2019-10-23T12:42:02.000+02:00
BREAKING CHANGE: public implicits renamed

We want to prevent name collision which breaks user code and is very
hard to detect.
diff --git a/doobie-hikari-pureconfig/src/main/scala/com/avast/sst/doobie/pureconfig/ConfigReaders.scala b/doobie-hikari-pureconfig/src/main/scala/com/avast/sst/doobie/pureconfig/ConfigReaders.scala
@@ -9,7 +9,7 @@ import pureconfig.generic.semiauto.deriveReader
 
 trait ConfigReaders {
 
-  implicit val transactionIsolationReader: ConfigReader[TransactionIsolation] = ConfigReader[String].emap {
+  implicit val doobieTransactionIsolationReader: ConfigReader[TransactionIsolation] = ConfigReader[String].emap {
     case "TRANSACTION_NONE"             => TransactionIsolation.TransactionNone.asRight
     case "TRANSACTION_READ_UNCOMMITTED" => TransactionIsolation.TransactionReadUncommitted.asRight
     case "TRANSACTION_READ_COMMITTED"   => TransactionIsolation.TransactionReadCommitted.asRight
@@ -18,6 +18,6 @@ trait ConfigReaders {
     case unknown                        => Left(CannotConvert(unknown, "TransactionIsolation", "unknown value"))
   }
 
-  implicit val configReader: ConfigReader[DoobieHikariConfig] = deriveReader
+  implicit val doobieDoobieHikariConfigReader: ConfigReader[DoobieHikariConfig] = deriveReader
 
 }
diff --git a/flyway-pureconfig/src/main/scala/com/avast/sst/flyway/pureconfig/ConfigReaders.scala b/flyway-pureconfig/src/main/scala/com/avast/sst/flyway/pureconfig/ConfigReaders.scala
@@ -11,12 +11,12 @@ import pureconfig.generic.semiauto.deriveReader
 
 trait ConfigReaders {
 
-  implicit private[pureconfig] val charsetReader: ConfigReader[Charset] = ConfigReader[String].emap { value =>
+  implicit private[pureconfig] val flywayCharsetReader: ConfigReader[Charset] = ConfigReader[String].emap { value =>
     Either.catchNonFatal(Charset.forName(value)).leftMap(ExceptionThrown.apply)
   }
 
-  implicit val migrationVersionReader: ConfigReader[MigrationVersion] = ConfigReader[String].map(MigrationVersion.fromVersion)
+  implicit val flywayMigrationVersionReader: ConfigReader[MigrationVersion] = ConfigReader[String].map(MigrationVersion.fromVersion)
 
-  implicit val configReader: ConfigReader[FlywayConfig] = deriveReader
+  implicit val flywayFlywayConfigReader: ConfigReader[FlywayConfig] = deriveReader
 
 }
diff --git a/http4s-client-blaze-pureconfig/src/main/scala/com/avast/sst/http4s/client/pureconfig/ConfigReaders.scala b/http4s-client-blaze-pureconfig/src/main/scala/com/avast/sst/http4s/client/pureconfig/ConfigReaders.scala
@@ -10,14 +10,14 @@ import pureconfig.generic.semiauto.{deriveEnumerationReader, deriveReader}
 
 trait ConfigReaders {
 
-  implicit val userAgentReader: ConfigReader[`User-Agent`] = ConfigReader[String].emap { value =>
+  implicit val http4sClientUserAgentReader: ConfigReader[`User-Agent`] = ConfigReader[String].emap { value =>
     `User-Agent`.parse(value).leftMap { parseFailure =>
       CannotConvert(value, "User-Agent HTTP header", parseFailure.message)
     }
   }
 
-  implicit val parserModeReader: ConfigReader[ParserMode] = deriveEnumerationReader
+  implicit val http4sClientParserModeReader: ConfigReader[ParserMode] = deriveEnumerationReader
 
-  implicit val http4sBlazeClientConfigReader: ConfigReader[Http4sBlazeClientConfig] = deriveReader
+  implicit val http4sClientHttp4sBlazeClientConfigReader: ConfigReader[Http4sBlazeClientConfig] = deriveReader
 
 }
diff --git a/http4s-server-blaze-pureconfig/src/main/scala/com/avast/sst/http4s/server/pureconfig/ConfigReaders.scala b/http4s-server-blaze-pureconfig/src/main/scala/com/avast/sst/http4s/server/pureconfig/ConfigReaders.scala
@@ -7,8 +7,8 @@ import pureconfig.generic.semiauto.deriveReader
 
 trait ConfigReaders {
 
-  implicit val socketOptionsReader: ConfigReader[SocketOptions] = deriveReader
+  implicit val http4sServerSocketOptionsReader: ConfigReader[SocketOptions] = deriveReader
 
-  implicit val http4sBlazeServerConfigReader: ConfigReader[Http4sBlazeServerConfig] = deriveReader
+  implicit val http4sServerHttp4sBlazeServerConfigReader: ConfigReader[Http4sBlazeServerConfig] = deriveReader
 
 }
diff --git a/jvm-pureconfig/src/main/scala/com/avast/sst/jvm/pureconfig/ConfigReaders.scala b/jvm-pureconfig/src/main/scala/com/avast/sst/jvm/pureconfig/ConfigReaders.scala
@@ -7,10 +7,10 @@ import pureconfig.generic.semiauto.{deriveEnumerationReader, deriveReader}
 
 trait ConfigReaders {
 
-  implicit val threadPoolExecutorConfigReader: ConfigReader[ThreadPoolExecutorConfig] = deriveReader
+  implicit val jvmThreadPoolExecutorConfigReader: ConfigReader[ThreadPoolExecutorConfig] = deriveReader
 
-  implicit val taskPeekingModeReader: ConfigReader[TaskPeekingMode] = deriveEnumerationReader
+  implicit val jvmTaskPeekingModeReader: ConfigReader[TaskPeekingMode] = deriveEnumerationReader
 
-  implicit val forkJoinPoolConfigReader: ConfigReader[ForkJoinPoolConfig] = deriveReader
+  implicit val jvmForkJoinPoolConfigReader: ConfigReader[ForkJoinPoolConfig] = deriveReader
 
 }
diff --git a/micrometer-jmx-pureconfig/src/main/scala/com/avast/sst/micrometer/jmx/pureconfig/ConfigReaders.scala b/micrometer-jmx-pureconfig/src/main/scala/com/avast/sst/micrometer/jmx/pureconfig/ConfigReaders.scala
@@ -6,6 +6,6 @@ import pureconfig.generic.semiauto.deriveReader
 
 trait ConfigReaders {
 
-  implicit val micrometerJmxConfigReader: ConfigReader[MicrometerJmxConfig] = deriveReader
+  implicit val micrometerMicrometerJmxConfigReader: ConfigReader[MicrometerJmxConfig] = deriveReader
 
 }
diff --git a/micrometer-statsd-pureconfig/src/main/scala/com/avast/sst/micrometer/statsd/pureconfig/ConfigReaders.scala b/micrometer-statsd-pureconfig/src/main/scala/com/avast/sst/micrometer/statsd/pureconfig/ConfigReaders.scala
@@ -6,6 +6,6 @@ import pureconfig.generic.semiauto.deriveReader
 
 trait ConfigReaders {
 
-  implicit val micrometerStatsDConfigReader: ConfigReader[MicrometerStatsDConfig] = deriveReader
+  implicit val micrometerMicrometerStatsDConfigReader: ConfigReader[MicrometerStatsDConfig] = deriveReader
 
 }

Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,7 @@ import pureconfig.generic.semiauto.deriveReader`
`9`	`9`
`10`	`10`	`trait ConfigReaders {`
`11`	`11`
`12`		`- implicit val transactionIsolationReader: ConfigReader[TransactionIsolation] = ConfigReader[String].emap {`
	`12`	`+ implicit val doobieTransactionIsolationReader: ConfigReader[TransactionIsolation] = ConfigReader[String].emap {`
`13`	`13`	`case "TRANSACTION_NONE" => TransactionIsolation.TransactionNone.asRight`
`14`	`14`	`case "TRANSACTION_READ_UNCOMMITTED" => TransactionIsolation.TransactionReadUncommitted.asRight`
`15`	`15`	`case "TRANSACTION_READ_COMMITTED" => TransactionIsolation.TransactionReadCommitted.asRight`
`@@ -18,6 +18,6 @@ trait ConfigReaders {`
`18`	`18`	`case unknown => Left(CannotConvert(unknown, "TransactionIsolation", "unknown value"))`
`19`	`19`	`}`
`20`	`20`
`21`		`- implicit val configReader: ConfigReader[DoobieHikariConfig] = deriveReader`
	`21`	`+ implicit val doobieDoobieHikariConfigReader: ConfigReader[DoobieHikariConfig] = deriveReader`
`22`	`22`
`23`	`23`	`}`
Original file line number	Diff line number	Diff line change
`@@ -11,12 +11,12 @@ import pureconfig.generic.semiauto.deriveReader`
`11`	`11`
`12`	`12`	`trait ConfigReaders {`
`13`	`13`
`14`		`- implicit private[pureconfig] val charsetReader: ConfigReader[Charset] = ConfigReader[String].emap { value =>`
	`14`	`+ implicit private[pureconfig] val flywayCharsetReader: ConfigReader[Charset] = ConfigReader[String].emap { value =>`
`15`	`15`	`Either.catchNonFatal(Charset.forName(value)).leftMap(ExceptionThrown.apply)`
`16`	`16`	`}`
`17`	`17`
`18`		`- implicit val migrationVersionReader: ConfigReader[MigrationVersion] = ConfigReader[String].map(MigrationVersion.fromVersion)`
	`18`	`+ implicit val flywayMigrationVersionReader: ConfigReader[MigrationVersion] = ConfigReader[String].map(MigrationVersion.fromVersion)`
`19`	`19`
`20`		`- implicit val configReader: ConfigReader[FlywayConfig] = deriveReader`
	`20`	`+ implicit val flywayFlywayConfigReader: ConfigReader[FlywayConfig] = deriveReader`
`21`	`21`
`22`	`22`	`}`
Original file line number	Diff line number	Diff line change
`@@ -10,14 +10,14 @@ import pureconfig.generic.semiauto.{deriveEnumerationReader, deriveReader}`
`10`	`10`
`11`	`11`	`trait ConfigReaders {`
`12`	`12`
`13`		- implicit val userAgentReader: ConfigReader[`User-Agent`] = ConfigReader[String].emap { value =>
	`13`	+ implicit val http4sClientUserAgentReader: ConfigReader[`User-Agent`] = ConfigReader[String].emap { value =>
`14`	`14`	`User-Agent`.parse(value).leftMap { parseFailure =>
`15`	`15`	`CannotConvert(value, "User-Agent HTTP header", parseFailure.message)`
`16`	`16`	`}`
`17`	`17`	`}`
`18`	`18`
`19`		`- implicit val parserModeReader: ConfigReader[ParserMode] = deriveEnumerationReader`
	`19`	`+ implicit val http4sClientParserModeReader: ConfigReader[ParserMode] = deriveEnumerationReader`
`20`	`20`
`21`		`- implicit val http4sBlazeClientConfigReader: ConfigReader[Http4sBlazeClientConfig] = deriveReader`
	`21`	`+ implicit val http4sClientHttp4sBlazeClientConfigReader: ConfigReader[Http4sBlazeClientConfig] = deriveReader`
`22`	`22`
`23`	`23`	`}`
Original file line number	Diff line number	Diff line change
`@@ -7,8 +7,8 @@ import pureconfig.generic.semiauto.deriveReader`
`7`	`7`
`8`	`8`	`trait ConfigReaders {`
`9`	`9`
`10`		`- implicit val socketOptionsReader: ConfigReader[SocketOptions] = deriveReader`
	`10`	`+ implicit val http4sServerSocketOptionsReader: ConfigReader[SocketOptions] = deriveReader`
`11`	`11`
`12`		`- implicit val http4sBlazeServerConfigReader: ConfigReader[Http4sBlazeServerConfig] = deriveReader`
	`12`	`+ implicit val http4sServerHttp4sBlazeServerConfigReader: ConfigReader[Http4sBlazeServerConfig] = deriveReader`
`13`	`13`
`14`	`14`	`}`
Original file line number	Diff line number	Diff line change
`@@ -7,10 +7,10 @@ import pureconfig.generic.semiauto.{deriveEnumerationReader, deriveReader}`
`7`	`7`
`8`	`8`	`trait ConfigReaders {`
`9`	`9`
`10`		`- implicit val threadPoolExecutorConfigReader: ConfigReader[ThreadPoolExecutorConfig] = deriveReader`
	`10`	`+ implicit val jvmThreadPoolExecutorConfigReader: ConfigReader[ThreadPoolExecutorConfig] = deriveReader`
`11`	`11`
`12`		`- implicit val taskPeekingModeReader: ConfigReader[TaskPeekingMode] = deriveEnumerationReader`
	`12`	`+ implicit val jvmTaskPeekingModeReader: ConfigReader[TaskPeekingMode] = deriveEnumerationReader`
`13`	`13`
`14`		`- implicit val forkJoinPoolConfigReader: ConfigReader[ForkJoinPoolConfig] = deriveReader`
	`14`	`+ implicit val jvmForkJoinPoolConfigReader: ConfigReader[ForkJoinPoolConfig] = deriveReader`
`15`	`15`
`16`	`16`	`}`
Original file line number	Diff line number	Diff line change
`@@ -6,6 +6,6 @@ import pureconfig.generic.semiauto.deriveReader`
`6`	`6`
`7`	`7`	`trait ConfigReaders {`
`8`	`8`
`9`		`- implicit val micrometerJmxConfigReader: ConfigReader[MicrometerJmxConfig] = deriveReader`
	`9`	`+ implicit val micrometerMicrometerJmxConfigReader: ConfigReader[MicrometerJmxConfig] = deriveReader`
`10`	`10`
`11`	`11`	`}`
Original file line number	Diff line number	Diff line change
`@@ -6,6 +6,6 @@ import pureconfig.generic.semiauto.deriveReader`
`6`	`6`
`7`	`7`	`trait ConfigReaders {`
`8`	`8`
`9`		`- implicit val micrometerStatsDConfigReader: ConfigReader[MicrometerStatsDConfig] = deriveReader`
	`9`	`+ implicit val micrometerMicrometerStatsDConfigReader: ConfigReader[MicrometerStatsDConfig] = deriveReader`
`10`	`10`
`11`	`11`	`}`