core

License	MIT
GroupId	com.tkroman
ArtifactId	core_2.12
Last Version	0.0.1
Release Date	Mar 6, 2017
Type	jar
Description	core core
Project URL	http://github.com/tkroman/micromarshal
Project Organization	com.tkroman
Source Code Management	https://github.com/tkroman/micromarshal

Download core_2.12

Filename	Size
core_2.12-0.0.1.pom
core_2.12-0.0.1.jar	60 KB
core_2.12-0.0.1-sources.jar	1 KB
core_2.12-0.0.1-javadoc.jar	189 bytes

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/com.tkroman/core_2.12/ -->
<dependency>
    <groupId>com.tkroman</groupId>
    <artifactId>core_2.12</artifactId>
    <version>0.0.1</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/com.tkroman/core_2.12/
implementation 'com.tkroman:core_2.12:0.0.1'

Gradle Kotlin

// https://jarcasting.com/artifacts/com.tkroman/core_2.12/
implementation ("com.tkroman:core_2.12:0.0.1")

Apache Buildr

'com.tkroman:core_2.12:jar:0.0.1'

Apache Ivy

<dependency org="com.tkroman" name="core_2.12" rev="0.0.1">
  <artifact name="core_2.12" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='com.tkroman', module='core_2.12', version='0.0.1')
)

Scala SBT

libraryDependencies += "com.tkroman" % "core_2.12" % "0.0.1"

Leiningen

[com.tkroman/core_2.12 "0.0.1"]

Dependencies

compile (2)

Group / Artifact	Type	Version
org.typelevel : scala-library	jar	2.12.1
com.tkroman : macros_2.12	jar	0.0.1

Project Modules

There are no modules declared in this project.

micromarshal

Autoderivation of Akka-HTTP marshallers/unmarshallers with uPickle in < 200 LOC.

Usage

Dependency

Very much beta. Cross-build for scala 2.11/2.12.

"com.tkroman" %% "micromarshal" % "0.0.8"

In order to expand macro annotations client projects should also have these options enabled:

lazy val expandMacroAnnotations: Seq[Def.Setting[_]] = Seq(
  addCompilerPlugin(
    ("org.scalameta" % "paradise" % "3.0.0-M7").cross(CrossVersion.full)
  ),

  libraryDependencies +=
    "org.scalameta" %% "scalameta" % "1.6.0" % Provided,

  scalacOptions += "-Xplugin-require:macroparadise",

  // macroparadise plugin doesn't work in repl yet.
  scalacOptions in (Compile, console) := Seq(),

  // macroparadise doesn't work with scaladoc yet.
  sources in (Compile, doc) := Nil
)

Code

Full example in tests

In short: just slap @com.tkroman.micromarshal.deriveAkkaMarshalling on your case class or sealed trait to get an automatic upickle-powered JSON encoding/decoding support + Akka HTTP (un)marshallers.

import com.tkroman.micromarshal.deriveAkkaMarshalling

@deriveAkkaMarshalling
case class Foo(str: String)

so later in your Akka-HTTP router you can do this:

get {
  path("foo") {
    complete(Foo("content"))
  }
}

Hygiene

Micromarshal does not rely on generation of fresh names and does not employ typechecking of any kind to ensure that companion objects of classes already contain implicit ReadWriter definitions.

Instead, there is a simple convention: if the companion object contains a definition of type upickle.default.ReadWriter[A] (or custom.pickler.ReadWriter[A]), no ReadWriter implicit is generated. This might come in handy when a need arises to manually define and instance for a sealed hierarchy.

Custom (un)picklers

Consistently with uPickle, deriveAkkaMarshalling accepts a custom pickler. For example:

package a.b.c

object CustomPickler extends upickle.AttributeTagged {
  // custom pickling here
}

@deriveAkkaMarshalling("a.b.c.OptionPickler")
case class Foo(x: Int)

TODO

• Abstraction over JSON library (would like to support circe)

Versions

Version
0.0.1 Mar 6, 2017