shortcuts: git{lab,hub}.com is supported

Author: mr-c

CONTRIBUTING.md

@@ -109,7 +109,7 @@ are used when they would otherwise not be required.
 ### Basic Application Flow
 
 1. User fills in the form on the front page. This is represented by 
-`workflow.WorkflowForm` and consists of just a URL to Github/Gitlab, 
+`workflow.WorkflowForm` and consists of just a URL to github.com/gitlab.com,
 or a URL to a git repository as well as the branch and path of a 
 workflow within the repository.
 

src/main/java/org/commonwl/view/workflow/WorkflowController.java

@@ -174,8 +174,8 @@ public ModelAndView createWorkflow(@Valid WorkflowForm workflowForm, BindingResu
     }
 
     /**
-     * Display a page for a particular workflow from Github or Github format URL
-     * @param domain The domain of the hosting site, Github or Gitlab
+     * Display a page for a particular workflow from github.com or gitlab.com format URL
+     * @param domain The domain of the hosting site, github.com or gitlab.com
      * @param owner The owner of the repository
      * @param repoName The name of the repository
      * @param branch The branch of repository
@@ -217,7 +217,7 @@ public ModelAndView getWorkflowGeneric(@Value("${applicationURL}") String applic
 
     /**
      * Download the Research Object Bundle for a particular workflow
-     * @param domain The domain of the hosting site, Github or Gitlab
+     * @param domain The domain of the hosting site, github.com or gitlab.com
      * @param owner The owner of the repository
      * @param repoName The name of the repository
      * @param branch The branch of repository
@@ -260,7 +260,7 @@ public Resource getROBundleGeneric(@PathVariable("branch") String branch,
 
     /**
      * Download a generated graph for a workflow in SVG format
-     * @param domain The domain of the hosting site, Github or Gitlab
+     * @param domain The domain of the hosting site, github.com or gitlab.com
      * @param owner The owner of the repository
      * @param repoName The name of the repository
      * @param branch The branch of repository
@@ -300,7 +300,7 @@ public Resource downloadGraphSvgGeneric(@PathVariable("branch") String branch,
 
     /**
      * Download a generated graph for a workflow in PNG format
-     * @param domain The domain of the hosting site, Github or Gitlab
+     * @param domain The domain of the hosting site, github.com or gitlab.com
      * @param owner The owner of the repository
      * @param repoName The name of the repository
      * @param branch The branch of repository
@@ -340,7 +340,7 @@ public Resource downloadGraphPngGeneric(@PathVariable("branch") String branch,
 
     /**
      * Download a generated graph for a workflow in XDOT format
-     * @param domain The domain of the hosting site, Github or Gitlab
+     * @param domain The domain of the hosting site, github.com or gitlab.com
      * @param owner The owner of the repository
      * @param repoName The name of the repository
      * @param branch The branch of repository
@@ -441,8 +441,8 @@ public static String extractPath(String path, int startSlashNum) {
     }
 
     /**
-     * Constructs a GitDetails object for Github/Gitlab details
-     * @param domain The domain name (always .com)
+     * Constructs a GitDetails object for github.com/gitlab.com details
+     * @param domain The domain name ("github" or "gitlab", without .com)
      * @param owner The owner of the repository
      * @param repoName The name of the repository
      * @param branch The branch of the repository

src/main/java/org/commonwl/view/workflow/WorkflowFormValidator.java

@@ -38,19 +38,19 @@ public class WorkflowFormValidator {
 
     private final Logger logger = LoggerFactory.getLogger(this.getClass());
 
-    // URL validation for cwl files on Github
+    // URL validation for cwl files on github.com
     private static final String GITHUB_CWL_REGEX = "^https?:\\/\\/github\\.com\\/([A-Za-z0-9_.-]+)\\/([A-Za-z0-9_.-]+)\\/?(?:tree|blob)\\/([^/]+)(?:\\/(.+\\.cwl))$";
     private static final Pattern githubCwlPattern = Pattern.compile(GITHUB_CWL_REGEX);
 
-    // URL validation for directories on Github
+    // URL validation for directories on github.com
     private static final String GITHUB_DIR_REGEX = "^https?:\\/\\/github\\.com\\/([A-Za-z0-9_.-]+)\\/([A-Za-z0-9_.-]+)\\/?(?:(?:tree|blob)\\/([^/]+)\\/?(.*)?)?$";
     private static final Pattern githubDirPattern = Pattern.compile(GITHUB_DIR_REGEX);
 
-    // URL validation for cwl files on Gitlab
+    // URL validation for cwl files on gitlab.com
     private static final String GITLAB_CWL_REGEX = "^https?:\\/\\/gitlab\\.com\\/([A-Za-z0-9_.-]+)\\/([A-Za-z0-9_.-]+)\\/?(?:tree|blob)\\/([^/]+)(?:\\/(.+\\.cwl))$";
     private static final Pattern gitlabCwlPattern = Pattern.compile(GITLAB_CWL_REGEX);
 
-    // URL validation for directories on Gitlab
+    // URL validation for directories on gitlab.com
     private static final String GITLAB_DIR_REGEX = "^https?:\\/\\/gitlab\\.com\\/([A-Za-z0-9_.-]+)\\/([A-Za-z0-9_.-]+)\\/?(?:(?:tree|blob)\\/([^/]+)\\/?(.*)?)?$";
     private static final Pattern gitlabDirPattern = Pattern.compile(GITLAB_DIR_REGEX);
 
@@ -84,31 +84,31 @@ public GitDetails validateAndParse(WorkflowForm form, Errors e) {
                 packedId = form.getPackedId();
             }
 
-            // Github URL
+            // github.com URL
             Matcher m = githubCwlPattern.matcher(form.getUrl());
             if (m.find()) {
                 repoUrl = "https://github.com/" + m.group(1) + "/" + m.group(2) + ".git";
                 if (branch == null) branch = m.group(3);
                 if (path == null) path = m.group(4);
             }
 
-            // Gitlab URL
+            // gitlab.com URL
             m = gitlabCwlPattern.matcher(form.getUrl());
             if (m.find()) {
                 repoUrl = "https://gitlab.com/" + m.group(1) + "/" + m.group(2) + ".git";
                 if (branch == null) branch = m.group(3);
                 if (path == null) path = m.group(4);
             }
 
-            // Github Dir URL
+            // github.com Dir URL
             m = githubDirPattern.matcher(form.getUrl());
             if (m.find() && ! m.group(2).endsWith(".git")) {
                 repoUrl = "https://github.com/" + m.group(1) + "/" + m.group(2) + ".git";
                 if (branch == null) branch = m.group(3);
                 if (path == null) path = m.group(4);
             }
 
-            // Gitlab Dir URL
+            // gitlab.com Dir URL
             m = gitlabDirPattern.matcher(form.getUrl());
             if (m.find() && ! m.group(2).endsWith(".git")) {
                 repoUrl = "https://gitlab.com/" + m.group(1) + "/" + m.group(2) + ".git";
@@ -158,4 +158,4 @@ private boolean isEmptyOrWhitespace(String str) {
                 str.length() == 0 ||
                 StringUtils.isWhitespace(str));
     }
-}
+}

src/main/java/org/commonwl/view/workflow/WorkflowJSONController.java

@@ -166,8 +166,8 @@ public ResponseEntity<?> newWorkflowFromGitURLJson(@RequestParam(value="url") St
     }
 
     /**
-     * Get the JSON representation of a workflow from Github or Gitlab details
-     * @param domain The domain of the hosting site, Github or Gitlab
+     * Get the JSON representation of a workflow from github.com or gitlab.com details
+     * @param domain The domain of the hosting site, github.com or gitlab.com
      * @param owner The owner of the Github repository
      * @param repoName The name of the repository
      * @param branch The branch of repository

src/main/java/org/commonwl/view/workflow/WorkflowService.java

@@ -567,7 +567,7 @@ public Optional<String> findRawBaseForCommit(String commitId) {
                 return Optional.of(potentialRaw.replace(path, ""));
             }
         }
-        // Not found, or not at GitHub/GitLab
+        // Not found, or not at github.com/gitlab.com
         return Optional.empty();
 
     }

src/main/resources/messages.properties

@@ -1,4 +1,4 @@
-url.emptyOrWhitespace = Must be a URL to a workflow on Gitlab or Github, or a Git repository URL
+url.emptyOrWhitespace = Must be a URL to a workflow on gitlab.com or github.com, or a Git repository URL
 branch.emptyOrWhitespace = You must provide a branch where the workflow exists
 path.emptyOrWhitespace = You must provide a path to the workflow within the repository
 
@@ -7,4 +7,4 @@ git.notFound = The workflow could not be found within the repository
 git.sshError = SSH URLs are not supported, please provide a HTTPS URL for the repository or submodules
 
 url.parsingError = An unexpected error occurred when parsing the workflow
-url.noWorkflowsInDirectory = No workflow files were found in the given directory
+url.noWorkflowsInDirectory = No workflow files were found in the given directory

src/main/resources/static/js/main.js

@@ -94,7 +94,7 @@ require(['jquery'],
                 }
                 return success;
             } else if (!githubPattern.test(input) && !gitlabPattern.test(input)) {
-                addWarning("url", "Must be a URL to a workflow or directory of workflows on Gitlab or Github, or a Git repository URL");
+                addWarning("url", "Must be a URL to a workflow or directory of workflows on gitlab.com or github.com, or a Git repository URL");
                 return false;
             }
         });
@@ -111,4 +111,4 @@ require(['jquery'],
         }
 
         $("#url").trigger("change");
-    });
+    });

src/main/resources/templates/about.html

@@ -68,8 +68,8 @@ <h1>About</h1>
 		<section id="privacy"> 
             <h1>Privacy policy</h1>
             <p>CWL Viewer publishes visualizations of workflows from publicly available 
-            <em>git</em> repositories hosted by third-parties like <a href="https://github.com/">GitHub</a>
-            or <a href="https://about.gitlab.com/">GitLab</a>.             
+            <em>git</em> repositories hosted by third-parties like <a href="https://github.com/">github.com</a>
+            or <a href="https://about.gitlab.com/">gitlab.com</a>.             
             Anyone can submit a workflow, which will be added 
             to our <a href="/workflows">public listing</a>.                         
             </p>

src/main/resources/templates/apidocs.html

@@ -59,17 +59,17 @@ <h4>Parameters</h4>
                         <tr>
                             <td>url</td>
                             <td>String</td>
-                            <td>The URL of the repository. Either a Gitlab or Github URL, or any Git repository URL. If a Gitlab or Github repository URL is used, the following fields will take priority over those parsed from the URL if provided.</td>
+                            <td>The URL of the repository. Either a gitlab.com or github.com URL, or any Git repository URL. If a gitlab.com or github.com repository URL is used, the following fields will take priority over those parsed from the URL if provided.</td>
                         </tr>
                         <tr>
                             <td>branch</td>
                             <td>String</td>
-                            <td>The branch of the repository. Required if the URL is not from Gitlab or Github.</td>
+                            <td>The branch of the repository. Required if the URL is not from gitlab.com or github.com.</td>
                         </tr>
                         <tr>
                             <td>path</td>
                             <td>String</td>
-                            <td>The path within the repository to the workflow file. Required if the URL is not from Gitlab or Github.</td>
+                            <td>The path within the repository to the workflow file. Required if the URL is not from gitlab.com or github.com.</td>
                         </tr>
                         <tr>
                             <td>packedId</td>

src/main/resources/templates/index.html

@@ -48,7 +48,7 @@ <h1>Common Workflow Language Viewer</h1>
                     <hr/>
 
                     <h2>Workflow URL</h2>
-                    <p>Provide a Github, Gitlab or Git repository link to the workflow (or directory of workflows) here</p>
+                    <p>Provide a github.com, gitlab.com or Git repository link to the workflow (or directory of workflows) here</p>
                     <div class="alert alert-grey">
                         <strong>Don't know what to view?</strong> Try these from <i>common-workflow-language/workflows</i>:
                         <a class="example" href="https://github.com/common-workflow-language/workflows/tree/master/workflows/compile/compile1.cwl">compile</a>,
@@ -67,7 +67,7 @@ <h2>Workflow URL</h2>
                         </div>
                         <div id="urlGroup" class="form-group">
                             <label class="control-label" for="url">URL to workflow</label>
-                            <input type="text" class="form-control" placeholder="Github, Gitlab or Git repository URL" id="url" name="url" th:field="*{url}" th:value="${formURL}" />
+                            <input type="text" class="form-control" placeholder="github.com, gitlab.com or Git repository URL" id="url" name="url" th:field="*{url}" th:value="${formURL}" />
                             <span class="help-block"></span>
                         </div>
                         <div id="extraInputs" class="row">