Genericize Injector loading code, create new AutoFormatParam namespace, move out unit tests.

git-svn-id: http://htmlpurifier.org/svnroot/htmlpurifier/trunk@1224 48356398-32a2-884e-a903-53898d9a118a

TODO

@@ -46,7 +46,7 @@ TODO List
  # Formatters for plaintext
     - Smileys
     - Linkification for HTML Purifier docs: notably configuration and classes
- - Standardize token armor for all areas of armor
+ - Standardize token armor for all areas of processing
  - Fixes for Firefox's inability to handle COL alignment props (Bug 915)
  - Automatically add non-breaking spaces to empty table cells when
    empty-cells:show is applied to have compatibility with Internet Explorer

library/HTMLPurifier/ConfigSchema.php

@@ -67,7 +67,8 @@ class HTMLPurifier_ConfigSchema {
         $this->defineNamespace('URI', 'Features regarding Uniform Resource Identifiers.');
         $this->defineNamespace('HTML', 'Configuration regarding allowed HTML.');
         $this->defineNamespace('CSS', 'Configuration regarding allowed CSS.');
-        $this->defineNamespace('AutoFormat', 'Configuration regarding auto-formatting functionality such as auto-paragraphing or linkification.');
+        $this->defineNamespace('AutoFormat', 'Configuration for activating auto-formatting functionality (also known as <code>Injector</code>s)');
+        $this->defineNamespace('AutoFormatParam', 'Configuration for customizing auto-formatting functionality');
         $this->defineNamespace('Output', 'Configuration relating to the generation of (X)HTML.');
         $this->defineNamespace('Cache', 'Configuration for DefinitionCache and related subclasses.');
         $this->defineNamespace('Test', 'Developer testing configuration for our unit tests.');

library/HTMLPurifier/Strategy/MakeWellFormed.php

@@ -7,6 +7,17 @@ require_once 'HTMLPurifier/Generator.php';
 require_once 'HTMLPurifier/Injector/AutoParagraph.php';
 require_once 'HTMLPurifier/Injector/Linkify.php';
 
+HTMLPurifier_ConfigSchema::define(
+    'AutoFormat', 'Custom', array(), 'list', '
+<p>
+  This directive can be used to add custom auto-format injectors.
+  Specify an array of injector names (class name minus the prefix)
+  or concrete implementations. Injector class must exist. This directive
+  has been available since 2.0.1.
+</p>
+'
+);
+
 /**
  * Takes tokens makes them well-formed (balance end tags, etc.)
  */
@@ -48,14 +59,19 @@ class HTMLPurifier_Strategy_MakeWellFormed extends HTMLPurifier_Strategy
         
         $this->injectors = array();
         
-        // we need a generic way of adding injectors, and also its own
+        $injectors = $config->getBatch('AutoFormat');
-        // configuration namespace
+        $custom_injectors = $injectors['Custom'];
-        if ($config->get('AutoFormat', 'AutoParagraph')) {
+        unset($injectors['Custom']); // special case
-            $this->injectors[] = new HTMLPurifier_Injector_AutoParagraph();
+        foreach ($injectors as $injector => $b) {
+            $injector = "HTMLPurifier_Injector_$injector";
+            if ($b) $this->injectors[] = new $injector;
         }
-        
+        foreach ($custom_injectors as $injector) {
-        if ($config->get('AutoFormat', 'Linkify')) {
+            if (is_string($injector)) {
-            $this->injectors[] = new HTMLPurifier_Injector_Linkify();
+                $injector = "HTMLPurifier_Injector_$injector";
+                $injector = new $injector;
+            }
+            $this->injectors[] = $injector;
         }
         
         // array index of the injector that resulted in an array

tests/HTMLPurifier/Injector/AutoParagraphTest.php

@@ -0,0 +1,247 @@
+<?php
+
+require_once 'HTMLPurifier/InjectorHarness.php';
+require_once 'HTMLPurifier/Injector/AutoParagraph.php';
+
+class HTMLPurifier_Injector_AutoParagraphTest extends HTMLPurifier_InjectorHarness
+{
+    
+    function setup() {
+        parent::setup();
+        $this->config = array('AutoFormat.AutoParagraph' => true);
+    }
+    
+    function test() {
+        $this->assertResult(
+            'Foobar',
+            '<p>Foobar</p>'
+        );
+        
+        $this->assertResult(
+'Par 1
+Par 1 still',
+'<p>Par 1
+Par 1 still</p>'
+        );
+        
+        $this->assertResult(
+'Par1
+
+Par2',
+            '<p>Par1</p><p>Par2</p>'
+        );
+        
+        $this->assertResult(
+'Par1
+
+ 
+
+Par2',
+            '<p>Par1</p><p>Par2</p>'
+        );
+        
+        $this->assertResult(
+'<b>Par1</b>
+
+<i>Par2</i>',
+            '<p><b>Par1</b></p><p><i>Par2</i></p>'
+        );
+        
+        
+        $this->assertResult(
+'<b>Par1
+
+Par2</b>',
+'<p><b>Par1
+
+Par2</b></p>'
+        );
+        
+        $this->assertResult(
+            'Par1<p>Par2</p>',
+            '<p>Par1</p><p>Par2</p>'
+        );
+        
+        $this->assertResult(
+            '<b>Par1',
+            '<p><b>Par1</b></p>'
+        );
+        
+        $this->assertResult(
+'<pre>Par1
+
+Par1</pre>'
+        );
+        
+        $this->assertResult(
+'Par1
+
+  ',
+'<p>Par1</p>'
+        );
+        $this->assertResult(
+'Par1
+
+<div>Par2</div>
+
+Par3',
+'<p>Par1</p><div>Par2</div><p>Par3</p>'
+        );
+        
+        $this->assertResult(
+'Par<b>1</b>',
+            '<p>Par<b>1</b></p>'
+        );
+        
+        $this->assertResult(
+'
+
+Par',
+            '<p>Par</p>'
+        );
+        
+        $this->assertResult(
+'
+
+Par
+
+',
+            '<p>Par</p>'
+        );
+        
+        $this->assertResult(
+'<div>Par1
+
+Par2</div>',
+            '<div><p>Par1</p><p>Par2</p></div>'
+        );
+        
+        $this->assertResult(
+'<div><b>Par1</b>
+
+Par2</div>',
+            '<div><p><b>Par1</b></p><p>Par2</p></div>'
+        );
+        
+        $this->assertResult('<div>Par1</div>');
+        
+        $this->assertResult(
+'<div><b>Par1</b>
+
+<i>Par2</i></div>',
+            '<div><p><b>Par1</b></p><p><i>Par2</i></p></div>'
+        );
+        
+        $this->assertResult(
+'<pre><b>Par1</b>
+
+<i>Par2</i></pre>',
+            true
+        );
+        
+        $this->assertResult(
+'<div><p>Foo
+
+Bar</p></div>',
+            '<div><p>Foo</p><p>Bar</p></div>'
+        );
+        
+        $this->assertResult(
+'<div><p><b>Foo</b>
+
+<i>Bar</i></p></div>',
+            '<div><p><b>Foo</b></p><p><i>Bar</i></p></div>'
+        );
+        
+        $this->assertResult(
+'<div><b>Foo</b></div>',
+            '<div><b>Foo</b></div>'
+        );
+        
+        $this->assertResult(
+'<blockquote>Par1
+
+Par2</blockquote>',
+            '<blockquote><p>Par1</p><p>Par2</p></blockquote>'
+        );
+        
+        $this->assertResult(
+'<ul><li>Foo</li>
+
+<li>Bar</li></ul>', true
+        );
+        
+        $this->assertResult(
+'<div>
+
+Bar
+
+</div>', 
+        '<div><p>Bar</p></div>'
+        );
+        
+        $this->assertResult(
+'<b>Par1</b>a
+
+
+
+Par2', 
+        '<p><b>Par1</b>a</p><p>Par2</p>'
+        );
+        
+        $this->assertResult(
+'Par1
+
+Par2</p>', 
+        '<p>Par1</p><p>Par2</p>'
+        );
+        
+        $this->assertResult(
+'Par1
+
+Par2</div>', 
+        '<p>Par1</p><p>Par2</p>'
+        );
+        
+        $this->assertResult(
+'<div>
+Par1
+</div>', true
+        );
+        
+        $this->assertResult(
+'<div>Par1
+
+<div>Par2</div></div>',
+'<div><p>Par1</p><div>Par2</div></div>'
+        );
+        
+        $this->assertResult(
+'<div>Par1
+<div>Par2</div></div>',
+'<div><p>Par1
+</p><div>Par2</div></div>'
+        );
+        
+        $this->assertResult(
+'Par1
+<div>Par2</div>',
+'<p>Par1
+</p><div>Par2</div>'
+        );
+        
+    }
+    
+    function testInlineRootNode() {
+        $this->assertResult(
+'Par
+
+Par2',
+            true,
+            array('AutoFormat.AutoParagraph' => true, 'HTML.Parent' => 'span')
+        );
+    }
+    
+}
+
+?>

tests/HTMLPurifier/Injector/LinkifyTest.php

@@ -0,0 +1,39 @@
+<?php
+
+require_once 'HTMLPurifier/InjectorHarness.php';
+require_once 'HTMLPurifier/Injector/Linkify.php';
+
+class HTMLPurifier_Injector_LinkifyTest extends HTMLPurifier_InjectorHarness
+{
+    
+    function setup() {
+        parent::setup();
+        $this->config = array('AutoFormat.Linkify' => true);
+    }
+    
+    function testLinkify() {
+        
+        $this->assertResult(
+            'http://example.com',
+            '<a href="http://example.com">http://example.com</a>'
+        );
+        
+        $this->assertResult(
+            '<b>http://example.com</b>',
+            '<b><a href="http://example.com">http://example.com</a></b>'
+        );
+        
+        $this->assertResult(
+            'This URL http://example.com is what you need',
+            'This URL <a href="http://example.com">http://example.com</a> is what you need'
+        );
+        
+        $this->assertResult(
+            '<a>http://example.com/</a>'
+        );
+        
+    }
+    
+}
+
+?>

tests/HTMLPurifier/InjectorHarness.php

@@ -0,0 +1,16 @@
+<?php
+
+require_once 'HTMLPurifier/StrategyHarness.php';
+require_once 'HTMLPurifier/Strategy/MakeWellFormed.php';
+
+class HTMLPurifier_InjectorHarness extends HTMLPurifier_StrategyHarness
+{
+    
+    function setUp() {
+        parent::setUp();
+        $this->obj = new HTMLPurifier_Strategy_MakeWellFormed();
+    }
+    
+}
+
+?>

tests/HTMLPurifier/Strategy/MakeWellFormedTest.php

@@ -75,262 +75,6 @@ class HTMLPurifier_Strategy_MakeWellFormedTest extends HTMLPurifier_StrategyHarn
         
     }
     
-    function testAutoParagraph() {
-        $this->config = array('AutoFormat.AutoParagraph' => true);
-        
-        $this->assertResult(
-            'Foobar',
-            '<p>Foobar</p>'
-        );
-        
-        $this->assertResult(
-'Par 1
-Par 1 still',
-'<p>Par 1
-Par 1 still</p>'
-        );
-        
-        $this->assertResult(
-'Par1
-
-Par2',
-            '<p>Par1</p><p>Par2</p>'
-        );
-        
-        $this->assertResult(
-'Par1
-
- 
-
-Par2',
-            '<p>Par1</p><p>Par2</p>'
-        );
-        
-        $this->assertResult(
-'<b>Par1</b>
-
-<i>Par2</i>',
-            '<p><b>Par1</b></p><p><i>Par2</i></p>'
-        );
-        
-        
-        $this->assertResult(
-'<b>Par1
-
-Par2</b>',
-'<p><b>Par1
-
-Par2</b></p>'
-        );
-        
-        $this->assertResult(
-            'Par1<p>Par2</p>',
-            '<p>Par1</p><p>Par2</p>'
-        );
-        
-        $this->assertResult(
-            '<b>Par1',
-            '<p><b>Par1</b></p>'
-        );
-        
-        $this->assertResult(
-'<pre>Par1
-
-Par1</pre>'
-        );
-        
-        $this->assertResult(
-'Par1
-
-  ',
-'<p>Par1</p>'
-        );
-        $this->assertResult(
-'Par1
-
-<div>Par2</div>
-
-Par3',
-'<p>Par1</p><div>Par2</div><p>Par3</p>'
-        );
-        
-        $this->assertResult(
-'Par<b>1</b>',
-            '<p>Par<b>1</b></p>'
-        );
-        
-        $this->assertResult(
-'
-
-Par',
-            '<p>Par</p>'
-        );
-        
-        $this->assertResult(
-'
-
-Par
-
-',
-            '<p>Par</p>'
-        );
-        
-        $this->assertResult(
-'<div>Par1
-
-Par2</div>',
-            '<div><p>Par1</p><p>Par2</p></div>'
-        );
-        
-        $this->assertResult(
-'<div><b>Par1</b>
-
-Par2</div>',
-            '<div><p><b>Par1</b></p><p>Par2</p></div>'
-        );
-        
-        $this->assertResult('<div>Par1</div>');
-        
-        $this->assertResult(
-'<div><b>Par1</b>
-
-<i>Par2</i></div>',
-            '<div><p><b>Par1</b></p><p><i>Par2</i></p></div>'
-        );
-        
-        $this->assertResult(
-'<pre><b>Par1</b>
-
-<i>Par2</i></pre>',
-            true
-        );
-        
-        $this->assertResult(
-'<div><p>Foo
-
-Bar</p></div>',
-            '<div><p>Foo</p><p>Bar</p></div>'
-        );
-        
-        $this->assertResult(
-'<div><p><b>Foo</b>
-
-<i>Bar</i></p></div>',
-            '<div><p><b>Foo</b></p><p><i>Bar</i></p></div>'
-        );
-        
-        $this->assertResult(
-'<div><b>Foo</b></div>',
-            '<div><b>Foo</b></div>'
-        );
-        
-        $this->assertResult(
-'<blockquote>Par1
-
-Par2</blockquote>',
-            '<blockquote><p>Par1</p><p>Par2</p></blockquote>'
-        );
-        
-        $this->assertResult(
-'<ul><li>Foo</li>
-
-<li>Bar</li></ul>', true
-        );
-        
-        $this->assertResult(
-'<div>
-
-Bar
-
-</div>', 
-        '<div><p>Bar</p></div>'
-        );
-        
-        $this->assertResult(
-'<b>Par1</b>a
-
-
-
-Par2', 
-        '<p><b>Par1</b>a</p><p>Par2</p>'
-        );
-        
-        $this->assertResult(
-'Par1
-
-Par2</p>', 
-        '<p>Par1</p><p>Par2</p>'
-        );
-        
-        $this->assertResult(
-'Par1
-
-Par2</div>', 
-        '<p>Par1</p><p>Par2</p>'
-        );
-        
-        $this->assertResult(
-'<div>
-Par1
-</div>', true
-        );
-        
-        $this->assertResult(
-'<div>Par1
-
-<div>Par2</div></div>',
-'<div><p>Par1</p><div>Par2</div></div>'
-        );
-        
-        $this->assertResult(
-'<div>Par1
-<div>Par2</div></div>',
-'<div><p>Par1
-</p><div>Par2</div></div>'
-        );
-        
-        $this->assertResult(
-'Par1
-<div>Par2</div>',
-'<p>Par1
-</p><div>Par2</div>'
-        );
-        
-        $this->assertResult(
-'Par
-
-Par2',
-            true,
-            array('AutoFormat.AutoParagraph' => true, 'HTML.Parent' => 'span')
-        );
-        
-    }
-    
-    function testLinkify() {
-        
-        $this->config = array('AutoFormat.Linkify' => true);
-        
-        $this->assertResult(
-            'http://example.com',
-            '<a href="http://example.com">http://example.com</a>'
-        );
-        
-        $this->assertResult(
-            '<b>http://example.com</b>',
-            '<b><a href="http://example.com">http://example.com</a></b>'
-        );
-        
-        $this->assertResult(
-            'This URL http://example.com is what you need',
-            'This URL <a href="http://example.com">http://example.com</a> is what you need'
-        );
-        
-        $this->assertResult(
-            '<a>http://example.com/</a>'
-        );
-        
-    }
-    
     function testMultipleInjectors() {
         
         $this->config = array('AutoFormat.AutoParagraph' => true, 'AutoFormat.Linkify' => true);

tests/test_files.php

@@ -81,6 +81,8 @@ $test_files[] = 'HTMLPurifier/HTMLModuleTest.php';
 $test_files[] = 'HTMLPurifier/HTMLModule/ScriptingTest.php';
 $test_files[] = 'HTMLPurifier/HTMLModule/TidyTest.php';
 $test_files[] = 'HTMLPurifier/IDAccumulatorTest.php';
+$test_files[] = 'HTMLPurifier/Injector/AutoParagraphTest.php';
+$test_files[] = 'HTMLPurifier/Injector/LinkifyTest.php';
 $test_files[] = 'HTMLPurifier/LanguageFactoryTest.php';
 $test_files[] = 'HTMLPurifier/LanguageTest.php';
 $test_files[] = 'HTMLPurifier/Lexer/DirectLexTest.php';