Repository navigation
Expand file tree
/
Copy pathusers-guide.html
More file actions
2051 lines (1921 loc) · 56.6 KB
/
Copy pathusers-guide.html
File metadata and controls
2051 lines (1921 loc) · 56.6 KB
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
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html">
<title>Kwalify User's Guide (for Ruby)</title>
<meta name="author" content="makoto kuwata <kwa(at)kuwata-lab.com>">
<meta name="generator" content="kwaser">
<meta http-equiv="Content-Style-Type" content="text/css">
<link rel="stylesheet" href="docstyle.css" type="text/css">
</head>
<body>
<div class="mainbody">
<div align="left"><h1>Kwalify User's Guide (for Ruby)</h1></div>
<div align="left">
makoto kuwata <kwa(at)kuwata-lab.com><br>
last update: $Date$<br>
</div>
<a name="preface"></a>
<h2 class="section1">Preface</h2>
<p>Kwalify<sup>(<a href="#fnref:1" name="fnlink:1">*1</a>)</sup> is a parser, schema validator, and data binding tool for YAML and JSON.
Kwalify enables you to handle YAML and JSON more easily and strictly.
</p>
<p>Topics:
</p>
<ul type="disc">
<li><a href="#schema">Schema validation for YAML</a> and <a href="#tips-json">JSON</a>
</li>
<li><a href="#actions">Class definition generation for Ruby, PHP, and Java</a>
</li>
<li><a href="#howto-databinding">Data binding</a>
</li>
<li><a href="#howto-preceding">Preceding alias</a>
</li>
</ul>
<div class="footnote">
<dl compact>
<dt>(<a name="fnref:1" href="#fnlink:1">*1</a>)</dt>
<dd>Pronounce as 'Qualify'.</dd>
</dl>
</div>
<a name="toc"></a>
<h3 class="section2">Table of Contents</h3>
<ul>
<li><a href="#preface">Preface</a>
<ul>
<li><a href="#toc">Table of Contents</a>
</li>
</ul>
</li>
<li><a href="#schema">Schema Definition</a>
<ul>
<li><a href="#schema-seq">Sequence</a>
</li>
<li><a href="#schema-map">Mapping</a>
</li>
<li><a href="#schema-seq-of-map">Sequence of Mapping</a>
</li>
<li><a href="#schema-map-of-seq">Mapping of Sequence</a>
</li>
<li><a href="#schema-rules">Rule and Constraint</a>
</li>
<li><a href="#schema-unique">Unique constraint</a>
</li>
</ul>
</li>
<li><a href="#tips">Tips</a>
<ul>
<li><a href="#tips-json">JSON</a>
</li>
<li><a href="#tips-anchor">Anchor and Alias</a>
</li>
<li><a href="#tips-default">Default of Mapping</a>
</li>
<li><a href="#tips-merge">Merging Mappings</a>
</li>
</ul>
</li>
<li><a href="#howto">How to in Ruby</a>
<ul>
<li><a href="#howot-validate">Validation</a>
</li>
<li><a href="#howto-parse">Parsing with Validation</a>
</li>
<li><a href="#howto-meta">Meta Validation</a>
</li>
<li><a href="#howto-hook">Validator#validator_hook()</a>
</li>
<li><a href="#howto-preceding">Preceding Alias</a>
</li>
<li><a href="#howto-databinding">Data Binding</a>
</li>
</ul>
</li>
<li><a href="#actions">Actions</a>
<ul>
<li><a href="#action-genclass">Class Definition Generation</a>
<ul>
<li><a href="#action-genclass-ruby">Ruby Class Definition</a>
</li>
<li><a href="#action-genclass-java">Java Class Definition</a>
</li>
</ul>
</li>
</ul>
</li>
<li><a href="#ref">References</a>
<ul>
<li><a href="#ref-usage">Usage in Command-Line</a>
</li>
</ul>
</li>
</ul>
<br>
<br>
<a name="schema"></a>
<h2 class="section1">Schema Definition</h2>
<p>This section describes how to define schema definition of YAML.
</p>
<a name="schema-seq"></a>
<h3 class="section2">Sequence</h3>
<a name="schema01.yaml"></a>
<div class="program_caption">
<code>schema01.yaml</code> : sequence of string</div>
<pre class="program">type: seq
sequence:
- type: str
</pre>
<a name="document01a.yaml"></a>
<div class="program_caption">
<code>document01a.yaml</code> : valid document example</div>
<pre class="program">- foo
- bar
- baz
</pre>
<a name="valid01.result"></a>
<div class="terminal_caption">
validate</div>
<pre class="terminal">$ kwalify -lf schema01.yaml document01a.yaml
document01a.yaml#0: valid.
</pre>
<a name="document01b.yaml"></a>
<div class="program_caption">
<code>document01b.yaml</code> : invalid document example</div>
<pre class="program">- foo
- 123
- baz
</pre>
<a name="invalid01.result"></a>
<div class="terminal_caption">
validate</div>
<pre class="terminal">$ kwalify -lf schema01.yaml document01b.yaml
document01b.yaml#0: INVALID
- (line 2) [/1] '123': not a string.
</pre>
<p>Default '<code>type:</code>' is <code>str</code> so you can omit '<code>type: str</code>'.
</p>
<br>
<a name="schema-map"></a>
<h3 class="section2">Mapping</h3>
<a name="schema02.yaml"></a>
<div class="program_caption">
<code>schema02.yaml</code> : mapping of scalar</div>
<pre class="program">type: map
mapping:
"name":
type: str
required: yes
"email":
type: str
pattern: /@/
"age":
type: int
"birth":
type: date
</pre>
<a name="document02a.yaml"></a>
<div class="program_caption">
<code>document02a.yaml</code> : valid document example</div>
<pre class="program">name: foo
email: foo@mail.com
age: 20
birth: 1985-01-01
</pre>
<a name="valid02.result"></a>
<div class="terminal_caption">
validate</div>
<pre class="terminal">$ kwalify -lf schema02.yaml document02a.yaml
document02a.yaml#0: valid.
</pre>
<a name="document02b.yaml"></a>
<div class="program_caption">
<code>document02b.yaml</code> : invalid document example</div>
<pre class="program">name: foo
email: foo(at)mail.com
age: twenty
birth: Jun 01, 1985
</pre>
<a name="invalid02.result"></a>
<div class="terminal_caption">
validate</div>
<pre class="terminal">$ kwalify -lf schema02.yaml document02b.yaml
document02b.yaml#0: INVALID
- (line 2) [/email] 'foo(at)mail.com': not matched to pattern /@/.
- (line 3) [/age] 'twenty': not a integer.
- (line 4) [/birth] 'Jun 01, 1985': not a date.
</pre>
<br>
<a name="schema-seq-of-map"></a>
<h3 class="section2">Sequence of Mapping</h3>
<a name="schema03.yaml"></a>
<div class="program_caption">
<code>schema03.yaml</code> : sequence of mapping</div>
<pre class="program">type: seq
sequence:
- type: map
mapping:
"name":
type: str
required: true
"email":
type: str
</pre>
<a name="document03a.yaml"></a>
<div class="program_caption">
<code>document03a.yaml</code> : valid document example</div>
<pre class="program">- name: foo
email: foo@mail.com
- name: bar
email: bar@mail.net
- name: baz
email: baz@mail.org
</pre>
<a name="valid03.result"></a>
<div class="terminal_caption">
validate</div>
<pre class="terminal">$ kwalify -lf schema03.yaml document03a.yaml
document03a.yaml#0: valid.
</pre>
<a name="document03b.yaml"></a>
<div class="program_caption">
<code>document03b.yaml</code> : invalid document example</div>
<pre class="program">- name: foo
email: foo@mail.com
- naem: bar
email: bar@mail.net
- name: baz
mail: baz@mail.org
</pre>
<a name="invalid03.result"></a>
<div class="terminal_caption">
validate</div>
<pre class="terminal">$ kwalify -lf schema03.yaml document03b.yaml
document03b.yaml#0: INVALID
- (line 3) [/1] key 'name:' is required.
- (line 3) [/1/naem] key 'naem:' is undefined.
- (line 6) [/2/mail] key 'mail:' is undefined.
</pre>
<br>
<a name="schema-map-of-seq"></a>
<h3 class="section2">Mapping of Sequence</h3>
<a name="schema04.yaml"></a>
<div class="program_caption">
<code>schema04.yaml</code> : mapping of sequence of mapping</div>
<pre class="program">type: map
mapping:
"company":
type: str
required: yes
"email":
type: str
"employees":
type: seq
sequence:
- type: map
mapping:
"code":
type: int
required: yes
"name":
type: str
required: yes
"email":
type: str
</pre>
<a name="document04a.yaml"></a>
<div class="program_caption">
<code>document04a.yaml</code> : valid document example</div>
<pre class="program">company: Kuwata lab.
email: webmaster@kuwata-lab.com
employees:
- code: 101
name: foo
email: foo@kuwata-lab.com
- code: 102
name: bar
email: bar@kuwata-lab.com
</pre>
<a name="valid04.result"></a>
<div class="terminal_caption">
validate</div>
<pre class="terminal">$ kwalify -lf schema04.yaml document04a.yaml
document04a.yaml#0: valid.
</pre>
<a name="document04b.yaml"></a>
<div class="program_caption">
<code>document04b.yaml</code> : invalid document example</div>
<pre class="program">company: Kuwata Lab.
email: webmaster@kuwata-lab.com
employees:
- code: A101
name: foo
email: foo@kuwata-lab.com
- code: 102
name: bar
mail: bar@kuwata-lab.com
</pre>
<a name="invalid04.result"></a>
<div class="terminal_caption">
validate</div>
<pre class="terminal">$ kwalify -lf schema04.yaml document04b.yaml
document04b.yaml#0: INVALID
- (line 4) [/employees/0/code] 'A101': not a integer.
- (line 9) [/employees/1/mail] key 'mail:' is undefined.
</pre>
<br>
<a name="schema-rules"></a>
<h3 class="section2">Rule and Constraint</h3>
<p><code>type:</code>, <code>required:</code>, <code>length</code>, ... are called <strong>constraint</strong> and set of constraints are called <strong>rule</strong>.
</p>
<ul type="disc">
<li>Rule contains 'type:' constraint. If 'type:' is omitted, 'type: str' is used as default.
</li>
<li>'sequence:' constraint takes a sequence of rule (the sequence can contain only a rule).
</li>
<li>'mapping:' constraint takes a mapping which values are rules.
</li>
</ul>
<div style="align:center;">
<img src="img/fig01.png" alt="constraints and rules of schema definition." />
</div>
<p>The following is a list of constraints.
</p>
<dl class="dl3">
<dt class="dt3"><strong>
<code>required:</code> </strong></dt>
<dd class="dd3">
Value is required when true (default is false).
This is similar to not-null constraint in RDBMS.
</dd>
<dt class="dt3"><strong>
<code>enum:</code> </strong></dt>
<dd class="dd3">
List of available values.
</dd>
<dt class="dt3"><strong>
<code>pattern:</code> </strong></dt>
<dd class="dd3">
Specifies regular expression pattern of value.
</dd>
<dt class="dt3"><strong>
<code>type:</code> </strong></dt>
<dd class="dd3">
Type of value. The followings are available:
<ul type="circle">
<li><code>str</code>
</li>
<li><code>int</code>
</li>
<li><code>float</code>
</li>
<li><code>number</code> (== int or float)
</li>
<li><code>text</code> (== str or number)
</li>
<li><code>bool</code>
</li>
<li><code>date</code>
</li>
<li><code>time</code>
</li>
<li><code>timestamp</code>
</li>
<li><code>seq</code>
</li>
<li><code>map</code>
</li>
<li><code>scalar</code> (all but seq and map)
</li>
<li><code>any</code> (means any data)
</li>
</ul>
</dd>
<dt class="dt3"><strong>
<code>range:</code> </strong></dt>
<dd class="dd3">
Range of value between max/max-ex and min/min-ex.
<ul type="circle">
<li>'max' means 'max-inclusive'.
</li>
<li>'min' means 'min-inclusive'.
</li>
<li>'max-ex' means 'max-exclusive'.
</li>
<li>'min-ex' means 'min-exclusive'.
</li>
</ul>
Type <code>seq</code>, <code>map</code>, <code>bool</code> and <code>any</code> are not available with <code>range:</code>.
</dd>
<dt class="dt3"><strong>
<code>length:</code> </strong></dt>
<dd class="dd3">
Range of length of value between max/max-ex and min/min-ex.
Only type <code>str</code> and <code>text</code> are available with <code>length:</code>.
</dd>
<dt class="dt3"><strong>
<code>assert:</code> </strong></dt>
<dd class="dd3">
String which represents validation expression.
String should contain variable name <code>val</code> which represents value.
(This is an experimental function and not supported in Kwartz-java).
</dd>
<dt class="dt3"><strong>
<code>unique:</code> </strong></dt>
<dd class="dd3">
Value is unique for mapping or sequence.
This is similar to unique constraint of RDBMS.
See the next subsection for detail.
</dd>
<dt class="dt3"><strong>
<code>name:</code> </strong></dt>
<dd class="dd3">
Name of schema.
</dd>
<dt class="dt3"><strong>
<code>desc:</code> </strong></dt>
<dd class="dd3">
Description. This is not used for validation.
</dd>
<dt class="dt3"><strong>
<code>class:</code> </strong></dt>
<dd class="dd3">
Class name. This is for data-binding and is available only with type 'map'.
This is also used in 'genclass' action.
</dd>
<dt class="dt3"><strong>
<code>default:</code> </strong></dt>
<dd class="dd3">
Default value.
This is only for 'genclass' action, and have no effect to validation and parsing.
Default value should be scalar and it is not available if <code>type:</code> is <code>map</code> or <code>seq</code>, and also not available when <code>required:</code> is true.
</dd>
</dl>
<a name="schema05.yaml"></a>
<div class="program_caption">
<code>schema05.yaml</code> : rule examples</div>
<pre class="program">type: seq
sequence:
-
type: map
mapping:
"name":
type: str
required: yes
"email":
type: str
required: yes
pattern: /@/
"password":
type: text
length: { max: 16, min: 8 }
"age":
type: int
range: { max: 30, min: 18 }
# or assert: 18 <= val && val <= 30
"blood":
type: str
enum: [A, B, O, AB]
"birth":
type: date
"memo":
type: any
"deleted":
type: bool
default: false
</pre>
<a name="document05a.yaml"></a>
<div class="program_caption">
<code>document05a.yaml</code> : valid document example</div>
<pre class="program">- name: foo
email: foo@mail.com
password: xxx123456
age: 20
blood: A
birth: 1985-01-01
- name: bar
email: bar@mail.net
age: 25
blood: AB
birth: 1980-01-01
</pre>
<a name="valid05.result"></a>
<div class="terminal_caption">
validate</div>
<pre class="terminal">$ kwalify -lf schema05.yaml document05a.yaml
document05a.yaml#0: valid.
</pre>
<a name="document05b.yaml"></a>
<div class="program_caption">
<code>document05b.yaml</code> : invalid document example</div>
<pre class="program">- name: foo
email: foo(at)mail.com
password: xxx123
age: twenty
blood: a
birth: 1985-01-01
- given-name: bar
family-name: Bar
email: bar@mail.net
age: 15
blood: AB
birth: 1980/01/01
</pre>
<a name="invalid05.result"></a>
<div class="terminal_caption">
validate</div>
<pre class="terminal">$ kwalify -lf schema05.yaml document05b.yaml
document05b.yaml#0: INVALID
- (line 2) [/0/email] 'foo(at)mail.com': not matched to pattern /@/.
- (line 3) [/0/password] 'xxx123': too short (length 6 < min 8).
- (line 4) [/0/age] 'twenty': not a integer.
- (line 5) [/0/blood] 'a': invalid blood value.
- (line 7) [/1] key 'name:' is required.
- (line 7) [/1/given-name] key 'given-name:' is undefined.
- (line 8) [/1/family-name] key 'family-name:' is undefined.
- (line 10) [/1/age] '15': too small (< min 18).
- (line 12) [/1/birth] '1980/01/01': not a date.
</pre>
<br>
<a name="schema-unique"></a>
<h3 class="section2">Unique constraint</h3>
<p>'<code>unique:</code>' constraint is available with elements of sequence or mapping.
This is equivalent to unique constraint of RDBMS.
</p>
<ul type="disc">
<li>Type of rule which has '<code>unique:</code>' entry must be scalar (str, int, float, ...).
</li>
<li>Type of parent rule must be sequence or mapping.
</li>
</ul>
<a name="schema06.yaml"></a>
<div class="program_caption">
<code>schema06.yaml</code> : unique constraint entry with mapping and sequence</div>
<pre class="program">type: seq
sequence:
- type: map
required: yes
mapping:
"name": { type: str, required: yes, <strong>unique: yes</strong> }
"email": { type: str }
"groups":
type: seq
sequence:
- { type: str, <strong>unique: yes</strong> }
</pre>
<a name="document06a.yaml"></a>
<div class="program_caption">
<code>document06a.yaml</code> : valid document example</div>
<pre class="program">- name: foo
email: admin@mail.com
groups:
- users
- foo
- admin
- name: bar
email: admin@mail.com
groups:
- users
- admin
- name: baz
email: baz@mail.com
groups:
- users
</pre>
<a name="valid06.result"></a>
<div class="terminal_caption">
validate</div>
<pre class="terminal">$ kwalify -lf schema06.yaml document06a.yaml
document06a.yaml#0: valid.
</pre>
<a name="document06b.yaml"></a>
<div class="program_caption">
<code>document06b.yaml</code> : invalid document example</div>
<pre class="program">- name: foo
email: admin@mail.com
groups:
- foo
- users
- admin
- foo
- name: bar
email: admin@mail.com
groups:
- admin
- users
- name: bar
email: baz@mail.com
groups:
- users
</pre>
<a name="invalid06.result"></a>
<div class="terminal_caption">
validate</div>
<pre class="terminal">$ kwalify -lf schema06.yaml document06b.yaml
document06b.yaml#0: INVALID
- (line 7) [/0/groups/3] 'foo': is already used at '/0/groups/0'.
- (line 13) [/2/name] 'bar': is already used at '/1/name'.
</pre>
<br>
<br>
<a name="tips"></a>
<h2 class="section1">Tips</h2>
<a name="tips-json"></a>
<h3 class="section2">JSON</h3>
<p><a href="http://www.json.org">JSON</a> is a lightweight data-interchange format, especially useful for JavaScript.
JSON can be considered as a subset of YAML. It means that YAML parser can parse JSON and Kwalify can validate JSON document.
</p>
<a name="schema12.json"></a>
<div class="program_caption">
<code>schema12.json</code> : an example schema definition written in JSON format</div>
<pre class="program">{ "type": "map",
"required": true,
"mapping": {
"name": { "type": "str", "required": true },
"email": { "type": "str" },
"age": { "type": "int" },
"gender": { "type": "str", "enum": ["M", "F"] },
"favorite": { "type": "seq",
"sequence": [ { "type": "str" } ]
}
}
}
</pre>
<a name="document12a.json"></a>
<div class="program_caption">
<code>document12a.json</code> : valid JSON document example</div>
<pre class="program">{ "name": "Foo",
"email": "foo@mail.com",
"age": 20,
"gender": "F",
"favorite": [
"football",
"basketball",
"baseball"
]
}
</pre>
<a name="valid12.result"></a>
<div class="terminal_caption">
validate</div>
<pre class="terminal">$ kwalify -lf schema12.json document12a.json
document12a.json#0: valid.
</pre>
<a name="document12b.json"></a>
<div class="program_caption">
<code>document12b.json</code> : invalid JSON document example</div>
<pre class="program">{
"mail": "foo@mail.com",
"age": twenty,
"gender": "X",
"favorite": [ 123, 456 ]
}
</pre>
<a name="invalid12.json"></a>
<div class="terminal_caption">
validate</div>
<pre class="terminal">$ kwalify -lf schema12.json document12b.json
document12b.json#0: INVALID
- (line 1) [/] key 'name:' is required.
- (line 2) [/mail] key 'mail:' is undefined.
- (line 3) [/age] 'twenty': not a integer.
- (line 4) [/gender] 'X': invalid gender value.
- (line 5) [/favorite/0] '123': not a string.
- (line 5) [/favorite/1] '456': not a string.
</pre>
<br>
<a name="tips-anchor"></a>
<h3 class="section2">Anchor and Alias</h3>
<p>You can share rules by YAML anchor and alias.
</p>
<a name="schema13.yaml"></a>
<div class="program_caption">
<code>schema13.yaml</code> : anchor example</div>
<pre class="program">type: seq
sequence:
- <strong>&employee</strong>
type: map
mapping:
"given-name": <strong>&name</strong>
type: str
required: yes
"family-name": <strong>*name</strong>
"post":
type: str
enum: [executive, manager, clerk]
"supervisor": <strong>*employee</strong>
</pre>
<p>Anchor and alias is also available in YAML document.
</p>
<a name="document13a.yaml"></a>
<div class="program_caption">
<code>document13a.yaml</code> : valid document example</div>
<pre class="program">- <strong>&foo</strong>
given-name: foo
family-name: Foo
post: executive
- <strong>&bar</strong>
given-name: bar
family-name: Bar
post: manager
supervisor: <strong>*foo</strong>
- given-name: baz
family-name: Baz
post: clerk
supervisor: <strong>*bar</strong>
- given-name: zak
family-name: Zak
post: clerk
supervisor: <strong>*bar</strong>
</pre>
<a name="valid13.result"></a>
<div class="terminal_caption">
validate</div>
<pre class="terminal">$ kwalify -lf schema13.yaml document13a.yaml
document13a.yaml#0: valid.
</pre>
<br>
<a name="tips-default"></a>
<h3 class="section2">Default of Mapping</h3>
<p>YAML allows user to specify default value of mapping.
</p>
<p>For example, the following YAML document uses default value of mapping.
</p>
<pre class="program">A: 10
B: 20
<strong>=: -1</strong> # default value
</pre>
<p>This is equal to the following Ruby code.
</p>
<pre class="program">map = ["A"=>10, "B"=>20]
map.default = -1
map
</pre>
<p>Kwalify allows user to specify default rule using default value of mapping.
It is useful when key names are unknown.
</p>
<a name="schema14.yaml"></a>
<div class="program_caption">
<code>schema14.yaml</code> : default rule example</div>
<pre class="program">type: map
mapping:
<strong>=:</strong> # default rule
type: number
range: { max: 1, min: -1 }
</pre>
<a name="document14a.yaml"></a>
<div class="program_caption">
<code>document14a.yaml</code> : valid document example</div>
<pre class="program">value1: 0
value2: 0.5
value3: -0.9
</pre>
<a name="valid14.result"></a>
<div class="terminal_caption">
validate</div>
<pre class="terminal">$ kwalify -lf schema14.yaml document14a.yaml
document14a.yaml#0: valid.
</pre>
<a name="document14b.yaml"></a>
<div class="program_caption">
<code>document14b.yaml</code> : invalid document example</div>
<pre class="program">value1: 0
value2: 1.1
value3: -2.0
</pre>
<a name="invalid14.result"></a>
<div class="terminal_caption">
validate</div>
<pre class="terminal">$ kwalify -lf schema14.yaml document14b.yaml
document14b.yaml#0: INVALID
- (line 2) [/value2] '1.1': too large (> max 1).
- (line 3) [/value3] '-2.0': too small (< min -1).
</pre>
<br>
<a name="tips-merge"></a>
<h3 class="section2">Merging Mappings</h3>
<p>YAML allows user to merge mappings.
</p>
<pre class="program">- <strong>&a1</strong>
A: 10
B: 20
- <strong><<: *a1</strong> # merge
A: 15 # override
C: 30 # add
</pre>
<p>This is equal to the following Ruby code.
</p>
<pre class="program">a1 = {"A"=>10, "B"=>20}
tmp = {}
tmp.update(a1) # merge
tmp["A"] = 15 # override
tmp["C"] = 30 # add
</pre>
<p>This feature allows Kwalify to merge rule entries.
</p>
<a name="schema15.yaml"></a>
<div class="program_caption">
<code>schema15.yaml</code> : merging rule entries example</div>
<pre class="program">type: map
mapping:
"group":
type: map
mapping:
"name": <strong>&name</strong>
type: str
required: yes
"email": <strong>&email</strong>
type: str
pattern: /@/
required: no
"user":
type: map
mapping:
"name":
<strong><<: *name</strong> # merge
<strong>length: { max: 16 }</strong> # add
"email":
<strong><<: *email</strong> # merge
<strong>required: yes</strong> # override
</pre>
<a name="document15a.yaml"></a>
<div class="program_caption">
<code>document15a.yaml</code> : valid document example</div>
<pre class="program">group:
name: foo
email: foo@mail.com
user:
name: bar
email: bar@mail.com
</pre>
<a name="valid15.result"></a>
<div class="terminal_caption">
validate</div>
<pre class="terminal">$ kwalify -lf schema15.yaml document15a.yaml
document15a.yaml#0: valid.
</pre>
<a name="document15b.yaml"></a>
<div class="program_caption">
<code>document15b.yaml</code> : invalid document example</div>
<pre class="program">group:
name: foo
email: foo@mail.com
user:
name: toooooo-looooong-name
</pre>
<a name="invalid15.result"></a>
<div class="terminal_caption">
validate</div>
<pre class="terminal">$ kwalify -lf schema15.yaml document15b.yaml
document15b.yaml#0: INVALID
- (line 5) [/user] key 'email:' is required.
- (line 5) [/user/name] 'toooooo-looooong-name': too long (length 21 > max 16).
</pre>
<br>
<br>
<a name="howto"></a>
<h2 class="section1">How to in Ruby</h2>
<p>This section describes how to use Kwalify in Ruby.
</p>
<a name="howot-validate"></a>
<h3 class="section2">Validation</h3>
<a name="howto-validation.rb"></a>
<pre class="program">require 'kwalify'
#require 'yaml'
## load schema data
schema = Kwalify::Yaml.load_file('kwalify.schema.yaml')
## or
#schema = YAML.load_file('kwalify.schema.yaml')
## create validator
validator = Kwalify::Validator.new(schema)
## load document
document = Kwalify::Yaml.load_file('document.yaml')
## or
#document = YAML.load_file('document.yaml')
## validate
errors = validator.validate(document)
## show errors
if errors && !errors.empty?
for e in errors
puts "[#{e.path}] #{e.message}"
end
end
</pre>
<br>
<a name="howto-parse"></a>
<h3 class="section2">Parsing with Validation</h3>
<p>From version 0.7, Kwalify supports parsing with validation.
</p>
<a name="howto-validation-with-parsing.rb"></a>
<pre class="program">require 'kwalify'
#require 'yaml'
## load schema data
schema = Kwalify::Yaml.load_file('kwalify.schema.yaml')
## or
#schema = YAML.load_file('kwalify.schema.yaml')
## create validator
validator = Kwalify::Validator.new(schema)
## create parser with validator
## (if validator is ommitted, no validation executed.)
parser = Kwalify::Yaml::Parser.new(validator)
## parse document with validation
filename = 'document.yaml'
document = parser.parse_file(filename)
## or
#document = parser.parse(File.read(filename), filename)
## show errors if exist
errors = parser.errors()
if errors && !errors.empty?
for e in errors
puts "#{e.linenum}:#{e.column} [#{e.path}] #{e.message}"
end
end
</pre>
<br>
<a name="howto-meta"></a>
<h3 class="section2">Meta Validation</h3>
<p>Meta validator is a validator which validates schema definition.
The schema definition is placed at 'kwalify/kwalify.schema.yaml'.
</p>
<p>Kwalify also provides Kwalify::MetaValidator class which validates
schema definition.
</p>
<pre class="program">require 'kwalify'
## meta validator
metavalidator = Kwalify::MetaValidator.instance
## validate schema definition
parser = Kwalify::Yaml::Parser.new(metavalidator)
errors = parser.parse_file('kwalify.schema.yaml')
for e in errors
puts "#{e.linenum}:#{e.column} [#{e.path}] #{e.message}"
end if errors && !errors.empty?
</pre>
<p>Meta validation is also available with command-line option '-m'.