Allows customizing Jekyll _config.yml file

build.sbt

@@ -29,10 +29,11 @@ lazy val pluginSettings = Seq(
       "jgit-repo" at "http://download.eclipse.org/jgit/maven"
     ),
     libraryDependencies ++= Seq(
-      "com.lihaoyi"   %% "scalatags" % "0.6.0",
-      "org.scalactic" %% "scalactic" % "3.0.0",
-      "org.scalatest"  %% "scalatest"  % versions("scalatest")  % "test",
-      "org.scalacheck" %% "scalacheck" % versions("scalacheck") % "test"
+      "com.lihaoyi"    %% "scalatags"    % "0.6.0",
+      "org.scalactic"  %% "scalactic"    % "3.0.0",
+      "net.jcazevedo"  %% "moultingyaml" % "0.4.0",
+      "org.scalatest"  %% "scalatest"    % versions("scalatest") % "test",
+      "org.scalacheck" %% "scalacheck"   % versions("scalacheck") % "test"
     ),
     scalafmtConfig in ThisBuild := Some(file(".scalafmt"))
   ) ++ reformatOnCompileSettings

project/plugins.sbt

@@ -1,5 +1,5 @@
-addSbtPlugin("com.fortysevendeg" % "sbt-catalysts-extras" % "0.1.2")
-addSbtPlugin("com.geirsson"      % "sbt-scalafmt"         % "0.4.7")
-libraryDependencies <+= sbtVersion("org.scala-sbt" % "scripted-plugin" % _)
+addSbtPlugin("com.fortysevendeg"                   % "sbt-catalysts-extras" % "0.1.2")
+addSbtPlugin("com.geirsson"                        % "sbt-scalafmt"         % "0.4.10")
+libraryDependencies <+= sbtVersion("org.scala-sbt" % "scripted-plugin"      % _)
 // Plugin inception dependency to be able to generate the sbt-microsites' microsite
 addSbtPlugin("com.fortysevendeg" % "sbt-microsites" % "0.3.3")

src/main/scala/microsites/MicrositeKeys.scala

@@ -17,7 +17,6 @@
 package microsites
 
 import sbt._
-import microsites.domain.ExtraMdFileConfig
 
 trait MicrositeKeys {
   val makeMicrosite = taskKey[Unit]("Main Task to build a Microsite")
@@ -33,6 +32,7 @@ trait MicrositeKeys {
   val micrositeBaseUrl          = settingKey[String]("Microsite site base url")
   val micrositeDocumentationUrl = settingKey[String]("Microsite site documentation url")
   val micrositeHighlightTheme   = settingKey[String]("Microsite Highlight Theme")
+  val micrositeConfigYaml       = settingKey[ConfigYml]("Microsite _config.yml file configuration.")
   val micrositeImgDirectory = settingKey[File](
     "Optional. Microsite images directory. By default, it'll be the resourcesDirectory + '/microsite/img'")
   val micrositeCssDirectory = settingKey[File](
@@ -49,7 +49,6 @@ trait MicrositeKeys {
 
   val micrositeExtraMdFiles = settingKey[Map[File, ExtraMdFileConfig]](
     "Optional. This key is useful when you want to include automatically markdown documents as a part of your microsite, and these files are located in different places from the tutSourceDirectory. The map key is related with the source file, the map value corresponds with the target relative file path and the document meta-information configuration. By default, the map is empty.")
-
   val micrositePalette     = settingKey[Map[String, String]]("Microsite palette")
   val micrositeGithubOwner = settingKey[String]("Microsite Github owner")
   val micrositeGithubRepo  = settingKey[String]("Microsite Github repo")

src/main/scala/microsites/MicrositesPlugin.scala

@@ -21,7 +21,6 @@ import com.typesafe.sbt.SbtGhPages.ghpages
 import com.typesafe.sbt.SbtGit.git
 import com.typesafe.sbt.site.SitePlugin.autoImport._
 import com.typesafe.sbt.site.jekyll.JekyllPlugin
-import microsites.domain._
 import microsites.util.MicrositeHelper
 import sbt.Keys._
 import sbt._
@@ -35,9 +34,9 @@ object MicrositesPlugin extends AutoPlugin {
   import MicrositesPlugin.autoImport._
   import com.typesafe.sbt.site.jekyll.JekyllPlugin.autoImport._
 
-  override def requires = IvyPlugin && JekyllPlugin
+  override def requires: Plugins = IvyPlugin && JekyllPlugin
 
-  override def trigger = allRequirements
+  override def trigger: PluginTrigger = allRequirements
 
   override def projectSettings: Seq[Def.Setting[_]] =
     tutSettings ++
@@ -61,6 +60,8 @@ object MicrositesPlugin extends AutoPlugin {
     micrositeDocumentationUrl := "",
     micrositeTwitter := "",
     micrositeHighlightTheme := "default",
+    micrositeConfigYaml := ConfigYml(
+      yamlPath = Some((resourceDirectory in Compile).value / "microsite" / "_config.yml")),
     micrositeImgDirectory := (resourceDirectory in Compile).value / "microsite" / "img",
     micrositeCssDirectory := (resourceDirectory in Compile).value / "microsite" / "css",
     micrositeJsDirectory := (resourceDirectory in Compile).value / "microsite" / "js",
@@ -79,7 +80,28 @@ object MicrositesPlugin extends AutoPlugin {
     micrositeGithubOwner := "47deg",
     micrositeGithubRepo := "sbt-microsites")
 
-  lazy val micrositeHelper = Def.setting {
+  lazy val micrositeHelper: Def.Initialize[MicrositeHelper] = Def.setting {
+    val baseUrl =
+      if (!micrositeBaseUrl.value.isEmpty && !micrositeBaseUrl.value.startsWith("/"))
+        s"/${micrositeBaseUrl.value}"
+      else micrositeBaseUrl.value
+
+    val defaultYamlCustomVariables = Map(
+      "name"        -> micrositeName.value,
+      "description" -> micrositeDescription.value,
+      "version"     -> version.value,
+      "org"         -> organizationName.value,
+      "baseurl"     -> baseUrl,
+      "docs"        -> true,
+      "markdown"    -> "kramdown",
+      "highlighter" -> "rouge",
+      "collections" -> Map("tut" -> Map("output" -> true))
+    )
+
+    val userCustomVariables = micrositeConfigYaml.value
+    val configWithAllCustomVariables = userCustomVariables.copy(
+      yamlCustomProperties = defaultYamlCustomVariables ++ userCustomVariables.yamlCustomProperties)
+
     new MicrositeHelper(
       MicrositeSettings(
         name = micrositeName.value,
@@ -88,6 +110,7 @@ object MicrositesPlugin extends AutoPlugin {
         homepage = micrositeHomepage.value,
         twitter = micrositeTwitter.value,
         highlightTheme = micrositeHighlightTheme.value,
+        micrositeConfigYaml = configWithAllCustomVariables,
         micrositeImgDirectory = micrositeImgDirectory.value,
         micrositeCssDirectory = micrositeCssDirectory.value,
         micrositeJsDirectory = micrositeJsDirectory.value,

src/main/scala/microsites/layouts/DocsLayout.scala

@@ -16,7 +16,7 @@
 
 package microsites.layouts
 
-import microsites.domain.MicrositeSettings
+import microsites.MicrositeSettings
 
 import scalatags.Text.TypedTag
 import scalatags.Text.tags2.section

src/main/scala/microsites/layouts/HomeLayout.scala

@@ -16,7 +16,7 @@
 
 package microsites.layouts
 
-import microsites.domain.MicrositeSettings
+import microsites.MicrositeSettings
 
 import scalatags.Text.TypedTag
 import scalatags.Text.all._

src/main/scala/microsites/layouts/Layout.scala

@@ -16,7 +16,7 @@
 
 package microsites.layouts
 
-import microsites.domain.MicrositeSettings
+import microsites.MicrositeSettings
 import microsites.util.FileHelper._
 
 import scalatags.Text.TypedTag

src/main/scala/microsites/layouts/MenuPartialLayout.scala

@@ -16,7 +16,7 @@
 
 package microsites.layouts
 
-import microsites.domain.MicrositeSettings
+import microsites.MicrositeSettings
 
 import scalatags.Text.TypedTag
 import scalatags.Text.all._

src/main/scala/microsites/layouts/PageLayout.scala

@@ -16,7 +16,7 @@
 
 package microsites.layouts
 
-import microsites.domain.MicrositeSettings
+import microsites.MicrositeSettings
 
 import scalatags.Text.TypedTag
 import scalatags.Text.all._

src/main/scala/microsites/microsites.scala

@@ -0,0 +1,81 @@
+/*
+ * Copyright 2016 47 Degrees, LLC. <http://www.47deg.com>
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import net.jcazevedo.moultingyaml._
+import sbt._
+
+import scala.language.{postfixOps, reflectiveCalls}
+
+package object microsites {
+
+  case class MicrositeSettings(name: String,
+                               description: String,
+                               author: String,
+                               homepage: String,
+                               twitter: String,
+                               highlightTheme: String,
+                               micrositeConfigYaml: ConfigYml,
+                               micrositeImgDirectory: File,
+                               micrositeCssDirectory: File,
+                               micrositeJsDirectory: File,
+                               micrositeExternalLayoutsDirectory: File,
+                               micrositeExternalIncludesDirectory: File,
+                               micrositeDataDirectory: File,
+                               micrositeExtraMdFiles: Map[File, ExtraMdFileConfig],
+                               micrositeBaseUrl: String,
+                               micrositeDocumentationUrl: String,
+                               palette: Map[String, String],
+                               githubOwner: String,
+                               githubRepo: String)
+
+  case class ExtraMdFileConfig(fileName: String,
+                               layout: String,
+                               metaProperties: Map[String, String] = Map.empty)
+
+  case class ConfigYml(
+      yamlCustomProperties: Map[String, Any] = Map.empty,
+      yamlPath: Option[File] = None,
+      yamlInline: String = ""
+  )
+
+  object ConfigYamlProtocol extends DefaultYamlProtocol {
+
+    implicit object AnyYamlFormat extends YamlFormat[Any] {
+      def write(x: Any): YamlValue = x match {
+        case n: Int            => YamlNumber(n)
+        case n: Long           => YamlNumber(n)
+        case n: Double         => YamlNumber(n)
+        case s: String         => YamlString(s)
+        case b: Boolean        => YamlBoolean(b)
+        case x: Seq[_]         => seqFormat[Any].write(x)
+        case m: Map[String, _] => mapFormat[String, Any].write(m)
+        case t =>
+          serializationError("Serialization Error - Non expected type " + t.getClass.getName)
+      }
+
+      def read(value: YamlValue): Any = value match {
+        case YamlNumber(n)  => n.intValue()
+        case YamlString(s)  => s
+        case YamlBoolean(b) => b
+        case _: YamlArray   => listFormat[Any].read(value)
+        case _: YamlObject  => mapFormat[String, Any].read(value)
+        case x =>
+          deserializationError("Deserialization Error - it failed the deserialization of " + x)
+      }
+    }
+  }
+
+}

src/main/scala/microsites/util/MicrositeHelper.scala

@@ -18,10 +18,13 @@ package microsites.util
 
 import java.io.File
 
-import microsites.domain._
+import microsites._
+import net.jcazevedo.moultingyaml.{YamlObject, _}
+import ConfigYamlProtocol._
 import microsites.layouts._
 import microsites.util.FileHelper._
 import sbt._
+
 import scala.io.Source
 
 class MicrositeHelper(config: MicrositeSettings) {
@@ -57,14 +60,15 @@ class MicrositeHelper(config: MicrositeSettings) {
       case (sourceFile, targetFileConfig) =>
         println(s"Copying from ${sourceFile.getAbsolutePath} to $tutSourceDir$targetFileConfig")
 
-        val targetFileContent = s"""---
-          |layout: ${targetFileConfig.layout}
-          |${targetFileConfig.metaProperties map {
-                                     case (key, value) => "%s: %s" format (key, value)
-                                   } mkString ("", "\n", "")}
-          |---
-          |${Source.fromFile(sourceFile.getAbsolutePath).mkString}
-          |""".stripMargin
+        val targetFileContent =
+          s"""---
+             |layout: ${targetFileConfig.layout}
+             |${targetFileConfig.metaProperties map {
+               case (key, value) => "%s: %s" format (key, value)
+             } mkString ("", "\n", "")}
+             |---
+             |${Source.fromFile(sourceFile.getAbsolutePath).mkString}
+             |""".stripMargin
 
         IO.write(s"$tutSourceDir${targetFileConfig.fileName}".toFile, targetFileContent)
     }
@@ -76,23 +80,18 @@ class MicrositeHelper(config: MicrositeSettings) {
   def createConfigYML(targetDir: String): File = {
     val targetFile = createFilePathIfNotExists(s"$targetDir$jekyllDir/_config.yml")
 
-    val baseUrl =
-      if (!config.micrositeBaseUrl.isEmpty && !config.micrositeBaseUrl.startsWith("/"))
-        s"/${config.micrositeBaseUrl}"
-      else config.micrositeBaseUrl
-
-    IO.write(targetFile,
-             s"""name: ${config.name}
-          |description: "${config.description}"
-          |baseurl: $baseUrl
-          |docs: true
-          |
-          |markdown: kramdown
-          |highlighter: rouge
-          |collections:
-          |  tut:
-          |    output: true
-          |""".stripMargin)
+    val yaml             = config.micrositeConfigYaml
+    val customProperties = yaml.yamlCustomProperties.toYaml.asYamlObject.fields
+    val inlineYaml =
+      if (yaml.yamlInline.nonEmpty)
+        yaml.yamlInline.parseYaml.asYamlObject.fields
+      else Map.empty[YamlValue, YamlValue]
+    val fileYaml = yaml.yamlPath.fold(Map.empty[YamlValue, YamlValue])(f =>
+      if (f.exists()) {
+        Source.fromFile(f.getAbsolutePath).mkString.parseYaml.asYamlObject.fields
+      } else Map.empty[YamlValue, YamlValue])
+
+    IO.write(targetFile, YamlObject(customProperties ++ fileYaml ++ inlineYaml).prettyPrint)
 
     targetFile
   }
@@ -127,7 +126,7 @@ class MicrositeHelper(config: MicrositeSettings) {
         targetFile
     }
 
-  def copyConfigurationFile(sourceDir: File, targetDir: File) = {
+  def copyConfigurationFile(sourceDir: File, targetDir: File): Unit = {
 
     val targetFile = createFilePathIfNotExists(s"$targetDir/_config.yml")
 

src/sbt-test/microsites/change-default-paths/build.sbt

@@ -1,4 +1,4 @@
-import microsites.domain._
+import microsites._
 
 enablePlugins(MicrositesPlugin)
 scalaVersion := "2.11.8"

src/sbt-test/microsites/config-yml/CONSEQUAT.md

@@ -0,0 +1,3 @@
+# Consequat Overview
+
+Consequat is another random file, located in the project's root.

src/sbt-test/microsites/config-yml/README.md

@@ -0,0 +1,3 @@
+# Overview
+
+README file of the project, located in the project's root.