CRM_Utils_JS - Improve encode handling of strings

[civicrm-core.git] / tests / phpunit / CRM / Utils / JSTest.php

diff --git a/tests/phpunit/CRM/Utils/JSTest.php b/tests/phpunit/CRM/Utils/JSTest.php
index 4f1e97d8303b830b81e5e12ab8906af99967d3fc..42ca9e20e99dc613804a7fa7e711cef57bd0ca0d 100644 (file)
--- a/tests/phpunit/CRM/Utils/JSTest.php
+++ b/tests/phpunit/CRM/Utils/JSTest.php
@@ -35,38 +35,38 @@ class CRM_Utils_JSTest extends CiviUnitTestCase {
    * @return array
    */
   public function translateExamples() {
-    $cases = array();
-    $cases[] = array(
+    $cases = [];
+    $cases[] = [
       '',
-      array(),
-    );
+      [],
+    ];
     // missing ts
-    $cases[] = array(
+    $cases[] = [
       'alert("Hello world")',
-      array(),
-    );
+      [],
+    ];
     // basic function call
-    $cases[] = array(
+    $cases[] = [
       'alert(ts("Hello world"));',
-      array('Hello world'),
-    );
+      ['Hello world'],
+    ];
     // with arg
-    $cases[] = array(
+    $cases[] = [
       'alert(ts("Hello world", {1: "whiz"}));',
-      array('Hello world'),
-    );
+      ['Hello world'],
+    ];
     // not really ts()
-    $cases[] = array(
+    $cases[] = [
       'alert(clients("Hello world"));',
-      array(),
-    );
+      [],
+    ];
     // not really ts()
-    $cases[] = array(
+    $cases[] = [
       'alert(clients("Hello world", {1: "whiz"}));',
-      array(),
-    );
+      [],
+    ];
     // with arg
-    $cases[] = array(
+    $cases[] = [
       "\n" .
       "public function whits() {\n" .
       "  for (a in b) {\n" .
@@ -75,37 +75,37 @@ class CRM_Utils_JSTest extends CiviUnitTestCase {
       "    });\n" .
       "  }\n" .
       "}\n",
-      array('Hello'),
-    );
+      ['Hello'],
+    ];
     // duplicate
-    $cases[] = array(
+    $cases[] = [
       'alert(ts("Hello world") + "-" + ts("Hello world"));',
-      array('Hello world'),
-    );
+      ['Hello world'],
+    ];
     // two strings, addition
-    $cases[] = array(
+    $cases[] = [
       'alert(ts("Hello world") + "-" + ts("How do you do?"));',
-      array('Hello world', 'How do you do?'),
-    );
+      ['Hello world', 'How do you do?'],
+    ];
     // two strings, separate calls
-    $cases[] = array(
+    $cases[] = [
       'alert(ts("Hello world");\nalert(ts("How do you do?"));',
-      array('Hello world', 'How do you do?'),
-    );
-    $cases[] = array(
+      ['Hello world', 'How do you do?'],
+    ];
+    $cases[] = [
       'alert(ts(\'Single quoted\'));',
-      array('Single quoted'),
-    );
+      ['Single quoted'],
+    ];
     // unclear string
-    $cases[] = array(
+    $cases[] = [
       'alert(ts(message));',
-      array(),
-    );
+      [],
+    ];
     // ts() within a string
-    $cases[] = array(
+    $cases[] = [
       'alert(ts("Does the ts(\'example\') notation work?"));',
-      array('Does the ts(\'example\') notation work?'),
-    );
+      ['Does the ts(\'example\') notation work?'],
+    ];
     return $cases;
   }
 
@@ -136,18 +136,18 @@ class CRM_Utils_JSTest extends CiviUnitTestCase {
     $abc = "(function (angular, $, _) {\na();\n\nb();\n\nc();\n})(angular,CRM.$, CRM._);";
     $cb = "(function( angular, $,_) {\nc();\n\nb();\n})(angular,CRM.$,CRM._);";
 
-    $cases = array();
-    $cases[] = array(array($a), "$a");
-    $cases[] = array(array($b), "$b");
-    $cases[] = array(array($c), "$c");
-    $cases[] = array(array($d), "$d");
-    $cases[] = array(array($m), "$m");
-    $cases[] = array(array($a, $b), "$ab");
-    $cases[] = array(array($a, $m, $b), "$a$m$b");
-    $cases[] = array(array($a, $d), "$a$d");
-    $cases[] = array(array($a, $d, $b), "$a$d$b");
-    $cases[] = array(array($a, $b, $c), "$abc");
-    $cases[] = array(array($a, $b, $d, $c, $b), "$ab$d$cb");
+    $cases = [];
+    $cases[] = [[$a], "$a"];
+    $cases[] = [[$b], "$b"];
+    $cases[] = [[$c], "$c"];
+    $cases[] = [[$d], "$d"];
+    $cases[] = [[$m], "$m"];
+    $cases[] = [[$a, $b], "$ab"];
+    $cases[] = [[$a, $m, $b], "$a$m$b"];
+    $cases[] = [[$a, $d], "$a$d"];
+    $cases[] = [[$a, $d, $b], "$a$d$b"];
+    $cases[] = [[$a, $b, $c], "$abc"];
+    $cases[] = [[$a, $b, $d, $c, $b], "$ab$d$cb"];
     return $cases;
   }
 
@@ -159,34 +159,34 @@ class CRM_Utils_JSTest extends CiviUnitTestCase {
   public function testDedupeClosure($scripts, $expectedOutput) {
     $actualOutput = CRM_Utils_JS::dedupeClosures(
       $scripts,
-      array('angular', '$', '_'),
-      array('angular', 'CRM.$', 'CRM._')
+      ['angular', '$', '_'],
+      ['angular', 'CRM.$', 'CRM._']
     );
     $this->assertEquals($expectedOutput, implode("", $actualOutput));
   }
 
   public function stripCommentsExamples() {
-    $cases = array();
-    $cases[] = array(
+    $cases = [];
+    $cases[] = [
       "a();\n//# sourceMappingURL=../foo/bar/baz.js\nb();",
       "a();\n\nb();",
-    );
-    $cases[] = array(
+    ];
+    $cases[] = [
       "// foo\na();",
       "\na();",
-    );
-    $cases[] = array(
+    ];
+    $cases[] = [
       "b();\n  // foo",
       "b();\n",
-    );
-    $cases[] = array(
+    ];
+    $cases[] = [
       "/// foo\na();\n\t \t//bar\nb();\n// whiz",
       "\na();\n\nb();\n",
-    );
-    $cases[] = array(
+    ];
+    $cases[] = [
       "alert('//# sourceMappingURL=../foo/bar/baz.js');\n//zoop\na();",
       "alert('//# sourceMappingURL=../foo/bar/baz.js');\n\na();",
-    );
+    ];
     return $cases;
   }
 
@@ -203,6 +203,7 @@ class CRM_Utils_JSTest extends CiviUnitTestCase {
     return [
       ['{a: \'Apple\', \'b\': "Banana", c: [1, 2, 3]}', ['a' => 'Apple', 'b' => 'Banana', 'c' => [1, 2, 3]]],
       ['true', TRUE],
+      [' ', NULL],
       ['false', FALSE],
       ['null', NULL],
       ['"true"', 'true'],
@@ -212,6 +213,10 @@ class CRM_Utils_JSTest extends CiviUnitTestCase {
       ["{  }", []],
       [" [   ]", []],
       [" [ 2   ]", [2]],
+      [
+        '{a: "parse error no closing bracket"',
+        NULL,
+      ],
       [
         '{a: ["foo", \'bar\'], "b": {a: [\'foo\', "bar"], b: {\'a\': ["foo", "bar"], b: {}}}}',
         ['a' => ['foo', 'bar'], 'b' => ['a' => ['foo', 'bar'], 'b' => ['a' => ['foo', 'bar'], 'b' => []]]],
@@ -232,6 +237,39 @@ class CRM_Utils_JSTest extends CiviUnitTestCase {
     $this->assertEquals($expectedOutput, CRM_Utils_JS::decode($input));
   }
 
+  public static function encodeExamples() {
+    return [
+      [
+        ['a' => 'Apple', 'b' => 'Banana', 'c' => [0, -2, 3.15]],
+        "{a: 'Apple', b: 'Banana', c: [0, -2, 3.15]}",
+      ],
+      [
+        ['a' => ['foo', 'bar'], 'b' => ["'a'" => ['foo/bar&', 'bar(foo)'], 'b' => ['a' => ["fo'oo", '"bar"'], 'b' => []]]],
+        "{a: ['foo', 'bar'], b: {\"'a'\": ['foo/bar&', 'bar(foo)'], b: {a: ['fo\\'oo', '\"bar\"'], b: {}}}}",
+      ],
+      [TRUE, 'true'],
+      [' ', "' '"],
+      [FALSE, 'false'],
+      [NULL, 'null'],
+      ['true', "'true'"],
+      ['"false"', "'\"false\"'"],
+      ['0.5', "'0.5'"],
+      [0.5, '0.5'],
+      [[], "{}"],
+    ];
+  }
+
+  /**
+   * @param string $input
+   * @param string $expectedOutput
+   * @dataProvider encodeExamples
+   */
+  public function testEncode($input, $expectedOutput) {
+    $result = CRM_Utils_JS::encode($input);
+    $this->assertEquals($expectedOutput, $result);
+    $this->assertEquals($input, CRM_Utils_JS::decode($result));
+  }
+
   /**
    * @return array
    */