kabk 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.

This version of kabk might be problematic. Click here for more details.

Files changed (67) hide show
  1. checksums.yaml +7 -0
  2. data/CHANGELOG.md +27 -0
  3. data/Gemfile +6 -0
  4. data/Gemfile.lock +108 -0
  5. data/Kabk_logo.svg +33 -0
  6. data/LICENSE +21 -0
  7. data/README.md +101 -0
  8. data/doc/Kabk/Adapters/Base.html +854 -0
  9. data/doc/Kabk/Adapters/SequelAdapter.html +948 -0
  10. data/doc/Kabk/Adapters.html +120 -0
  11. data/doc/Kabk/ApiError.html +511 -0
  12. data/doc/Kabk/Auth/JwtStrategy.html +551 -0
  13. data/doc/Kabk/Auth.html +118 -0
  14. data/doc/Kabk/Concurrency.html +297 -0
  15. data/doc/Kabk/ConcurrencyConflictError.html +225 -0
  16. data/doc/Kabk/Error.html +140 -0
  17. data/doc/Kabk/ExportHandler.html +381 -0
  18. data/doc/Kabk/Field.html +2160 -0
  19. data/doc/Kabk/ForbiddenError.html +225 -0
  20. data/doc/Kabk/InvalidFieldError.html +136 -0
  21. data/doc/Kabk/InvalidOldPasswordError.html +225 -0
  22. data/doc/Kabk/NotFoundError.html +225 -0
  23. data/doc/Kabk/QueryBuilder.html +551 -0
  24. data/doc/Kabk/Registry.html +608 -0
  25. data/doc/Kabk/RelationHydrator.html +480 -0
  26. data/doc/Kabk/Resource.html +1986 -0
  27. data/doc/Kabk/ResourceBuilder.html +1002 -0
  28. data/doc/Kabk/RestEngine.html +879 -0
  29. data/doc/Kabk/SchemaRenderer.html +318 -0
  30. data/doc/Kabk/UnauthorizedError.html +225 -0
  31. data/doc/Kabk/UploadHandler.html +308 -0
  32. data/doc/Kabk/ValidationError.html +225 -0
  33. data/doc/Kabk/Validator.html +380 -0
  34. data/doc/Kabk.html +330 -0
  35. data/doc/_index.html +376 -0
  36. data/doc/class_list.html +54 -0
  37. data/doc/css/common.css +1 -0
  38. data/doc/css/full_list.css +206 -0
  39. data/doc/css/style.css +1089 -0
  40. data/doc/file.README.html +149 -0
  41. data/doc/file_list.html +59 -0
  42. data/doc/frames.html +22 -0
  43. data/doc/index.html +149 -0
  44. data/doc/js/app.js +801 -0
  45. data/doc/js/full_list.js +334 -0
  46. data/doc/js/jquery.js +4 -0
  47. data/doc/method_list.html +910 -0
  48. data/doc/top-level-namespace.html +112 -0
  49. data/docs/API_REFERENCE.md +241 -0
  50. data/lib/kabk/adapters/base.rb +45 -0
  51. data/lib/kabk/adapters/sequel_adapter.rb +125 -0
  52. data/lib/kabk/concurrency.rb +30 -0
  53. data/lib/kabk/errors.rb +62 -0
  54. data/lib/kabk/export_handler.rb +43 -0
  55. data/lib/kabk/field.rb +97 -0
  56. data/lib/kabk/query_builder.rb +72 -0
  57. data/lib/kabk/registry.rb +41 -0
  58. data/lib/kabk/relation_hydrator.rb +107 -0
  59. data/lib/kabk/resource.rb +88 -0
  60. data/lib/kabk/resource_builder.rb +93 -0
  61. data/lib/kabk/rest_engine.rb +84 -0
  62. data/lib/kabk/schema_renderer.rb +69 -0
  63. data/lib/kabk/upload_handler.rb +24 -0
  64. data/lib/kabk/validator.rb +64 -0
  65. data/lib/kabk/version.rb +6 -0
  66. data/lib/kabk.rb +51 -0
  67. metadata +193 -0
data/doc/Kabk/Field.html ADDED
@@ -0,0 +1,2160 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
6
+ <title>
7
+ Class: Kabk::Field
8
+
9
+ &mdash; Documentation by YARD 0.9.45
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="../css/style.css" type="text/css">
14
+
15
+ <link rel="stylesheet" href="../css/common.css" type="text/css">
16
+
17
+ <script type="text/javascript">
18
+ pathId = "Kabk::Field";
19
+ relpath = '../';
20
+ </script>
21
+
22
+
23
+ <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
24
+
25
+ <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
26
+
27
+
28
+ </head>
29
+ <body>
30
+ <div id="main_progress" aria-hidden="true"></div>
31
+
32
+ <div class="nav_wrap">
33
+ <iframe id="nav" src="../class_list.html?1"></iframe>
34
+ <div id="resizer"></div>
35
+ </div>
36
+
37
+ <div id="main" tabindex="-1">
38
+ <div id="header">
39
+ <div id="menu">
40
+
41
+ <a href="../_index.html">Index (F)</a> &raquo;
42
+ <span class='title'><span class='object_link'><a href="../Kabk.html" title="Kabk (module)">Kabk</a></span></span>
43
+ &raquo;
44
+ <span class="title">Field</span>
45
+
46
+ </div>
47
+
48
+ <div id="search">
49
+
50
+ <a class="full_list_link" id="class_list_link"
51
+ href="../class_list.html">
52
+
53
+ <svg width="24" height="24">
54
+ <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
55
+ <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
56
+ <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
57
+ </svg>
58
+ </a>
59
+
60
+ </div>
61
+ <div class="clear"></div>
62
+ </div>
63
+
64
+ <div id="content"><h1>Class: Kabk::Field
65
+
66
+
67
+
68
+ </h1>
69
+ <div class="box_info">
70
+
71
+ <dl>
72
+ <dt>Inherits:</dt>
73
+ <dd>
74
+ <span class="inheritName">Object</span>
75
+
76
+ <ul class="fullTree">
77
+ <li>Object</li>
78
+
79
+ <li class="next">Kabk::Field</li>
80
+
81
+ </ul>
82
+ <a href="#" class="inheritanceTree">show all</a>
83
+
84
+ </dd>
85
+ </dl>
86
+
87
+
88
+
89
+
90
+
91
+
92
+
93
+
94
+
95
+
96
+
97
+ <dl>
98
+ <dt>Defined in:</dt>
99
+ <dd>lib/kabk/field.rb
100
+ </dd>
101
+ </dl>
102
+
103
+ </div>
104
+
105
+ <h2>Overview</h2><div class="docstring">
106
+ <div class="discussion">
107
+ <p>Represents field/column metadata</p>
108
+
109
+ </div>
110
+ </div>
111
+ <div class="tags">
112
+
113
+
114
+ </div>
115
+
116
+
117
+
118
+ <h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
119
+ <ul class="summary">
120
+
121
+ <li class="public ">
122
+ <span class="summary_signature">
123
+
124
+ <a href="#accordion-instance_method" title="#accordion (instance method)">#<strong>accordion</strong> &#x21d2; Boolean </a>
125
+
126
+
127
+
128
+ </span>
129
+
130
+
131
+
132
+
133
+
134
+
135
+
136
+
137
+
138
+
139
+
140
+
141
+ <span class="summary_desc"><div class='inline'><p>If true, wraps this field in an accordion section.</p></div></span>
142
+
143
+ </li>
144
+
145
+
146
+ <li class="public ">
147
+ <span class="summary_signature">
148
+
149
+ <a href="#calendar-instance_method" title="#calendar (instance method)">#<strong>calendar</strong> &#x21d2; Symbol </a>
150
+
151
+
152
+
153
+ </span>
154
+
155
+
156
+
157
+
158
+
159
+
160
+
161
+
162
+
163
+
164
+
165
+
166
+ <span class="summary_desc"><div class='inline'><p>The calendar system to use if type is date/datetime (e.g., :jalali, :gregorian).</p></div></span>
167
+
168
+ </li>
169
+
170
+
171
+ <li class="public ">
172
+ <span class="summary_signature">
173
+
174
+ <a href="#col_width-instance_method" title="#col_width (instance method)">#<strong>col_width</strong> &#x21d2; Integer </a>
175
+
176
+
177
+
178
+ </span>
179
+
180
+
181
+
182
+
183
+
184
+
185
+
186
+
187
+
188
+
189
+
190
+
191
+ <span class="summary_desc"><div class='inline'><p>Bootstrap grid column width (1 to 12).</p></div></span>
192
+
193
+ </li>
194
+
195
+
196
+ <li class="public ">
197
+ <span class="summary_signature">
198
+
199
+ <a href="#default_value-instance_method" title="#default_value (instance method)">#<strong>default_value</strong> &#x21d2; Object </a>
200
+
201
+
202
+
203
+ </span>
204
+
205
+
206
+
207
+
208
+
209
+
210
+
211
+
212
+
213
+
214
+
215
+
216
+ <span class="summary_desc"><div class='inline'><p>The default value for the field.</p></div></span>
217
+
218
+ </li>
219
+
220
+
221
+ <li class="public ">
222
+ <span class="summary_signature">
223
+
224
+ <a href="#depends_on-instance_method" title="#depends_on (instance method)">#<strong>depends_on</strong> &#x21d2; Hash </a>
225
+
226
+
227
+
228
+ </span>
229
+
230
+
231
+
232
+
233
+
234
+
235
+
236
+
237
+
238
+
239
+
240
+
241
+ <span class="summary_desc"><div class='inline'><p>Configures field dependency visibility (e.g., { field: &quot;published&quot;, value: true }).</p></div></span>
242
+
243
+ </li>
244
+
245
+
246
+ <li class="public ">
247
+ <span class="summary_signature">
248
+
249
+ <a href="#display_as-instance_method" title="#display_as (instance method)">#<strong>display_as</strong> &#x21d2; Symbol </a>
250
+
251
+
252
+
253
+ </span>
254
+
255
+
256
+
257
+
258
+
259
+
260
+
261
+
262
+
263
+
264
+
265
+
266
+ <span class="summary_desc"><div class='inline'><p>UI hint for how to display the value (e.g., :badge, :thumbnail, :boolean_icon).</p></div></span>
267
+
268
+ </li>
269
+
270
+
271
+ <li class="public ">
272
+ <span class="summary_signature">
273
+
274
+ <a href="#form_type-instance_method" title="#form_type (instance method)">#<strong>form_type</strong> &#x21d2; Symbol </a>
275
+
276
+
277
+
278
+ </span>
279
+
280
+
281
+
282
+
283
+
284
+
285
+
286
+
287
+
288
+
289
+
290
+
291
+ <span class="summary_desc"><div class='inline'><p>The frontend input component type (e.g., :text, :switch, :date, :image_single).</p></div></span>
292
+
293
+ </li>
294
+
295
+
296
+ <li class="public ">
297
+ <span class="summary_signature">
298
+
299
+ <a href="#hidden_in_form-instance_method" title="#hidden_in_form (instance method)">#<strong>hidden_in_form</strong> &#x21d2; Boolean </a>
300
+
301
+
302
+
303
+ </span>
304
+
305
+
306
+
307
+
308
+
309
+
310
+
311
+
312
+
313
+
314
+
315
+
316
+ <span class="summary_desc"><div class='inline'><p>If true, hides the field in forms.</p></div></span>
317
+
318
+ </li>
319
+
320
+
321
+ <li class="public ">
322
+ <span class="summary_signature">
323
+
324
+ <a href="#hidden_in_table-instance_method" title="#hidden_in_table (instance method)">#<strong>hidden_in_table</strong> &#x21d2; Boolean </a>
325
+
326
+
327
+
328
+ </span>
329
+
330
+
331
+
332
+
333
+
334
+
335
+
336
+
337
+
338
+
339
+
340
+
341
+ <span class="summary_desc"><div class='inline'><p>If true, hides the field in data tables.</p></div></span>
342
+
343
+ </li>
344
+
345
+
346
+ <li class="public ">
347
+ <span class="summary_signature">
348
+
349
+ <a href="#label-instance_method" title="#label (instance method)">#<strong>label</strong> &#x21d2; String </a>
350
+
351
+
352
+
353
+ </span>
354
+
355
+
356
+
357
+
358
+
359
+
360
+
361
+
362
+
363
+
364
+
365
+
366
+ <span class="summary_desc"><div class='inline'><p>The human-readable label for the field.</p></div></span>
367
+
368
+ </li>
369
+
370
+
371
+ <li class="public ">
372
+ <span class="summary_signature">
373
+
374
+ <a href="#name-instance_method" title="#name (instance method)">#<strong>name</strong> &#x21d2; String </a>
375
+
376
+
377
+
378
+ </span>
379
+
380
+
381
+
382
+
383
+
384
+
385
+
386
+
387
+
388
+
389
+
390
+
391
+ <span class="summary_desc"><div class='inline'><p>The technical name of the field (e.g., &quot;created_at&quot;).</p></div></span>
392
+
393
+ </li>
394
+
395
+
396
+ <li class="public ">
397
+ <span class="summary_signature">
398
+
399
+ <a href="#nullable-instance_method" title="#nullable (instance method)">#<strong>nullable</strong> &#x21d2; Boolean </a>
400
+
401
+
402
+
403
+ </span>
404
+
405
+
406
+
407
+
408
+
409
+
410
+
411
+
412
+
413
+
414
+
415
+
416
+ <span class="summary_desc"><div class='inline'><p>Indicates if this field can be null.</p></div></span>
417
+
418
+ </li>
419
+
420
+
421
+ <li class="public ">
422
+ <span class="summary_signature">
423
+
424
+ <a href="#options-instance_method" title="#options (instance method)">#<strong>options</strong> &#x21d2; Array, Hash </a>
425
+
426
+
427
+
428
+ </span>
429
+
430
+
431
+
432
+
433
+
434
+
435
+
436
+
437
+
438
+
439
+
440
+
441
+ <span class="summary_desc"><div class='inline'><p>Hardcoded select options if applicable.</p></div></span>
442
+
443
+ </li>
444
+
445
+
446
+ <li class="public ">
447
+ <span class="summary_signature">
448
+
449
+ <a href="#order-instance_method" title="#order (instance method)">#<strong>order</strong> &#x21d2; Integer </a>
450
+
451
+
452
+
453
+ </span>
454
+
455
+
456
+
457
+
458
+
459
+
460
+
461
+
462
+
463
+
464
+
465
+
466
+ <span class="summary_desc"><div class='inline'><p>The explicit ordering weight for rendering.</p></div></span>
467
+
468
+ </li>
469
+
470
+
471
+ <li class="public ">
472
+ <span class="summary_signature">
473
+
474
+ <a href="#primary_key-instance_method" title="#primary_key (instance method)">#<strong>primary_key</strong> &#x21d2; Boolean </a>
475
+
476
+
477
+
478
+ </span>
479
+
480
+
481
+
482
+
483
+
484
+
485
+
486
+
487
+
488
+
489
+
490
+
491
+ <span class="summary_desc"><div class='inline'><p>Indicates if this field is the primary key.</p></div></span>
492
+
493
+ </li>
494
+
495
+
496
+ <li class="public ">
497
+ <span class="summary_signature">
498
+
499
+ <a href="#readonly-instance_method" title="#readonly (instance method)">#<strong>readonly</strong> &#x21d2; Boolean </a>
500
+
501
+
502
+
503
+ </span>
504
+
505
+
506
+
507
+
508
+
509
+
510
+
511
+
512
+
513
+
514
+
515
+
516
+ <span class="summary_desc"><div class='inline'><p>Indicates if this field is read-only.</p></div></span>
517
+
518
+ </li>
519
+
520
+
521
+ <li class="public ">
522
+ <span class="summary_signature">
523
+
524
+ <a href="#relation-instance_method" title="#relation (instance method)">#<strong>relation</strong> &#x21d2; Hash </a>
525
+
526
+
527
+
528
+ </span>
529
+
530
+
531
+
532
+
533
+
534
+
535
+
536
+
537
+
538
+
539
+
540
+
541
+ <span class="summary_desc"><div class='inline'><p>Relational metadata (e.g., { resource: &quot;user&quot;, cardinality: &quot;many_to_one&quot;, ... }).</p></div></span>
542
+
543
+ </li>
544
+
545
+
546
+ <li class="public ">
547
+ <span class="summary_signature">
548
+
549
+ <a href="#required-instance_method" title="#required (instance method)">#<strong>required</strong> &#x21d2; Boolean </a>
550
+
551
+
552
+
553
+ </span>
554
+
555
+
556
+
557
+
558
+
559
+
560
+
561
+
562
+
563
+
564
+
565
+
566
+ <span class="summary_desc"><div class='inline'><p>Indicates if this field is mandatory in forms.</p></div></span>
567
+
568
+ </li>
569
+
570
+
571
+ <li class="public ">
572
+ <span class="summary_signature">
573
+
574
+ <a href="#rows-instance_method" title="#rows (instance method)">#<strong>rows</strong> &#x21d2; Integer </a>
575
+
576
+
577
+
578
+ </span>
579
+
580
+
581
+
582
+
583
+
584
+
585
+
586
+
587
+
588
+
589
+
590
+
591
+ <span class="summary_desc"><div class='inline'><p>For textarea form_type, specifies the number of rows.</p></div></span>
592
+
593
+ </li>
594
+
595
+
596
+ <li class="public ">
597
+ <span class="summary_signature">
598
+
599
+ <a href="#type-instance_method" title="#type (instance method)">#<strong>type</strong> &#x21d2; Symbol </a>
600
+
601
+
602
+
603
+ </span>
604
+
605
+
606
+
607
+
608
+
609
+
610
+
611
+
612
+
613
+
614
+
615
+
616
+ <span class="summary_desc"><div class='inline'><p>The underlying data type (:string, :number, :boolean, :date, :datetime, :file, :relation).</p></div></span>
617
+
618
+ </li>
619
+
620
+
621
+ <li class="public ">
622
+ <span class="summary_signature">
623
+
624
+ <a href="#upload_config-instance_method" title="#upload_config (instance method)">#<strong>upload_config</strong> &#x21d2; Hash </a>
625
+
626
+
627
+
628
+ </span>
629
+
630
+
631
+
632
+
633
+
634
+
635
+
636
+
637
+
638
+
639
+
640
+
641
+ <span class="summary_desc"><div class='inline'><p>Configuration for file uploads.</p></div></span>
642
+
643
+ </li>
644
+
645
+
646
+ <li class="public ">
647
+ <span class="summary_signature">
648
+
649
+ <a href="#validation-instance_method" title="#validation (instance method)">#<strong>validation</strong> &#x21d2; Hash </a>
650
+
651
+
652
+
653
+ </span>
654
+
655
+
656
+
657
+
658
+
659
+
660
+
661
+
662
+
663
+
664
+
665
+
666
+ <span class="summary_desc"><div class='inline'><p>Server-side validation rules (e.g., { min_length: 5, unique: true }).</p></div></span>
667
+
668
+ </li>
669
+
670
+
671
+ </ul>
672
+
673
+
674
+
675
+
676
+
677
+ <h2>
678
+ Instance Method Summary
679
+ <small><a href="#" class="summary_toggle">collapse</a></small>
680
+ </h2>
681
+
682
+ <ul class="summary">
683
+
684
+ <li class="public ">
685
+ <span class="summary_signature">
686
+
687
+ <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(name:, **attributes) &#x21d2; Field </a>
688
+
689
+
690
+
691
+ </span>
692
+
693
+
694
+ <span class="note title constructor">constructor</span>
695
+
696
+
697
+
698
+
699
+
700
+
701
+
702
+
703
+ <span class="summary_desc"><div class='inline'><p>A new instance of Field.</p></div></span>
704
+
705
+ </li>
706
+
707
+
708
+ <li class="public ">
709
+ <span class="summary_signature">
710
+
711
+ <a href="#to_h-instance_method" title="#to_h (instance method)">#<strong>to_h</strong> &#x21d2; Object </a>
712
+
713
+
714
+
715
+ </span>
716
+
717
+
718
+
719
+
720
+
721
+
722
+
723
+
724
+
725
+ <span class="summary_desc"><div class='inline'></div></span>
726
+
727
+ </li>
728
+
729
+
730
+ </ul>
731
+
732
+
733
+
734
+ <div id="constructor_details" class="method_details_list">
735
+ <h2>Constructor Details</h2>
736
+
737
+ <div class="method_details first">
738
+ <h3 class="signature first" id="initialize-instance_method">
739
+
740
+ #<strong>initialize</strong>(name:, **attributes) &#x21d2; <tt><span class='object_link'><a href="" title="Kabk::Field (class)">Field</a></span></tt>
741
+
742
+
743
+
744
+
745
+
746
+ </h3><div class="docstring">
747
+ <div class="discussion">
748
+ <p>Returns a new instance of Field.</p>
749
+
750
+ </div>
751
+ </div>
752
+ <div class="tags">
753
+
754
+
755
+ </div><table class="source_code">
756
+ <tr>
757
+ <td>
758
+ <pre class="lines">
759
+
760
+
761
+ 51
762
+ 52
763
+ 53
764
+ 54
765
+ 55
766
+ 56
767
+ 57
768
+ 58
769
+ 59
770
+ 60
771
+ 61
772
+ 62
773
+ 63
774
+ 64
775
+ 65</pre>
776
+ </td>
777
+ <td>
778
+ <pre class="code"><span class="info file"># File 'lib/kabk/field.rb', line 51</span>
779
+
780
+ <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='label'>name:</span><span class='comma'>,</span> <span class='op'>**</span><span class='id identifier rubyid_attributes'>attributes</span><span class='rparen'>)</span>
781
+ <span class='ivar'>@name</span> <span class='op'>=</span> <span class='id identifier rubyid_name'>name</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span>
782
+ <span class='ivar'>@primary_key</span> <span class='op'>=</span> <span class='kw'>false</span>
783
+ <span class='ivar'>@nullable</span> <span class='op'>=</span> <span class='kw'>false</span>
784
+ <span class='ivar'>@col_width</span> <span class='op'>=</span> <span class='int'>12</span>
785
+ <span class='ivar'>@required</span> <span class='op'>=</span> <span class='kw'>false</span>
786
+ <span class='ivar'>@readonly</span> <span class='op'>=</span> <span class='kw'>false</span>
787
+ <span class='ivar'>@hidden_in_table</span> <span class='op'>=</span> <span class='kw'>false</span>
788
+ <span class='ivar'>@hidden_in_form</span> <span class='op'>=</span> <span class='kw'>false</span>
789
+ <span class='ivar'>@accordion</span> <span class='op'>=</span> <span class='kw'>false</span>
790
+
791
+ <span class='id identifier rubyid_attributes'>attributes</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_k'>k</span><span class='comma'>,</span> <span class='id identifier rubyid_v'>v</span><span class='op'>|</span>
792
+ <span class='id identifier rubyid_send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_k'>k</span><span class='embexpr_end'>}</span><span class='tstring_content'>=</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_v'>v</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id identifier rubyid_respond_to?'>respond_to?</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_k'>k</span><span class='embexpr_end'>}</span><span class='tstring_content'>=</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
793
+ <span class='kw'>end</span>
794
+ <span class='kw'>end</span></pre>
795
+ </td>
796
+ </tr>
797
+ </table>
798
+ </div>
799
+
800
+ </div>
801
+
802
+ <div id="instance_attr_details" class="attr_details">
803
+ <h2>Instance Attribute Details</h2>
804
+
805
+
806
+ <span id="accordion=-instance_method"></span>
807
+ <div class="method_details first">
808
+ <h3 class="signature first" id="accordion-instance_method">
809
+
810
+ #<strong>accordion</strong> &#x21d2; <tt>Boolean</tt>
811
+
812
+
813
+
814
+
815
+
816
+ </h3><div class="docstring">
817
+ <div class="discussion">
818
+ <p>Returns If true, wraps this field in an accordion section.</p>
819
+
820
+ </div>
821
+ </div>
822
+ <div class="tags">
823
+
824
+ <p class="tag_title">Returns:</p>
825
+ <ul class="return">
826
+
827
+ <li>
828
+
829
+
830
+ <span class='type'>(<tt>Boolean</tt>)</span>
831
+
832
+
833
+
834
+ &mdash;
835
+ <div class='inline'><p>If true, wraps this field in an accordion section.</p></div>
836
+
837
+ </li>
838
+
839
+ </ul>
840
+
841
+ </div><table class="source_code">
842
+ <tr>
843
+ <td>
844
+ <pre class="lines">
845
+
846
+
847
+ 35
848
+ 36
849
+ 37</pre>
850
+ </td>
851
+ <td>
852
+ <pre class="code"><span class="info file"># File 'lib/kabk/field.rb', line 35</span>
853
+
854
+ <span class='kw'>def</span> <span class='id identifier rubyid_accordion'>accordion</span>
855
+ <span class='ivar'>@accordion</span>
856
+ <span class='kw'>end</span></pre>
857
+ </td>
858
+ </tr>
859
+ </table>
860
+ </div>
861
+
862
+
863
+ <span id="calendar=-instance_method"></span>
864
+ <div class="method_details ">
865
+ <h3 class="signature " id="calendar-instance_method">
866
+
867
+ #<strong>calendar</strong> &#x21d2; <tt>Symbol</tt>
868
+
869
+
870
+
871
+
872
+
873
+ </h3><div class="docstring">
874
+ <div class="discussion">
875
+ <p>Returns The calendar system to use if type is date/datetime (e.g., :jalali, :gregorian).</p>
876
+
877
+ </div>
878
+ </div>
879
+ <div class="tags">
880
+
881
+ <p class="tag_title">Returns:</p>
882
+ <ul class="return">
883
+
884
+ <li>
885
+
886
+
887
+ <span class='type'>(<tt>Symbol</tt>)</span>
888
+
889
+
890
+
891
+ &mdash;
892
+ <div class='inline'><p>The calendar system to use if type is date/datetime (e.g., :jalali, :gregorian).</p></div>
893
+
894
+ </li>
895
+
896
+ </ul>
897
+
898
+ </div><table class="source_code">
899
+ <tr>
900
+ <td>
901
+ <pre class="lines">
902
+
903
+
904
+ 15
905
+ 16
906
+ 17</pre>
907
+ </td>
908
+ <td>
909
+ <pre class="code"><span class="info file"># File 'lib/kabk/field.rb', line 15</span>
910
+
911
+ <span class='kw'>def</span> <span class='id identifier rubyid_calendar'>calendar</span>
912
+ <span class='ivar'>@calendar</span>
913
+ <span class='kw'>end</span></pre>
914
+ </td>
915
+ </tr>
916
+ </table>
917
+ </div>
918
+
919
+
920
+ <span id="col_width=-instance_method"></span>
921
+ <div class="method_details ">
922
+ <h3 class="signature " id="col_width-instance_method">
923
+
924
+ #<strong>col_width</strong> &#x21d2; <tt>Integer</tt>
925
+
926
+
927
+
928
+
929
+
930
+ </h3><div class="docstring">
931
+ <div class="discussion">
932
+ <p>Returns Bootstrap grid column width (1 to 12).</p>
933
+
934
+ </div>
935
+ </div>
936
+ <div class="tags">
937
+
938
+ <p class="tag_title">Returns:</p>
939
+ <ul class="return">
940
+
941
+ <li>
942
+
943
+
944
+ <span class='type'>(<tt>Integer</tt>)</span>
945
+
946
+
947
+
948
+ &mdash;
949
+ <div class='inline'><p>Bootstrap grid column width (1 to 12).</p></div>
950
+
951
+ </li>
952
+
953
+ </ul>
954
+
955
+ </div><table class="source_code">
956
+ <tr>
957
+ <td>
958
+ <pre class="lines">
959
+
960
+
961
+ 23
962
+ 24
963
+ 25</pre>
964
+ </td>
965
+ <td>
966
+ <pre class="code"><span class="info file"># File 'lib/kabk/field.rb', line 23</span>
967
+
968
+ <span class='kw'>def</span> <span class='id identifier rubyid_col_width'>col_width</span>
969
+ <span class='ivar'>@col_width</span>
970
+ <span class='kw'>end</span></pre>
971
+ </td>
972
+ </tr>
973
+ </table>
974
+ </div>
975
+
976
+
977
+ <span id="default_value=-instance_method"></span>
978
+ <div class="method_details ">
979
+ <h3 class="signature " id="default_value-instance_method">
980
+
981
+ #<strong>default_value</strong> &#x21d2; <tt>Object</tt>
982
+
983
+
984
+
985
+
986
+
987
+ </h3><div class="docstring">
988
+ <div class="discussion">
989
+ <p>Returns The default value for the field.</p>
990
+
991
+ </div>
992
+ </div>
993
+ <div class="tags">
994
+
995
+ <p class="tag_title">Returns:</p>
996
+ <ul class="return">
997
+
998
+ <li>
999
+
1000
+
1001
+ <span class='type'>(<tt>Object</tt>)</span>
1002
+
1003
+
1004
+
1005
+ &mdash;
1006
+ <div class='inline'><p>The default value for the field.</p></div>
1007
+
1008
+ </li>
1009
+
1010
+ </ul>
1011
+
1012
+ </div><table class="source_code">
1013
+ <tr>
1014
+ <td>
1015
+ <pre class="lines">
1016
+
1017
+
1018
+ 41
1019
+ 42
1020
+ 43</pre>
1021
+ </td>
1022
+ <td>
1023
+ <pre class="code"><span class="info file"># File 'lib/kabk/field.rb', line 41</span>
1024
+
1025
+ <span class='kw'>def</span> <span class='id identifier rubyid_default_value'>default_value</span>
1026
+ <span class='ivar'>@default_value</span>
1027
+ <span class='kw'>end</span></pre>
1028
+ </td>
1029
+ </tr>
1030
+ </table>
1031
+ </div>
1032
+
1033
+
1034
+ <span id="depends_on=-instance_method"></span>
1035
+ <div class="method_details ">
1036
+ <h3 class="signature " id="depends_on-instance_method">
1037
+
1038
+ #<strong>depends_on</strong> &#x21d2; <tt>Hash</tt>
1039
+
1040
+
1041
+
1042
+
1043
+
1044
+ </h3><div class="docstring">
1045
+ <div class="discussion">
1046
+ <p>Returns Configures field dependency visibility (e.g., { field: &quot;published&quot;, value: true }).</p>
1047
+
1048
+ </div>
1049
+ </div>
1050
+ <div class="tags">
1051
+
1052
+ <p class="tag_title">Returns:</p>
1053
+ <ul class="return">
1054
+
1055
+ <li>
1056
+
1057
+
1058
+ <span class='type'>(<tt>Hash</tt>)</span>
1059
+
1060
+
1061
+
1062
+ &mdash;
1063
+ <div class='inline'><p>Configures field dependency visibility (e.g., { field: &quot;published&quot;, value: true }).</p></div>
1064
+
1065
+ </li>
1066
+
1067
+ </ul>
1068
+
1069
+ </div><table class="source_code">
1070
+ <tr>
1071
+ <td>
1072
+ <pre class="lines">
1073
+
1074
+
1075
+ 43
1076
+ 44
1077
+ 45</pre>
1078
+ </td>
1079
+ <td>
1080
+ <pre class="code"><span class="info file"># File 'lib/kabk/field.rb', line 43</span>
1081
+
1082
+ <span class='kw'>def</span> <span class='id identifier rubyid_depends_on'>depends_on</span>
1083
+ <span class='ivar'>@depends_on</span>
1084
+ <span class='kw'>end</span></pre>
1085
+ </td>
1086
+ </tr>
1087
+ </table>
1088
+ </div>
1089
+
1090
+
1091
+ <span id="display_as=-instance_method"></span>
1092
+ <div class="method_details ">
1093
+ <h3 class="signature " id="display_as-instance_method">
1094
+
1095
+ #<strong>display_as</strong> &#x21d2; <tt>Symbol</tt>
1096
+
1097
+
1098
+
1099
+
1100
+
1101
+ </h3><div class="docstring">
1102
+ <div class="discussion">
1103
+ <p>Returns UI hint for how to display the value (e.g., :badge, :thumbnail, :boolean_icon).</p>
1104
+
1105
+ </div>
1106
+ </div>
1107
+ <div class="tags">
1108
+
1109
+ <p class="tag_title">Returns:</p>
1110
+ <ul class="return">
1111
+
1112
+ <li>
1113
+
1114
+
1115
+ <span class='type'>(<tt>Symbol</tt>)</span>
1116
+
1117
+
1118
+
1119
+ &mdash;
1120
+ <div class='inline'><p>UI hint for how to display the value (e.g., :badge, :thumbnail, :boolean_icon).</p></div>
1121
+
1122
+ </li>
1123
+
1124
+ </ul>
1125
+
1126
+ </div><table class="source_code">
1127
+ <tr>
1128
+ <td>
1129
+ <pre class="lines">
1130
+
1131
+
1132
+ 21
1133
+ 22
1134
+ 23</pre>
1135
+ </td>
1136
+ <td>
1137
+ <pre class="code"><span class="info file"># File 'lib/kabk/field.rb', line 21</span>
1138
+
1139
+ <span class='kw'>def</span> <span class='id identifier rubyid_display_as'>display_as</span>
1140
+ <span class='ivar'>@display_as</span>
1141
+ <span class='kw'>end</span></pre>
1142
+ </td>
1143
+ </tr>
1144
+ </table>
1145
+ </div>
1146
+
1147
+
1148
+ <span id="form_type=-instance_method"></span>
1149
+ <div class="method_details ">
1150
+ <h3 class="signature " id="form_type-instance_method">
1151
+
1152
+ #<strong>form_type</strong> &#x21d2; <tt>Symbol</tt>
1153
+
1154
+
1155
+
1156
+
1157
+
1158
+ </h3><div class="docstring">
1159
+ <div class="discussion">
1160
+ <p>Returns The frontend input component type (e.g., :text, :switch, :date, :image_single).</p>
1161
+
1162
+ </div>
1163
+ </div>
1164
+ <div class="tags">
1165
+
1166
+ <p class="tag_title">Returns:</p>
1167
+ <ul class="return">
1168
+
1169
+ <li>
1170
+
1171
+
1172
+ <span class='type'>(<tt>Symbol</tt>)</span>
1173
+
1174
+
1175
+
1176
+ &mdash;
1177
+ <div class='inline'><p>The frontend input component type (e.g., :text, :switch, :date, :image_single).</p></div>
1178
+
1179
+ </li>
1180
+
1181
+ </ul>
1182
+
1183
+ </div><table class="source_code">
1184
+ <tr>
1185
+ <td>
1186
+ <pre class="lines">
1187
+
1188
+
1189
+ 13
1190
+ 14
1191
+ 15</pre>
1192
+ </td>
1193
+ <td>
1194
+ <pre class="code"><span class="info file"># File 'lib/kabk/field.rb', line 13</span>
1195
+
1196
+ <span class='kw'>def</span> <span class='id identifier rubyid_form_type'>form_type</span>
1197
+ <span class='ivar'>@form_type</span>
1198
+ <span class='kw'>end</span></pre>
1199
+ </td>
1200
+ </tr>
1201
+ </table>
1202
+ </div>
1203
+
1204
+
1205
+ <span id="hidden_in_form=-instance_method"></span>
1206
+ <div class="method_details ">
1207
+ <h3 class="signature " id="hidden_in_form-instance_method">
1208
+
1209
+ #<strong>hidden_in_form</strong> &#x21d2; <tt>Boolean</tt>
1210
+
1211
+
1212
+
1213
+
1214
+
1215
+ </h3><div class="docstring">
1216
+ <div class="discussion">
1217
+ <p>Returns If true, hides the field in forms.</p>
1218
+
1219
+ </div>
1220
+ </div>
1221
+ <div class="tags">
1222
+
1223
+ <p class="tag_title">Returns:</p>
1224
+ <ul class="return">
1225
+
1226
+ <li>
1227
+
1228
+
1229
+ <span class='type'>(<tt>Boolean</tt>)</span>
1230
+
1231
+
1232
+
1233
+ &mdash;
1234
+ <div class='inline'><p>If true, hides the field in forms.</p></div>
1235
+
1236
+ </li>
1237
+
1238
+ </ul>
1239
+
1240
+ </div><table class="source_code">
1241
+ <tr>
1242
+ <td>
1243
+ <pre class="lines">
1244
+
1245
+
1246
+ 33
1247
+ 34
1248
+ 35</pre>
1249
+ </td>
1250
+ <td>
1251
+ <pre class="code"><span class="info file"># File 'lib/kabk/field.rb', line 33</span>
1252
+
1253
+ <span class='kw'>def</span> <span class='id identifier rubyid_hidden_in_form'>hidden_in_form</span>
1254
+ <span class='ivar'>@hidden_in_form</span>
1255
+ <span class='kw'>end</span></pre>
1256
+ </td>
1257
+ </tr>
1258
+ </table>
1259
+ </div>
1260
+
1261
+
1262
+ <span id="hidden_in_table=-instance_method"></span>
1263
+ <div class="method_details ">
1264
+ <h3 class="signature " id="hidden_in_table-instance_method">
1265
+
1266
+ #<strong>hidden_in_table</strong> &#x21d2; <tt>Boolean</tt>
1267
+
1268
+
1269
+
1270
+
1271
+
1272
+ </h3><div class="docstring">
1273
+ <div class="discussion">
1274
+ <p>Returns If true, hides the field in data tables.</p>
1275
+
1276
+ </div>
1277
+ </div>
1278
+ <div class="tags">
1279
+
1280
+ <p class="tag_title">Returns:</p>
1281
+ <ul class="return">
1282
+
1283
+ <li>
1284
+
1285
+
1286
+ <span class='type'>(<tt>Boolean</tt>)</span>
1287
+
1288
+
1289
+
1290
+ &mdash;
1291
+ <div class='inline'><p>If true, hides the field in data tables.</p></div>
1292
+
1293
+ </li>
1294
+
1295
+ </ul>
1296
+
1297
+ </div><table class="source_code">
1298
+ <tr>
1299
+ <td>
1300
+ <pre class="lines">
1301
+
1302
+
1303
+ 31
1304
+ 32
1305
+ 33</pre>
1306
+ </td>
1307
+ <td>
1308
+ <pre class="code"><span class="info file"># File 'lib/kabk/field.rb', line 31</span>
1309
+
1310
+ <span class='kw'>def</span> <span class='id identifier rubyid_hidden_in_table'>hidden_in_table</span>
1311
+ <span class='ivar'>@hidden_in_table</span>
1312
+ <span class='kw'>end</span></pre>
1313
+ </td>
1314
+ </tr>
1315
+ </table>
1316
+ </div>
1317
+
1318
+
1319
+ <span id="label=-instance_method"></span>
1320
+ <div class="method_details ">
1321
+ <h3 class="signature " id="label-instance_method">
1322
+
1323
+ #<strong>label</strong> &#x21d2; <tt>String</tt>
1324
+
1325
+
1326
+
1327
+
1328
+
1329
+ </h3><div class="docstring">
1330
+ <div class="discussion">
1331
+ <p>Returns The human-readable label for the field.</p>
1332
+
1333
+ </div>
1334
+ </div>
1335
+ <div class="tags">
1336
+
1337
+ <p class="tag_title">Returns:</p>
1338
+ <ul class="return">
1339
+
1340
+ <li>
1341
+
1342
+
1343
+ <span class='type'>(<tt>String</tt>)</span>
1344
+
1345
+
1346
+
1347
+ &mdash;
1348
+ <div class='inline'><p>The human-readable label for the field.</p></div>
1349
+
1350
+ </li>
1351
+
1352
+ </ul>
1353
+
1354
+ </div><table class="source_code">
1355
+ <tr>
1356
+ <td>
1357
+ <pre class="lines">
1358
+
1359
+
1360
+ 9
1361
+ 10
1362
+ 11</pre>
1363
+ </td>
1364
+ <td>
1365
+ <pre class="code"><span class="info file"># File 'lib/kabk/field.rb', line 9</span>
1366
+
1367
+ <span class='kw'>def</span> <span class='id identifier rubyid_label'>label</span>
1368
+ <span class='ivar'>@label</span>
1369
+ <span class='kw'>end</span></pre>
1370
+ </td>
1371
+ </tr>
1372
+ </table>
1373
+ </div>
1374
+
1375
+
1376
+ <span id="name=-instance_method"></span>
1377
+ <div class="method_details ">
1378
+ <h3 class="signature " id="name-instance_method">
1379
+
1380
+ #<strong>name</strong> &#x21d2; <tt>String</tt>
1381
+
1382
+
1383
+
1384
+
1385
+
1386
+ </h3><div class="docstring">
1387
+ <div class="discussion">
1388
+ <p>Returns The technical name of the field (e.g., &quot;created_at&quot;).</p>
1389
+
1390
+ </div>
1391
+ </div>
1392
+ <div class="tags">
1393
+
1394
+ <p class="tag_title">Returns:</p>
1395
+ <ul class="return">
1396
+
1397
+ <li>
1398
+
1399
+
1400
+ <span class='type'>(<tt>String</tt>)</span>
1401
+
1402
+
1403
+
1404
+ &mdash;
1405
+ <div class='inline'><p>The technical name of the field (e.g., &quot;created_at&quot;).</p></div>
1406
+
1407
+ </li>
1408
+
1409
+ </ul>
1410
+
1411
+ </div><table class="source_code">
1412
+ <tr>
1413
+ <td>
1414
+ <pre class="lines">
1415
+
1416
+
1417
+ 7
1418
+ 8
1419
+ 9</pre>
1420
+ </td>
1421
+ <td>
1422
+ <pre class="code"><span class="info file"># File 'lib/kabk/field.rb', line 7</span>
1423
+
1424
+ <span class='kw'>def</span> <span class='id identifier rubyid_name'>name</span>
1425
+ <span class='ivar'>@name</span>
1426
+ <span class='kw'>end</span></pre>
1427
+ </td>
1428
+ </tr>
1429
+ </table>
1430
+ </div>
1431
+
1432
+
1433
+ <span id="nullable=-instance_method"></span>
1434
+ <div class="method_details ">
1435
+ <h3 class="signature " id="nullable-instance_method">
1436
+
1437
+ #<strong>nullable</strong> &#x21d2; <tt>Boolean</tt>
1438
+
1439
+
1440
+
1441
+
1442
+
1443
+ </h3><div class="docstring">
1444
+ <div class="discussion">
1445
+ <p>Returns Indicates if this field can be null.</p>
1446
+
1447
+ </div>
1448
+ </div>
1449
+ <div class="tags">
1450
+
1451
+ <p class="tag_title">Returns:</p>
1452
+ <ul class="return">
1453
+
1454
+ <li>
1455
+
1456
+
1457
+ <span class='type'>(<tt>Boolean</tt>)</span>
1458
+
1459
+
1460
+
1461
+ &mdash;
1462
+ <div class='inline'><p>Indicates if this field can be null.</p></div>
1463
+
1464
+ </li>
1465
+
1466
+ </ul>
1467
+
1468
+ </div><table class="source_code">
1469
+ <tr>
1470
+ <td>
1471
+ <pre class="lines">
1472
+
1473
+
1474
+ 19
1475
+ 20
1476
+ 21</pre>
1477
+ </td>
1478
+ <td>
1479
+ <pre class="code"><span class="info file"># File 'lib/kabk/field.rb', line 19</span>
1480
+
1481
+ <span class='kw'>def</span> <span class='id identifier rubyid_nullable'>nullable</span>
1482
+ <span class='ivar'>@nullable</span>
1483
+ <span class='kw'>end</span></pre>
1484
+ </td>
1485
+ </tr>
1486
+ </table>
1487
+ </div>
1488
+
1489
+
1490
+ <span id="options=-instance_method"></span>
1491
+ <div class="method_details ">
1492
+ <h3 class="signature " id="options-instance_method">
1493
+
1494
+ #<strong>options</strong> &#x21d2; <tt>Array</tt>, <tt>Hash</tt>
1495
+
1496
+
1497
+
1498
+
1499
+
1500
+ </h3><div class="docstring">
1501
+ <div class="discussion">
1502
+ <p>Returns Hardcoded select options if applicable.</p>
1503
+
1504
+ </div>
1505
+ </div>
1506
+ <div class="tags">
1507
+
1508
+ <p class="tag_title">Returns:</p>
1509
+ <ul class="return">
1510
+
1511
+ <li>
1512
+
1513
+
1514
+ <span class='type'>(<tt>Array</tt>, <tt>Hash</tt>)</span>
1515
+
1516
+
1517
+
1518
+ &mdash;
1519
+ <div class='inline'><p>Hardcoded select options if applicable.</p></div>
1520
+
1521
+ </li>
1522
+
1523
+ </ul>
1524
+
1525
+ </div><table class="source_code">
1526
+ <tr>
1527
+ <td>
1528
+ <pre class="lines">
1529
+
1530
+
1531
+ 39
1532
+ 40
1533
+ 41</pre>
1534
+ </td>
1535
+ <td>
1536
+ <pre class="code"><span class="info file"># File 'lib/kabk/field.rb', line 39</span>
1537
+
1538
+ <span class='kw'>def</span> <span class='id identifier rubyid_options'>options</span>
1539
+ <span class='ivar'>@options</span>
1540
+ <span class='kw'>end</span></pre>
1541
+ </td>
1542
+ </tr>
1543
+ </table>
1544
+ </div>
1545
+
1546
+
1547
+ <span id="order=-instance_method"></span>
1548
+ <div class="method_details ">
1549
+ <h3 class="signature " id="order-instance_method">
1550
+
1551
+ #<strong>order</strong> &#x21d2; <tt>Integer</tt>
1552
+
1553
+
1554
+
1555
+
1556
+
1557
+ </h3><div class="docstring">
1558
+ <div class="discussion">
1559
+ <p>Returns The explicit ordering weight for rendering.</p>
1560
+
1561
+ </div>
1562
+ </div>
1563
+ <div class="tags">
1564
+
1565
+ <p class="tag_title">Returns:</p>
1566
+ <ul class="return">
1567
+
1568
+ <li>
1569
+
1570
+
1571
+ <span class='type'>(<tt>Integer</tt>)</span>
1572
+
1573
+
1574
+
1575
+ &mdash;
1576
+ <div class='inline'><p>The explicit ordering weight for rendering.</p></div>
1577
+
1578
+ </li>
1579
+
1580
+ </ul>
1581
+
1582
+ </div><table class="source_code">
1583
+ <tr>
1584
+ <td>
1585
+ <pre class="lines">
1586
+
1587
+
1588
+ 25
1589
+ 26
1590
+ 27</pre>
1591
+ </td>
1592
+ <td>
1593
+ <pre class="code"><span class="info file"># File 'lib/kabk/field.rb', line 25</span>
1594
+
1595
+ <span class='kw'>def</span> <span class='id identifier rubyid_order'>order</span>
1596
+ <span class='ivar'>@order</span>
1597
+ <span class='kw'>end</span></pre>
1598
+ </td>
1599
+ </tr>
1600
+ </table>
1601
+ </div>
1602
+
1603
+
1604
+ <span id="primary_key=-instance_method"></span>
1605
+ <div class="method_details ">
1606
+ <h3 class="signature " id="primary_key-instance_method">
1607
+
1608
+ #<strong>primary_key</strong> &#x21d2; <tt>Boolean</tt>
1609
+
1610
+
1611
+
1612
+
1613
+
1614
+ </h3><div class="docstring">
1615
+ <div class="discussion">
1616
+ <p>Returns Indicates if this field is the primary key.</p>
1617
+
1618
+ </div>
1619
+ </div>
1620
+ <div class="tags">
1621
+
1622
+ <p class="tag_title">Returns:</p>
1623
+ <ul class="return">
1624
+
1625
+ <li>
1626
+
1627
+
1628
+ <span class='type'>(<tt>Boolean</tt>)</span>
1629
+
1630
+
1631
+
1632
+ &mdash;
1633
+ <div class='inline'><p>Indicates if this field is the primary key.</p></div>
1634
+
1635
+ </li>
1636
+
1637
+ </ul>
1638
+
1639
+ </div><table class="source_code">
1640
+ <tr>
1641
+ <td>
1642
+ <pre class="lines">
1643
+
1644
+
1645
+ 17
1646
+ 18
1647
+ 19</pre>
1648
+ </td>
1649
+ <td>
1650
+ <pre class="code"><span class="info file"># File 'lib/kabk/field.rb', line 17</span>
1651
+
1652
+ <span class='kw'>def</span> <span class='id identifier rubyid_primary_key'>primary_key</span>
1653
+ <span class='ivar'>@primary_key</span>
1654
+ <span class='kw'>end</span></pre>
1655
+ </td>
1656
+ </tr>
1657
+ </table>
1658
+ </div>
1659
+
1660
+
1661
+ <span id="readonly=-instance_method"></span>
1662
+ <div class="method_details ">
1663
+ <h3 class="signature " id="readonly-instance_method">
1664
+
1665
+ #<strong>readonly</strong> &#x21d2; <tt>Boolean</tt>
1666
+
1667
+
1668
+
1669
+
1670
+
1671
+ </h3><div class="docstring">
1672
+ <div class="discussion">
1673
+ <p>Returns Indicates if this field is read-only.</p>
1674
+
1675
+ </div>
1676
+ </div>
1677
+ <div class="tags">
1678
+
1679
+ <p class="tag_title">Returns:</p>
1680
+ <ul class="return">
1681
+
1682
+ <li>
1683
+
1684
+
1685
+ <span class='type'>(<tt>Boolean</tt>)</span>
1686
+
1687
+
1688
+
1689
+ &mdash;
1690
+ <div class='inline'><p>Indicates if this field is read-only.</p></div>
1691
+
1692
+ </li>
1693
+
1694
+ </ul>
1695
+
1696
+ </div><table class="source_code">
1697
+ <tr>
1698
+ <td>
1699
+ <pre class="lines">
1700
+
1701
+
1702
+ 29
1703
+ 30
1704
+ 31</pre>
1705
+ </td>
1706
+ <td>
1707
+ <pre class="code"><span class="info file"># File 'lib/kabk/field.rb', line 29</span>
1708
+
1709
+ <span class='kw'>def</span> <span class='id identifier rubyid_readonly'>readonly</span>
1710
+ <span class='ivar'>@readonly</span>
1711
+ <span class='kw'>end</span></pre>
1712
+ </td>
1713
+ </tr>
1714
+ </table>
1715
+ </div>
1716
+
1717
+
1718
+ <span id="relation=-instance_method"></span>
1719
+ <div class="method_details ">
1720
+ <h3 class="signature " id="relation-instance_method">
1721
+
1722
+ #<strong>relation</strong> &#x21d2; <tt>Hash</tt>
1723
+
1724
+
1725
+
1726
+
1727
+
1728
+ </h3><div class="docstring">
1729
+ <div class="discussion">
1730
+ <p>Returns Relational metadata (e.g., { resource: &quot;user&quot;, cardinality: &quot;many_to_one&quot;, ... }).</p>
1731
+
1732
+ </div>
1733
+ </div>
1734
+ <div class="tags">
1735
+
1736
+ <p class="tag_title">Returns:</p>
1737
+ <ul class="return">
1738
+
1739
+ <li>
1740
+
1741
+
1742
+ <span class='type'>(<tt>Hash</tt>)</span>
1743
+
1744
+
1745
+
1746
+ &mdash;
1747
+ <div class='inline'><p>Relational metadata (e.g., { resource: &quot;user&quot;, cardinality: &quot;many_to_one&quot;, ... }).</p></div>
1748
+
1749
+ </li>
1750
+
1751
+ </ul>
1752
+
1753
+ </div><table class="source_code">
1754
+ <tr>
1755
+ <td>
1756
+ <pre class="lines">
1757
+
1758
+
1759
+ 47
1760
+ 48
1761
+ 49</pre>
1762
+ </td>
1763
+ <td>
1764
+ <pre class="code"><span class="info file"># File 'lib/kabk/field.rb', line 47</span>
1765
+
1766
+ <span class='kw'>def</span> <span class='id identifier rubyid_relation'>relation</span>
1767
+ <span class='ivar'>@relation</span>
1768
+ <span class='kw'>end</span></pre>
1769
+ </td>
1770
+ </tr>
1771
+ </table>
1772
+ </div>
1773
+
1774
+
1775
+ <span id="required=-instance_method"></span>
1776
+ <div class="method_details ">
1777
+ <h3 class="signature " id="required-instance_method">
1778
+
1779
+ #<strong>required</strong> &#x21d2; <tt>Boolean</tt>
1780
+
1781
+
1782
+
1783
+
1784
+
1785
+ </h3><div class="docstring">
1786
+ <div class="discussion">
1787
+ <p>Returns Indicates if this field is mandatory in forms.</p>
1788
+
1789
+ </div>
1790
+ </div>
1791
+ <div class="tags">
1792
+
1793
+ <p class="tag_title">Returns:</p>
1794
+ <ul class="return">
1795
+
1796
+ <li>
1797
+
1798
+
1799
+ <span class='type'>(<tt>Boolean</tt>)</span>
1800
+
1801
+
1802
+
1803
+ &mdash;
1804
+ <div class='inline'><p>Indicates if this field is mandatory in forms.</p></div>
1805
+
1806
+ </li>
1807
+
1808
+ </ul>
1809
+
1810
+ </div><table class="source_code">
1811
+ <tr>
1812
+ <td>
1813
+ <pre class="lines">
1814
+
1815
+
1816
+ 27
1817
+ 28
1818
+ 29</pre>
1819
+ </td>
1820
+ <td>
1821
+ <pre class="code"><span class="info file"># File 'lib/kabk/field.rb', line 27</span>
1822
+
1823
+ <span class='kw'>def</span> <span class='id identifier rubyid_required'>required</span>
1824
+ <span class='ivar'>@required</span>
1825
+ <span class='kw'>end</span></pre>
1826
+ </td>
1827
+ </tr>
1828
+ </table>
1829
+ </div>
1830
+
1831
+
1832
+ <span id="rows=-instance_method"></span>
1833
+ <div class="method_details ">
1834
+ <h3 class="signature " id="rows-instance_method">
1835
+
1836
+ #<strong>rows</strong> &#x21d2; <tt>Integer</tt>
1837
+
1838
+
1839
+
1840
+
1841
+
1842
+ </h3><div class="docstring">
1843
+ <div class="discussion">
1844
+ <p>Returns For textarea form_type, specifies the number of rows.</p>
1845
+
1846
+ </div>
1847
+ </div>
1848
+ <div class="tags">
1849
+
1850
+ <p class="tag_title">Returns:</p>
1851
+ <ul class="return">
1852
+
1853
+ <li>
1854
+
1855
+
1856
+ <span class='type'>(<tt>Integer</tt>)</span>
1857
+
1858
+
1859
+
1860
+ &mdash;
1861
+ <div class='inline'><p>For textarea form_type, specifies the number of rows.</p></div>
1862
+
1863
+ </li>
1864
+
1865
+ </ul>
1866
+
1867
+ </div><table class="source_code">
1868
+ <tr>
1869
+ <td>
1870
+ <pre class="lines">
1871
+
1872
+
1873
+ 37
1874
+ 38
1875
+ 39</pre>
1876
+ </td>
1877
+ <td>
1878
+ <pre class="code"><span class="info file"># File 'lib/kabk/field.rb', line 37</span>
1879
+
1880
+ <span class='kw'>def</span> <span class='id identifier rubyid_rows'>rows</span>
1881
+ <span class='ivar'>@rows</span>
1882
+ <span class='kw'>end</span></pre>
1883
+ </td>
1884
+ </tr>
1885
+ </table>
1886
+ </div>
1887
+
1888
+
1889
+ <span id="type=-instance_method"></span>
1890
+ <div class="method_details ">
1891
+ <h3 class="signature " id="type-instance_method">
1892
+
1893
+ #<strong>type</strong> &#x21d2; <tt>Symbol</tt>
1894
+
1895
+
1896
+
1897
+
1898
+
1899
+ </h3><div class="docstring">
1900
+ <div class="discussion">
1901
+ <p>Returns The underlying data type (:string, :number, :boolean, :date, :datetime, :file, :relation).</p>
1902
+
1903
+ </div>
1904
+ </div>
1905
+ <div class="tags">
1906
+
1907
+ <p class="tag_title">Returns:</p>
1908
+ <ul class="return">
1909
+
1910
+ <li>
1911
+
1912
+
1913
+ <span class='type'>(<tt>Symbol</tt>)</span>
1914
+
1915
+
1916
+
1917
+ &mdash;
1918
+ <div class='inline'><p>The underlying data type (:string, :number, :boolean, :date, :datetime, :file, :relation).</p></div>
1919
+
1920
+ </li>
1921
+
1922
+ </ul>
1923
+
1924
+ </div><table class="source_code">
1925
+ <tr>
1926
+ <td>
1927
+ <pre class="lines">
1928
+
1929
+
1930
+ 11
1931
+ 12
1932
+ 13</pre>
1933
+ </td>
1934
+ <td>
1935
+ <pre class="code"><span class="info file"># File 'lib/kabk/field.rb', line 11</span>
1936
+
1937
+ <span class='kw'>def</span> <span class='id identifier rubyid_type'>type</span>
1938
+ <span class='ivar'>@type</span>
1939
+ <span class='kw'>end</span></pre>
1940
+ </td>
1941
+ </tr>
1942
+ </table>
1943
+ </div>
1944
+
1945
+
1946
+ <span id="upload_config=-instance_method"></span>
1947
+ <div class="method_details ">
1948
+ <h3 class="signature " id="upload_config-instance_method">
1949
+
1950
+ #<strong>upload_config</strong> &#x21d2; <tt>Hash</tt>
1951
+
1952
+
1953
+
1954
+
1955
+
1956
+ </h3><div class="docstring">
1957
+ <div class="discussion">
1958
+ <p>Returns Configuration for file uploads.</p>
1959
+
1960
+ </div>
1961
+ </div>
1962
+ <div class="tags">
1963
+
1964
+ <p class="tag_title">Returns:</p>
1965
+ <ul class="return">
1966
+
1967
+ <li>
1968
+
1969
+
1970
+ <span class='type'>(<tt>Hash</tt>)</span>
1971
+
1972
+
1973
+
1974
+ &mdash;
1975
+ <div class='inline'><p>Configuration for file uploads.</p></div>
1976
+
1977
+ </li>
1978
+
1979
+ </ul>
1980
+
1981
+ </div><table class="source_code">
1982
+ <tr>
1983
+ <td>
1984
+ <pre class="lines">
1985
+
1986
+
1987
+ 49
1988
+ 50
1989
+ 51</pre>
1990
+ </td>
1991
+ <td>
1992
+ <pre class="code"><span class="info file"># File 'lib/kabk/field.rb', line 49</span>
1993
+
1994
+ <span class='kw'>def</span> <span class='id identifier rubyid_upload_config'>upload_config</span>
1995
+ <span class='ivar'>@upload_config</span>
1996
+ <span class='kw'>end</span></pre>
1997
+ </td>
1998
+ </tr>
1999
+ </table>
2000
+ </div>
2001
+
2002
+
2003
+ <span id="validation=-instance_method"></span>
2004
+ <div class="method_details ">
2005
+ <h3 class="signature " id="validation-instance_method">
2006
+
2007
+ #<strong>validation</strong> &#x21d2; <tt>Hash</tt>
2008
+
2009
+
2010
+
2011
+
2012
+
2013
+ </h3><div class="docstring">
2014
+ <div class="discussion">
2015
+ <p>Returns Server-side validation rules (e.g., { min_length: 5, unique: true }).</p>
2016
+
2017
+ </div>
2018
+ </div>
2019
+ <div class="tags">
2020
+
2021
+ <p class="tag_title">Returns:</p>
2022
+ <ul class="return">
2023
+
2024
+ <li>
2025
+
2026
+
2027
+ <span class='type'>(<tt>Hash</tt>)</span>
2028
+
2029
+
2030
+
2031
+ &mdash;
2032
+ <div class='inline'><p>Server-side validation rules (e.g., { min_length: 5, unique: true }).</p></div>
2033
+
2034
+ </li>
2035
+
2036
+ </ul>
2037
+
2038
+ </div><table class="source_code">
2039
+ <tr>
2040
+ <td>
2041
+ <pre class="lines">
2042
+
2043
+
2044
+ 45
2045
+ 46
2046
+ 47</pre>
2047
+ </td>
2048
+ <td>
2049
+ <pre class="code"><span class="info file"># File 'lib/kabk/field.rb', line 45</span>
2050
+
2051
+ <span class='kw'>def</span> <span class='id identifier rubyid_validation'>validation</span>
2052
+ <span class='ivar'>@validation</span>
2053
+ <span class='kw'>end</span></pre>
2054
+ </td>
2055
+ </tr>
2056
+ </table>
2057
+ </div>
2058
+
2059
+ </div>
2060
+
2061
+
2062
+ <div id="instance_method_details" class="method_details_list">
2063
+ <h2>Instance Method Details</h2>
2064
+
2065
+
2066
+ <div class="method_details first">
2067
+ <h3 class="signature first" id="to_h-instance_method">
2068
+
2069
+ #<strong>to_h</strong> &#x21d2; <tt>Object</tt>
2070
+
2071
+
2072
+
2073
+
2074
+
2075
+ </h3><table class="source_code">
2076
+ <tr>
2077
+ <td>
2078
+ <pre class="lines">
2079
+
2080
+
2081
+ 67
2082
+ 68
2083
+ 69
2084
+ 70
2085
+ 71
2086
+ 72
2087
+ 73
2088
+ 74
2089
+ 75
2090
+ 76
2091
+ 77
2092
+ 78
2093
+ 79
2094
+ 80
2095
+ 81
2096
+ 82
2097
+ 83
2098
+ 84
2099
+ 85
2100
+ 86
2101
+ 87
2102
+ 88
2103
+ 89
2104
+ 90
2105
+ 91
2106
+ 92
2107
+ 93
2108
+ 94
2109
+ 95</pre>
2110
+ </td>
2111
+ <td>
2112
+ <pre class="code"><span class="info file"># File 'lib/kabk/field.rb', line 67</span>
2113
+
2114
+ <span class='kw'>def</span> <span class='id identifier rubyid_to_h'>to_h</span>
2115
+ <span class='id identifier rubyid_hash'>hash</span> <span class='op'>=</span> <span class='lbrace'>{</span>
2116
+ <span class='label'>name:</span> <span class='ivar'>@name</span><span class='comma'>,</span>
2117
+ <span class='label'>label:</span> <span class='ivar'>@label</span><span class='comma'>,</span>
2118
+ <span class='label'>type:</span> <span class='ivar'>@type</span><span class='comma'>,</span>
2119
+ <span class='label'>form_type:</span> <span class='ivar'>@form_type</span>
2120
+ <span class='rbrace'>}</span>
2121
+
2122
+ <span class='id identifier rubyid_hash'>hash</span><span class='lbracket'>[</span><span class='symbol'>:calendar</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='ivar'>@calendar</span> <span class='kw'>if</span> <span class='ivar'>@calendar</span>
2123
+ <span class='id identifier rubyid_hash'>hash</span><span class='lbracket'>[</span><span class='symbol'>:primary_key</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='ivar'>@primary_key</span> <span class='kw'>if</span> <span class='ivar'>@primary_key</span>
2124
+ <span class='id identifier rubyid_hash'>hash</span><span class='lbracket'>[</span><span class='symbol'>:nullable</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='ivar'>@nullable</span> <span class='kw'>unless</span> <span class='ivar'>@nullable</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
2125
+ <span class='id identifier rubyid_hash'>hash</span><span class='lbracket'>[</span><span class='symbol'>:display_as</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='ivar'>@display_as</span> <span class='kw'>if</span> <span class='ivar'>@display_as</span>
2126
+ <span class='id identifier rubyid_hash'>hash</span><span class='lbracket'>[</span><span class='symbol'>:col_width</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='ivar'>@col_width</span> <span class='kw'>if</span> <span class='ivar'>@col_width</span>
2127
+ <span class='id identifier rubyid_hash'>hash</span><span class='lbracket'>[</span><span class='symbol'>:order</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='ivar'>@order</span> <span class='kw'>if</span> <span class='ivar'>@order</span>
2128
+ <span class='id identifier rubyid_hash'>hash</span><span class='lbracket'>[</span><span class='symbol'>:required</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='ivar'>@required</span> <span class='kw'>if</span> <span class='ivar'>@required</span>
2129
+ <span class='id identifier rubyid_hash'>hash</span><span class='lbracket'>[</span><span class='symbol'>:readonly</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='ivar'>@readonly</span> <span class='kw'>if</span> <span class='ivar'>@readonly</span>
2130
+ <span class='id identifier rubyid_hash'>hash</span><span class='lbracket'>[</span><span class='symbol'>:hidden_in_table</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='ivar'>@hidden_in_table</span> <span class='kw'>if</span> <span class='ivar'>@hidden_in_table</span>
2131
+ <span class='id identifier rubyid_hash'>hash</span><span class='lbracket'>[</span><span class='symbol'>:hidden_in_form</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='ivar'>@hidden_in_form</span> <span class='kw'>if</span> <span class='ivar'>@hidden_in_form</span>
2132
+ <span class='id identifier rubyid_hash'>hash</span><span class='lbracket'>[</span><span class='symbol'>:accordion</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='ivar'>@accordion</span> <span class='kw'>if</span> <span class='ivar'>@accordion</span>
2133
+ <span class='id identifier rubyid_hash'>hash</span><span class='lbracket'>[</span><span class='symbol'>:rows</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='ivar'>@rows</span> <span class='kw'>if</span> <span class='ivar'>@rows</span>
2134
+ <span class='id identifier rubyid_hash'>hash</span><span class='lbracket'>[</span><span class='symbol'>:options</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='ivar'>@options</span> <span class='kw'>if</span> <span class='ivar'>@options</span>
2135
+ <span class='id identifier rubyid_hash'>hash</span><span class='lbracket'>[</span><span class='symbol'>:default_value</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='ivar'>@default_value</span> <span class='kw'>unless</span> <span class='ivar'>@default_value</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
2136
+ <span class='id identifier rubyid_hash'>hash</span><span class='lbracket'>[</span><span class='symbol'>:depends_on</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='ivar'>@depends_on</span> <span class='kw'>if</span> <span class='ivar'>@depends_on</span>
2137
+ <span class='id identifier rubyid_hash'>hash</span><span class='lbracket'>[</span><span class='symbol'>:validation</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='ivar'>@validation</span> <span class='kw'>if</span> <span class='ivar'>@validation</span>
2138
+ <span class='id identifier rubyid_hash'>hash</span><span class='lbracket'>[</span><span class='symbol'>:relation</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='ivar'>@relation</span> <span class='kw'>if</span> <span class='ivar'>@relation</span>
2139
+ <span class='id identifier rubyid_hash'>hash</span><span class='lbracket'>[</span><span class='symbol'>:upload_config</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='ivar'>@upload_config</span> <span class='kw'>if</span> <span class='ivar'>@upload_config</span>
2140
+
2141
+ <span class='id identifier rubyid_hash'>hash</span>
2142
+ <span class='kw'>end</span></pre>
2143
+ </td>
2144
+ </tr>
2145
+ </table>
2146
+ </div>
2147
+
2148
+ </div>
2149
+
2150
+ </div>
2151
+
2152
+ <div id="footer">
2153
+ Generated on Tue Aug 11 21:17:06 2026 by
2154
+ <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
2155
+ 0.9.45 (ruby-4.0.6).
2156
+ </div>
2157
+
2158
+ </div>
2159
+ </body>
2160
+ </html>