feat(dataformat): add key-value format

Author: nutgaard

.github/workflows/master.yaml

@@ -14,6 +14,9 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v1
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 18
       - uses: actions/cache@v1
         with:
           path: ~/.npm

src/dataformat/csv.ts

@@ -29,7 +29,6 @@ function readCSVLine(chars: string[], startAt: number, delimiter: string = ','):
             }
         } else if (ch === '\\') {
             buffer.push(chars[++i]);
-            continue;
         } else if (ch === delimiter && currentQuote === undefined) {
             values.push(buffer.join(''));
             buffer = [];

src/dataformat/kv.ts

@@ -0,0 +1,58 @@
+import { DataFormat } from './domain';
+
+function writeAsKVSync(object: unknown, delimiter: string = ' '): string {
+    if (typeof object === 'string') return object;
+    return Object.entries(object)
+        .map(([key, value]) => `${key}='${value.replace(/'/g, "\\'")}'`)
+        .join(delimiter);
+}
+function parseKVSync<T>(content: string, delimiter: string = ' '): T {
+    const chars = content.split('');
+    const accumulator: { [key: string]: string } = {};
+    let keybuffer: string[] = [];
+    let valuebuffer: string[] = [];
+    let buffer = keybuffer;
+    let currentQuote: string | undefined = undefined;
+
+    for (let i = 0; i < chars.length; i++) {
+        const ch = chars[i];
+        if (ch === '"' || ch === "'") {
+            if (currentQuote === undefined) {
+                currentQuote = ch;
+            } else if (ch === currentQuote) {
+                currentQuote = undefined;
+            } else {
+                buffer.push(ch);
+            }
+        } else if (ch === '\\') {
+            buffer.push(chars[++i]);
+        } else if (ch === '=' && currentQuote === undefined) {
+            buffer = valuebuffer;
+        } else if ((ch === delimiter && currentQuote === undefined) || (ch === '\n' && currentQuote === undefined)) {
+            if (keybuffer.length > 0) {
+                accumulator[keybuffer.join('')] = valuebuffer.join('');
+            }
+            keybuffer = [];
+            valuebuffer = [];
+            buffer = keybuffer;
+        } else {
+            buffer.push(ch);
+        }
+    }
+    if (buffer.length > 0) {
+        if (keybuffer.length > 0) {
+            accumulator[keybuffer.join('')] = valuebuffer.join('');
+        }
+    }
+
+    return accumulator as unknown as T;
+}
+
+export const KvFormat: DataFormat<unknown> = {
+    serialize(object: Array<string[]>, delimiter: string = ' '): string {
+        return writeAsKVSync(object, delimiter);
+    },
+    deserialize(content: string, delimiter: string = ' '): Array<string[]> {
+        return parseKVSync(content, delimiter);
+    }
+};

test/dataformat/kv.test.ts

@@ -0,0 +1,29 @@
+import { test, assertThat } from '../test-lib';
+import { KvFormat } from '../../src/dataformat/kv';
+
+const content = `
+action='CREATE' subject='A123456' resource='resource.name' RESOURCE_ID='1234' META='NAME'
+action=DELETE subject=A123456 resource=resource.name RESOURCE_ID=6547 META="NAME ADR, OK"
+action='READ' subject='A123456' resource='resource.name' RESOURCE_ID='7895' META='NESTEST=value'
+`
+    .trim()
+    .split('\n');
+
+test('should be able to parse keyvalue string', () => {
+    const result = content.map((it) => KvFormat.deserialize(it));
+    assertThat(
+        { action: 'CREATE', subject: 'A123456', resource: 'resource.name', RESOURCE_ID: '1234', META: 'NAME' },
+        result[0],
+        'audit log should match'
+    );
+    assertThat(
+        { action: 'DELETE', subject: 'A123456', resource: 'resource.name', RESOURCE_ID: '6547', META: 'NAME ADR, OK' },
+        result[1],
+        'kvlog without quotes should word'
+    );
+    assertThat(
+        { action: 'READ', subject: 'A123456', resource: 'resource.name', RESOURCE_ID: '7895', META: 'NESTEST=value' },
+        result[2],
+        'nested kv-values should work'
+    );
+});

test/index.ts

@@ -1,2 +1,3 @@
 import './dataformat/csv.test';
 import './dataformat/json.test';
+import './dataformat/kv.test';