Merge pull request #57 from pietroppeter/add-skip-hook-skip-fields

fix #50: add skipHook to skip fields of object when serializing

Author: treeform

README.md

@@ -250,6 +250,33 @@ Gives us:
 "10/13"
 ```
 
+### `proc skipHook*()` Can be used to skip fields when serializing an object
+
+If you want to skip some fields when serializing an object you can declare a `skipHook*()`
+
+```nim
+type
+  Conn = object
+    id: int
+  Foo = object
+    a: int
+    password: string
+    b: float
+    conn: Conn
+
+proc skipHook*(T: typedesc[Foo], key: static string): bool =
+  key in ["password", "conn"]
+
+var v = Foo(a:1, password: "12345", b:0.5, conn: Conn(id: 1))
+let s = v.toJson()
+```
+
+Gives us:
+
+```
+"{"a":1,"b":0.5}"
+```
+
 ## Static writing with `toStaticJson`.
 
 Sometimes you have some json, and you want to write it in a static way. There is a special function for that:

src/jsony.nim

@@ -796,11 +796,21 @@ proc dumpHook*(s: var string, v: object) =
   else:
     # Normal objects.
     for k, e in v.fieldPairs:
-      if i > 0:
-        s.add ','
-      s.dumpKey(k)
-      s.dumpHook(e)
-      inc i
+      when compiles(skipHook(type(v), k)):
+        when skipHook(type(v), k):
+          discard
+        else:
+          if i > 0:
+            s.add ','
+          s.dumpKey(k)
+          s.dumpHook(e)
+          inc i
+      else:
+        if i > 0:
+          s.add ','
+        s.dumpKey(k)
+        s.dumpHook(e)
+        inc i
   s.add '}'
 
 proc dumpHook*[N, T](s: var string, v: array[N, t[T]]) =

tests/all.nim

@@ -4,5 +4,5 @@
 
 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"
+    test_rawjson, test_refs, test_sets, test_skipHook, test_strings, test_tables, test_tojson, test_tuples
+echo "all tests pass"

tests/test_skipHook.nim

@@ -0,0 +1,17 @@
+import jsony
+
+type
+  Conn = object
+    id: int
+  Foo = object
+    a: int
+    password: string
+    b: float
+    conn: Conn
+
+proc skipHook(T: typedesc[Foo], key: static string): bool =
+  key in ["password", "conn"]
+
+let v = Foo(a:1, password: "12345", b:0.6, conn: Conn(id: 1))
+doAssert v.toJson() ==
+  """{"a":1,"b":0.6}"""