https://github.com/valentiay/phobos
Efficient and expressive XML data-binding library for Scala
https://github.com/valentiay/phobos
Last synced: about 2 months ago
JSON representation
Efficient and expressive XML data-binding library for Scala
- Host: GitHub
- URL: https://github.com/valentiay/phobos
- Owner: valentiay
- License: apache-2.0
- Created: 2024-03-06T18:32:39.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2025-11-13T19:22:04.000Z (5 months ago)
- Last Synced: 2025-11-13T21:16:12.073Z (5 months ago)
- Language: Scala
- Size: 1010 KB
- Stars: 30
- Watchers: 1
- Forks: 7
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- fucking-awesome-scala - phobos - binding library for Scala |   (Table of Contents / XML / HTML)
- awesome-scala - phobos - binding library for Scala |   (Table of Contents / XML / HTML)
README
# phobos
[](https://search.maven.org/search?q=dev.valentiay.phobos-core)
[](https://github.com/valentiay/phobos/actions/workflows/scala.yml)
[](https://discord.gg/S9Ad88t)
Phobos is an XML data-binding library based on stream parsing.
It depends only on [aalto-xml](https://github.com/FasterXML/aalto-xml/) for parsing.
Scala 2.12, 2.13 and 3 are supported. See [Supported Scala versions](#supported-scala-versions) for more details.
If you find Phobos useful, please consider giving it a star! ⭐
## QuickStart
Add phobos-core to your dependencies:
```
libraryDependencies += "dev.valentiay" %% "phobos-core" % "0.29.0"
```
Then try this code out in `sbt console` or in a separate source file:
```scala
import phobos.decoding._
import phobos.encoding._
import phobos.syntax._
import phobos.derivation.semiauto._
case class TravelPoint(country: String, city: String)
object TravelPoint {
implicit val travelPointElementEncoder: ElementEncoder[TravelPoint] = deriveElementEncoder
implicit val travelPointElementDecoder: ElementDecoder[TravelPoint] = deriveElementDecoder
}
case class Price(@attr currency: String, @text value: Double)
object Price {
implicit val priceElementEncoder: ElementEncoder[Price] = deriveElementEncoder
implicit val priceElementDecoder: ElementDecoder[Price] = deriveElementDecoder
}
case class Journey(price: Price, departure: TravelPoint, arrival: TravelPoint)
object Journey {
implicit val journeyXmlEncoder: XmlEncoder[Journey] = deriveXmlEncoder("journey")
implicit val journeyXmlDecoder: XmlDecoder[Journey] = deriveXmlDecoder("journey")
}
val journey =
Journey(
price = Price("EUR", 1000.0),
departure = TravelPoint("France", "Marcelle"),
arrival = TravelPoint("Germany", "Munich")
)
val xml = XmlEncoder[Journey].encode(journey)
println(xml)
val decodedJourney = xml.flatMap(XmlDecoder[Journey].decode(_))
println(decodedJourney)
assert(Right(journey) == decodedJourney)
```
Please see [phobos wiki](https://github.com/Tinkoff/phobos/wiki) for explanation of the syntax and more details.
## Performance
Performance details can be found out in [phobos-benchmark repository](https://github.com/valentiay/phobos-benchmark).
## Modules
There are several additional modules for some specific cases.
These modules could be added with command below:
```
libraryDependencies += "dev.valentiay" %% "phobos-" % "0.29.0"
```
Where `` is module name.
| Module name | Functionality |
|-------------|----------------|
| ast | Support for parsing XML into AST |
| akka-http | Marshallers and unmarshallers for [akka-http](https://doc.akka.io/docs/akka-http/current/) |
| akka-stream | Streaming decoding support for [akka-stream](https://doc.akka.io/docs/akka/current/stream/index.html)|
| cats | Cats instances |
| derevo | Separate derivation of encoders and decoders separately using [derevo](https://github.com/manatki/derevo) annotations (e.g. `@derive(xmlEncoder("foo"))`)|
| enumeratum | Support for [enumeratum](https://github.com/lloydmeta/enumeratum#manual-override-of-name) enums |
| fs2 | Streaming decoding support (`Stream[F, Array[Byte]] => G[A]`). Latest fs2 version (fs2 `3.x`, cats effect `3.x`) |
| fs2-ce2 | Streaming decoding support (`Stream[F, Array[Byte]] => G[A]`). Same as fs2 module, but for fs2 version `2.x` using cats effect `2.x` |
| monix | Streaming decoding support (`Observable[Array[Byte]] => Task[A]`) |
| refined | Support for [refined](https://github.com/fthomas/refined) |
## Supported Scala versions
Most modules support Scala 2.12, 2.13 and 3.
Dependencies for some modules don't support Scala 3, thus these modules support only Scala 2.x.
Detailed information about supported Scala versions is in the table below. Available versions for modules are marked with ✓.
| Module name | 2.12 | 2.13 | 3 |
|-------------|------|------|---|
| core | ✓ | ✓ | ✓ |
| akka-http | ✓ | ✓ | |
| akka-stream | ✓ | ✓ | ✓ |
| ast | ✓ | ✓ | |
| cats | ✓ | ✓ | ✓ |
| derevo | ✓ | ✓ | |
| enumeratum | ✓ | ✓ | ✓ |
| fs2 | ✓ | ✓ | ✓ |
| fs2-ce2 | ✓ | ✓ | ✓ |
| monix | ✓ | ✓ | ✓ |
| refined | ✓ | ✓ | |