context_spook 1.6.0 → 1.7.0

data/spec/fixtures/encode/delimiters.json

@@ -0,0 +1,214 @@
+{
+  "version": "4.0",
+  "category": "encode",
+  "description": "Delimiter options – tab and pipe delimiters, delimiter-aware quoting",
+  "tests": [
+    {
+      "name": "encodes primitive arrays with tab delimiter",
+      "input": {
+        "tags": ["reading", "gaming", "coding"]
+      },
+      "expected": "tags[3\t]: reading\tgaming\tcoding",
+      "options": {
+        "delimiter": "\t"
+      },
+      "specSection": "11"
+    },
+    {
+      "name": "encodes primitive arrays with pipe delimiter",
+      "input": {
+        "tags": ["reading", "gaming", "coding"]
+      },
+      "expected": "tags[3|]: reading|gaming|coding",
+      "options": {
+        "delimiter": "|"
+      },
+      "specSection": "11"
+    },
+    {
+      "name": "encodes primitive arrays with comma delimiter",
+      "input": {
+        "tags": ["reading", "gaming", "coding"]
+      },
+      "expected": "tags[3]: reading,gaming,coding",
+      "options": {
+        "delimiter": ","
+      },
+      "specSection": "11"
+    },
+    {
+      "name": "encodes tabular arrays with tab delimiter",
+      "input": {
+        "items": [
+          { "sku": "A1", "qty": 2, "price": 9.99 },
+          { "sku": "B2", "qty": 1, "price": 14.5 }
+        ]
+      },
+      "expected": "items[2\t]{sku\tqty\tprice}:\n  A1\t2\t9.99\n  B2\t1\t14.5",
+      "options": {
+        "delimiter": "\t"
+      },
+      "specSection": "11"
+    },
+    {
+      "name": "encodes tabular arrays with pipe delimiter",
+      "input": {
+        "items": [
+          { "sku": "A1", "qty": 2, "price": 9.99 },
+          { "sku": "B2", "qty": 1, "price": 14.5 }
+        ]
+      },
+      "expected": "items[2|]{sku|qty|price}:\n  A1|2|9.99\n  B2|1|14.5",
+      "options": {
+        "delimiter": "|"
+      },
+      "specSection": "11"
+    },
+    {
+      "name": "encodes nested arrays with tab delimiter",
+      "input": {
+        "pairs": [["a", "b"], ["c", "d"]]
+      },
+      "expected": "pairs[2\t]:\n  - [2\t]: a\tb\n  - [2\t]: c\td",
+      "options": {
+        "delimiter": "\t"
+      },
+      "specSection": "11"
+    },
+    {
+      "name": "encodes nested arrays with pipe delimiter",
+      "input": {
+        "pairs": [["a", "b"], ["c", "d"]],
+        "items": [{ "k": [[1, { "x": 1 }]] }]
+      },
+      "expected": "pairs[2|]:\n  - [2|]: a|b\n  - [2|]: c|d\nitems[1|]:\n  - k[1|]:\n      - [2|]:\n        - 1\n        - x: 1",
+      "options": {
+        "delimiter": "|"
+      },
+      "specSection": "11"
+    },
+    {
+      "name": "encodes root-level array with tab delimiter",
+      "input": ["x", "y", "z"],
+      "expected": "[3\t]: x\ty\tz",
+      "options": {
+        "delimiter": "\t"
+      },
+      "specSection": "11"
+    },
+    {
+      "name": "encodes root-level array with pipe delimiter",
+      "input": ["x", "y", "z"],
+      "expected": "[3|]: x|y|z",
+      "options": {
+        "delimiter": "|"
+      },
+      "specSection": "11"
+    },
+    {
+      "name": "encodes root-level array of objects with tab delimiter",
+      "input": [{ "id": 1 }, { "id": 2 }],
+      "expected": "[2\t]{id}:\n  1\n  2",
+      "options": {
+        "delimiter": "\t"
+      },
+      "specSection": "11"
+    },
+    {
+      "name": "encodes root-level array of objects with pipe delimiter",
+      "input": [{ "id": 1 }, { "id": 2 }],
+      "expected": "[2|]{id}:\n  1\n  2",
+      "options": {
+        "delimiter": "|"
+      },
+      "specSection": "11"
+    },
+    {
+      "name": "quotes strings containing pipe delimiter",
+      "input": {
+        "items": ["a", "b|c", "d"]
+      },
+      "expected": "items[3|]: a|\"b|c\"|d",
+      "options": {
+        "delimiter": "|"
+      },
+      "specSection": "11"
+    },
+    {
+      "name": "does not quote commas with tab delimiter",
+      "input": {
+        "items": ["a,b", "c,d"]
+      },
+      "expected": "items[2\t]: a,b\tc,d",
+      "options": {
+        "delimiter": "\t"
+      },
+      "specSection": "11"
+    },
+    {
+      "name": "does not quote commas in tabular values with tab delimiter",
+      "input": {
+        "items": [
+          { "id": 1, "note": "a,b" },
+          { "id": 2, "note": "c,d" }
+        ]
+      },
+      "expected": "items[2\t]{id\tnote}:\n  1\ta,b\n  2\tc,d",
+      "options": {
+        "delimiter": "\t"
+      },
+      "specSection": "11"
+    },
+    {
+      "name": "does not quote commas in object values with pipe delimiter",
+      "input": {
+        "note": "a,b"
+      },
+      "expected": "note: a,b",
+      "options": {
+        "delimiter": "|"
+      },
+      "specSection": "11"
+    },
+    {
+      "name": "quotes nested array values containing pipe delimiter",
+      "input": {
+        "pairs": [["a", "b|c"]]
+      },
+      "expected": "pairs[1|]:\n  - [2|]: a|\"b|c\"",
+      "options": {
+        "delimiter": "|"
+      },
+      "specSection": "11"
+    },
+    {
+      "name": "quotes a primitive list item containing the document delimiter",
+      "input": {
+        "a": [
+          "x|y",
+          "p,q",
+          {
+            "b": 1
+          }
+        ]
+      },
+      "expected": "a[3|]:\n  - \"x|y\"\n  - p,q\n  - b: 1",
+      "options": {
+        "delimiter": "|"
+      },
+      "specSection": "11.1",
+      "minSpecVersion": "4.2"
+    },
+    {
+      "name": "keeps a root string containing only a non-document delimiter unquoted",
+      "input": "a,b",
+      "expected": "a,b",
+      "options": {
+        "delimiter": "|"
+      },
+      "specSection": "11.1",
+      "note": "A root primitive is quoted against the document delimiter (§11.1)",
+      "minSpecVersion": "4.2"
+    }
+  ]
+}

data/spec/fixtures/encode/objects-keyed.json

@@ -0,0 +1,160 @@
+{
+  "version": "4.0",
+  "category": "encode",
+  "description": "Keyed tabular encoding – objects whose values are uniform objects collapse into keyed headers with entry rows",
+  "tests": [
+    {
+      "name": "encodes objects of uniform objects in keyed tabular form",
+      "input": {
+        "servers": {
+          "alpha": { "host": "a.example.com", "port": 8080 },
+          "beta": { "host": "b.example.com", "port": 9090 }
+        }
+      },
+      "expected": "servers[2:]{host,port}:\n  alpha: a.example.com,8080\n  beta: b.example.com,9090",
+      "specSection": "9.5"
+    },
+    {
+      "name": "encodes an eligible root object with a keyless keyed header",
+      "input": {
+        "alice": { "age": 30, "city": "Berlin" },
+        "bob": { "age": 25, "city": "Oslo" }
+      },
+      "expected": "[2:]{age,city}:\n  alice: 30,Berlin\n  bob: 25,Oslo",
+      "specSection": "9.5",
+      "note": "The keyless keyed header is valid only at the root (§5)"
+    },
+    {
+      "name": "collapses uniform nested object columns inside keyed headers",
+      "input": {
+        "regions": {
+          "eu": { "name": "Europe", "geo": { "lat": 50, "lon": 10 } },
+          "us": { "name": "America", "geo": { "lat": 40, "lon": -100 } }
+        }
+      },
+      "expected": "regions[2:]{name,geo{lat,lon}}:\n  eu: Europe,50,10\n  us: America,40,-100",
+      "specSection": "9.5"
+    },
+    {
+      "name": "orders fields by the first entry value's encounter order",
+      "input": {
+        "m": {
+          "a": { "x": 1, "y": 2 },
+          "b": { "y": 4, "x": 3 }
+        }
+      },
+      "expected": "m[2:]{x,y}:\n  a: 1,2\n  b: 3,4",
+      "specSection": "9.5"
+    },
+    {
+      "name": "uses the active delimiter in keyed headers and entry-row cells",
+      "input": {
+        "servers": {
+          "alpha": { "host": "a.example.com", "port": 8080, "note": "x|y" },
+          "beta": { "host": "b.example.com", "port": 9090, "note": "p,q" }
+        }
+      },
+      "options": { "delimiter": "|" },
+      "expected": "servers[2:|]{host|port|note}:\n  alpha: a.example.com|8080|\"x|y\"\n  beta: b.example.com|9090|p,q",
+      "specSection": "9.5",
+      "minSpecVersion": "4.2",
+      "note": "The keyed marker precedes the delimiter symbol: [2:|]"
+    },
+    {
+      "name": "quotes entry keys per key encoding",
+      "input": {
+        "ids": { "42": { "v": 1 }, "my key": { "v": 2 } }
+      },
+      "expected": "ids[2:]{v}:\n  \"42\": 1\n  \"my key\": 2",
+      "specSection": "9.5"
+    },
+    {
+      "name": "quotes entry-row cells containing the active delimiter",
+      "input": {
+        "notes": {
+          "n1": { "text": "a,b" },
+          "n2": { "text": "c" }
+        }
+      },
+      "expected": "notes[2:]{text}:\n  n1: \"a,b\"\n  n2: c",
+      "specSection": "9.5"
+    },
+    {
+      "name": "keeps single-entry objects in nested form",
+      "input": {
+        "config": {
+          "only": { "a": 1, "b": 2 }
+        }
+      },
+      "expected": "config:\n  only:\n    a: 1\n    b: 2",
+      "specSection": "9.5",
+      "note": "Keyed tabular detection requires at least two entries"
+    },
+    {
+      "name": "keeps objects in nested form when entry values have differing key sets",
+      "input": {
+        "envs": {
+          "dev": { "host": "x" },
+          "prod": { "host": "y", "port": 1 }
+        }
+      },
+      "expected": "envs:\n  dev:\n    host: x\n  prod:\n    host: y\n    port: 1",
+      "specSection": "9.5"
+    },
+    {
+      "name": "keeps objects in nested form when a value is primitive",
+      "input": {
+        "m": {
+          "a": { "x": 1 },
+          "b": 2
+        }
+      },
+      "expected": "m:\n  a:\n    x: 1\n  b: 2",
+      "specSection": "9.5"
+    },
+    {
+      "name": "keeps objects in nested form when an entry value contains an array",
+      "input": {
+        "m": {
+          "a": { "tags": ["x"] },
+          "b": { "tags": ["y"] }
+        }
+      },
+      "expected": "m:\n  a:\n    tags[1]: x\n  b:\n    tags[1]: y",
+      "specSection": "9.5",
+      "note": "Entry-row cells must be primitive leaves; an array value disqualifies the column"
+    },
+    {
+      "name": "emits a keyed header on the hyphen line when it is the first field of a list item",
+      "input": {
+        "items": [
+          { "config": { "a": { "x": 1 }, "b": { "x": 2 } }, "status": "ok" },
+          { "status": "down" }
+        ]
+      },
+      "expected": "items[2]:\n  - config[2:]{x}:\n      a: 1\n      b: 2\n    status: ok\n  - status: down",
+      "specSection": "10",
+      "note": "Entry rows at depth +2, sibling fields at depth +1, mirroring tabular arrays on hyphen lines"
+    },
+    {
+      "name": "never encodes an anonymous array element in keyed tabular form",
+      "input": {
+        "items": [
+          { "a": { "x": 1 }, "b": { "x": 2 } },
+          5
+        ]
+      },
+      "expected": "items[2]:\n  - a:\n      x: 1\n    b:\n      x: 2\n  - 5",
+      "specSection": "9.5",
+      "note": "The element object is keyed-eligible but has no key; the keyless form is root-only, so it encodes per §10"
+    },
+    {
+      "name": "keeps an object of empty objects out of keyed tabular form",
+      "input": {
+        "m": { "a": {}, "b": {} }
+      },
+      "expected": "m:\n  a:\n  b:",
+      "specSection": "9.5"
+    }
+  ]
+}

data/spec/fixtures/encode/objects.json

@@ -0,0 +1,288 @@
+{
+  "version": "4.0",
+  "category": "encode",
+  "description": "Object encoding – simple objects, nested objects, key encoding",
+  "tests": [
+    {
+      "name": "preserves key order in objects with primitive values",
+      "input": {
+        "id": 123,
+        "name": "Ada",
+        "active": true,
+        "value": null
+      },
+      "expected": "id: 123\nname: Ada\nactive: true\nvalue: null",
+      "specSection": "8"
+    },
+    {
+      "name": "encodes an empty root object as an empty document",
+      "input": {},
+      "expected": "",
+      "specSection": "8"
+    },
+    {
+      "name": "quotes string value with colon",
+      "input": {
+        "note": "a:b"
+      },
+      "expected": "note: \"a:b\"",
+      "specSection": "7.2"
+    },
+    {
+      "name": "quotes string value with comma",
+      "input": {
+        "note": "a,b"
+      },
+      "expected": "note: \"a,b\"",
+      "specSection": "7.2"
+    },
+    {
+      "name": "quotes string value with newline",
+      "input": {
+        "text": "line1\nline2"
+      },
+      "expected": "text: \"line1\\nline2\"",
+      "specSection": "7.2"
+    },
+    {
+      "name": "quotes string value with embedded quotes",
+      "input": {
+        "text": "say \"hello\""
+      },
+      "expected": "text: \"say \\\"hello\\\"\"",
+      "specSection": "7.2"
+    },
+    {
+      "name": "quotes string values with a leading or trailing space",
+      "input": {
+        "lead": " padded",
+        "trail": "padded "
+      },
+      "expected": "lead: \" padded\"\ntrail: \"padded \"",
+      "specSection": "7.2"
+    },
+    {
+      "name": "quotes string value with only spaces",
+      "input": {
+        "text": "  "
+      },
+      "expected": "text: \"  \"",
+      "specSection": "7.2"
+    },
+    {
+      "name": "quotes string value that looks like true",
+      "input": {
+        "v": "true"
+      },
+      "expected": "v: \"true\"",
+      "specSection": "7.2"
+    },
+    {
+      "name": "quotes string value that looks like number",
+      "input": {
+        "v": "42"
+      },
+      "expected": "v: \"42\"",
+      "specSection": "7.2"
+    },
+    {
+      "name": "quotes string value that looks like a number with an uppercase exponent",
+      "input": {
+        "v": "1E6"
+      },
+      "expected": "v: \"1E6\"",
+      "specSection": "7.2"
+    },
+    {
+      "name": "quotes key with colon",
+      "input": {
+        "order:id": 7
+      },
+      "expected": "\"order:id\": 7",
+      "specSection": "7.3"
+    },
+    {
+      "name": "quotes keys with brackets or braces",
+      "input": {
+        "[index]": 5,
+        "{key}": 6
+      },
+      "expected": "\"[index]\": 5\n\"{key}\": 6",
+      "specSection": "7.3"
+    },
+    {
+      "name": "quotes key with comma",
+      "input": {
+        "a,b": 1
+      },
+      "expected": "\"a,b\": 1",
+      "specSection": "7.3"
+    },
+    {
+      "name": "quotes keys with spaces",
+      "input": {
+        "full name": "Ada",
+        " a ": 1
+      },
+      "expected": "\"full name\": Ada\n\" a \": 1",
+      "specSection": "7.3"
+    },
+    {
+      "name": "quotes keys with a leading or interior hyphen",
+      "input": {
+        "-lead": 1,
+        "a-b": 2
+      },
+      "expected": "\"-lead\": 1\n\"a-b\": 2",
+      "specSection": "7.3"
+    },
+    {
+      "name": "quotes numeric key",
+      "input": {
+        "123": "x"
+      },
+      "expected": "\"123\": x",
+      "specSection": "7.3"
+    },
+    {
+      "name": "quotes empty string key",
+      "input": {
+        "": 1
+      },
+      "expected": "\"\": 1",
+      "specSection": "7.3"
+    },
+    {
+      "name": "quotes non-ASCII key",
+      "input": {
+        "café": 1
+      },
+      "expected": "\"café\": 1",
+      "specSection": "7.3",
+      "note": "The unquoted-key pattern is ASCII-only, so every non-ASCII key is quoted"
+    },
+    {
+      "name": "keeps dotted and literal-named keys unquoted",
+      "input": {
+        "a.b": 1,
+        "true": 2
+      },
+      "expected": "a.b: 1\ntrue: 2",
+      "specSection": "7.3",
+      "minSpecVersion": "4.2"
+    },
+    {
+      "name": "escapes newline and quotes in keys",
+      "input": {
+        "line\n": 1,
+        "he said \"hi\"": 2
+      },
+      "expected": "\"line\\n\": 1\n\"he said \\\"hi\\\"\": 2",
+      "specSection": "7.1"
+    },
+    {
+      "name": "escapes tab in key",
+      "input": {
+        "tab\there": 2
+      },
+      "expected": "\"tab\\there\": 2",
+      "specSection": "7.1"
+    },
+    {
+      "name": "escapes U+0004 control character in key via \\uXXXX",
+      "input": {
+        "a\u0004b": 1
+      },
+      "expected": "\"a\\u0004b\": 1",
+      "specSection": "7.1"
+    },
+    {
+      "name": "escapes U+001F control character in key via \\uXXXX",
+      "input": {
+        "x\u001fy": 2
+      },
+      "expected": "\"x\\u001fy\": 2",
+      "specSection": "7.1"
+    },
+    {
+      "name": "encodes deeply nested objects",
+      "input": {
+        "a": {
+          "b": {
+            "c": "deep"
+          }
+        }
+      },
+      "expected": "a:\n  b:\n    c: deep",
+      "specSection": "8"
+    },
+    {
+      "name": "encodes empty nested object",
+      "input": {
+        "user": {}
+      },
+      "expected": "user:",
+      "specSection": "8"
+    },
+    {
+      "name": "encodes __proto__ own property as an ordinary key",
+      "input": {
+        "__proto__": "polluted",
+        "safe": true
+      },
+      "expected": "__proto__: polluted\nsafe: true",
+      "specSection": "15",
+      "note": "No key has special meaning, so the encoder emits prototype-named own entries like any other (§8)"
+    },
+    {
+      "name": "encodes __proto__ as a tabular field name",
+      "input": {
+        "rows": [
+          {
+            "__proto__": "a",
+            "x": 1
+          },
+          {
+            "__proto__": "b",
+            "x": 2
+          }
+        ]
+      },
+      "expected": "rows[2]{__proto__,x}:\n  a,1\n  b,2",
+      "specSection": "15"
+    },
+    {
+      "name": "quotes hash-leading string in object field value",
+      "input": {
+        "note": "#x"
+      },
+      "expected": "note: \"#x\"",
+      "specSection": "7.2"
+    },
+    {
+      "name": "encodes empty string key opening a nested object",
+      "input": {
+        "": {
+          "a": 1
+        }
+      },
+      "expected": "\"\":\n  a: 1",
+      "specSection": "8"
+    },
+    {
+      "name": "keeps strings that only resemble numbers or literals, a leading byte-order mark, or DEL unquoted",
+      "input": {
+        "a": ".5",
+        "b": "NaN",
+        "c": "True",
+        "d": "\ufeffx",
+        "e": "a\u007fb",
+        "f": "\u0664\u0662"
+      },
+      "expected": "a: .5\nb: NaN\nc: True\nd: \ufeffx\ne: a\u007fb\nf: \u0664\u0662",
+      "specSection": "7.2",
+      "note": "Only a root primitive starting with U+FEFF is quoted, and only U+0000–U+001F count as controls (§7.1, §7.2)",
+      "minSpecVersion": "4.2"
+    }
+  ]
+}