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
|
/*
* sbt-boilerplate is distributed under the 2-Clause BSD license. See the LICENSE file in the root
* of the repository.
*
* Copyright (c) 2012-2016 Johannes Rudolph
*/
package spray.boilerplate
import java.io.FileInputStream
import sbt._
import Keys._
import sbt.plugins.JvmPlugin
object BoilerplatePlugin extends AutoPlugin {
override def trigger: PluginTrigger = noTrigger
override def `requires`: Plugins = JvmPlugin
object autoImport {
val boilerplateGenerate = taskKey[Seq[File]]("Generates boilerplate from template files")
val boilerplateSource = settingKey[File]("Default directory containing boilerplate template sources.")
val boilerplateSignature = settingKey[String](
"Function that creates signature string to prepend to the generated file (given an input file name). " +
"Will be used to detect boilerplate-generated files")
}
import autoImport._
override def projectSettings: Seq[Def.Setting[_]] =
inConfig(Compile)(rawBoilerplateSettings) ++ inConfig(Test)(rawBoilerplateSettings) ++ Seq(
boilerplateSignature := "// auto-generated by sbt-boilerplate\n")
private def rawBoilerplateSettings: Seq[Setting[_]] = {
val inputFilter = "*.template"
Seq(
boilerplateSource := sourceDirectory.value / "boilerplate",
watchSources in Defaults.ConfigGlobal ++= ((boilerplateSource.value ** inputFilter) --- (boilerplateSource.value ** excludeFilter.value ** inputFilter)).get,
boilerplateGenerate := generateFromTemplates(streams.value, boilerplateSignature.value, boilerplateSource.value, sourceManaged.value),
mappings in packageSrc ++= managedSources.value pair (Path.relativeTo(sourceManaged.value) | Path.flat),
sourceGenerators <+= boilerplateGenerate)
}
def generateFromTemplates(streams: TaskStreams, signature: String, sourceDir: File, targetDir: File): Seq[File] = {
val files = sourceDir ** "*.template"
streams.log.debug(s"Found ${files.get.size} template files in $sourceDir.")
def changeExtension(f: File): File = {
val (_, name) = f.getName.reverse.span(_ != '.')
val strippedName = name.drop(1).reverse.toString
val newName =
if (!strippedName.contains(".")) s"$strippedName.scala"
else strippedName
new File(f.getParent, newName)
}
val mapping = (files pair rebase(sourceDir, targetDir)).map {
case (orig, target) ⇒ (orig, changeExtension(target))
}
val newFiles = mapping.map(_._2)
clearTargetDir(streams, targetDir, signature, newFiles)
mapping foreach {
case (templateFile, target) ⇒
if (templateFile.lastModified > target.lastModified) {
streams.log.info("Generating '%s'" format target.getName)
val template = IO.read(templateFile)
IO.write(target,
signature + Generator.generateFromTemplate(template, 22))
} else
streams.log.debug("Template '%s' older than target. Ignoring." format templateFile.getName)
}
newFiles
}
def clearTargetDir(streams: TaskStreams, targetDir: File, signature: String, newFiles: Seq[File]): Seq[File] = {
val fileSet = newFiles.toSet
val buffer = new Array[Byte](signature.getBytes("utf8").size)
def containsSignature(file: File): Boolean = {
val f = new FileInputStream(file)
try {
val read = f.read(buffer)
(read != buffer.length) || // if we haven't read the full signature assume we had read it
new String(buffer, "utf8") == signature
} finally f.close()
}
val toRemove =
targetDir.***
// apply filters with increasing effort
.filter(f ⇒ f.exists && f.isFile)
.filter(_.length >= signature.length)
.filter(!fileSet(_))
.filter(containsSignature)
.get
toRemove.foreach { f ⇒
streams.log.debug(s"Removing $f that was formerly created by sbt-boilerplate (but won't be created anew).")
f.delete
}
toRemove
}
}
|