jsondata 0.3.0

JSON processing package for document databses
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
@title[JSON]

@snap[midpoint slide1]
<h1>JSON</h1>
<br/>
<b style="color: crimson;">J</b>ava<b style="color: crimson;">S</b>cript
<b style="color: crimson;">O</b>bject
<b style="color: crimson;">N</b>otation
@snapend


@snap[south-east author-box]
@fa[envelope](prataprc@gmail.com - R Pratap Chakravarthy) <br/>
@fa[github](https://github.com/bnclabs/jsondata) <br/>
@snapend

---

Why JSON ?
==========

<br/>
@snap[fragment text-center text-blue]
Web standard for data exchange.
@snapend

@snap[mt30 fragment text-center text-green]
Inter-operability with several languages.
@snapend

@snap[mt30 fragment text-center text-black]
Human friendly as apposed to machine friendly.
@snapend

---

Data types
==========

JSON defines the least common subset of data types across
sevaral languages.

@snap[fragment mt30]
<b>Primitive types</b>
@snapend

@ul
* **null**, equivalent of None, nil, null in many languages.
* **number**, base 10 representation.
* **bool**, true or false. Both represented in lowercase.
* **string**, double quoted, utf8 encoded plain text.
@ulend

@snap[fragment mt30]
<b>Structured types</b>
@snapend

@ul
* **Array**, heterogenous collection of other types, with number index.
* **Object**, heterogenous collection of other types, with string index.
@ulend


+++

Examples
========

@snap[fragment text-center text-12]
"Hello world!"
@snapend

<br/>

@snap[fragment text-center text-12]
42
@snapend

<br/>

@snap[fragment text-center text-12]
true
@snapend

<br/>

@snap[fragment text-center text-12]
null
@snapend

+++

Examples: Numbers
=================

@snap[west ml20 text-12]
<pre style="line-height: 2em">
132837
-132837
0
.123
0.123
-0.123
-.123
1e2
</pre>
@snapend

@snap[east mr20 text-12]
<pre style="line-height: 2em">
-1e+2
1e-2
-1e-2
.123e2
0.123e+2
-0.123e-2
-.123e+2
-1.123e+2
</pre>
@snapend

---

Numbers
=======

@snap[mt30 fragment]
Integer numbers within the range [-(2^53)+1, (2^53)-1] are generally considered interoperable.
@snapend

@snap[mt30 fragment]
Floating point numbers shall support accuracy and precision defined by IEEE 754 binary64 (double precision).
@snapend

---

Strings
=======

```bnf
string: '"' utf8-unicode-chars '"'.
```

@snap[mt30 fragment]
Unicode chars that needs to be escaped:
@snapend

@ul[mt30]
* Quotation mark (").
* Reverse solidus (\\).
* Control characters (U+0000 through U+001F)
@ulend

---

Example: object
===============

```json
{
  "Image": {
	"Width":  800,
	"Height": 600,
	"Title":  "View from 15th Floor",
	"Thumbnail": {
		"Url":    "http://www.example.com/image/481989943",
		"Height": 125,
		"Width":  100
	},
	"Animated" : false,
	"IDs": [116, 943, 234, 38793]
  }
}
```

---

Example: array
==============

```json
[
	{
	   "precision": "zip",
	   "Latitude":  37.7668,
	   "Longitude": -122.3959,
	   "Address":   "",
	   "Country":   "US"
	},
	{
	   "precision": "zip",
	   "Latitude":  37.371991,
	   "Longitude": -122.026020,
	   "Address":   "",
	   "Country":   "US"
	}
]
```

---

Grammar
=======

```bnf
bool     : "true" | "false".
null     : "null".
string   : '"' chars '"'.

number   : "-"? int frac? exp?.
int      : "0" | [0-9]+.
frac     : "." [0-9]+.
exp      : ("e"|"E") (-|+)? [0-9]+.

object   : "{" property \*(comma property) "}".
property : string ":" value.

array    : "[" value \*(comma value) "]".
```

+++

Whitespace
==========

JSON has a free-form syntax, meaning all forms of whitespace
serve only to separate tokens in the grammar, and have no
semantic significance.

```bnf
white-space     : space | horizontal-tab | new-line | cr
space           : %x20
horizontal-tab  : %x09
new-line        : %x0A
cr              : %x0D // Carriage-Return
```

---

128-bit integers
================

@snap[mt30 fragment]
[JSON specification](https://tools.ietf.org/html/rfc8259) do not define
the precision for integer numbers.
@snapend

@snap[mt30 fragment]
While most implementation of JSON handles number as 64-bit floating-point,
[jsondata](https://github.com/bnclabs/jsondata), a rust implementation
to process JSON, support serialization and de-serialisation of signed
128-bit integers.
@snapend

---

Numbers: Deferred conversion
============================

@snap[mt30 fragment]
When used in context of a document-database, parsing JSON data is a
repeated operation, and many times only specific fields within
a JSON document need to be lookedup.
@snapend

@snap[mt30 fragment]
To that end, [jsondata](https://github.com/bnclabs/jsondata) supports
deferred conversion of numbers.
@snapend

+++

Benchmark results
=================

```rust
Without deferred conversion:

    test json_test::bench_no_deferred    1,093 ns/iter (+/- 88)
    test json_test::bench_num              109 ns/iter (+/- 19)

With deferred conversion:

    test json_test::bench_deferred       1,004 ns/iter (+/- 215)
    test json_test::bench_num               77 ns/iter (+/- 4)
```

An improvement around 10-30%.

```rust
// bench_no_deferred uses the following sample
r#"[10123.1231, 1231.123123, 1233.123123, 123.1231231, 12312e10]"#;
// bench_num uses the following sample
"123121.2234234"
```

---

JSON Pointer
============

[JSON Pointer][jptr] defines a string syntax for identifying a specific value
within a JSON document.

@snap[fragment]
A JSON pointer text is made of path components separated by @color[blue](/).
@snapend

<div class="fragment mt30">
For Example: @color[blue](/users/0/name) <br/>
@css[text-07]({"users": [ {"name": "joe", age: 20}, {"name": "jack", age: 30}, {"name": "jane", age: 25} ])

<table style="margin: unset" class="mt30">
<tr> <th> path </th> <th> meaning </th> </tr>
<tr> <td>/users</td> <td> fetch the member value with matching key - @color[blue](users) </td> </tr>
<tr> <td>/0    </td> <td> fetch the @color[blue](first value) from an array </td> </tr>
<tr> <td>/name </td> <td> fetch the member value with matching key - @color[blue](name) </td> </tr>
</table>

</div>


[jptr]: https://tools.ietf.org/html/rfc6901

+++

Path matching
=============

@css[text-bold fragment](String-escape)

@snap[fragment]
All instances of quotation mark '"' (%x22), reverse solidus '\' (%x5C),
and control (%x00-1F) characters MUST be un-escaped.
@snapend

@css[text-bold fragment](Tilde-escape)

@snap[fragment]
All instances of ~0 and ~1 must be un-escaped to ~ and /.
@snapend

@css[text-bold fragment](Comparison)

@ul
* If current reference value is an object, path-fragment is compared byte-by-byte with the property name.
* If currently referenced value is a JSON array, path-fragment is interpreted as base-10 integer in ASCII and converted to zero-based index.
@ulend

+++

<!-- .slide: class="jptr-result" -->

Example: Result
===============

@img[west jptr-eg span-45](./template/jpt-eg.png)

<table class="east jptr-eg span-45">
    <tr><th>pointer-text</th> <th>result</th></tr>
    <tr><td>""</td>           <td>// the whole document</td></tr>
    <tr><td>"/foo"</td>       <td>["bar", "baz"]</td></tr>
    <tr><td>"/foo/0"</td>     <td>"bar"</td></tr>
    <tr><td>"/"</td>          <td>0</td></tr>
    <tr><td>"/a~1b"</td>      <td>1</td></tr>
    <tr><td>"/c%d"</td>       <td>2</td></tr>
    <tr><td>"/e^f"</td>       <td>3</td></tr>
    <tr><td>"/g|h"</td>       <td>4</td></tr>
    <tr><td>"/i\\j"</td>      <td>5</td></tr>
    <tr><td>"/k\"l"</td>      <td>6</td></tr>
    <tr><td>"/ "</td>         <td>7</td></tr>
    <tr><td>"/m~0n"</td>      <td>8</td></tr>
</table>

+++

Grammar
=======

<br/>

```bnf
json-pointer    = *( "/" reference-token )
reference-token = *( unescaped | escaped )
unescaped       = %x00-2E | %x30-7D | %x7F-10FFFF
escaped         = "~" ( "0" | "1" )
```

@ul[mt30]
* %x2F ('/') and %x7E ('~') are excluded from 'unescaped'
* @color[blue]~0 means @color[blue]~
* @color[blue]~1 means @color[blue]/.
* @color[blue]~ escaping is not applied recursively. @color[blue]~01 literally becomes @color[blue]~1.
@ulend

---

Json5
=====

Corner cases and good to have features that was left out in JSON.

@ul
* Object keys may be an ECMAScript 5.1 IdentifierName.
* Objects may have a single trailing comma.
* Arrays may have a single trailing comma.
* Strings may be single quoted.
* Strings may span multiple lines by escaping new line characters.
* Strings may include character escapes.
* Numbers may be hexadecimal.
* Numbers may have a leading or trailing decimal point.
* Numbers may be IEEE 754 positive infinity, negative infinity, and NaN.
* Numbers may begin with an explicit plus sign.
* Single and multi-line comments are allowed.
* Additional white space characters are allowed.
@ulend

+++

Identifier for bbject key
=========================

<br/>

```json
{
    width: 1920,
    height: 1080,
}
```

and

```json
{
    "width": 1920,
    "height": 1080,
}
```

are equivalent.

+++

Trailing comma
==============

<br/>

```json
[
    { name: 'Joe', age: 27, },
    { name: 'Jane', age: 32 },
]
```

and

```json
[
    { name: 'Joe', age: 27 },
    { name: 'Jane', age: 32 }
]
```

are equivalent.

+++

Single quoted strings
=====================

```json
{
    image: {
        width: 1920,
        height: 1080,
        'aspect-ratio': '16:9',
    }
}
```

and

```json
{
    image: {
        width: 1920,
        height: 1080,
        "aspect-ratio": "16:9",
    }
}
```

are equivalent.

+++

Multi-line strings
==================

<br/>

```json
"Lorem ipsum dolor sit amet, \
consectetur adipiscing elit."
```

and

```json
'Lorem ipsum dolor sit amet, consectetur adipiscing elit.'
```

are equivalent.

+++

<!-- .slide: class="chresc" -->

Character escapes in strings
============================

A string containing only a single reverse solidus character
may be represented as ``\x5C`` or ``\u005C``.

A string containing only the musical score character
🎼 (U+1F3BC) may be represented as '\uD83C\uDFBC'.

Escape | Sequence Description | Code Point
-------|----------------------|-----------
  \'   | Apostrophe	          | U+0027
  \"   | Quotation mark	      | U+0022
  \\   | Reverse solidus      | U+005C
  \b   | Backspace            | U+0008
  \f   | Form feed            | U+000C
  \n   | Line feed            | U+000A
  \r   | Carriage return      | U+000D
  \t   | Horizontal tab       | U+0009
  \v   | Vertical tab         | U+000B
  \0   | Null                 | U+0000

+++

Hexadecimal numbers
===================

<br/>

```json
{
    positiveHex: 0xdecaf,
    negativeHex: -0xC0FFEE,
}
```

and

```json
{
    positiveHex: 912559,
    negativeHex: -12648430,
}
```

are equivalent.

+++

Leading/Trailing decimal point
==============================

<br/>

```json
{
    integer: 123,
    withFractionPart: 123.456,
    onlyFractionPart: .456,
    trailingPoint: 456.,
    withExponent: 123e-456,
}
```

+++

+/- infinity and NaN
====================

<br/>

```json
{
    positiveInfinity: Infinity,
    negativeInfinity: -Infinity,
    notANumber: NaN,
}
```

+++

+ Numbers
=========

<br/>

```json
{
    impliedPositive: 123,
    explicitPositive: +123,
}
```

+++

Comments
========

<br/>

```json
// This is a single line comment.

/* This is a multi-
   line comment. */
```

+++

<!-- .slide: class="whitespace" -->

White space characters
======================

Additional whitespace chars:

Code Points          | Description
---------------------|-----------------
 U+0009	             | Horizontal tab
 U+000A	             | Line feed
 U+000B	             | Vertical tab
 U+000C	             | Form feed
 U+000D	             | Carriage return
 U+0020	             | Space
 U+00A0	             | Non-breaking space
 U+2028	             | Line separator
 U+2029	             | Paragraph separator
 U+FEFF	             | Byte order mark
 Unicode Zs category | Any other character in the Space Separator Unicode category

---

@snap[midpoint]
<h1>Thank you</h1>
@snapend