-
Notifications
You must be signed in to change notification settings - Fork 4.6k
/
IdePlugin.java
217 lines (191 loc) · 8.15 KB
/
IdePlugin.java
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
/*
* Copyright 2010 the original author or authors.
*
* 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.
*/
package org.gradle.plugins.ide.internal;
import com.google.common.base.Optional;
import org.apache.commons.lang.StringUtils;
import org.gradle.api.Action;
import org.gradle.api.Plugin;
import org.gradle.api.Project;
import org.gradle.api.Task;
import org.gradle.api.UncheckedIOException;
import org.gradle.api.invocation.Gradle;
import org.gradle.api.logging.Logger;
import org.gradle.api.logging.Logging;
import org.gradle.api.tasks.Delete;
import org.gradle.api.tasks.TaskProvider;
import org.gradle.internal.logging.ConsoleRenderer;
import org.gradle.internal.os.OperatingSystem;
import org.gradle.plugins.ide.IdeWorkspace;
import org.gradle.process.ExecSpec;
import java.awt.*;
import java.io.File;
import java.io.IOException;
public abstract class IdePlugin implements Plugin<Project> {
private static final Logger LOGGER = Logging.getLogger(IdePlugin.class);
private TaskProvider<Task> lifecycleTask;
private TaskProvider<Delete> cleanTask;
protected Project project;
/**
* Returns the path to the correct Gradle distribution to use. The wrapper of the generating project will be used only if the execution context of the currently running Gradle is in the Gradle home (typical of a wrapper execution context). If this isn't the case, we try to use the current Gradle home, if available, as the distribution. Finally, if nothing matches, we default to the system-wide Gradle distribution.
*
* @param project the Gradle project generating the IDE files
* @return path to Gradle distribution to use within the generated IDE files
*/
public static String toGradleCommand(Project project) {
Gradle gradle = project.getGradle();
Optional<String> gradleWrapperPath = Optional.absent();
Project rootProject = project.getRootProject();
String gradlewExtension = OperatingSystem.current().isWindows() ? ".bat" : "";
File gradlewFile = rootProject.file("gradlew" + gradlewExtension);
if (gradlewFile.exists()) {
gradleWrapperPath = Optional.of(gradlewFile.getAbsolutePath());
}
if (gradle.getGradleHomeDir() != null) {
if (gradleWrapperPath.isPresent() && gradle.getGradleHomeDir().getAbsolutePath().startsWith(gradle.getGradleUserHomeDir().getAbsolutePath())) {
return gradleWrapperPath.get();
}
return gradle.getGradleHomeDir().getAbsolutePath() + "/bin/gradle";
}
return gradleWrapperPath.or("gradle");
}
@Override
public void apply(Project target) {
project = target;
String lifecycleTaskName = getLifecycleTaskName();
lifecycleTask = target.getTasks().register(lifecycleTaskName);
cleanTask = target.getTasks().register(cleanName(lifecycleTaskName), Delete.class, new Action<Delete>() {
@Override
public void execute(Delete task) {
task.setGroup("IDE");
}
});
lifecycleTask.configure(new Action<Task>() {
@Override
public void execute(Task task) {
task.setGroup("IDE");
task.shouldRunAfter(cleanTask);
}
});
onApply(target);
}
public TaskProvider<? extends Task> getLifecycleTask() {
return lifecycleTask;
}
public TaskProvider<? extends Task> getCleanTask() {
return cleanTask;
}
protected String cleanName(String taskName) {
return String.format("clean%s", StringUtils.capitalize(taskName));
}
public void addWorker(Task worker) {
addWorker(project.getTasks().named(worker.getName()), worker.getName());
}
public void addWorker(TaskProvider<? extends Task> worker, String workerName) {
addWorker(worker, workerName, true);
}
public void addWorker(Task worker, boolean includeInClean) {
addWorker(project.getTasks().named(worker.getName()), worker.getName(), includeInClean);
}
public void addWorker(final TaskProvider<? extends Task> worker, String workerName, boolean includeInClean) {
lifecycleTask.configure(dependsOn(worker));
final TaskProvider<Delete> cleanWorker = project.getTasks().register(cleanName(workerName), Delete.class, new Action<Delete>() {
@Override
public void execute(Delete cleanWorker) {
cleanWorker.delete(worker);
}
});
if (includeInClean) {
cleanTask.configure(dependsOn(cleanWorker));
}
// Always schedule the generation task after the clean task
worker.configure(new Action<Task>() {
@Override
public void execute(Task task) {
task.shouldRunAfter(cleanWorker);
}
});
}
protected static Action<? super Task> dependsOn(final Task taskDependency) {
return new Action<Task>() {
@Override
public void execute(Task task) {
task.dependsOn(taskDependency);
}
};
}
protected static Action<? super Task> dependsOn(final TaskProvider<? extends Task> taskProvider) {
return new Action<Task>() {
@Override
public void execute(Task task) {
task.dependsOn(taskProvider);
}
};
}
protected static Action<? super Task> withDescription(final String description) {
return new Action<Task>() {
@Override
public void execute(Task task) {
task.setDescription(description);
}
};
}
protected void onApply(Project target) {
}
protected void addWorkspace(final IdeWorkspace workspace) {
lifecycleTask.configure(new Action<Task>() {
@Override
public void execute(Task lifecycleTask) {
lifecycleTask.doLast(new Action<Task>() {
@Override
public void execute(Task task) {
LOGGER.lifecycle(String.format("Generated %s at %s", workspace.getDisplayName(), new ConsoleRenderer().asClickableFileUrl(workspace.getLocation().get().getAsFile())));
}
});
}
});
project.getTasks().register("open" + StringUtils.capitalize(getLifecycleTaskName()), new Action<Task>() {
@Override
public void execute(Task openTask) {
openTask.dependsOn(lifecycleTask);
openTask.setGroup("IDE");
openTask.setDescription("Opens the " + workspace.getDisplayName());
openTask.doLast(new Action<Task>() {
@Override
public void execute(Task task) {
if (OperatingSystem.current().isMacOsX()) {
project.exec(new Action<ExecSpec>() {
@Override
public void execute(ExecSpec execSpec) {
execSpec.commandLine("open", workspace.getLocation().get());
}
});
} else {
try {
Desktop.getDesktop().open(workspace.getLocation().get().getAsFile());
} catch (IOException e) {
throw new UncheckedIOException(e);
}
}
}
});
}
});
}
protected abstract String getLifecycleTaskName();
public boolean isRoot() {
return project.getParent() == null;
}
}