tests/HTMLPurifier/ComplexHarness.php

   1 <?php
   2
   3 /**
   4  * General-purpose test-harness that makes testing functions that require
   5  * configuration and context objects easier when those two parameters are
   6  * meaningless.  See HTMLPurifier_ChildDefTest for a good example of usage.
   7  */
   8 class HTMLPurifier_ComplexHarness extends HTMLPurifier_Harness
   9 {
  10
  11     /**
  12      * Instance of the object that will execute the method.
  13      * @type object
  14      */
  15     protected $obj;
  16
  17     /**
  18      * Name of the function to be executed.
  19      * @type string
  20      */
  21     protected $func;
  22
  23     /**
  24      * Whether or not the method deals in tokens.
  25      * If set to true, assertResult()
  26      * will transparently convert HTML to and back from tokens.
  27      * @type bool
  28      */
  29     protected $to_tokens = false;
  30
  31     /**
  32      * Whether or not the method deals in a node list.
  33      * If set to true, assertResult() will transparently convert HTML
  34      * to and back from node.
  35      * @type bool
  36      */
  37     protected $to_node_list = false;
  38
  39     /**
  40      * Whether or not to convert tokens back into HTML before performing
  41      * equality check, has no effect on bools.
  42      * @type bool
  43      */
  44     protected $to_html = false;
  45
  46     /**
  47      * Instance of an HTMLPurifier_Lexer implementation.
  48      * @type HTMLPurifier_Lexer
  49      */
  50     protected $lexer;
  51
  52     public function __construct()
  53     {
  54         $this->lexer     = new HTMLPurifier_Lexer_DirectLex();
  55         parent::__construct();
  56     }
  57
  58     /**
  59      * Asserts a specific result from a one parameter + config/context function
  60      * @param string $input Input parameter
  61      * @param bool|string $expect Expectation
  62      */
  63     protected function assertResult($input, $expect = true)
  64     {
  65         // $func may cause $input to change, so "clone" another copy
  66         // to sacrifice
  67         if ($this->to_node_list && is_string($input)) {
  68             $input = HTMLPurifier_Arborize::arborize($this->tokenize($temp = $input), $this->config, $this->context)->children;
  69             $input_c = HTMLPurifier_Arborize::arborize($this->tokenize($temp), $this->config, $this->context)->children;
  70         } elseif ($this->to_tokens && is_string($input)) {
  71             $input   = $this->tokenize($temp = $input);
  72             $input_c = $this->tokenize($temp);
  73         } else {
  74             $input_c = $input;
  75         }
  76
  77         // call the function
  78         $func = $this->func;
  79         $result = $this->obj->$func($input_c, $this->config, $this->context);
  80
  81         // test a bool result
  82         if (is_bool($result)) {
  83             $this->assertIdentical($expect, $result);
  84             return;
  85         } elseif (is_bool($expect)) {
  86             $expect = $input;
  87         }
  88
  89         if ($this->to_html) {
  90             if ($this->to_node_list) {
  91                 $result = $this->generateTokens($result);
  92                 if (is_array($expect) && !empty($expect) && $expect[0] instanceof HTMLPurifier_Node) {
  93                     $expect = $this->generateTokens($expect);
  94                 }
  95             }
  96             $result = $this->generate($result);
  97             if (is_array($expect)) {
  98                 $expect = $this->generate($expect);
  99             }
 100         }
 101         $this->assertIdentical($expect, $result);
 102
 103         if ($expect !== $result) {
 104             echo '<pre>' . var_dump($result) . '</pre>';
 105         }
 106
 107     }
 108
 109     /**
 110      * Tokenize HTML into tokens, uses member variables for common variables
 111      */
 112     protected function tokenize($html)
 113     {
 114         return $this->lexer->tokenizeHTML($html, $this->config, $this->context);
 115     }
 116
 117     /**
 118      * Generate textual HTML from tokens
 119      */
 120     protected function generate($tokens)
 121     {
 122         $generator = new HTMLPurifier_Generator($this->config, $this->context);
 123         return $generator->generateFromTokens($tokens);
 124     }
 125
 126     /**
 127      * Generate tokens from node list
 128      */
 129     protected function generateTokens($children)
 130     {
 131         $dummy = new HTMLPurifier_Node_Element("dummy");
 132         $dummy->children = $children;
 133         return HTMLPurifier_Arborize::flatten($dummy, $this->context, $this->config);
 134     }
 135
 136 }
 137
 138 // vim: et sw=4 sts=4