From d1e4cc3f4e0e64b162b11bdce2c36d6724675e2a Mon Sep 17 00:00:00 2001
From: Tim Otten <totten@civicrm.org>
Date: Fri, 31 Mar 2017 22:07:49 -0700
Subject: [PATCH] CRM-20600 - PartialSyntaxTest - Ensure that Angular partials
 are well-formed

---
 Civi/Angular/Coder.php                        |  82 ++++++++++++
 .../Civi/Angular/PartialSyntaxTest.php        | 121 ++++++++++++++++++
 tools/scripts/check-angular.php               |  58 +++++++++
 3 files changed, 261 insertions(+)
 create mode 100644 Civi/Angular/Coder.php
 create mode 100644 tests/phpunit/Civi/Angular/PartialSyntaxTest.php
 create mode 100755 tools/scripts/check-angular.php

diff --git a/Civi/Angular/Coder.php b/Civi/Angular/Coder.php
new file mode 100644
index 0000000000..c780462c93
--- /dev/null
+++ b/Civi/Angular/Coder.php
@@ -0,0 +1,82 @@
+<?php
+namespace Civi\Angular;
+
+class Coder {
+
+  /**
+   *
+   * Determine whether an HTML snippet remains consistent (through an
+   * decode/encode loop).
+   *
+   * Note: Variations in whitespace are permitted.
+   *
+   * @param string $html
+   * @return bool
+   */
+  public function checkConsistentHtml($html) {
+    try {
+      $recodedHtml = $this->recode($html);
+    }
+    catch (\Exception $e) {
+      return FALSE;
+    }
+
+    $htmlSig = preg_replace('/[ \t\r\n\/]+/', '', $this->cleanup($html));
+    $docSig = preg_replace('/[ \t\r\n\/]+/', '', $recodedHtml);
+    if ($htmlSig !== $docSig || empty($html) != empty($htmlSig)) {
+      return FALSE;
+    }
+    return TRUE;
+  }
+
+  /**
+   * Parse an HTML snippet and re-encode is as HTML.
+   *
+   * This is useful for detecting cases where the parser or encoder
+   * have quirks/bugs.
+   *
+   * @param string $html
+   * @return string
+   */
+  public function recode($html) {
+    $doc = \phpQuery::newDocument("$html", 'text/html');
+    return $this->encode($doc);
+  }
+
+  /**
+   * Encode a phpQueryObject as HTML.
+   *
+   * @param \phpQueryObject $doc
+   * @return string
+   *   HTML
+   */
+  public function encode($doc) {
+    $doc->document->formatOutput = TRUE;
+    return $this->cleanup($doc->markupOuter());
+  }
+
+  protected function cleanup($html) {
+    $html = preg_replace_callback("/([\\-a-zA-Z0-9]+)=(')([^']*)(')/", array($this, 'cleanupAttribute'), $html);
+    $html = preg_replace_callback('/([\-a-zA-Z0-9]+)=(")([^"]*)(")/', array($this, 'cleanupAttribute'), $html);
+    return $html;
+  }
+
+  protected function cleanupAttribute($matches) {
+    list ($full, $attr, $lquote, $value, $rquote) = $matches;
+
+    switch ($attr) {
+      case 'href':
+        if (strpos($value, '%7B%7B') !== FALSE && strpos($value, '%7D%7D') !== FALSE) {
+          $value = urldecode($value);
+        }
+        break;
+
+      default:
+        $value = html_entity_decode($value);
+        break;
+    }
+
+    return "$attr=$lquote$value$rquote";
+  }
+
+}
diff --git a/tests/phpunit/Civi/Angular/PartialSyntaxTest.php b/tests/phpunit/Civi/Angular/PartialSyntaxTest.php
new file mode 100644
index 0000000000..796345e2ae
--- /dev/null
+++ b/tests/phpunit/Civi/Angular/PartialSyntaxTest.php
@@ -0,0 +1,121 @@
+<?php
+/*
+ +--------------------------------------------------------------------+
+ | CiviCRM version 4.7                                                |
+ +--------------------------------------------------------------------+
+ | Copyright CiviCRM LLC (c) 2004-2017                                |
+ +--------------------------------------------------------------------+
+ | This file is a part of CiviCRM.                                    |
+ |                                                                    |
+ | CiviCRM is free software; you can copy, modify, and distribute it  |
+ | under the terms of the GNU Affero General Public License           |
+ | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
+ |                                                                    |
+ | CiviCRM is distributed in the hope that it will be useful, but     |
+ | WITHOUT ANY WARRANTY; without even the implied warranty of         |
+ | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
+ | See the GNU Affero General Public License for more details.        |
+ |                                                                    |
+ | You should have received a copy of the GNU Affero General Public   |
+ | License and the CiviCRM Licensing Exception along                  |
+ | with this program; if not, contact CiviCRM LLC                     |
+ | at info[AT]civicrm[DOT]org. If you have questions about the        |
+ | GNU Affero General Public License or the licensing of CiviCRM,     |
+ | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
+ +--------------------------------------------------------------------+
+ */
+
+namespace Civi\Angular;
+
+/**
+ * Ensure that all Angular *.html partials are well-formed.
+ */
+class PartialSyntaxTest extends \CiviUnitTestCase {
+
+  /**
+   * @var Manager
+   */
+  protected $angular;
+
+  /**
+   * @var \CRM_Core_Resources
+   */
+  protected $res;
+
+  /**
+   * @inheritDoc
+   */
+  protected function setUp() {
+    $this->useTransaction(TRUE);
+    parent::setUp();
+    $this->createLoggedInUser();
+    $this->res = \CRM_Core_Resources::singleton();
+    $this->angular = new Manager($this->res);
+  }
+
+  public function basicConsistencyExamples() {
+    $cases = array();
+
+    $cases[0] = array(
+      '<div foo="bar"></div>',
+      '<div foo="bar"></div>',
+    );
+    $cases[1] = array(
+      '<div foo="bar"/>',
+      '<div foo="bar"></div>',
+    );
+    $cases[2] = array(
+      '<div foo=\'bar\'></div>',
+      '<div foo="bar"></div>',
+    );
+    $cases[3] = array(
+      '<div foo=\'ts("Hello world")\'></div>',
+      '<div foo=\'ts("Hello world")\'></div>',
+    );
+    $cases[4] = array(
+      '<div foo="ts(\'Hello world\')\"></div>',
+      '<div foo="ts(\'Hello world\')\"></div>',
+    );
+    $cases[5] = array(
+      '<a href="{{foo}}" title="{{bar}}"></a>',
+      '<a href="{{foo}}" title="{{bar}}"></a>',
+    );
+    $cases[6] = array(
+      '<div ng-if="a && b"></div>',
+      '<div ng-if="a && b"></div>',
+    );
+
+    return $cases;
+  }
+
+  /**
+   * @param string $inputHtml
+   * @param string $expectHtml
+   * @dataProvider basicConsistencyExamples
+   */
+  public function testConsistencyExamples($inputHtml, $expectHtml) {
+    $coder = new Coder();
+    $this->assertEquals($expectHtml, $coder->recode($inputHtml));
+  }
+
+  /**
+   */
+  public function testAllPartials() {
+    $coder = new \Civi\Angular\Coder();
+    $errors = array();
+    $count = 0;
+    foreach ($this->angular->getModules() as $module => $moduleDefn) {
+      $partials = $this->angular->getPartials($module);
+      foreach ($partials as $path => $html) {
+        $count++;
+        if (!$coder->checkConsistentHtml($html)) {
+          $recodedHtml = $coder->recode($html);
+          $this->assertEquals($html, $recodedHtml, "File $path has inconsistent HTML. Use tools/scripts/check-angular.php to debug. ");
+        }
+      }
+    }
+
+    $this->assertTrue($count > 0);
+  }
+
+}
diff --git a/tools/scripts/check-angular.php b/tools/scripts/check-angular.php
new file mode 100755
index 0000000000..b0d44d3003
--- /dev/null
+++ b/tools/scripts/check-angular.php
@@ -0,0 +1,58 @@
+#!/usr/bin/env php
+<?php
+eval(`cv php:boot`);
+
+global $civicrm_root;
+$realArgs = $argv;
+$diffCmd = FALSE;
+$files = array();
+
+array_shift($realArgs);
+foreach ($realArgs as $arg) {
+  switch ($arg) {
+    case '--diff':
+      $diffCmd = 'diff -wu';
+      break;
+
+    case '--colordiff':
+      $diffCmd = 'colordiff -wu';
+      break;
+
+    default:
+      $files[] = $arg;
+  }
+}
+
+if (empty($files)) {
+  echo "usage: cleanup-angular.php [--diff|--colordiff] <file>\n";
+  echo "example: cleanup-angular.php '/full/path/to/crmMailing/BlockSummary.html'\n";
+  echo "note: The file path must be absolute.\n";
+  exit(1);
+}
+else {
+  foreach ($files as $file) {
+    compareFile($file, $diffCmd);
+  }
+}
+
+function compareFile($file, $diffCmd) {
+  $coder = new \Civi\Angular\Coder();
+
+  if (!file_exists($file)) {
+    fwrite(STDERR, "Failed to find file $file (CWD=" . getcwd() . ")\n");
+    return;
+  }
+  $oldMarkup = file_get_contents($file);
+  if ($coder->checkConsistentHtml($oldMarkup)) {
+    echo "File \"$file\" appears sufficiently consistent.\n";
+  }
+  else {
+    $newMarkup = $coder->recode($oldMarkup);
+    $newFile = "{$file}.recoded";
+    echo "File \"$file\" appears to have consistency issues. Created $newFile.\n";
+    file_put_contents($newFile, $newMarkup);
+    if ($diffCmd) {
+      passthru($diffCmd . ' '  . escapeshellarg($file) . ' ' . escapeshellarg($newFile));
+    }
+  }
+}
\ No newline at end of file
-- 
2.25.1