doing 2.1.2pre → 2.1.6pre

Sign up to get free protection for your applications and to get access to all the features.
Files changed (116) hide show
  1. checksums.yaml +4 -4
  2. data/.yardoc/checksums +19 -15
  3. data/.yardoc/object_types +0 -0
  4. data/.yardoc/objects/root.dat +0 -0
  5. data/.yardopts +1 -1
  6. data/CHANGELOG.md +62 -14
  7. data/Gemfile.lock +25 -1
  8. data/README.md +5 -1
  9. data/Rakefile +2 -0
  10. data/bin/doing +429 -142
  11. data/docs/_config.yml +1 -0
  12. data/{doc → docs/doc}/Array.html +63 -1
  13. data/docs/doc/BooleanTermParser/Clause.html +293 -0
  14. data/docs/doc/BooleanTermParser/Operator.html +172 -0
  15. data/docs/doc/BooleanTermParser/Query.html +417 -0
  16. data/docs/doc/BooleanTermParser/QueryParser.html +135 -0
  17. data/docs/doc/BooleanTermParser/QueryTransformer.html +124 -0
  18. data/docs/doc/BooleanTermParser.html +115 -0
  19. data/docs/doc/Doing/CLIFormat.html +131 -0
  20. data/{doc → docs/doc}/Doing/Color.html +2 -2
  21. data/{doc → docs/doc}/Doing/Completion.html +1 -1
  22. data/{doc → docs/doc}/Doing/Configuration.html +163 -69
  23. data/{doc → docs/doc}/Doing/Content.html +0 -0
  24. data/{doc → docs/doc}/Doing/Errors/DoingNoTraceError.html +1 -1
  25. data/{doc → docs/doc}/Doing/Errors/DoingRuntimeError.html +1 -1
  26. data/{doc → docs/doc}/Doing/Errors/DoingStandardError.html +1 -1
  27. data/{doc → docs/doc}/Doing/Errors/EmptyInput.html +1 -1
  28. data/{doc → docs/doc}/Doing/Errors/NoResults.html +1 -1
  29. data/{doc → docs/doc}/Doing/Errors/PluginException.html +1 -1
  30. data/{doc → docs/doc}/Doing/Errors/UserCancelled.html +1 -1
  31. data/{doc → docs/doc}/Doing/Errors/WrongCommand.html +1 -1
  32. data/{doc → docs/doc}/Doing/Errors.html +1 -1
  33. data/{doc → docs/doc}/Doing/Hooks.html +1 -1
  34. data/{doc → docs/doc}/Doing/Item.html +135 -89
  35. data/{doc → docs/doc}/Doing/Items.html +36 -2
  36. data/{doc → docs/doc}/Doing/LogAdapter.html +70 -1
  37. data/{doc → docs/doc}/Doing/Note.html +5 -134
  38. data/{doc → docs/doc}/Doing/Pager.html +1 -1
  39. data/{doc → docs/doc}/Doing/Plugins.html +431 -35
  40. data/{doc → docs/doc}/Doing/Prompt.html +70 -18
  41. data/{doc → docs/doc}/Doing/Section.html +1 -1
  42. data/docs/doc/Doing/TemplateString.html +713 -0
  43. data/docs/doc/Doing/Util/Backup.html +686 -0
  44. data/{doc → docs/doc}/Doing/Util.html +16 -4
  45. data/{doc → docs/doc}/Doing/WWID.html +133 -73
  46. data/{doc → docs/doc}/Doing/WWIDFile.html +0 -0
  47. data/{doc → docs/doc}/Doing.html +4 -4
  48. data/{doc → docs/doc}/GLI/Commands/MarkdownDocumentListener.html +1 -1
  49. data/{doc → docs/doc}/GLI/Commands.html +1 -1
  50. data/{doc → docs/doc}/GLI.html +1 -1
  51. data/{doc → docs/doc}/Hash.html +1 -1
  52. data/docs/doc/PhraseParser/Operator.html +172 -0
  53. data/docs/doc/PhraseParser/PhraseClause.html +303 -0
  54. data/docs/doc/PhraseParser/Query.html +495 -0
  55. data/docs/doc/PhraseParser/QueryParser.html +136 -0
  56. data/docs/doc/PhraseParser/QueryTransformer.html +124 -0
  57. data/docs/doc/PhraseParser/TermClause.html +293 -0
  58. data/docs/doc/PhraseParser.html +115 -0
  59. data/{doc → docs/doc}/Status.html +1 -1
  60. data/{doc → docs/doc}/String.html +319 -13
  61. data/{doc → docs/doc}/Symbol.html +35 -1
  62. data/{doc → docs/doc}/Time.html +70 -2
  63. data/{doc → docs/doc}/_index.html +132 -4
  64. data/docs/doc/class_list.html +51 -0
  65. data/{doc → docs/doc}/css/common.css +0 -0
  66. data/{doc → docs/doc}/css/full_list.css +0 -0
  67. data/{doc → docs/doc}/css/style.css +0 -0
  68. data/{doc → docs/doc}/file.README.html +6 -2
  69. data/{doc → docs/doc}/file_list.html +0 -0
  70. data/{doc → docs/doc}/frames.html +0 -0
  71. data/{doc → docs/doc}/index.html +6 -2
  72. data/{doc → docs/doc}/js/app.js +0 -0
  73. data/{doc → docs/doc}/js/full_list.js +0 -0
  74. data/{doc → docs/doc}/js/jquery.js +0 -0
  75. data/{doc → docs/doc}/method_list.html +684 -196
  76. data/{doc → docs/doc}/top-level-namespace.html +2 -2
  77. data/docs/index.md +60 -0
  78. data/doing.gemspec +3 -0
  79. data/doing.rdoc +222 -74
  80. data/example_plugin.rb +3 -1
  81. data/lib/completion/_doing.zsh +53 -41
  82. data/lib/completion/doing.bash +17 -6
  83. data/lib/completion/doing.fish +321 -2
  84. data/lib/doing/array.rb +9 -0
  85. data/lib/doing/boolean_term_parser.rb +86 -0
  86. data/lib/doing/completion/fish_completion.rb +46 -3
  87. data/lib/doing/completion/zsh_completion.rb +1 -1
  88. data/lib/doing/configuration.rb +48 -21
  89. data/lib/doing/item.rb +105 -10
  90. data/lib/doing/items.rb +6 -0
  91. data/lib/doing/log_adapter.rb +28 -0
  92. data/lib/doing/note.rb +31 -30
  93. data/lib/doing/phrase_parser.rb +124 -0
  94. data/lib/doing/plugin_manager.rb +84 -21
  95. data/lib/doing/plugins/export/dayone_export.rb +209 -0
  96. data/lib/doing/plugins/export/html_export.rb +2 -2
  97. data/lib/doing/plugins/export/json_export.rb +1 -0
  98. data/lib/doing/plugins/export/markdown_export.rb +1 -1
  99. data/lib/doing/plugins/export/template_export.rb +94 -86
  100. data/lib/doing/prompt.rb +26 -15
  101. data/lib/doing/string.rb +114 -29
  102. data/lib/doing/string_chronify.rb +5 -1
  103. data/lib/doing/symbol.rb +4 -0
  104. data/lib/doing/template_string.rb +197 -0
  105. data/lib/doing/time.rb +32 -0
  106. data/lib/doing/util.rb +6 -7
  107. data/lib/doing/util_backup.rb +287 -0
  108. data/lib/doing/version.rb +1 -1
  109. data/lib/doing/wwid.rb +105 -41
  110. data/lib/doing.rb +9 -0
  111. data/lib/examples/plugins/say_export.rb +1 -1
  112. data/lib/examples/plugins/wiki_export/wiki_export.rb +3 -3
  113. data/lib/templates/doing-dayone-entry.erb +6 -0
  114. data/lib/templates/doing-dayone.erb +5 -0
  115. metadata +136 -51
  116. data/doc/class_list.html +0 -51
@@ -203,7 +203,7 @@
203
203
  <li class="public ">
204
204
  <span class="summary_signature">
205
205
 
206
- <a href="#plugin_regex-class_method" title="plugin_regex (class method)">.<strong>plugin_regex</strong>(type: :export) &#x21d2; Object </a>
206
+ <a href="#plugin_regex-class_method" title="plugin_regex (class method)">.<strong>plugin_regex</strong>(type: :export) &#x21d2; Regexp </a>
207
207
 
208
208
 
209
209
 
@@ -217,7 +217,7 @@
217
217
 
218
218
 
219
219
 
220
- <span class="summary_desc"><div class='inline'><p>Return a regular expression of all plugin triggers for type.</p>
220
+ <span class="summary_desc"><div class='inline'><p>Return a regular expression of all plugin triggers for type.</p>
221
221
  </div></span>
222
222
 
223
223
  </li>
@@ -226,7 +226,7 @@
226
226
  <li class="public ">
227
227
  <span class="summary_signature">
228
228
 
229
- <a href="#plugin_templates-class_method" title="plugin_templates (class method)">.<strong>plugin_templates</strong>(type: :export) &#x21d2; Object </a>
229
+ <a href="#plugin_templates-class_method" title="plugin_templates (class method)">.<strong>plugin_templates</strong>(type: :export) &#x21d2; Array&lt;String&gt; </a>
230
230
 
231
231
 
232
232
 
@@ -240,7 +240,8 @@
240
240
 
241
241
 
242
242
 
243
- <span class="summary_desc"><div class='inline'></div></span>
243
+ <span class="summary_desc"><div class='inline'><p>Return array of available template names.</p>
244
+ </div></span>
244
245
 
245
246
  </li>
246
247
 
@@ -270,7 +271,7 @@
270
271
  <li class="public ">
271
272
  <span class="summary_signature">
272
273
 
273
- <a href="#plugins_path-class_method" title="plugins_path (class method)">.<strong>plugins_path</strong>(add_dir = nil) &#x21d2; Object </a>
274
+ <a href="#plugins_path-class_method" title="plugins_path (class method)">.<strong>plugins_path</strong>(add_dir = nil) &#x21d2; Array </a>
274
275
 
275
276
 
276
277
 
@@ -284,7 +285,7 @@
284
285
 
285
286
 
286
287
 
287
- <span class="summary_desc"><div class='inline'><p>Public: Setup the plugin search path.</p>
288
+ <span class="summary_desc"><div class='inline'><p>Setup the plugin search path.</p>
288
289
  </div></span>
289
290
 
290
291
  </li>
@@ -293,7 +294,7 @@
293
294
  <li class="public ">
294
295
  <span class="summary_signature">
295
296
 
296
- <a href="#register-class_method" title="register (class method)">.<strong>register</strong>(title, type, klass) &#x21d2; Object </a>
297
+ <a href="#register-class_method" title="register (class method)">.<strong>register</strong>(title, type, klass) &#x21d2; Boolean </a>
297
298
 
298
299
 
299
300
 
@@ -316,7 +317,7 @@
316
317
  <li class="public ">
317
318
  <span class="summary_signature">
318
319
 
319
- <a href="#template_for_trigger-class_method" title="template_for_trigger (class method)">.<strong>template_for_trigger</strong>(trigger, type: :export) &#x21d2; Object </a>
320
+ <a href="#save_template-class_method" title="save_template (class method)">.<strong>save_template</strong>(tpl, dir, filename) &#x21d2; Object </a>
320
321
 
321
322
 
322
323
 
@@ -338,7 +339,7 @@
338
339
  <li class="public ">
339
340
  <span class="summary_signature">
340
341
 
341
- <a href="#template_regex-class_method" title="template_regex (class method)">.<strong>template_regex</strong>(type: :export) &#x21d2; Object </a>
342
+ <a href="#template_for_trigger-class_method" title="template_for_trigger (class method)">.<strong>template_for_trigger</strong>(trigger, type: :export, save_to: nil) &#x21d2; String </a>
342
343
 
343
344
 
344
345
 
@@ -352,7 +353,31 @@
352
353
 
353
354
 
354
355
 
355
- <span class="summary_desc"><div class='inline'></div></span>
356
+ <span class="summary_desc"><div class='inline'><p>Find and return the appropriate template for a trigger string.</p>
357
+ </div></span>
358
+
359
+ </li>
360
+
361
+
362
+ <li class="public ">
363
+ <span class="summary_signature">
364
+
365
+ <a href="#template_regex-class_method" title="template_regex (class method)">.<strong>template_regex</strong>(type: :export) &#x21d2; Regexp </a>
366
+
367
+
368
+
369
+ </span>
370
+
371
+
372
+
373
+
374
+
375
+
376
+
377
+
378
+
379
+ <span class="summary_desc"><div class='inline'><p>Return a regular expression of all template triggers for type.</p>
380
+ </div></span>
356
381
 
357
382
  </li>
358
383
 
@@ -382,7 +407,7 @@
382
407
  <li class="public ">
383
408
  <span class="summary_signature">
384
409
 
385
- <a href="#valid_type-class_method" title="valid_type (class method)">.<strong>valid_type</strong>(type, default: nil) &#x21d2; Object </a>
410
+ <a href="#valid_type-class_method" title="valid_type (class method)">.<strong>valid_type</strong>(type, default: nil) &#x21d2; Symbol </a>
386
411
 
387
412
 
388
413
 
@@ -396,7 +421,8 @@
396
421
 
397
422
 
398
423
 
399
- <span class="summary_desc"><div class='inline'></div></span>
424
+ <span class="summary_desc"><div class='inline'><p>Converts a partial symbol to a valid plugin type, e.g.</p>
425
+ </div></span>
400
426
 
401
427
  </li>
402
428
 
@@ -633,7 +659,7 @@
633
659
  <div class="method_details ">
634
660
  <h3 class="signature " id="plugin_regex-class_method">
635
661
 
636
- .<strong>plugin_regex</strong>(type: :export) &#x21d2; <tt>Object</tt>
662
+ .<strong>plugin_regex</strong>(type: :export) &#x21d2; <tt>Regexp</tt>
637
663
 
638
664
 
639
665
 
@@ -641,8 +667,8 @@
641
667
 
642
668
  </h3><div class="docstring">
643
669
  <div class="discussion">
644
- <p>Return a regular expression of all
645
- plugin triggers for type</p>
670
+ <p>Return a regular expression of all plugin triggers
671
+ for type</p>
646
672
 
647
673
 
648
674
  </div>
@@ -656,20 +682,38 @@
656
682
  <span class='name'>type</span>
657
683
 
658
684
 
659
- <span class='type'></span>
685
+ <span class='type'>(<tt><span class='object_link'><a href="../Symbol.html" title="Symbol (class)">Symbol</a></span></tt>)</span>
660
686
 
661
687
 
662
688
  <em class="default">(defaults to: <tt>:export</tt>)</em>
663
689
 
664
690
 
665
691
  &mdash;
666
- <div class='inline'><p>The type :import or :export</p>
692
+ <div class='inline'><p>The type :import or
693
+ :export</p>
667
694
  </div>
668
695
 
669
696
  </li>
670
697
 
671
698
  </ul>
672
699
 
700
+ <p class="tag_title">Returns:</p>
701
+ <ul class="return">
702
+
703
+ <li>
704
+
705
+
706
+ <span class='type'>(<tt>Regexp</tt>)</span>
707
+
708
+
709
+
710
+ &mdash;
711
+ <div class='inline'><p>regular expression</p>
712
+ </div>
713
+
714
+ </li>
715
+
716
+ </ul>
673
717
 
674
718
  </div>
675
719
  </div>
@@ -677,13 +721,62 @@
677
721
  <div class="method_details ">
678
722
  <h3 class="signature " id="plugin_templates-class_method">
679
723
 
680
- .<strong>plugin_templates</strong>(type: :export) &#x21d2; <tt>Object</tt>
724
+ .<strong>plugin_templates</strong>(type: :export) &#x21d2; <tt><span class='object_link'><a href="../Array.html" title="Array (class)">Array</a></span>&lt;<span class='object_link'><a href="../String.html" title="String (class)">String</a></span>&gt;</tt>
681
725
 
682
726
 
683
727
 
684
728
 
685
729
 
686
- </h3>
730
+ </h3><div class="docstring">
731
+ <div class="discussion">
732
+ <p>Return array of available template names</p>
733
+
734
+
735
+ </div>
736
+ </div>
737
+ <div class="tags">
738
+ <p class="tag_title">Parameters:</p>
739
+ <ul class="param">
740
+
741
+ <li>
742
+
743
+ <span class='name'>type</span>
744
+
745
+
746
+ <span class='type'>(<tt><span class='object_link'><a href="../Symbol.html" title="Symbol (class)">Symbol</a></span></tt>)</span>
747
+
748
+
749
+ <em class="default">(defaults to: <tt>:export</tt>)</em>
750
+
751
+
752
+ &mdash;
753
+ <div class='inline'><p>Plugin type (:import,
754
+ :export)</p>
755
+ </div>
756
+
757
+ </li>
758
+
759
+ </ul>
760
+
761
+ <p class="tag_title">Returns:</p>
762
+ <ul class="return">
763
+
764
+ <li>
765
+
766
+
767
+ <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="../String.html" title="String (class)">String</a></span>&gt;</tt>)</span>
768
+
769
+
770
+
771
+ &mdash;
772
+ <div class='inline'><p>template names</p>
773
+ </div>
774
+
775
+ </li>
776
+
777
+ </ul>
778
+
779
+ </div>
687
780
  </div>
688
781
 
689
782
  <div class="method_details ">
@@ -701,7 +794,7 @@
701
794
  <div class="method_details ">
702
795
  <h3 class="signature " id="plugins_path-class_method">
703
796
 
704
- .<strong>plugins_path</strong>(add_dir = nil) &#x21d2; <tt>Object</tt>
797
+ .<strong>plugins_path</strong>(add_dir = nil) &#x21d2; <tt><span class='object_link'><a href="../Array.html" title="Array (class)">Array</a></span></tt>
705
798
 
706
799
 
707
800
 
@@ -709,15 +802,52 @@
709
802
 
710
803
  </h3><div class="docstring">
711
804
  <div class="discussion">
712
- <p>Public: Setup the plugin search path</p>
713
-
714
- <p>Returns an Array of plugin search paths</p>
805
+ <p>Setup the plugin search path</p>
715
806
 
716
807
 
717
808
  </div>
718
809
  </div>
719
810
  <div class="tags">
811
+ <p class="tag_title">Parameters:</p>
812
+ <ul class="param">
720
813
 
814
+ <li>
815
+
816
+ <span class='name'>add_dir</span>
817
+
818
+
819
+ <span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
820
+
821
+
822
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
823
+
824
+
825
+ &mdash;
826
+ <div class='inline'><p>optional additional
827
+ path to include</p>
828
+ </div>
829
+
830
+ </li>
831
+
832
+ </ul>
833
+
834
+ <p class="tag_title">Returns:</p>
835
+ <ul class="return">
836
+
837
+ <li>
838
+
839
+
840
+ <span class='type'>(<tt><span class='object_link'><a href="../Array.html" title="Array (class)">Array</a></span></tt>)</span>
841
+
842
+
843
+
844
+ &mdash;
845
+ <div class='inline'><p>Returns an Array of plugin search paths</p>
846
+ </div>
847
+
848
+ </li>
849
+
850
+ </ul>
721
851
 
722
852
  </div>
723
853
  </div>
@@ -725,7 +855,7 @@
725
855
  <div class="method_details ">
726
856
  <h3 class="signature " id="register-class_method">
727
857
 
728
- .<strong>register</strong>(title, type, klass) &#x21d2; <tt>Object</tt>
858
+ .<strong>register</strong>(title, type, klass) &#x21d2; <tt>Boolean</tt>
729
859
 
730
860
 
731
861
 
@@ -735,19 +865,114 @@
735
865
  <div class="discussion">
736
866
  <p>Register a plugin</p>
737
867
 
738
- <p>param: +[String|Array]+ title The name of the plugin (can be an array of names)</p>
739
868
 
740
- <p>param: +type+ The plugin type (:import, :export)</p>
869
+ </div>
870
+ </div>
871
+ <div class="tags">
872
+ <p class="tag_title">Parameters:</p>
873
+ <ul class="param">
874
+
875
+ <li>
876
+
877
+ <span class='name'>title</span>
878
+
879
+
880
+ <span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span>|<span class='object_link'><a href="../Array.html" title="Array (class)">Array</a></span></tt>)</span>
881
+
882
+
883
+
884
+ &mdash;
885
+ <div class='inline'><p>The name of the
886
+ plugin (can be an array of names)</p>
887
+ </div>
888
+
889
+ </li>
890
+
891
+ <li>
892
+
893
+ <span class='name'>type</span>
894
+
895
+
896
+ <span class='type'>(<tt><span class='object_link'><a href="../Symbol.html" title="Symbol (class)">Symbol</a></span></tt>)</span>
897
+
898
+
899
+
900
+ &mdash;
901
+ <div class='inline'><p>The plugin type
902
+ (:import, :export)</p>
903
+ </div>
904
+
905
+ </li>
906
+
907
+ <li>
908
+
909
+ <span class='name'>klass</span>
910
+
911
+
912
+ <span class='type'>(<tt>Class</tt>)</span>
913
+
914
+
915
+
916
+ &mdash;
917
+ <div class='inline'><p>The class responding to
918
+ :render or :import</p>
919
+ </div>
920
+
921
+ </li>
922
+
923
+ </ul>
741
924
 
742
- <p>param: +klass+ The class responding to :render or :import</p>
925
+ <p class="tag_title">Returns:</p>
926
+ <ul class="return">
927
+
928
+ <li>
929
+
930
+
931
+ <span class='type'>(<tt>Boolean</tt>)</span>
932
+
933
+
934
+
935
+ &mdash;
936
+ <div class='inline'><p>Success boolean</p>
937
+ </div>
938
+
939
+ </li>
940
+
941
+ </ul>
743
942
 
744
- <p>returns: Success boolean</p>
943
+ </div>
944
+ </div>
945
+
946
+ <div class="method_details ">
947
+ <h3 class="signature " id="save_template-class_method">
948
+
949
+ .<strong>save_template</strong>(tpl, dir, filename) &#x21d2; <tt>Object</tt>
950
+
745
951
 
952
+
953
+
954
+
955
+ </h3><div class="docstring">
956
+ <div class="discussion">
957
+
746
958
 
747
959
  </div>
748
960
  </div>
749
961
  <div class="tags">
750
962
 
963
+ <p class="tag_title">Raises:</p>
964
+ <ul class="raise">
965
+
966
+ <li>
967
+
968
+
969
+ <span class='type'>(<tt>DoingRuntimeError</tt>)</span>
970
+
971
+
972
+
973
+ </li>
974
+
975
+ </ul>
751
976
 
752
977
  </div>
753
978
  </div>
@@ -755,7 +980,7 @@
755
980
  <div class="method_details ">
756
981
  <h3 class="signature " id="template_for_trigger-class_method">
757
982
 
758
- .<strong>template_for_trigger</strong>(trigger, type: :export) &#x21d2; <tt>Object</tt>
983
+ .<strong>template_for_trigger</strong>(trigger, type: :export, save_to: nil) &#x21d2; <tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>
759
984
 
760
985
 
761
986
 
@@ -763,12 +988,69 @@
763
988
 
764
989
  </h3><div class="docstring">
765
990
  <div class="discussion">
766
-
991
+ <p>Find and return the appropriate template for a
992
+ trigger string. Outputs a string that can be
993
+ written out to the terminal for redirection</p>
994
+
767
995
 
768
996
  </div>
769
997
  </div>
770
998
  <div class="tags">
999
+ <p class="tag_title">Parameters:</p>
1000
+ <ul class="param">
1001
+
1002
+ <li>
1003
+
1004
+ <span class='name'>trigger</span>
1005
+
1006
+
1007
+ <span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
1008
+
1009
+
1010
+
1011
+ &mdash;
1012
+ <div class='inline'><p>The trigger to test</p>
1013
+ </div>
1014
+
1015
+ </li>
771
1016
 
1017
+ <li>
1018
+
1019
+ <span class='name'>type</span>
1020
+
1021
+
1022
+ <span class='type'>(<tt><span class='object_link'><a href="../Symbol.html" title="Symbol (class)">Symbol</a></span></tt>)</span>
1023
+
1024
+
1025
+ <em class="default">(defaults to: <tt>:export</tt>)</em>
1026
+
1027
+
1028
+ &mdash;
1029
+ <div class='inline'><p>the plugin type
1030
+ (:import, :export)</p>
1031
+ </div>
1032
+
1033
+ </li>
1034
+
1035
+ </ul>
1036
+
1037
+ <p class="tag_title">Returns:</p>
1038
+ <ul class="return">
1039
+
1040
+ <li>
1041
+
1042
+
1043
+ <span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
1044
+
1045
+
1046
+
1047
+ &mdash;
1048
+ <div class='inline'><p>string content of template for trigger</p>
1049
+ </div>
1050
+
1051
+ </li>
1052
+
1053
+ </ul>
772
1054
  <p class="tag_title">Raises:</p>
773
1055
  <ul class="raise">
774
1056
 
@@ -789,13 +1071,63 @@
789
1071
  <div class="method_details ">
790
1072
  <h3 class="signature " id="template_regex-class_method">
791
1073
 
792
- .<strong>template_regex</strong>(type: :export) &#x21d2; <tt>Object</tt>
1074
+ .<strong>template_regex</strong>(type: :export) &#x21d2; <tt>Regexp</tt>
793
1075
 
794
1076
 
795
1077
 
796
1078
 
797
1079
 
798
- </h3>
1080
+ </h3><div class="docstring">
1081
+ <div class="discussion">
1082
+ <p>Return a regular expression of all template
1083
+ triggers for type</p>
1084
+
1085
+
1086
+ </div>
1087
+ </div>
1088
+ <div class="tags">
1089
+ <p class="tag_title">Parameters:</p>
1090
+ <ul class="param">
1091
+
1092
+ <li>
1093
+
1094
+ <span class='name'>type</span>
1095
+
1096
+
1097
+ <span class='type'>(<tt><span class='object_link'><a href="../Symbol.html" title="Symbol (class)">Symbol</a></span></tt>)</span>
1098
+
1099
+
1100
+ <em class="default">(defaults to: <tt>:export</tt>)</em>
1101
+
1102
+
1103
+ &mdash;
1104
+ <div class='inline'><p>The type :import or
1105
+ :export</p>
1106
+ </div>
1107
+
1108
+ </li>
1109
+
1110
+ </ul>
1111
+
1112
+ <p class="tag_title">Returns:</p>
1113
+ <ul class="return">
1114
+
1115
+ <li>
1116
+
1117
+
1118
+ <span class='type'>(<tt>Regexp</tt>)</span>
1119
+
1120
+
1121
+
1122
+ &mdash;
1123
+ <div class='inline'><p>regular expression</p>
1124
+ </div>
1125
+
1126
+ </li>
1127
+
1128
+ </ul>
1129
+
1130
+ </div>
799
1131
  </div>
800
1132
 
801
1133
  <div class="method_details ">
@@ -813,13 +1145,77 @@
813
1145
  <div class="method_details ">
814
1146
  <h3 class="signature " id="valid_type-class_method">
815
1147
 
816
- .<strong>valid_type</strong>(type, default: nil) &#x21d2; <tt>Object</tt>
1148
+ .<strong>valid_type</strong>(type, default: nil) &#x21d2; <tt><span class='object_link'><a href="../Symbol.html" title="Symbol (class)">Symbol</a></span></tt>
817
1149
 
818
1150
 
819
1151
 
820
1152
 
821
1153
 
822
- </h3>
1154
+ </h3><div class="docstring">
1155
+ <div class="discussion">
1156
+ <p>Converts a partial symbol to a valid plugin type,
1157
+ e.g. :imp =&gt; :import</p>
1158
+
1159
+
1160
+ </div>
1161
+ </div>
1162
+ <div class="tags">
1163
+ <p class="tag_title">Parameters:</p>
1164
+ <ul class="param">
1165
+
1166
+ <li>
1167
+
1168
+ <span class='name'>type</span>
1169
+
1170
+
1171
+ <span class='type'>(<tt><span class='object_link'><a href="../Symbol.html" title="Symbol (class)">Symbol</a></span></tt>)</span>
1172
+
1173
+
1174
+
1175
+ &mdash;
1176
+ <div class='inline'><p>the symbol to test</p>
1177
+ </div>
1178
+
1179
+ </li>
1180
+
1181
+ <li>
1182
+
1183
+ <span class='name'>default</span>
1184
+
1185
+
1186
+ <span class='type'>(<tt><span class='object_link'><a href="../Symbol.html" title="Symbol (class)">Symbol</a></span></tt>)</span>
1187
+
1188
+
1189
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1190
+
1191
+
1192
+ &mdash;
1193
+ <div class='inline'><p>fallback value</p>
1194
+ </div>
1195
+
1196
+ </li>
1197
+
1198
+ </ul>
1199
+
1200
+ <p class="tag_title">Returns:</p>
1201
+ <ul class="return">
1202
+
1203
+ <li>
1204
+
1205
+
1206
+ <span class='type'>(<tt><span class='object_link'><a href="../Symbol.html" title="Symbol (class)">Symbol</a></span></tt>)</span>
1207
+
1208
+
1209
+
1210
+ &mdash;
1211
+ <div class='inline'><p>:import or :export</p>
1212
+ </div>
1213
+
1214
+ </li>
1215
+
1216
+ </ul>
1217
+
1218
+ </div>
823
1219
  </div>
824
1220
 
825
1221
  <div class="method_details ">
@@ -839,7 +1235,7 @@
839
1235
  </div>
840
1236
 
841
1237
  <div id="footer">
842
- Generated on Sun Nov 28 05:27:33 2021 by
1238
+ Generated on Mon Dec 20 15:39:45 2021 by
843
1239
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
844
1240
  0.9.26 (ruby-3.0.1).
845
1241
  </div>