Kotlinify and simplify a little bit the code (#23)

* Remove useless public modifier

* Set PhxMessage to a data class

* Improve PhxMessage documentation

* Simplify code

* Add empty line at end of file to be POSIX compliant

Author: eyal-lezmy

src/main/kotlin/org/phoenixframework/PhxChannel.kt

@@ -136,7 +136,7 @@ class PhxChannel(
      * @param timeout: Overrides the default timeout
      * @return Push which receive hooks can be applied to
      */
-    public fun join(joinParams: Payload? = null, timeout: Long? = null): PhxPush {
+    fun join(joinParams: Payload? = null, timeout: Long? = null): PhxPush {
         if (joinedOnce) {
             throw IllegalStateException("Tried to join channel multiple times. `join()` can only be called once per channel")
         }
@@ -156,7 +156,7 @@ class PhxChannel(
      * @param callback: Callback to be informed when the channel closes
      * @return the ref counter of the subscription
      */
-    public fun onClose(callback: (msg: PhxMessage) -> Unit): Int {
+    fun onClose(callback: (msg: PhxMessage) -> Unit): Int {
         return this.on(PhxEvent.CLOSE, callback)
     }
 
@@ -166,14 +166,14 @@ class PhxChannel(
      * @param callback: Callback to be informed when the channel errors
      * @return the ref counter of the subscription
      */
-    public fun onError(callback: (msg: PhxMessage) -> Unit): Int {
+    fun onError(callback: (msg: PhxMessage) -> Unit): Int {
         return this.on(PhxEvent.ERROR, callback)
     }
 
     /**
      * Convenience method to take the Channel.Event enum. Same as channel.on(string)
      */
-    public fun on(event: PhxChannel.PhxEvent, callback: (PhxMessage) -> Unit): Int {
+    fun on(event: PhxChannel.PhxEvent, callback: (PhxMessage) -> Unit): Int {
         return this.on(event.value, callback)
     }
 
@@ -195,7 +195,7 @@ class PhxChannel(
      * @param callback: Receives payload of the event
      * @return: The subscriptions ref counter
      */
-    public fun on(event: String, callback: (PhxMessage) -> Unit): Int {
+    fun on(event: String, callback: (PhxMessage) -> Unit): Int {
         val ref = bindingRef
         this.bindingRef = ref + 1
 
@@ -220,7 +220,7 @@ class PhxChannel(
      * @param event: Event to unsubscribe from
      * @param ref: Optional. Ref counter returned when subscribed to event
      */
-    public fun off(event: String, ref: Int? = null) {
+    fun off(event: String, ref: Int? = null) {
         // Remove any subscriptions that match the given event and ref ID. If no ref
         // ID is given, then remove all subscriptions for an event.
         if (ref != null) {
@@ -238,7 +238,7 @@ class PhxChannel(
      * @param timeout: Optional timeout. Default will be used
      * @return [PhxPush] that can be hooked into
      */
-    public fun push(event: String, payload: Payload, timeout: Long = DEFAULT_TIMEOUT): PhxPush {
+    fun push(event: String, payload: Payload, timeout: Long = DEFAULT_TIMEOUT): PhxPush {
         if (!joinedOnce) {
             // If the Channel has not been joined, throw an exception
             throw RuntimeException("Tried to push $event to $topic before joining. Use channel.join() before pushing events")
@@ -269,7 +269,7 @@ class PhxChannel(
      *
      * @param timeout: Optional timeout. Default will be used
      */
-    public fun leave(timeout: Long = DEFAULT_TIMEOUT): PhxPush {
+    fun leave(timeout: Long = DEFAULT_TIMEOUT): PhxPush {
         this.state = PhxState.LEAVING
 
         val onClose: ((PhxMessage) -> Unit) = {
@@ -297,7 +297,7 @@ class PhxChannel(
      * @param callback: Callback which will receive the inbound message before
      * it is dispatched to other callbacks. Must return a Message object.
      */
-    public fun onMessage(callback: (message: PhxMessage) -> PhxMessage) {
+    fun onMessage(callback: (message: PhxMessage) -> PhxMessage) {
         this.onMessage = callback
     }
 
@@ -380,4 +380,4 @@ class PhxChannel(
     /** @return: True if the channel has requested to leave */
     val isLeaving: Boolean
         get() = state == PhxState.LEAVING
-}
+}

src/main/kotlin/org/phoenixframework/PhxMessage.kt

@@ -2,20 +2,20 @@ package org.phoenixframework
 
 import com.google.gson.annotations.SerializedName
 
-class PhxMessage(
+data class PhxMessage(
         /** The unique string ref. Empty if not present */
         @SerializedName("ref")
         val ref: String = "",
 
-        /** Property "topic" is never used */
+        /** The message topic */
         @SerializedName("topic")
         val topic: String = "",
 
-        /** Property "topic" is never used */
+        /** The message event name, for example "phx_join" or any other custom name */
         @SerializedName("event")
         val event: String = "",
 
-        /** Property "topic" is never used */
+        /** The payload of the message */
         @SerializedName("payload")
         val payload: Payload = HashMap(),
 
@@ -30,10 +30,4 @@ class PhxMessage(
      */
     val status: String?
         get() = payload["status"] as? String
-
-
-    override fun toString(): String {
-        return "Message(ref='$ref', joinRef=$joinRef, topic='$topic', event='$event', payload=$payload)"
-    }
-
-}
+}

src/main/kotlin/org/phoenixframework/PhxPush.kt

@@ -138,9 +138,7 @@ class PhxPush(
      * in milliseconds is reached.
      */
     fun startTimeout() {
-        this.timeoutTimer?.let {
-            it.cancel()
-        }
+        this.timeoutTimer?.cancel()
 
         val ref = this.channel.socket.makeRef()
         this.ref = ref
@@ -191,4 +189,4 @@ class PhxPush(
             this.channel.trigger(message)
         }
     }
-}
+}

src/main/kotlin/org/phoenixframework/PhxSocket.kt

@@ -33,28 +33,28 @@ open class PhxSocket(
     // Public Attributes
     //------------------------------------------------------------------------------
     /** Timeout to use when opening connections */
-    public var timeout: Long = DEFAULT_TIMEOUT
+    var timeout: Long = DEFAULT_TIMEOUT
 
     /** Interval between sending a heartbeat */
-    public var heartbeatIntervalMs: Long = DEFAULT_HEARTBEAT
+    var heartbeatIntervalMs: Long = DEFAULT_HEARTBEAT
 
     /** Interval between socket reconnect attempts */
-    public var reconnectAfterMs: ((tries: Int) -> Long) = closure@{
+    var reconnectAfterMs: ((tries: Int) -> Long) = closure@{
         return@closure if (it >= 3) 100000 else longArrayOf(1000, 2000, 5000)[it]
     }
 
     /** Hook for custom logging into the client */
-    public var logger: ((msg: String) -> Unit)? = null
+    var logger: ((msg: String) -> Unit)? = null
 
     /** Disable sending Heartbeats by setting to true */
-    public var skipHeartbeat: Boolean = false
+    var skipHeartbeat: Boolean = false
 
     /**
      * Socket will attempt to reconnect if the Socket was closed. Will not
      * reconnect if the Socket errored (e.g. connection refused.) Default
      * is set to true
      */
-    public var autoReconnect: Boolean = true
+    var autoReconnect: Boolean = true
 
 
     //------------------------------------------------------------------------------
@@ -140,13 +140,13 @@ open class PhxSocket(
     // Public
     //------------------------------------------------------------------------------
     /** True if the Socket is currently connected */
-    public val isConnected: Boolean
+    val isConnected: Boolean
         get() = connection != null
 
     /**
      * Disconnects the Socket
      */
-    public fun disconnect() {
+    fun disconnect() {
         connection?.close(1000, null)
         connection = null
 
@@ -157,7 +157,7 @@ open class PhxSocket(
      * will be sent through the connection. If the Socket is already connected,
      * then this call will be ignored.
      */
-    public fun connect() {
+    fun connect() {
         // Do not attempt to reconnect if already connected
         if (isConnected) return
         connection = client.newWebSocket(request, this)
@@ -173,7 +173,7 @@ open class PhxSocket(
      *
      * @param callback: Callback to register
      */
-    public fun onOpen(callback: () -> Unit) {
+    fun onOpen(callback: () -> Unit) {
         this.onOpenCallbacks.add(callback)
     }
 
@@ -188,7 +188,7 @@ open class PhxSocket(
      *
      * @param callback: Callback to register
      */
-    public fun onClose(callback: () -> Unit) {
+    fun onClose(callback: () -> Unit) {
         this.onCloseCallbacks.add(callback)
     }
 
@@ -202,7 +202,7 @@ open class PhxSocket(
      *
      * @param callback: Callback to register
      */
-    public fun onError(callback: (Throwable?, Response?) -> Unit) {
+    fun onError(callback: (Throwable?, Response?) -> Unit) {
         this.onErrorCallbacks.add(callback)
     }
 
@@ -216,7 +216,7 @@ open class PhxSocket(
      *
      * @param callback: Callback to register
      */
-    public fun onMessage(callback: (PhxMessage) -> Unit) {
+    fun onMessage(callback: (PhxMessage) -> Unit) {
         this.onMessageCallbacks.add(callback)
     }
 
@@ -226,7 +226,7 @@ open class PhxSocket(
      * call this method when you are finished when the Socket in order to release
      * any references held by the socket.
      */
-    public fun removeAllCallbacks() {
+    fun removeAllCallbacks() {
         this.onOpenCallbacks.clear()
         this.onCloseCallbacks.clear()
         this.onErrorCallbacks.clear()
@@ -237,7 +237,7 @@ open class PhxSocket(
      * Removes the Channel from the socket. This does not cause the channel to inform
      * the server that it is leaving so you should call channel.leave() first.
      */
-    public fun remove(channel: PhxChannel) {
+    fun remove(channel: PhxChannel) {
         this.channels = channels
                 .filter { it.joinRef != channel.joinRef }
                 .toMutableList()
@@ -249,7 +249,7 @@ open class PhxSocket(
      * Example:
      *  val channel = socket.channel("rooms", params)
      */
-    public fun channel(topic: String, params: Payload? = null): PhxChannel {
+    fun channel(topic: String, params: Payload? = null): PhxChannel {
         val channel = PhxChannel(topic, params ?: HashMap(), this)
         this.channels.add(channel)
         return channel
@@ -258,14 +258,14 @@ open class PhxSocket(
     /**
      * Sends data through the Socket
      */
-    public open fun push(topic: String,
-                    event: String,
-                    payload: Payload,
-                    ref: String? = null,
-                    joinRef: String? = null) {
+    open fun push(topic: String,
+                  event: String,
+                  payload: Payload,
+                  ref: String? = null,
+                  joinRef: String? = null) {
 
         val callback: (() -> Unit) = {
-            var body: MutableMap<String, Any> = HashMap()
+            val body: MutableMap<String, Any> = HashMap()
             body["topic"] = topic
             body["event"] = event
             body["payload"] = payload
@@ -294,7 +294,7 @@ open class PhxSocket(
     /**
      * @return the next message ref, accounting for overflows
      */
-    public open fun makeRef(): String {
+    open fun makeRef(): String {
         val newRef = this.ref + 1
         this.ref = if (newRef == Int.MAX_VALUE) 0 else newRef
 

src/main/kotlin/org/phoenixframework/PhxTimer.kt

@@ -43,4 +43,4 @@ class PhxTimer(
         this.timer?.cancel()
         this.timer = null
     }
-}
+}

src/test/kotlin/org/phoenixframework/PhxChannelTest.kt

@@ -150,4 +150,3 @@ class PhxChannelTest {
         CompletableFuture.allOf(f1, f3).get(10, TimeUnit.SECONDS)
     }
 }
-

src/test/kotlin/org/phoenixframework/PhxMessageTest.kt

@@ -19,4 +19,4 @@ class PhxMessageTest {
         assertThat(message.status).isEqualTo("ok")
 
     }
-}
+}

src/test/kotlin/org/phoenixframework/PhxSocketTest.kt

@@ -36,4 +36,4 @@ class PhxSocketTest {
         assertThat(PhxSocket("wss://localhost:4000/socket/websocket", spacesParams).endpoint.toString())
                 .isEqualTo("https://localhost:4000/socket/websocket?user_id=1&token=abc%20123")
     }
-}
+}