occam-open-cli 5.0.122 → 5.0.125

package/README.md

@@ -35,10 +35,10 @@ These are the commands and options:
 
 Commands:
 
-  version                                        Show the version
-
   help                                           Show this help
   
+  version                                        Show the version
+
   [install] <package_name>                       Install a package
 
   initialise                                     Create a configuration file
@@ -68,6 +68,8 @@ Options:
   --quietly|-q                                   Run with almost no console logging
 
   --log-level|-l                                 Set the log level when publishing
+  
+  --yes|-y                                       Initially answer yes to prompts
 ```
 
 This is slightly different from `npm` in that `open` is usually executed from the parent directory of a project rather than from within the project sub-directory itself. Projects might reside in a `~/Mathematics/` directory, for example, in which case you should initialise `open` in there:

package/bin/abbreviations.js

@@ -1,14 +1,16 @@
 "use strict";
 
-const { HELP_OPTION, DRY_RUN_OPTION, VERSION_OPTION, QUIETLY_OPTION, LOG_LEVEL_OPTION } = require("./options");
+const { YES_OPTION, HELP_OPTION, DRY_RUN_OPTION, VERSION_OPTION, QUIETLY_OPTION, LOG_LEVEL_OPTION } = require("./options");
 
-const h = HELP_OPTION,
+const y = YES_OPTION,
+      h = HELP_OPTION,
       d = DRY_RUN_OPTION,
       v = VERSION_OPTION,
       q = QUIETLY_OPTION,
       l = LOG_LEVEL_OPTION
 
 module.exports = {
+  y,
   h,
   d,
   v,

package/bin/action/clone.js

@@ -1,20 +1,23 @@
 "use strict";
 
 const cloneOperation = require("../operation/clone"),
-      repositoryOperation = require("../operation/repository"),
-      releaseNamePromptOperation = require("../operation/prompt/releaseName");
+      cloneReleasesOperation = require("../operation/cloneReleases"),
+      releaseNamePromptOperation = require("../operation/prompt/releaseName"),
+      cloneDependenciesPromptOperation = require("../operation/prompt/cloneDependencies");
 
 const { executeOperations } = require("../utilities/operation"),
       { SUCCESSFUL_CLONE_MESSAGE, FAILED_CLONE_MESSAGE } = require("../messages");
 
-function cloneAction(argument, quietly) {
+function cloneAction(argument, quietly, yes) {
   const releaseName = argument,  ///
         operations = [
           releaseNamePromptOperation,
-          repositoryOperation,
-          cloneOperation
+          cloneDependenciesPromptOperation,
+          cloneOperation,
+          cloneReleasesOperation
         ],
         context = {
+          yes,
           quietly,
           releaseName
         };

package/bin/action/help.js

@@ -7,10 +7,10 @@ function helpAction() {
 
 Commands:
 
-  version                                        Show the version
-
   help                                           Show this help
   
+  version                                        Show the version
+
   [install] <package_name>                       Install a package
 
   initialise                                     Create a configuration file
@@ -40,6 +40,8 @@ Options:
   --quietly|-q                                   Run with almost no console logging
 
   --log-level|-l                                 Set the log level when publishing
+  
+  --yes|-y                                       Initially answer yes to prompts
 
 Further information:
 

package/bin/action/open.js

@@ -1,20 +1,21 @@
 "use strict";
 
 const openOperation = require("../operation/open"),
-      unpackReleasesOperation = require("../operation/unpackReleases"),
+      openReleasesOperation = require("../operation/openReleases"),
       releaseNamePromptOperation = require("../operation/prompt/releaseName");
 
 const { executeOperations } = require("../utilities/operation"),
       { SUCCESSFUL_OPEN_MESSAGE, FAILED_OPEN_MESSAGE } = require("../messages");
 
-function openAction(argument, quietly) {
+function openAction(argument, quietly, yes) {
   const releaseName = argument,  ///
         operations = [
           releaseNamePromptOperation,
           openOperation,
-          unpackReleasesOperation
+          openReleasesOperation
         ],
         context = {
+          yes,
           quietly,
           releaseName
         };

package/bin/actions.js

@@ -13,7 +13,7 @@ const helpAction = require("./action/help"),
       createAccountAction = require("./action/createAccount"),
       resetPasswordAction = require("./action/resetPassword");
 
-const { DEFAULT_HELP, DEFAULT_DRY_RUN, DEFAULT_VERSION, DEFAULT_QUIETLY, DEFAULT_LOG_LEVEL } = require("./defaults"),
+const { DEFAULT_YES, DEFAULT_HELP, DEFAULT_DRY_RUN, DEFAULT_VERSION, DEFAULT_QUIETLY, DEFAULT_LOG_LEVEL } = require("./defaults"),
       { HELP_COMMAND,
         OPEN_COMMAND,
         CLONE_COMMAND,
@@ -29,7 +29,8 @@ const { DEFAULT_HELP, DEFAULT_DRY_RUN, DEFAULT_VERSION, DEFAULT_QUIETLY, DEFAULT
 
 function actions(command, argument, options) {
   const commandMissing = (command === null),
-        { help = DEFAULT_HELP,
+        { yes = DEFAULT_YES,
+          help = DEFAULT_HELP,
           dryRun = DEFAULT_DRY_RUN,
           version = DEFAULT_VERSION,
           quietly = DEFAULT_QUIETLY,
@@ -47,8 +48,8 @@ function actions(command, argument, options) {
 
   switch (command) {
     case HELP_COMMAND : helpAction(); break;
-    case OPEN_COMMAND : openAction(argument, quietly); break;
-    case CLONE_COMMAND : cloneAction(argument, quietly); break;
+    case OPEN_COMMAND : openAction(argument, quietly, yes); break;
+    case CLONE_COMMAND : cloneAction(argument, quietly, yes); break;
     case VERSION_COMMAND : versionAction(); break;
     case PUBLISH_COMMAND : publishAction(argument, dryRun, logLevel); break;
     case SIGN_IN_COMMAND : signInAction(argument); break;

package/bin/constants.js

@@ -1,6 +1,7 @@
 "use strict";
 
-const END = "end",
+const YES = "yes",
+      END = "end",
       DATA = "data",
       OPEN = "open",
       HOST_URL = "hostURL",
@@ -12,6 +13,7 @@ const END = "end",
       PACKAGE_JSON = "package.json";
 
 module.exports = {
+  YES,
   END,
   DATA,
   OPEN,

package/bin/defaults.js

@@ -4,7 +4,8 @@ const { levels } = require("necessary");
 
 const { INFO_LEVEL } = levels;
 
-const DEFAULT_HELP = false,
+const DEFAULT_YES = false,
+      DEFAULT_HELP = false,
       DEFAULT_HOST = "https://openmathematics.org",
       DEFAULT_DRY_RUN = false,
       DEFAULT_VERSION = false,
@@ -13,6 +14,7 @@ const DEFAULT_HELP = false,
       DEFAULT_GITHUB_HOST_NAME = "github.com";
 
 module.exports = {
+  DEFAULT_YES,
   DEFAULT_HELP,
   DEFAULT_HOST,
   DEFAULT_DRY_RUN,

package/bin/descriptions.js

@@ -8,6 +8,7 @@ const USE_SSH_DESCRIPTION = "Use SSH when cloning: ",
       EMAIL_ADDRESS_DESCRIPTION = "Email address: ",
       CONFIRM_PASSWORD_DESCRIPTION = "Confirm password: ",
       GITHUB_HOST_NAME_DESCRIPTION = "GitHub host name (leave blank for default): ",
+      CLONE_DEPENDENCIES_DESCRIPTION = "Clone dependencies? (y)es (n)o: ",
       EMAIL_ADDRESS_OR_USERNAME_DESCRIPTION = "Email address or username: ";
 
 module.exports = {
@@ -19,5 +20,6 @@ module.exports = {
   EMAIL_ADDRESS_DESCRIPTION,
   CONFIRM_PASSWORD_DESCRIPTION,
   GITHUB_HOST_NAME_DESCRIPTION,
+  CLONE_DEPENDENCIES_DESCRIPTION,
   EMAIL_ADDRESS_OR_USERNAME_DESCRIPTION
 };

package/bin/messages.js

@@ -4,6 +4,7 @@ const PASSWORDS_DO_NOT_MATCH_MESSAGE = "The passwords do not match.",
       SERVER_FAILED_TO_RESPOND_ERROR_MESSAGE = "The server did not respond in a timely or intelligible fashion. If this problem persists then please be kind enough to report it.",
       CONFIGURATION_FILE_DOES_NOT_EXIST_MESSAGE = "The action cannot be performed because the configuration file is missing. Run 'open initialise' to create one.",
       SIGN_OUT_MESSAGE = "You have been signed out.",
+      INVALID_ANSWER_MESSAGE = "You must answer (y)es or (n)o.",
       INVALID_USERNAME_MESSAGE = "Usernames must consist of groups of at least two and no more than sixteen numbers or lowercase letters, separated by dashes.",
       INVALID_PASSWORD_MESSAGE = "Passwords must consist of at least eight letters, numbers or common punctuation symbols.",
       INVALID_AFFIRMATION_MESSAGE = "You must answer (y)es or (n)o.",
@@ -29,6 +30,7 @@ module.exports = {
   SERVER_FAILED_TO_RESPOND_ERROR_MESSAGE,
   CONFIGURATION_FILE_DOES_NOT_EXIST_MESSAGE,
   SIGN_OUT_MESSAGE,
+  INVALID_ANSWER_MESSAGE,
   INVALID_USERNAME_MESSAGE,
   INVALID_PASSWORD_MESSAGE,
   INVALID_AFFIRMATION_MESSAGE,

package/bin/operation/clone.js

@@ -1,51 +1,25 @@
 "use strict";
 
-const { exec } = require("child_process"),
-      { fileSystemUtilities } = require("necessary");
+const post = require("../post");
 
-const { checkEntryExists } = fileSystemUtilities;
-
-const { getOptions } = require("../configuration"),
-      { DEFAULT_GITHUB_HOST_NAME } = require("../defaults");
+const { CLONE_API_URI } = require("../uris");
 
 function cloneOperation(proceed, abort, context) {
   const { releaseName } = context,
-        path = releaseName, ///
-        entryExists = checkEntryExists(path);
-
-  if (entryExists) {
-    const { quietly } = context;
-
-    if (!quietly) {
-      console.log(`Cannot clone the '${releaseName}' package because an entry of that name already exists.`);
-    }
-
-    proceed();
-
-    return;
-  }
-
-  let { repository } = context;
-
-  const options = getOptions(),
-        { ssh } = options;
-
-  if (ssh) {
-    const { gitHubHostName } = ssh;
-
-    repository = repository.replace(`https://${DEFAULT_GITHUB_HOST_NAME}/`, `git@${gitHubHostName}:`)
-  }
-
-  const command = `git clone ${repository}.git`;
+        uri = `${CLONE_API_URI}/${releaseName}`,
+        json = {};
 
-  exec(command, (error) => {
-    if (error) {
-      abort();
+  post(uri, json, (json) => {
+    const { success, releases = null } = json;
 
-      return;
-    }
+    Object.assign(context, {
+      success,
+      releases
+    });
 
-    proceed();
+    success ?
+      proceed() :
+        abort();
   });
 }
 

package/bin/operation/clone.old.js

@@ -0,0 +1,52 @@
+"use strict";
+
+const { exec } = require("child_process"),
+      { fileSystemUtilities } = require("necessary");
+
+const { checkEntryExists } = fileSystemUtilities;
+
+const { getOptions } = require("../configuration"),
+      { DEFAULT_GITHUB_HOST_NAME } = require("../defaults");
+
+function cloneOperation(proceed, abort, context) {
+  const { releaseName } = context,
+        path = releaseName, ///
+        entryExists = checkEntryExists(path);
+
+  if (entryExists) {
+    const { quietly } = context;
+
+    if (!quietly) {
+      console.log(`Cannot clone the '${releaseName}' package because an entry of that name already exists.`);
+    }
+
+    proceed();
+
+    return;
+  }
+
+  let { repository } = context;
+
+  const options = getOptions(),
+        { ssh } = options;
+
+  if (ssh) {
+    const { gitHubHostName } = ssh;
+
+    repository = repository.replace(`https://${DEFAULT_GITHUB_HOST_NAME}/`, `git@${gitHubHostName}:`)
+  }
+
+  const command = `git clone ${repository}.git`;
+
+  exec(command, (error) => {
+    if (error) {
+      abort();
+
+      return;
+    }
+
+    proceed();
+  });
+}
+
+module.exports = cloneOperation;

package/bin/operation/cloneReleases.js

@@ -0,0 +1,75 @@
+"use strict";
+
+const { exec } = require("child_process"),
+      { fileSystemUtilities, asynchronousUtilities } = require("necessary");
+
+const { getOptions } = require("../configuration"),
+      { DEFAULT_GITHUB_HOST_NAME } = require("../defaults");
+
+const { checkEntryExists } = fileSystemUtilities;
+
+const { forEach } = asynchronousUtilities;
+
+function cloneReleasesOperation(proceed, abort, context) {
+  const { releases } = context,
+        done = proceed; ///
+
+  forEach(releases, cloneReleasePromptOperation, done, context);
+}
+
+module.exports = cloneReleasesOperation;
+
+function cloneReleasePromptOperation(release, next, done, context, index) {
+  const { cloneDependencies } = context;
+
+  if (!cloneDependencies) {
+    if (index > 0) {
+      next();
+
+      return;
+    }
+  }
+
+  const { name } = release,
+        entryPath = name, ///
+        entryExists = checkEntryExists(entryPath);
+
+  if (entryExists) {
+    const { quietly } = context;
+
+    if (!quietly) {
+      console.log(`Cannot clone the '${name}' package because a directory of that name already exists.`);
+    }
+
+    next();
+
+    return;
+  }
+
+  done = next;  ///
+
+  cloneRelease(release, done);
+}
+
+function cloneRelease(release, done) {
+  let repository = release.getRepository();
+
+  const options = getOptions(),
+        { ssh } = options;
+
+  if (ssh) {
+    const { gitHubHostName } = ssh;
+
+    repository = repository.replace(`https://${DEFAULT_GITHUB_HOST_NAME}/`, `git@${gitHubHostName}:`)
+  }
+
+  const command = `git clone ${repository}.git`;
+
+  exec(command, (error) => {
+    if (error) {
+      console.log(error);
+    }
+
+    done();
+  });
+}

package/bin/operation/open.js

@@ -17,7 +17,9 @@ function openOperation(proceed, abort, context) {
       releases
     });
 
-    proceed();
+    success ?
+      proceed() :
+        abort();
   });
 }
 

package/bin/operation/openReleases.js

@@ -0,0 +1,90 @@
+"use strict";
+
+const { shellUtilities, fileSystemUtilities, asynchronousUtilities } = require("necessary");
+
+const { YES } = require("../constants"),
+      { validateAnswer } = require("../utilities/validate"),
+      { isAnswerAffirmative } = require("../utilities/prompt"),
+      { INVALID_ANSWER_MESSAGE } = require("../messages");
+
+const { writeFile, removeEntry, checkEntryExists, isEntryDirectory } = fileSystemUtilities;
+
+const { prompt } = shellUtilities,
+      { forEach } = asynchronousUtilities;
+
+function openReleasesOperation(proceed, abort, context) {
+  const { releases } = context,
+        done = proceed; ///
+
+  forEach(releases, openReleasePromptOperation, done, context);
+}
+
+module.exports = openReleasesOperation;
+
+function openReleasePromptOperation(release, next, done, context) {
+  const { name } = release,
+        entryPath = name, ///
+        entryExists = checkEntryExists(entryPath);
+
+  if (!entryExists) {
+    openRelease(release);
+
+    next();
+
+    return;
+  }
+
+  const entryDirectory = isEntryDirectory(entryPath);
+
+  if (entryDirectory) {
+    const { quietly } = context;
+
+    if (!quietly) {
+      console.log(`Cannot open the '${name}' package because a directory of that name already exists.`);
+    }
+
+    next();
+
+    return;
+  }
+
+  const { yes } = context,
+        answer = yes ?
+                   YES :
+                     null,
+        description = `Overwrite the existing '${name}' package? (y)es (n)o: `,
+        errorMessage = INVALID_ANSWER_MESSAGE,
+        validationFunction = validateAnswer,  ///
+        options = {
+        answer,
+          description,
+          errorMessage,
+          validationFunction
+        };
+
+  prompt(options, (answer) => {
+    const valid = (answer !== null);
+
+    if (valid) {
+      const affirmative = isAnswerAffirmative(answer);
+
+      if (affirmative) {
+        removeEntry(entryPath);
+
+        openRelease(release);
+      }
+
+      next();
+    }
+  });
+}
+
+function openRelease(release) {
+  const { name } = release,
+        filePath = name,  ///
+        releaseJSON = release,  ///
+        releaseJSONString = JSON.stringify(releaseJSON),
+        content = releaseJSONString; ///
+
+  writeFile(filePath, content);
+}

package/bin/operation/prompt/areYouSure.js

@@ -2,8 +2,8 @@
 
 const { shellUtilities } = require("necessary");
 
-const { validateAffirmation } = require("../../utilities/validate"),
-      { isAnswerAffirmative } = require("../../utilities/prompt"),
+const { isAnswerAffirmative } = require("../../utilities/prompt"),
+      { validateAffirmation } = require("../../utilities/validate"),
       { ARE_YOU_SURE_DESCRIPTION } = require("../../descriptions"),
       { INVALID_AFFIRMATION_MESSAGE } = require("../../messages");
 

package/bin/operation/prompt/cloneDependencies.js

@@ -0,0 +1,48 @@
+"use strict";
+
+const { shellUtilities } = require("necessary");
+
+const { YES } = require("../../constants"),
+      { isAnswerAffirmative } = require("../../utilities/prompt"),
+      { validateAffirmation } = require("../../utilities/validate"),
+      { INVALID_AFFIRMATION_MESSAGE } = require("../../messages"),
+      { CLONE_DEPENDENCIES_DESCRIPTION } = require("../../descriptions");
+
+const { prompt } = shellUtilities;
+
+function cloneDependenciesPromptOperation(proceed, abort, context) {
+  const { yes } = context,
+        answer = yes ?
+                   YES :
+                     null,
+        description = CLONE_DEPENDENCIES_DESCRIPTION,
+        errorMessage = INVALID_AFFIRMATION_MESSAGE,
+        validationFunction = validateAffirmation,  ///
+        options = {
+          answer,
+          description,
+          errorMessage,
+          validationFunction
+        };
+
+  prompt(options, (answer) => {
+    const valid = (answer !== null);
+
+    if (valid) {
+      const affirmative = isAnswerAffirmative(answer),
+            cloneDependencies = affirmative; ///
+
+      Object.assign(context, {
+        cloneDependencies
+      });
+
+      proceed();
+
+      return;
+    }
+
+    abort();
+  });
+}
+
+module.exports = cloneDependenciesPromptOperation;

package/bin/operation/prompt/releaseName.js

@@ -19,9 +19,9 @@ function releaseNamePromptOperation(proceed, abort, context) {
       proceed();
       
       return;
-    } else {
-      console.log(errorMessage);
     }
+
+    console.log(errorMessage);
   }
 
   const description = RELEASE_NAME_DESCRIPTION,

package/bin/options.js

@@ -1,12 +1,14 @@
 "use strict";
 
-const HELP_OPTION = "help",
+const YES_OPTION = "yes",
+      HELP_OPTION = "help",
       VERSION_OPTION = "version",
       QUIETLY_OPTION = "quietly",
       DRY_RUN_OPTION = "dry-run",
       LOG_LEVEL_OPTION = "log-level";
 
 module.exports = {
+  YES_OPTION,
   HELP_OPTION,
   VERSION_OPTION,
   QUIETLY_OPTION,

package/bin/utilities/validate.js

@@ -1,5 +1,6 @@
 "use strict";
 
+function validateAnswer(answer) { return  /^(:?yes|no|y|n)$/i.test(answer); }
 
 function validateUsername(username) { return /^[a-z0-9]{2,16}(?:-[a-z0-9]{2,16}){0,4}$/.test(username); }
 
@@ -32,6 +33,7 @@ function validateEmailAddressOrUsername(emailAddressOrUsername) {
 }
 
 module.exports = {
+  validateAnswer,
   validateUsername,
   validatePassword,
   validateAffirmation,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "occam-open-cli",
   "author": "James Smith",
-  "version": "5.0.122",
+  "version": "5.0.125",
   "license": "MIT, Anti-996",
   "homepage": "https://github.com/djalbat/occam-open-cli",
   "description": "Occam's command line package management tool.",
@@ -11,7 +11,7 @@
   },
   "dependencies": {
     "argumentative": "^2.0.21",
-    "necessary": "^11.1.4",
+    "necessary": "^11.2.0",
     "occam-file-system": "^5.0.83"
   },
   "scripts": {},

package/bin/operation/repository.js

@@ -1,29 +0,0 @@
-"use strict";
-
-const post = require("../post");
-
-const { CLONE_API_URI } = require("../uris");
-
-function repositoryOperation(proceed, abort, context) {
-  const { releaseName } = context,
-        uri = `${CLONE_API_URI}/${releaseName}`,
-        json = {};
-
-  post(uri, json, (json) => {
-    const { repository = null } = json;
-
-    if (repository === null) {
-      abort();
-
-      return;
-    }
-
-    Object.assign(context, {
-      repository
-    });
-
-    proceed();
-  });
-}
-
-module.exports = repositoryOperation;

package/bin/operation/unpackReleases.js

@@ -1,42 +0,0 @@
-"use strict";
-
-const { fileSystemUtilities } = require("necessary");
-
-const { writeFile, checkEntryExists } = fileSystemUtilities;
-
-function unpackReleasesOperation(proceed, abort, context) {
-  const { releases } = context;
-
-  if (releases === null) {
-    abort();
-
-    return;
-  }
-
-  releases.forEach((release) => {
-    const { name } = release,
-          path = name, ///
-          entryExists = checkEntryExists(path);
-
-    if (entryExists) {
-      const { quietly } = context;
-
-      if (!quietly) {
-        console.log(`Cannot write the '${name}' package to disk because an entry of that name already exists.`);
-      }
-
-      return;
-    }
-
-    const filePath = path,  ///
-          releaseJSON = release,  ///
-          releaseJSONString = JSON.stringify(releaseJSON),
-          content = releaseJSONString; ///
-
-    writeFile(filePath, content);
-  });
-
-  proceed();
-}
-
-module.exports = unpackReleasesOperation;