make your JSON look good in those skinny jeans
Scala
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
notes
project
src
.gitignore
LICENSE
README.md
build.sbt

README.md

json slim Coverage Status

make your JSON look good in those skinny jeans

Json slim trims your JSON of unwanted adornments and attributes.

Install

using sbt add the following to your build definition

resolvers += "softprops-bintray" at "http://dl.bintray.com/softprops/maven"

libraryDependencies += "com.meetup" % "json-slim" % "0.1.1"

or if you are using ls-sbt

just do

ls-install json-slim

usage

jsonslim provides a way to negotiate the presence ( or absence ) of properties within JSON-encoded objects. The vocabulary for doing is comprised to operations: only and omit. You can ask for only a set of attributes or, if you are feeling more conservative, you can ask to omit attributes.

paths

Target attributes of JSON-encoded object are referenced by simple . delimited strings which represent traversable paths to the attribute.

a.b.c will target the json field c of field b of field a. You may provide multiple paths for each operation. Only takes precedence over omit. If you ask for "only" a subset of fields, the "omit" will only apply to that subset.

example

Assume you have given the following JSON-encoded object

{
  "people": [{
    "name": "bill",
    "age": 30,
    "titles":["foo", "bar"]
  }]
}

Let's say you don't care for titles. Omit them with

jsonslim.Trim.omit("people.titles")(jsonStr) // Some({"people":[{"name":"bill","age":30}]})

Let's say you only want the names of people. Include only names with

jsonslim.Trim.only("people.name")(jsonStr) // Some({"people":[{"name":"bill"}]})

inputs

A Trim is an exported function that you can assign and apply to multiple inputs. Inputs for a Trim are defined as the following typeclass jsonslim.Src[T].

trait Src[T] {
  def apply(a: T): Option[JValue]
  def unapply(jv: JValue): T
}

A Src[T] needs a way to be lifted into an org.json4s.JValue, the intermediary format used to manipulate the JSON ast, and a way to go from an org.json4s.JValue back into type T. Since the lifting into a JValue may not be possible, failure may be represented as None. Src conversions for Strings and direct JVaules are provided. If you use an alternative type representation of JSON you will need to bring an implicit implementation of a Src into scope.

combining operations

You can also combine multiple attribute paths for each operation for a slim party

val trim = jsonslim.Trim.only("people.name", "foo.bar")
                        .omit("people.titles", "baz.boom")
val slim = jsonDocuments.map(trim(_)).flatten

Authors

License

Copyright 2013 Meetup inc

Licensed under MIT