occam-open-cli 5.0.105 → 5.0.106

package/README.md

@@ -63,6 +63,8 @@ Options:
 
   --version|-v                                   Show the version
 
+  --quietly|-q                                   Run with almost no console logging
+
   --log-level|-l                                 Set the log level when publishing
 ```
 

package/bin/abbreviations.js

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

package/bin/action/help.js

@@ -35,6 +35,8 @@ Options:
 
   --version|-v                                   Show the version
 
+  --quietly|-q                                   Run with almost no console logging
+
   --log-level|-l                                 Set the log level when publishing
 
 Further information:

package/bin/action/open.js

@@ -1,13 +1,34 @@
 "use strict";
 
-const { OPEN_MESSAGE } = require("../messages");
+const openOperation = require("../operation/open"),
+      unpackReleasesOperation = require("../operation/unpackReleases"),
+      releaseNamePromptOperation = require("../operation/prompt/releaseName");
 
-function openAction(argument) {
-  const message = OPEN_MESSAGE;
+const { executeOperations } = require("../utilities/operation"),
+      { SUCCESSFUL_OPEN_MESSAGE, FAILED_OPEN_MESSAGE } = require("../messages");
 
-  console.log(message);
+function openAction(argument, quietly) {
+  const releaseName = argument,  ///
+        operations = [
+          releaseNamePromptOperation,
+          openOperation,
+          unpackReleasesOperation
+        ],
+        context = {
+          quietly,
+          releaseName
+        };
 
-  process.exit();
+  executeOperations(operations, (completed) => {
+    const success = completed,  ///
+          message = success ?
+                      SUCCESSFUL_OPEN_MESSAGE :
+                        FAILED_OPEN_MESSAGE;
+
+    console.log(message);
+
+    process.exit();
+  }, context);
 }
 
 module.exports = openAction;

package/bin/action/publish.js

@@ -1,8 +1,8 @@
 "use strict";
 
 const publishOperation = require("../operation/publish"),
-      zipReleaseOperation = require("../operation/zipRelease"),
       loadReleaseOperation = require("../operation/loadRelease"),
+      packReleaseOperation = require("../operation/packRelease"),
       getIdentityTokenOperation = require("../operation/getIdentityToken"),
       releaseNamePromptOperation = require("../operation/prompt/releaseName"),
       updateMetaJSONFileVersionOperation = require("../operation/updateMetaJSONFileVersion");
@@ -17,7 +17,7 @@ function publishAction(argument, dryRun, logLevel) {
           getIdentityTokenOperation,
           releaseNamePromptOperation,
           loadReleaseOperation,
-          zipReleaseOperation,
+          packReleaseOperation,
           publishOperation,
           updateMetaJSONFileVersionOperation
         ],

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_LOG_LEVEL } = require("./defaults"),
+const { DEFAULT_HELP, DEFAULT_DRY_RUN, DEFAULT_VERSION, DEFAULT_QUIETLY, DEFAULT_LOG_LEVEL } = require("./defaults"),
       { HELP_COMMAND,
         CLONE_COMMAND,
         VERSION_COMMAND,
@@ -32,6 +32,7 @@ function actions(command, argument, options) {
         { help = DEFAULT_HELP,
           dryRun = DEFAULT_DRY_RUN,
           version = DEFAULT_VERSION,
+          quietly = DEFAULT_QUIETLY,
           logLevel = DEFAULT_LOG_LEVEL } = options;
 
   if (false) {
@@ -59,7 +60,7 @@ function actions(command, argument, options) {
     default :
       argument = command;  ///
 
-      open(argument);
+      openAction(argument, quietly);
 
       break;
   }

package/bin/defaults.js

@@ -8,6 +8,7 @@ const DEFAULT_HELP = false,
       DEFAULT_HOST = "https://openmathematics.org",
       DEFAULT_DRY_RUN = false,
       DEFAULT_VERSION = false,
+      DEFAULT_QUIETLY = false,
       DEFAULT_LOG_LEVEL = INFO_LEVEL,
       DEFAULT_GITHUB_HOST_NAME = "github.com";
 
@@ -16,6 +17,7 @@ module.exports = {
   DEFAULT_HOST,
   DEFAULT_DRY_RUN,
   DEFAULT_VERSION,
+  DEFAULT_QUIETLY,
   DEFAULT_LOG_LEVEL,
   DEFAULT_GITHUB_HOST_NAME
 };

package/bin/messages.js

@@ -3,7 +3,6 @@
 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.",
-      OPEN_MESSAGE = "The open functionality is not implemented yet.",
       SIGN_OUT_MESSAGE = "You have been signed out.",
       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.",
@@ -12,11 +11,13 @@ const PASSWORDS_DO_NOT_MATCH_MESSAGE = "The passwords do not match.",
       INVALID_EMAIL_ADDRESS_MESSAGE = "The email address does not appear to be a valid one.",
       INVALID_GITHUB_HOST_NAME_MESSAGE = "The GitHub host name can be any number of alphabetical, numeric, dash or period characters, or can be left blank.",
       INVALID_EMAIL_ADDRESS_OR_USERNAME_MESSAGE = "The email address or username does not appear to be a valid one.",
+      FAILED_OPEN_MESSAGE = "Failed to open the package.",
       FAILED_CLONE_MESSAGE = "Failed to clone the package.",
       FAILED_PUBLISH_MESSAGE = "Failed to publish the package.",
       FAILED_DEPRECATE_MESSAGE = "Failed to deprecate the package.",
       FAILED_INITIALISE_MESSAGE = "Failed to create a configuration file because one is already present.",
       FAILED_SET_OPTIONS_MESSAGE = "Failed to set the options.",
+      SUCCESSFUL_OPEN_MESSAGE = "The package has been opened successfully.",
       SUCCESSFUL_CLONE_MESSAGE = "The package has been cloned successfully.",
       SUCCESSFUL_PUBLISH_MESSAGE = "The package has been published successfully.",
       SUCCESSFUL_DEPRECATE_MESSAGE = "The package has been deprecated successfully.",
@@ -27,7 +28,6 @@ module.exports = {
   PASSWORDS_DO_NOT_MATCH_MESSAGE,
   SERVER_FAILED_TO_RESPOND_ERROR_MESSAGE,
   CONFIGURATION_FILE_DOES_NOT_EXIST_MESSAGE,
-  OPEN_MESSAGE,
   SIGN_OUT_MESSAGE,
   INVALID_USERNAME_MESSAGE,
   INVALID_PASSWORD_MESSAGE,
@@ -36,11 +36,13 @@ module.exports = {
   INVALID_EMAIL_ADDRESS_MESSAGE,
   INVALID_GITHUB_HOST_NAME_MESSAGE,
   INVALID_EMAIL_ADDRESS_OR_USERNAME_MESSAGE,
+  FAILED_OPEN_MESSAGE,
   FAILED_CLONE_MESSAGE,
   FAILED_PUBLISH_MESSAGE,
   FAILED_DEPRECATE_MESSAGE,
   FAILED_INITIALISE_MESSAGE,
   FAILED_SET_OPTIONS_MESSAGE,
+  SUCCESSFUL_OPEN_MESSAGE,
   SUCCESSFUL_CLONE_MESSAGE,
   SUCCESSFUL_PUBLISH_MESSAGE,
   SUCCESSFUL_DEPRECATE_MESSAGE,

package/bin/operation/open.js

@@ -0,0 +1,24 @@
+"use strict";
+
+const post = require("../post");
+
+const { OPEN_API_URI } = require("../uris");
+
+function openOperation(proceed, abort, context) {
+  const { releaseName } = context,
+        uri = `${OPEN_API_URI}/${releaseName}`,
+        json = {};
+
+  post(uri, json, (json) => {
+    const { success, releases = null } = json;
+
+    Object.assign(context, {
+      success,
+      releases
+    });
+
+    proceed();
+  });
+}
+
+module.exports = openOperation;

package/bin/operation/packRelease.js

@@ -0,0 +1,17 @@
+"use strict";
+
+function packReleaseOperation(proceed, abort, context) {
+  let { release } = context;
+
+  const releaseJSON = release.toJSON();
+
+  release = releaseJSON;  ///
+
+  Object.assign(context, {
+    release
+  });
+
+  proceed();
+}
+
+module.exports = packReleaseOperation;

package/bin/operation/publish.js

@@ -7,13 +7,13 @@ const post = require("../post");
 const { PUBLISH_API_URI } = require("../uris");
 
 function publishOperation(proceed, abort, context) {
-  const { dryRun, logLevel, releaseName, identityToken, zippedRelease } = context,
+  const { dryRun, release, logLevel, releaseName, identityToken } = context,
         uri = `${PUBLISH_API_URI}/${releaseName}`,
         json = {
           dryRun,
+          release,
           logLevel,
-          identityToken,
-          zippedRelease
+          identityToken
         };
 
   post(uri, json, (json) => {

package/bin/operation/unpackReleases.js

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

package/bin/operation/updateMetaJSONFileVersion.js

@@ -10,8 +10,7 @@ function updateMetaJSONFileVersionOperation(proceed, abort, context) {
   const { success } = context;
 
   if (success) {
-    const { release, version } = context,
-          releaseName = release.getName(),
+    const { version, releaseName } = context,
           metaJSONFilePath = `${releaseName}/${META_JSON_FILE_NAME}`,
           projectsDirectoryPath = process.cwd(), ///
           metaJSONFile = loadFile(metaJSONFilePath, projectsDirectoryPath);

package/bin/options.js

@@ -2,12 +2,14 @@
 
 const HELP_OPTION = "help",
       VERSION_OPTION = "version",
+      QUIETLY_OPTION = "quietly",
       DRY_RUN_OPTION = "dry-run",
       LOG_LEVEL_OPTION = "log-level";
 
 module.exports = {
   HELP_OPTION,
   VERSION_OPTION,
+  QUIETLY_OPTION,
   DRY_RUN_OPTION,
   LOG_LEVEL_OPTION
 };

package/bin/uris.js

@@ -1,6 +1,7 @@
 "use strict";
 
-const CLONE_API_URI = "/api/clone",
+const OPEN_API_URI = "/api/open",
+      CLONE_API_URI = "/api/clone",
       PUBLISH_API_URI = "/api/publish",
       SIGN_IN_API_URI = "/api/sign-in",
       DEPRECATE_API_URI = "/api/deprecate",
@@ -8,6 +9,7 @@ const CLONE_API_URI = "/api/clone",
       CREATE_ACCOUNT_API_URI = "/api/create-account";
 
 module.exports = {
+  OPEN_API_URI,
   CLONE_API_URI,
   PUBLISH_API_URI,
   SIGN_IN_API_URI,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "occam-open-cli",
   "author": "James Smith",
-  "version": "5.0.105",
+  "version": "5.0.106",
   "license": "MIT, Anti-996",
   "homepage": "https://github.com/djalbat/occam-open-cli",
   "description": "Occam's command line package management tool.",
@@ -11,9 +11,8 @@
   },
   "dependencies": {
     "argumentative": "^2.0.21",
-    "jszip": "^3.10.1",
     "necessary": "^11.1.4",
-    "occam-file-system": "^5.0.75"
+    "occam-file-system": "^5.0.76"
   },
   "scripts": {},
   "bin": {

package/bin/operation/zipRelease.js

@@ -1,36 +0,0 @@
-"use strict";
-
-const JSZip = require("jszip");
-
-const { encodings } = require("necessary");
-
-const { RELEASE_JSON } = require("../constants");
-
-const { BASE64_ENCODING } = encodings;
-
-function zipReleaseOperation(proceed, abort, context) {
-  const { release } = context,
-        type = BASE64_ENCODING,  ///
-        jsZip = new JSZip(),
-        releaseJSON = release.toJSON(),
-        releaseJSONString = JSON.stringify(releaseJSON),
-        name = RELEASE_JSON,
-        content = releaseJSONString,  ///
-        options = {
-          type
-        };
-
-  jsZip.file(name, content);
-
-  jsZip.generateAsync(options)
-    .catch(abort)
-    .then((zippedRelease) => {
-      Object.assign(context, {
-        zippedRelease
-      });
-
-      proceed();
-    });
-}
-
-module.exports = zipReleaseOperation;