msgpack/msgpack-scala

MessagePack serializer implementation for Scala / msgpack.org[Scala]

MessagePack for Scala

• Message Pack specification: https://github.com/msgpack/msgpack/blob/master/spec.md

Quick Start

libraryDependencies += "org.msgpack" %% "msgpack-scala" % "(version)"

General usage is the same with msgpack-java. See this example code (Java).

For MessagePack Developers

Basic sbt commands

Enter the sbt console:

$ ./sbt

Here is a list of sbt commands for daily development:

> ~compile                                 # Compile source codes
> ~test:compile                            # Compile both source and test codes
> ~test                                    # Run tests upon source code change
> ~test-only *MessagePackTest              # Run tests in the specified class
> ~test-only *MessagePackTest -- -n prim   # Run the test tagged as "prim"
> project msgpack-scala                    # Focus on a specific project
> package                                  # Create a jar file in the target folder of each project
> scalafmt                                 # Reformat source codes
> ; coverage; test; coverageReport; coverageAggregate;  # Code coverage

Publishing

> publishLocal            # Install to local .ivy2 repository
> publish                 # Publishing a snapshot version to the Sonatype repository

> release                 # Run the release procedure (set a new version, run tests, upload artifacts, then deploy to Sonatype)

For publishing to Maven central, msgpack-scala uses sbt-sonatype plugin. Set Sonatype account information (user name and password) in the global sbt settings. To protect your password, never include this file in your project.

$HOME/.sbt/(sbt-version)/sonatype.sbt

credentials += Credentials("Sonatype Nexus Repository Manager",
        "oss.sonatype.org",
        "(Sonatype user name)",
        "(Sonatype password)")

msgpack-scala's Issues

scala 2.10?

would it be possible to compile this for scala 2.10?

Build failure by missing artifact org.msgpack:msgpack:jar:0.6.7-SNAPSHOT in msgpack.org

I tried to do "maven test", but failed. Log is as follows:

$ mvn test 

[INFO] ------------------------------------------------------------------------
[INFO] BUILD FAILURE
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 56.012s
[INFO] Finished at: Sun Jan 06 23:07:17 JST 2013
[INFO] Final Memory: 5M/81M
[INFO] ------------------------------------------------------------------------
[ERROR] Failed to execute goal on project msgpack-scala_2.9.1: Could not resolve dependencies for project org.msgpack:msgpack-scala_2.9.1:jar:0.6.7-SNAPSHOT: Could not find artifact org.msgpack:msgpack:jar:0.6.7-SNAPSHOT in msgpack.org (http://msgpack.org/maven2/) -> [Help 1]
[ERROR] 
[ERROR] To see the full stack trace of the errors, re-run Maven with the -e switch.
[ERROR] Re-run Maven using the -X switch to enable full debug logging.
[ERROR] 
[ERROR] For more information about the errors and possible solutions, please read the following articles:
[ERROR] [Help 1] http://cwiki.apache.org/confluence/display/MAVEN/DependencyResolutionException

Scala 2.10 support

Title says it all. It would be nice to have a 2.10 version
(some of the APIs around reflection have changed e.g. manifest.erasure is deprecated)

deserialize by msgpack-c

Can I deserialize the data, which serialized by msgpack-scala, by msgpack-c ?

Quick start not found

http://wiki.msgpack.org/display/MSGPACK/QuickStart+for+Scala

Gives a 404.

Support Nothing

I have a case-class that has this field: rank: Option[Int] = None,

And MessagePack reports: Cannot find template for class scala.runtime.Nothing

Pure Scala msgpack

I'm now prototyping pure-scala implementation of msgpack for supporting Scala, Scala.js, and Scala.native:
wvlet/airframe#127

Basic ideas for the implementation is as follows:

• Having SPI for providing interfaces for implementing MessagePack based codec (unpackXXX, packXXX). This will be useful if you need to implement MessagePack based object serizliation/deserialization code.
• Remove performance specific optimization in msgpack-java (e.g., MessageBuffer)
• Use simpler Value classes (e.g., Integer, Float, String, Array, Map, etc.) suited to Scala case classes. msgpack-java needed to use complex interface hierarchies to support immutable classes. I want to remove this complexity.

Synchronize with msgpack java artifact 0.7.1

Do you plan to release a version targeting the msgpack java artifact 0.7.1 ?

Improve case class support

As reported here (http://taka7646.hatenablog.com/entry/2013/02/17/005658) case classes need an explicit constructor in order to remove the exception "Can't find plain constructor or companion object".

Is this really needed f? Maybe for performance concerns ?

Other related issue: should it be possible to deserialize immutable fields (val) ?

Failed to work Quick Start sample No. 2

Hi,

I tried to work sample program No.2, Use in normal way, at QuickStart page with scala 2.9.1 and msgpack-scala 0.6.6, but failed. The log output is is here.

Could you tell me if I miss some points?

Thanks,
Tsuyoshi

readArrayBegin in org.msgpack.template.builder.ScalaBuildContext#buildReadMethodBody

It might not be an issue but part of my misunderstanding of the problem.

Let me explain it before I comment the title.

I'm trying to read into a class A which has 2 fields, let's say

class A {
  var a:String
  var b:String
}

I've written a serialization of such event in a file, that I'll try to read like this:

    val openStream: InputStream = new URL("file:///temp/test").openStream()
    var events = ScalaMessagePack.read[Event](openStream)

    println(events)

And here is what I got:

Expected array, but got map value
org.msgpack.MessageTypeException: Expected array, but got map value
    at org.msgpack.unpacker.Accept.acceptMap(Accept.java:93)
    at org.msgpack.unpacker.MessagePackUnpacker.readOneWithoutStack(MessagePackUnpacker.java:132)
    at org.msgpack.unpacker.MessagePackUnpacker.readOne(MessagePackUnpacker.java:73)

This happen because the method referred in the title is always calling readArrayBegin at the start of the read. However, it look like the binary file I've written based on write is not writing an array but a map.
However, if I readAsValue the file, it will work by resulting a MapValue...

Is there something I miss, or is it a bug (which I don't believe).

Thanks for you help

can't resolve dependencies

Used to work, but now getting this exception:

sbt.ResolveException: unresolved dependency: org.msgpack#msgpack-scala_2.10;0.8.13: not found
	at sbt.IvyActions$.sbt$IvyActions$$resolve(IvyActions.scala:291)
	at sbt.IvyActions$$anonfun$updateEither$1.apply(IvyActions.scala:188)
	at sbt.IvyActions$$anonfun$updateEither$1.apply(IvyActions.scala:165)
	at sbt.IvySbt$Module$$anonfun$withModule$1.apply(Ivy.scala:155)
	at sbt.IvySbt$Module$$anonfun$withModule$1.apply(Ivy.scala:155)
	at sbt.IvySbt$$anonfun$withIvy$1.apply(Ivy.scala:132)
	at sbt.IvySbt.sbt$IvySbt$$action$1(Ivy.scala:57)
	at sbt.IvySbt$$anon$4.call(Ivy.scala:65)
	at xsbt.boot.Locks$GlobalLock.withChannel$1(Locks.scala:93)
	at xsbt.boot.Locks$GlobalLock.xsbt$boot$Locks$GlobalLock$$withChannelRetries$1(Locks.scala:78)
	at xsbt.boot.Locks$GlobalLock$$anonfun$withFileLock$1.apply(Locks.scala:97)
	at xsbt.boot.Using$.withResource(Using.scala:10)
	at xsbt.boot.Using$.apply(Using.scala:9)
	at xsbt.boot.Locks$GlobalLock.ignoringDeadlockAvoided(Locks.scala:58)
	at xsbt.boot.Locks$GlobalLock.withLock(Locks.scala:48)
	at xsbt.boot.Locks$.apply0(Locks.scala:31)
	at xsbt.boot.Locks$.apply(Locks.scala:28)
	at sbt.IvySbt.withDefaultLogger(Ivy.scala:65)
	at sbt.IvySbt.withIvy(Ivy.scala:127)
	at sbt.IvySbt.withIvy(Ivy.scala:124)
	at sbt.IvySbt$Module.withModule(Ivy.scala:155)
	at sbt.IvyActions$.updateEither(IvyActions.scala:165)
	at sbt.Classpaths$$anonfun$sbt$Classpaths$$work$1$1.apply(Defaults.scala:1369)
	at sbt.Classpaths$$anonfun$sbt$Classpaths$$work$1$1.apply(Defaults.scala:1365)
	at sbt.Classpaths$$anonfun$doWork$1$1$$anonfun$87.apply(Defaults.scala:1399)
	at sbt.Classpaths$$anonfun$doWork$1$1$$anonfun$87.apply(Defaults.scala:1397)
	at sbt.Tracked$$anonfun$lastOutput$1.apply(Tracked.scala:37)
	at sbt.Classpaths$$anonfun$doWork$1$1.apply(Defaults.scala:1402)
	at sbt.Classpaths$$anonfun$doWork$1$1.apply(Defaults.scala:1396)
	at sbt.Tracked$$anonfun$inputChanged$1.apply(Tracked.scala:60)
	at sbt.Classpaths$.cachedUpdate(Defaults.scala:1419)
	at sbt.Classpaths$$anonfun$updateTask$1.apply(Defaults.scala:1348)
	at sbt.Classpaths$$anonfun$updateTask$1.apply(Defaults.scala:1310)
	at scala.Function1$$anonfun$compose$1.apply(Function1.scala:47)
	at sbt.$tilde$greater$$anonfun$$u2219$1.apply(TypeFunctions.scala:40)
	at sbt.std.Transform$$anon$4.work(System.scala:63)
	at sbt.Execute$$anonfun$submit$1$$anonfun$apply$1.apply(Execute.scala:226)
	at sbt.Execute$$anonfun$submit$1$$anonfun$apply$1.apply(Execute.scala:226)
	at sbt.ErrorHandling$.wideConvert(ErrorHandling.scala:17)
	at sbt.Execute.work(Execute.scala:235)
	at sbt.Execute$$anonfun$submit$1.apply(Execute.scala:226)
	at sbt.Execute$$anonfun$submit$1.apply(Execute.scala:226)
	at sbt.ConcurrentRestrictions$$anon$4$$anonfun$1.apply(ConcurrentRestrictions.scala:159)
	at sbt.CompletionService$$anon$2.call(CompletionService.scala:28)
	at java.util.concurrent.FutureTask.run(FutureTask.java:266)
	at java.util.concurrent.Executors$RunnableAdapter.call(Executors.java:511)
	at java.util.concurrent.FutureTask.run(FutureTask.java:266)
	at java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1149)
	at java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:624)
	at java.lang.Thread.run(Thread.java:748)
[error] (redis/*:update) sbt.ResolveException: unresolved dependency: org.msgpack#msgpack-scala_2.10;0.8.13: not found

ClassCastError when use ArrayBuffer

import org.msgpack.annotation.Message
import org.msgpack.ScalaMessagePack
import scala.collection.mutable

@Message
class A {
  var names: scala.collection.Seq[String] = Nil
}

object Main extends App {
  val a = new A()
  a.names = mutable.ArrayBuffer("a", "b")
  val serialized : Array[Byte] = ScalaMessagePack.write(a)
}

[error] (run-main-0) java.lang.ClassCastException: scala.collection.mutable.ArrayBuffer cannot be cast to scala.collection.immutable.List
java.lang.ClassCastException: scala.collection.mutable.ArrayBuffer cannot be cast to scala.collection.immutable.List
    at org.msgpack.template.ImmutableListTemplate.write(ImmutableListTemplate.scala:32)
    at org.msgpack.template.AbstractTemplate.write(AbstractTemplate.java:27)
    at A_$$_Template_1493359522_0.write(A_$$_Template_1493359522_0.java)
    at org.msgpack.template.AbstractTemplate.write(AbstractTemplate.java:27)
    at org.msgpack.MessagePack.write(MessagePack.java:196)
    at org.msgpack.ScalaMessagePackWrapper$class.write(ScalaMessagePack.scala:64)
    at org.msgpack.ScalaMessagePack$.write(ScalaMessagePack.scala:43)
    at Main$.delayedEndpoint$Main$1(Main.scala:13)
    at Main$delayedInit$body.apply(Main.scala:10)
    at scala.Function0$class.apply$mcV$sp(Function0.scala:40)
    at scala.runtime.AbstractFunction0.apply$mcV$sp(AbstractFunction0.scala:12)
    at scala.App$$anonfun$main$1.apply(App.scala:76)
    at scala.App$$anonfun$main$1.apply(App.scala:76)
    at scala.collection.immutable.List.foreach(List.scala:381)
    at scala.collection.generic.TraversableForwarder$class.foreach(TraversableForwarder.scala:35)
    at scala.App$class.main(App.scala:76)
    at Main$.main(Main.scala:10)
    at Main.main(Main.scala)
    at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
    at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:62)
    at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
    at java.lang.reflect.Method.invoke(Method.java:497)

Scala 2.11 support

Is scala 2.11 supported?