[3.1.0] Add StringHashParser.

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

extras/ConfigSchema/DirectiveParser.php

@@ -1,10 +0,0 @@
-<?php
-
-/**
- * Parses directive files, building up object representation of 
- * configuration directives for runtime use or for documentation.
- */
-class ConfigSchema_DirectiveParser
-{
-    
-}

extras/ConfigSchema/StringHashParser.php

@@ -0,0 +1,67 @@
+<?php
+
+/**
+ * Parses string hash files. File format is as such:
+ * 
+ *      DefaultKeyValue
+ *      KEY: Value
+ *      KEY2: Value2
+ *      --MULTILINE-KEY--
+ *      Multiline
+ *      value.
+ *
+ * Which would output something similar to:
+ *
+ *      array(
+ *          'ID' => 'DefaultKeyValue',
+ *          'KEY' => 'Value',
+ *          'KEY2' => 'Value2',
+ *          'MULTILINE-KEY' => "Multiline\nvalue.\n",
+ *      )
+ *
+ * We use this as an easy to use file-format for configuration schema
+ * files.
+ */
+class ConfigSchema_StringHashParser
+{
+    
+    public $default = 'ID';
+    
+    public function parseFile($file) {
+        if (is_string($file)) $file = new FSTools_File($file);
+        if (!$file->exists()) throw new Exception('File does not exist');
+        $file->open('r');
+        $state   = false;
+        $single  = false;
+        $ret     = array();
+        while (($line = $file->getLine()) !== false) {
+            $line = rtrim($line, "\n\r");
+            if (!$state && $line === '') continue;
+            if (strncmp('--', $line, 2) === 0) {
+                // Multiline declaration
+                $state = trim($line, '- ');
+                continue;
+            } elseif (!$state) {
+                $single = true;
+                if (strpos($line, ':') !== false) {
+                    // Single-line declaration
+                    list($state, $line) = explode(': ', $line, 2);
+                } else {
+                    // Use default declaration
+                    $state  = $this->default;
+                }
+            }
+            if ($single) {
+                $ret[$state] = $line;
+                $single = false;
+                $state  = false;
+            } else {
+                if (!isset($ret[$state])) $ret[$state] = '';
+                $ret[$state] .= "$line\n";
+            }
+        }
+        $file->close();
+        return $ret;
+    }
+    
+}

tests/ConfigSchema/DirectiveParserTest.php

@@ -1,7 +0,0 @@
-<?php
-
-class ConfigSchema_DirectiveParserTest extends UnitTestCase
-{
-    
-    
-}

tests/ConfigSchema/StringHashParser/AppendMultiline.txt

@@ -0,0 +1,4 @@
+--KEY--
+Line1
+--KEY--
+Line2

tests/ConfigSchema/StringHashParser/Default.txt

@@ -0,0 +1 @@
+DefaultValue

tests/ConfigSchema/StringHashParser/OverrideSingle.txt

@@ -0,0 +1,2 @@
+KEY: Original
+KEY: New

tests/ConfigSchema/StringHashParser/Simple.txt

@@ -0,0 +1,5 @@
+Namespace.Directive
+TYPE: string
+--DESCRIPTION--
+Multiline
+stuff

tests/ConfigSchema/StringHashParserTest.php

@@ -0,0 +1,53 @@
+<?php
+
+/**
+ * @note Sample input files are located in the StringHashParser/ directory.
+ */
+class ConfigSchema_StringHashParserTest extends UnitTestCase
+{
+    
+    /**
+     * Instance of ConfigSchema_StringHashParser being tested.
+     */
+    protected $parser;
+    
+    function setup() {
+        $this->parser = new ConfigSchema_StringHashParser();
+    }
+    
+    /**
+     * Assert that $file gets parsed into the form of $expect
+     */
+    function assertParse($file, $expect) {
+        $result = $this->parser->parseFile(dirname(__FILE__) . '/StringHashParser/' . $file);
+        $this->assertIdentical($result, $expect);
+    }
+    
+    function testSimple() {
+        $this->assertParse('Simple.txt', array(
+            'ID' => 'Namespace.Directive',
+            'TYPE' => 'string',
+            'DESCRIPTION' => "Multiline\nstuff\n"
+        ));
+    }
+    
+    function testOverrideSingle() {
+        $this->assertParse('OverrideSingle.txt', array(
+            'KEY' => 'New',
+        ));
+    }
+    
+    function testAppendMultiline() {
+        $this->assertParse('AppendMultiline.txt', array(
+            'KEY' => "Line1\nLine2\n",
+        ));
+    }
+    
+    function testDefault() {
+        $this->parser->default = 'NEW-ID';
+        $this->assertParse('Default.txt', array(
+            'NEW-ID' => 'DefaultValue',
+        ));
+    }
+    
+}

tests/test_files.php

@@ -136,4 +136,4 @@ $test_files[] = 'FSTools/FileTest.php';
 
 // ConfigSchema auxiliary library
 
-$test_files[] = 'ConfigSchema/DirectiveParserTest.php';
+$test_files[] = 'ConfigSchema/StringHashParserTest.php';