1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
|
package dotty.tools
package dottydoc
package staticsite
import java.nio.file.{ Files, FileSystems }
import java.nio.file.StandardCopyOption.REPLACE_EXISTING
import java.io.{ File => JFile }
import java.util.{ List => JList }
import java.nio.file.Path
import java.io.ByteArrayInputStream
import java.nio.charset.StandardCharsets
import dotc.config.Printers.dottydoc
import dotc.core.Contexts.Context
import scala.io.Source
import scala.collection.mutable.ArrayBuffer
case class Site(val root: JFile, val docs: JList[_]) extends ResourceFinder {
/** All files that are considered static in this context, this can be
* anything from CSS, JS to images and other files.
*
* @note files that are *not* considered static are files ending in a compilable
* extension.
*/
def staticAssets: Array[JFile] = {
if (_staticAssets eq null) initFiles()
_staticAssets
}
/** All files that are considered compilable assets in this context. This
* is mainly markdown and html files, but could include other files in the
* future.
*
* @note files that are considered compilable end in `.md` or `.html`
*/
def compilableFiles: Array[JFile] = {
if (_compilableFiles eq null) initFiles()
_compilableFiles
}
// FileSystem getter
private[this] val fs = FileSystems.getDefault
def copyStaticFiles(outDir: JFile = new JFile(root.getAbsolutePath + "/_site")): this.type = {
if (!outDir.isDirectory) outDir.mkdirs()
if (!outDir.isDirectory) /*dottydoc.*/println(s"couldn't create output folder: $outDir")
else {
// Copy user-defined static assets
staticAssets.foreach { asset =>
val target = mkdirs(fs.getPath(outDir.getAbsolutePath, stripRoot(asset)))
val source = mkdirs(fs.getPath(asset.getAbsolutePath))
Files.copy(source, target, REPLACE_EXISTING)
}
// Copy statics included in resources
Map(
"css/dottydoc.css" -> "/css/dottydoc.css",
"css/color-brewer.css" -> "/css/color-brewer.css",
"js/highlight.pack.js" -> "/js/highlight.pack.js"
)
.mapValues(getResource)
.foreach { case (path, resource) =>
val source = new ByteArrayInputStream(resource.getBytes(StandardCharsets.UTF_8))
val target = mkdirs(fs.getPath(outDir.getAbsolutePath, path))
Files.copy(source, target, REPLACE_EXISTING)
}
}
this
}
/** Generate HTML files from markdown and .html sources */
def generateHtmlFiles(outDir: JFile = new JFile(root.getAbsolutePath + "/_site"))(implicit ctx: Context): this.type = {
if (!outDir.isDirectory) outDir.mkdirs()
if (!outDir.isDirectory) /*dottydoc.*/println(s"couldn't create output folder: $outDir")
else compilableFiles.foreach { asset =>
import scala.collection.JavaConverters._
val baseUrl: String = {
val rootLen = root.getAbsolutePath.split('/').length
val assetLen = asset.getAbsolutePath.split('/').length
"../" * (assetLen - rootLen - 1) + "."
}
val defaultParams = Map(
"docs" -> docs,
"page" -> Map("url" -> stripRoot(asset)),
"site" -> Map("baseUrl" -> baseUrl).asJava
)
val fileContents = Source.fromFile(asset).mkString
val page =
if (asset.getName.endsWith(".md")) new MarkdownPage(fileContents, defaultParams, includes)
else new HtmlPage(fileContents, defaultParams, includes)
val renderedPage = render(page)
val source = new ByteArrayInputStream(renderedPage.getBytes(StandardCharsets.UTF_8))
val target = {
val tgt = stripRoot(asset)
tgt.splitAt(tgt.lastIndexOf('.'))._1 + ".html"
}
val htmlTarget = mkdirs(fs.getPath(outDir.getAbsolutePath, target))
Files.copy(source, htmlTarget, REPLACE_EXISTING)
}
this
}
private def mkdirs(path: Path): path.type = {
val parent = path.getParent.toFile
if (!parent.isDirectory && !parent.mkdirs())
dottydoc.println(s"couldn't create directory: $parent")
path
}
/** This function allows the stripping of the path that leads up to root.
*
* ```scala
* stripRoot(new JFile("/some/root/dir/css/index.css"))
* // returns: dir/css/index.css
* // given that root is: /some/root
* ```
*/
def stripRoot(f: JFile): String = {
val rootLen = root.getAbsolutePath.length + 1
f.getAbsolutePath.drop(rootLen)
}
// Initialization of `staticAssets` and `compilableAssets`:
private[this] var _staticAssets: Array[JFile] = _
private[this] var _compilableFiles: Array[JFile] = _
private[this] def initFiles() = {
// Split files between compilable and static assets
def splitFiles(f: JFile, assets: ArrayBuffer[JFile], comp: ArrayBuffer[JFile]): Unit = {
val name = f.getName
if (f.isDirectory) {
if (!f.getName.startsWith("_")) f.listFiles.foreach(splitFiles(_, assets, comp))
}
else if (name.endsWith(".md") || name.endsWith(".html")) comp.append(f)
else assets.append(f)
}
val assets = new ArrayBuffer[JFile]
val comp = new ArrayBuffer[JFile]
splitFiles(root, assets, comp)
_staticAssets = assets.toArray
_compilableFiles = comp.toArray
}
/** Files that define a layout then referred to by `layout: filename-no-ext`
* in yaml front-matter.
*
* The compiler will look in two locations, `<root>/_layouts/` and
* in the bundled jar file's resources `/_layouts`.
*
* If the user supplies a layout that has the same name as one of the
* defaults, the user-defined one will take precedence.
*/
val layouts: Map[String, String] = {
val userDefinedLayouts =
root
.listFiles.find(d => d.getName == "_layouts" && d.isDirectory)
.map(collectFiles(_, f => f.endsWith(".md") || f.endsWith(".html")))
.getOrElse(Map.empty)
.map { case (k, v) => (k.substring(0, k.lastIndexOf('.')), v) }
val defaultLayouts: Map[String, String] = Map(
"main" -> "/_layouts/main.html",
"doc" -> "/_layouts/doc.html",
"doc-page" -> "/_layouts/doc-page.html",
"index" -> "/_layouts/index.html"
).mapValues(getResource)
defaultLayouts ++ userDefinedLayouts
}
/** Include files are allowed under the directory `_includes`. These files
* have to be compilable files and can be used with liquid includes:
*
* ```
* {% include "some-file" %}
* ```
*
* You can also use the `with` statement:
*
* ```
* {% include "some-file" with { key: value } %}
* ```
*/
val includes: Map[String, String] = {
val userDefinedIncludes =
root
.listFiles.find(d => d.getName == "_includes" && d.isDirectory)
.map(collectFiles(_, f => f.endsWith(".md") || f.endsWith(".html")))
.getOrElse(Map.empty)
val defaultIncludes: Map[String, String] = Map(
"header.html" -> "/_includes/header.html",
"toc.html" -> "/_includes/toc.html"
).mapValues(getResource)
defaultIncludes ++ userDefinedIncludes
}
private def collectFiles(dir: JFile, includes: String => Boolean): Map[String, String] =
dir
.listFiles
.filter(f => includes(f.getName))
.map(f => (f.getName, Source.fromFile(f).mkString))
.toMap
/** Render a page to html, the resulting string is the result of the complete
* expansion of the template with all its layouts and includes.
*/
def render(page: Page, params: Map[String, AnyRef] = Map.empty)(implicit ctx: Context): String =
page.yaml.get("layout").flatMap(layouts.get(_)) match {
case None =>
page.html
case Some(layout) =>
import scala.collection.JavaConverters._
val newParams = page.params ++ params ++ Map("page" -> page.yaml) ++ Map("content" -> page.html)
val expandedTemplate = new HtmlPage(layout, newParams, includes)
render(expandedTemplate, params)
}
}
|
