term_utils 0.1.1 → 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.
@@ -0,0 +1,1290 @@
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: TermUtils::Tab::Column
8
+
9
+ &mdash; Documentation by YARD 0.9.20
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="../../css/style.css" type="text/css" charset="utf-8" />
14
+
15
+ <link rel="stylesheet" href="../../css/common.css" type="text/css" charset="utf-8" />
16
+
17
+ <script type="text/javascript" charset="utf-8">
18
+ pathId = "TermUtils::Tab::Column";
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 class="nav_wrap">
31
+ <iframe id="nav" src="../../class_list.html?1"></iframe>
32
+ <div id="resizer"></div>
33
+ </div>
34
+
35
+ <div id="main" tabindex="-1">
36
+ <div id="header">
37
+ <div id="menu">
38
+
39
+ <a href="../../_index.html">Index (C)</a> &raquo;
40
+ <span class='title'><span class='object_link'><a href="../../TermUtils.html" title="TermUtils (module)">TermUtils</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Tab.html" title="TermUtils::Tab (module)">Tab</a></span></span>
41
+ &raquo;
42
+ <span class="title">Column</span>
43
+
44
+ </div>
45
+
46
+ <div id="search">
47
+
48
+ <a class="full_list_link" id="class_list_link"
49
+ href="../../class_list.html">
50
+
51
+ <svg width="24" height="24">
52
+ <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
53
+ <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
54
+ <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
55
+ </svg>
56
+ </a>
57
+
58
+ </div>
59
+ <div class="clear"></div>
60
+ </div>
61
+
62
+ <div id="content"><h1>Class: TermUtils::Tab::Column
63
+
64
+
65
+
66
+ </h1>
67
+ <div class="box_info">
68
+
69
+ <dl>
70
+ <dt>Inherits:</dt>
71
+ <dd>
72
+ <span class="inheritName">Object</span>
73
+
74
+ <ul class="fullTree">
75
+ <li>Object</li>
76
+
77
+ <li class="next">TermUtils::Tab::Column</li>
78
+
79
+ </ul>
80
+ <a href="#" class="inheritanceTree">show all</a>
81
+
82
+ </dd>
83
+ </dl>
84
+
85
+
86
+
87
+
88
+
89
+
90
+
91
+
92
+
93
+
94
+
95
+ <dl>
96
+ <dt>Defined in:</dt>
97
+ <dd>lib/term_utils/tab.rb</dd>
98
+ </dl>
99
+
100
+ </div>
101
+
102
+ <h2>Overview</h2><div class="docstring">
103
+ <div class="discussion">
104
+
105
+ <p>Represents a table column.</p>
106
+
107
+
108
+ </div>
109
+ </div>
110
+ <div class="tags">
111
+
112
+
113
+ </div>
114
+
115
+
116
+
117
+ <h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
118
+ <ul class="summary">
119
+
120
+ <li class="public ">
121
+ <span class="summary_signature">
122
+
123
+ <a href="#align-instance_method" title="#align (instance method)">#<strong>align</strong> &#x21d2; Symbol </a>
124
+
125
+
126
+
127
+ </span>
128
+
129
+
130
+
131
+
132
+
133
+
134
+
135
+
136
+
137
+
138
+
139
+
140
+ <span class="summary_desc"><div class='inline'>
141
+ <p>`:left`, `:right`.</p>
142
+ </div></span>
143
+
144
+ </li>
145
+
146
+
147
+ <li class="public ">
148
+ <span class="summary_signature">
149
+
150
+ <a href="#ellipsis-instance_method" title="#ellipsis (instance method)">#<strong>ellipsis</strong> &#x21d2; String </a>
151
+
152
+
153
+
154
+ </span>
155
+
156
+
157
+
158
+
159
+
160
+
161
+
162
+
163
+
164
+
165
+
166
+
167
+ <span class="summary_desc"><div class='inline'></div></span>
168
+
169
+ </li>
170
+
171
+
172
+ <li class="public ">
173
+ <span class="summary_signature">
174
+
175
+ <a href="#fixed-instance_method" title="#fixed (instance method)">#<strong>fixed</strong> &#x21d2; Boolean </a>
176
+
177
+
178
+
179
+ </span>
180
+
181
+
182
+
183
+
184
+
185
+
186
+
187
+
188
+
189
+
190
+
191
+
192
+ <span class="summary_desc"><div class='inline'></div></span>
193
+
194
+ </li>
195
+
196
+
197
+ <li class="public ">
198
+ <span class="summary_signature">
199
+
200
+ <a href="#format-instance_method" title="#format (instance method)">#<strong>format</strong> &#x21d2; Proc, ... </a>
201
+
202
+
203
+
204
+ </span>
205
+
206
+
207
+
208
+
209
+
210
+
211
+
212
+
213
+
214
+
215
+
216
+
217
+ <span class="summary_desc"><div class='inline'></div></span>
218
+
219
+ </li>
220
+
221
+
222
+ <li class="public ">
223
+ <span class="summary_signature">
224
+
225
+ <a href="#id-instance_method" title="#id (instance method)">#<strong>id</strong> &#x21d2; Symbol </a>
226
+
227
+
228
+
229
+ </span>
230
+
231
+
232
+
233
+
234
+
235
+
236
+
237
+
238
+
239
+
240
+
241
+
242
+ <span class="summary_desc"><div class='inline'></div></span>
243
+
244
+ </li>
245
+
246
+
247
+ <li class="public ">
248
+ <span class="summary_signature">
249
+
250
+ <a href="#index-instance_method" title="#index (instance method)">#<strong>index</strong> &#x21d2; Integer </a>
251
+
252
+
253
+
254
+ </span>
255
+
256
+
257
+
258
+
259
+
260
+
261
+
262
+
263
+
264
+
265
+
266
+
267
+ <span class="summary_desc"><div class='inline'></div></span>
268
+
269
+ </li>
270
+
271
+
272
+ <li class="public ">
273
+ <span class="summary_signature">
274
+
275
+ <a href="#width-instance_method" title="#width (instance method)">#<strong>width</strong> &#x21d2; Integer </a>
276
+
277
+
278
+
279
+ </span>
280
+
281
+
282
+
283
+
284
+
285
+
286
+
287
+
288
+
289
+
290
+
291
+
292
+ <span class="summary_desc"><div class='inline'></div></span>
293
+
294
+ </li>
295
+
296
+
297
+ </ul>
298
+
299
+
300
+
301
+
302
+
303
+ <h2>
304
+ Instance Method Summary
305
+ <small><a href="#" class="summary_toggle">collapse</a></small>
306
+ </h2>
307
+
308
+ <ul class="summary">
309
+
310
+ <li class="public ">
311
+ <span class="summary_signature">
312
+
313
+ <a href="#align_cut-instance_method" title="#align_cut (instance method)">#<strong>align_cut</strong>(str) &#x21d2; String </a>
314
+
315
+
316
+
317
+ </span>
318
+
319
+
320
+
321
+
322
+
323
+
324
+
325
+
326
+
327
+ <span class="summary_desc"><div class='inline'>
328
+ <p>Aligns and cuts a given string.</p>
329
+ </div></span>
330
+
331
+ </li>
332
+
333
+
334
+ <li class="public ">
335
+ <span class="summary_signature">
336
+
337
+ <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(opts = {}) &#x21d2; Column </a>
338
+
339
+
340
+
341
+ </span>
342
+
343
+
344
+ <span class="note title constructor">constructor</span>
345
+
346
+
347
+
348
+
349
+
350
+
351
+
352
+
353
+ <span class="summary_desc"><div class='inline'>
354
+ <p>A new instance of Column.</p>
355
+ </div></span>
356
+
357
+ </li>
358
+
359
+
360
+ <li class="public ">
361
+ <span class="summary_signature">
362
+
363
+ <a href="#render_data-instance_method" title="#render_data (instance method)">#<strong>render_data</strong>(v) &#x21d2; Object </a>
364
+
365
+
366
+
367
+ </span>
368
+
369
+
370
+
371
+
372
+
373
+
374
+
375
+
376
+
377
+ <span class="summary_desc"><div class='inline'>
378
+ <p>Renders a given value.</p>
379
+ </div></span>
380
+
381
+ </li>
382
+
383
+
384
+ <li class="public ">
385
+ <span class="summary_signature">
386
+
387
+ <a href="#render_header-instance_method" title="#render_header (instance method)">#<strong>render_header</strong>(v) &#x21d2; Object </a>
388
+
389
+
390
+
391
+ </span>
392
+
393
+
394
+
395
+
396
+
397
+
398
+
399
+
400
+
401
+ <span class="summary_desc"><div class='inline'>
402
+ <p>Renders a given header.</p>
403
+ </div></span>
404
+
405
+ </li>
406
+
407
+
408
+ <li class="public ">
409
+ <span class="summary_signature">
410
+
411
+ <a href="#validate-instance_method" title="#validate (instance method)">#<strong>validate</strong> &#x21d2; nil </a>
412
+
413
+
414
+
415
+ </span>
416
+
417
+
418
+
419
+
420
+
421
+
422
+
423
+
424
+
425
+ <span class="summary_desc"><div class='inline'>
426
+ <p>Validates the column represented by this one.</p>
427
+ </div></span>
428
+
429
+ </li>
430
+
431
+
432
+ </ul>
433
+
434
+
435
+ <div id="constructor_details" class="method_details_list">
436
+ <h2>Constructor Details</h2>
437
+
438
+ <div class="method_details first">
439
+ <h3 class="signature first" id="initialize-instance_method">
440
+
441
+ #<strong>initialize</strong>(opts = {}) &#x21d2; <tt><span class='object_link'><a href="" title="TermUtils::Tab::Column (class)">Column</a></span></tt>
442
+
443
+
444
+
445
+
446
+
447
+ </h3><div class="docstring">
448
+ <div class="discussion">
449
+
450
+ <p>Returns a new instance of Column</p>
451
+
452
+
453
+ </div>
454
+ </div>
455
+ <div class="tags">
456
+ <p class="tag_title">Parameters:</p>
457
+ <ul class="param">
458
+
459
+ <li>
460
+
461
+ <span class='name'>opts</span>
462
+
463
+
464
+ <span class='type'>(<tt>Hash</tt>)</span>
465
+
466
+
467
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
468
+
469
+
470
+ </li>
471
+
472
+ </ul>
473
+
474
+
475
+
476
+
477
+ <p class="tag_title">Options Hash (<tt>opts</tt>):</p>
478
+ <ul class="option">
479
+
480
+ <li>
481
+ <span class="name">:id</span>
482
+ <span class="type">(<tt>Symbol</tt>)</span>
483
+ <span class="default">
484
+
485
+ </span>
486
+
487
+ </li>
488
+
489
+ <li>
490
+ <span class="name">:index</span>
491
+ <span class="type">(<tt>Integer</tt>)</span>
492
+ <span class="default">
493
+
494
+ </span>
495
+
496
+ </li>
497
+
498
+ <li>
499
+ <span class="name">:width</span>
500
+ <span class="type">(<tt>Integer</tt>)</span>
501
+ <span class="default">
502
+
503
+ </span>
504
+
505
+ </li>
506
+
507
+ <li>
508
+ <span class="name">:align</span>
509
+ <span class="type">(<tt>Symbol</tt>)</span>
510
+ <span class="default">
511
+
512
+ </span>
513
+
514
+ </li>
515
+
516
+ <li>
517
+ <span class="name">:fixed</span>
518
+ <span class="type">(<tt>Boolean</tt>)</span>
519
+ <span class="default">
520
+
521
+ </span>
522
+
523
+ </li>
524
+
525
+ <li>
526
+ <span class="name">:ellipsis</span>
527
+ <span class="type">(<tt>String</tt>)</span>
528
+ <span class="default">
529
+
530
+ </span>
531
+
532
+ </li>
533
+
534
+ <li>
535
+ <span class="name">:format</span>
536
+ <span class="type">(<tt>Proc</tt>, <tt>String</tt>, <tt>nil</tt>)</span>
537
+ <span class="default">
538
+
539
+ </span>
540
+
541
+ </li>
542
+
543
+ </ul>
544
+
545
+
546
+
547
+ </div><table class="source_code">
548
+ <tr>
549
+ <td>
550
+ <pre class="lines">
551
+
552
+
553
+ 173
554
+ 174
555
+ 175
556
+ 176
557
+ 177
558
+ 178
559
+ 179
560
+ 180
561
+ 181</pre>
562
+ </td>
563
+ <td>
564
+ <pre class="code"><span class="info file"># File 'lib/term_utils/tab.rb', line 173</span>
565
+
566
+ <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
567
+ <span class='ivar'>@id</span> <span class='op'>=</span> <span class='id identifier rubyid_opts'>opts</span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span><span class='lparen'>(</span><span class='symbol'>:id</span><span class='rparen'>)</span>
568
+ <span class='ivar'>@index</span> <span class='op'>=</span> <span class='id identifier rubyid_opts'>opts</span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span><span class='lparen'>(</span><span class='symbol'>:index</span><span class='rparen'>)</span>
569
+ <span class='ivar'>@width</span> <span class='op'>=</span> <span class='id identifier rubyid_opts'>opts</span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span><span class='lparen'>(</span><span class='symbol'>:width</span><span class='comma'>,</span> <span class='int'>8</span><span class='rparen'>)</span>
570
+ <span class='ivar'>@align</span> <span class='op'>=</span> <span class='id identifier rubyid_opts'>opts</span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span><span class='lparen'>(</span><span class='symbol'>:align</span><span class='comma'>,</span> <span class='symbol'>:left</span><span class='rparen'>)</span>
571
+ <span class='ivar'>@fixed</span> <span class='op'>=</span> <span class='id identifier rubyid_opts'>opts</span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span><span class='lparen'>(</span><span class='symbol'>:fixed</span><span class='comma'>,</span> <span class='kw'>false</span><span class='rparen'>)</span>
572
+ <span class='ivar'>@ellipsis</span> <span class='op'>=</span> <span class='id identifier rubyid_opts'>opts</span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span><span class='lparen'>(</span><span class='symbol'>:ellipsis</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>?</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
573
+ <span class='ivar'>@format</span> <span class='op'>=</span> <span class='id identifier rubyid_opts'>opts</span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span><span class='lparen'>(</span><span class='symbol'>:format</span><span class='comma'>,</span> <span class='kw'>nil</span><span class='rparen'>)</span>
574
+ <span class='kw'>end</span></pre>
575
+ </td>
576
+ </tr>
577
+ </table>
578
+ </div>
579
+
580
+ </div>
581
+
582
+ <div id="instance_attr_details" class="attr_details">
583
+ <h2>Instance Attribute Details</h2>
584
+
585
+
586
+ <span id="align=-instance_method"></span>
587
+ <div class="method_details first">
588
+ <h3 class="signature first" id="align-instance_method">
589
+
590
+ #<strong>align</strong> &#x21d2; <tt>Symbol</tt>
591
+
592
+
593
+
594
+
595
+
596
+ </h3><div class="docstring">
597
+ <div class="discussion">
598
+
599
+ <p>Returns `:left`, `:right`.</p>
600
+
601
+
602
+ </div>
603
+ </div>
604
+ <div class="tags">
605
+
606
+ <p class="tag_title">Returns:</p>
607
+ <ul class="return">
608
+
609
+ <li>
610
+
611
+
612
+ <span class='type'>(<tt>Symbol</tt>)</span>
613
+
614
+
615
+
616
+ &mdash;
617
+ <div class='inline'>
618
+ <p>`:left`, `:right`.</p>
619
+ </div>
620
+
621
+ </li>
622
+
623
+ </ul>
624
+
625
+ </div><table class="source_code">
626
+ <tr>
627
+ <td>
628
+ <pre class="lines">
629
+
630
+
631
+ 158
632
+ 159
633
+ 160</pre>
634
+ </td>
635
+ <td>
636
+ <pre class="code"><span class="info file"># File 'lib/term_utils/tab.rb', line 158</span>
637
+
638
+ <span class='kw'>def</span> <span class='id identifier rubyid_align'>align</span>
639
+ <span class='ivar'>@align</span>
640
+ <span class='kw'>end</span></pre>
641
+ </td>
642
+ </tr>
643
+ </table>
644
+ </div>
645
+
646
+
647
+ <span id="ellipsis=-instance_method"></span>
648
+ <div class="method_details ">
649
+ <h3 class="signature " id="ellipsis-instance_method">
650
+
651
+ #<strong>ellipsis</strong> &#x21d2; <tt>String</tt>
652
+
653
+
654
+
655
+
656
+
657
+ </h3><div class="docstring">
658
+ <div class="discussion">
659
+
660
+
661
+ </div>
662
+ </div>
663
+ <div class="tags">
664
+
665
+ <p class="tag_title">Returns:</p>
666
+ <ul class="return">
667
+
668
+ <li>
669
+
670
+
671
+ <span class='type'>(<tt>String</tt>)</span>
672
+
673
+
674
+
675
+ </li>
676
+
677
+ </ul>
678
+
679
+ </div><table class="source_code">
680
+ <tr>
681
+ <td>
682
+ <pre class="lines">
683
+
684
+
685
+ 162
686
+ 163
687
+ 164</pre>
688
+ </td>
689
+ <td>
690
+ <pre class="code"><span class="info file"># File 'lib/term_utils/tab.rb', line 162</span>
691
+
692
+ <span class='kw'>def</span> <span class='id identifier rubyid_ellipsis'>ellipsis</span>
693
+ <span class='ivar'>@ellipsis</span>
694
+ <span class='kw'>end</span></pre>
695
+ </td>
696
+ </tr>
697
+ </table>
698
+ </div>
699
+
700
+
701
+ <span id="fixed=-instance_method"></span>
702
+ <div class="method_details ">
703
+ <h3 class="signature " id="fixed-instance_method">
704
+
705
+ #<strong>fixed</strong> &#x21d2; <tt>Boolean</tt>
706
+
707
+
708
+
709
+
710
+
711
+ </h3><div class="docstring">
712
+ <div class="discussion">
713
+
714
+
715
+ </div>
716
+ </div>
717
+ <div class="tags">
718
+
719
+ <p class="tag_title">Returns:</p>
720
+ <ul class="return">
721
+
722
+ <li>
723
+
724
+
725
+ <span class='type'>(<tt>Boolean</tt>)</span>
726
+
727
+
728
+
729
+ </li>
730
+
731
+ </ul>
732
+
733
+ </div><table class="source_code">
734
+ <tr>
735
+ <td>
736
+ <pre class="lines">
737
+
738
+
739
+ 160
740
+ 161
741
+ 162</pre>
742
+ </td>
743
+ <td>
744
+ <pre class="code"><span class="info file"># File 'lib/term_utils/tab.rb', line 160</span>
745
+
746
+ <span class='kw'>def</span> <span class='id identifier rubyid_fixed'>fixed</span>
747
+ <span class='ivar'>@fixed</span>
748
+ <span class='kw'>end</span></pre>
749
+ </td>
750
+ </tr>
751
+ </table>
752
+ </div>
753
+
754
+
755
+ <span id="format=-instance_method"></span>
756
+ <div class="method_details ">
757
+ <h3 class="signature " id="format-instance_method">
758
+
759
+ #<strong>format</strong> &#x21d2; <tt>Proc</tt>, ...
760
+
761
+
762
+
763
+
764
+
765
+ </h3><div class="docstring">
766
+ <div class="discussion">
767
+
768
+
769
+ </div>
770
+ </div>
771
+ <div class="tags">
772
+
773
+ <p class="tag_title">Returns:</p>
774
+ <ul class="return">
775
+
776
+ <li>
777
+
778
+
779
+ <span class='type'>(<tt>Proc</tt>, <tt>String</tt>, <tt>nil</tt>)</span>
780
+
781
+
782
+
783
+ </li>
784
+
785
+ </ul>
786
+
787
+ </div><table class="source_code">
788
+ <tr>
789
+ <td>
790
+ <pre class="lines">
791
+
792
+
793
+ 164
794
+ 165
795
+ 166</pre>
796
+ </td>
797
+ <td>
798
+ <pre class="code"><span class="info file"># File 'lib/term_utils/tab.rb', line 164</span>
799
+
800
+ <span class='kw'>def</span> <span class='id identifier rubyid_format'>format</span>
801
+ <span class='ivar'>@format</span>
802
+ <span class='kw'>end</span></pre>
803
+ </td>
804
+ </tr>
805
+ </table>
806
+ </div>
807
+
808
+
809
+ <span id="id=-instance_method"></span>
810
+ <div class="method_details ">
811
+ <h3 class="signature " id="id-instance_method">
812
+
813
+ #<strong>id</strong> &#x21d2; <tt>Symbol</tt>
814
+
815
+
816
+
817
+
818
+
819
+ </h3><div class="docstring">
820
+ <div class="discussion">
821
+
822
+
823
+ </div>
824
+ </div>
825
+ <div class="tags">
826
+
827
+ <p class="tag_title">Returns:</p>
828
+ <ul class="return">
829
+
830
+ <li>
831
+
832
+
833
+ <span class='type'>(<tt>Symbol</tt>)</span>
834
+
835
+
836
+
837
+ </li>
838
+
839
+ </ul>
840
+
841
+ </div><table class="source_code">
842
+ <tr>
843
+ <td>
844
+ <pre class="lines">
845
+
846
+
847
+ 152
848
+ 153
849
+ 154</pre>
850
+ </td>
851
+ <td>
852
+ <pre class="code"><span class="info file"># File 'lib/term_utils/tab.rb', line 152</span>
853
+
854
+ <span class='kw'>def</span> <span class='id identifier rubyid_id'>id</span>
855
+ <span class='ivar'>@id</span>
856
+ <span class='kw'>end</span></pre>
857
+ </td>
858
+ </tr>
859
+ </table>
860
+ </div>
861
+
862
+
863
+ <span id="index=-instance_method"></span>
864
+ <div class="method_details ">
865
+ <h3 class="signature " id="index-instance_method">
866
+
867
+ #<strong>index</strong> &#x21d2; <tt>Integer</tt>
868
+
869
+
870
+
871
+
872
+
873
+ </h3><div class="docstring">
874
+ <div class="discussion">
875
+
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>Integer</tt>)</span>
888
+
889
+
890
+
891
+ </li>
892
+
893
+ </ul>
894
+
895
+ </div><table class="source_code">
896
+ <tr>
897
+ <td>
898
+ <pre class="lines">
899
+
900
+
901
+ 154
902
+ 155
903
+ 156</pre>
904
+ </td>
905
+ <td>
906
+ <pre class="code"><span class="info file"># File 'lib/term_utils/tab.rb', line 154</span>
907
+
908
+ <span class='kw'>def</span> <span class='id identifier rubyid_index'>index</span>
909
+ <span class='ivar'>@index</span>
910
+ <span class='kw'>end</span></pre>
911
+ </td>
912
+ </tr>
913
+ </table>
914
+ </div>
915
+
916
+
917
+ <span id="width=-instance_method"></span>
918
+ <div class="method_details ">
919
+ <h3 class="signature " id="width-instance_method">
920
+
921
+ #<strong>width</strong> &#x21d2; <tt>Integer</tt>
922
+
923
+
924
+
925
+
926
+
927
+ </h3><div class="docstring">
928
+ <div class="discussion">
929
+
930
+
931
+ </div>
932
+ </div>
933
+ <div class="tags">
934
+
935
+ <p class="tag_title">Returns:</p>
936
+ <ul class="return">
937
+
938
+ <li>
939
+
940
+
941
+ <span class='type'>(<tt>Integer</tt>)</span>
942
+
943
+
944
+
945
+ </li>
946
+
947
+ </ul>
948
+
949
+ </div><table class="source_code">
950
+ <tr>
951
+ <td>
952
+ <pre class="lines">
953
+
954
+
955
+ 156
956
+ 157
957
+ 158</pre>
958
+ </td>
959
+ <td>
960
+ <pre class="code"><span class="info file"># File 'lib/term_utils/tab.rb', line 156</span>
961
+
962
+ <span class='kw'>def</span> <span class='id identifier rubyid_width'>width</span>
963
+ <span class='ivar'>@width</span>
964
+ <span class='kw'>end</span></pre>
965
+ </td>
966
+ </tr>
967
+ </table>
968
+ </div>
969
+
970
+ </div>
971
+
972
+
973
+ <div id="instance_method_details" class="method_details_list">
974
+ <h2>Instance Method Details</h2>
975
+
976
+
977
+ <div class="method_details first">
978
+ <h3 class="signature first" id="align_cut-instance_method">
979
+
980
+ #<strong>align_cut</strong>(str) &#x21d2; <tt>String</tt>
981
+
982
+
983
+
984
+
985
+
986
+ </h3><div class="docstring">
987
+ <div class="discussion">
988
+
989
+ <p>Aligns and cuts a given string.</p>
990
+
991
+
992
+ </div>
993
+ </div>
994
+ <div class="tags">
995
+ <p class="tag_title">Parameters:</p>
996
+ <ul class="param">
997
+
998
+ <li>
999
+
1000
+ <span class='name'>str</span>
1001
+
1002
+
1003
+ <span class='type'>(<tt>String</tt>)</span>
1004
+
1005
+
1006
+
1007
+ </li>
1008
+
1009
+ </ul>
1010
+
1011
+ <p class="tag_title">Returns:</p>
1012
+ <ul class="return">
1013
+
1014
+ <li>
1015
+
1016
+
1017
+ <span class='type'>(<tt>String</tt>)</span>
1018
+
1019
+
1020
+
1021
+ </li>
1022
+
1023
+ </ul>
1024
+
1025
+ </div><table class="source_code">
1026
+ <tr>
1027
+ <td>
1028
+ <pre class="lines">
1029
+
1030
+
1031
+ 197
1032
+ 198
1033
+ 199
1034
+ 200
1035
+ 201
1036
+ 202
1037
+ 203
1038
+ 204
1039
+ 205
1040
+ 206
1041
+ 207
1042
+ 208
1043
+ 209
1044
+ 210
1045
+ 211
1046
+ 212
1047
+ 213
1048
+ 214</pre>
1049
+ </td>
1050
+ <td>
1051
+ <pre class="code"><span class="info file"># File 'lib/term_utils/tab.rb', line 197</span>
1052
+
1053
+ <span class='kw'>def</span> <span class='id identifier rubyid_align_cut'>align_cut</span><span class='lparen'>(</span><span class='id identifier rubyid_str'>str</span><span class='rparen'>)</span>
1054
+ <span class='kw'>if</span> <span class='ivar'>@align</span> <span class='op'>==</span> <span class='symbol'>:left</span>
1055
+ <span class='comment'># Align left
1056
+ </span> <span class='kw'>if</span> <span class='ivar'>@fixed</span> <span class='kw'>and</span> <span class='lparen'>(</span><span class='id identifier rubyid_str'>str</span><span class='period'>.</span><span class='id identifier rubyid_length'>length</span> <span class='op'>&gt;</span> <span class='ivar'>@width</span><span class='rparen'>)</span>
1057
+ <span class='id identifier rubyid_str'>str</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_str'>str</span><span class='lbracket'>[</span><span class='int'>0</span><span class='op'>..</span><span class='lparen'>(</span><span class='ivar'>@width</span> <span class='op'>-</span> <span class='lparen'>(</span><span class='ivar'>@ellipsis</span><span class='period'>.</span><span class='id identifier rubyid_length'>length</span> <span class='op'>+</span> <span class='int'>1</span><span class='rparen'>)</span><span class='rparen'>)</span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='embexpr_beg'>#{</span><span class='ivar'>@ellipsis</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
1058
+ <span class='kw'>else</span>
1059
+ <span class='id identifier rubyid_str'>str</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>%-*s</span><span class='tstring_end'>&quot;</span></span> <span class='op'>%</span> <span class='lbracket'>[</span><span class='ivar'>@width</span><span class='comma'>,</span> <span class='id identifier rubyid_str'>str</span><span class='rbracket'>]</span>
1060
+ <span class='kw'>end</span>
1061
+ <span class='kw'>else</span>
1062
+ <span class='comment'># Align right
1063
+ </span> <span class='kw'>if</span> <span class='ivar'>@fixed</span> <span class='kw'>and</span> <span class='lparen'>(</span><span class='id identifier rubyid_str'>str</span><span class='period'>.</span><span class='id identifier rubyid_length'>length</span> <span class='op'>&gt;</span> <span class='ivar'>@width</span><span class='rparen'>)</span>
1064
+ <span class='id identifier rubyid_str'>str</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='ivar'>@ellipsis</span><span class='embexpr_end'>}</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_str'>str</span><span class='lbracket'>[</span><span class='lparen'>(</span><span class='id identifier rubyid_str'>str</span><span class='period'>.</span><span class='id identifier rubyid_length'>length</span> <span class='op'>-</span> <span class='ivar'>@width</span> <span class='op'>+</span> <span class='ivar'>@ellipsis</span><span class='period'>.</span><span class='id identifier rubyid_length'>length</span><span class='rparen'>)</span><span class='op'>..</span><span class='lparen'>(</span><span class='id identifier rubyid_str'>str</span><span class='period'>.</span><span class='id identifier rubyid_length'>length</span> <span class='op'>-</span> <span class='int'>1</span><span class='rparen'>)</span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
1065
+ <span class='kw'>else</span>
1066
+ <span class='id identifier rubyid_str'>str</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>%*s</span><span class='tstring_end'>&quot;</span></span> <span class='op'>%</span> <span class='lbracket'>[</span><span class='ivar'>@width</span><span class='comma'>,</span> <span class='id identifier rubyid_str'>str</span><span class='rbracket'>]</span>
1067
+ <span class='kw'>end</span>
1068
+ <span class='kw'>end</span>
1069
+ <span class='id identifier rubyid_str'>str</span>
1070
+ <span class='kw'>end</span></pre>
1071
+ </td>
1072
+ </tr>
1073
+ </table>
1074
+ </div>
1075
+
1076
+ <div class="method_details ">
1077
+ <h3 class="signature " id="render_data-instance_method">
1078
+
1079
+ #<strong>render_data</strong>(v) &#x21d2; <tt>Object</tt>
1080
+
1081
+
1082
+
1083
+
1084
+
1085
+ </h3><div class="docstring">
1086
+ <div class="discussion">
1087
+
1088
+ <p>Renders a given value. return [String]</p>
1089
+
1090
+
1091
+ </div>
1092
+ </div>
1093
+ <div class="tags">
1094
+ <p class="tag_title">Parameters:</p>
1095
+ <ul class="param">
1096
+
1097
+ <li>
1098
+
1099
+ <span class='name'>v</span>
1100
+
1101
+
1102
+ <span class='type'>(<tt>Object</tt>)</span>
1103
+
1104
+
1105
+
1106
+ </li>
1107
+
1108
+ </ul>
1109
+
1110
+
1111
+ </div><table class="source_code">
1112
+ <tr>
1113
+ <td>
1114
+ <pre class="lines">
1115
+
1116
+
1117
+ 226
1118
+ 227
1119
+ 228
1120
+ 229
1121
+ 230
1122
+ 231
1123
+ 232
1124
+ 233
1125
+ 234
1126
+ 235
1127
+ 236
1128
+ 237</pre>
1129
+ </td>
1130
+ <td>
1131
+ <pre class="code"><span class="info file"># File 'lib/term_utils/tab.rb', line 226</span>
1132
+
1133
+ <span class='kw'>def</span> <span class='id identifier rubyid_render_data'>render_data</span><span class='lparen'>(</span><span class='id identifier rubyid_v'>v</span><span class='rparen'>)</span>
1134
+ <span class='id identifier rubyid_str'>str</span> <span class='op'>=</span> <span class='id identifier rubyid_v'>v</span>
1135
+ <span class='kw'>if</span> <span class='id identifier rubyid_v'>v</span>
1136
+ <span class='kw'>if</span> <span class='ivar'>@format</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span> <span class='const'>Proc</span>
1137
+ <span class='id identifier rubyid_str'>str</span> <span class='op'>=</span> <span class='ivar'>@format</span><span class='period'>.</span><span class='id identifier rubyid_call'>call</span><span class='lparen'>(</span><span class='id identifier rubyid_v'>v</span><span class='rparen'>)</span>
1138
+ <span class='kw'>elsif</span> <span class='ivar'>@format</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span> <span class='const'>String</span>
1139
+ <span class='id identifier rubyid_str'>str</span> <span class='op'>=</span> <span class='ivar'>@format</span> <span class='op'>%</span> <span class='id identifier rubyid_v'>v</span>
1140
+ <span class='kw'>end</span>
1141
+ <span class='kw'>end</span>
1142
+ <span class='id identifier rubyid_str'>str</span> <span class='op'>=</span> <span class='id identifier rubyid_str'>str</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span> <span class='kw'>unless</span> <span class='id identifier rubyid_str'>str</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span> <span class='const'>String</span>
1143
+ <span class='id identifier rubyid_align_cut'>align_cut</span> <span class='id identifier rubyid_str'>str</span>
1144
+ <span class='kw'>end</span></pre>
1145
+ </td>
1146
+ </tr>
1147
+ </table>
1148
+ </div>
1149
+
1150
+ <div class="method_details ">
1151
+ <h3 class="signature " id="render_header-instance_method">
1152
+
1153
+ #<strong>render_header</strong>(v) &#x21d2; <tt>Object</tt>
1154
+
1155
+
1156
+
1157
+
1158
+
1159
+ </h3><div class="docstring">
1160
+ <div class="discussion">
1161
+
1162
+ <p>Renders a given header. return [String]</p>
1163
+
1164
+
1165
+ </div>
1166
+ </div>
1167
+ <div class="tags">
1168
+ <p class="tag_title">Parameters:</p>
1169
+ <ul class="param">
1170
+
1171
+ <li>
1172
+
1173
+ <span class='name'>v</span>
1174
+
1175
+
1176
+ <span class='type'>(<tt>Object</tt>)</span>
1177
+
1178
+
1179
+
1180
+ </li>
1181
+
1182
+ </ul>
1183
+
1184
+
1185
+ </div><table class="source_code">
1186
+ <tr>
1187
+ <td>
1188
+ <pre class="lines">
1189
+
1190
+
1191
+ 218
1192
+ 219
1193
+ 220
1194
+ 221
1195
+ 222</pre>
1196
+ </td>
1197
+ <td>
1198
+ <pre class="code"><span class="info file"># File 'lib/term_utils/tab.rb', line 218</span>
1199
+
1200
+ <span class='kw'>def</span> <span class='id identifier rubyid_render_header'>render_header</span><span class='lparen'>(</span><span class='id identifier rubyid_v'>v</span><span class='rparen'>)</span>
1201
+ <span class='id identifier rubyid_str'>str</span> <span class='op'>=</span> <span class='id identifier rubyid_v'>v</span>
1202
+ <span class='id identifier rubyid_str'>str</span> <span class='op'>=</span> <span class='id identifier rubyid_str'>str</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span> <span class='kw'>unless</span> <span class='id identifier rubyid_str'>str</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span> <span class='const'>String</span>
1203
+ <span class='id identifier rubyid_align_cut'>align_cut</span> <span class='id identifier rubyid_str'>str</span>
1204
+ <span class='kw'>end</span></pre>
1205
+ </td>
1206
+ </tr>
1207
+ </table>
1208
+ </div>
1209
+
1210
+ <div class="method_details ">
1211
+ <h3 class="signature " id="validate-instance_method">
1212
+
1213
+ #<strong>validate</strong> &#x21d2; <tt>nil</tt>
1214
+
1215
+
1216
+
1217
+
1218
+
1219
+ </h3><div class="docstring">
1220
+ <div class="discussion">
1221
+
1222
+ <p>Validates the column represented by this one.</p>
1223
+
1224
+
1225
+ </div>
1226
+ </div>
1227
+ <div class="tags">
1228
+
1229
+ <p class="tag_title">Returns:</p>
1230
+ <ul class="return">
1231
+
1232
+ <li>
1233
+
1234
+
1235
+ <span class='type'>(<tt>nil</tt>)</span>
1236
+
1237
+
1238
+
1239
+ </li>
1240
+
1241
+ </ul>
1242
+
1243
+ </div><table class="source_code">
1244
+ <tr>
1245
+ <td>
1246
+ <pre class="lines">
1247
+
1248
+
1249
+ 184
1250
+ 185
1251
+ 186
1252
+ 187
1253
+ 188
1254
+ 189
1255
+ 190
1256
+ 191
1257
+ 192
1258
+ 193</pre>
1259
+ </td>
1260
+ <td>
1261
+ <pre class="code"><span class="info file"># File 'lib/term_utils/tab.rb', line 184</span>
1262
+
1263
+ <span class='kw'>def</span> <span class='id identifier rubyid_validate'>validate</span>
1264
+ <span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>missing column id (nil)</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>if</span> <span class='ivar'>@id</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
1265
+ <span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>missing column index (nil)</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>if</span> <span class='ivar'>@index</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
1266
+ <span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>wrong column index (not integer)</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>unless</span> <span class='ivar'>@index</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span> <span class='const'>Integer</span>
1267
+ <span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>wrong column index (not &gt;= 0)</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>if</span> <span class='ivar'>@index</span> <span class='op'>&lt;</span> <span class='int'>0</span>
1268
+ <span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>missing column width (nil)</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>if</span> <span class='ivar'>@width</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
1269
+ <span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>wrong column width (not integer)</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>unless</span> <span class='ivar'>@width</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span> <span class='const'>Integer</span>
1270
+ <span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>wrong column width (not &gt; 0)</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>if</span> <span class='ivar'>@width</span> <span class='op'>&lt;=</span> <span class='int'>0</span>
1271
+ <span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>wrong column align (not :left or :right)</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>unless</span> <span class='qsymbols_beg'>%i{</span><span class='tstring_content'>left</span><span class='words_sep'> </span><span class='tstring_content'>right</span><span class='tstring_end'>}</span></span><span class='period'>.</span><span class='id identifier rubyid_index'>index</span> <span class='ivar'>@align</span>
1272
+ <span class='kw'>end</span></pre>
1273
+ </td>
1274
+ </tr>
1275
+ </table>
1276
+ </div>
1277
+
1278
+ </div>
1279
+
1280
+ </div>
1281
+
1282
+ <div id="footer">
1283
+ Generated on Thu Oct 17 22:50:57 2019 by
1284
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1285
+ 0.9.20 (ruby-2.6.5).
1286
+ </div>
1287
+
1288
+ </div>
1289
+ </body>
1290
+ </html>