- Implement StringHash wrapper ArrayObject

- Implement namespace parsing for StringHashAdapter, as well as rudimentary error-checking

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

extras/ConfigSchema/StringHash.php

@@ -0,0 +1,33 @@
+<?php
+
+/**
+ * This is in almost every respect equivalent to an array except
+ * that it keeps track of which keys were accessed.
+ */
+class ConfigSchema_StringHash extends ArrayObject
+{
+    protected $accessed = array();
+    
+    /**
+     * Retrieves a value, and logs the access.
+     */
+    public function offsetGet($index) {
+        $this->accessed[$index] = true;
+        return parent::offsetGet($index);
+    }
+    
+    /**
+     * Returns a lookup array of all array indexes that have been accessed.
+     * @return Array in form array($index => true).
+     */
+    public function getAccessed() {
+        return $this->accessed;
+    }
+    
+    /**
+     * Resets the access array.
+     */
+    public function resetAccessed() {
+        $this->accessed = array();
+    }
+}

extras/ConfigSchema/StringHashAdapter.php

@@ -12,11 +12,32 @@ class ConfigSchema_StringHashAdapter
      * based on its values.
      */
     public function adapt($hash, $schema) {
+        
+        if (!isset($hash['ID'])) {
+            trigger_error('Missing key ID in string hash');
+            return;
+        }
+        
+        // Check namespace:
+        if (strpos($hash['ID'], '.') === false) {
+            // This will cause problems if we decide to support nested
+            // namespaces, but for now it's ok.
+            $schema->addNamespace($hash['ID'], $hash['DESCRIPTION']);
+            return;
+        }
+        
         list($ns, $directive) = explode('.', $hash['ID'], 2);
-        $default      = eval("return {$hash['DEFAULT']};");
-        $type         = $hash['TYPE'];
-        $description  = $hash['DESCRIPTION'];
-        $schema->add($ns, $directive, $default, $type, $description);
+        
+        if (isset($hash['DEFAULT'], $hash['DESCRIPTION'], $hash['TYPE'])) {
+            $raw_default  = $hash['DEFAULT'];
+            $default      = eval("return $raw_default;");
+            $description  = $hash['DESCRIPTION'];
+            $type         = $hash['TYPE'];
+            $schema->add($ns, $directive, $default, $type, $description);
+        }
+        
+        
+        
     }
     
 }

tests/ConfigSchema/StringHashAdapterTest.php

@@ -7,7 +7,7 @@ class ConfigSchema_StringHashAdapterTest extends UnitTestCase
         parent::UnitTestCase();
     }
     
-    function assertAdapt($input, $calls) {
+    function assertAdapt($input, $calls = array()) {
         $schema = new HTMLPurifier_ConfigSchemaMock();
         foreach ($calls as $func => $params) {
             $schema->expectOnce($func, $params);
@@ -32,4 +32,24 @@ class ConfigSchema_StringHashAdapterTest extends UnitTestCase
             )
         );
     }
+    
+    function testNamespace() {
+        $this->assertAdapt(
+            array(
+                'ID' => 'Namespace',
+                'DESCRIPTION' => 'Description of namespace'
+            ),
+            array(
+                'addNamespace' => array('Namespace', 'Description of namespace'),
+            )
+        );
+    }
+    
+    function testMissingId() {
+        $this->expectError('Missing key ID in string hash');
+        $this->assertAdapt(array());
+    }
+    
+    
+    
 }

tests/ConfigSchema/StringHashTest.php

@@ -0,0 +1,18 @@
+<?php
+
+class ConfigSchema_StringHashTest extends UnitTestCase
+{
+    
+    public function testUsed() {
+        $hash = new ConfigSchema_StringHash(array(
+            'key' => 'value',
+            'key2' => 'value2'
+        ));
+        $this->assertIdentical($hash->getAccessed(), array());
+        $t = $hash['key'];
+        $this->assertIdentical($hash->getAccessed(), array('key' => true));
+        $hash->resetAccessed();
+        $this->assertIdentical($hash->getAccessed(), array());
+    }
+    
+}

tests/test_files.php

@@ -138,3 +138,4 @@ $test_files[] = 'FSTools/FileTest.php';
 
 $test_files[] = 'ConfigSchema/StringHashAdapterTest.php';
 $test_files[] = 'ConfigSchema/StringHashParserTest.php';
+$test_files[] = 'ConfigSchema/StringHashTest.php';