Embed gitter channel (#183)

* Embed Gitter Channel #32. * Gitter Sidecar button added. Fixes #32 * Deleted unused imports
47degrees · May 16, 2017 · c96023a · c96023a
1 parent 87edac0
commit c96023a
Show file tree

Hide file tree

Showing 6 changed files with 33 additions and 4 deletions.
diff --git a/docs/src/main/tut/docs/settings.md b/docs/src/main/tut/docs/settings.md
@@ -97,6 +97,12 @@ micrositeGitHostingUrl := "https://gitlab.com/gitlab-org/gitlab-ce"
 micrositeAnalyticsToken := 'UA-XXXXX-Y'
 ```
 
+- `micrositeGitterChannel`: This setting is used to enabled the Gitter sidecar Channel functionality, by default is enabled. The chat room is taken from `micrositeGithubOwner` and `micrositeGithubRepo`.
+
+```
+micrositeGitterChannel := true
+```
+
 - `micrositeHighlightTheme`: by default, the theme of Highlight.js is [default](https://highlightjs.org/static/demo/), however, you can configure it to a different theme thanks to this setting:
 
 ```

diff --git a/src/main/scala/microsites/MicrositeKeys.scala b/src/main/scala/microsites/MicrositeKeys.scala
@@ -119,6 +119,9 @@ trait MicrositeKeys {
   val micrositeAnalyticsToken: SettingKey[String] =
     settingKey[String](
       "Optional. Add your property id of Google Analytics to add a Google Analytics tracker")
+  val micrositeGitterChannel: SettingKey[Boolean] = SettingKey[Boolean](
+    "Optional. Includes Gitter sidecar Chat functionality. Enabled by default."
+  )
 
   val publishMicrositeCommandKey: String = "publishMicrositeCommand"
 }
@@ -198,7 +201,8 @@ trait MicrositeAutoImportSettings extends MicrositeKeys {
             case _      => ""
           },
           gitHostingService = micrositeGitHostingService.value.name,
-          gitHostingUrl = micrositeGitHostingUrl.value
+          gitHostingUrl = micrositeGitHostingUrl.value,
+          gitSidecarChat = micrositeGitterChannel.value
         )
       ))
   }

diff --git a/src/main/scala/microsites/MicrositesPlugin.scala b/src/main/scala/microsites/MicrositesPlugin.scala
@@ -96,6 +96,7 @@ object MicrositesPlugin extends AutoPlugin {
     micrositeGitHostingUrl := "",
     micrositePushSiteWith := GHPagesPlugin,
     micrositeAnalyticsToken := "",
+    micrositeGitterChannel := true,
     includeFilter in Jekyll := ("*.html" | "*.css" | "*.png" | "*.jpg" | "*.jpeg" | "*.gif" | "*.js" | "*.swf" | "*.md" | "*.webm" | "*.ico" | "CNAME"),
     commands ++= Seq(publishMicrositeCommand)
   )

diff --git a/src/main/scala/microsites/layouts/Layout.scala b/src/main/scala/microsites/layouts/Layout.scala
@@ -148,6 +148,17 @@ abstract class Layout(config: MicrositeSettings) {
       script(src := js)
     }
 
+    val gitSidecar: List[TypedTag[String]] = {
+      if (config.gitSettings.gitSidecarChat &&
+        (!config.gitSettings.githubOwner.isEmpty || !config.gitSettings.githubRepo.isEmpty)) {
+        List(
+          script(s"""((window.gitter = {}).chat = {}).options = {
+                 |room: '${config.gitSettings.githubOwner}/${config.gitSettings.githubRepo}'};""".stripMargin),
+          script(src := s"https://sidecar.gitter.im/dist/sidecar.v1.js")
+        )
+      } else Nil
+    }
+
     List(
       script(src := "https://cdnjs.cloudflare.com/ajax/libs/jquery/1.11.3/jquery.min.js"),
       script(
@@ -158,7 +169,7 @@ abstract class Layout(config: MicrositeSettings) {
                |});
                |hljs.initHighlighting();
              """.stripMargin)
-    ) ++ customJsList ++ customCDNList
+    ) ++ customJsList ++ customCDNList ++ gitSidecar
   }
 
   def kazariEnableScript: TypedTag[String] = script(s"""

diff --git a/src/main/scala/microsites/microsites.scala b/src/main/scala/microsites/microsites.scala
@@ -57,7 +57,8 @@ case class MicrositeGitSettings(
     githubOwner: String,
     githubRepo: String,
     gitHostingService: MicrositeKeys.GitHostingService,
-    gitHostingUrl: String)
+    gitHostingUrl: String,
+    gitSidecarChat: Boolean)
 
 case class MicrositeUrlSettings(micrositeBaseUrl: String, micrositeDocumentationUrl: String)
 

diff --git a/src/test/scala/microsites/util/Arbitraries.scala b/src/test/scala/microsites/util/Arbitraries.scala
@@ -130,6 +130,7 @@ trait Arbitraries {
       githubRepo                         ← Arbitrary.arbitrary[String]
       gitHostingService                  ← Arbitrary.arbitrary[GitHostingService]
       gitHostingUrl                      ← Arbitrary.arbitrary[String]
+      gitSidecarChat                     ← Arbitrary.arbitrary[Boolean]
       micrositeKazariEvaluatorUrl        ← Arbitrary.arbitrary[String]
       micrositeKazariEvaluatorToken      ← Arbitrary.arbitrary[String]
       micrositeKazariGithubToken         ← Arbitrary.arbitrary[String]
@@ -159,7 +160,12 @@ trait Arbitraries {
           micrositeExtraMdFiles
         ),
         MicrositeUrlSettings(micrositeBaseUrl, micrositeDocumentationUrl),
-        MicrositeGitSettings(githubOwner, githubRepo, gitHostingService, gitHostingUrl),
+        MicrositeGitSettings(
+          githubOwner,
+          githubRepo,
+          gitHostingService,
+          gitHostingUrl,
+          gitSidecarChat),
         KazariSettings(
           micrositeKazariEvaluatorUrl,
           micrositeKazariEvaluatorToken,