Merge pull request #61 from treeform/dev

add RawJson

Author: treeform

README.md

@@ -298,3 +298,31 @@ type Entry = object
   }
 }""".fromJson(Entry)
 ```
+
+## Full support for raw-json.
+
+Sometimes you don't need to parse the json, but just send it or store it in the database. You can speed this up by using `RawJson` type. What it does is prevents full parsing of that json tree and instead returns it is a `RawJson` (`disticnt string`) type. You can then do anything you want with that. Store it in a database or pass it along to some other API. Or maybe parse it later again with jsony.
+
+```nim
+import jsony
+type
+  Message = object
+    id: uint64
+    data: RawJson
+
+let
+  messageData = """{"id":123,"data":{"page":"base64","arr":[1,2,3]}}"""
+  message = messageData.fromJson(Message)
+
+# make sure raw json was not parsed
+doAssert message.data.string == """{"page":"base64","arr":[1,2,3]}"""
+
+# make sure that dumping raw json produces same result
+doAssert message.toJson() == messageData
+```
+
+You can also wait to parse the json later or maybe even with different types:
+
+```
+message.data.string.fromJson(DataPayload)
+```

src/jsony.nim

@@ -1,4 +1,5 @@
-import jsony/objvar, strutils, tables, sets, unicode, json, options, parseutils, typetraits
+import jsony/objvar, std/json, std/options, std/parseutils, std/sets,
+    std/strutils, std/tables, std/typetraits, std/unicode
 
 type JsonError* = object of ValueError
 
@@ -10,6 +11,7 @@ when defined(release):
 type
   SomeTable*[K, V] = Table[K, V] | OrderedTable[K, V] |
     TableRef[K, V] | OrderedTableRef[K, V]
+  RawJson* = distinct string
 
 proc parseHook*[T](s: string, i: var int, v: var seq[T])
 proc parseHook*[T: enum](s: string, i: var int, v: var T)
@@ -73,10 +75,19 @@ proc parseHook*(s: string, i: var int, v: var bool) =
   else:
     # Its faster to do char by char scan:
     eatSpace(s, i)
-    if i + 3 < s.len and s[i+0] == 't' and s[i+1] == 'r' and s[i+2] == 'u' and s[i+3] == 'e':
+    if i + 3 < s.len and
+        s[i+0] == 't' and
+        s[i+1] == 'r' and
+        s[i+2] == 'u' and
+        s[i+3] == 'e':
       i += 4
       v = true
-    elif i + 4 < s.len and s[i+0] == 'f' and s[i+1] == 'a' and s[i+2] == 'l' and s[i+3] == 's' and s[i+4] == 'e':
+    elif i + 4 < s.len and
+        s[i+0] == 'f' and
+        s[i+1] == 'a' and
+        s[i+2] == 'l' and
+        s[i+3] == 's' and
+        s[i+4] == 'e':
       i += 5
       v = false
     else:
@@ -234,7 +245,11 @@ proc parseStringFast(s: string, i: var int, v: var string) =
 proc parseHook*(s: string, i: var int, v: var string) =
   ## Parse string.
   eatSpace(s, i)
-  if i + 3 < s.len and s[i+0] == 'n' and s[i+1] == 'u' and s[i+2] == 'l' and s[i+3] == 'l':
+  if i + 3 < s.len and
+      s[i+0] == 'n' and
+      s[i+1] == 'u' and
+      s[i+2] == 'l' and
+      s[i+3] == 'l':
     i += 4
     return
   eatChar(s, i, '"')
@@ -284,7 +299,11 @@ proc parseHook*[T: array](s: string, i: var int, v: var T) =
 
 proc parseHook*[T: not object](s: string, i: var int, v: var ref T) =
   eatSpace(s, i)
-  if i + 3 < s.len and s[i+0] == 'n' and s[i+1] == 'u' and s[i+2] == 'l' and s[i+3] == 'l':
+  if i + 3 < s.len and
+      s[i+0] == 'n' and
+      s[i+1] == 'u' and
+      s[i+2] == 'l' and
+      s[i+3] == 'l':
     i += 4
     return
   new(v)
@@ -406,7 +425,11 @@ proc parseHook*[T: enum](s: string, i: var int, v: var T) =
 proc parseHook*[T: object|ref object](s: string, i: var int, v: var T) =
   ## Parse an object or ref object.
   eatSpace(s, i)
-  if i + 3 < s.len and s[i+0] == 'n' and s[i+1] == 'u' and s[i+2] == 'l' and s[i+3] == 'l':
+  if i + 3 < s.len and
+      s[i+0] == 'n' and
+      s[i+1] == 'u' and
+      s[i+2] == 'l' and
+      s[i+3] == 'l':
     i += 4
     return
   eatChar(s, i, '{')
@@ -448,7 +471,11 @@ proc parseHook*[T: object|ref object](s: string, i: var int, v: var T) =
 proc parseHook*[T](s: string, i: var int, v: var Option[T]) =
   ## Parse an Option.
   eatSpace(s, i)
-  if i + 3 < s.len and s[i+0] == 'n' and s[i+1] == 'u' and s[i+2] == 'l' and s[i+3] == 'l':
+  if i + 3 < s.len and
+      s[i+0] == 'n' and
+      s[i+1] == 'u' and
+      s[i+2] == 'l' and
+      s[i+3] == 'l':
     i += 4
     return
   var e: T
@@ -575,7 +602,7 @@ proc dumpHook*(s: var string, v: string)
 proc dumpHook*(s: var string, v: char)
 proc dumpHook*(s: var string, v: tuple)
 proc dumpHook*(s: var string, v: enum)
-type t[T] = tuple[a:string, b:T]
+type t[T] = tuple[a: string, b: T]
 proc dumpHook*[N, T](s: var string, v: array[N, t[T]])
 proc dumpHook*[N, T](s: var string, v: array[N, T])
 proc dumpHook*[T](s: var string, v: seq[T])
@@ -842,6 +869,14 @@ proc dumpHook*(s: var string, v: JsonNode) =
     of JBool:
       s.dumpHook(v.getBool)
 
+proc parseHook*(s: string, i: var int, v: var RawJson) =
+  let oldI = i
+  skipValue(s, i)
+  v = s[oldI ..< i].RawJson
+
+proc dumpHook*(s: var string, v: RawJson) =
+  s.add v.string
+
 proc toJson*[T](v: T): string =
   dumpHook(result, v)
 
@@ -860,6 +895,5 @@ template toStaticJson*(v: untyped): static[string] =
 #   const s = v.toJsonDynamic()
 #   s
 
-
 when defined(release):
   {.pop.}

tests/all.nim

@@ -2,21 +2,7 @@
 # nim js -r .\tests\all.nim
 # nim cpp -r .\tests\all.nim
 
-import test_arrays
-import test_char
-import test_enums
-import test_errors
-import test_fast_numbers
-import test_json_in_json
-import test_numbers
-import test_objects
-import test_options
-import test_parseHook
-import test_sets
-import test_strings
-import test_tables
-import test_tojson
-import test_tuples
-import test_refs
-
+import test_arrays, test_char, test_enums, test_errors, test_fast_numbers,
+    test_json_in_json, test_numbers, test_objects, test_options, test_parseHook,
+    test_rawjson, test_refs, test_sets, test_strings, test_tables, test_tojson, test_tuples
 echo "all tests pass"

tests/bench.nim

@@ -1,6 +1,4 @@
-import benchy, random, streams, macros
-import jsony, jason
-import eminim
+import benchy, eminim, jason, jsony, macros, random, streams
 when defined(packedjson):
   import packedjson, packedjson/deserialiser
 else:

tests/bench_parts.nim

@@ -1,6 +1,4 @@
-import benchy, random, streams
-import jsony, jason
-import eminim
+import benchy, eminim, jason, jsony, random, streams
 when defined(packedjson):
   import packedjson, packedjson/deserialiser
 else:
@@ -9,7 +7,6 @@ when not defined(gcArc):
   import serialization
   import json_serialization except Json, toJson
 
-
 block:
   echo "deserialize string:"
   var jsonStr = "\"hello there how are you?\""

tests/bench_statics.nim

@@ -1,4 +1,4 @@
-import jsony, jason, benchy
+import benchy, jason, jsony
 
 const
   number11 = 11
@@ -57,4 +57,4 @@ timeIt "treeform/jsony object", 100:
 
 timeIt "disruptek/jason object", 100:
   for i in 0 .. 1000:
-    discard thing.jason.string
+    discard thing.jason.string

tests/fuzz.nim

@@ -1,5 +1,4 @@
-import os, strutils, random, strformat, tables, jsony
-
+import jsony, os, random, strformat, strutils, tables
 
 type
   NodeKind = enum

tests/fuzz_strings.nim

@@ -1,4 +1,4 @@
-import random, jsony, unicode
+import jsony, random, unicode
 
 randomize()
 

tests/run_extranl_suite.nim

@@ -1,4 +1,4 @@
-import osproc, os, strutils, sequtils
+import os, osproc, sequtils, strutils
 
 # https://github.com/nst/JSONTestSuite
 # A comprehensive test suite for RFC 8259 compliant JSON parsers

tests/run_test_jsony.nim

@@ -1,8 +1,6 @@
 # Rebuild with: nim c -d:release
 
-import json
-import os
-
+import json, os
 let fn = os.paramStr(1)
 
 try: