Add some topic events (no state yet)

Move handlers to their own packages
Update JUnit

CHANGELOG

@@ -2,6 +2,7 @@ vNEXT (in development)
 
  * Added support for SCRAM-SHA-1 and SCRAM-SHA-256 SASL mechanisms
  * Added MotdLineReceived event
+ * (Internal) Move event handlers into their own package
 
 v0.7.0
 

build.gradle.kts

@@ -41,9 +41,9 @@ dependencies {
     implementation("io.ktor:ktor-network-tls:1.1.2")
 
     testImplementation("com.nhaarman.mockitokotlin2:mockito-kotlin:2.1.0")
-    testImplementation("org.junit.jupiter:junit-jupiter-api:5.3.2")
-    testImplementation("org.junit.jupiter:junit-jupiter-params:5.3.2")
-    testRuntime("org.junit.jupiter:junit-jupiter-engine:5.3.2")
+    testImplementation("org.junit.jupiter:junit-jupiter-api:5.4.0")
+    testImplementation("org.junit.jupiter:junit-jupiter-params:5.4.0")
+    testRuntime("org.junit.jupiter:junit-jupiter-engine:5.4.0")
 }
 
 java {
@@ -88,7 +88,7 @@ tasks {
     }
 
     withType<Wrapper> {
-        gradleVersion = "5.2"
+        gradleVersion = "5.2.1"
     }
 
     withType<KotlinCompile> {

src/main/kotlin/com/dmdirc/ktirc/IrcClientImpl.kt

@@ -1,6 +1,8 @@
 package com.dmdirc.ktirc
 
 import com.dmdirc.ktirc.events.*
+import com.dmdirc.ktirc.handlers.EventHandler
+import com.dmdirc.ktirc.handlers.eventHandlers
 import com.dmdirc.ktirc.io.KtorLineBufferedSocket
 import com.dmdirc.ktirc.io.LineBufferedSocket
 import com.dmdirc.ktirc.io.MessageHandler

src/main/kotlin/com/dmdirc/ktirc/events/Events.kt

@@ -54,6 +54,12 @@ class ChannelNamesReceived(time: LocalDateTime, val channel: String, val names:
 /** Raised when the entirety of the channel's member list has been received. */
 class ChannelNamesFinished(time: LocalDateTime, val channel: String) : IrcEvent(time)
 
+/** Raised when a channel topic is discovered (not changed). Usually followed by [ChannelTopicMetadataDiscovered]. */
+class ChannelTopicDiscovered(time: LocalDateTime, val channel: String, val topic: String) : IrcEvent(time)
+
+/** Raised when a channel topic's metadata is discovered. */
+class ChannelTopicMetadataDiscovered(time: LocalDateTime, val channel: String, val user: User, val setTime: LocalDateTime) : IrcEvent(time)
+
 /** Raised when a message is received. */
 class MessageReceived(time: LocalDateTime, val user: User, val target: String, val message: String, val messageId: String? = null) : IrcEvent(time)
 

src/main/kotlin/com/dmdirc/ktirc/events/CapabilitiesHandler.kt → src/main/kotlin/com/dmdirc/ktirc/handlers/CapabilitiesHandler.kt

@@ -1,6 +1,7 @@
-package com.dmdirc.ktirc.events
+package com.dmdirc.ktirc.handlers
 
 import com.dmdirc.ktirc.IrcClient
+import com.dmdirc.ktirc.events.*
 import com.dmdirc.ktirc.messages.sendAuthenticationMessage
 import com.dmdirc.ktirc.messages.sendCapabilityEnd
 import com.dmdirc.ktirc.messages.sendCapabilityRequest

src/main/kotlin/com/dmdirc/ktirc/events/ChannelStateHandler.kt → src/main/kotlin/com/dmdirc/ktirc/handlers/ChannelStateHandler.kt

@@ -1,6 +1,7 @@
-package com.dmdirc.ktirc.events
+package com.dmdirc.ktirc.handlers
 
 import com.dmdirc.ktirc.IrcClient
+import com.dmdirc.ktirc.events.*
 import com.dmdirc.ktirc.model.ChannelState
 import com.dmdirc.ktirc.model.ChannelUser
 import com.dmdirc.ktirc.util.logger

src/main/kotlin/com/dmdirc/ktirc/events/EventHandler.kt → src/main/kotlin/com/dmdirc/ktirc/handlers/EventHandler.kt

@@ -1,6 +1,7 @@
-package com.dmdirc.ktirc.events
+package com.dmdirc.ktirc.handlers
 
 import com.dmdirc.ktirc.IrcClient
+import com.dmdirc.ktirc.events.IrcEvent
 
 @FunctionalInterface
 internal interface EventHandler {

src/main/kotlin/com/dmdirc/ktirc/events/PingHandler.kt → src/main/kotlin/com/dmdirc/ktirc/handlers/PingHandler.kt

@@ -1,6 +1,8 @@
-package com.dmdirc.ktirc.events
+package com.dmdirc.ktirc.handlers
 
 import com.dmdirc.ktirc.IrcClient
+import com.dmdirc.ktirc.events.IrcEvent
+import com.dmdirc.ktirc.events.PingReceived
 import com.dmdirc.ktirc.messages.sendPong
 
 internal class PingHandler : EventHandler {

src/main/kotlin/com/dmdirc/ktirc/events/ServerStateHandler.kt → src/main/kotlin/com/dmdirc/ktirc/handlers/ServerStateHandler.kt

@@ -1,6 +1,7 @@
-package com.dmdirc.ktirc.events
+package com.dmdirc.ktirc.handlers
 
 import com.dmdirc.ktirc.IrcClient
+import com.dmdirc.ktirc.events.*
 import com.dmdirc.ktirc.model.ServerState
 import com.dmdirc.ktirc.model.ServerStatus
 import java.time.LocalDateTime

src/main/kotlin/com/dmdirc/ktirc/events/UserStateHandler.kt → src/main/kotlin/com/dmdirc/ktirc/handlers/UserStateHandler.kt

@@ -1,6 +1,7 @@
-package com.dmdirc.ktirc.events
+package com.dmdirc.ktirc.handlers
 
 import com.dmdirc.ktirc.IrcClient
+import com.dmdirc.ktirc.events.*
 import com.dmdirc.ktirc.model.UserState
 
 internal class UserStateHandler : EventHandler {
@@ -10,7 +11,7 @@ internal class UserStateHandler : EventHandler {
             is ChannelJoined -> handleJoin(client.userState, event)
             is ChannelParted -> handlePart(client, event)
             is ChannelUserKicked -> handleKick(client, event)
-            is ChannelNamesReceived  -> handleNamesReceived(client, event)
+            is ChannelNamesReceived -> handleNamesReceived(client, event)
             is UserAccountChanged -> handleAccountChanged(client, event)
             is UserNickChanged -> handleNickChanged(client, event)
             is UserQuit -> handleQuit(client.userState, event)

src/main/kotlin/com/dmdirc/ktirc/io/MessageHandler.kt

@@ -1,7 +1,7 @@
 package com.dmdirc.ktirc.io
 
 import com.dmdirc.ktirc.IrcClient
-import com.dmdirc.ktirc.events.EventHandler
+import com.dmdirc.ktirc.handlers.EventHandler
 import com.dmdirc.ktirc.events.IrcEvent
 import com.dmdirc.ktirc.messages.MessageProcessor
 import com.dmdirc.ktirc.model.IrcMessage

src/main/kotlin/com/dmdirc/ktirc/messages/MessageProcessor.kt

@@ -32,6 +32,7 @@ internal val messageProcessors = setOf(
         PartProcessor(),
         PingProcessor(),
         PrivmsgProcessor(),
+        TopicProcessor(),
         QuitProcessor(),
         WelcomeProcessor()
 )

src/main/kotlin/com/dmdirc/ktirc/messages/NumericConstants.kt

@@ -8,6 +8,8 @@ internal const val RPL_ISUPPORT = "005"
 internal const val RPL_UMODEIS = "221"
 
 internal const val RPL_CHANNELMODEIS = "324"
+internal const val RPL_TOPIC = "332"
+internal const val RPL_TOPICWHOTIME = "333"
 internal const val RPL_MOTD = "372"
 internal const val RPL_MOTDSTART = "375"
 internal const val RPL_ENDOFMOTD = "376"

src/main/kotlin/com/dmdirc/ktirc/messages/TopicProcessor.kt

@@ -0,0 +1,29 @@
+package com.dmdirc.ktirc.messages
+
+import com.dmdirc.ktirc.events.ChannelTopicDiscovered
+import com.dmdirc.ktirc.events.ChannelTopicMetadataDiscovered
+import com.dmdirc.ktirc.model.IrcMessage
+import com.dmdirc.ktirc.model.asUser
+import com.dmdirc.ktirc.util.currentTimeZoneProvider
+import java.time.Instant
+import java.time.LocalDateTime
+
+internal class TopicProcessor : MessageProcessor {
+
+    override val commands = arrayOf(RPL_TOPIC, RPL_TOPICWHOTIME)
+
+    override fun process(message: IrcMessage) = sequence {
+        when (message.command) {
+            RPL_TOPIC -> yield(ChannelTopicDiscovered(message.time, message.channel, String(message.params[2])))
+            RPL_TOPICWHOTIME -> yield(ChannelTopicMetadataDiscovered(
+                    message.time, message.channel, message.params[2].asUser(), message.topicSetTime))
+        }
+    }.toList()
+
+    private val IrcMessage.channel
+        get() = String(params[1])
+
+    private val IrcMessage.topicSetTime
+        get() = LocalDateTime.ofInstant(Instant.ofEpochSecond(String(params[3]).toLong()), currentTimeZoneProvider())
+
+}

src/test/kotlin/com/dmdirc/ktirc/events/CapabilitiesHandlerTest.kt → src/test/kotlin/com/dmdirc/ktirc/handlers/CapabilitiesHandlerTest.kt

@@ -1,7 +1,8 @@
-package com.dmdirc.ktirc.events
+package com.dmdirc.ktirc.handlers
 
 import com.dmdirc.ktirc.IrcClient
 import com.dmdirc.ktirc.TestConstants
+import com.dmdirc.ktirc.events.*
 import com.dmdirc.ktirc.model.CapabilitiesNegotiationState
 import com.dmdirc.ktirc.model.Capability
 import com.dmdirc.ktirc.model.ServerState

src/test/kotlin/com/dmdirc/ktirc/events/ChannelStateHandlerTest.kt → src/test/kotlin/com/dmdirc/ktirc/handlers/ChannelStateHandlerTest.kt

@@ -1,7 +1,8 @@
-package com.dmdirc.ktirc.events
+package com.dmdirc.ktirc.handlers
 
 import com.dmdirc.ktirc.IrcClient
 import com.dmdirc.ktirc.TestConstants
+import com.dmdirc.ktirc.events.*
 import com.dmdirc.ktirc.io.CaseMapping
 import com.dmdirc.ktirc.model.*
 import com.nhaarman.mockitokotlin2.doReturn

src/test/kotlin/com/dmdirc/ktirc/events/PingHandlerTest.kt → src/test/kotlin/com/dmdirc/ktirc/handlers/PingHandlerTest.kt

@@ -1,7 +1,8 @@
-package com.dmdirc.ktirc.events
+package com.dmdirc.ktirc.handlers
 
 import com.dmdirc.ktirc.IrcClient
 import com.dmdirc.ktirc.TestConstants
+import com.dmdirc.ktirc.events.PingReceived
 import com.nhaarman.mockitokotlin2.mock
 import com.nhaarman.mockitokotlin2.verify
 import kotlinx.coroutines.runBlocking

src/test/kotlin/com/dmdirc/ktirc/events/ServerStateHandlerTest.kt → src/test/kotlin/com/dmdirc/ktirc/handlers/ServerStateHandlerTest.kt

@@ -1,7 +1,8 @@
-package com.dmdirc.ktirc.events
+package com.dmdirc.ktirc.handlers
 
 import com.dmdirc.ktirc.IrcClient
 import com.dmdirc.ktirc.TestConstants
+import com.dmdirc.ktirc.events.*
 import com.dmdirc.ktirc.model.*
 import com.nhaarman.mockitokotlin2.doReturn
 import com.nhaarman.mockitokotlin2.mock

src/test/kotlin/com/dmdirc/ktirc/events/UserStateHandlerTest.kt → src/test/kotlin/com/dmdirc/ktirc/handlers/UserStateHandlerTest.kt

@@ -1,7 +1,8 @@
-package com.dmdirc.ktirc.events
+package com.dmdirc.ktirc.handlers
 
 import com.dmdirc.ktirc.IrcClient
 import com.dmdirc.ktirc.TestConstants
+import com.dmdirc.ktirc.events.*
 import com.dmdirc.ktirc.io.CaseMapping
 import com.dmdirc.ktirc.model.*
 import com.nhaarman.mockitokotlin2.argForWhich

src/test/kotlin/com/dmdirc/ktirc/io/MessageHandlerTest.kt

@@ -2,7 +2,7 @@ package com.dmdirc.ktirc.io
 
 import com.dmdirc.ktirc.IrcClient
 import com.dmdirc.ktirc.TestConstants
-import com.dmdirc.ktirc.events.EventHandler
+import com.dmdirc.ktirc.handlers.EventHandler
 import com.dmdirc.ktirc.events.ServerConnected
 import com.dmdirc.ktirc.events.ServerReady
 import com.dmdirc.ktirc.events.ServerWelcome

src/test/kotlin/com/dmdirc/ktirc/messages/TopicProcessorTest.kt

@@ -0,0 +1,49 @@
+package com.dmdirc.ktirc.messages
+
+import com.dmdirc.ktirc.TestConstants
+import com.dmdirc.ktirc.events.ChannelTopicDiscovered
+import com.dmdirc.ktirc.events.ChannelTopicMetadataDiscovered
+import com.dmdirc.ktirc.model.IrcMessage
+import com.dmdirc.ktirc.params
+import com.dmdirc.ktirc.util.currentTimeProvider
+import com.dmdirc.ktirc.util.currentTimeZoneProvider
+import org.junit.jupiter.api.Assertions.assertEquals
+import org.junit.jupiter.api.BeforeEach
+import org.junit.jupiter.api.Test
+import java.time.ZoneId
+
+internal class TopicProcessorTest {
+
+    private val processor = TopicProcessor()
+
+    @BeforeEach
+    fun setUp() {
+        currentTimeProvider = { TestConstants.time }
+    }
+
+    @Test
+    fun `raises ChannelTopicDiscovered event when topic is supplied`() {
+        val events = processor.process(IrcMessage(emptyMap(), null, "332", params("acidBurn", "#thegibson", "Hack the planet!")))
+        assertEquals(1, events.size)
+
+        val event = events[0] as ChannelTopicDiscovered
+        assertEquals(TestConstants.time, event.time)
+        assertEquals("#thegibson", event.channel)
+        assertEquals("Hack the planet!", event.topic)
+    }
+
+    @Test
+    fun `raises ChannelTopicMetadataDiscovered event when topic is supplied`() {
+        val events = processor.process(IrcMessage(emptyMap(), null, "333", params("acidBurn", "#thegibson", "zeroCool", unixtime(currentTimeZoneProvider()))))
+        assertEquals(1, events.size)
+
+        val event = events[0] as ChannelTopicMetadataDiscovered
+        assertEquals(TestConstants.time, event.time)
+        assertEquals("#thegibson", event.channel)
+        assertEquals("zeroCool", event.user.nickname)
+        assertEquals(TestConstants.time, event.setTime)
+    }
+
+    private fun unixtime(zoneId: ZoneId) = TestConstants.time.toEpochSecond(zoneId.rules.getOffset(TestConstants.time)).toString()
+
+}