Add grab command to collect script's dependencies

Previously, run --local could be used to collect a script's
dependencies in ./repository. However, with this mechanism it wasn't
possible to collect the dependencies without running the application.

This commit adds a new command, grab, that can be used to collect
a script's dependencies in ./repository without having to run it.
run is configured with ./repository as a location in which it can find
its dependencies so that the previously collected dependencies
can be used when subsequently running the app.

As part of this work RunCommand and TestCommand have been refactored
to use common code for their common options:

	--no-guess-imports
	--no-guess-dependencies
	--classpath

Previously, the declaration and handling of the options was duplicated
in the two classes. GrabCommand also has these three options and uses
the same common code.

Author: wilkinsona

spring-boot-cli/grab-samples/grab.groovy

@@ -0,0 +1,4 @@
+@Grab('spring-jdbc')
+class GrabTest {
+	
+}

spring-boot-cli/src/main/java/org/springframework/boot/cli/command/CompilerOptionHandler.java

@@ -0,0 +1,63 @@
+/*
+ * Copyright 2012-2013 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.springframework.boot.cli.command;
+
+import joptsimple.OptionSpec;
+
+import static java.util.Arrays.asList;
+
+/**
+ * An {@link OptionHandler} for commands that result in the compilation of one or more
+ * Groovy scripts
+ * 
+ * @author Andy Wilkinson
+ */
+public class CompilerOptionHandler extends OptionHandler {
+
+	private OptionSpec<Void> noGuessImportsOption;
+
+	private OptionSpec<Void> noGuessDependenciesOption;
+
+	private OptionSpec<String> classpathOption;
+
+	@Override
+	protected final void options() {
+		this.noGuessImportsOption = option("no-guess-imports",
+				"Do not attempt to guess imports");
+		this.noGuessDependenciesOption = option("no-guess-dependencies",
+				"Do not attempt to guess dependencies");
+		this.classpathOption = option(asList("classpath", "cp"),
+				"Additional classpath entries").withRequiredArg();
+		doOptions();
+	}
+
+	protected void doOptions() {
+	}
+
+	public OptionSpec<Void> getNoGuessImportsOption() {
+		return this.noGuessImportsOption;
+	}
+
+	public OptionSpec<Void> getNoGuessDependenciesOption() {
+		return this.noGuessDependenciesOption;
+	}
+
+	public OptionSpec<String> getClasspathOption() {
+		return this.classpathOption;
+	}
+
+}

spring-boot-cli/src/main/java/org/springframework/boot/cli/command/DefaultCommandFactory.java

@@ -30,9 +30,9 @@
  */
 public class DefaultCommandFactory implements CommandFactory {
 
-	private static final List<Command> DEFAULT_COMMANDS = Arrays
-			.<Command> asList(new VersionCommand(), new RunCommand(), new CleanCommand(),
-					new TestCommand());
+	private static final List<Command> DEFAULT_COMMANDS = Arrays.<Command> asList(
+			new VersionCommand(), new RunCommand(), new CleanCommand(),
+			new TestCommand(), new GrabCommand());
 
 	@Override
 	public Collection<Command> getCommands() {

spring-boot-cli/src/main/java/org/springframework/boot/cli/command/GrabCommand.java

@@ -0,0 +1,74 @@
+/*
+ * Copyright 2012-2013 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.springframework.boot.cli.command;
+
+import java.io.File;
+import java.util.List;
+
+import joptsimple.OptionSet;
+
+import org.springframework.boot.cli.Command;
+import org.springframework.boot.cli.compiler.GroovyCompiler;
+import org.springframework.boot.cli.compiler.GroovyCompilerConfiguration;
+import org.springframework.boot.cli.compiler.GroovyCompilerConfigurationAdapter;
+import org.springframework.boot.cli.compiler.RepositoryConfigurationFactory;
+import org.springframework.boot.cli.compiler.grape.RepositoryConfiguration;
+import org.springframework.util.StringUtils;
+
+/**
+ * {@link Command} to grab the dependencies of one or more Groovy scripts
+ * 
+ * @author Andy Wilkinson
+ */
+public class GrabCommand extends OptionParsingCommand {
+
+	public GrabCommand() {
+		super("grab", "Download a spring groovy script's dependencies to ./repository",
+				new GrabOptionHandler());
+	}
+
+	private static final class GrabOptionHandler extends CompilerOptionHandler {
+
+		@Override
+		protected void run(OptionSet options) throws Exception {
+			FileOptions fileOptions = new FileOptions(options);
+
+			List<RepositoryConfiguration> repositoryConfiguration = RepositoryConfigurationFactory
+					.createDefaultRepositoryConfiguration();
+			repositoryConfiguration.add(0, new RepositoryConfiguration("local", new File(
+					getM2HomeDirectory(), "repository").toURI(), true));
+
+			GroovyCompilerConfiguration configuration = new GroovyCompilerConfigurationAdapter(
+					options, this, repositoryConfiguration);
+
+			if (System.getProperty("grape.root") == null) {
+				System.setProperty("grape.root", ".");
+			}
+
+			GroovyCompiler groovyCompiler = new GroovyCompiler(configuration);
+			groovyCompiler.compile(fileOptions.getFilesArray());
+		}
+
+		private File getM2HomeDirectory() {
+			String mavenRoot = System.getProperty("maven.home");
+			if (StringUtils.hasLength(mavenRoot)) {
+				return new File(mavenRoot);
+			}
+			return new File(System.getProperty("user.home"), ".m2");
+		}
+	}
+}

spring-boot-cli/src/main/java/org/springframework/boot/cli/command/RunCommand.java

@@ -17,13 +17,18 @@
 package org.springframework.boot.cli.command;
 
 import java.awt.Desktop;
+import java.io.File;
+import java.util.List;
 import java.util.logging.Level;
 
 import joptsimple.OptionSet;
 import joptsimple.OptionSpec;
 
 import org.springframework.boot.cli.Command;
+import org.springframework.boot.cli.compiler.GroovyCompilerConfigurationAdapter;
 import org.springframework.boot.cli.compiler.GroovyCompilerScope;
+import org.springframework.boot.cli.compiler.RepositoryConfigurationFactory;
+import org.springframework.boot.cli.compiler.grape.RepositoryConfiguration;
 import org.springframework.boot.cli.runner.SpringApplicationRunner;
 import org.springframework.boot.cli.runner.SpringApplicationRunnerConfiguration;
 
@@ -53,41 +58,25 @@ public void stop() {
 		}
 	}
 
-	private static class RunOptionHandler extends OptionHandler {
+	private static class RunOptionHandler extends CompilerOptionHandler {
 
 		private OptionSpec<Void> watchOption;
 
 		private OptionSpec<Void> editOption;
 
-		private OptionSpec<Void> noGuessImportsOption;
-
-		private OptionSpec<Void> noGuessDependenciesOption;
-
 		private OptionSpec<Void> verboseOption;
 
 		private OptionSpec<Void> quietOption;
 
-		private OptionSpec<Void> localOption;
-
-		private OptionSpec<String> classpathOption;
-
 		private SpringApplicationRunner runner;
 
 		@Override
-		protected void options() {
+		protected void doOptions() {
 			this.watchOption = option("watch", "Watch the specified file for changes");
-			this.localOption = option("local",
-					"Accumulate the dependencies in a local folder (./repository)");
 			this.editOption = option(asList("edit", "e"),
 					"Open the file with the default system editor");
-			this.noGuessImportsOption = option("no-guess-imports",
-					"Do not attempt to guess imports");
-			this.noGuessDependenciesOption = option("no-guess-dependencies",
-					"Do not attempt to guess dependencies");
 			this.verboseOption = option(asList("verbose", "v"), "Verbose logging");
 			this.quietOption = option(asList("quiet", "q"), "Quiet logging");
-			this.classpathOption = option(asList("classpath", "cp"),
-					"Additional classpath entries").withRequiredArg();
 		}
 
 		@Override
@@ -98,11 +87,14 @@ protected void run(OptionSet options) throws Exception {
 				Desktop.getDesktop().edit(fileOptions.getFiles().get(0));
 			}
 
+			List<RepositoryConfiguration> repositoryConfiguration = RepositoryConfigurationFactory
+					.createDefaultRepositoryConfiguration();
+			repositoryConfiguration.add(0, new RepositoryConfiguration("local", new File(
+					"repository").toURI(), true));
+
 			SpringApplicationRunnerConfiguration configuration = new SpringApplicationRunnerConfigurationAdapter(
-					options);
-			if (configuration.isLocal() && System.getProperty("grape.root") == null) {
-				System.setProperty("grape.root", ".");
-			}
+					options, this, repositoryConfiguration);
+
 			this.runner = new SpringApplicationRunner(configuration,
 					fileOptions.getFilesArray(), fileOptions.getArgsArray());
 			this.runner.compileAndRun();
@@ -112,13 +104,14 @@ protected void run(OptionSet options) throws Exception {
 		 * Simple adapter class to present the {@link OptionSet} as a
 		 * {@link SpringApplicationRunnerConfiguration}.
 		 */
-		private class SpringApplicationRunnerConfigurationAdapter implements
+		private class SpringApplicationRunnerConfigurationAdapter extends
+				GroovyCompilerConfigurationAdapter implements
 				SpringApplicationRunnerConfiguration {
 
-			private OptionSet options;
-
-			public SpringApplicationRunnerConfigurationAdapter(OptionSet options) {
-				this.options = options;
+			public SpringApplicationRunnerConfigurationAdapter(OptionSet options,
+					CompilerOptionHandler optionHandler,
+					List<RepositoryConfiguration> repositoryConfiguration) {
+				super(options, optionHandler, repositoryConfiguration);
 			}
 
 			@Override
@@ -128,44 +121,19 @@ public GroovyCompilerScope getScope() {
 
 			@Override
 			public boolean isWatchForFileChanges() {
-				return this.options.has(RunOptionHandler.this.watchOption);
-			}
-
-			@Override
-			public boolean isGuessImports() {
-				return !this.options.has(RunOptionHandler.this.noGuessImportsOption);
-			}
-
-			@Override
-			public boolean isGuessDependencies() {
-				return !this.options.has(RunOptionHandler.this.noGuessDependenciesOption);
-			}
-
-			@Override
-			public boolean isLocal() {
-				return this.options.has(RunOptionHandler.this.localOption);
+				return getOptions().has(RunOptionHandler.this.watchOption);
 			}
 
 			@Override
 			public Level getLogLevel() {
-				if (this.options.has(RunOptionHandler.this.verboseOption)) {
+				if (getOptions().has(RunOptionHandler.this.verboseOption)) {
 					return Level.FINEST;
 				}
-				if (this.options.has(RunOptionHandler.this.quietOption)) {
+				if (getOptions().has(RunOptionHandler.this.quietOption)) {
 					return Level.OFF;
 				}
 				return Level.INFO;
 			}
-
-			@Override
-			public String[] getClasspath() {
-				if (this.options.has(RunOptionHandler.this.classpathOption)) {
-					return this.options.valueOf(RunOptionHandler.this.classpathOption)
-							.split(":");
-				}
-				return NO_CLASSPATH;
-			}
-
 		}
 	}
 

spring-boot-cli/src/main/java/org/springframework/boot/cli/command/ScriptCommand.java

@@ -28,6 +28,7 @@
 import java.net.URL;
 import java.util.Collection;
 import java.util.Collections;
+import java.util.List;
 
 import joptsimple.OptionParser;
 
@@ -37,6 +38,8 @@
 import org.springframework.boot.cli.compiler.GroovyCompiler;
 import org.springframework.boot.cli.compiler.GroovyCompilerConfiguration;
 import org.springframework.boot.cli.compiler.GroovyCompilerScope;
+import org.springframework.boot.cli.compiler.RepositoryConfigurationFactory;
+import org.springframework.boot.cli.compiler.grape.RepositoryConfiguration;
 import org.springframework.util.FileCopyUtils;
 
 /**
@@ -271,6 +274,11 @@ public String[] getClasspath() {
 			return NO_CLASSPATH;
 		}
 
+		@Override
+		public List<RepositoryConfiguration> getRepositoryConfiguration() {
+			return RepositoryConfigurationFactory.createDefaultRepositoryConfiguration();
+		}
+
 	}
 
 }