What to do for overriding the PureConfig behavior in Scala ?

Table of contents

Reading Time: 2 minutes

PureConfig has its own predefined behavior for reading and writing to the configuration files, but sometimes we got the tricky requirement in which we need some specific behavior; for example to read the config.

It is possible to override the behavior of PureConfig for a certain type by implementing another instance of ConfigReader, ConfigWriter or ConfigConvert. So in this blog we will discuss all 3 override types.

1. ConfigReader:
The default behavior of PureConfig for String is to return the string itself in the configuration.
For example, when below configuration will be read by PureConfig, it will be read as it is :
application.conf:

company {
full-name = "Knoldus Software LLP"
started = 2012
employees = "80-120"
offices = ["India", "Singapore", "US", "Canada"]
offices-in-india {
head-office = "Delhi"
development = "Noida"
}
}

Reading configuration:

import pureconfig.error.ConfigReaderFailures
import pureconfig.loadConfig

class SimpleConfig {
def getConfig: Either[ConfigReaderFailures, Company] = loadConfig[Company]
}

case class Company(company: CompanyDetails)

case class CompanyDetails(fullName: String,
started: Int,
employees: String,
offices: List[String],
officesInIndia: Map[String, String],
extraActivity: Option[String])

// Calling and displaying the configuration
val simpleConfig = new SimpleConfig().getConfig

simpleConfig match {
case Left(ex) => ex.toList.foreach(println)

case Right(config) =>
println(s"Company's Name ${config.company.fullName}")
println(s"Company started at ${config.company.started}")
println(s"Company's strength is ${config.company.employees}")
println(s"Company's presence are in ${config.company.offices}")
println(s"Company's office in India are ${config.company.officesInIndia}")
println(s"Company's extra activity is ${config.company.extraActivity}")
}

Output :

Knoldus Software LLP
2012
80-120
List(India, Singapore, US, Canada)
Map(development -> Noida, head-office -> Delhi)

This is the default behavior of ConfigReader in which the output is same as it is defined in configuration file.

Now let’s try to override the above behavior. Now we want that Strings are always read upper case. For this, we need to define custom ConfigReader instance for String:

implicit val overrideStrReader = ConfigReader.fromString[String](catchReadError(_.toUpperCase()))

After adding above line, lets take a look on output :

KNOLDUS SOFTWARE LLP
2012
80-120
List(INDIA, SINGAPORE, US, CANADA)
Map(development -> NOIDA, head-office -> DELHI)

View full code on github.

2. ConfigWriter:

Add below line to override the String write behavior:

implicit val myStringWriter = ConfigWriter.toString[String](n => s"$n !!!")

Write config:

val companyDetails = CompanyDetails("Knoldus Software LLP", 2012, "80-120", Nil, Map(), None)
val conf = Company(companyDetails).toConfig
println(conf)

output:

SimpleConfigObject({"company":{"employees":"80-120 !!!","full-name":"Knoldus Software LLP !!!","offices":[],"offices-in-india":{},"started":2012}})

You can see above that “!!!” has been appended to the each string value.

View full code on github

3. ConfigConvert:

If you want to define both operations, the easier way to add full support for a class is by creating a ConfigConvert:

implicit val myStringConvert = ConfigConvert.viaString[String](
catchReadError(s => s.toUpperCase ), n => s"$n !!!")

A ConfigConvert is both an instance of ConfigReader and an instance of ConfigWriter, so it can be used everywhere one of them is required.

View full code on github

That’s it. Hope you enjoy the reading.

Happy Blogging !!!

Happy Coding !!!

1 thought on “What to do for overriding the PureConfig behavior in Scala ?3 min read”

Comments are closed.

High performance systems

Data Engineering, Strategy and Analytics

Intelligence Driven Decisioning - AI/ML

Cloud Engineering

Architecture Strategy, Audit & Academy

Platforms

KDP

KDSP

Products

Premon

Studio9

Tech Hub

Akka

Scala

Rust

Spark

Functional Java

Kafka

Flink

ML/AI

DevOps

Data Warehouse

Travel

Retail

Finance

Healthcare

Media and Publishing

Consumer Internet

Hi-tech & IoT

Case Studies

Blogs

Books

Community

Resources

OS contributions

Webinars

Knolx

Check out our open positions

Services

Go to Overview

Accelerators

Go to Overview

Platforms

Products

TechHub

Industries

Go to Overview

Travel

Insights

Go to Overview

What to do for overriding the PureConfig behavior in Scala ?

Share the Knol:

Related

Written by Rishi Khandelwal

1 thought on “What to do for overriding the PureConfig behavior in Scala ?3 min read”

COMPANY

Sign up to our newsletter

Certificates

Partners

© 2023 Knoldus, Inc. All Rights Reserved.

Part of NashTech

Privacy Policy | Sitemap

Check out our
open positions