Add simpler server/profile methods to DSL

CHANGELOG

@@ -1,5 +1,8 @@
 vNEXT (in development)
 
+ * Improve DSL for creating an IrcClient to allow parameters to be passed to server and profile
+   e.g. IrcClient { server("irc.example.com", 6667) }
+
 v0.8.0
 
  * Added support for SCRAM-SHA-1 and SCRAM-SHA-256 SASL mechanisms

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

@@ -40,29 +40,58 @@ internal data class IrcClientConfig(val server: ServerConfig, val profile: Profi
 class IrcClientConfigBuilder {
 
     private var server: ServerConfig? = null
+        set(value) {
+            check(field == null) { "server may only be specified once" }
+            check(!value?.host.isNullOrEmpty()) { "server.host must be specified" }
+            field = value
+        }
+
     private var profile: ProfileConfig? = null
+        set(value) {
+            check(field == null) { "profile may only be specified once" }
+            check(!value?.nickname.isNullOrEmpty()) { "profile.nickname must be specified" }
+            field = value
+        }
+
     private var sasl: SaslConfig? = null
+        set(value) {
+            check(field == null) { "sasl may only be specified once" }
+            field = value
+        }
 
     /**
      * Configures the server that the IrcClient will connect to.
      *
-     * At a minimum, [ServerConfig.host] must be supplied.
+     * See [ServerConfig] for details of each parameter.
+     *
+     * @param block Optional additional configuration to apply to the [ServerConfig]
      */
     @IrcClientDsl
-    fun server(block: ServerConfig.() -> Unit) {
-        check(server == null) { "server may only be specified once" }
-        server = ServerConfig().apply(block).also { check(it.host.isNotEmpty()) { "server.host must be specified" } }
+    fun server(host: String? = null, port: Int? = null, useTls: Boolean? = null, password: String? = null, block: (ServerConfig.() -> Unit)? = null) {
+        server = ServerConfig().apply {
+            host?.let { this.host = it }
+            port?.let { this.port = it }
+            useTls?.let { this.useTls = it }
+            password?.let { this.password = it }
+            block?.let { apply(it) }
+        }
     }
 
     /**
      * Configures the profile of the IrcClient user.
      *
-     * At a minimum, [ProfileConfig.nickname] must be supplied.
+     * See [ProfileConfig] for details of each parameter.
+     *
+     * @param block Optional additional configuration to apply to the [ProfileConfig]
      */
     @IrcClientDsl
-    fun profile(block: ProfileConfig.() -> Unit) {
-        check(profile == null) { "profile may only be specified once" }
-        profile = ProfileConfig().apply(block).also { check(it.nickname.isNotEmpty()) { "profile.nickname must be specified" } }
+    fun profile(nickname: String? = null, username: String? = null, realName: String? = null, block: (ProfileConfig.() -> Unit)? = null) {
+        profile = ProfileConfig().apply {
+            nickname?.let { this.nickname = it }
+            username?.let { this.username = it }
+            realName?.let { this.realName = it }
+            block?.let { apply(it) }
+        }
     }
 
     /**
@@ -70,7 +99,6 @@ class IrcClientConfigBuilder {
      */
     @IrcClientDsl
     fun sasl(block: SaslConfig.() -> Unit) {
-        check(sasl == null) { "sasl may only be specified once" }
         sasl = SaslConfig().apply(block)
     }
 
@@ -143,7 +171,7 @@ class SaslConfig {
 
     @IrcClientDsl
     fun mechanisms(vararg methods: String) {
-        with (this.mechanisms) {
+        with(this.mechanisms) {
             clear()
             addAll(methods)
         }

src/test/kotlin/com/dmdirc/ktirc/DslTest.kt

@@ -26,6 +26,15 @@ internal class IrcClientConfigBuilderTest {
         }
     }
 
+    @Test
+    fun `throws if empty host is provided`() {
+        assertThrows<IllegalStateException> {
+            IrcClientConfigBuilder().apply {
+                server("")
+            }
+        }
+    }
+
     @Test
     fun `throws if profile is defined twice`() {
         assertThrows<IllegalStateException> {
@@ -45,6 +54,15 @@ internal class IrcClientConfigBuilderTest {
         }
     }
 
+    @Test
+    fun `throws if empty nickname is provided`() {
+        assertThrows<IllegalStateException> {
+            IrcClientConfigBuilder().apply {
+                profile("")
+            }
+        }
+    }
+
     @Test
     fun `throws if sasl is defined twice`() {
         assertThrows<IllegalStateException> {
@@ -91,6 +109,35 @@ internal class IrcClientConfigBuilderTest {
         assertTrue(config.server.useTls)
     }
 
+    @Test
+    fun `applies server settings with convenience function`() {
+        val config = IrcClientConfigBuilder().apply {
+            profile { nickname = "acidBurn" }
+            server("thegibson.com", 1337, true, "h4cktheplan3t")
+        }.build()
+
+        assertEquals("thegibson.com", config.server.host)
+        assertEquals(1337, config.server.port)
+        assertEquals("h4cktheplan3t", config.server.password)
+        assertTrue(config.server.useTls)
+    }
+
+    @Test
+    fun `applies server settings with convenience function and block`() {
+        val config = IrcClientConfigBuilder().apply {
+            profile { nickname = "acidBurn" }
+            server("thegibson.com", 1337) {
+                password = "h4cktheplan3t"
+                useTls = true
+            }
+        }.build()
+
+        assertEquals("thegibson.com", config.server.host)
+        assertEquals(1337, config.server.port)
+        assertEquals("h4cktheplan3t", config.server.password)
+        assertTrue(config.server.useTls)
+    }
+
     @Test
     fun `applies profile settings`() {
         val config = IrcClientConfigBuilder().apply {
@@ -107,6 +154,32 @@ internal class IrcClientConfigBuilderTest {
         assertEquals("Kate", config.profile.realName)
     }
 
+    @Test
+    fun `applies profile settings with convenience function`() {
+        val config = IrcClientConfigBuilder().apply {
+            profile("acidBurn", "acidB", "Kate")
+            server { host = "thegibson.com" }
+        }.build()
+
+        assertEquals("acidBurn", config.profile.nickname)
+        assertEquals("acidB", config.profile.username)
+        assertEquals("Kate", config.profile.realName)
+    }
+
+    @Test
+    fun `applies profile settings with convenience function and block`() {
+        val config = IrcClientConfigBuilder().apply {
+            profile("acidBurn", "acidB") {
+                realName = "Kate"
+            }
+            server { host = "thegibson.com" }
+        }.build()
+
+        assertEquals("acidBurn", config.profile.nickname)
+        assertEquals("acidB", config.profile.username)
+        assertEquals("Kate", config.profile.realName)
+    }
+
     @Test
     fun `applies sasl settings`() {
         val config = IrcClientConfigBuilder().apply {