jdaviderb / ditto-serializer

a simple DSL for json serialization

My motivation to build this library is because I didn't find a great library for JSON Serialization in Scala as ActiveModel::Serializer or fast_jsonapi so I thought, why not to build a pretty DSL for JSON Serialization in this great language?

_{Built with ❤︎ by jdavierb}

🔥 Features

• ❤️ DSL similar to Active Model Serializer, Netflix Fast JSON API
• ✅ Support encoders for JSON Serialization like Circle, Spray
• 👋 Easy to test

📜 Table of Contents

• Installation
• Usage
  • DSL
  • Model Definition
  • Serializer Definition
• JSON Serialization
  • Using circle
  • Using spray-json

Installation

If you use SBT you can add ditto-serializer in your project with

externalResolvers += "ditto-serializer" at "https://maven.pkg.github.com/jdaviderb/ditto-serializer"

libraryDependencies += "jdaviderb" %% "ditto-serializer" % "0.5"

DSL

Ditto serializer is very simple we only have 3 helpers in our API for build JSON

1. attribute[T]: this helper append to field to the JSON Object
2. list: this helper returns a new instance of DittoList (Array) you can add new a element using the method add example: list.add("new item")
3. map: this helper returns a new instance of DittoMap [JsonObject] you can add a new (key, value) using the method set example: map.set("key", "value")

Model Definition

case class User(firstName: String, lastName: String)

Serializer Definitation

import org.jdaviderb.dittoSerializer.core.Serializer

class UserSerializer(val user: User) extends Serializer {
  attribute("name") { user.firstName }
  attribute("last_name") { user.lastName }
  attribute("full_name") { s"${user.firstName} ${user.lastName}" }
}

_{Complex Example}

JSON Serialization

Using Circle

if you want to use Circle for JSON Serialization, you have to add this package in your project

externalResolvers += "ditto-circle" at "https://maven.pkg.github.com/jdaviderb/ditto-circle"

libraryDependencies += "jdaviderb" %% "ditto-circle" % "0.5"

Example:

import org.jdaviderb.DittoCircle.Enconder
import org.jdaviderb.dittoSerializer.core.Serializer

// Model definition
case class User(firstName: String, lastName: String)

// Serializer
class UserSerializer(val user: User) extends Serializer {
  attribute("name") { user.firstName }
  attribute("last_name") { user.lastName }
  attribute("full_name") { s"${user.firstName} ${user.lastName}" }
}

// JSON Serialization
val jorge = User("Jorge", "Hernandez")
val josue = User("Josue", "Hernandez")
val users = List(jorge, josue)

Enconder.from(new UserSerializer(jorge))
/*
  RESULT:
  {
    "full_name" : "Jorge Hernandez",
    "last_name" : "Hernandez",
    "name" : "Jorge"
  }
*/

Enconder.fromList(users.map(new UserSerializer(_)))
/*
  RESULT:
  [
    {
      "full_name" : "Jorge Hernandez",
      "last_name" : "Hernandez",
      "name" : "Jorge"
    },
    {
      "full_name" : "Josue Hernandez",
      "last_name" : "Hernandez",
      "name" : "Josue"
    }
  ]
*/

Using Spray

Pending

Using Json4s

Pending

Pending

• add more documentation
• add examples for tests
• support Json4s
• support Spray Json