doing 2.1.37 → 2.1.40

Sign up to get free protection for your applications and to get access to all the features.
Files changed (121) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +61 -0
  3. data/Gemfile.lock +1 -1
  4. data/README.md +1 -1
  5. data/Rakefile +7 -1
  6. data/bin/commands/config.rb +43 -34
  7. data/bin/commands/done.rb +1 -18
  8. data/bin/commands/finish.rb +30 -25
  9. data/bin/commands/grep.rb +3 -14
  10. data/bin/commands/last.rb +2 -8
  11. data/bin/commands/meanwhile.rb +13 -6
  12. data/bin/commands/now.rb +2 -4
  13. data/bin/commands/on.rb +4 -15
  14. data/bin/commands/recent.rb +2 -8
  15. data/bin/commands/reset.rb +24 -1
  16. data/bin/commands/select.rb +1 -1
  17. data/bin/commands/show.rb +8 -16
  18. data/bin/commands/since.rb +1 -12
  19. data/bin/commands/today.rb +2 -13
  20. data/bin/commands/view.rb +1 -1
  21. data/bin/commands/yesterday.rb +2 -13
  22. data/bin/doing +41 -36
  23. data/docs/doc/Array.html +1 -1
  24. data/docs/doc/BooleanTermParser/Clause.html +1 -1
  25. data/docs/doc/BooleanTermParser/Operator.html +1 -1
  26. data/docs/doc/BooleanTermParser/Query.html +1 -1
  27. data/docs/doc/BooleanTermParser/QueryParser.html +1 -1
  28. data/docs/doc/BooleanTermParser/QueryTransformer.html +1 -1
  29. data/docs/doc/BooleanTermParser.html +1 -1
  30. data/docs/doc/Doing/Color.html +166 -20
  31. data/docs/doc/Doing/Completion.html +1 -1
  32. data/docs/doc/Doing/Configuration.html +1 -1
  33. data/docs/doc/Doing/Errors/DoingNoTraceError.html +7 -3
  34. data/docs/doc/Doing/Errors/DoingRuntimeError.html +7 -3
  35. data/docs/doc/Doing/Errors/DoingStandardError.html +1 -1
  36. data/docs/doc/Doing/Errors/EmptyInput.html +10 -2
  37. data/docs/doc/Doing/Errors/HistoryLimitError.html +194 -0
  38. data/docs/doc/Doing/Errors/InvalidPlugin.html +194 -0
  39. data/docs/doc/Doing/Errors/MissingBackupFile.html +194 -0
  40. data/docs/doc/Doing/Errors/NoResults.html +10 -2
  41. data/docs/doc/Doing/Errors/PluginException.html +1 -1
  42. data/docs/doc/Doing/Errors/UserCancelled.html +10 -2
  43. data/docs/doc/Doing/Errors/WrongCommand.html +10 -2
  44. data/docs/doc/Doing/Errors.html +9 -9
  45. data/docs/doc/Doing/Hooks.html +1 -1
  46. data/docs/doc/Doing/Item.html +114 -1576
  47. data/docs/doc/Doing/Items.html +121 -5
  48. data/docs/doc/Doing/Logger.html +1 -1
  49. data/docs/doc/Doing/Note.html +1 -1
  50. data/docs/doc/Doing/Pager.html +1 -1
  51. data/docs/doc/Doing/Plugins.html +1 -1
  52. data/docs/doc/Doing/Prompt.html +2 -2
  53. data/docs/doc/Doing/Section.html +1 -1
  54. data/docs/doc/Doing/TemplateString.html +2 -2
  55. data/docs/doc/Doing/Types.html +1 -1
  56. data/docs/doc/Doing/Util/Backup.html +5 -5
  57. data/docs/doc/Doing/Util.html +1 -1
  58. data/docs/doc/Doing/WWID.html +197 -4033
  59. data/docs/doc/Doing.html +2 -2
  60. data/docs/doc/FalseClass.html +1 -1
  61. data/docs/doc/GLI/Commands/Help.html +1 -1
  62. data/docs/doc/GLI/Commands/MarkdownDocumentListener.html +1 -1
  63. data/docs/doc/GLI/Commands.html +1 -1
  64. data/docs/doc/GLI.html +1 -1
  65. data/docs/doc/Hash.html +1 -1
  66. data/docs/doc/Object.html +1 -1
  67. data/docs/doc/PhraseParser/Operator.html +1 -1
  68. data/docs/doc/PhraseParser/PhraseClause.html +1 -1
  69. data/docs/doc/PhraseParser/Query.html +1 -1
  70. data/docs/doc/PhraseParser/QueryParser.html +1 -1
  71. data/docs/doc/PhraseParser/QueryTransformer.html +1 -1
  72. data/docs/doc/PhraseParser/TermClause.html +1 -1
  73. data/docs/doc/PhraseParser.html +1 -1
  74. data/docs/doc/Status.html +1 -1
  75. data/docs/doc/String.html +1 -1
  76. data/docs/doc/Symbol.html +1 -1
  77. data/docs/doc/Time.html +1 -1
  78. data/docs/doc/TrueClass.html +1 -1
  79. data/docs/doc/_index.html +26 -5
  80. data/docs/doc/class_list.html +1 -1
  81. data/docs/doc/file.README.html +2 -2
  82. data/docs/doc/index.html +2 -2
  83. data/docs/doc/method_list.html +237 -709
  84. data/docs/doc/top-level-namespace.html +3 -3
  85. data/docs/index.md +1 -1
  86. data/doing.rdoc +54 -7
  87. data/lib/completion/_doing.zsh +6 -6
  88. data/lib/completion/doing.bash +10 -10
  89. data/lib/completion/doing.fish +8 -2
  90. data/lib/doing/add_options.rb +31 -1
  91. data/lib/doing/chronify/array.rb +68 -18
  92. data/lib/doing/chronify/string.rb +3 -1
  93. data/lib/doing/colors.rb +77 -30
  94. data/lib/doing/completion.rb +4 -5
  95. data/lib/doing/errors.rb +51 -35
  96. data/lib/doing/hooks.rb +3 -3
  97. data/lib/doing/item/dates.rb +112 -0
  98. data/lib/doing/item/query.rb +433 -0
  99. data/lib/doing/item/state.rb +59 -0
  100. data/lib/doing/item/tags.rb +87 -0
  101. data/lib/doing/item.rb +6 -537
  102. data/lib/doing/items.rb +39 -14
  103. data/lib/doing/plugin_manager.rb +3 -3
  104. data/lib/doing/plugins/export/template_export.rb +4 -4
  105. data/lib/doing/plugins/import/cal_to_json.scpt +0 -0
  106. data/lib/doing/prompt.rb +6 -8
  107. data/lib/doing/string/tags.rb +8 -2
  108. data/lib/doing/util_backup.rb +6 -8
  109. data/lib/doing/version.rb +1 -1
  110. data/lib/doing/wwid/display.rb +399 -0
  111. data/lib/doing/wwid/editor.rb +214 -0
  112. data/lib/doing/wwid/filetools.rb +186 -0
  113. data/lib/doing/wwid/filter.rb +218 -0
  114. data/lib/doing/wwid/guess.rb +87 -0
  115. data/lib/doing/wwid/interactive.rb +385 -0
  116. data/lib/doing/wwid/modify.rb +618 -0
  117. data/lib/doing/wwid/tags.rb +54 -0
  118. data/lib/doing/wwid/timers.rb +345 -0
  119. data/lib/doing/wwid/wwidutil.rb +104 -0
  120. data/lib/doing/wwid.rb +31 -2308
  121. 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,304 +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="#to_pretty-instance_method" title="#to_pretty (instance method)">#<strong>to_pretty</strong>(elements: %i[date title section]) &#x21d2; Object </a>
779
-
780
-
781
-
782
- </span>
783
-
784
-
785
-
786
-
787
-
788
-
789
-
790
-
791
-
792
- <span class="summary_desc"><div class='inline'><p>outputs a colored string with relative date and highlighted tags.</p>
793
- </div></span>
794
-
795
- </li>
796
-
797
-
798
- <li class="public ">
799
- <span class="summary_signature">
800
-
801
- <a href="#to_s-instance_method" title="#to_s (instance method)">#<strong>to_s</strong> &#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 item in Doing file format, including leading tab.</p>
816
- </div></span>
817
-
818
- </li>
819
-
820
-
821
- <li class="public ">
822
- <span class="summary_signature">
823
-
824
- <a href="#unfinished%3F-instance_method" title="#unfinished? (instance method)">#<strong>unfinished?</strong> &#x21d2; Boolean </a>
825
-
826
-
827
-
828
- </span>
829
-
830
-
831
-
832
-
833
-
834
-
835
-
836
-
837
-
838
- <span class="summary_desc"><div class='inline'><p>Test if item does not contain @done tag.</p>
839
- </div></span>
840
-
841
- </li>
842
-
843
-
844
- </ul>
845
-
846
-
847
-
848
-
849
-
850
-
851
-
852
-
853
-
854
-
855
-
856
- <h3 class="inherited">Methods included from <span class='object_link'><a href="Color.html" title="Doing::Color (module)">Color</a></span></h3>
857
- <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>
858
- <div id="constructor_details" class="method_details_list">
859
- <h2>Constructor Details</h2>
860
-
861
- <div class="method_details first">
862
- <h3 class="signature first" id="initialize-instance_method">
863
-
864
- #<strong>initialize</strong>(date, title, section, note = nil) &#x21d2; <tt><span class='object_link'><a href="" title="Doing::Item (class)">Item</a></span></tt>
865
-
866
-
867
-
868
-
869
-
870
- </h3><div class="docstring">
871
- <div class="discussion">
872
- <p>Initialize an item with date, title, section, and
873
- optional note</p>
874
-
875
-
876
- </div>
877
- </div>
878
- <div class="tags">
879
- <p class="tag_title">Parameters:</p>
880
- <ul class="param">
881
-
882
- <li>
441
+ </div>
442
+ </div>
443
+ <div class="tags">
444
+ <p class="tag_title">Parameters:</p>
445
+ <ul class="param">
446
+
447
+ <li>
883
448
 
884
449
  <span class='name'>date</span>
885
450
 
@@ -899,883 +464,67 @@ optional note</p>
899
464
  <span class='name'>title</span>
900
465
 
901
466
 
902
- <span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
903
-
904
-
905
-
906
- &mdash;
907
- <div class='inline'><p>The title</p>
908
- </div>
909
-
910
- </li>
911
-
912
- <li>
913
-
914
- <span class='name'>section</span>
915
-
916
-
917
- <span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
918
-
919
-
920
-
921
- &mdash;
922
- <div class='inline'><p>The section to which
923
- the item belongs</p>
924
- </div>
925
-
926
- </li>
927
-
928
- <li>
929
-
930
- <span class='name'>note</span>
931
-
932
-
933
- <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>
934
-
935
-
936
- <em class="default">(defaults to: <tt>nil</tt>)</em>
937
-
938
-
939
- &mdash;
940
- <div class='inline'><p>The note
941
- (optional)</p>
942
- </div>
943
-
944
- </li>
945
-
946
- </ul>
947
-
948
-
949
- </div>
950
- </div>
951
-
952
- </div>
953
-
954
- <div id="instance_attr_details" class="attr_details">
955
- <h2>Instance Attribute Details</h2>
956
-
957
-
958
- <span id="date=-instance_method"></span>
959
- <div class="method_details first">
960
- <h3 class="signature first" id="date-instance_method">
961
-
962
- #<strong>date</strong> &#x21d2; <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt>
963
-
964
-
965
-
966
-
967
-
968
- </h3><div class="docstring">
969
- <div class="discussion">
970
- <p>Returns the value of attribute date.</p>
971
-
972
-
973
- </div>
974
- </div>
975
- <div class="tags">
976
-
977
-
978
- </div>
979
- </div>
980
-
981
-
982
- <span id="note=-instance_method"></span>
983
- <div class="method_details ">
984
- <h3 class="signature " id="note-instance_method">
985
-
986
- #<strong>note</strong> &#x21d2; <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt>
987
-
988
-
989
-
990
-
991
-
992
- </h3><div class="docstring">
993
- <div class="discussion">
994
- <p>Returns the value of attribute note.</p>
995
-
996
-
997
- </div>
998
- </div>
999
- <div class="tags">
1000
-
1001
-
1002
- </div>
1003
- </div>
1004
-
1005
-
1006
- <span id="section=-instance_method"></span>
1007
- <div class="method_details ">
1008
- <h3 class="signature " id="section-instance_method">
1009
-
1010
- #<strong>section</strong> &#x21d2; <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt>
1011
-
1012
-
1013
-
1014
-
1015
-
1016
- </h3><div class="docstring">
1017
- <div class="discussion">
1018
- <p>Returns the value of attribute section.</p>
1019
-
1020
-
1021
- </div>
1022
- </div>
1023
- <div class="tags">
1024
-
1025
-
1026
- </div>
1027
- </div>
1028
-
1029
-
1030
- <span id="title=-instance_method"></span>
1031
- <div class="method_details ">
1032
- <h3 class="signature " id="title-instance_method">
1033
-
1034
- #<strong>title</strong> &#x21d2; <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt>
1035
-
1036
-
1037
-
1038
-
1039
-
1040
- </h3><div class="docstring">
1041
- <div class="discussion">
1042
- <p>Returns the value of attribute title.</p>
1043
-
1044
-
1045
- </div>
1046
- </div>
1047
- <div class="tags">
1048
-
1049
-
1050
- </div>
1051
- </div>
1052
-
1053
- </div>
1054
-
1055
-
1056
- <div id="instance_method_details" class="method_details_list">
1057
- <h2>Instance Method Details</h2>
1058
-
1059
-
1060
- <div class="method_details first">
1061
- <h3 class="signature first" id="calculate_end_date-instance_method">
1062
-
1063
- #<strong>calculate_end_date</strong>(opt) &#x21d2; <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt>
1064
-
1065
-
1066
-
1067
-
1068
-
1069
- </h3>
1070
- </div>
1071
-
1072
- <div class="method_details ">
1073
- <h3 class="signature " id="clone-instance_method">
1074
-
1075
- #<strong>clone</strong> &#x21d2; <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt>
1076
-
1077
-
1078
-
1079
-
1080
-
1081
- </h3>
1082
- </div>
1083
-
1084
- <div class="method_details ">
1085
- <h3 class="signature " id="duration-instance_method">
1086
-
1087
- #<strong>duration</strong> &#x21d2; <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt>
1088
-
1089
-
1090
-
1091
-
1092
-
1093
- </h3><div class="docstring">
1094
- <div class="discussion">
1095
- <p>If the entry doesn&#39;t have a @done date, return the elapsed time</p>
1096
-
1097
-
1098
- </div>
1099
- </div>
1100
- <div class="tags">
1101
-
1102
-
1103
- </div>
1104
- </div>
1105
-
1106
- <div class="method_details ">
1107
- <h3 class="signature " id="end_date-instance_method">
1108
-
1109
- #<strong>end_date</strong> &#x21d2; <tt><span class='object_link'><a href="../Time.html" title="Time (class)">Time</a></span></tt>
1110
-
1111
-
1112
-
1113
-
1114
-
1115
- </h3><div class="docstring">
1116
- <div class="discussion">
1117
- <p>Get the value of the item&#39;s @done tag</p>
1118
-
1119
-
1120
- </div>
1121
- </div>
1122
- <div class="tags">
1123
-
1124
- <p class="tag_title">Returns:</p>
1125
- <ul class="return">
1126
-
1127
- <li>
1128
-
1129
-
1130
- <span class='type'>(<tt><span class='object_link'><a href="../Time.html" title="Time (class)">Time</a></span></tt>)</span>
1131
-
1132
-
1133
-
1134
- &mdash;
1135
- <div class='inline'><p>@done value</p>
1136
- </div>
1137
-
1138
- </li>
1139
-
1140
- </ul>
1141
-
1142
- </div>
1143
- </div>
1144
-
1145
- <div class="method_details ">
1146
- <h3 class="signature " id="equal?-instance_method">
1147
-
1148
- #<strong>equal?</strong>(other, match_section: false) &#x21d2; <tt>Boolean</tt>
1149
-
1150
-
1151
-
1152
-
1153
-
1154
- </h3><div class="docstring">
1155
- <div class="discussion">
1156
- <p>Test for equality between items</p>
1157
-
1158
-
1159
- </div>
1160
- </div>
1161
- <div class="tags">
1162
- <p class="tag_title">Parameters:</p>
1163
- <ul class="param">
1164
-
1165
- <li>
1166
-
1167
- <span class='name'>other</span>
1168
-
1169
-
1170
- <span class='type'>(<tt><span class='object_link'><a href="" title="Doing::Item (class)">Item</a></span></tt>)</span>
1171
-
1172
-
1173
-
1174
- &mdash;
1175
- <div class='inline'><p>The other item</p>
1176
- </div>
1177
-
1178
- </li>
1179
-
1180
- <li>
1181
-
1182
- <span class='name'>match_section</span>
1183
-
1184
-
1185
- <span class='type'>(<tt>Boolean</tt>)</span>
1186
-
1187
-
1188
- <em class="default">(defaults to: <tt>false</tt>)</em>
1189
-
1190
-
1191
- &mdash;
1192
- <div class='inline'><p>If true, require item sections to match</p>
1193
- </div>
1194
-
1195
- </li>
1196
-
1197
- </ul>
1198
-
1199
- <p class="tag_title">Returns:</p>
1200
- <ul class="return">
1201
-
1202
- <li>
1203
-
1204
-
1205
- <span class='type'>(<tt>Boolean</tt>)</span>
1206
-
1207
-
1208
-
1209
- &mdash;
1210
- <div class='inline'><p>is equal?</p>
1211
- </div>
1212
-
1213
- </li>
1214
-
1215
- </ul>
1216
-
1217
- </div>
1218
- </div>
1219
-
1220
- <div class="method_details ">
1221
- <h3 class="signature " id="expand_date_tags-instance_method">
1222
-
1223
- #<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>
1224
-
1225
-
1226
-
1227
-
1228
-
1229
- </h3><div class="docstring">
1230
- <div class="discussion">
1231
- <p>Updates the title of the Item by expanding natural
1232
- language dates within configured date tags (tags
1233
- whose value is expected to be a date)</p>
1234
-
1235
-
1236
- </div>
1237
- </div>
1238
- <div class="tags">
1239
- <p class="tag_title">Parameters:</p>
1240
- <ul class="param">
1241
-
1242
- <li>
1243
-
1244
- <span class='name'>additional_tags</span>
1245
-
1246
-
1247
- <span class='type'></span>
1248
-
1249
-
1250
- <em class="default">(defaults to: <tt>nil</tt>)</em>
1251
-
1252
-
1253
- &mdash;
1254
- <div class='inline'><p>An array of additional
1255
- tag names to consider
1256
- dates</p>
1257
- </div>
1258
-
1259
- </li>
1260
-
1261
- </ul>
1262
-
1263
-
1264
- </div>
1265
- </div>
1266
-
1267
- <div class="method_details ">
1268
- <h3 class="signature " id="finished?-instance_method">
1269
-
1270
- #<strong>finished?</strong> &#x21d2; <tt>Boolean</tt>
1271
-
1272
-
1273
-
1274
-
1275
-
1276
- </h3><div class="docstring">
1277
- <div class="discussion">
1278
- <p>Test if item has a @done tag</p>
1279
-
1280
-
1281
- </div>
1282
- </div>
1283
- <div class="tags">
1284
-
1285
- <p class="tag_title">Returns:</p>
1286
- <ul class="return">
1287
-
1288
- <li>
1289
-
1290
-
1291
- <span class='type'>(<tt>Boolean</tt>)</span>
1292
-
1293
-
1294
-
1295
- &mdash;
1296
- <div class='inline'><p>true item has @done tag</p>
1297
- </div>
1298
-
1299
- </li>
1300
-
1301
- </ul>
1302
-
1303
- </div>
1304
- </div>
1305
-
1306
- <div class="method_details ">
1307
- <h3 class="signature " id="highlight_search-instance_method">
1308
-
1309
- #<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>
1310
-
1311
-
1312
-
1313
-
1314
-
1315
- </h3>
1316
- </div>
1317
-
1318
- <div class="method_details ">
1319
- <h3 class="signature " id="id-instance_method">
1320
-
1321
- #<strong>id</strong> &#x21d2; <tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>
1322
-
1323
-
1324
-
1325
-
1326
-
1327
- </h3><div class="docstring">
1328
- <div class="discussion">
1329
- <p>Generate a hash that represents the entry</p>
1330
-
1331
-
1332
- </div>
1333
- </div>
1334
- <div class="tags">
1335
-
1336
- <p class="tag_title">Returns:</p>
1337
- <ul class="return">
1338
-
1339
- <li>
1340
-
1341
-
1342
- <span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
1343
-
1344
-
1345
-
1346
- &mdash;
1347
- <div class='inline'><p>entry hash</p>
1348
- </div>
1349
-
1350
- </li>
1351
-
1352
- </ul>
1353
-
1354
- </div>
1355
- </div>
1356
-
1357
- <div class="method_details ">
1358
- <h3 class="signature " id="ignore_case-instance_method">
1359
-
1360
- #<strong>ignore_case</strong>(search, case_type) &#x21d2; <tt>Boolean</tt>
1361
-
1362
-
1363
-
1364
-
1365
-
1366
- </h3><div class="docstring">
1367
- <div class="discussion">
1368
- <p>Determine if case should be ignored for searches</p>
1369
-
1370
-
1371
- </div>
1372
- </div>
1373
- <div class="tags">
1374
- <p class="tag_title">Parameters:</p>
1375
- <ul class="param">
1376
-
1377
- <li>
1378
-
1379
- <span class='name'>search</span>
1380
-
1381
-
1382
- <span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
1383
-
1384
-
1385
-
1386
- &mdash;
1387
- <div class='inline'><p>The search string</p>
1388
- </div>
1389
-
1390
- </li>
1391
-
1392
- <li>
1393
-
1394
- <span class='name'>case_type</span>
1395
-
1396
-
1397
- <span class='type'>(<tt><span class='object_link'><a href="../Symbol.html" title="Symbol (class)">Symbol</a></span></tt>)</span>
1398
-
1399
-
1400
-
1401
- &mdash;
1402
- <div class='inline'><p>The case type</p>
1403
- </div>
1404
-
1405
- </li>
1406
-
1407
- </ul>
1408
-
1409
- <p class="tag_title">Returns:</p>
1410
- <ul class="return">
1411
-
1412
- <li>
1413
-
1414
-
1415
- <span class='type'>(<tt>Boolean</tt>)</span>
1416
-
1417
-
1418
-
1419
- &mdash;
1420
- <div class='inline'><p>case should be ignored</p>
1421
- </div>
1422
-
1423
- </li>
1424
-
1425
- </ul>
1426
-
1427
- </div>
1428
- </div>
1429
-
1430
- <div class="method_details ">
1431
- <h3 class="signature " id="interval-instance_method">
1432
-
1433
- #<strong>interval</strong> &#x21d2; <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt>
1434
-
1435
-
1436
-
1437
-
1438
-
1439
- </h3><div class="docstring">
1440
- <div class="discussion">
1441
- <p>Get the difference between the item&#39;s start date and
1442
- the value of its @done tag (if present)</p>
1443
-
1444
-
1445
- </div>
1446
- </div>
1447
- <div class="tags">
1448
-
1449
- <p class="tag_title">Returns:</p>
1450
- <ul class="return">
1451
-
1452
- <li>
1453
-
1454
-
1455
- <span class='type'></span>
1456
-
1457
-
1458
-
1459
-
1460
- <div class='inline'><p>Interval in seconds</p>
1461
- </div>
1462
-
1463
- </li>
1464
-
1465
- </ul>
1466
-
1467
- </div>
1468
- </div>
1469
-
1470
- <div class="method_details ">
1471
- <h3 class="signature " id="move_to-instance_method">
1472
-
1473
- #<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>
1474
-
1475
-
1476
-
1477
-
1478
-
1479
- </h3><div class="docstring">
1480
- <div class="discussion">
1481
- <p>Move item from current section to destination section</p>
1482
-
1483
-
1484
- </div>
1485
- </div>
1486
- <div class="tags">
1487
- <p class="tag_title">Parameters:</p>
1488
- <ul class="param">
1489
-
1490
- <li>
1491
-
1492
- <span class='name'>new_section</span>
1493
-
1494
-
1495
- <span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
1496
-
1497
-
1498
-
1499
- &mdash;
1500
- <div class='inline'><p>The destination
1501
- section</p>
1502
- </div>
1503
-
1504
- </li>
1505
-
1506
- <li>
1507
-
1508
- <span class='name'>label</span>
1509
-
1510
-
1511
- <span class='type'>(<tt>Boolean</tt>)</span>
1512
-
1513
-
1514
- <em class="default">(defaults to: <tt>true</tt>)</em>
1515
-
1516
-
1517
- &mdash;
1518
- <div class='inline'><p>add @from(original
1519
- section) tag</p>
1520
- </div>
1521
-
1522
- </li>
1523
-
1524
- <li>
1525
-
1526
- <span class='name'>log</span>
1527
-
1528
-
1529
- <span class='type'>(<tt>Boolean</tt>)</span>
1530
-
1531
-
1532
- <em class="default">(defaults to: <tt>true</tt>)</em>
1533
-
1534
-
1535
- &mdash;
1536
- <div class='inline'><p>log this action</p>
1537
- </div>
1538
-
1539
- </li>
1540
-
1541
- </ul>
1542
-
1543
- <p class="tag_title">Returns:</p>
1544
- <ul class="return">
1545
-
1546
- <li>
1547
-
1548
-
1549
- <span class='type'></span>
1550
-
1551
-
1552
-
1553
-
1554
- <div class='inline'><p>nothing</p>
1555
- </div>
1556
-
1557
- </li>
1558
-
1559
- </ul>
1560
-
1561
- </div>
1562
- </div>
1563
-
1564
- <div class="method_details ">
1565
- <h3 class="signature " id="overlapping_time?-instance_method">
1566
-
1567
- #<strong>overlapping_time?</strong>(item_b) &#x21d2; <tt>Boolean</tt>
1568
-
1569
-
1570
-
1571
-
1572
-
1573
- </h3><div class="docstring">
1574
- <div class="discussion">
1575
- <p>Test if the interval between start date and @done
1576
- value overlaps with another item&#39;s</p>
1577
-
1578
-
1579
- </div>
1580
- </div>
1581
- <div class="tags">
1582
- <p class="tag_title">Parameters:</p>
1583
- <ul class="param">
1584
-
1585
- <li>
1586
-
1587
- <span class='name'>item_b</span>
1588
-
1589
-
1590
- <span class='type'>(<tt><span class='object_link'><a href="" title="Doing::Item (class)">Item</a></span></tt>)</span>
1591
-
1592
-
1593
-
1594
- &mdash;
1595
- <div class='inline'><p>The item to compare</p>
1596
- </div>
1597
-
1598
- </li>
1599
-
1600
- </ul>
1601
-
1602
- <p class="tag_title">Returns:</p>
1603
- <ul class="return">
1604
-
1605
- <li>
1606
-
1607
-
1608
- <span class='type'>(<tt>Boolean</tt>)</span>
1609
-
1610
-
1611
-
1612
- &mdash;
1613
- <div class='inline'><p>overlaps?</p>
1614
- </div>
1615
-
1616
- </li>
1617
-
1618
- </ul>
1619
-
1620
- </div>
1621
- </div>
1622
-
1623
- <div class="method_details ">
1624
- <h3 class="signature " id="same_time?-instance_method">
1625
-
1626
- #<strong>same_time?</strong>(item_b) &#x21d2; <tt>Boolean</tt>
1627
-
1628
-
1629
-
1630
-
1631
-
1632
- </h3><div class="docstring">
1633
- <div class="discussion">
1634
- <p>Test if two items occur at the same time (same start date and equal duration)</p>
1635
-
1636
-
1637
- </div>
1638
- </div>
1639
- <div class="tags">
1640
- <p class="tag_title">Parameters:</p>
1641
- <ul class="param">
1642
-
1643
- <li>
1644
-
1645
- <span class='name'>item_b</span>
1646
-
1647
-
1648
- <span class='type'>(<tt><span class='object_link'><a href="" title="Doing::Item (class)">Item</a></span></tt>)</span>
1649
-
1650
-
1651
-
1652
- &mdash;
1653
- <div class='inline'><p>The item to compare</p>
1654
- </div>
1655
-
1656
- </li>
1657
-
1658
- </ul>
1659
-
1660
- <p class="tag_title">Returns:</p>
1661
- <ul class="return">
1662
-
1663
- <li>
1664
-
1665
-
1666
- <span class='type'>(<tt>Boolean</tt>)</span>
1667
-
1668
-
1669
-
1670
- &mdash;
1671
- <div class='inline'><p>is equal?</p>
1672
- </div>
1673
-
1674
- </li>
1675
-
1676
- </ul>
1677
-
1678
- </div>
1679
- </div>
1680
-
1681
- <div class="method_details ">
1682
- <h3 class="signature " id="search-instance_method">
1683
-
1684
- #<strong>search</strong>(search, distance: nil, negate: false, case_type: nil) &#x21d2; <tt>Boolean</tt>
1685
-
1686
-
1687
-
1688
-
1689
-
1690
- </h3><div class="docstring">
1691
- <div class="discussion">
1692
- <p>Test if item matches search string</p>
1693
-
1694
-
1695
- </div>
1696
- </div>
1697
- <div class="tags">
1698
- <p class="tag_title">Parameters:</p>
1699
- <ul class="param">
1700
-
1701
- <li>
1702
-
1703
- <span class='name'>search</span>
1704
-
1705
-
1706
- <span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
1707
-
1708
-
1709
-
1710
- &mdash;
1711
- <div class='inline'><p>The search string</p>
1712
- </div>
1713
-
1714
- </li>
1715
-
1716
- <li>
1717
-
1718
- <span class='name'>negate</span>
1719
-
1720
-
1721
- <span class='type'>(<tt>Boolean</tt>)</span>
1722
-
467
+ <span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
1723
468
 
1724
- <em class="default">(defaults to: <tt>false</tt>)</em>
1725
469
 
1726
470
 
1727
471
  &mdash;
1728
- <div class='inline'><p>negate results</p>
472
+ <div class='inline'><p>The title</p>
1729
473
  </div>
1730
474
 
1731
475
  </li>
1732
476
 
1733
477
  <li>
1734
478
 
1735
- <span class='name'>case_type</span>
1736
-
479
+ <span class='name'>section</span>
1737
480
 
1738
- <span class='type'>(<tt><span class='object_link'><a href="../Symbol.html" title="Symbol (class)">Symbol</a></span></tt>)</span>
1739
481
 
482
+ <span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
1740
483
 
1741
- <em class="default">(defaults to: <tt>nil</tt>)</em>
1742
484
 
1743
485
 
1744
486
  &mdash;
1745
- <div class='inline'><p>The case-sensitivity
1746
- type (:sensitive,
1747
- :ignore, :smart)</p>
487
+ <div class='inline'><p>The section to which
488
+ the item belongs</p>
1748
489
  </div>
1749
490
 
1750
491
  </li>
1751
492
 
1752
- </ul>
1753
-
1754
- <p class="tag_title">Returns:</p>
1755
- <ul class="return">
1756
-
1757
493
  <li>
1758
494
 
495
+ <span class='name'>note</span>
1759
496
 
1760
- <span class='type'>(<tt>Boolean</tt>)</span>
1761
497
 
498
+ <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>
499
+
500
+
501
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1762
502
 
1763
503
 
1764
504
  &mdash;
1765
- <div class='inline'><p>matches search criteria</p>
505
+ <div class='inline'><p>The note
506
+ (optional)</p>
1766
507
  </div>
1767
508
 
1768
509
  </li>
1769
510
 
1770
511
  </ul>
1771
512
 
513
+
514
+ </div>
1772
515
  </div>
516
+
1773
517
  </div>
518
+
519
+ <div id="instance_attr_details" class="attr_details">
520
+ <h2>Instance Attribute Details</h2>
1774
521
 
1775
- <div class="method_details ">
1776
- <h3 class="signature " id="should_finish?-instance_method">
522
+
523
+ <span id="date=-instance_method"></span>
524
+ <div class="method_details first">
525
+ <h3 class="signature first" id="date-instance_method">
1777
526
 
1778
- #<strong>should_finish?</strong> &#x21d2; <tt>Boolean</tt>
527
+ #<strong>date</strong> &#x21d2; <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt>
1779
528
 
1780
529
 
1781
530
 
@@ -1783,39 +532,23 @@ type (:sensitive,
1783
532
 
1784
533
  </h3><div class="docstring">
1785
534
  <div class="discussion">
1786
- <p>Test if item is included in never_finish config and
1787
- thus should not receive a @done tag</p>
535
+ <p>Returns the value of attribute date.</p>
1788
536
 
1789
537
 
1790
538
  </div>
1791
539
  </div>
1792
540
  <div class="tags">
1793
541
 
1794
- <p class="tag_title">Returns:</p>
1795
- <ul class="return">
1796
-
1797
- <li>
1798
-
1799
-
1800
- <span class='type'>(<tt>Boolean</tt>)</span>
1801
-
1802
-
1803
-
1804
- &mdash;
1805
- <div class='inline'><p>item should receive @done tag</p>
1806
- </div>
1807
-
1808
- </li>
1809
-
1810
- </ul>
1811
542
 
1812
543
  </div>
1813
544
  </div>
1814
545
 
546
+
547
+ <span id="note=-instance_method"></span>
1815
548
  <div class="method_details ">
1816
- <h3 class="signature " id="should_time?-instance_method">
549
+ <h3 class="signature " id="note-instance_method">
1817
550
 
1818
- #<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>
1819
552
 
1820
553
 
1821
554
 
@@ -1823,39 +556,23 @@ thus should not receive a @done tag</p>
1823
556
 
1824
557
  </h3><div class="docstring">
1825
558
  <div class="discussion">
1826
- <p>Test if item is included in never_time config and
1827
- thus should not receive a date on the @done tag</p>
559
+ <p>Returns the value of attribute note.</p>
1828
560
 
1829
561
 
1830
562
  </div>
1831
563
  </div>
1832
564
  <div class="tags">
1833
565
 
1834
- <p class="tag_title">Returns:</p>
1835
- <ul class="return">
1836
-
1837
- <li>
1838
-
1839
-
1840
- <span class='type'>(<tt>Boolean</tt>)</span>
1841
-
1842
-
1843
-
1844
- &mdash;
1845
- <div class='inline'><p>item should receive @done date</p>
1846
- </div>
1847
-
1848
- </li>
1849
-
1850
- </ul>
1851
566
 
1852
567
  </div>
1853
568
  </div>
1854
569
 
570
+
571
+ <span id="section=-instance_method"></span>
1855
572
  <div class="method_details ">
1856
- <h3 class="signature " id="tag-instance_method">
573
+ <h3 class="signature " id="section-instance_method">
1857
574
 
1858
- #<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>
1859
576
 
1860
577
 
1861
578
 
@@ -1863,150 +580,23 @@ thus should not receive a date on the @done tag</p>
1863
580
 
1864
581
  </h3><div class="docstring">
1865
582
  <div class="discussion">
1866
- <p>Add (or remove) tags from the title of the item</p>
583
+ <p>Returns the value of attribute section.</p>
1867
584
 
1868
585
 
1869
586
  </div>
1870
587
  </div>
1871
588
  <div class="tags">
1872
- <p class="tag_title">Parameters:</p>
1873
- <ul class="param">
1874
-
1875
- <li>
1876
-
1877
- <span class='name'>tags</span>
1878
-
1879
-
1880
- <span class='type'>(<tt><span class='object_link'><a href="../Array.html" title="Array (class)">Array</a></span></tt>)</span>
1881
-
1882
-
1883
-
1884
- &mdash;
1885
- <div class='inline'><p>The tags to apply</p>
1886
- </div>
1887
-
1888
- </li>
1889
-
1890
- <li>
1891
-
1892
- <span class='name'>options</span>
1893
-
1894
-
1895
- <span class='type'></span>
1896
-
1897
-
1898
-
1899
- &mdash;
1900
- <div class='inline'><p>Additional options</p>
1901
- </div>
1902
-
1903
- </li>
1904
-
1905
- </ul>
1906
-
1907
-
1908
-
1909
-
1910
-
1911
-
1912
- <p class="tag_title">Options Hash (<tt>**options</tt>):</p>
1913
- <ul class="option">
1914
-
1915
- <li>
1916
- <span class="name">:date</span>
1917
- <span class="type">(<tt>Boolean</tt>)</span>
1918
- <span class="default">
1919
-
1920
- </span>
1921
-
1922
- &mdash; <div class='inline'><p>Include timestamp?</p>
1923
- </div>
1924
-
1925
- </li>
1926
-
1927
- <li>
1928
- <span class="name">:single</span>
1929
- <span class="type">(<tt>Boolean</tt>)</span>
1930
- <span class="default">
1931
-
1932
- </span>
1933
-
1934
- &mdash; <div class='inline'><p>Log as a single change?</p>
1935
- </div>
1936
-
1937
- </li>
1938
-
1939
- <li>
1940
- <span class="name">:value</span>
1941
- <span class="type">(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
1942
- <span class="default">
1943
-
1944
- </span>
1945
-
1946
- &mdash; <div class='inline'><p>A value to include as @tag(value)</p>
1947
- </div>
1948
-
1949
- </li>
1950
-
1951
- <li>
1952
- <span class="name">:remove</span>
1953
- <span class="type">(<tt>Boolean</tt>)</span>
1954
- <span class="default">
1955
-
1956
- </span>
1957
-
1958
- &mdash; <div class='inline'><p>if true remove instead of adding</p>
1959
- </div>
1960
-
1961
- </li>
1962
-
1963
- <li>
1964
- <span class="name">:rename_to</span>
1965
- <span class="type">(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
1966
- <span class="default">
1967
-
1968
- </span>
1969
-
1970
- &mdash; <div class='inline'><p>if not nil, rename target tag to this tag name</p>
1971
- </div>
1972
-
1973
- </li>
1974
-
1975
- <li>
1976
- <span class="name">:regex</span>
1977
- <span class="type">(<tt>Boolean</tt>)</span>
1978
- <span class="default">
1979
-
1980
- </span>
1981
-
1982
- &mdash; <div class='inline'><p>treat target tag string as regex pattern</p>
1983
- </div>
1984
-
1985
- </li>
1986
-
1987
- <li>
1988
- <span class="name">:force</span>
1989
- <span class="type">(<tt>Boolean</tt>)</span>
1990
- <span class="default">
1991
-
1992
- </span>
1993
-
1994
- &mdash; <div class='inline'><p>with rename_to, add tag if it doesn&#39;t exist</p>
1995
- </div>
1996
-
1997
- </li>
1998
-
1999
- </ul>
2000
589
 
2001
590
 
2002
-
2003
591
  </div>
2004
592
  </div>
2005
593
 
594
+
595
+ <span id="title=-instance_method"></span>
2006
596
  <div class="method_details ">
2007
- <h3 class="signature " id="tag_array-instance_method">
597
+ <h3 class="signature " id="title-instance_method">
2008
598
 
2009
- #<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>
2010
600
 
2011
601
 
2012
602
 
@@ -2014,38 +604,40 @@ thus should not receive a date on the @done tag</p>
2014
604
 
2015
605
  </h3><div class="docstring">
2016
606
  <div class="discussion">
2017
- <p>convert tags on item to an array with @ symbols removed</p>
607
+ <p>Returns the value of attribute title.</p>
2018
608
 
2019
609
 
2020
610
  </div>
2021
611
  </div>
2022
612
  <div class="tags">
2023
613
 
2024
- <p class="tag_title">Returns:</p>
2025
- <ul class="return">
2026
-
2027
- <li>
2028
-
2029
-
2030
- <span class='type'>(<tt><span class='object_link'><a href="../Array.html" title="Array (class)">Array</a></span></tt>)</span>
2031
-
2032
-
2033
-
2034
- &mdash;
2035
- <div class='inline'><p>array of tags</p>
614
+
2036
615
  </div>
2037
-
2038
- </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>
2039
629
 
2040
- </ul>
2041
630
 
2042
- </div>
631
+
632
+
633
+
634
+ </h3>
2043
635
  </div>
2044
636
 
2045
637
  <div class="method_details ">
2046
- <h3 class="signature " id="tag_values?-instance_method">
638
+ <h3 class="signature " id="equal?-instance_method">
2047
639
 
2048
- #<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>
2049
641
 
2050
642
 
2051
643
 
@@ -2053,7 +645,7 @@ thus should not receive a date on the @done tag</p>
2053
645
 
2054
646
  </h3><div class="docstring">
2055
647
  <div class="discussion">
2056
- <p>Test if item matches tag values</p>
648
+ <p>Test for equality between items</p>
2057
649
 
2058
650
 
2059
651
  </div>
@@ -2064,39 +656,22 @@ thus should not receive a date on the @done tag</p>
2064
656
 
2065
657
  <li>
2066
658
 
2067
- <span class='name'>queries</span>
2068
-
2069
-
2070
- <span class='type'>(<tt><span class='object_link'><a href="../Array.html" title="Array (class)">Array</a></span></tt>)</span>
2071
-
2072
-
2073
-
2074
- &mdash;
2075
- <div class='inline'><p>The tag value queries to test</p>
2076
- </div>
2077
-
2078
- </li>
2079
-
2080
- <li>
2081
-
2082
- <span class='name'>bool</span>
2083
-
659
+ <span class='name'>other</span>
2084
660
 
2085
- <span class='type'>(<tt><span class='object_link'><a href="../Symbol.html" title="Symbol (class)">Symbol</a></span></tt>)</span>
2086
661
 
662
+ <span class='type'>(<tt><span class='object_link'><a href="" title="Doing::Item (class)">Item</a></span></tt>)</span>
2087
663
 
2088
- <em class="default">(defaults to: <tt>:and</tt>)</em>
2089
664
 
2090
665
 
2091
666
  &mdash;
2092
- <div class='inline'><p>The boolean to use for multiple tags (:and, :or, :not)</p>
667
+ <div class='inline'><p>The other item</p>
2093
668
  </div>
2094
669
 
2095
670
  </li>
2096
671
 
2097
672
  <li>
2098
673
 
2099
- <span class='name'>negate</span>
674
+ <span class='name'>match_section</span>
2100
675
 
2101
676
 
2102
677
  <span class='type'>(<tt>Boolean</tt>)</span>
@@ -2106,7 +681,7 @@ thus should not receive a date on the @done tag</p>
2106
681
 
2107
682
 
2108
683
  &mdash;
2109
- <div class='inline'><p>negate the result?</p>
684
+ <div class='inline'><p>If true, require item sections to match</p>
2110
685
  </div>
2111
686
 
2112
687
  </li>
@@ -2124,7 +699,7 @@ thus should not receive a date on the @done tag</p>
2124
699
 
2125
700
 
2126
701
  &mdash;
2127
- <div class='inline'><p>true if tag/bool combination passes</p>
702
+ <div class='inline'><p>is equal?</p>
2128
703
  </div>
2129
704
 
2130
705
  </li>
@@ -2135,9 +710,9 @@ thus should not receive a date on the @done tag</p>
2135
710
  </div>
2136
711
 
2137
712
  <div class="method_details ">
2138
- <h3 class="signature " id="tags-instance_method">
713
+ <h3 class="signature " id="id-instance_method">
2139
714
 
2140
- #<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>
2141
716
 
2142
717
 
2143
718
 
@@ -2145,7 +720,7 @@ thus should not receive a date on the @done tag</p>
2145
720
 
2146
721
  </h3><div class="docstring">
2147
722
  <div class="discussion">
2148
- <p>Get a list of tags on the item</p>
723
+ <p>Generate a hash that represents the entry</p>
2149
724
 
2150
725
 
2151
726
  </div>
@@ -2158,12 +733,12 @@ thus should not receive a date on the @done tag</p>
2158
733
  <li>
2159
734
 
2160
735
 
2161
- <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>
2162
737
 
2163
738
 
2164
739
 
2165
740
  &mdash;
2166
- <div class='inline'><p>array of tags (no values)</p>
741
+ <div class='inline'><p>entry hash</p>
2167
742
  </div>
2168
743
 
2169
744
  </li>
@@ -2174,9 +749,9 @@ thus should not receive a date on the @done tag</p>
2174
749
  </div>
2175
750
 
2176
751
  <div class="method_details ">
2177
- <h3 class="signature " id="tags?-instance_method">
752
+ <h3 class="signature " id="move_to-instance_method">
2178
753
 
2179
- #<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>
2180
755
 
2181
756
 
2182
757
 
@@ -2184,7 +759,7 @@ thus should not receive a date on the @done tag</p>
2184
759
 
2185
760
  </h3><div class="docstring">
2186
761
  <div class="discussion">
2187
- <p>Test if item contains tag(s)</p>
762
+ <p>Move item from current section to destination section</p>
2188
763
 
2189
764
 
2190
765
  </div>
@@ -2195,49 +770,51 @@ thus should not receive a date on the @done tag</p>
2195
770
 
2196
771
  <li>
2197
772
 
2198
- <span class='name'>tags</span>
773
+ <span class='name'>new_section</span>
2199
774
 
2200
775
 
2201
- <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>
2202
777
 
2203
778
 
2204
779
 
2205
780
  &mdash;
2206
- <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>
2207
783
  </div>
2208
784
 
2209
785
  </li>
2210
786
 
2211
787
  <li>
2212
788
 
2213
- <span class='name'>bool</span>
789
+ <span class='name'>label</span>
2214
790
 
2215
791
 
2216
- <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>
2217
793
 
2218
794
 
2219
- <em class="default">(defaults to: <tt>:and</tt>)</em>
795
+ <em class="default">(defaults to: <tt>true</tt>)</em>
2220
796
 
2221
797
 
2222
798
  &mdash;
2223
- <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>
2224
801
  </div>
2225
802
 
2226
803
  </li>
2227
804
 
2228
805
  <li>
2229
806
 
2230
- <span class='name'>negate</span>
807
+ <span class='name'>log</span>
2231
808
 
2232
809
 
2233
810
  <span class='type'>(<tt>Boolean</tt>)</span>
2234
811
 
2235
812
 
2236
- <em class="default">(defaults to: <tt>false</tt>)</em>
813
+ <em class="default">(defaults to: <tt>true</tt>)</em>
2237
814
 
2238
815
 
2239
816
  &mdash;
2240
- <div class='inline'><p>negate the result?</p>
817
+ <div class='inline'><p>log this action</p>
2241
818
  </div>
2242
819
 
2243
820
  </li>
@@ -2250,12 +827,12 @@ thus should not receive a date on the @done tag</p>
2250
827
  <li>
2251
828
 
2252
829
 
2253
- <span class='type'>(<tt>Boolean</tt>)</span>
830
+ <span class='type'></span>
2254
831
 
2255
832
 
2256
833
 
2257
- &mdash;
2258
- <div class='inline'><p>true if tag/bool combination passes</p>
834
+
835
+ <div class='inline'><p>nothing</p>
2259
836
  </div>
2260
837
 
2261
838
  </li>
@@ -2323,45 +900,6 @@ thus should not receive a date on the @done tag</p>
2323
900
  <div class="tags">
2324
901
 
2325
902
 
2326
- </div>
2327
- </div>
2328
-
2329
- <div class="method_details ">
2330
- <h3 class="signature " id="unfinished?-instance_method">
2331
-
2332
- #<strong>unfinished?</strong> &#x21d2; <tt>Boolean</tt>
2333
-
2334
-
2335
-
2336
-
2337
-
2338
- </h3><div class="docstring">
2339
- <div class="discussion">
2340
- <p>Test if item does not contain @done tag</p>
2341
-
2342
-
2343
- </div>
2344
- </div>
2345
- <div class="tags">
2346
-
2347
- <p class="tag_title">Returns:</p>
2348
- <ul class="return">
2349
-
2350
- <li>
2351
-
2352
-
2353
- <span class='type'>(<tt>Boolean</tt>)</span>
2354
-
2355
-
2356
-
2357
- &mdash;
2358
- <div class='inline'><p>true if item is missing @done tag</p>
2359
- </div>
2360
-
2361
- </li>
2362
-
2363
- </ul>
2364
-
2365
903
  </div>
2366
904
  </div>
2367
905
 
@@ -2370,7 +908,7 @@ thus should not receive a date on the @done tag</p>
2370
908
  </div>
2371
909
 
2372
910
  <div id="footer">
2373
- Generated on Sat Mar 12 11:56:35 2022 by
911
+ Generated on Tue Mar 15 11:14:29 2022 by
2374
912
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
2375
913
  0.9.27 (ruby-3.0.1).
2376
914
  </div>