Merge branch 'big-favor-for-imagejan'

See:
http://forum.imagej.net/t/shift-clicking-on-menu-item-to-open-script-editor/2617

Author: ctrueden

pom.xml

@@ -10,7 +10,7 @@
 	</parent>
 
 	<artifactId>scijava-common</artifactId>
-	<version>2.60.3-SNAPSHOT</version>
+	<version>2.61.0-SNAPSHOT</version>
 
 	<name>SciJava Common</name>
 	<description>SciJava Common is a shared library for SciJava software. It provides a plugin framework, with an extensible mechanism for service discovery, backed by its own annotation processor, so that plugins can be loaded dynamically. It is used by downstream projects in the SciJava ecosystem, such as ImageJ and SCIFIO.</description>

src/main/java/org/scijava/script/ScriptFinder.java

@@ -33,7 +33,6 @@
 
 import java.io.File;
 import java.io.IOException;
-import java.io.InputStreamReader;
 import java.net.MalformedURLException;
 import java.net.URL;
 import java.util.Collections;
@@ -191,8 +190,7 @@ private int createInfos(final List<ScriptInfo> scripts, final Set<URL> urls,
 			urls.add(url);
 
 			try {
-				final ScriptInfo info = new ScriptInfo(getContext(), //
-					path, new InputStreamReader(url.openStream()));
+				final ScriptInfo info = new ScriptInfo(getContext(), url, path);
 
 				info.setMenuPath(menuPath);
 

src/main/java/org/scijava/script/ScriptInfo.java

@@ -35,8 +35,11 @@
 import java.io.File;
 import java.io.FileReader;
 import java.io.IOException;
+import java.io.InputStreamReader;
 import java.io.Reader;
 import java.io.StringReader;
+import java.net.MalformedURLException;
+import java.net.URL;
 import java.text.SimpleDateFormat;
 import java.util.ArrayList;
 import java.util.Date;
@@ -76,6 +79,7 @@ public class ScriptInfo extends AbstractModuleInfo implements Contextual {
 
 	private static final int PARAM_CHAR_MAX = 640 * 1024; // should be enough ;-)
 
+	private final URL url;
 	private final String path;
 	private final String script;
 
@@ -105,7 +109,7 @@ public class ScriptInfo extends AbstractModuleInfo implements Contextual {
 	 * @param file The script file.
 	 */
 	public ScriptInfo(final Context context, final File file) {
-		this(context, file.getPath());
+		this(context, null, file.getPath(), null);
 	}
 
 	/**
@@ -116,7 +120,23 @@ public ScriptInfo(final Context context, final File file) {
 	 * @param path Path to the script file.
 	 */
 	public ScriptInfo(final Context context, final String path) {
-		this(context, path, null);
+		this(context, null, path, null);
+	}
+
+	/**
+	 * Creates a script metadata object which describes a script at the given URL.
+	 * 
+	 * @param context The SciJava application context to use when populating
+	 *          service inputs.
+	 * @param url URL which references the script.
+	 * @param path Pseudo-path to the script file. This file does not actually
+	 *          need to exist, but rather provides a name for the script with file
+	 *          extension.
+	 */
+	public ScriptInfo(final Context context, final URL url, final String path)
+		throws IOException
+	{
+		this(context, url, path, new InputStreamReader(url.openStream()));
 	}
 
 	/**
@@ -132,9 +152,16 @@ public ScriptInfo(final Context context, final String path) {
 	 */
 	public ScriptInfo(final Context context, final String path,
 		final Reader reader)
+	{
+		this(context, null, path, reader);
+	}
+
+	private ScriptInfo(final Context context, final URL url, final String path,
+		final Reader reader)
 	{
 		setContext(context);
-		this.path = path;
+		this.url = url(url, path);
+		this.path = path(url, path);
 
 		String contents = null;
 		if (reader != null) {
@@ -150,6 +177,26 @@ public ScriptInfo(final Context context, final String path,
 
 	// -- ScriptInfo methods --
 
+	/**
+	 * Gets the URL of the script.
+	 * <p>
+	 * If the actual source of the script is a URL (provided via
+	 * {@link #ScriptInfo(Context, URL, String)}), then this will return it.
+	 * </p>
+	 * <p>
+	 * Alternately, if the path (from {@link #getPath()}) is a real file on disk
+	 * (provided via {@link #ScriptInfo(Context, File)} or
+	 * {@link #ScriptInfo(Context, String)}), then the URL returned here will be a
+	 * {@code file://} one reference to it.
+	 * </p>
+	 * <p>
+	 * Otherwise, this method will return null.
+	 * </p>
+	 */
+	public URL getURL() {
+		return url;
+	}
+
 	/**
 	 * Gets the path to the script on disk.
 	 * <p>
@@ -332,6 +379,21 @@ public String getVersion() {
 
 	// -- Helper methods --
 
+	private URL url(final URL u, final String p) {
+		if (u != null) return u;
+		try {
+			return new File(p).toURI().toURL();
+		}
+		catch (final MalformedURLException exc) {
+			log.debug("Cannot glean URL from path: " + p, exc);
+			return null;
+		}
+	}
+
+	private String path(final URL u, final String p) {
+		return p == null ? u.getPath() : p;
+	}
+
 	private void parseParam(final String param) throws ScriptException {
 		final int lParen = param.indexOf("(");
 		final int rParen = param.lastIndexOf(")");

src/test/java/org/scijava/script/ScriptFinderTest.java

@@ -32,6 +32,7 @@
 package org.scijava.script;
 
 import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertTrue;
 
 import java.io.File;
 import java.io.IOException;
@@ -114,6 +115,7 @@ public void testFindScripts() {
 			"Math > Trig > tan", //
 		};
 		assertMenuPaths(expected, scripts);
+		assertURLsMatch(scripts);
 	}
 
 	/**
@@ -148,6 +150,7 @@ public void testMenuPrefixes() {
 			"Foo > Bar > Math > Trig > tan", //
 		};
 		assertMenuPaths(expected, scripts);
+		assertURLsMatch(scripts);
 	}
 
 	/**
@@ -181,6 +184,7 @@ public void testOverlappingDirectories() {
 			"Math > Trig > tan", //
 		};
 		assertMenuPaths(expected, scripts);
+		assertURLsMatch(scripts);
 	}
 
 	// -- Helper methods --
@@ -212,6 +216,14 @@ private void assertMenuPaths(final String[] expected,
 		}
 	}
 
+	private void assertURLsMatch(final ArrayList<ScriptInfo> scripts) {
+		for (final ScriptInfo info : scripts) {
+			final String urlPath = info.getURL().getPath();
+			final String path = info.getPath();
+			assertTrue(urlPath + " <> " + path, urlPath.endsWith("/" + path));
+		}
+	}
+
 	// -- Helper classes --
 
 	/** "Handles" scripts with .foo extension. */