Merge branch 'release/0.3.2'

Conflicts:
	CHANGES.md
	README.md
	project/Build.scala

Author: Sam Ritchie

CHANGES.md

@@ -1,6 +1,16 @@
 # chill #
 
+### 0.3.2
+
+* Add a LocaleSerializer to chill-java: https://github.com/twitter/chill/pull/128
+* chill-akka module: https://github.com/twitter/chill/pull/116
+* Community section to README (with a mailing list!) https://github.com/twitter/chill/pull/127
+* SingletonSerializer for (): https://github.com/twitter/chill/pull/130
+* Add Externalizer (fault-tolerant meatlocker): https://github.com/twitter/chill/pull/126
+* Use References in Externalizer: https://github.com/twitter/chill/pull/131
+
 ### 0.3.1
+
 * Issue 115: fix for wrapped Arrays with non-primitives
 
 ### 0.3.0

README.md

@@ -1,7 +1,7 @@
 ## Chill [![Build Status](https://secure.travis-ci.org/twitter/chill.png)](http://travis-ci.org/twitter/chill)
 
 Extensions for the [Kryo serialization library](http://code.google.com/p/kryo/) including
-serializers and a set of classes to ease configuration of Kryo in systems like Hadoop, Storm, 
+serializers and a set of classes to ease configuration of Kryo in systems like Hadoop, Storm,
 Akka, etc.
 
 Chill has a set of subprojects: chill-java, chill-hadoop, chill-storm and chill-scala.  Other than
@@ -101,11 +101,8 @@ only scala serializers).  Chill provides support for singletons, scala Objects a
   * all 22 scala tuples
 
 ## Chill-bijection
-[Bijections and Injections](https://github.com/twitter/bijection)
-are useful when considering serialization. If you have an Injection from
-`T` to `Array[Byte]` you have a serialization.  Additionally, if you have a Bijection between `A`
-and `B`, and a serialization for `B`, then you have a serialization for `A`.  See
-`BijectionEnrichedKryo` for easy interop between bijection and chill.
+
+[Bijections and Injections](https://github.com/twitter/bijection) are useful when considering serialization. If you have an Injection from `T` to `Array[Byte]` you have a serialization.  Additionally, if you have a Bijection between `A` and `B`, and a serialization for `B`, then you have a serialization for `A`.  See `BijectionEnrichedKryo` for easy interop between bijection and chill.
 
 ### KryoInjection: easy serialization to byte Arrays
 
@@ -120,9 +117,37 @@ val tryDecode: scala.util.Try[Any] = KryoInjection.invert(bytes)
 
 KryoInjection can be composed with Bijections and Injections from `com.twitter.bijection`.
 
+## Chill-Akka
+
+To use, add a key to your config like:
+```
+    akka.actor.serializers {
+      kryo = "com.twitter.chill.akka.AkkaSerializer"
+    }
+```
+
+Then for the super-classes of all your message types, for instance, scala.Product, write:
+```scala
+   akka.actor.serialization-bindings {
+     "scala.Product" = kryo
+   }
+```
+
+If you want to use the `chill.config.ConfiguredInstantiator` see `ConfiguredAkkaSerializer`
+otherwise, subclass `AkkaSerializer` and override `kryoInstantiator` to control how the `Kryo`
+object is created.
+
+## Community and Documentation
+
+To learn more and find links to tutorials and information around the web, check out the [Chill Wiki](https://github.com/twitter/chill/wiki).
+
+The latest ScalaDocs are hosted on Chill's [Github Project Page](http://twitter.github.io/chill).
+
+Discussion occurs primarily on the [Chill mailing list](https://groups.google.com/forum/#!forum/chill-user). Issues should be reported on the [GitHub issue tracker](https://github.com/twitter/chill/issues).
+
 ## Maven
 
-Chill modules are available on Maven Central. The current groupid and version for all modules is, respectively, `"com.twitter"` and  `0.3.1`.
+Chill modules are available on Maven Central. The current groupid and version for all modules is, respectively, `"com.twitter"` and  `0.3.2`.
 
 Current published artifacts are
 
@@ -133,6 +158,8 @@ Current published artifacts are
 * `chill_2.10`
 * `chill-bijection_2.9.3`
 * `chill-bijection_2.10`
+* `chill-akka_2.9.3`
+* `chill-akka_2.10`
 
 The suffix denotes the scala version.
 

chill-akka/src/main/scala/com/twitter/chill/akka/ActorRefSerializer.scala

@@ -0,0 +1,55 @@
+package com.twitter.chill.akka
+/*******************************************************************************
+ * Copyright 2012 Roman Levenstein
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ ******************************************************************************/
+
+import akka.actor.ExtendedActorSystem
+import akka.actor.ActorRef
+import akka.serialization.Serialization
+import com.esotericsoftware.kryo.Kryo
+import com.esotericsoftware.kryo.Serializer
+import com.esotericsoftware.kryo.io.Input
+import com.esotericsoftware.kryo.io.Output
+
+/***
+ * This module provides helper classes for serialization of Akka-specific classes.
+ *
+ * @author Roman Levenstein
+ * @author P. Oscar Boykin
+ */
+
+import com.twitter.chill.{toRich, IKryoRegistrar}
+
+class ActorRefSerializer(system: ExtendedActorSystem) extends Serializer[ActorRef] with IKryoRegistrar {
+
+  def apply(kryo: Kryo): Unit = {
+    if(!kryo.alreadyRegistered(classOf[ActorRef])) {
+      kryo.forClass[ActorRef](this)
+      kryo.forSubclass[ActorRef](this)
+    }
+  }
+
+	override def read(kryo: Kryo, input: Input, typ: Class[ActorRef]): ActorRef = {
+		val path = input.readString()
+		system.actorFor(path)
+	}
+
+	override def write(kryo: Kryo, output: Output, obj: ActorRef) = {
+		Serialization.currentTransportAddress.value match {
+			case null => output.writeString(obj.path.toString)
+			case addr => output.writeString(obj.path.toStringWithAddress(addr))
+		}
+	}
+}

chill-akka/src/main/scala/com/twitter/chill/akka/AkkaConfig.scala

@@ -0,0 +1,40 @@
+/*
+Copyright 2013 Twitter, Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package com.twitter.chill.akka
+
+import com.twitter.chill.config.{Config => ChillConfig}
+import com.typesafe.config.{Config => TypesafeConfig}
+import com.typesafe.config.ConfigFactory
+
+import scala.util.Try
+
+/** Wraps the immutable typesafe.config.Config in a wrapper that
+ * keeps track of the state and follows the semantics of ChillConfig
+ */
+class AkkaConfig(var typesafeConfig: TypesafeConfig) extends ChillConfig {
+  /* This is implementing a Java API so that has an assy format */
+  def get(key: String) =
+    Try(typesafeConfig.getString(key)).toOption.orNull
+
+  def set(key: String, value: String) {
+    typesafeConfig = Option(value).map { v =>
+      ConfigFactory.parseString("%s = \"%s\"".format(key, v))
+        .withFallback(typesafeConfig)
+    }
+    .getOrElse(typesafeConfig.withoutPath(key))
+  }
+}

chill-akka/src/main/scala/com/twitter/chill/akka/AkkaSerializer.scala

@@ -0,0 +1,83 @@
+/*
+Copyright 2013 Twitter, Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package com.twitter.chill.akka
+
+import akka.actor.{ExtendedActorSystem, ActorRef}
+import akka.serialization.Serializer
+
+import com.twitter.chill._
+import com.twitter.chill.config.ConfiguredInstantiator
+
+/**
+ * To use, add a key to your config like:
+ *
+ * {{{
+ *
+ *    akka.actor.serializers {
+ *      kryo = "com.twitter.chill.akka.AkkaSerializer"
+ *    }
+ * }}}
+ *
+ * Then for the super-classes of all your message types,
+ *   for instance, scala.Product, write:
+ * {{{
+ *    akka.actor.serialization-bindings {
+ *      "scala.Product" = kryo
+ *    }
+ * }}}
+ *
+ * Kryo is not thread-safe so we use an object pool to avoid over allocating.
+ */
+class AkkaSerializer(system: ExtendedActorSystem) extends Serializer {
+
+  /** You can override this to easily change your serializers.
+   * If you do so, make sure to change the config to use the name of
+   * your new class
+   */
+  def kryoInstantiator: KryoInstantiator =
+    (new ScalaKryoInstantiator).withRegistrar(new ActorRefSerializer(system))
+
+  /**
+   * Since each thread only needs 1 Kryo, the pool doesn't need more
+   * space than the number of threads. We guess that there are 4 hyperthreads /
+   * core and then multiple by the nember of cores.
+   */
+  def poolSize: Int = {
+    val GUESS_THREADS_PER_CORE = 4
+    GUESS_THREADS_PER_CORE * Runtime.getRuntime.availableProcessors
+  }
+
+  val kryoPool: KryoPool =
+    KryoPool.withByteArrayOutputStream(poolSize, kryoInstantiator)
+
+  def includeManifest: Boolean = false
+  def identifier = 8675309
+  def toBinary(obj: AnyRef): Array[Byte] = kryoPool.toBytesWithClass(obj)
+  def fromBinary(bytes: Array[Byte], clazz: Option[Class[_]]): AnyRef =
+    kryoPool.fromBytes(bytes)
+}
+
+/** Uses the Config system of chill.config to Configure at runtime which KryoInstantiator to use
+ * Overriding kryoInstantiator and using your own class name is probably easier for most cases.
+ * See ConfiguredInstantiator static methods for how to build up a correct Config with
+ * your reflected or serialized instantiators.
+ */
+class ConfiguredAkkaSerializer(system: ExtendedActorSystem) extends AkkaSerializer(system) {
+  override def kryoInstantiator: KryoInstantiator =
+    (new ConfiguredInstantiator(new AkkaConfig(system.settings.config)))
+      .withRegistrar(new ActorRefSerializer(system))
+}

chill-akka/src/test/scala/com/twitter/chill/akka/AkkaTests.scala

@@ -0,0 +1,50 @@
+/*
+Copyright 2012 Twitter, Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package com.twitter.chill.akka
+
+import org.specs._
+
+import akka.actor.{ ActorRef, ActorSystem }
+import akka.serialization._
+import com.typesafe.config.ConfigFactory
+
+class AkkaTests extends Specification {
+
+  noDetailedDiffs() //Fixes issue for scala 2.9
+
+  val system = ActorSystem("example", ConfigFactory.parseString("""
+    akka.actor.serializers {
+      kryo = "com.twitter.chill.akka.AkkaSerializer"
+    }
+
+    akka.actor.serialization-bindings {
+      "scala.Product" = kryo
+      "akka.actor.ActorRef" = kryo
+    }
+"""))
+
+  // Get the Serialization Extension
+  val serialization = SerializationExtension(system)
+
+  "AkkaSerializer" should {
+    "be selected for tuples" in {
+      // Find the Serializer for it
+      val serializer = serialization.findSerializerFor((1,2,3))
+      serializer.getClass.equals(classOf[AkkaSerializer]) must beTrue
+    }
+  }
+}

chill-java/src/main/java/com/twitter/chill/java/LocaleSerializer.java

@@ -0,0 +1,37 @@
+/*
+Copyright 2013 Twitter, Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package com.twitter.chill.java;
+
+import com.esotericsoftware.kryo.Kryo;
+import com.esotericsoftware.kryo.serializers.JavaSerializer;
+import com.esotericsoftware.kryo.Serializer;
+import com.esotericsoftware.kryo.io.Input;
+import com.esotericsoftware.kryo.io.Output;
+
+import com.twitter.chill.IKryoRegistrar;
+import com.twitter.chill.SingleRegistrar;
+
+import java.util.Locale;
+
+/** The java serializer uses an cache of allocated instances so
+ * it is probably a bit hard to beat, so why bother
+ */
+public class LocaleSerializer extends JavaSerializer {
+   static public IKryoRegistrar registrar() {
+      return new SingleRegistrar(Locale.class, new LocaleSerializer());
+    }
+}

chill-java/src/main/java/com/twitter/chill/java/PackageRegistrar.java

@@ -38,6 +38,8 @@ static public IKryoRegistrar all() {
       TimestampSerializer.registrar(),
       URISerializer.registrar(),
       InetSocketAddressSerializer.registrar(),
-      UUIDSerializer.registrar());
+      UUIDSerializer.registrar(),
+      LocaleSerializer.registrar(),
+      SimpleDateFormatSerializer.registrar());
   }
 }