-
Notifications
You must be signed in to change notification settings - Fork 5
/
ResourcesPlugin.kt
215 lines (192 loc) · 8.91 KB
/
ResourcesPlugin.kt
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
package com.goncalossilva.resources
import org.gradle.api.Action
import org.gradle.api.Task
import org.gradle.api.provider.Provider
import org.gradle.api.tasks.Copy
import org.gradle.api.tasks.Delete
import org.gradle.api.tasks.TaskProvider
import org.jetbrains.kotlin.gradle.plugin.KotlinCompilation
import org.jetbrains.kotlin.gradle.plugin.KotlinCompilerPluginSupportPlugin
import org.jetbrains.kotlin.gradle.plugin.SubpluginArtifact
import org.jetbrains.kotlin.gradle.plugin.SubpluginOption
import org.jetbrains.kotlin.gradle.plugin.mpp.KotlinJsCompilation
import org.jetbrains.kotlin.gradle.plugin.mpp.KotlinNativeCompilation
import org.jetbrains.kotlin.gradle.targets.js.dsl.KotlinJsSubTargetContainerDsl
import org.jetbrains.kotlin.gradle.targets.js.npm.npmProject
import java.io.File
import kotlin.contracts.contract
@Suppress("TooManyFunctions")
class ResourcesPlugin : KotlinCompilerPluginSupportPlugin {
override fun getCompilerPluginId() = BuildConfig.PLUGIN_ID
override fun getPluginArtifact() = SubpluginArtifact(
groupId = BuildConfig.GROUP_ID,
artifactId = BuildConfig.ARTIFACT_ID,
version = BuildConfig.VERSION
)
override fun isApplicable(kotlinCompilation: KotlinCompilation<*>) =
isCompiledForTesting(kotlinCompilation) && hasResources(kotlinCompilation) &&
(isAppleCompilation(kotlinCompilation) || isJsNodeCompilation(kotlinCompilation) ||
isJsBrowserCompilation(kotlinCompilation))
override fun applyToCompilation(
kotlinCompilation: KotlinCompilation<*>
): Provider<List<SubpluginOption>> {
val project = kotlinCompilation.target.project
/*
* For Apple platforms, move resources into the binary's output directory so that they
* can be loaded using `NSBundle.mainBundle` and related APIs.
*/
if(isAppleCompilation(kotlinCompilation)) {
val target = kotlinCompilation.target
target.binaries.forEach { binary ->
setupCopyResourcesTask(
kotlinCompilation = kotlinCompilation,
taskName = getTaskName("copyResources", binary.name, target.targetName),
outputDirectory = binary.outputDirectory,
mustRunAfterTask = kotlinCompilation.processResourcesTaskName,
dependantTask = binary.linkTaskName
)
}
}
/*
* For Node and the browser, move resources into the script's output directory.
*/
if (isJsNodeCompilation(kotlinCompilation) || isJsBrowserCompilation(kotlinCompilation)) {
setupCopyResourcesTask(
kotlinCompilation = kotlinCompilation,
taskName = getTaskName("copyResources", kotlinCompilation.target.targetName),
outputDirectory = kotlinCompilation.npmProject.dir,
mustRunAfterTask = kotlinCompilation.processResourcesTaskName,
dependantTask = kotlinCompilation.compileKotlinTaskName
)
}
/*
* For the browser, move resources into the script's output directory and leverage
* Karma's proxies to load them from the filesystem.
*/
if (isJsBrowserCompilation(kotlinCompilation)) {
setupProxyResourcesTask(
kotlinCompilation = kotlinCompilation,
taskName = getTaskName("proxyResources", kotlinCompilation.target.targetName),
// Task where karma.conf.js is created, in KotlinKarma.createTestExecutionSpec.
mustRunAfterTask = kotlinCompilation.processResourcesTaskName,
dependantTask = kotlinCompilation.compileKotlinTaskName
)
}
return project.provider { emptyList() }
}
private fun isCompiledForTesting(kotlinCompilation: KotlinCompilation<*>) =
kotlinCompilation.compilationName == KotlinCompilation.TEST_COMPILATION_NAME
private fun isAppleCompilation(kotlinCompilation: KotlinCompilation<*>): Boolean {
contract {
returns(true) implies (kotlinCompilation is KotlinNativeCompilation)
}
return kotlinCompilation is KotlinNativeCompilation &&
kotlinCompilation.konanTarget.family.isAppleFamily
}
private fun isJsNodeCompilation(kotlinCompilation: KotlinCompilation<*>): Boolean {
contract {
returns(true) implies (kotlinCompilation is KotlinJsCompilation)
}
return kotlinCompilation is KotlinJsCompilation && kotlinCompilation.target.let {
it is KotlinJsSubTargetContainerDsl && it.isNodejsConfigured
}
}
private fun isJsBrowserCompilation(kotlinCompilation: KotlinCompilation<*>): Boolean {
contract {
returns(true) implies (kotlinCompilation is KotlinJsCompilation)
}
return kotlinCompilation is KotlinJsCompilation && kotlinCompilation.target.let {
it is KotlinJsSubTargetContainerDsl && it.isBrowserConfigured
}
}
private fun hasResources(kotlinCompilation: KotlinCompilation<*>) =
kotlinCompilation.allKotlinSourceSets.any { sourceSet ->
sourceSet.resources.srcDirs.any { !it.listFiles().isNullOrEmpty() }
}
private fun getResourceDirs(kotlinCompilation: KotlinCompilation<*>): List<String> {
val projectDirPath = kotlinCompilation.target.project.projectDir.path
return kotlinCompilation.allKotlinSourceSets.flatMap { sourceSet ->
// Paths should be relative to the project's directory.
sourceSet.resources.srcDirs.map { it.path.removePrefix(projectDirPath).trimStart('/') }
}
}
private fun getTaskName(prefix: String, vararg qualifiers: String) =
"$prefix${qualifiers.joinToString("") { it.replaceFirstChar(Char::titlecase) }}"
private fun setupCopyResourcesTask(
kotlinCompilation: KotlinCompilation<*>,
taskName: String,
outputDirectory: File,
mustRunAfterTask: String,
dependantTask: String
): TaskProvider<Copy>? {
val project = kotlinCompilation.target.project
val tasks = project.tasks
val resourceDirs = getResourceDirs(kotlinCompilation).map { "$it/**" }
val copyResourcesTask = tasks.register(taskName, Copy::class.java) { task ->
task.from(project.projectDir)
task.include(resourceDirs)
task.into(outputDirectory)
task.mustRunAfter(mustRunAfterTask)
}
tasks.named(dependantTask).configure {
it.dependsOn(copyResourcesTask)
}
return copyResourcesTask
}
private fun setupProxyResourcesTask(
kotlinCompilation: KotlinCompilation<*>,
taskName: String,
mustRunAfterTask: String,
dependantTask: String
): TaskProvider<Task> {
val project = kotlinCompilation.target.project
val tasks = project.tasks
val confFile = project.projectDir
.resolve("karma.config.d")
.apply { mkdirs() }
.resolve("proxy-resources.js")
val proxyResourcesTask = tasks.register(taskName) { task ->
@Suppress("ObjectLiteralToLambda")
task.doLast(object : Action<Task> {
override fun execute(_task: Task) {
// Create karma configuration file in the expected location, deleting it when we're done.
confFile.printWriter().use { confWriter ->
getResourceDirs(kotlinCompilation).forEach { resourceDir ->
confWriter.println(
"""
|config.files.push({
| pattern: __dirname + "/$resourceDir/**",
| watched: false,
| included: false,
| served: true,
| nocache: false
|});
""".trimMargin()
)
}
confWriter.println(
"""
|config.set({
| "proxies": {
| "/": __dirname + "/"
| }
|});
""".trimMargin()
)
}
}
})
task.mustRunAfter(mustRunAfterTask)
}
tasks.named(dependantTask).configure {
it.dependsOn(proxyResourcesTask)
}
val cleanupConfFileTask = tasks.register("${taskName}Cleanup", Delete::class.java) {
it.delete = setOf(confFile)
}
tasks.named(getTaskName(kotlinCompilation.target.name, "browser", kotlinCompilation.name)) {
it.finalizedBy(cleanupConfFileTask)
}
return proxyResourcesTask
}
}