feat(ngParseExt): New ngParseExt module

New ngParseExt module

Including this module into an application will extend $parse to allow identifiers
following ES6 identifiers

Author: lgalfaso

Gruntfile.js

@@ -137,6 +137,9 @@ module.exports = function(grunt) {
       ngMock: {
         files: { src: 'src/ngMock/**/*.js' },
       },
+      ngParseExt: {
+        files: { src: 'src/ngParseExt/**/*.js' },
+      },
       ngResource: {
         files: { src: 'src/ngResource/**/*.js' },
       },
@@ -233,7 +236,11 @@ module.exports = function(grunt) {
         dest: 'build/angular-aria.js',
         src: util.wrap(files['angularModules']['ngAria'], 'module')
       },
-      'promises-aplus-adapter': {
+      parseext: {
+        dest: 'build/angular-parse-ext.js',
+        src: util.wrap(files['angularModules']['ngParseExt'], 'module')
+      },
+      "promises-aplus-adapter": {
         dest:'tmp/promises-aplus-adapter++.js',
         src:['src/ng/q.js', 'lib/promises-aplus/promises-aplus-test-adapter.js']
       }
@@ -251,7 +258,8 @@ module.exports = function(grunt) {
       resource: 'build/angular-resource.js',
       route: 'build/angular-route.js',
       sanitize: 'build/angular-sanitize.js',
-      aria: 'build/angular-aria.js'
+      aria: 'build/angular-aria.js',
+      parseext: 'build/angular-parse-ext.js'
     },
 
 

angularFiles.js

@@ -120,6 +120,10 @@ var angularFiles = {
     'ngMessages': [
       'src/ngMessages/messages.js'
     ],
+    'ngParseExt': [
+      'src/ngParseExt/ucd.js',
+      'src/ngParseExt/module.js'
+    ],
     'ngResource': [
       'src/ngResource/resource.js'
     ],

i18n/generate.sh

@@ -9,4 +9,8 @@ npm run test-i18n
 
 node src/closureSlurper.js
 
+npm run test-i18n-ucd
+
+echo "Generating ngParseExt"
+node ucd/src/extract.js
 

i18n/ucd/spec/extactValuesSpec.js

@@ -0,0 +1,53 @@
+var extractValues = require('../src/extractValues.js').extractValues;
+var stream = require('stream');
+
+function StringStream(str) {
+  return new stream.Readable({
+    read: function(n) {
+      this.push(str);
+      str = null;
+    }
+  });
+}
+
+describe('extractValues', function() {
+  it('should extract the values from the xml', function(done) {
+    var str = '<ucd><repertoire><char cp="0000" IDS="N"></char><char cp="0001" IDS="Y"></char><char cp="0002" IDS="Y"></char><char cp="0003" IDS="N"></char></repertoire></ucd>';
+    extractValues(StringStream(str), {'IDS': 'Y'}, function(values) {
+      expect(values).toEqual({ IDS_Y : [ [ '0001', '0002' ] ] });
+      done();
+    });
+  });
+
+  it('should extract the values from the xml if the last element matches', function(done) {
+    var str = '<ucd><repertoire><char cp="0000" IDS="N"></char><char cp="0001" IDS="Y"></char><char cp="0002" IDS="Y"></char><char cp="0003" IDS="Y"></char></repertoire></ucd>';
+    extractValues(StringStream(str), {'IDS': 'Y'}, function(values) {
+      expect(values).toEqual({ IDS_Y : [ [ '0001', '0003' ] ] });
+      done();
+    });
+  });
+
+  it('should support `reserved`', function(done) {
+    var str = '<ucd><repertoire><char cp="0000" IDS="N"></char><char cp="0001" IDS="Y"></char><reserved first-cp="0002" last-cp="0005" IDS="N"></reserved><char cp="0006" IDS="Y"></char></repertoire></ucd>';
+    extractValues(StringStream(str), {'IDS': 'Y'}, function(values) {
+      expect(values).toEqual({ IDS_Y : [ [ '0001', '0001' ], [ '0006', '0006' ] ] });
+      done();
+    });
+  });
+
+  it('should support `surrogate`', function(done) {
+    var str = '<ucd><repertoire><char cp="0000" IDS="N"></char><char cp="0001" IDS="Y"></char><surrogate first-cp="0002" last-cp="0005" IDS="N"></surrogate><char cp="0006" IDS="Y"></char></repertoire></ucd>';
+    extractValues(StringStream(str), {'IDS': 'Y'}, function(values) {
+      expect(values).toEqual({ IDS_Y : [ [ '0001', '0001' ], [ '0006', '0006' ] ] });
+      done();
+    });
+  });
+
+  it('should support `noncharactere`', function(done) {
+    var str = '<ucd><repertoire><char cp="0000" IDS="N"></char><char cp="0001" IDS="Y"></char><noncharacter first-cp="0002" last-cp="0005" IDS="N"></noncharacter><char cp="0006" IDS="Y"></char></repertoire></ucd>';
+    extractValues(StringStream(str), {'IDS': 'Y'}, function(values) {
+      expect(values).toEqual({ IDS_Y : [ [ '0001', '0001' ], [ '0006', '0006' ] ] });
+      done();
+    });
+  });
+});

i18n/ucd/spec/generateCodeSpec.js

@@ -0,0 +1,54 @@
+
+var generateCodeModule = require('../src/generateCode.js');
+var generateCode = generateCodeModule.generateCode;
+var generateFunction = generateCodeModule.generateFunction;
+
+describe('generateFunction', function() {
+  it('should generate function with ranges', function() {
+    expect(generateFunction([ [ '0001', '0003' ] ], 'IDS_Y')).toEqual('\
+function IDS_Y(cp) {\n\
+  if (0x0001 <= cp && cp <= 0x0003) return true;\n\
+  return false;\n\
+}\n');
+  });
+
+  it('should generate function with multiple ranges', function() {
+    expect(generateFunction([ [ '0001', '0003' ], [ '0005', '0009'] ], 'IDS_Y')).toEqual('\
+function IDS_Y(cp) {\n\
+  if (0x0001 <= cp && cp <= 0x0003) return true;\n\
+  if (0x0005 <= cp && cp <= 0x0009) return true;\n\
+  return false;\n\
+}\n');
+  });
+
+  it('should generate function with unique values', function() {
+    expect(generateFunction([ [ '0001', '0001' ], [ '0005', '0009'] ], 'IDS_Y')).toEqual('\
+function IDS_Y(cp) {\n\
+  if (cp === 0x0001) return true;\n\
+  if (0x0005 <= cp && cp <= 0x0009) return true;\n\
+  return false;\n\
+}\n');
+  });
+});
+
+describe('generateCode', function() {
+  it('should generate the function for all the values', function() {
+    expect(generateCode({ IDS_Y : [ [ '0001', '0001' ], [ '0006', '0006' ] ], IDC_Y : [ [ '0002', '0002' ], [ '0007', '0007' ] ] })).toEqual('\
+/******************************************************\n\
+ *         Generated file, do not modify              *\n\
+ *                                                    *\n\
+ *****************************************************/\n\
+"use strict";\n\
+function IDS_Y(cp) {\n\
+  if (cp === 0x0001) return true;\n\
+  if (cp === 0x0006) return true;\n\
+  return false;\n\
+}\n\
+function IDC_Y(cp) {\n\
+  if (cp === 0x0002) return true;\n\
+  if (cp === 0x0007) return true;\n\
+  return false;\n\
+}\n\
+');
+  });
+});

i18n/ucd/src/extract.js

@@ -0,0 +1,28 @@
+"use strict";
+
+var fs = require('fs');
+var zlib = require('zlib');
+var extractValues = require('./extractValues').extractValues;
+var generateCode = require('./generateCode').generateCode;
+var generateextractValues = require('./extractValues').extractValues;
+// ID_Start and ID_Continue
+var propertiesToExtract = {'IDS': 'Y', 'IDC': 'Y'};
+
+function main() {
+  extractValues(
+    fs.createReadStream('./ucd/src/ucd.all.flat.xml.gz').pipe(zlib.createGunzip()),
+    propertiesToExtract,
+    writeFile);
+
+  function writeFile(validRanges) {
+    var code = generateCode(validRanges);
+    try {
+      var stats = fs.lstatSync('../src/ngParseExt');
+    } catch (e) {
+      fs.mkdirSync('../src/ngParseExt');
+    }
+    fs.writeFile('../src/ngParseExt/ucd.js', code);
+  }
+}
+
+main();

i18n/ucd/src/extractValues.js

@@ -0,0 +1,58 @@
+/**
+ * Extract values from a stream.
+ */
+
+exports.extractValues = extractValues;
+
+var sax = require('sax/lib/sax');
+var saxStrict = true;
+var saxOptions = {};
+var validXMLTagNames = { char: 'Y', reserved: 'Y', surrogate: 'Y', noncharacter: 'Y'};
+
+function extractValues(stream, propertiesToExtract, callback) {
+  var saxStream = sax.createStream(saxStrict, saxOptions);
+  var firstValid = {};
+  var lastValid = {};
+  var keys = Object.keys(propertiesToExtract);
+  var keyValues = keys.map(function(k) { return propertiesToExtract[k]; });
+  var validRanges = {};
+
+  for (var i in keys) {
+    validRanges[keys[i] + '_' + keyValues[i]] = [];
+  }
+  saxStream.onopentag = onOpenTag;
+  stream
+    .pipe(saxStream)
+    .on('end', doCallback);
+
+  function onOpenTag(node) {
+    var property;
+    if (validXMLTagNames[node.name]) {
+      for (var i in keys) {
+        property = keyValues[i];
+        if (node.attributes[keys[i]] === property) validProperty(keys[i] + '_' + property, node);
+        else invalidProperty(keys[i] + '_' + property);
+      }
+    }
+  }
+
+  function validProperty(property, node) {
+    if (!firstValid[property]) firstValid[property] =
+        node.attributes.cp || node.attributes['first-cp'];
+    lastValid[property] = node.attributes.cp || node.attributes['last-cp'];
+  }
+
+  function invalidProperty(property) {
+    if (!firstValid[property]) return;
+    validRanges[property].push([firstValid[property], lastValid[property]]);
+    firstValid[property] = null;
+  }
+
+  function doCallback() {
+    for (var i in keys) {
+      property = keys[i] + '_' + keyValues[i];
+      invalidProperty(property);
+    }
+    callback(validRanges);
+  }
+}

i18n/ucd/src/generateCode.js

@@ -0,0 +1,33 @@
+
+exports.generateCode = generateCode;
+exports.generateFunction = generateFunction;
+
+function generateCode(validRanges) {
+  var code = '/******************************************************\n' +
+             ' *         Generated file, do not modify              *\n' +
+             ' *                                                    *\n' +
+             ' *****************************************************/\n' +
+             '"use strict";\n';
+  var keys = Object.keys(validRanges);
+  for (var i in keys) {
+    code += generateFunction(validRanges[keys[i]], keys[i]);
+  }
+  return code;
+}
+
+
+function generateFunction(positiveElements, functionName) {
+  var result = [];
+  result.push('function ', functionName, '(cp) {\n');
+  positiveElements.forEach(function(range) {
+    if (range[0] === range[1]) {
+      result.push('  if (cp === 0x', range[0], ')');
+    } else {
+      result.push('  if (0x', range[0], ' <= cp && cp <= 0x', range[1], ')');
+    }
+    result.push(' return true;\n');
+  });
+  result.push('  return false;\n}\n');
+  return result.join('');
+}
+

i18n/ucd/src/ucd.all.flat.xml.gz

@@ -17,7 +17,8 @@
     "preinstall": "node scripts/npm/check-node-modules.js --purge",
     "postinstall": "node scripts/npm/copy-npm-shrinkwrap.js",
     "commit": "git-cz",
-    "test-i18n": "jasmine-node i18n/spec"
+    "test-i18n": "jasmine-node i18n/spec",
+    "test-i18n-ucd": "jasmine-node i18n/ucd/spec"
   },
   "devDependencies": {
     "angular-benchpress": "0.x.x",
@@ -75,6 +76,7 @@
     "q-io": "^1.10.9",
     "qq": "^0.3.5",
     "rewire": "~2.1.0",
+    "sax": "^1.1.1",
     "semver": "~4.0.3",
     "shelljs": "~0.3.0",
     "sorted-object": "^1.0.0",

package.json

@@ -0,0 +1,44 @@
+'use strict';
+
+/**
+ * @ngdoc module
+ * @name ngParseExt
+ * @description
+ *
+ * # ngParseExt
+ *
+ * The `ngParseExt` module provides functionality to allow Unicode characters in
+ * identifiers inside Angular expressions.
+ *
+ *
+ * <div doc-module-components="ngParseExt"></div>
+ *
+ * This module allows the usage of any identifier that follows ES6 identifier naming convention
+ * to be used as an identifier in an Angular expression. ES6 delegates some of the identifier
+ * rules definition to Unicode, this module uses ES6 and Unicode 8.0 identifiers convention.
+ *
+ */
+
+/* global angularParseExtModule: true,
+  IDS_Y,
+  IDC_Y
+*/
+
+function isValidIdentifierStart(ch, cp) {
+  return ch === '$' ||
+         ch === '_' ||
+         IDS_Y(cp);
+}
+
+function isValidIdentifierContinue(ch, cp) {
+  return ch === '$' ||
+         ch === '_' ||
+         cp === 0x200C || // <ZWNJ>
+         cp === 0x200D || // <ZWJ>
+         IDC_Y(cp);
+}
+
+angular.module('ngParseExt', [])
+  .config(['$parseProvider', function($parseProvider) {
+    $parseProvider.setIdentifierFns(isValidIdentifierStart, isValidIdentifierContinue);
+  }]);