ST6RI-178 Reworked project load interface in SysMLInteractive

Previously loading required using UUID or name to reference projects and
their branches but there were no interface that allowed mixing the two
e.g reference the project by UUID and the branch by name.

This rework makes load parameterization more flexible to allow more
cases to be covered.

Author: TheKorpos

org.omg.sysml.interactive/src/org/omg/sysml/interactive/SysMLInteractive.java

@@ -34,6 +34,7 @@
 import java.util.Collections;
 import java.util.Comparator;
 import java.util.List;
+import java.util.Map;
 import java.util.Scanner;
 import java.util.UUID;
 import java.util.stream.Collectors;
@@ -96,6 +97,12 @@
 
 public class SysMLInteractive extends SysMLUtil {
 
+	public static final String HELP_KEY = "help";
+	public static final String PROJECT_ID_KEY = "id";
+	public static final String PROJECT_NAME_KEY = "name";
+	public static final String BRANCH_ID_KEY = "branch-id";
+	public static final String BRANCH_NAME_KEY = "branch";
+	
 	public static final String KERNEL_LIBRARIES_DIRECTORY = "Kernel Libraries";
 	public static final String SYSTEMS_LIBRARY_DIRECTORY = "Systems Library";
 	public static final String DOMAIN_LIBRARIES_DIRECTORY = "Domain Libraries";
@@ -438,61 +445,74 @@ protected String publish(String name) {
 				publish(name, null, null, false, Collections.emptyList());
 	}
 
-	public String loadByName(String projectName, String branchName, List<String> help) {
-		if (Strings.isNullOrEmpty(projectName)) {
-			return help.isEmpty()? "": SysMLInteractiveHelp.getLoadHelp();
-		}
+	/**
+	 * Loads using the supplied parameters<br>
+	 * Possible parameters are:
+	 * <li> {@value SysMLInteractive#PROJECT_NAME_KEY}: name of the project</li>
+	 * <li> {@value SysMLInteractive#PROJECT_ID_KEY}: id of the project</li>
+	 * <li> {@value SysMLInteractive#BRANCH_NAME_KEY}: name of the project's branch</li>
+	 * <li> {@value SysMLInteractive#BRANCH_ID_KEY}: id of the project's branch </li>
+	 * <li>{@value SysMLInteractive#HELP_KEY}: request help string for the operation</li>
+	 * 
+	 * <br>
+	 * {@value SysMLInteractive#PROJECT_NAME_KEY} and {@value SysMLInteractive#PROJECT_ID_KEY} are mutually exclusive. It is mandatory to specify one of them.
+	 * <br>
+	 * {@value SysMLInteractive#BRANCH_NAME_KEY} and {@value SysMLInteractive#BRANCH_ID_KEY} are mutually exclusive. If neither is given the project's default branch is used.
+	 * <br>
+	 * If help {@value SysMLInteractive#HELP_KEY} is passed as a parameter (with any value) the help string is printed. Every other parameters are ignored.
+	 * 
+	 * <br>
+	 * <br>
+	 * @param parameters map containing the parameters and their values
+	 * @return output of the command
+	 */
+	public String load(Map<String, String> parameters) {
 
-		ProjectRepository repository = new ProjectRepository(apiBasePath);
-		RemoteProject repositoryProject = repository.getProjectByName(projectName);
+		if (parameters.containsKey(HELP_KEY)) {
+			return SysMLInteractiveHelp.getLoadHelp();
+		}
 
-		if (repositoryProject == null) {
-			return "ERROR:Project doesn't exist.";
+		if (parameters.containsKey(PROJECT_ID_KEY) && parameters.containsKey(PROJECT_NAME_KEY)) {
+			return "ERROR:Name and id cannot be provided at the same time.";
 		}
 
-		return load(repositoryProject, branchName);
-	}
-	
-	public String loadById(String projectId, String branchId, List<String> help) {
-		if (Strings.isNullOrEmpty(projectId)) {
-			return help.isEmpty()? "": SysMLInteractiveHelp.getLoadHelp();
+		if (parameters.containsKey(BRANCH_ID_KEY) && parameters.containsKey(BRANCH_NAME_KEY)) {
+			return "ERROR:Branch name and branch id cannot be provided at the same time";
 		}
 
-		ProjectRepository repository = new ProjectRepository(apiBasePath);
-		RemoteProject remoteProject = repository.getPRojectById(UUID.fromString(projectId));
+		final ProjectRepository repository = new ProjectRepository(apiBasePath);
+		final RemoteProject project;
 
-		if (remoteProject == null) {
-			return "ERROR:Project doesn't exist.";
+		if (parameters.containsKey(PROJECT_ID_KEY)) {
+			String projectId = parameters.get(PROJECT_ID_KEY);
+			project = repository.getProjectById(projectId);
+		} else if (parameters.containsKey(PROJECT_NAME_KEY)) {
+			String projectName = parameters.get(PROJECT_NAME_KEY);
+			project = repository.getProjectByName(projectName);
+		} else {
+			return SysMLInteractiveHelp.getLoadHelp();
 		}
 
-		if (branchId == null) {
-			return load(remoteProject, (UUID) null);
-		} else {
-			UUID branchUUID = UUID.fromString(branchId);
-			return load(remoteProject, branchUUID);
+		if (project == null) {
+			return "ERROR:Project doesn't exist.";
 		}
-	}
-	
-	private String load(RemoteProject remoteProject, String branchName) {
+		
 		final RemoteBranch branch;
-		if (branchName == null) {
-			branch = remoteProject.getDefaultBranch();
+		
+		if (parameters.containsKey(BRANCH_NAME_KEY)) {
+			String branchName = parameters.get(BRANCH_NAME_KEY);
+			branch = project.getBranch(branchName);
+		} else if (parameters.containsKey(BRANCH_ID_KEY)) {
+			String branchIdString = parameters.get(BRANCH_ID_KEY);
+			UUID branchId = UUID.fromString(branchIdString);
+			branch = project.getBranch(branchId);
 		} else {
-			branch = remoteProject.getBranch(branchName);
+			branch = project.getDefaultBranch();
 		}
+		
 		return load(branch);
 	}
 
-	private String load(RemoteProject remoteProject, UUID branchId) {
-		final RemoteBranch branch;
-		if (branchId == null) {
-			branch = remoteProject.getDefaultBranch();
-		} else {
-			branch = remoteProject.getBranch(branchId);
-		}
-		return load(branch);
-	}
-
 	private String load(RemoteBranch branch) {
 		if (branch == null) {
 			return "ERROR:Branch doesn't exist";
@@ -538,8 +558,8 @@ private String load(RemoteBranch branch) {
 
 	protected String download(String name) {
 		return "-h".equals(name)?
-				loadByName(null, null, Collections.singletonList("true")):
-				loadByName(name, null, Collections.emptyList());
+				load(Map.of(HELP_KEY, "true")):
+				load(Map.of(PROJECT_NAME_KEY, name));
 	}
 
 	public String projects(List<String> help) {

org.omg.sysml.jupyter.kernel/src/main/java/org/omg/sysml/jupyter/kernel/magic/Load.java

@@ -22,10 +22,11 @@
  */
 package org.omg.sysml.jupyter.kernel.magic;
 
+import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
 
-import org.omg.sysml.jupyter.kernel.ISysML;
+import org.omg.sysml.interactive.SysMLInteractive;
 
 import io.github.spencerpark.jupyter.kernel.magic.registry.LineMagic;
 import io.github.spencerpark.jupyter.kernel.magic.registry.MagicsArgs;
@@ -42,20 +43,36 @@ public class Load {
 	@LineMagic
 	public static String load(List<String> args) {
         Map<String, List<String>> vals = SHOW_ARGS.parse(args);
-        List<String> help = vals.get("help");
-        List<String> name = vals.get("name");
-        List<String> id = vals.get("id");
-        List<String> branches = vals.get("branch");
-        String branch = branches.isEmpty()? null: branches.get(0);
+        Map<String, String> parameters = new HashMap<>();
 
-        if (!name.isEmpty() && !id.isEmpty()) {
-        	return "Name and id cannot be provided at the same time.";
-        } else if (!name.isEmpty()) {
-        	return ISysML.getKernelInstance().getInteractive().loadByName(name.get(0), branch, help);
-        } else if (!id.isEmpty()) {
-        	return ISysML.getKernelInstance().getInteractive().loadById(id.get(0), branch, help);
-        } else {
-        	return ISysML.getKernelInstance().getInteractive().help("%load");
+        if (optionPassed(vals,"name")) {
+        	parameters.put(SysMLInteractive.PROJECT_NAME_KEY, getFirstValueOrNull(vals, "name"));
         }
+        
+        if (optionPassed(vals,"id")) {
+        	parameters.put(SysMLInteractive.PROJECT_ID_KEY, getFirstValueOrNull(vals, "id"));
+        }
+        
+        if (optionPassed(vals,"branch")) {
+        	parameters.put(SysMLInteractive.BRANCH_NAME_KEY, getFirstValueOrNull(vals, "branch"));
+        }
+        
+        if (optionPassed(vals,"help")) {
+        	parameters.put(SysMLInteractive.HELP_KEY, "true");
+        }
+        
+        return SysMLInteractive.getInstance().load(parameters);
+	}
+	
+	private static String getFirstValueOrNull(Map<String, List<String>> map, String key) {
+		if (map.containsKey(key)) {
+			List<String> values = map.get(key);
+			return values.isEmpty()? null: values.get(0);
+		}
+		return null;
+	}
+	
+	private static boolean optionPassed(Map<String, List<String>> map, String key) {
+		return map.containsKey(key) && map.get(key) != null && !map.get(key).isEmpty();
 	}
 }