@lumjs/compat 1.4.0 → 2.0.0

package/lib/modulebuilder/into-core.js

@@ -1,34 +0,0 @@
-const core = require('@lumjs/core');
-
-/**
- * A helper for building modules «Lazy»
- * 
- * @name module:@lumjs/core.ModuleBuilder
- * @see module:@lumjs/core/modulebuilder
- * @deprecated
- */
-core.lazy(core, 'ModuleBuilder', () => require('./index'), E);
-
-/**
- * Return a set of functions for building a module.
- * 
- * @alias module:@lumjs/core.buildModule
- * @see module:@lumjs/core/modulebuilder.build 
- * @deprecated
- */
-core.buildModule = function(m,o) 
-{ 
-  return core.ModuleBuilder.build(m,o); 
-}
-
-/**
- * Create a new `ModuleBuilder` instance.
- * 
- * @alias module:@lumjs/core.newBuilder
- * @see module:@lumjs/core/modulebuilder.new
- * @deprecated
- */
-core.newBuilder = function(m, o)
-{
-  return core.ModuleBuilder.new(m,o);
-}

package/lib/v4/deprecated.js

@@ -1,122 +0,0 @@
-/**
- * Mark a function/method/property as deprecated.
- *
- * Adds a warning to the Console that the method is deprecated.
- *
- * It can also optionally give example replacement code, and run a function 
- * that will call the replacement code automatically.
- *
- * @param {string} name  The name of the deprecated method/property/etc.
- *
- *   This should actually be the full method signature, or at least the
- *   signature matching what a call to the deprecated method made.
- *
- *   So rather than 'someOldMethod', use 'MyClass.someOldMethod(foo, bar)'
- *   as a more detailed name. This is only used in the Console warning.
- *
- *   This is the only mandatory parameter.
- *
- * @param {mixed} [replace={}]  Replacement options.
- * 
- *   If this is a {string}, it is the same as passing an {object} with
- *   the following options specified:
- *
- *     ```{msg: replace}```
- *
- *   If it is a {function}, it is the same as passing an {object} with
- *   the following options specified:
- *
- *     ```{exec: replace, msg: true, strip: true}```
- *
- *   If it is an {object}, then it will be a set of options:
- *
- *     "exec" {function}
- *
- *       If specified, this function will be called and the value returned.
- *       No paramters are passed to the function, so it should be a simple 
- *       anonymous closure which simply calls the actual replacement code.
- *
- *     "msg" {string|boolean}
- *
- *       If this is a {string} it will be added to the warning output.
- *
- *       If this is `true` and `exec` is set, we will extract the function
- *       text using `exec.toString()` and add it to the warning output.
- *
- *       In any other cases, no replacement message will be appended.
- *
- *     "strip" {boolean}
- *
- *       If this is `true`, then we will strip `'function() { return '`
- *       from the start of the function text (whitespace ignored), as well
- *       as stripping '}' from the very end of the function text.
- *
- *       This is only applicable if `exec` is set, and `msg` is `true`.
- *
- *   If the `replace` value is none of the above, it will be ignored.
- *
- * @return {mixed}  The output is dependent on the parameters passed.
- *
- * If `replace` is a function or an object with 
- *
- * In any other case the return value will be undefined.
- *
- * @alias module:@lumjs/compat/v4/deprecated
- */
-module.exports = function (name, replace={})
-{
-  const DEP_MSG = ':Deprecated =>';
-  const REP_MSG = ':replaceWith =>';
-
-  if (typeof replace === S)
-  { // A string replacement example only.
-    replace = {msg: replace};
-  }
-  else if (typeof replace === F)
-  { // A function replacement.
-    replace = {exec: replace, msg: true, strip: true};
-  }
-  else if (!is_obj(replace))
-  { // Not an object, that's not valid.
-    replace = {};
-  }
-
-  const msgs = [DEP_MSG, name];
-  const exec = (typeof replace.exec === F) 
-    ? replace.exec
-    : null;
-
-  if (exec && replace.msg === true)
-  { // Extract the function text.
-    const strip = (typeof replace.strip === B)
-      ? replace.strip
-      : false;
-
-    let methtext = replace.exec.toString();
-
-    if (strip)
-    { // Remove wrapping anonymous closure function.
-      methtext = methtext.replace(/^function\(\)\s*\{\s*(return\s*)?/, '');
-      methtext = methtext.replace(/\s*\}$/, '');
-      // Also support arrow function version.
-      methtext = methtext.replace(/^\(\)\s*\=\>\s*/, '');
-    }
-
-    // Set the replacement msg to the method text.
-    replace.msg = methtext;
-  }
-
-  if (typeof replace.msg === 'string')
-  { // A replacement message.
-    msgs.push(REP_MSG, replace.msg);
-  }
-
-  // Show the messages.
-  console.warn(...msgs);
-
-  // Finally, call the replacement function if it was defined.
-  if (exec)
-  {
-    return exec();
-  }
-}

package/lib/v4/descriptors.js

@@ -1,217 +0,0 @@
-/**
- * Descriptors magic objects library.
- * @module @lumjs/compat/v4/descriptors
- */
-
-const core = require('@lumjs/core');
-const {InternalObjectId,Enum,types} = core;
-const {doesDescriptor,isObj,def,B,F,N} = types;
-
-// We moved getProperty() to the `@lumjs/core/obj` module.
-const getProperty = core.obj.getProperty;
-exports.getProperty = getProperty;
-
-const DESC_ID = new InternalObjectId({name: '$LumDescriptor'});
-const DESC_ADD = Enum(['ONE', 'SHORT', 'SET'], {flags: true});
-
-/**
- * Create a magic Descriptor object.
- * @param {object} desc - Descriptor template.
- * @param {object} [opts] - Options (to be documented.)
- * @returns {object} `desc`
- * @alias module:@lumjs/compat/v4/descriptors.descriptor
- */
-function descriptor(desc, opts={})
-{
-  if (!isObj(opts)) throw new TypeError("Options must be an object");
-
-  if (typeof desc === B)
-  { // This is a special case.
-    opts.accessorSafe = desc;
-    opts.add = DESC_ADD.ONE;
-    desc = {};
-  }
-
-  if (!isObj(desc)) 
-    throw new TypeError("First parameter (desc) must be a descriptor template object");
-
-  if (!Object.isExtensible(desc))
-    throw new RangeError("First parameter (desc) must not be locked, sealed, frozen, etc.");
-
-  const accessorSafe = (typeof opts.accessorSafe === B) 
-    ? opts.accessorSafe
-    : (desc.writable === undefined);
-  
-  DESC_ID.tag(desc);
-
-  // Add a function or other property.
-  const add = def(desc);
-
-  // Add a getter.
-  function accessor(name, getter, setter)
-  {
-    const adef = {configurable: true};
-    if (typeof getter === F) adef.get = getter;
-    if (typeof setter === F) adef.set = setter;
-    def(desc, name, adef);
-  }
-
-  add('accessorSafe', accessorSafe);
-
-  add('whenDone', function(func)
-  {
-    if (typeof func === F)
-    {
-      add('done', func);
-    }
-    return this;
-  });
-
-  if (typeof opts.done === F)
-  {
-    desc.whenDone(opts.done);
-  }
-
-  add('setValue', function (val, noClean)
-  {
-    if (this.get !== undefined || this.set !== undefined)
-    {
-      console.error("Accessor properties already defined", this);
-    }
-    else
-    {
-      this.value = val;
-    }
-    
-    return this;
-  });
-
-  if (accessorSafe)
-  {
-    function validate ()
-    {
-      if (this.value !== undefined)
-      { 
-        console.error("Data 'value' property defined", this);
-        return false;
-      }
-
-      for (const arg of arguments)
-      { // All accessor arguments must be functions.
-        if (typeof arg !== F) throw new TypeError("Parameter must be a function");
-      }
-
-      return true;
-    }
-
-    add('setGetter', function(func)
-    {
-      if (validate.call(this, func))
-        this.get = func;
-      return this;
-    });
-
-    add('setSetter', function(func)
-    {
-      if (validate.call(this, func))
-        this.set = func;
-      return this;    
-    });
-
-    add('setAccessor', function(getter, setter)
-    {
-      if (validate.call(this, getter, setter))
-      {
-        this.get = getter;
-        this.set = setter;
-      }
-      return this;
-    });
-
-  } // accessorSafe
-
-  if (opts.add)
-  {
-    const addTypes 
-      = (typeof opts.add === N) 
-      ? opts.add 
-      : DESC_ADD.SET;
-
-    function addBool(propname)
-    {
-      const setBool = function() 
-      { 
-        this[propname] = true; 
-        return this; 
-      }
-
-      if (addTypes & DESC_ADD.ONE)
-      {
-        const aname = propname[0];
-        accessor(aname, setBool);
-      }
-      if (addTypes & DESC_ADD.SHORT)
-      {
-        const aname = propname.substring(0,4);
-        accessor(aname, setBool);
-      }
-      if (addTypes & DESC_ADD.SET)
-      {
-        const aname = 'set'+ucfirst(propname);
-        accessor(aname, setBool);
-      }
-    }
-
-    addBool('configurable');
-    addBool('enumerable');
-    addBool('writable');
-
-  } // addBools
-
-  // Is the descriptor ready to be used?
-  accessor('isReady', function()
-  {
-    return doesDescriptor(this);
-  });
-
-  return desc;
-} // descriptor()
-
-exports.descriptor = descriptor;
-
-/**
- * Get a Descriptor object.
- * @param {object} desc - Either a Descriptor, or a descriptor template. 
- * @returns {object}
- * @alias module:@lumjs/compat/v4/descriptors.getDescriptor
- */
-function getDescriptor(desc)
-{
-  return DESC_ID.is(desc) ? desc : descriptor(desc);
-}
-
-exports.getDescriptor = getDescriptor;
-
-/**
- * A factory for building magic Descriptor objects.
- * @alias module:@lumjs/compat/v4/descriptors.DESC
- */
-const DESC =
-{
-  get RO()    { return descriptor(true)  },
-  get CONF()  { return descriptor(true).c  },
-  get ENUM()  { return descriptor(true).e  },
-  get WRITE() { return descriptor(false).w },
-  get RW()    { return descriptor(false).c.w },
-  get DEF()   { return descriptor(true).c.e  },
-  get OPEN()  { return descriptor(false).c.e.w },
-}
-
-def(DESC)
-  ('make', descriptor)
-  ('is',   DESC_ID.isFunction())
-  ('get',  getDescriptor)
-  ('does', doesDescriptor)
-  ('ADD',  DESC_ADD);
-
-exports.DESC = DESC;

package/lib/v4/index.js

@@ -1,53 +0,0 @@
-/**
- * Lum.js v4 compatibility set.
- * 
- * Now uses lazy-loading for all properties.
- * 
- * @module @lumjs/compat/v4
- */
-
-const {lazy} = require('@lumjs/core/types');
-
-const E = lazy.def.e;
-
-/**
- * @name module:@lumjs/compat/v4.descriptors
- * @see module:@lumjs/compat/v4/descriptors
- */
-lazy(exports, 'descriptors', () => require('./descriptors'), E);
-
-/**
- * @name module:@lumjs/compat/v4.DESC
- * @see module:@lumjs/compat/v4/descriptors.DESC
- */
-lazy(exports, 'DESC', () => exports.descriptors.DESC, E);
-
-/**
- * @name module:@lumjs/compat/v4.prop
- * @see module:@lumjs/compat/v4/prop
- */
-lazy(exports, 'prop', () => require('./prop'), E);
-
-/**
- * @name module:@lumjs/compat/v4.deprecated
- * @see module:@lumjs/compat/v4/deprecated
- */
-lazy(exports, 'deprecated', () => require('./deprecated'), E);
-
-/**
- * @name module:@lumjs/compat/v4.LoadTracker
- * @see module:@lumjs/compat/v4/loadtracker
- */
-lazy(exports, 'LoadTracker', () => require('./loadtracker'), E);
-
-/**
- * @name module:@lumjs/compat/v4.Promise
- * @see module:@lumjs/compat/v4/promise
- */
-lazy(exports, 'Promise', () => require('./promise'), E);
-
-/**
- * @name module:@lumjs/compat/v4.obj
- * @see module:@lumjs/compat/v4/object-helpers
- */
-lazy(exports, 'obj', () => require('./object-helpers'), E);