@qooxdoo/framework 7.5.1 → 7.6.0

package/source/class/qx/tool/cli/commands/Config.js

@@ -13,13 +13,9 @@
 
    Authors:
      * John Spackman (john.spackman@zenesis.com, @johnspackman)
+     * Henner Kollmann (Henner.Kollmann@gmx.de, @hkollmann)
 
 ************************************************************************ */
-const process = require("process");
-const path = require("path");
-const columnify = require("columnify");
-const fs = qx.tool.utils.Promisify.fs;
-
 /**
  * Handles persistent configuration
  */
@@ -29,64 +25,20 @@ qx.Class.define("qx.tool.cli.commands.Config", {
 
   statics: {
     getYargsCommand() {
-      function run(argv, name) {
-        var cmd = new qx.tool.cli.commands.Config(argv);
-        return cmd[name](argv).catch(e => {
-          qx.tool.compiler.Console.error(e.stack || e.message);
-          process.exit(1);
-        });
-      }
       return {
-        command: "config <key> [value]",
-        describe: "gets/sets persistent configuration",
+        command: "config <command> [options]",
+        desc: "handles persistent configuration",
         builder(yargs) {
-          yargs
-            .option("quiet", {
-              alias: "q",
-              describe:
-                "Suppresses warnings (eg about unknown configuration keys)",
-              type: "boolean"
-            })
-            .command(
-              "set <key> <value>",
-              "Sets a configuration value",
-              () => {},
-              argv => run(argv, "cmdSet")
-            )
-            .command(
-              "get <key> [options]",
-              "Gets a configuration value",
-              {
-                bare: {
-                  type: "boolean",
-                  describe: "Restricts output to just the value"
-                }
-              },
-
-              argv => run(argv, "cmdGet")
-            )
-            .command(
-              "delete <key>",
-              "Deletes a configuration value",
-              () => {},
-              argv => run(argv, "cmdDelete")
-            )
-            .command(
-              "list",
-              "Lists all known configuration values",
-              {
-                all: {
-                  type: "boolean",
-                  describe: "Shows all keys, including unset"
-                }
-              },
-
-              argv => run(argv, "cmdList")
-            );
+          qx.tool.cli.Cli.addYargsCommands(
+            yargs,
+            ["List", "Set", "Get", "Delete"],
+
+            "qx.tool.cli.commands.config"
+          );
+
+          return yargs.demandCommand().showHelpOnFail().help();
         },
-        handler(argv) {
-          // Nothing
-        }
+        handler() {}
       };
     },
 
@@ -124,14 +76,14 @@ qx.Class.define("qx.tool.cli.commands.Config", {
   },
 
   members: {
-    __describe(key) {
+    _describe(key) {
       var data = qx.tool.cli.commands.Config.KNOWN_VALUES[key];
       return data && data.desc;
     },
 
-    __checkKey(argv) {
+    _checkKey(argv) {
       if (!argv.quiet) {
-        let desc = this.__describe(argv.key);
+        let desc = this._describe(argv.key);
         if (!desc) {
           qx.tool.compiler.Console.warn(
             "Warning: Unrecognised configuration key " + argv.key
@@ -140,7 +92,7 @@ qx.Class.define("qx.tool.cli.commands.Config", {
       }
     },
 
-    __breakout(key) {
+    _breakout(key) {
       let pos = key.lastIndexOf(".");
       let parentKey = pos > -1 ? key.substring(0, pos) : "";
       let childKey = key.substring(pos + 1);
@@ -150,83 +102,6 @@ qx.Class.define("qx.tool.cli.commands.Config", {
         parentKey: parentKey,
         childKey: childKey
       };
-    },
-
-    async cmdSet(argv) {
-      this.__checkKey(argv);
-      let cfg = await qx.tool.cli.ConfigDb.getInstance();
-      let setting = qx.tool.cli.commands.Config.KNOWN_VALUES[argv.key];
-      let value = argv.value;
-      if (setting && typeof setting.set == "function") {
-        value = await setting.set(value);
-      }
-
-      let keyInfo = this.__breakout(argv.key);
-      let parent = cfg.db(keyInfo.parentKey, {});
-      if (value === undefined) {
-        delete parent[keyInfo.childKey];
-      } else {
-        parent[keyInfo.childKey] = value;
-      }
-      await cfg.save();
-    },
-
-    async cmdDelete(argv) {
-      this.__checkKey(argv);
-      let cfg = await qx.tool.cli.ConfigDb.getInstance();
-      let keyInfo = this.__breakout(argv.key);
-      let parent = cfg.db(keyInfo.parentKey);
-      if (parent) {
-        delete parent[keyInfo.childKey];
-      }
-      await cfg.save();
-    },
-
-    async cmdGet(argv) {
-      this.__checkKey(argv);
-      let cfg = await qx.tool.cli.ConfigDb.getInstance();
-      let value = cfg.db(argv.key);
-      if (argv.bare) {
-        qx.tool.compiler.Console.info(value || "");
-      } else if (value !== undefined) {
-        qx.tool.compiler.Console.info(argv.key + "=" + value);
-      } else {
-        qx.tool.compiler.Console.info(argv.key + " is not set");
-      }
-    },
-
-    async cmdList(argv) {
-      let cfg = await qx.tool.cli.ConfigDb.getInstance();
-
-      let keys = {};
-      function scan(obj, parentKey) {
-        for (let [key, value] of Object.entries(obj)) {
-          let fullKey = parentKey + (parentKey.length ? "." : "") + key;
-          if (qx.tool.utils.Utils.isPlainObject(value)) {
-            scan(value, fullKey);
-            continue;
-          }
-          keys[fullKey] = true;
-        }
-      }
-      if (argv.all) {
-        for (let key in qx.tool.cli.commands.Config.KNOWN_VALUES) {
-          keys[key] = true;
-        }
-      }
-
-      // Recursively get a list of all known keys
-      scan(cfg.db(), "");
-      keys = Object.keys(keys);
-      keys.sort();
-      keys = keys.map(key => ({
-        key: key,
-        value: cfg.db(key),
-        description: this.__describe(key) || "Unrecognised key"
-      }));
-
-      // Display each value
-      qx.tool.compiler.Console.info(columnify(keys));
     }
   }
 });

package/source/class/qx/tool/cli/commands/ExportGlyphs.js

@@ -0,0 +1,134 @@
+/* ************************************************************************
+
+   qooxdoo - the new era of web development
+
+   http://qooxdoo.org
+
+   Copyright:
+     2023 Zenesis Limited (https://www.zenesis.com)
+
+   License:
+     MIT: https://opensource.org/licenses/MIT
+     See the LICENSE file in the project's top-level directory for details.
+
+   Authors:
+     * John Spackman (@johnspackman)
+
+************************************************************************ */
+
+const fs = require("fs");
+const path = require("upath");
+const fontkit = require("@foliojs-fork/fontkit");
+const tmp = require("tmp");
+
+/**
+ * Exports font ligatures as a map
+ */
+qx.Class.define("qx.tool.cli.commands.ExportGlyphs", {
+  extend: qx.tool.cli.commands.Command,
+
+  statics: {
+    getYargsCommand() {
+      return {
+        command: "export-glyphs font-file glyph-file",
+        describe: "export font glyphs & ligatures"
+      };
+    }
+  },
+
+  members: {
+    /**
+     * @override
+     */
+    async process() {
+      let filename = this.argv.fontFile;
+      if (filename.match(/^https?:\/\//)) {
+        filename = await qx.tool.utils.Http.downloadToTempFile(
+          filename,
+          /^font\/(ttf|svg|eot|woff|woff2)$/
+        );
+      }
+      let font = await qx.tool.utils.Promisify.call(cb =>
+        fontkit.open(filename, null, cb)
+      );
+
+      if (!font.GSUB) {
+        qx.tool.compiler.Console.error(
+          `The webfont in ${filename} does not have any ligatures`
+        );
+
+        return;
+      }
+
+      let glyphs = {};
+
+      // some IconFonts (MaterialIcons for example) use ligatures
+      // to name their icons. This code extracts the ligatures
+      // hat tip to Jossef Harush https://stackoverflow.com/questions/54721774/extracting-ttf-font-ligature-mappings/54728584
+      let ligatureName = {};
+      let lookupList = font.GSUB.lookupList.toArray();
+      let lookupListIndexes =
+        font.GSUB.featureList[0].feature.lookupListIndexes;
+      lookupListIndexes.forEach(index => {
+        let subTable = lookupList[index].subTables[0];
+        let leadingCharacters = [];
+        if (subTable.coverage.rangeRecords) {
+          subTable.coverage.rangeRecords.forEach(coverage => {
+            for (let i = coverage.start; i <= coverage.end; i++) {
+              let character = font.stringsForGlyph(i)[0];
+              leadingCharacters.push(character);
+            }
+          });
+        }
+        let ligatureSets = subTable.ligatureSets.toArray();
+        ligatureSets.forEach((ligatureSet, ligatureSetIndex) => {
+          let leadingCharacter = leadingCharacters[ligatureSetIndex];
+          ligatureSet.forEach(ligature => {
+            let character = font.stringsForGlyph(ligature.glyph)[0];
+            if (!character) {
+              // qx.tool.compiler.Console.log(`WARN: ${this.getName()} no character ${ligature}`);
+              return;
+            }
+            let ligatureText =
+              leadingCharacter +
+              ligature.components.map(x => font.stringsForGlyph(x)[0]).join("");
+            var hexId = character.charCodeAt(0).toString(16);
+            if (ligatureName[hexId] == undefined) {
+              ligatureName[hexId] = [ligatureText];
+            } else {
+              ligatureName[hexId].push(ligatureText);
+            }
+          });
+        });
+      });
+
+      font.characterSet.forEach(codePoint => {
+        let glyph = font.glyphForCodePoint(codePoint);
+        if (glyph.path.commands.length < 1 && !glyph.layers) {
+          return;
+        }
+
+        const found = gName => {
+          glyphs[gName] = {
+            advanceWidth: glyph.advanceWidth,
+            advanceHeight: glyph.advanceHeight,
+            codePoint
+          };
+        };
+        if (glyph.name) {
+          found(glyph.name);
+        }
+        var names = ligatureName[codePoint.toString(16)];
+        if (names) {
+          names.forEach(found);
+        }
+      });
+
+      await fs.promises.writeFile(
+        this.argv.glyphFile,
+        JSON.stringify(glyphs, null, 2),
+        "utf8"
+      );
+    }
+  }
+});

package/source/class/qx/tool/cli/commands/Package.js

@@ -75,6 +75,9 @@ qx.Class.define("qx.tool.cli.commands.Package", {
           );
 
           return yargs.showHelpOnFail().help();
+        },
+        handler() {
+          // Nothing
         }
       };
     }

package/source/class/qx/tool/cli/commands/Pkg.js

@@ -47,7 +47,7 @@ qx.Class.define("qx.tool.cli.commands.Pkg", {
 
           return yargs.demandCommand().showHelpOnFail().help();
         },
-        handler(argv) {
+        handler() {
           // Nothing
         }
       };

package/source/class/qx/tool/cli/commands/config/Delete.js

@@ -0,0 +1,47 @@
+/* ************************************************************************
+
+   qooxdoo - the new era of web development
+
+   http://qooxdoo.org
+
+   Copyright:
+   2017 Christian Boulanger
+
+   License:
+   MIT: https://opensource.org/licenses/MIT
+   See the LICENSE file in the project's top-level directory for details.
+
+   Authors:
+   * Christian Boulanger (info@bibliograph.org, @cboulanger)
+   * Henner Kollmann (Henner.Kollmann@gmx.de, @hkollmann)
+
+************************************************************************ */
+qx.Class.define("qx.tool.cli.commands.config.Delete", {
+  extend: qx.tool.cli.commands.Config,
+  statics: {
+    /**
+     * Returns the yargs command data
+     * @return {Object}
+     */
+    getYargsCommand() {
+      return {
+        command: "delete <key>",
+        describe: "Deletes a configuration value"
+      };
+    }
+  },
+
+  members: {
+    async process() {
+      await super.process();
+      this._checkKey(this.argv);
+      let cfg = await qx.tool.cli.ConfigDb.getInstance();
+      let keyInfo = this._breakout(this.argv.key);
+      let parent = cfg.db(keyInfo.parentKey);
+      if (parent) {
+        delete parent[keyInfo.childKey];
+      }
+      await cfg.save();
+    }
+  }
+});

package/source/class/qx/tool/cli/commands/config/Get.js

@@ -0,0 +1,52 @@
+/* ************************************************************************
+
+   qooxdoo - the new era of web development
+
+   http://qooxdoo.org
+
+   Copyright:
+   2017 Christian Boulanger
+
+   License:
+   MIT: https://opensource.org/licenses/MIT
+   See the LICENSE file in the project's top-level directory for details.
+
+   Authors:
+   * Christian Boulanger (info@bibliograph.org, @cboulanger)
+   * Henner Kollmann (Henner.Kollmann@gmx.de, @hkollmann)
+
+************************************************************************ */
+qx.Class.define("qx.tool.cli.commands.config.Get", {
+  extend: qx.tool.cli.commands.Config,
+  statics: {
+    /**
+     * Returns the yargs command data
+     * @return {Object}
+     */
+    getYargsCommand() {
+      return {
+        command: "get <key> [options]",
+        describe: "Gets a configuration value"
+      };
+    }
+  },
+
+  members: {
+    /**
+     * Lists library packages compatible with the current project
+     */
+    async process() {
+      await super.process();
+      this._checkKey(this.argv);
+      let cfg = await qx.tool.cli.ConfigDb.getInstance();
+      let value = cfg.db(this.argv.key);
+      if (this.argv.bare) {
+        qx.tool.compiler.Console.info(value || "");
+      } else if (value !== undefined) {
+        qx.tool.compiler.Console.info(this.argv.key + "=" + value);
+      } else {
+        qx.tool.compiler.Console.info(this.argv.key + " is not set");
+      }
+    }
+  }
+});

package/source/class/qx/tool/cli/commands/config/List.js

@@ -0,0 +1,81 @@
+/* ************************************************************************
+
+   qooxdoo - the new era of web development
+
+   http://qooxdoo.org
+
+   Copyright:
+   2017 Christian Boulanger
+
+   License:
+   MIT: https://opensource.org/licenses/MIT
+   See the LICENSE file in the project's top-level directory for details.
+
+   Authors:
+   * Christian Boulanger (info@bibliograph.org, @cboulanger)
+   * Henner Kollmann (Henner.Kollmann@gmx.de, @hkollmann)
+
+************************************************************************ */
+const columnify = require("columnify");
+
+/**
+ * Lists compatible packages
+ */
+qx.Class.define("qx.tool.cli.commands.config.List", {
+  extend: qx.tool.cli.commands.Config,
+  statics: {
+    /**
+     * Returns the yargs command data
+     * @return {Object}
+     */
+    getYargsCommand() {
+      return {
+        command: "list",
+        describe: "Lists all known configuration values",
+        builder: {
+          all: {
+            type: "boolean",
+            describe: "Shows all keys, including unset"
+          }
+        }
+      };
+    }
+  },
+
+  members: {
+    async process() {
+      await super.process();
+      let cfg = await qx.tool.cli.ConfigDb.getInstance();
+
+      let keys = {};
+      function scan(obj, parentKey) {
+        for (let [key, value] of Object.entries(obj)) {
+          let fullKey = parentKey + (parentKey.length ? "." : "") + key;
+          if (qx.tool.utils.Utils.isPlainObject(value)) {
+            scan(value, fullKey);
+            continue;
+          }
+          keys[fullKey] = true;
+        }
+      }
+      if (this.argv.all) {
+        for (let key in qx.tool.cli.commands.Config.KNOWN_VALUES) {
+          keys[key] = true;
+        }
+      }
+
+      // Recursively get a list of all known keys
+      scan(cfg.db(), "");
+      keys = Object.keys(keys);
+      keys.sort();
+      keys = keys.map(key => ({
+        key: key,
+        value: cfg.db(key),
+        description: this._describe(key) || "Unrecognised key"
+      }));
+
+      // Display each value
+      qx.tool.compiler.Console.info(columnify(keys));
+    }
+  }
+});

package/source/class/qx/tool/cli/commands/config/Set.js

@@ -0,0 +1,61 @@
+/* ************************************************************************
+
+   qooxdoo - the new era of web development
+
+   http://qooxdoo.org
+
+   Copyright:
+   2017 Christian Boulanger
+
+   License:
+   MIT: https://opensource.org/licenses/MIT
+   See the LICENSE file in the project's top-level directory for details.
+
+   Authors:
+   * Christian Boulanger (info@bibliograph.org, @cboulanger)
+   * Henner Kollmann (Henner.Kollmann@gmx.de, @hkollmann)
+
+************************************************************************ */
+qx.Class.define("qx.tool.cli.commands.config.Set", {
+  extend: qx.tool.cli.commands.Config,
+  statics: {
+    /**
+     * Returns the yargs command data
+     * @return {Object}
+     */
+    getYargsCommand() {
+      return {
+        command: "set <key> <value>",
+        describe: "Sets a configuration value",
+        builder: {
+          all: {
+            type: "boolean",
+            describe: "Shows all keys, including unset"
+          }
+        }
+      };
+    }
+  },
+
+  members: {
+    async process() {
+      await super.process();
+      this._checkKey(this.argv);
+      let cfg = await qx.tool.cli.ConfigDb.getInstance();
+      let setting = qx.tool.cli.commands.Config.KNOWN_VALUES[this.argv.key];
+      let value = this.argv.value;
+      if (setting && typeof setting.set == "function") {
+        value = await setting.set(value);
+      }
+
+      let keyInfo = this._breakout(this.argv.key);
+      let parent = cfg.db(keyInfo.parentKey, {});
+      if (value === undefined) {
+        delete parent[keyInfo.childKey];
+      } else {
+        parent[keyInfo.childKey] = value;
+      }
+      await cfg.save();
+    }
+  }
+});

package/source/class/qx/tool/cli/commands/package/Update.js

@@ -325,10 +325,10 @@ qx.Class.define("qx.tool.cli.commands.package.Update", {
           }
 
           // create a list of libraries via their manifests
-          for (let [index, { path: manifest_path }] of manifests.entries()) {
+          for (let [index, manifest] of manifests.entries()) {
             let manifest_data;
-            manifest_path = path.join(
-              manifest_path,
+            const manifest_path = path.join(
+              manifest.path,
               qx.tool.config.Manifest.config.fileName
             );
 

package/source/class/qx/tool/compiler/Analyser.js

@@ -61,6 +61,7 @@ qx.Class.define("qx.tool.compiler.Analyser", {
     this.__translations = {};
     this.__classFiles = {};
     this.__environmentChecks = {};
+    this.__fonts = {};
   },
 
   properties: {
@@ -194,6 +195,9 @@ qx.Class.define("qx.tool.compiler.Analyser", {
     __cldrs: null,
     __translations: null,
 
+    /** @type{qx.tool.compiler.app.ManifestFont[]} list of fonts in provides.fonts */
+    __fonts: null,
+
     __classFiles: null,
     __environmentChecks: null,
     __inDefer: false,
@@ -1415,6 +1419,47 @@ qx.Class.define("qx.tool.compiler.Analyser", {
       this.__librariesByNamespace[library.getNamespace()] = library;
     },
 
+    /**
+     * Returns a font by name
+     *
+     * @param {String} name
+     * @param {Boolean?} create whether to create the font if it does not exist (default is false)
+     * @returns {qx.tool.app.ManifestFont?} null if it does not exist and `create` is falsey
+     */
+    getFont(name, create) {
+      let font = this.__fonts[name] || null;
+      if (!font && create) {
+        font = this.__fonts[name] = new qx.tool.compiler.app.ManifestFont(name);
+      }
+      return font;
+    },
+
+    /**
+     * Detects whether the filename is one of the fonts
+     *
+     * @param {String} filename
+     * @returns {Boolean} whether the filename is a font asset
+     */
+    isFontAsset(filename) {
+      let isFont = false;
+      if (filename.endsWith("svg")) {
+        for (let fontName in this.__fonts) {
+          let font = this.__fonts[fontName];
+          let sources = font.getSources() || [];
+          isFont = sources.find(source => source == filename);
+        }
+      }
+      return isFont;
+    },
+    /**
+     * Returns the map of all fonts, indexed by name
+     *
+     * @returns {Map<String,qx.tool.app.ManifestFont>}
+     */
+    getFonts() {
+      return this.__fonts;
+    },
+
     /**
      * Adds a required class to be analysed by analyseClasses()
      *