Merge pull request #4 from NotNinja/develop

neocotic · web-flow · commit d43cc1e1d71b · 2018-01-25T14:19:51.000Z
Release 0.1.2
diff --git a/.gitignore b/.gitignore
@@ -1,4 +1,5 @@
-.nyc_output/
-coverage/
 node_modules/
 *.log
+
+.nyc_output/
+coverage/
diff --git a/.npmignore b/.npmignore
@@ -1,7 +1,9 @@
+.nyc_output/
 coverage/
+codecov.yml
+
 test/
 .*
 AUTHORS.md
 CHANGES.md
-codecov.yml
 CONTRIBUTING.md
diff --git a/.travis.yml b/.travis.yml
@@ -2,12 +2,15 @@ sudo: false
 language: node_js
 node_js:
   - "8"
+  - "9"
 script:
   - npm test
 after_success:
   - npm run coverage
 notifications:
+  email: false
   slack:
     rooms:
       - secure: Bu+WX8d4eWg+hubGeMZQ5j/mdt0LmRbohp3NO9DQGi2/026Z7N/tGkienEaD8oOQY3ZORaQuGbMCLBHrMWUIAz8kaeMqtvRjj3a8ZGNVZ/2kFLwv2gQnMGkigULZNbDFKRd6I7WkEfOUU4ANsXNDzsfdM3h2jXbIGew922adF0GkQGm8npLAfshj32Mogwe1oU78pVFukW8TcWrL2iZDRaBk2mrPYfTyP3scbdYeOIDDgWvnV0DkXHP2oPI9mMjzuIOBEXF5cBv7wMMHOu1/dtZzN/zrMB1Hm0iFsdb2TT8NgpTjaxb3y0JuEgC+e1TB6VznZ53HwED5G4eDBFE7Nz4iJ1y4rMTOzDxqMhXPOgwD4DOg2JDgZeT3bm1De63fpeM7vbfuZnGAnm5u9NR2ylVcH0yCCfdH0WV0nhA+k384MQH/WJe1xerrIu7kMOh6VyM7BxgDvpROn3vWrkWfPWufXeyX8ZSaA2j0OcYpQ4nfF2dhsmCEMeKhNU5AgdJhCVa97STsLz8lH9RMSrYz95HH/y6Yz3YZ6te+lCZLokNjo3vO89+hoUHCe5obxwxD9zLWsBhtxtKKgzLGn45JSZOA5zr3QNhQlzw8FkDBrVyLlYKUoP2+kW8eZpTM0udRClSrquXf1Kf0pbReKHemrK73arSMesd/FAjM8hRCtIA=
+    on_failure: change
     on_success: change
diff --git a/CHANGES.md b/CHANGES.md
@@ -1,3 +1,10 @@
+## Version 0.1.2, 2018.01.25
+
+* Move Unicode escape and unescape logic out to new `escape-unicode` and `unescape-unicode` modules respectively
+* Configure travis to also build against Node.js v9
+* Replace `chai` with `assert` in unit tests
+* Bump dependencies
+
 ## Version 0.1.1, 2017.12.09
 
 * Fix require statements in README examples [#2](https://github.com/NotNinja/nevis/issues/2)
diff --git a/LICENSE.md b/LICENSE.md
@@ -1,4 +1,4 @@
-Copyright (C) 2017 Alasdair Mercer, !ninja
+Copyright (C) 2018 Alasdair Mercer, !ninja
 
 Permission is hereby granted, free of charge, to any person obtaining a copy  
 of this software and associated documentation files (the "Software"), to deal  
diff --git a/README.md b/README.md
@@ -88,7 +88,7 @@ $ cat ascii.properties | native2ascii --reverse > utf8.properties
 
 ## API
 
-    native2ascii(input[, options])
+### native2ascii(input[, options])
 
 Converts the specified `input` so that it can be encoded in ASCII by using Unicode escapes ("\uxxxx" notation) for all
 characters that are not part of the ASCII character set.
@@ -97,13 +97,13 @@ This function is useful for properties files containing characters not in ISO-88
 
 A reverse conversion can be performed by enabling the `reverse` option.
 
-### Options
+#### Options
 
 | Option    | Description                      | Default |
 | --------- | -------------------------------- | ------- |
 | `reverse` | Whether to reverse the operation | `false` |
 
-### Examples
+#### Examples
 
 Unicode escape characters not in the ASCII character set so that they can be safely written encoded into ASCII:
 
diff --git a/bin/native2ascii b/bin/native2ascii
@@ -1,7 +1,7 @@
 #!/usr/bin/env node
 
 /*
- * Copyright (C) 2017 Alasdair Mercer, !ninja
+ * Copyright (C) 2018 Alasdair Mercer, !ninja
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "node-native2ascii",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "description": "Node.js implementation of Java's Native-to-ASCII Converter",
   "homepage": "https://github.com/NotNinja/node-native2ascii",
   "bugs": {
@@ -25,16 +25,17 @@
     "url": "https://github.com/NotNinja/node-native2ascii.git"
   },
   "dependencies": {
-    "commander": "^2.12.2"
+    "commander": "^2.13.0",
+    "escape-unicode": "^0.1.0",
+    "unescape-unicode": "^0.1.0"
   },
   "devDependencies": {
-    "chai": "^4.1.2",
     "codecov": "^3.0.0",
-    "eslint": "^4.13.0",
+    "eslint": "^4.16.0",
     "eslint-config-notninja": "^0.2.3",
-    "mocha": "^4.0.1",
-    "nyc": "^11.3.0",
-    "sinon": "^4.1.3",
+    "mocha": "^5.0.0",
+    "nyc": "^11.4.1",
+    "sinon": "^4.2.1",
     "tmp": "0.0.33"
   },
   "bin": {
diff --git a/src/cli.js b/src/cli.js
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2017 Alasdair Mercer, !ninja
+ * Copyright (C) 2018 Alasdair Mercer, !ninja
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal
diff --git a/src/native2ascii.js b/src/native2ascii.js
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2017 Alasdair Mercer, !ninja
+ * Copyright (C) 2018 Alasdair Mercer, !ninja
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal
diff --git a/src/unicode/escape.js b/src/unicode/escape.js
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2017 Alasdair Mercer, !ninja
+ * Copyright (C) 2018 Alasdair Mercer, !ninja
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal
@@ -22,7 +22,7 @@
 
 'use strict';
 
-const hexDigits = [ '0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'a', 'b', 'c', 'd', 'e', 'f' ];
+const escapeUnicode = require('escape-unicode');
 
 /**
  * Converts all Unicode characters within the specifed <code>input</code> to Unicode escapes ("\uxxxx" notation).
@@ -37,36 +37,13 @@ function escape(input) {
     const code = input.charCodeAt(i);
 
     if (code > 0x7f) {
-      result += `\\u${toHex(code)}`;
+      result += escapeUnicode(input, i, i + 1);
     } else {
-      result += input.charAt(i);
+      result += input[i];
     }
   }
 
   return result;
 }
 
-/**
- * Converts the specified character <code>code</code> to a hexadecimal value.
- *
- * @param {number} code - the character code to be converted
- * @return {string} The 4-digit hexadecimal string.
- */
-function toHex(code) {
-  return toHexDigit((code >> 12) & 15) +
-    toHexDigit((code >> 8) & 15) +
-    toHexDigit((code >> 4) & 15) +
-    toHexDigit(code & 15);
-}
-
-/**
- * Converts the specified <code>nibble</code> to a hexadecimal digit.
- *
- * @param {number} nibble - the nibble to be converted
- * @return {string} The single-digit hexadecimal string.
- */
-function toHexDigit(nibble) {
-  return hexDigits[nibble & 15];
-}
-
 module.exports = escape;
diff --git a/src/unicode/index.js b/src/unicode/index.js
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2017 Alasdair Mercer, !ninja
+ * Copyright (C) 2018 Alasdair Mercer, !ninja
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal
diff --git a/src/unicode/unescape.js b/src/unicode/unescape.js
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2017 Alasdair Mercer, !ninja
+ * Copyright (C) 2018 Alasdair Mercer, !ninja
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal
@@ -22,7 +22,7 @@
 
 'use strict';
 
-/* eslint complexity: "off" */
+const unescapeUnicode = require('unescape-unicode');
 
 /**
  * Converts all Unicode escapes ("\uxxxx" notation) within the specified <code>input</code> into their corresponding
@@ -38,13 +38,13 @@ function unescape(input) {
   let result = '';
 
   for (let i = 0, length = input.length; i < length; i++) {
-    let ch = input.charAt(i);
+    let ch = input[i];
 
     if (ch === '\\') {
-      ch = input.charAt(++i);
+      ch = input[++i];
 
       if (ch === 'u') {
-        result += getUnicode(input, i + 1);
+        result += unescapeUnicode(input, i + 1);
         i += 4;
       } else {
         result += `\\${ch}`;
@@ -57,63 +57,4 @@ function unescape(input) {
   return result;
 }
 
-/**
- * Attempts to convert the Unicode escape within <code>input</code> at the specified <code>offset</code>.
- *
- * <code>offset</code> should be the index of the first character after the "\u" prefix of the Unicode escape and will
- * result in the offset being increased as it reads in the next four characters within <code>input</code>.
- *
- * This function will throw an error if the hexadecimal value corresponding to the Unicode escape at the specified
- * <code>offset</code> is malformed.
- *
- * @param {string} input - the string to be converted
- * @param {number} offset - the offset of the hexadecimal segment of the Unicode escape from which the Unicode character
- * is to be derived relative to <code>input</code>
- * @return {string} The Unicode character converted from the escape at <code>offset</code> within <code>input</code>.
- * @throws {Error} If the Unicode escape is malformed.
- */
-function getUnicode(input, offset) {
-  let unicode = 0;
-
-  for (let i = offset, end = offset + 4; i < end; i++) {
-    const ch = input.charAt(i);
-    const code = ch.charCodeAt(0);
-
-    switch (ch) {
-    case '0':
-    case '1':
-    case '2':
-    case '3':
-    case '4':
-    case '5':
-    case '6':
-    case '7':
-    case '8':
-    case '9':
-      unicode = (unicode << 4) + code - 0x30;
-      break;
-    case 'A':
-    case 'B':
-    case 'C':
-    case 'D':
-    case 'E':
-    case 'F':
-      unicode = (unicode << 4) + 10 + code - 0x41;
-      break;
-    case 'a':
-    case 'b':
-    case 'c':
-    case 'd':
-    case 'e':
-    case 'f':
-      unicode = (unicode << 4) + 10 + code - 0x61;
-      break;
-    default:
-      throw new Error(`Malformed character found in \\uxxxx encoding: ${ch}`);
-    }
-  }
-
-  return String.fromCharCode(unicode);
-}
-
 module.exports = unescape;
diff --git a/test/cli.spec.js b/test/cli.spec.js
diff --git a/test/native2ascii.spec.js b/test/native2ascii.spec.js
diff --git a/test/unicode/escape.spec.js b/test/unicode/escape.spec.js
diff --git a/test/unicode/index.spec.js b/test/unicode/index.spec.js
diff --git a/test/unicode/unescape.spec.js b/test/unicode/unescape.spec.js

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-Copyright (C) 2017 Alasdair Mercer, !ninja`
	`1`	`+Copyright (C) 2018 Alasdair Mercer, !ninja`
`2`	`2`
`3`	`3`	`Permission is hereby granted, free of charge, to any person obtaining a copy`
`4`	`4`	`of this software and associated documentation files (the "Software"), to deal`
Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`#!/usr/bin/env node`
`2`	`2`
`3`	`3`	`/*`
`4`		`- * Copyright (C) 2017 Alasdair Mercer, !ninja`
	`4`	`+ * Copyright (C) 2018 Alasdair Mercer, !ninja`
`5`	`5`	`*`
`6`	`6`	`* Permission is hereby granted, free of charge, to any person obtaining a copy`
`7`	`7`	`* of this software and associated documentation files (the "Software"), to deal`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`/*`
`2`		`- * Copyright (C) 2017 Alasdair Mercer, !ninja`
	`2`	`+ * Copyright (C) 2018 Alasdair Mercer, !ninja`
`3`	`3`	`*`
`4`	`4`	`* Permission is hereby granted, free of charge, to any person obtaining a copy`
`5`	`5`	`* of this software and associated documentation files (the "Software"), to deal`