doing 2.1.39 → 2.1.40

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.
Files changed (116) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +23 -0
  3. data/Gemfile.lock +1 -1
  4. data/README.md +1 -1
  5. data/bin/commands/config.rb +43 -34
  6. data/bin/commands/done.rb +1 -18
  7. data/bin/commands/finish.rb +30 -25
  8. data/bin/commands/grep.rb +3 -14
  9. data/bin/commands/last.rb +2 -8
  10. data/bin/commands/meanwhile.rb +13 -6
  11. data/bin/commands/on.rb +3 -16
  12. data/bin/commands/recent.rb +2 -8
  13. data/bin/commands/reset.rb +24 -1
  14. data/bin/commands/select.rb +1 -1
  15. data/bin/commands/show.rb +6 -17
  16. data/bin/commands/since.rb +1 -12
  17. data/bin/commands/today.rb +2 -13
  18. data/bin/commands/view.rb +1 -1
  19. data/bin/commands/yesterday.rb +2 -13
  20. data/bin/doing +15 -8
  21. data/docs/doc/Array.html +1 -1
  22. data/docs/doc/BooleanTermParser/Clause.html +1 -1
  23. data/docs/doc/BooleanTermParser/Operator.html +1 -1
  24. data/docs/doc/BooleanTermParser/Query.html +1 -1
  25. data/docs/doc/BooleanTermParser/QueryParser.html +1 -1
  26. data/docs/doc/BooleanTermParser/QueryTransformer.html +1 -1
  27. data/docs/doc/BooleanTermParser.html +1 -1
  28. data/docs/doc/Doing/Color.html +166 -20
  29. data/docs/doc/Doing/Completion.html +1 -1
  30. data/docs/doc/Doing/Configuration.html +1 -1
  31. data/docs/doc/Doing/Errors/DoingNoTraceError.html +7 -3
  32. data/docs/doc/Doing/Errors/DoingRuntimeError.html +7 -3
  33. data/docs/doc/Doing/Errors/DoingStandardError.html +1 -1
  34. data/docs/doc/Doing/Errors/EmptyInput.html +10 -2
  35. data/docs/doc/Doing/Errors/HistoryLimitError.html +194 -0
  36. data/docs/doc/Doing/Errors/InvalidPlugin.html +194 -0
  37. data/docs/doc/Doing/Errors/MissingBackupFile.html +194 -0
  38. data/docs/doc/Doing/Errors/NoResults.html +10 -2
  39. data/docs/doc/Doing/Errors/PluginException.html +1 -1
  40. data/docs/doc/Doing/Errors/UserCancelled.html +10 -2
  41. data/docs/doc/Doing/Errors/WrongCommand.html +10 -2
  42. data/docs/doc/Doing/Errors.html +9 -9
  43. data/docs/doc/Doing/Hooks.html +1 -1
  44. data/docs/doc/Doing/Item.html +90 -1615
  45. data/docs/doc/Doing/Items.html +121 -5
  46. data/docs/doc/Doing/Logger.html +1 -1
  47. data/docs/doc/Doing/Note.html +1 -1
  48. data/docs/doc/Doing/Pager.html +1 -1
  49. data/docs/doc/Doing/Plugins.html +1 -1
  50. data/docs/doc/Doing/Prompt.html +2 -2
  51. data/docs/doc/Doing/Section.html +1 -1
  52. data/docs/doc/Doing/TemplateString.html +2 -2
  53. data/docs/doc/Doing/Types.html +1 -1
  54. data/docs/doc/Doing/Util/Backup.html +5 -5
  55. data/docs/doc/Doing/Util.html +1 -1
  56. data/docs/doc/Doing/WWID.html +197 -4033
  57. data/docs/doc/Doing.html +2 -2
  58. data/docs/doc/FalseClass.html +1 -1
  59. data/docs/doc/GLI/Commands/Help.html +1 -1
  60. data/docs/doc/GLI/Commands/MarkdownDocumentListener.html +1 -1
  61. data/docs/doc/GLI/Commands.html +1 -1
  62. data/docs/doc/GLI.html +1 -1
  63. data/docs/doc/Hash.html +1 -1
  64. data/docs/doc/Object.html +1 -1
  65. data/docs/doc/PhraseParser/Operator.html +1 -1
  66. data/docs/doc/PhraseParser/PhraseClause.html +1 -1
  67. data/docs/doc/PhraseParser/Query.html +1 -1
  68. data/docs/doc/PhraseParser/QueryParser.html +1 -1
  69. data/docs/doc/PhraseParser/QueryTransformer.html +1 -1
  70. data/docs/doc/PhraseParser/TermClause.html +1 -1
  71. data/docs/doc/PhraseParser.html +1 -1
  72. data/docs/doc/Status.html +1 -1
  73. data/docs/doc/String.html +1 -1
  74. data/docs/doc/Symbol.html +1 -1
  75. data/docs/doc/Time.html +1 -1
  76. data/docs/doc/TrueClass.html +1 -1
  77. data/docs/doc/_index.html +26 -5
  78. data/docs/doc/class_list.html +1 -1
  79. data/docs/doc/file.README.html +2 -2
  80. data/docs/doc/index.html +2 -2
  81. data/docs/doc/method_list.html +293 -773
  82. data/docs/doc/top-level-namespace.html +3 -3
  83. data/docs/index.md +1 -1
  84. data/doing.rdoc +49 -7
  85. data/lib/completion/_doing.zsh +5 -5
  86. data/lib/completion/doing.bash +8 -8
  87. data/lib/completion/doing.fish +7 -2
  88. data/lib/doing/add_options.rb +31 -1
  89. data/lib/doing/chronify/array.rb +64 -22
  90. data/lib/doing/colors.rb +77 -30
  91. data/lib/doing/completion.rb +4 -5
  92. data/lib/doing/errors.rb +51 -35
  93. data/lib/doing/hooks.rb +3 -3
  94. data/lib/doing/item/dates.rb +112 -0
  95. data/lib/doing/item/query.rb +433 -0
  96. data/lib/doing/item/state.rb +59 -0
  97. data/lib/doing/item/tags.rb +87 -0
  98. data/lib/doing/item.rb +6 -667
  99. data/lib/doing/items.rb +38 -13
  100. data/lib/doing/plugin_manager.rb +3 -3
  101. data/lib/doing/plugins/export/template_export.rb +4 -4
  102. data/lib/doing/plugins/import/cal_to_json.scpt +0 -0
  103. data/lib/doing/util_backup.rb +6 -8
  104. data/lib/doing/version.rb +1 -1
  105. data/lib/doing/wwid/display.rb +399 -0
  106. data/lib/doing/wwid/editor.rb +214 -0
  107. data/lib/doing/wwid/filetools.rb +186 -0
  108. data/lib/doing/wwid/filter.rb +218 -0
  109. data/lib/doing/wwid/guess.rb +87 -0
  110. data/lib/doing/wwid/interactive.rb +385 -0
  111. data/lib/doing/wwid/modify.rb +618 -0
  112. data/lib/doing/wwid/tags.rb +54 -0
  113. data/lib/doing/wwid/timers.rb +345 -0
  114. data/lib/doing/wwid/wwidutil.rb +104 -0
  115. data/lib/doing/wwid.rb +31 -2317
  116. metadata +19 -2
@@ -247,28 +247,6 @@
247
247
  <li class="public ">
248
248
  <span class="summary_signature">
249
249
 
250
- <a href="#calculate_end_date-instance_method" title="#calculate_end_date (instance method)">#<strong>calculate_end_date</strong>(opt) &#x21d2; Object </a>
251
-
252
-
253
-
254
- </span>
255
-
256
-
257
-
258
-
259
-
260
-
261
-
262
-
263
-
264
- <span class="summary_desc"><div class='inline'></div></span>
265
-
266
- </li>
267
-
268
-
269
- <li class="public ">
270
- <span class="summary_signature">
271
-
272
250
  <a href="#clone-instance_method" title="#clone (instance method)">#<strong>clone</strong> &#x21d2; Object </a>
273
251
 
274
252
 
@@ -285,52 +263,6 @@
285
263
 
286
264
  <span class="summary_desc"><div class='inline'></div></span>
287
265
 
288
- </li>
289
-
290
-
291
- <li class="public ">
292
- <span class="summary_signature">
293
-
294
- <a href="#duration-instance_method" title="#duration (instance method)">#<strong>duration</strong> &#x21d2; Object </a>
295
-
296
-
297
-
298
- </span>
299
-
300
-
301
-
302
-
303
-
304
-
305
-
306
-
307
-
308
- <span class="summary_desc"><div class='inline'><p>If the entry doesn&#39;t have a @done date, return the elapsed time.</p>
309
- </div></span>
310
-
311
- </li>
312
-
313
-
314
- <li class="public ">
315
- <span class="summary_signature">
316
-
317
- <a href="#end_date-instance_method" title="#end_date (instance method)">#<strong>end_date</strong> &#x21d2; Time </a>
318
-
319
-
320
-
321
- </span>
322
-
323
-
324
-
325
-
326
-
327
-
328
-
329
-
330
-
331
- <span class="summary_desc"><div class='inline'><p>Get the value of the item&#39;s @done tag.</p>
332
- </div></span>
333
-
334
266
  </li>
335
267
 
336
268
 
@@ -354,74 +286,6 @@
354
286
  <span class="summary_desc"><div class='inline'><p>Test for equality between items.</p>
355
287
  </div></span>
356
288
 
357
- </li>
358
-
359
-
360
- <li class="public ">
361
- <span class="summary_signature">
362
-
363
- <a href="#expand_date_tags-instance_method" title="#expand_date_tags (instance method)">#<strong>expand_date_tags</strong>(additional_tags = nil) &#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'><p>Updates the title of the Item by expanding natural language dates within configured date tags (tags whose value is expected to be a date).</p>
378
- </div></span>
379
-
380
- </li>
381
-
382
-
383
- <li class="public ">
384
- <span class="summary_signature">
385
-
386
- <a href="#finished%3F-instance_method" title="#finished? (instance method)">#<strong>finished?</strong> &#x21d2; Boolean </a>
387
-
388
-
389
-
390
- </span>
391
-
392
-
393
-
394
-
395
-
396
-
397
-
398
-
399
-
400
- <span class="summary_desc"><div class='inline'><p>Test if item has a @done tag.</p>
401
- </div></span>
402
-
403
- </li>
404
-
405
-
406
- <li class="public ">
407
- <span class="summary_signature">
408
-
409
- <a href="#highlight_search-instance_method" title="#highlight_search (instance method)">#<strong>highlight_search</strong>(search, distance: nil, negate: false, case_type: nil) &#x21d2; Object </a>
410
-
411
-
412
-
413
- </span>
414
-
415
-
416
-
417
-
418
-
419
-
420
-
421
-
422
-
423
- <span class="summary_desc"><div class='inline'></div></span>
424
-
425
289
  </li>
426
290
 
427
291
 
@@ -445,29 +309,6 @@
445
309
  <span class="summary_desc"><div class='inline'><p>Generate a hash that represents the entry.</p>
446
310
  </div></span>
447
311
 
448
- </li>
449
-
450
-
451
- <li class="public ">
452
- <span class="summary_signature">
453
-
454
- <a href="#ignore_case-instance_method" title="#ignore_case (instance method)">#<strong>ignore_case</strong>(search, case_type) &#x21d2; Boolean </a>
455
-
456
-
457
-
458
- </span>
459
-
460
-
461
-
462
-
463
-
464
-
465
-
466
-
467
-
468
- <span class="summary_desc"><div class='inline'><p>Determine if case should be ignored for searches.</p>
469
- </div></span>
470
-
471
312
  </li>
472
313
 
473
314
 
@@ -493,29 +334,6 @@
493
334
  <span class="summary_desc"><div class='inline'><p>Initialize an item with date, title, section, and optional note.</p>
494
335
  </div></span>
495
336
 
496
- </li>
497
-
498
-
499
- <li class="public ">
500
- <span class="summary_signature">
501
-
502
- <a href="#interval-instance_method" title="#interval (instance method)">#<strong>interval</strong> &#x21d2; Object </a>
503
-
504
-
505
-
506
- </span>
507
-
508
-
509
-
510
-
511
-
512
-
513
-
514
-
515
-
516
- <span class="summary_desc"><div class='inline'><p>Get the difference between the item&#39;s start date and the value of its @done tag (if present).</p>
517
- </div></span>
518
-
519
337
  </li>
520
338
 
521
339
 
@@ -545,7 +363,7 @@
545
363
  <li class="public ">
546
364
  <span class="summary_signature">
547
365
 
548
- <a href="#overlapping_time%3F-instance_method" title="#overlapping_time? (instance method)">#<strong>overlapping_time?</strong>(item_b) &#x21d2; Boolean </a>
366
+ <a href="#to_pretty-instance_method" title="#to_pretty (instance method)">#<strong>to_pretty</strong>(elements: %i[date title section]) &#x21d2; Object </a>
549
367
 
550
368
 
551
369
 
@@ -559,7 +377,7 @@
559
377
 
560
378
 
561
379
 
562
- <span class="summary_desc"><div class='inline'><p>Test if the interval between start date and @done value overlaps with another item&#39;s.</p>
380
+ <span class="summary_desc"><div class='inline'><p>outputs a colored string with relative date and highlighted tags.</p>
563
381
  </div></span>
564
382
 
565
383
  </li>
@@ -568,7 +386,7 @@
568
386
  <li class="public ">
569
387
  <span class="summary_signature">
570
388
 
571
- <a href="#same_time%3F-instance_method" title="#same_time? (instance method)">#<strong>same_time?</strong>(item_b) &#x21d2; Boolean </a>
389
+ <a href="#to_s-instance_method" title="#to_s (instance method)">#<strong>to_s</strong> &#x21d2; Object </a>
572
390
 
573
391
 
574
392
 
@@ -582,327 +400,51 @@
582
400
 
583
401
 
584
402
 
585
- <span class="summary_desc"><div class='inline'><p>Test if two items occur at the same time (same start date and equal duration).</p>
403
+ <span class="summary_desc"><div class='inline'><p>outputs item in Doing file format, including leading tab.</p>
586
404
  </div></span>
587
405
 
588
406
  </li>
589
407
 
590
408
 
591
- <li class="public ">
592
- <span class="summary_signature">
593
-
594
- <a href="#search-instance_method" title="#search (instance method)">#<strong>search</strong>(search, distance: nil, negate: false, case_type: nil) &#x21d2; Boolean </a>
595
-
596
-
597
-
598
- </span>
599
-
600
-
601
-
602
-
603
-
604
-
605
-
606
-
607
-
608
- <span class="summary_desc"><div class='inline'><p>Test if item matches search string.</p>
609
- </div></span>
409
+ </ul>
610
410
 
611
- </li>
612
411
 
613
-
614
- <li class="public ">
615
- <span class="summary_signature">
616
-
617
- <a href="#should_finish%3F-instance_method" title="#should_finish? (instance method)">#<strong>should_finish?</strong> &#x21d2; Boolean </a>
618
-
619
412
 
620
-
621
- </span>
622
-
623
-
624
413
 
625
414
 
626
415
 
627
416
 
628
417
 
629
-
630
-
631
- <span class="summary_desc"><div class='inline'><p>Test if item is included in never_finish config and thus should not receive a @done tag.</p>
632
- </div></span>
633
-
634
- </li>
635
-
636
-
637
- <li class="public ">
638
- <span class="summary_signature">
639
-
640
- <a href="#should_time%3F-instance_method" title="#should_time? (instance method)">#<strong>should_time?</strong> &#x21d2; Boolean </a>
641
-
642
-
643
-
644
- </span>
645
-
646
418
 
647
419
 
648
420
 
421
+ <h3 class="inherited">Methods included from <span class='object_link'><a href="Color.html" title="Doing::Color (module)">Color</a></span></h3>
422
+ <p class="inherited"><span class='object_link'><a href="Color.html#attributes-instance_method" title="Doing::Color#attributes (method)">#attributes</a></span>, <span class='object_link'><a href="Color.html#coloring%3F-class_method" title="Doing::Color.coloring? (method)">coloring?</a></span>, <span class='object_link'><a href="Color.html#support%3F-instance_method" title="Doing::Color#support? (method)">#support?</a></span>, <span class='object_link'><a href="Color.html#template-class_method" title="Doing::Color.template (method)">template</a></span>, <span class='object_link'><a href="Color.html#uncolor-instance_method" title="Doing::Color#uncolor (method)">#uncolor</a></span></p>
423
+ <div id="constructor_details" class="method_details_list">
424
+ <h2>Constructor Details</h2>
649
425
 
426
+ <div class="method_details first">
427
+ <h3 class="signature first" id="initialize-instance_method">
650
428
 
429
+ #<strong>initialize</strong>(date, title, section, note = nil) &#x21d2; <tt><span class='object_link'><a href="" title="Doing::Item (class)">Item</a></span></tt>
651
430
 
652
431
 
653
432
 
654
- <span class="summary_desc"><div class='inline'><p>Test if item is included in never_time config and thus should not receive a date on the @done tag.</p>
655
- </div></span>
656
-
657
- </li>
658
433
 
659
-
660
- <li class="public ">
661
- <span class="summary_signature">
662
-
663
- <a href="#tag-instance_method" title="#tag (instance method)">#<strong>tag</strong>(tags, **options) &#x21d2; Object </a>
664
-
665
-
666
-
667
- </span>
668
-
669
-
670
-
671
-
672
-
673
-
674
434
 
435
+ </h3><div class="docstring">
436
+ <div class="discussion">
437
+ <p>Initialize an item with date, title, section, and
438
+ optional note</p>
675
439
 
676
-
677
- <span class="summary_desc"><div class='inline'><p>Add (or remove) tags from the title of the item.</p>
678
- </div></span>
679
-
680
- </li>
681
440
 
682
-
683
- <li class="public ">
684
- <span class="summary_signature">
685
-
686
- <a href="#tag_array-instance_method" title="#tag_array (instance method)">#<strong>tag_array</strong> &#x21d2; Array </a>
687
-
688
-
689
-
690
- </span>
691
-
692
-
693
-
694
-
695
-
696
-
697
-
698
-
699
-
700
- <span class="summary_desc"><div class='inline'><p>convert tags on item to an array with @ symbols removed.</p>
701
- </div></span>
702
-
703
- </li>
704
-
705
-
706
- <li class="public ">
707
- <span class="summary_signature">
708
-
709
- <a href="#tag_values%3F-instance_method" title="#tag_values? (instance method)">#<strong>tag_values?</strong>(queries, bool = :and, negate: false) &#x21d2; Boolean </a>
710
-
711
-
712
-
713
- </span>
714
-
715
-
716
-
717
-
718
-
719
-
720
-
721
-
722
-
723
- <span class="summary_desc"><div class='inline'><p>Test if item matches tag values.</p>
724
- </div></span>
725
-
726
- </li>
727
-
728
-
729
- <li class="public ">
730
- <span class="summary_signature">
731
-
732
- <a href="#tags-instance_method" title="#tags (instance method)">#<strong>tags</strong> &#x21d2; Array </a>
733
-
734
-
735
-
736
- </span>
737
-
738
-
739
-
740
-
741
-
742
-
743
-
744
-
745
-
746
- <span class="summary_desc"><div class='inline'><p>Get a list of tags on the item.</p>
747
- </div></span>
748
-
749
- </li>
750
-
751
-
752
- <li class="public ">
753
- <span class="summary_signature">
754
-
755
- <a href="#tags%3F-instance_method" title="#tags? (instance method)">#<strong>tags?</strong>(tags, bool = :and, negate: false) &#x21d2; Boolean </a>
756
-
757
-
758
-
759
- </span>
760
-
761
-
762
-
763
-
764
-
765
-
766
-
767
-
768
-
769
- <span class="summary_desc"><div class='inline'><p>Test if item contains tag(s).</p>
770
- </div></span>
771
-
772
- </li>
773
-
774
-
775
- <li class="public ">
776
- <span class="summary_signature">
777
-
778
- <a href="#tags_with_values-instance_method" title="#tags_with_values (instance method)">#<strong>tags_with_values</strong> &#x21d2; Array&lt;Array&gt; </a>
779
-
780
-
781
-
782
- </span>
783
-
784
-
785
-
786
-
787
-
788
-
789
-
790
-
791
-
792
- <span class="summary_desc"><div class='inline'><p>Return all tags including parenthetical values.</p>
793
- </div></span>
794
-
795
- </li>
796
-
797
-
798
- <li class="public ">
799
- <span class="summary_signature">
800
-
801
- <a href="#to_pretty-instance_method" title="#to_pretty (instance method)">#<strong>to_pretty</strong>(elements: %i[date title section]) &#x21d2; Object </a>
802
-
803
-
804
-
805
- </span>
806
-
807
-
808
-
809
-
810
-
811
-
812
-
813
-
814
-
815
- <span class="summary_desc"><div class='inline'><p>outputs a colored string with relative date and highlighted tags.</p>
816
- </div></span>
817
-
818
- </li>
819
-
820
-
821
- <li class="public ">
822
- <span class="summary_signature">
823
-
824
- <a href="#to_s-instance_method" title="#to_s (instance method)">#<strong>to_s</strong> &#x21d2; Object </a>
825
-
826
-
827
-
828
- </span>
829
-
830
-
831
-
832
-
833
-
834
-
835
-
836
-
837
-
838
- <span class="summary_desc"><div class='inline'><p>outputs item in Doing file format, including leading tab.</p>
839
- </div></span>
840
-
841
- </li>
842
-
843
-
844
- <li class="public ">
845
- <span class="summary_signature">
846
-
847
- <a href="#unfinished%3F-instance_method" title="#unfinished? (instance method)">#<strong>unfinished?</strong> &#x21d2; Boolean </a>
848
-
849
-
850
-
851
- </span>
852
-
853
-
854
-
855
-
856
-
857
-
858
-
859
-
860
-
861
- <span class="summary_desc"><div class='inline'><p>Test if item does not contain @done tag.</p>
862
- </div></span>
863
-
864
- </li>
865
-
866
-
867
- </ul>
868
-
869
-
870
-
871
-
872
-
873
-
874
-
875
-
876
-
877
-
878
-
879
- <h3 class="inherited">Methods included from <span class='object_link'><a href="Color.html" title="Doing::Color (module)">Color</a></span></h3>
880
- <p class="inherited"><span class='object_link'><a href="Color.html#attributes-class_method" title="Doing::Color.attributes (method)">attributes</a></span>, <span class='object_link'><a href="Color.html#coloring%3F-class_method" title="Doing::Color.coloring? (method)">coloring?</a></span>, <span class='object_link'><a href="Color.html#support%3F-instance_method" title="Doing::Color#support? (method)">#support?</a></span>, <span class='object_link'><a href="Color.html#uncolor-instance_method" title="Doing::Color#uncolor (method)">#uncolor</a></span></p>
881
- <div id="constructor_details" class="method_details_list">
882
- <h2>Constructor Details</h2>
883
-
884
- <div class="method_details first">
885
- <h3 class="signature first" id="initialize-instance_method">
886
-
887
- #<strong>initialize</strong>(date, title, section, note = nil) &#x21d2; <tt><span class='object_link'><a href="" title="Doing::Item (class)">Item</a></span></tt>
888
-
889
-
890
-
891
-
892
-
893
- </h3><div class="docstring">
894
- <div class="discussion">
895
- <p>Initialize an item with date, title, section, and
896
- optional note</p>
897
-
898
-
899
- </div>
900
- </div>
901
- <div class="tags">
902
- <p class="tag_title">Parameters:</p>
903
- <ul class="param">
904
-
905
- <li>
441
+ </div>
442
+ </div>
443
+ <div class="tags">
444
+ <p class="tag_title">Parameters:</p>
445
+ <ul class="param">
446
+
447
+ <li>
906
448
 
907
449
  <span class='name'>date</span>
908
450
 
@@ -990,855 +532,23 @@ the item belongs</p>
990
532
 
991
533
  </h3><div class="docstring">
992
534
  <div class="discussion">
993
- <p>Returns the value of attribute date.</p>
994
-
995
-
996
- </div>
997
- </div>
998
- <div class="tags">
999
-
1000
-
1001
- </div>
1002
- </div>
1003
-
1004
-
1005
- <span id="note=-instance_method"></span>
1006
- <div class="method_details ">
1007
- <h3 class="signature " id="note-instance_method">
1008
-
1009
- #<strong>note</strong> &#x21d2; <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt>
1010
-
1011
-
1012
-
1013
-
1014
-
1015
- </h3><div class="docstring">
1016
- <div class="discussion">
1017
- <p>Returns the value of attribute note.</p>
1018
-
1019
-
1020
- </div>
1021
- </div>
1022
- <div class="tags">
1023
-
1024
-
1025
- </div>
1026
- </div>
1027
-
1028
-
1029
- <span id="section=-instance_method"></span>
1030
- <div class="method_details ">
1031
- <h3 class="signature " id="section-instance_method">
1032
-
1033
- #<strong>section</strong> &#x21d2; <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt>
1034
-
1035
-
1036
-
1037
-
1038
-
1039
- </h3><div class="docstring">
1040
- <div class="discussion">
1041
- <p>Returns the value of attribute section.</p>
1042
-
1043
-
1044
- </div>
1045
- </div>
1046
- <div class="tags">
1047
-
1048
-
1049
- </div>
1050
- </div>
1051
-
1052
-
1053
- <span id="title=-instance_method"></span>
1054
- <div class="method_details ">
1055
- <h3 class="signature " id="title-instance_method">
1056
-
1057
- #<strong>title</strong> &#x21d2; <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt>
1058
-
1059
-
1060
-
1061
-
1062
-
1063
- </h3><div class="docstring">
1064
- <div class="discussion">
1065
- <p>Returns the value of attribute title.</p>
1066
-
1067
-
1068
- </div>
1069
- </div>
1070
- <div class="tags">
1071
-
1072
-
1073
- </div>
1074
- </div>
1075
-
1076
- </div>
1077
-
1078
-
1079
- <div id="instance_method_details" class="method_details_list">
1080
- <h2>Instance Method Details</h2>
1081
-
1082
-
1083
- <div class="method_details first">
1084
- <h3 class="signature first" id="calculate_end_date-instance_method">
1085
-
1086
- #<strong>calculate_end_date</strong>(opt) &#x21d2; <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt>
1087
-
1088
-
1089
-
1090
-
1091
-
1092
- </h3>
1093
- </div>
1094
-
1095
- <div class="method_details ">
1096
- <h3 class="signature " id="clone-instance_method">
1097
-
1098
- #<strong>clone</strong> &#x21d2; <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt>
1099
-
1100
-
1101
-
1102
-
1103
-
1104
- </h3>
1105
- </div>
1106
-
1107
- <div class="method_details ">
1108
- <h3 class="signature " id="duration-instance_method">
1109
-
1110
- #<strong>duration</strong> &#x21d2; <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt>
1111
-
1112
-
1113
-
1114
-
1115
-
1116
- </h3><div class="docstring">
1117
- <div class="discussion">
1118
- <p>If the entry doesn&#39;t have a @done date, return the elapsed time</p>
1119
-
1120
-
1121
- </div>
1122
- </div>
1123
- <div class="tags">
1124
-
1125
-
1126
- </div>
1127
- </div>
1128
-
1129
- <div class="method_details ">
1130
- <h3 class="signature " id="end_date-instance_method">
1131
-
1132
- #<strong>end_date</strong> &#x21d2; <tt><span class='object_link'><a href="../Time.html" title="Time (class)">Time</a></span></tt>
1133
-
1134
-
1135
-
1136
-
1137
-
1138
- </h3><div class="docstring">
1139
- <div class="discussion">
1140
- <p>Get the value of the item&#39;s @done tag</p>
1141
-
1142
-
1143
- </div>
1144
- </div>
1145
- <div class="tags">
1146
-
1147
- <p class="tag_title">Returns:</p>
1148
- <ul class="return">
1149
-
1150
- <li>
1151
-
1152
-
1153
- <span class='type'>(<tt><span class='object_link'><a href="../Time.html" title="Time (class)">Time</a></span></tt>)</span>
1154
-
1155
-
1156
-
1157
- &mdash;
1158
- <div class='inline'><p>@done value</p>
1159
- </div>
1160
-
1161
- </li>
1162
-
1163
- </ul>
1164
-
1165
- </div>
1166
- </div>
1167
-
1168
- <div class="method_details ">
1169
- <h3 class="signature " id="equal?-instance_method">
1170
-
1171
- #<strong>equal?</strong>(other, match_section: false) &#x21d2; <tt>Boolean</tt>
1172
-
1173
-
1174
-
1175
-
1176
-
1177
- </h3><div class="docstring">
1178
- <div class="discussion">
1179
- <p>Test for equality between items</p>
1180
-
1181
-
1182
- </div>
1183
- </div>
1184
- <div class="tags">
1185
- <p class="tag_title">Parameters:</p>
1186
- <ul class="param">
1187
-
1188
- <li>
1189
-
1190
- <span class='name'>other</span>
1191
-
1192
-
1193
- <span class='type'>(<tt><span class='object_link'><a href="" title="Doing::Item (class)">Item</a></span></tt>)</span>
1194
-
1195
-
1196
-
1197
- &mdash;
1198
- <div class='inline'><p>The other item</p>
1199
- </div>
1200
-
1201
- </li>
1202
-
1203
- <li>
1204
-
1205
- <span class='name'>match_section</span>
1206
-
1207
-
1208
- <span class='type'>(<tt>Boolean</tt>)</span>
1209
-
1210
-
1211
- <em class="default">(defaults to: <tt>false</tt>)</em>
1212
-
1213
-
1214
- &mdash;
1215
- <div class='inline'><p>If true, require item sections to match</p>
1216
- </div>
1217
-
1218
- </li>
1219
-
1220
- </ul>
1221
-
1222
- <p class="tag_title">Returns:</p>
1223
- <ul class="return">
1224
-
1225
- <li>
1226
-
1227
-
1228
- <span class='type'>(<tt>Boolean</tt>)</span>
1229
-
1230
-
1231
-
1232
- &mdash;
1233
- <div class='inline'><p>is equal?</p>
1234
- </div>
1235
-
1236
- </li>
1237
-
1238
- </ul>
1239
-
1240
- </div>
1241
- </div>
1242
-
1243
- <div class="method_details ">
1244
- <h3 class="signature " id="expand_date_tags-instance_method">
1245
-
1246
- #<strong>expand_date_tags</strong>(additional_tags = nil) &#x21d2; <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt>
1247
-
1248
-
1249
-
1250
-
1251
-
1252
- </h3><div class="docstring">
1253
- <div class="discussion">
1254
- <p>Updates the title of the Item by expanding natural
1255
- language dates within configured date tags (tags
1256
- whose value is expected to be a date)</p>
1257
-
1258
-
1259
- </div>
1260
- </div>
1261
- <div class="tags">
1262
- <p class="tag_title">Parameters:</p>
1263
- <ul class="param">
1264
-
1265
- <li>
1266
-
1267
- <span class='name'>additional_tags</span>
1268
-
1269
-
1270
- <span class='type'></span>
1271
-
1272
-
1273
- <em class="default">(defaults to: <tt>nil</tt>)</em>
1274
-
1275
-
1276
- &mdash;
1277
- <div class='inline'><p>An array of additional
1278
- tag names to consider
1279
- dates</p>
1280
- </div>
1281
-
1282
- </li>
1283
-
1284
- </ul>
1285
-
1286
-
1287
- </div>
1288
- </div>
1289
-
1290
- <div class="method_details ">
1291
- <h3 class="signature " id="finished?-instance_method">
1292
-
1293
- #<strong>finished?</strong> &#x21d2; <tt>Boolean</tt>
1294
-
1295
-
1296
-
1297
-
1298
-
1299
- </h3><div class="docstring">
1300
- <div class="discussion">
1301
- <p>Test if item has a @done tag</p>
1302
-
1303
-
1304
- </div>
1305
- </div>
1306
- <div class="tags">
1307
-
1308
- <p class="tag_title">Returns:</p>
1309
- <ul class="return">
1310
-
1311
- <li>
1312
-
1313
-
1314
- <span class='type'>(<tt>Boolean</tt>)</span>
1315
-
1316
-
1317
-
1318
- &mdash;
1319
- <div class='inline'><p>true item has @done tag</p>
1320
- </div>
1321
-
1322
- </li>
1323
-
1324
- </ul>
1325
-
1326
- </div>
1327
- </div>
1328
-
1329
- <div class="method_details ">
1330
- <h3 class="signature " id="highlight_search-instance_method">
1331
-
1332
- #<strong>highlight_search</strong>(search, distance: nil, negate: false, case_type: nil) &#x21d2; <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt>
1333
-
1334
-
1335
-
1336
-
1337
-
1338
- </h3>
1339
- </div>
1340
-
1341
- <div class="method_details ">
1342
- <h3 class="signature " id="id-instance_method">
1343
-
1344
- #<strong>id</strong> &#x21d2; <tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>
1345
-
1346
-
1347
-
1348
-
1349
-
1350
- </h3><div class="docstring">
1351
- <div class="discussion">
1352
- <p>Generate a hash that represents the entry</p>
1353
-
1354
-
1355
- </div>
1356
- </div>
1357
- <div class="tags">
1358
-
1359
- <p class="tag_title">Returns:</p>
1360
- <ul class="return">
1361
-
1362
- <li>
1363
-
1364
-
1365
- <span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
1366
-
1367
-
1368
-
1369
- &mdash;
1370
- <div class='inline'><p>entry hash</p>
1371
- </div>
1372
-
1373
- </li>
1374
-
1375
- </ul>
1376
-
1377
- </div>
1378
- </div>
1379
-
1380
- <div class="method_details ">
1381
- <h3 class="signature " id="ignore_case-instance_method">
1382
-
1383
- #<strong>ignore_case</strong>(search, case_type) &#x21d2; <tt>Boolean</tt>
1384
-
1385
-
1386
-
1387
-
1388
-
1389
- </h3><div class="docstring">
1390
- <div class="discussion">
1391
- <p>Determine if case should be ignored for searches</p>
1392
-
1393
-
1394
- </div>
1395
- </div>
1396
- <div class="tags">
1397
- <p class="tag_title">Parameters:</p>
1398
- <ul class="param">
1399
-
1400
- <li>
1401
-
1402
- <span class='name'>search</span>
1403
-
1404
-
1405
- <span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
1406
-
1407
-
1408
-
1409
- &mdash;
1410
- <div class='inline'><p>The search string</p>
1411
- </div>
1412
-
1413
- </li>
1414
-
1415
- <li>
1416
-
1417
- <span class='name'>case_type</span>
1418
-
1419
-
1420
- <span class='type'>(<tt><span class='object_link'><a href="../Symbol.html" title="Symbol (class)">Symbol</a></span></tt>)</span>
1421
-
1422
-
1423
-
1424
- &mdash;
1425
- <div class='inline'><p>The case type</p>
1426
- </div>
1427
-
1428
- </li>
1429
-
1430
- </ul>
1431
-
1432
- <p class="tag_title">Returns:</p>
1433
- <ul class="return">
1434
-
1435
- <li>
1436
-
1437
-
1438
- <span class='type'>(<tt>Boolean</tt>)</span>
1439
-
1440
-
1441
-
1442
- &mdash;
1443
- <div class='inline'><p>case should be ignored</p>
1444
- </div>
1445
-
1446
- </li>
1447
-
1448
- </ul>
1449
-
1450
- </div>
1451
- </div>
1452
-
1453
- <div class="method_details ">
1454
- <h3 class="signature " id="interval-instance_method">
1455
-
1456
- #<strong>interval</strong> &#x21d2; <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt>
1457
-
1458
-
1459
-
1460
-
1461
-
1462
- </h3><div class="docstring">
1463
- <div class="discussion">
1464
- <p>Get the difference between the item&#39;s start date and
1465
- the value of its @done tag (if present)</p>
1466
-
1467
-
1468
- </div>
1469
- </div>
1470
- <div class="tags">
1471
-
1472
- <p class="tag_title">Returns:</p>
1473
- <ul class="return">
1474
-
1475
- <li>
1476
-
1477
-
1478
- <span class='type'></span>
1479
-
1480
-
1481
-
1482
-
1483
- <div class='inline'><p>Interval in seconds</p>
1484
- </div>
1485
-
1486
- </li>
1487
-
1488
- </ul>
1489
-
1490
- </div>
1491
- </div>
1492
-
1493
- <div class="method_details ">
1494
- <h3 class="signature " id="move_to-instance_method">
1495
-
1496
- #<strong>move_to</strong>(new_section, label: true, log: true) &#x21d2; <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt>
1497
-
1498
-
1499
-
1500
-
1501
-
1502
- </h3><div class="docstring">
1503
- <div class="discussion">
1504
- <p>Move item from current section to destination section</p>
1505
-
1506
-
1507
- </div>
1508
- </div>
1509
- <div class="tags">
1510
- <p class="tag_title">Parameters:</p>
1511
- <ul class="param">
1512
-
1513
- <li>
1514
-
1515
- <span class='name'>new_section</span>
1516
-
1517
-
1518
- <span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
1519
-
1520
-
1521
-
1522
- &mdash;
1523
- <div class='inline'><p>The destination
1524
- section</p>
1525
- </div>
1526
-
1527
- </li>
1528
-
1529
- <li>
1530
-
1531
- <span class='name'>label</span>
1532
-
1533
-
1534
- <span class='type'>(<tt>Boolean</tt>)</span>
1535
-
1536
-
1537
- <em class="default">(defaults to: <tt>true</tt>)</em>
1538
-
1539
-
1540
- &mdash;
1541
- <div class='inline'><p>add @from(original
1542
- section) tag</p>
1543
- </div>
1544
-
1545
- </li>
1546
-
1547
- <li>
1548
-
1549
- <span class='name'>log</span>
1550
-
1551
-
1552
- <span class='type'>(<tt>Boolean</tt>)</span>
1553
-
1554
-
1555
- <em class="default">(defaults to: <tt>true</tt>)</em>
1556
-
1557
-
1558
- &mdash;
1559
- <div class='inline'><p>log this action</p>
1560
- </div>
1561
-
1562
- </li>
1563
-
1564
- </ul>
1565
-
1566
- <p class="tag_title">Returns:</p>
1567
- <ul class="return">
1568
-
1569
- <li>
1570
-
1571
-
1572
- <span class='type'></span>
1573
-
1574
-
1575
-
1576
-
1577
- <div class='inline'><p>nothing</p>
1578
- </div>
1579
-
1580
- </li>
1581
-
1582
- </ul>
1583
-
1584
- </div>
1585
- </div>
1586
-
1587
- <div class="method_details ">
1588
- <h3 class="signature " id="overlapping_time?-instance_method">
1589
-
1590
- #<strong>overlapping_time?</strong>(item_b) &#x21d2; <tt>Boolean</tt>
1591
-
1592
-
1593
-
1594
-
1595
-
1596
- </h3><div class="docstring">
1597
- <div class="discussion">
1598
- <p>Test if the interval between start date and @done
1599
- value overlaps with another item&#39;s</p>
1600
-
1601
-
1602
- </div>
1603
- </div>
1604
- <div class="tags">
1605
- <p class="tag_title">Parameters:</p>
1606
- <ul class="param">
1607
-
1608
- <li>
1609
-
1610
- <span class='name'>item_b</span>
1611
-
1612
-
1613
- <span class='type'>(<tt><span class='object_link'><a href="" title="Doing::Item (class)">Item</a></span></tt>)</span>
1614
-
1615
-
1616
-
1617
- &mdash;
1618
- <div class='inline'><p>The item to compare</p>
1619
- </div>
1620
-
1621
- </li>
1622
-
1623
- </ul>
1624
-
1625
- <p class="tag_title">Returns:</p>
1626
- <ul class="return">
1627
-
1628
- <li>
1629
-
1630
-
1631
- <span class='type'>(<tt>Boolean</tt>)</span>
1632
-
1633
-
1634
-
1635
- &mdash;
1636
- <div class='inline'><p>overlaps?</p>
1637
- </div>
1638
-
1639
- </li>
1640
-
1641
- </ul>
1642
-
1643
- </div>
1644
- </div>
1645
-
1646
- <div class="method_details ">
1647
- <h3 class="signature " id="same_time?-instance_method">
1648
-
1649
- #<strong>same_time?</strong>(item_b) &#x21d2; <tt>Boolean</tt>
1650
-
1651
-
1652
-
1653
-
1654
-
1655
- </h3><div class="docstring">
1656
- <div class="discussion">
1657
- <p>Test if two items occur at the same time (same start date and equal duration)</p>
1658
-
1659
-
1660
- </div>
1661
- </div>
1662
- <div class="tags">
1663
- <p class="tag_title">Parameters:</p>
1664
- <ul class="param">
1665
-
1666
- <li>
1667
-
1668
- <span class='name'>item_b</span>
1669
-
1670
-
1671
- <span class='type'>(<tt><span class='object_link'><a href="" title="Doing::Item (class)">Item</a></span></tt>)</span>
1672
-
1673
-
1674
-
1675
- &mdash;
1676
- <div class='inline'><p>The item to compare</p>
1677
- </div>
1678
-
1679
- </li>
1680
-
1681
- </ul>
1682
-
1683
- <p class="tag_title">Returns:</p>
1684
- <ul class="return">
1685
-
1686
- <li>
1687
-
1688
-
1689
- <span class='type'>(<tt>Boolean</tt>)</span>
1690
-
1691
-
1692
-
1693
- &mdash;
1694
- <div class='inline'><p>is equal?</p>
1695
- </div>
1696
-
1697
- </li>
1698
-
1699
- </ul>
1700
-
1701
- </div>
1702
- </div>
1703
-
1704
- <div class="method_details ">
1705
- <h3 class="signature " id="search-instance_method">
1706
-
1707
- #<strong>search</strong>(search, distance: nil, negate: false, case_type: nil) &#x21d2; <tt>Boolean</tt>
1708
-
1709
-
1710
-
1711
-
1712
-
1713
- </h3><div class="docstring">
1714
- <div class="discussion">
1715
- <p>Test if item matches search string</p>
1716
-
1717
-
1718
- </div>
1719
- </div>
1720
- <div class="tags">
1721
- <p class="tag_title">Parameters:</p>
1722
- <ul class="param">
1723
-
1724
- <li>
1725
-
1726
- <span class='name'>search</span>
1727
-
1728
-
1729
- <span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
1730
-
1731
-
1732
-
1733
- &mdash;
1734
- <div class='inline'><p>The search string</p>
1735
- </div>
1736
-
1737
- </li>
1738
-
1739
- <li>
1740
-
1741
- <span class='name'>negate</span>
1742
-
1743
-
1744
- <span class='type'>(<tt>Boolean</tt>)</span>
1745
-
1746
-
1747
- <em class="default">(defaults to: <tt>false</tt>)</em>
1748
-
1749
-
1750
- &mdash;
1751
- <div class='inline'><p>negate results</p>
1752
- </div>
1753
-
1754
- </li>
1755
-
1756
- <li>
1757
-
1758
- <span class='name'>case_type</span>
1759
-
1760
-
1761
- <span class='type'>(<tt><span class='object_link'><a href="../Symbol.html" title="Symbol (class)">Symbol</a></span></tt>)</span>
1762
-
1763
-
1764
- <em class="default">(defaults to: <tt>nil</tt>)</em>
1765
-
1766
-
1767
- &mdash;
1768
- <div class='inline'><p>The case-sensitivity
1769
- type (:sensitive,
1770
- :ignore, :smart)</p>
1771
- </div>
1772
-
1773
- </li>
1774
-
1775
- </ul>
1776
-
1777
- <p class="tag_title">Returns:</p>
1778
- <ul class="return">
1779
-
1780
- <li>
1781
-
1782
-
1783
- <span class='type'>(<tt>Boolean</tt>)</span>
1784
-
1785
-
1786
-
1787
- &mdash;
1788
- <div class='inline'><p>matches search criteria</p>
1789
- </div>
1790
-
1791
- </li>
1792
-
1793
- </ul>
1794
-
1795
- </div>
1796
- </div>
1797
-
1798
- <div class="method_details ">
1799
- <h3 class="signature " id="should_finish?-instance_method">
1800
-
1801
- #<strong>should_finish?</strong> &#x21d2; <tt>Boolean</tt>
1802
-
1803
-
1804
-
1805
-
1806
-
1807
- </h3><div class="docstring">
1808
- <div class="discussion">
1809
- <p>Test if item is included in never_finish config and
1810
- thus should not receive a @done tag</p>
535
+ <p>Returns the value of attribute date.</p>
1811
536
 
1812
537
 
1813
538
  </div>
1814
539
  </div>
1815
540
  <div class="tags">
1816
541
 
1817
- <p class="tag_title">Returns:</p>
1818
- <ul class="return">
1819
-
1820
- <li>
1821
-
1822
-
1823
- <span class='type'>(<tt>Boolean</tt>)</span>
1824
-
1825
-
1826
-
1827
- &mdash;
1828
- <div class='inline'><p>item should receive @done tag</p>
1829
- </div>
1830
-
1831
- </li>
1832
-
1833
- </ul>
1834
542
 
1835
543
  </div>
1836
544
  </div>
1837
545
 
546
+
547
+ <span id="note=-instance_method"></span>
1838
548
  <div class="method_details ">
1839
- <h3 class="signature " id="should_time?-instance_method">
549
+ <h3 class="signature " id="note-instance_method">
1840
550
 
1841
- #<strong>should_time?</strong> &#x21d2; <tt>Boolean</tt>
551
+ #<strong>note</strong> &#x21d2; <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt>
1842
552
 
1843
553
 
1844
554
 
@@ -1846,39 +556,23 @@ thus should not receive a @done tag</p>
1846
556
 
1847
557
  </h3><div class="docstring">
1848
558
  <div class="discussion">
1849
- <p>Test if item is included in never_time config and
1850
- thus should not receive a date on the @done tag</p>
559
+ <p>Returns the value of attribute note.</p>
1851
560
 
1852
561
 
1853
562
  </div>
1854
563
  </div>
1855
564
  <div class="tags">
1856
565
 
1857
- <p class="tag_title">Returns:</p>
1858
- <ul class="return">
1859
-
1860
- <li>
1861
-
1862
-
1863
- <span class='type'>(<tt>Boolean</tt>)</span>
1864
-
1865
-
1866
-
1867
- &mdash;
1868
- <div class='inline'><p>item should receive @done date</p>
1869
- </div>
1870
-
1871
- </li>
1872
-
1873
- </ul>
1874
566
 
1875
567
  </div>
1876
568
  </div>
1877
569
 
570
+
571
+ <span id="section=-instance_method"></span>
1878
572
  <div class="method_details ">
1879
- <h3 class="signature " id="tag-instance_method">
573
+ <h3 class="signature " id="section-instance_method">
1880
574
 
1881
- #<strong>tag</strong>(tags, **options) &#x21d2; <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt>
575
+ #<strong>section</strong> &#x21d2; <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt>
1882
576
 
1883
577
 
1884
578
 
@@ -1886,150 +580,23 @@ thus should not receive a date on the @done tag</p>
1886
580
 
1887
581
  </h3><div class="docstring">
1888
582
  <div class="discussion">
1889
- <p>Add (or remove) tags from the title of the item</p>
583
+ <p>Returns the value of attribute section.</p>
1890
584
 
1891
585
 
1892
586
  </div>
1893
587
  </div>
1894
588
  <div class="tags">
1895
- <p class="tag_title">Parameters:</p>
1896
- <ul class="param">
1897
-
1898
- <li>
1899
-
1900
- <span class='name'>tags</span>
1901
-
1902
-
1903
- <span class='type'>(<tt><span class='object_link'><a href="../Array.html" title="Array (class)">Array</a></span></tt>)</span>
1904
-
1905
-
1906
-
1907
- &mdash;
1908
- <div class='inline'><p>The tags to apply</p>
1909
- </div>
1910
-
1911
- </li>
1912
-
1913
- <li>
1914
-
1915
- <span class='name'>options</span>
1916
-
1917
-
1918
- <span class='type'></span>
1919
-
1920
-
1921
-
1922
- &mdash;
1923
- <div class='inline'><p>Additional options</p>
1924
- </div>
1925
-
1926
- </li>
1927
-
1928
- </ul>
1929
-
1930
-
1931
-
1932
-
1933
-
1934
-
1935
- <p class="tag_title">Options Hash (<tt>**options</tt>):</p>
1936
- <ul class="option">
1937
-
1938
- <li>
1939
- <span class="name">:date</span>
1940
- <span class="type">(<tt>Boolean</tt>)</span>
1941
- <span class="default">
1942
-
1943
- </span>
1944
-
1945
- &mdash; <div class='inline'><p>Include timestamp?</p>
1946
- </div>
1947
-
1948
- </li>
1949
-
1950
- <li>
1951
- <span class="name">:single</span>
1952
- <span class="type">(<tt>Boolean</tt>)</span>
1953
- <span class="default">
1954
-
1955
- </span>
1956
-
1957
- &mdash; <div class='inline'><p>Log as a single change?</p>
1958
- </div>
1959
-
1960
- </li>
1961
-
1962
- <li>
1963
- <span class="name">:value</span>
1964
- <span class="type">(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
1965
- <span class="default">
1966
-
1967
- </span>
1968
-
1969
- &mdash; <div class='inline'><p>A value to include as @tag(value)</p>
1970
- </div>
1971
-
1972
- </li>
1973
-
1974
- <li>
1975
- <span class="name">:remove</span>
1976
- <span class="type">(<tt>Boolean</tt>)</span>
1977
- <span class="default">
1978
-
1979
- </span>
1980
-
1981
- &mdash; <div class='inline'><p>if true remove instead of adding</p>
1982
- </div>
1983
-
1984
- </li>
1985
-
1986
- <li>
1987
- <span class="name">:rename_to</span>
1988
- <span class="type">(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
1989
- <span class="default">
1990
-
1991
- </span>
1992
-
1993
- &mdash; <div class='inline'><p>if not nil, rename target tag to this tag name</p>
1994
- </div>
1995
-
1996
- </li>
1997
-
1998
- <li>
1999
- <span class="name">:regex</span>
2000
- <span class="type">(<tt>Boolean</tt>)</span>
2001
- <span class="default">
2002
-
2003
- </span>
2004
-
2005
- &mdash; <div class='inline'><p>treat target tag string as regex pattern</p>
2006
- </div>
2007
-
2008
- </li>
2009
-
2010
- <li>
2011
- <span class="name">:force</span>
2012
- <span class="type">(<tt>Boolean</tt>)</span>
2013
- <span class="default">
2014
-
2015
- </span>
2016
-
2017
- &mdash; <div class='inline'><p>with rename_to, add tag if it doesn&#39;t exist</p>
2018
- </div>
2019
-
2020
- </li>
2021
-
2022
- </ul>
2023
589
 
2024
590
 
2025
-
2026
591
  </div>
2027
592
  </div>
2028
593
 
594
+
595
+ <span id="title=-instance_method"></span>
2029
596
  <div class="method_details ">
2030
- <h3 class="signature " id="tag_array-instance_method">
597
+ <h3 class="signature " id="title-instance_method">
2031
598
 
2032
- #<strong>tag_array</strong> &#x21d2; <tt><span class='object_link'><a href="../Array.html" title="Array (class)">Array</a></span></tt>
599
+ #<strong>title</strong> &#x21d2; <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt>
2033
600
 
2034
601
 
2035
602
 
@@ -2037,38 +604,40 @@ thus should not receive a date on the @done tag</p>
2037
604
 
2038
605
  </h3><div class="docstring">
2039
606
  <div class="discussion">
2040
- <p>convert tags on item to an array with @ symbols removed</p>
607
+ <p>Returns the value of attribute title.</p>
2041
608
 
2042
609
 
2043
610
  </div>
2044
611
  </div>
2045
612
  <div class="tags">
2046
613
 
2047
- <p class="tag_title">Returns:</p>
2048
- <ul class="return">
2049
-
2050
- <li>
2051
-
2052
-
2053
- <span class='type'>(<tt><span class='object_link'><a href="../Array.html" title="Array (class)">Array</a></span></tt>)</span>
2054
-
2055
-
2056
-
2057
- &mdash;
2058
- <div class='inline'><p>array of tags</p>
614
+
2059
615
  </div>
2060
-
2061
- </li>
616
+ </div>
617
+
618
+ </div>
619
+
620
+
621
+ <div id="instance_method_details" class="method_details_list">
622
+ <h2>Instance Method Details</h2>
623
+
624
+
625
+ <div class="method_details first">
626
+ <h3 class="signature first" id="clone-instance_method">
627
+
628
+ #<strong>clone</strong> &#x21d2; <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt>
2062
629
 
2063
- </ul>
2064
630
 
2065
- </div>
631
+
632
+
633
+
634
+ </h3>
2066
635
  </div>
2067
636
 
2068
637
  <div class="method_details ">
2069
- <h3 class="signature " id="tag_values?-instance_method">
638
+ <h3 class="signature " id="equal?-instance_method">
2070
639
 
2071
- #<strong>tag_values?</strong>(queries, bool = :and, negate: false) &#x21d2; <tt>Boolean</tt>
640
+ #<strong>equal?</strong>(other, match_section: false) &#x21d2; <tt>Boolean</tt>
2072
641
 
2073
642
 
2074
643
 
@@ -2076,7 +645,7 @@ thus should not receive a date on the @done tag</p>
2076
645
 
2077
646
  </h3><div class="docstring">
2078
647
  <div class="discussion">
2079
- <p>Test if item matches tag values</p>
648
+ <p>Test for equality between items</p>
2080
649
 
2081
650
 
2082
651
  </div>
@@ -2087,39 +656,22 @@ thus should not receive a date on the @done tag</p>
2087
656
 
2088
657
  <li>
2089
658
 
2090
- <span class='name'>queries</span>
2091
-
2092
-
2093
- <span class='type'>(<tt><span class='object_link'><a href="../Array.html" title="Array (class)">Array</a></span></tt>)</span>
2094
-
2095
-
2096
-
2097
- &mdash;
2098
- <div class='inline'><p>The tag value queries to test</p>
2099
- </div>
2100
-
2101
- </li>
2102
-
2103
- <li>
2104
-
2105
- <span class='name'>bool</span>
2106
-
659
+ <span class='name'>other</span>
2107
660
 
2108
- <span class='type'>(<tt><span class='object_link'><a href="../Symbol.html" title="Symbol (class)">Symbol</a></span></tt>)</span>
2109
661
 
662
+ <span class='type'>(<tt><span class='object_link'><a href="" title="Doing::Item (class)">Item</a></span></tt>)</span>
2110
663
 
2111
- <em class="default">(defaults to: <tt>:and</tt>)</em>
2112
664
 
2113
665
 
2114
666
  &mdash;
2115
- <div class='inline'><p>The boolean to use for multiple tags (:and, :or, :not)</p>
667
+ <div class='inline'><p>The other item</p>
2116
668
  </div>
2117
669
 
2118
670
  </li>
2119
671
 
2120
672
  <li>
2121
673
 
2122
- <span class='name'>negate</span>
674
+ <span class='name'>match_section</span>
2123
675
 
2124
676
 
2125
677
  <span class='type'>(<tt>Boolean</tt>)</span>
@@ -2129,7 +681,7 @@ thus should not receive a date on the @done tag</p>
2129
681
 
2130
682
 
2131
683
  &mdash;
2132
- <div class='inline'><p>negate the result?</p>
684
+ <div class='inline'><p>If true, require item sections to match</p>
2133
685
  </div>
2134
686
 
2135
687
  </li>
@@ -2147,7 +699,7 @@ thus should not receive a date on the @done tag</p>
2147
699
 
2148
700
 
2149
701
  &mdash;
2150
- <div class='inline'><p>true if tag/bool combination passes</p>
702
+ <div class='inline'><p>is equal?</p>
2151
703
  </div>
2152
704
 
2153
705
  </li>
@@ -2158,9 +710,9 @@ thus should not receive a date on the @done tag</p>
2158
710
  </div>
2159
711
 
2160
712
  <div class="method_details ">
2161
- <h3 class="signature " id="tags-instance_method">
713
+ <h3 class="signature " id="id-instance_method">
2162
714
 
2163
- #<strong>tags</strong> &#x21d2; <tt><span class='object_link'><a href="../Array.html" title="Array (class)">Array</a></span></tt>
715
+ #<strong>id</strong> &#x21d2; <tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>
2164
716
 
2165
717
 
2166
718
 
@@ -2168,7 +720,7 @@ thus should not receive a date on the @done tag</p>
2168
720
 
2169
721
  </h3><div class="docstring">
2170
722
  <div class="discussion">
2171
- <p>Get a list of tags on the item</p>
723
+ <p>Generate a hash that represents the entry</p>
2172
724
 
2173
725
 
2174
726
  </div>
@@ -2181,12 +733,12 @@ thus should not receive a date on the @done tag</p>
2181
733
  <li>
2182
734
 
2183
735
 
2184
- <span class='type'>(<tt><span class='object_link'><a href="../Array.html" title="Array (class)">Array</a></span></tt>)</span>
736
+ <span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
2185
737
 
2186
738
 
2187
739
 
2188
740
  &mdash;
2189
- <div class='inline'><p>array of tags (no values)</p>
741
+ <div class='inline'><p>entry hash</p>
2190
742
  </div>
2191
743
 
2192
744
  </li>
@@ -2197,9 +749,9 @@ thus should not receive a date on the @done tag</p>
2197
749
  </div>
2198
750
 
2199
751
  <div class="method_details ">
2200
- <h3 class="signature " id="tags?-instance_method">
752
+ <h3 class="signature " id="move_to-instance_method">
2201
753
 
2202
- #<strong>tags?</strong>(tags, bool = :and, negate: false) &#x21d2; <tt>Boolean</tt>
754
+ #<strong>move_to</strong>(new_section, label: true, log: true) &#x21d2; <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt>
2203
755
 
2204
756
 
2205
757
 
@@ -2207,7 +759,7 @@ thus should not receive a date on the @done tag</p>
2207
759
 
2208
760
  </h3><div class="docstring">
2209
761
  <div class="discussion">
2210
- <p>Test if item contains tag(s)</p>
762
+ <p>Move item from current section to destination section</p>
2211
763
 
2212
764
 
2213
765
  </div>
@@ -2218,107 +770,69 @@ thus should not receive a date on the @done tag</p>
2218
770
 
2219
771
  <li>
2220
772
 
2221
- <span class='name'>tags</span>
773
+ <span class='name'>new_section</span>
2222
774
 
2223
775
 
2224
- <span class='type'>(<tt><span class='object_link'><a href="../Array.html" title="Array (class)">Array</a></span> or <span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
776
+ <span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
2225
777
 
2226
778
 
2227
779
 
2228
780
  &mdash;
2229
- <div class='inline'><p>The tags to test. Can be an array or a comma-separated string.</p>
781
+ <div class='inline'><p>The destination
782
+ section</p>
2230
783
  </div>
2231
784
 
2232
785
  </li>
2233
786
 
2234
787
  <li>
2235
788
 
2236
- <span class='name'>bool</span>
789
+ <span class='name'>label</span>
2237
790
 
2238
791
 
2239
- <span class='type'>(<tt><span class='object_link'><a href="../Symbol.html" title="Symbol (class)">Symbol</a></span></tt>)</span>
792
+ <span class='type'>(<tt>Boolean</tt>)</span>
2240
793
 
2241
794
 
2242
- <em class="default">(defaults to: <tt>:and</tt>)</em>
795
+ <em class="default">(defaults to: <tt>true</tt>)</em>
2243
796
 
2244
797
 
2245
798
  &mdash;
2246
- <div class='inline'><p>The boolean to use for multiple tags (:and, :or, :not)</p>
799
+ <div class='inline'><p>add @from(original
800
+ section) tag</p>
2247
801
  </div>
2248
802
 
2249
803
  </li>
2250
804
 
2251
805
  <li>
2252
806
 
2253
- <span class='name'>negate</span>
807
+ <span class='name'>log</span>
2254
808
 
2255
809
 
2256
810
  <span class='type'>(<tt>Boolean</tt>)</span>
2257
811
 
2258
812
 
2259
- <em class="default">(defaults to: <tt>false</tt>)</em>
2260
-
2261
-
2262
- &mdash;
2263
- <div class='inline'><p>negate the result?</p>
2264
- </div>
2265
-
2266
- </li>
2267
-
2268
- </ul>
2269
-
2270
- <p class="tag_title">Returns:</p>
2271
- <ul class="return">
2272
-
2273
- <li>
2274
-
2275
-
2276
- <span class='type'>(<tt>Boolean</tt>)</span>
2277
-
813
+ <em class="default">(defaults to: <tt>true</tt>)</em>
2278
814
 
2279
815
 
2280
816
  &mdash;
2281
- <div class='inline'><p>true if tag/bool combination passes</p>
817
+ <div class='inline'><p>log this action</p>
2282
818
  </div>
2283
819
 
2284
820
  </li>
2285
821
 
2286
822
  </ul>
2287
823
 
2288
- </div>
2289
- </div>
2290
-
2291
- <div class="method_details ">
2292
- <h3 class="signature " id="tags_with_values-instance_method">
2293
-
2294
- #<strong>tags_with_values</strong> &#x21d2; <tt><span class='object_link'><a href="../Array.html" title="Array (class)">Array</a></span>&lt;<span class='object_link'><a href="../Array.html" title="Array (class)">Array</a></span>&gt;</tt>
2295
-
2296
-
2297
-
2298
-
2299
-
2300
- </h3><div class="docstring">
2301
- <div class="discussion">
2302
- <p>Return all tags including parenthetical values</p>
2303
-
2304
-
2305
- </div>
2306
- </div>
2307
- <div class="tags">
2308
-
2309
824
  <p class="tag_title">Returns:</p>
2310
825
  <ul class="return">
2311
826
 
2312
827
  <li>
2313
828
 
2314
829
 
2315
- <span class='type'>(<tt><span class='object_link'><a href="../Array.html" title="Array (class)">Array</a></span>&lt;<span class='object_link'><a href="../Array.html" title="Array (class)">Array</a></span>&gt;</tt>)</span>
830
+ <span class='type'></span>
2316
831
 
2317
832
 
2318
833
 
2319
- &mdash;
2320
- <div class='inline'><p>Array of array pairs,
2321
- [[tag1, value], [tag2, value]]</p>
834
+
835
+ <div class='inline'><p>nothing</p>
2322
836
  </div>
2323
837
 
2324
838
  </li>
@@ -2386,45 +900,6 @@ thus should not receive a date on the @done tag</p>
2386
900
  <div class="tags">
2387
901
 
2388
902
 
2389
- </div>
2390
- </div>
2391
-
2392
- <div class="method_details ">
2393
- <h3 class="signature " id="unfinished?-instance_method">
2394
-
2395
- #<strong>unfinished?</strong> &#x21d2; <tt>Boolean</tt>
2396
-
2397
-
2398
-
2399
-
2400
-
2401
- </h3><div class="docstring">
2402
- <div class="discussion">
2403
- <p>Test if item does not contain @done tag</p>
2404
-
2405
-
2406
- </div>
2407
- </div>
2408
- <div class="tags">
2409
-
2410
- <p class="tag_title">Returns:</p>
2411
- <ul class="return">
2412
-
2413
- <li>
2414
-
2415
-
2416
- <span class='type'>(<tt>Boolean</tt>)</span>
2417
-
2418
-
2419
-
2420
- &mdash;
2421
- <div class='inline'><p>true if item is missing @done tag</p>
2422
- </div>
2423
-
2424
- </li>
2425
-
2426
- </ul>
2427
-
2428
903
  </div>
2429
904
  </div>
2430
905
 
@@ -2433,7 +908,7 @@ thus should not receive a date on the @done tag</p>
2433
908
  </div>
2434
909
 
2435
910
  <div id="footer">
2436
- Generated on Sun Mar 13 05:08:08 2022 by
911
+ Generated on Tue Mar 15 11:14:29 2022 by
2437
912
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
2438
913
  0.9.27 (ruby-3.0.1).
2439
914
  </div>