@qooxdoo/framework 7.5.0 → 7.6.0

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/Install.js

@@ -677,6 +677,9 @@ qx.Class.define("qx.tool.cli.commands.package.Install", {
 
         return false;
       }
+      // relaod config. We need a fresh model here because data will be verified.
+      // The original model is enriched during parsing so validate will fail.
+      compileConfigModel.setLoaded(false);
       await compileConfigModel.load();
       let app = compileConfigModel.getValue("applications").find(app => {
         if (manifestApp.name && app.name) {

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()
      *

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

@@ -208,6 +208,7 @@ qx.Class.define("qx.tool.compiler.ClassFile", {
     };
 
     this.__requiredAssets = [];
+    this.__requiredFonts = {};
     this.__translations = [];
     this.__markers = [];
     this.__haveMarkersFor = {};
@@ -256,6 +257,10 @@ qx.Class.define("qx.tool.compiler.ClassFile", {
     __requiredClasses: null,
     __environmentChecks: null,
     __requiredAssets: null,
+
+    /** @type{Map<String,Object>} list of fonts indexed by name; the value is an object with `name` and `loc` */
+    __requiredFonts: null,
+
     __translateMessageIds: null,
     __scope: null,
     __inDefer: false,
@@ -631,6 +636,22 @@ qx.Class.define("qx.tool.compiler.ClassFile", {
       if (assets.length) {
         dbClassInfo.assets = assets;
       }
+
+      // Fonts
+      var fontNames = Object.keys(this.__requiredFonts);
+      if (fontNames.length) {
+        dbClassInfo.fonts = fontNames;
+        for (let fontName in this.__requiredFonts) {
+          if (!this.__analyser.getFont(fontName)) {
+            t.addMarker(
+              "fonts.unresolved#" + fontName,
+              this.__requiredFonts[fontName].loc.start,
+              fontName
+            );
+          }
+        }
+      }
+
       if (meta) {
         if (meta.aliases) {
           dbClassInfo.aliases = {};
@@ -754,6 +775,11 @@ qx.Class.define("qx.tool.compiler.ClassFile", {
             t._requireAsset(elem.body);
           });
         }
+        if (jsdoc["@usefont"]) {
+          jsdoc["@usefont"].forEach(function (elem) {
+            t._requireFont(elem.body, loc);
+          });
+        }
         return jsdoc;
       }
 
@@ -854,12 +880,16 @@ qx.Class.define("qx.tool.compiler.ClassFile", {
         if (sectionName === "members" || sectionName === "statics") {
           if (
             node.type == "ObjectMethod" ||
-            node.value.type === "FunctionExpression"
+            node.value.type === "FunctionExpression" ||
+            node.value.type === "MemberExpression"
           ) {
             meta.type = "function";
           } else {
             meta.type = "variable";
           }
+          if (node.async) {
+            meta.async = true;
+          }
           if (functionName.startsWith("__")) {
             meta.access = "private";
           } else if (functionName.startsWith("_")) {
@@ -2895,6 +2925,18 @@ qx.Class.define("qx.tool.compiler.ClassFile", {
       return this.__requiredAssets;
     },
 
+    /**
+     * Adds a required font
+     * @param {String} name  name of the font
+     * @param {Location} the Babel location
+     */
+    _requireFont(name, loc) {
+      this.__requiredFonts[name] = {
+        name,
+        loc
+      };
+    },
+
     /**
      * Finds an object property in a node tree (not a Qooxdoo property, an
      * object property)

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

@@ -267,7 +267,12 @@ qx.Class.define("qx.tool.compiler.Console", {
         /* eslint-enable no-template-curly-in-string */
 
         "qx.tool.compiler.maker.appNotHeadless":
-          "Compiling application '%1' but the target supports non-headless output, you may find unwanted dependencies are loaded during startup"
+          "Compiling application '%1' but the target supports non-headless output, you may find unwanted dependencies are loaded during startup",
+
+        // Fonts
+        "qx.tool.compiler.webfonts.deprecated":
+          "Manifest uses deprecated provides.webfonts, consider switching to provides.font",
+        "qx.tool.compiler.fonts.unresolved": "Cannot find font with name %1"
       },
 
       "warning"

package/source/class/qx/tool/compiler/app/Application.js

@@ -833,6 +833,25 @@ qx.Class.define("qx.tool.compiler.app.Application", {
       return assets;
     },
 
+    /**
+     * Returns a list of fonts required by the application, where the font is detailed in Manifest.json
+     * in `provides.fonts`
+     *
+     * @returns {String[]}
+     */
+    getFonts() {
+      var fonts = {};
+      var analyser = this.getAnalyser();
+      var db = analyser.getDatabase();
+      this.__loadDeps.forEach(classname => {
+        var classInfo = db.classInfo[classname];
+        if (classInfo.fonts) {
+          classInfo.fonts.forEach(fontName => (fonts[fontName] = true));
+        }
+      });
+      return Object.keys(fonts);
+    },
+
     /**
      * Returns the class name for the application
      * @returns {String}

package/source/class/qx/tool/compiler/app/Cldr.js

@@ -28,7 +28,9 @@ var path = require("path");
 var xml2js = require("xml2js");
 const CLDR = require("cldr");
 const { promisify } = require("util");
+const process = require("process");
 const readFile = promisify(fs.readFile);
+const readDir = promisify(fs.readdir);
 
 var log = qx.tool.utils.LogManager.createLog("cldr");
 
@@ -59,9 +61,39 @@ qx.Class.define("qx.tool.compiler.app.Cldr", {
       }
       log.debug("Loading CLDR " + cldrPath);
 
-      return readFile(path.join(cldrPath, data_path, locale + ".xml"), {
-        encoding: "utf-8"
-      })
+      const fullDir = path.join(cldrPath, data_path);
+
+      return readDir(fullDir)
+        .then(
+          names =>
+            new Promise((resolve, reject) => {
+              const searchedName = locale.toLowerCase() + ".xml";
+              const realName = names.find(
+                name => name.toLowerCase() === searchedName
+              );
+
+              if (realName) {
+                resolve(realName);
+              } else {
+                reject(
+                  new Error(
+                    'Cannot find XML file for locale "' +
+                      locale +
+                      '" in CLDR folder'
+                  )
+                );
+              }
+            })
+        )
+        .then(fileName =>
+          readFile(path.join(fullDir, fileName), {
+            encoding: "utf-8"
+          })
+        )
+        .catch(err => {
+          qx.tool.compiler.Console.error(err);
+          process.exit(1);
+        })
         .then(data =>
           qx.tool.utils.Utils.promisifyThis(parser.parseString, parser, data)
         )
@@ -564,30 +596,35 @@ qx.Class.define("qx.tool.compiler.app.Cldr", {
             });
 
             var monthContext = get("months[0].monthContext", cal);
-            find(monthContext, "type", "format", function (row) {
-              find(row.monthWidth, "type", "abbreviated", function (row) {
-                for (var i = 0; i < row.month.length; i++) {
-                  var m = row.month[i];
-                  cldr["cldr_month_format_abbreviated_" + m["$"].type] =
-                    getText(m);
-                }
-              });
-            });
-            find(monthContext, "type", "format", function (row) {
-              find(row.monthWidth, "type", "wide", function (row) {
-                for (var i = 0; i < row.month.length; i++) {
-                  var m = row.month[i];
-                  cldr["cldr_month_format_wide_" + m["$"].type] = getText(m);
-                }
-              });
-            });
-            find(monthContext, "type", "stand-alone", function (row) {
-              for (var i = 0; i < row.monthWidth[0].month.length; i++) {
-                var m = row.monthWidth[0].month[i];
-                cldr["cldr_month_stand-alone_narrow_" + m["$"].type] =
-                  getText(m);
+
+            const parseMonth = (months, cldrProperty) => {
+              if (!months) {
+                return;
               }
-            });
+              months.forEach(month => {
+                cldr[cldrProperty + "_" + month["$"].type] = getText(month);
+              });
+            };
+
+            const parseMonthContext = sectionNameInLocaleFile => {
+              find(monthContext, "type", "format", row =>
+                find(row.monthWidth, "type", sectionNameInLocaleFile, row =>
+                  parseMonth(
+                    row.month,
+                    "cldr_month_format_" + sectionNameInLocaleFile
+                  )
+                )
+              );
+            };
+
+            parseMonthContext("abbreviated");
+            parseMonthContext("wide");
+            find(monthContext, "type", "stand-alone", row =>
+              parseMonth(
+                row.monthWidth[0].month,
+                "cldr_month_stand-alone_narrow"
+              )
+            );
 
             function getTimeFormatPattern(row) {
               return row.timeFormat.pattern;

package/source/class/qx/tool/compiler/app/Library.js

@@ -93,7 +93,10 @@ qx.Class.define("qx.tool.compiler.app.Library", {
       check: "String"
     },
 
-    /** {WebFont[]} List of webfonts provided */
+    /**
+     * {WebFont[]} List of webfonts provided
+     * @deprecated
+     */
     webFonts: {
       init: null,
       nullable: true,
@@ -121,6 +124,7 @@ qx.Class.define("qx.tool.compiler.app.Library", {
     __sourceFileExtensions: null,
     __promiseLoadManifest: null,
     __environmentChecks: null,
+    __fontsData: null,
 
     /**
      * Transform for rootDir; converts it to an absolute path
@@ -238,13 +242,19 @@ qx.Class.define("qx.tool.compiler.app.Library", {
         this.setTranslationPath(data.provides.translation);
       }
       if (data.provides.webfonts) {
-        var fonts = [];
+        let fonts = [];
+        if (data.provides.webfonts.length) {
+          qx.tool.compiler.Console.print(
+            "qx.tool.compiler.webfonts.deprecated"
+          );
+        }
         data.provides.webfonts.forEach(wf => {
           var font = new qx.tool.compiler.app.WebFont(this).set(wf);
           fonts.push(font);
         });
         this.setWebFonts(fonts);
       }
+      this.__fontsData = data.provides.fonts || {};
       if (data.externalResources) {
         if (data.externalResources.script) {
           this.setAddScript(data.externalResources.script);
@@ -264,6 +274,15 @@ qx.Class.define("qx.tool.compiler.app.Library", {
       }
     },
 
+    /**
+     * Returns the provides.fonts data from the manifest
+     *
+     * @returns {Array}
+     */
+    getFontsData() {
+      return this.__fontsData;
+    },
+
     /**
      * Scans the filing system looking for classes; there are occasions (ie Qooxdoo's qxWeb module)
      * where the class name does not comply with the namespace, this method is used to find those
@@ -366,6 +385,36 @@ qx.Class.define("qx.tool.compiler.app.Library", {
       });
     },
 
+    /**
+     * Detects whether the filename is one of the library's fonts
+     *
+     * @param {String} filename
+     * @returns {Boolean}
+     */
+    isFontAsset(filename) {
+      let isWebFont = false;
+      if (filename.endsWith("svg")) {
+        let fonts = this.getWebFonts() || [];
+        isWebFont = fonts.find(webFont =>
+          webFont.getResources().find(resource => resource == filename)
+        );
+
+        if (!isWebFont) {
+          for (let fontId in this.__fontsData) {
+            let fontData = this.__fontsData[fontId];
+            isWebFont = (fontData.fontFaces || []).find(fontFace =>
+              (fontFace.paths || []).find(resource => resource == filename)
+            );
+
+            if (isWebFont) {
+              break;
+            }
+          }
+        }
+      }
+      return isWebFont;
+    },
+
     /**
      * Detects the type of a symbol, "class", "resource", "package", "environment", or null if not found
      *