Rename use-compression config option to enable-compression

Author: sirthias

src/main/scala/com/decodified/scalassh/HostConfig.scala

@@ -26,7 +26,7 @@ case class HostConfig(
   connectTimeout: Option[Int] = None,
   connectionTimeout: Option[Int] = None,
   commandTimeout: Option[Int] = None,
-  useCompression: Boolean = false,
+  enableCompression: Boolean = false,
   hostKeyVerifier: HostKeyVerifier = KnownHosts.right.toOption.getOrElse(DontVerify),
   sshjConfig: Config = HostConfig.DefaultSshjConfig
 )
@@ -46,7 +46,7 @@ abstract class FromStringsHostConfigProvider extends HostConfigProvider {
     optIntSetting("connect-timeout", settings, source).right.flatMap { connectTimeout =>
     optIntSetting("connection-timeout", settings, source).right.flatMap { connectionTimeout =>
     optIntSetting("command-timeout", settings, source).right.flatMap { commandTimeout =>
-    optBoolSetting("use-compression", settings, source).right.flatMap { useCompression =>
+    optBoolSetting("enable-compression", settings, source).right.flatMap { enableCompression =>
     setting("fingerprint", settings, source).right.map(forFingerprint).left.flatMap(_ => KnownHosts).right.map { verifier =>
     HostConfig(
       login,
@@ -55,7 +55,7 @@ abstract class FromStringsHostConfigProvider extends HostConfigProvider {
       connectTimeout = connectTimeout,
       connectionTimeout = connectionTimeout,
       commandTimeout = commandTimeout,
-      useCompression = useCompression.getOrElse(false),
+      enableCompression = enableCompression.getOrElse(false),
       hostKeyVerifier = verifier
     )}}}}}}}}}
   }

src/main/scala/com/decodified/scalassh/SshClient.scala

@@ -33,7 +33,7 @@ class SshClient(val config: HostConfig) {
       config.connectTimeout.foreach(client.setConnectTimeout(_))
       config.connectionTimeout.foreach(client.setTimeout(_))
       client.addHostKeyVerifier(config.hostKeyVerifier)
-      if (config.useCompression) client.useCompression()
+      if (config.enableCompression) client.useCompression()
     }
   }
 

src/test/resources/password.com

@@ -2,4 +2,4 @@
 login-type = password
 username = bob
 password = 123
-use-compression = yes
+enable-compression = yes

src/test/scala/com/decodified/scalassh/HostFileConfigSpec.scala

@@ -6,7 +6,7 @@ class HostFileConfigSpec extends Specification { def is =
 
   "Depending on the host file the HostFileConfig should produce a proper" ^
     "PasswordLogin" ! {
-      config("password.com") mustEqual Right(HostConfig(PasswordLogin("bob", "123"), "password.com", useCompression = true))
+      config("password.com") mustEqual Right(HostConfig(PasswordLogin("bob", "123"), "password.com", enableCompression = true))
     } ^
     "unencrypted PublicKeyLogin" ! {
       config("keyfile.com") mustEqual Right(HostConfig(PublicKeyLogin("alice", "/some/file"), "xyz.special.com", port = 30))