Merge in r657-674, prompted by near release of 1.4.0.

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

tests/HTMLPurifier/ConfigSchemaTest.php

@@ -2,10 +2,26 @@
 
 require_once 'HTMLPurifier/ConfigSchema.php';
 
+if (!class_exists('CS')) {
+    class CS extends HTMLPurifier_ConfigSchema {}
+}
+
 class HTMLPurifier_ConfigSchemaTest extends UnitTestCase
 {
     
+    /**
+     * Munged name of current file.
+     */
+    var $file;
+    
+    /**
+     * Copy of the real ConfigSchema to revert to.
+     */
     var $old_copy;
+    
+    /**
+     * Copy of dummy ConfigSchema for testing purposes.
+     */
     var $our_copy;
     
     function setUp() {
@@ -18,239 +34,214 @@ class HTMLPurifier_ConfigSchemaTest extends UnitTestCase
         $this->old_copy = HTMLPurifier_ConfigSchema::instance();
         // put in our copy, and reassign to the REAL reference
         $this->our_copy =& HTMLPurifier_ConfigSchema::instance($our_copy);
+        
+        $this->file = $this->our_copy->mungeFilename(__FILE__);
     }
     
     function tearDown() {
         // testing is done, restore the old copy
         HTMLPurifier_ConfigSchema::instance($this->old_copy);
+        tally_errors();
     }
     
-    function testNormal() {
+    function test_defineNamespace() {
+        CS::defineNamespace('http', $d = 'This is an internet protocol.');
         
-        $file = $this->our_copy->mungeFilename(__FILE__);
-        
-        // define a namespace
-        $description = 'Configuration that is always available.';
-        HTMLPurifier_ConfigSchema::defineNamespace(
-            'Core', $description
-        );
-        $this->assertIdentical($this->our_copy->defaults, array(
-            'Core' => array()
-        ));
-        $this->assertIdentical($this->our_copy->info, array(
-            'Core' => array()
-        ));
-        $namespace = new HTMLPurifier_ConfigEntity_Namespace();
-        $namespace->description = $description;
         $this->assertIdentical($this->our_copy->info_namespace, array(
-            'Core' => $namespace
+            'http' => new HTMLPurifier_ConfigEntity_Namespace($d)
         ));
         
+        $this->expectError('Cannot redefine namespace');
+        CS::defineNamespace('http', 'It is used to serve webpages.');
         
+        $this->expectError('Namespace name must be alphanumeric');
+        CS::defineNamespace('ssh+http', 'This http is tunneled through SSH.');
         
-        // define a directive
-        $description = 'This is a description of the directive.';
-        HTMLPurifier_ConfigSchema::define(
-            'Core', 'Name', 'default value', 'string',
-            $description
-        ); $line = __LINE__;
-        $this->assertIdentical($this->our_copy->defaults, array(
-            'Core' => array(
-                'Name' => 'default value'
-            )
-        ));
-        $directive = new HTMLPurifier_ConfigEntity_Directive();
-        $directive->type = 'string';
-        $directive->addDescription($file, $line, $description);
-        $this->assertIdentical($this->our_copy->info, array(
-            'Core' => array(
-                'Name' => $directive
-            )
-        ));
+        $this->expectError('Description must be non-empty');
+        CS::defineNamespace('ftp', null);
+    }
+    
+    function test_define() {
+        CS::defineNamespace('Car', 'Automobiles, those gas-guzzlers!');
         
+        CS::define('Car', 'Seats', 5, 'int', $d = 'Standard issue.'); $l = __LINE__;
         
-        
-        // define a directive in an undefined namespace
-        HTMLPurifier_ConfigSchema::define(
-            'Extension', 'Name', false, 'bool',
-            'This is for an extension, but we have not defined its namespace!'
-        );
-        $this->assertError('Cannot define directive for undefined namespace');
-        $this->assertNoErrors();
-        
-        
-        
-        // redefine a value in a valid manner
-        $description = 'Alternative configuration definition';
-        HTMLPurifier_ConfigSchema::define(
-            'Core', 'Name', 'default value', 'string',
-            $description
-        ); $line = __LINE__;
-        $this->assertNoErrors();
-        $directive->addDescription($file, $line, $description);
-        $this->assertIdentical($this->our_copy->info, array(
-            'Core' => array(
-                'Name' => $directive
-            )
-        ));
-        
-        
-        
-        // redefine a directive in an invalid manner
-        HTMLPurifier_ConfigSchema::define(
-            'Core', 'Name', 'different default', 'string',
-            'Inconsistent default or type, cannot redefine'
-        );
-        $this->assertError('Inconsistent default or type, cannot redefine');
-        $this->assertNoErrors();
-        
-        
-        
-        // make an enumeration
-        HTMLPurifier_ConfigSchema::defineAllowedValues(
-            'Core', 'Name', array(
-                'Real Value',
-                'Real Value 2'
+        $this->assertIdentical($this->our_copy->defaults['Car']['Seats'], 5);
+        $this->assertIdentical($this->our_copy->info['Car']['Seats'],
+            new HTMLPurifier_ConfigEntity_Directive('int',
+                array($this->file => array($l => $d))
             )
         );
-        $directive->allowed = array(
-            'Real Value' => true,
-            'Real Value 2' => true
-        );
-        $this->assertIdentical($this->our_copy->info, array(
-            'Core' => array(
-                'Name' => $directive
-            )
-        ));
         
+        CS::define('Car', 'Age', null, 'int/null', $d = 'Not always known.'); $l = __LINE__;
         
-        
-        // redefinition of enumeration is cumulative
-        HTMLPurifier_ConfigSchema::defineAllowedValues(
-            'Core', 'Name', array(
-                'Real Value 3',
+        $this->assertIdentical($this->our_copy->defaults['Car']['Age'], null);
+        $this->assertIdentical($this->our_copy->info['Car']['Age'], 
+            new HTMLPurifier_ConfigEntity_Directive('int',
+                array($this->file => array($l => $d)), true
             )
         );
-        $directive->allowed['Real Value 3'] = true;
-        $this->assertIdentical($this->our_copy->info, array(
-            'Core' => array(
-                'Name' => $directive
-            )
-        ));
         
+        $this->expectError('Cannot define directive for undefined namespace');
+        CS::define('Train', 'Cars', 10, 'int', 'Including the caboose.');
         
+        $this->expectError('Directive name must be alphanumeric');
+        CS::define('Car', 'Is it shiny?', true, 'bool', 'Indicates regular waxing.');
         
-        // cannot define enumeration for undefined directive
-        HTMLPurifier_ConfigSchema::defineAllowedValues(
-            'Core', 'Foobar', array(
-                'Real Value 9',
+        $this->expectError('Invalid type for configuration directive');
+        CS::define('Car', 'Efficiency', 50, 'mpg', 'The higher the better.');
+        
+        $this->expectError('Default value does not match directive type');
+        CS::define('Car', 'Producer', 'Ford', 'int', 'ID of the company that made the car.');
+        
+        $this->expectError('Description must be non-empty');
+        CS::define('Car', 'ComplexAttribute', 'lawyers', 'istring', null);
+    }
+    
+    function testRedefinition_define() {
+        CS::defineNamespace('Cat', 'Belongs to Schrodinger.');
+        
+        CS::define('Cat', 'Dead', false, 'bool', $d1 = 'Well, is it?'); $l1 = __LINE__;
+        CS::define('Cat', 'Dead', false, 'bool', $d2 = 'It is difficult to say.'); $l2 = __LINE__;
+        
+        $this->assertIdentical($this->our_copy->defaults['Cat']['Dead'], false);
+        $this->assertIdentical($this->our_copy->info['Cat']['Dead'], 
+            new HTMLPurifier_ConfigEntity_Directive('bool',
+                array($this->file => array($l1 => $d1, $l2 => $d2))
             )
         );
-        $this->assertError('Cannot define allowed values for undefined directive');
-        $this->assertNoErrors();
         
+        $this->expectError('Inconsistent default or type, cannot redefine');
+        CS::define('Cat', 'Dead', true, 'bool', 'Quantum mechanics does not know.');
         
+        $this->expectError('Inconsistent default or type, cannot redefine');
+        CS::define('Cat', 'Dead', 'maybe', 'string', 'Perhaps if we look we will know.');
+    }
+    
+    function test_defineAllowedValues() {
+        CS::defineNamespace('QuantumNumber', 'D');
+        CS::define('QuantumNumber', 'Spin', 0.5, 'float',
+            'Spin of particle. Fourth quantum number, represented by s.');
+        CS::define('QuantumNumber', 'Current', 's', 'string',
+            'Currently selected quantum number.');
+        CS::define('QuantumNumber', 'Difficulty', null, 'string/null', $d = 'How hard are the problems?'); $l = __LINE__;
         
-        // test defining value aliases for an enumerated value
-        HTMLPurifier_ConfigSchema::defineValueAliases(
-            'Core', 'Name', array(
-                'Aliased Value' => 'Real Value'
+        CS::defineAllowedValues( // okay, since default is null
+            'QuantumNumber', 'Difficulty', array('easy', 'medium', 'hard')
+        );
+        
+        $this->assertIdentical($this->our_copy->defaults['QuantumNumber']['Difficulty'], null);
+        $this->assertIdentical($this->our_copy->info['QuantumNumber']['Difficulty'], 
+            new HTMLPurifier_ConfigEntity_Directive(
+                'string',
+                array($this->file => array($l => $d)),
+                true,
+                array(
+                    'easy' => true,
+                    'medium' => true,
+                    'hard' => true
+                )
             )
         );
-        $directive->aliases['Aliased Value'] = 'Real Value';
-        $this->assertIdentical($this->our_copy->info, array(
-            'Core' => array(
-                'Name' => $directive
-            )
-        ));
         
+        $this->expectError('Cannot define allowed values for undefined directive');
+        CS::defineAllowedValues(
+            'SpaceTime', 'Symmetry', array('time', 'spatial', 'projective')
+        );
         
+        $this->expectError('Cannot define allowed values for directive whose type is not string');
+        CS::defineAllowedValues(
+            'QuantumNumber', 'Spin', array(0.5, -0.5)
+        );
         
-        // redefine should be cumulative
-        HTMLPurifier_ConfigSchema::defineValueAliases(
-            'Core', 'Name', array(
-                'Aliased Value 2' => 'Real Value 2'
+        $this->expectError('Default value must be in allowed range of variables');
+        CS::defineAllowedValues(
+            'QuantumNumber', 'Current', array('n', 'l', 'm') // forgot s!
+        );
+    }
+    
+    function test_defineValueAliases() {
+        CS::defineNamespace('Abbrev', 'Stuff on abbreviations.');
+        CS::define('Abbrev', 'HTH', 'Happy to Help', 'string', $d = 'Three-letters'); $l = __LINE__;
+        CS::defineAllowedValues(
+            'Abbrev', 'HTH', array(
+                'Happy to Help',
+                'Hope that Helps',
+                'HAIL THE HAND!'
             )
         );
-        $directive->aliases['Aliased Value 2'] = 'Real Value 2';
-        $this->assertIdentical($this->our_copy->info, array(
-            'Core' => array(
-                'Name' => $directive
-            )
-        ));
-        
-        
-        
-        // cannot create alias to not-allowed value
-        HTMLPurifier_ConfigSchema::defineValueAliases(
-            'Core', 'Name', array(
-                'Aliased Value 3' => 'Invalid Value'
+        CS::defineValueAliases(
+            'Abbrev', 'HTH', array(
+                'happy' => 'Happy to Help',
+                'hope' => 'Hope that Helps'
             )
         );
-        $this->assertError('Cannot define alias to value that is not allowed');
-        $this->assertNoErrors();
-        
-        
-        
-        // cannot create alias for already allowed value
-        HTMLPurifier_ConfigSchema::defineValueAliases(
-            'Core', 'Name', array(
-                'Real Value' => 'Real Value 2'
+        CS::defineValueAliases( // delayed addition
+            'Abbrev', 'HTH', array(
+                'hail' => 'HAIL THE HAND!'
             )
         );
-        $this->assertError('Cannot define alias over allowed value');
-        $this->assertNoErrors();
         
-        
-        
-        // define a directive with an invalid type
-        HTMLPurifier_ConfigSchema::define(
-            'Core', 'Foobar', false, 'omen',
-            'Omen is not a valid type, so we reject this.'
+        $this->assertIdentical($this->our_copy->defaults['Abbrev']['HTH'], 'Happy to Help');
+        $this->assertIdentical($this->our_copy->info['Abbrev']['HTH'], 
+            new HTMLPurifier_ConfigEntity_Directive(
+                'string',
+                array($this->file => array($l => $d)),
+                false,
+                array(
+                    'Happy to Help' => true,
+                    'Hope that Helps' => true,
+                    'HAIL THE HAND!' => true
+                ),
+                array(
+                    'happy' => 'Happy to Help',
+                    'hope' => 'Hope that Helps',
+                    'hail' => 'HAIL THE HAND!'
+                )
+            )
         );
         
-        $this->assertError('Invalid type for configuration directive');
-        $this->assertNoErrors();
-        
-        
-        
-        // define a directive with inconsistent type
-        HTMLPurifier_ConfigSchema::define(
-            'Core', 'Foobaz', 10, 'string',
-            'If we say string, we should mean it, not integer 10.'
+        $this->expectError('Cannot define alias to value that is not allowed');
+        CS::defineValueAliases(
+            'Abbrev', 'HTH', array(
+                'head' => 'Head to Head'
+            )
         );
         
-        $this->assertError('Default value does not match directive type');
-        $this->assertNoErrors();
-        
-        
-        
-        // define a directive that allows null
-        HTMLPurifier_ConfigSchema::define(
-            'Core', 'Foobaz', null, 'string/null',
-            'Nulls are allowed if you add on /null, cool huh?'
+        $this->expectError('Cannot define alias over allowed value');
+        CS::defineValueAliases(
+            'Abbrev', 'HTH', array(
+                'Hope that Helps' => 'Happy to Help'
+            )
         );
         
-        $this->assertNoErrors();
+    }
+   
+    function testAlias() {
+        CS::defineNamespace('Home', 'Sweet home.');
+        CS::define('Home', 'Rug', 3, 'int', 'ID.');
+        CS::defineAlias('Home', 'Carpet', 'Home', 'Rug');
         
-        
-        // define a directive with bad characters
-        HTMLPurifier_ConfigSchema::define(
-            'Core', 'Core.Attr', 10, 'int',
-            'No periods! >:-('
+        $this->assertTrue(!isset($this->our_copy->defaults['Home']['Carpet']));
+        $this->assertIdentical($this->our_copy->info['Home']['Carpet'], 
+            new HTMLPurifier_ConfigEntity_DirectiveAlias('Home', 'Rug')
         );
         
-        $this->assertError('Directive name must be alphanumeric');
-        $this->assertNoErrors();
+        $this->expectError('Cannot define directive alias in undefined namespace');
+        CS::defineAlias('Store', 'Rug', 'Home', 'Rug');
         
-        // define a namespace with bad characters
-        HTMLPurifier_ConfigSchema::defineNamespace(
-            'Foobar&Gromit', $description
-        );
+        $this->expectError('Directive name must be alphanumeric');
+        CS::defineAlias('Home', 'R.g', 'Home', 'Rug');
         
-        $this->assertError('Namespace name must be alphanumeric');
-        $this->assertNoErrors();
+        CS::define('Home', 'Rugger', 'Bob Max', 'string', 'Name of.');
+        $this->expectError('Cannot define alias over directive');
+        CS::defineAlias('Home', 'Rugger', 'Home', 'Rug');
         
+        $this->expectError('Cannot define alias to undefined directive');
+        CS::defineAlias('Home', 'Rug2', 'Home', 'Rugavan');
+        
+        $this->expectError('Cannot define alias to alias');
+        CS::defineAlias('Home', 'Rug2', 'Home', 'Carpet');
     }
     
     function assertValid($var, $type, $ret = null) {
@@ -270,25 +261,32 @@ class HTMLPurifier_ConfigSchemaTest extends UnitTestCase
         
         $this->assertValid('foobar', 'string');
         $this->assertValid('FOOBAR', 'istring', 'foobar');
+        
         $this->assertValid(34, 'int');
+        
         $this->assertValid(3.34, 'float');
+        
         $this->assertValid(false, 'bool');
         $this->assertValid(0, 'bool', false);
         $this->assertValid(1, 'bool', true);
-        $this->assertInvalid(34, 'bool');
-        $this->assertInvalid(null, 'bool');
-        $this->assertValid(array('1', '2', '3'), 'list');
-        $this->assertValid(array('1' => true, '2' => true), 'lookup');
-        $this->assertValid(array('1', '2'), 'lookup', array('1' => true, '2' => true));
-        $this->assertValid(array('foo' => 'bar'), 'hash');
-        $this->assertInvalid(array(0 => 'moo'), 'hash');
-        $this->assertValid(array(1 => 'moo'), 'hash');
-        $this->assertValid(23, 'mixed');
-        $this->assertValid('foo,bar, cow', 'list', array('foo', 'bar', 'cow'));
-        $this->assertValid('foo,bar', 'lookup', array('foo' => true, 'bar' => true));
         $this->assertValid('true', 'bool', true);
         $this->assertValid('false', 'bool', false);
         $this->assertValid('1', 'bool', true);
+        $this->assertInvalid(34, 'bool');
+        $this->assertInvalid(null, 'bool');
+        
+        $this->assertValid(array('1', '2', '3'), 'list');
+        $this->assertValid('foo,bar, cow', 'list', array('foo', 'bar', 'cow'));
+        
+        $this->assertValid(array('1' => true, '2' => true), 'lookup');
+        $this->assertValid(array('1', '2'), 'lookup', array('1' => true, '2' => true));
+        $this->assertValid('foo,bar', 'lookup', array('foo' => true, 'bar' => true));
+        
+        $this->assertValid(array('foo' => 'bar'), 'hash');
+        $this->assertValid(array(1 => 'moo'), 'hash');
+        $this->assertInvalid(array(0 => 'moo'), 'hash');
+        
+        $this->assertValid(23, 'mixed');
         
     }
     
@@ -318,12 +316,12 @@ class HTMLPurifier_ConfigSchemaTest extends UnitTestCase
     function testMungeFilename() {
         
         $this->assertMungeFilename(
-            'C:\\php\\libs\\htmlpurifier\\library\\HTMLPurifier\\AttrDef.php',
+            'C:\\php\\My Libraries\\htmlpurifier\\library\\HTMLPurifier\\AttrDef.php',
             'HTMLPurifier/AttrDef.php'
         );
         
         $this->assertMungeFilename(
-            'C:\\php\\libs\\htmlpurifier\\library\\HTMLPurifier.php',
+            'C:\\php\\My Libraries\\htmlpurifier\\library\\HTMLPurifier.php',
             'HTMLPurifier.php'
         );