doing 2.1.2pre → 2.1.6pre

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/.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
@@ -140,11 +140,13 @@
140
140
  <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>plugin_path</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="Util.html" title="Doing::Util (module)">Util</a></span></span><span class='period'>.</span><span class='id identifier rubyid_user_home'><span class='object_link'><a href="Util.html#user_home-instance_method" title="Doing::Util#user_home (method)">user_home</a></span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>.config</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>doing</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>plugins</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span><span class='comma'>,</span>
141
141
  <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>command_path</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="Util.html" title="Doing::Util (module)">Util</a></span></span><span class='period'>.</span><span class='id identifier rubyid_user_home'><span class='object_link'><a href="Util.html#user_home-instance_method" title="Doing::Util#user_home (method)">user_home</a></span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>.config</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>doing</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>commands</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
142
142
  <span class='rbrace'>}</span><span class='comma'>,</span>
143
- <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>doing_file</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>~/what_was_i_doing.md</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
143
+ <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>doing_file</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>~/.local/share/doing/what_was_i_doing.md</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
144
+ <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>backup_dir</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>~/.local/share/doing/doing_backup</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
144
145
  <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>current_section</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Currently</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
145
146
  <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>paginate</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='kw'>false</span><span class='comma'>,</span>
146
147
  <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>never_time</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='lbracket'>[</span><span class='rbracket'>]</span><span class='comma'>,</span>
147
148
  <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>never_finish</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='lbracket'>[</span><span class='rbracket'>]</span><span class='comma'>,</span>
149
+ <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>date_tags</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>done</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>defer(?:red)?</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>waiting</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='comma'>,</span>
148
150
 
149
151
  <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>timer_format</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>text</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
150
152
  <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>interval_format</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>text</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
@@ -152,7 +154,8 @@
152
154
  <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>templates</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='lbrace'>{</span>
153
155
  <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>default</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='lbrace'>{</span>
154
156
  <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>date_format</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>%Y-%m-%d %H:%M</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
155
- <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>template</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>%date | %title %interval%duration%note</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
157
+ <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>template</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>%reset%cyan%shortdate %boldwhite%80║ title %dark%boldmagenta[%boldwhite%-10section%boldmagenta]%reset
158
+ %yellow%interval%boldred%duration%dark%white%80_14┃ note</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
156
159
  <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>wrap_width</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='int'>0</span><span class='comma'>,</span>
157
160
  <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>order</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>asc</span><span class='tstring_end'>&#39;</span></span>
158
161
  <span class='rbrace'>}</span><span class='comma'>,</span>
@@ -169,7 +172,8 @@
169
172
  <span class='rbrace'>}</span><span class='comma'>,</span>
170
173
  <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>recent</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='lbrace'>{</span>
171
174
  <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>date_format</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>%_I:%M%P</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
172
- <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>template</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>%shortdate: %title (%section) %interval%duration%note</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
175
+ <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>template</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>%reset%cyan%shortdate %boldwhite%80║ title %dark%boldmagenta[%boldwhite%-10section%boldmagenta]%reset
176
+ %yellow%interval%boldred%duration%dark%white%80_14┃ note</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
173
177
  <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>wrap_width</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='int'>88</span><span class='comma'>,</span>
174
178
  <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>count</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='int'>10</span><span class='comma'>,</span>
175
179
  <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>order</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>asc</span><span class='tstring_end'>&#39;</span></span>
@@ -181,7 +185,7 @@
181
185
  <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>views</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='lbrace'>{</span>
182
186
  <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>done</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='lbrace'>{</span>
183
187
  <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>date_format</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>%_I:%M%P</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
184
- <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>template</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>%date | %title%note</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
188
+ <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>template</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>%date | %title (%section)% 18: note</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
185
189
  <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>wrap_width</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='int'>0</span><span class='comma'>,</span>
186
190
  <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>section</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>All</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
187
191
  <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>count</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='int'>0</span><span class='comma'>,</span>
@@ -202,6 +206,11 @@
202
206
  <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>marker_color</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>red</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
203
207
  <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>default_tags</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='lbracket'>[</span><span class='rbracket'>]</span><span class='comma'>,</span>
204
208
  <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>tag_sort</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>name</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
209
+ <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>search</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='lbrace'>{</span>
210
+ <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>matching</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>pattern</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='comment'># fuzzy, pattern, exact
211
+ </span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>distance</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='int'>3</span><span class='comma'>,</span>
212
+ <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>case</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>smart</span><span class='tstring_end'>&#39;</span></span> <span class='comment'># sensitive, ignore, smart
213
+ </span> <span class='rbrace'>}</span><span class='comma'>,</span>
205
214
  <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>include_notes</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='kw'>true</span>
206
215
  <span class='rbrace'>}</span></pre></dd>
207
216
 
@@ -214,6 +223,56 @@
214
223
  <h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
215
224
  <ul class="summary">
216
225
 
226
+ <li class="public ">
227
+ <span class="summary_signature">
228
+
229
+ <a href="#config_file-instance_method" title="#config_file (instance method)">#<strong>config_file</strong> &#x21d2; Object </a>
230
+
231
+
232
+
233
+ </span>
234
+
235
+
236
+
237
+
238
+
239
+
240
+
241
+
242
+
243
+
244
+
245
+
246
+ <span class="summary_desc"><div class='inline'></div></span>
247
+
248
+ </li>
249
+
250
+
251
+ <li class="public ">
252
+ <span class="summary_signature">
253
+
254
+ <a href="#force_answer-instance_method" title="#force_answer (instance method)">#<strong>force_answer</strong> &#x21d2; Object </a>
255
+
256
+
257
+
258
+ </span>
259
+
260
+
261
+
262
+
263
+
264
+
265
+
266
+
267
+
268
+
269
+
270
+
271
+ <span class="summary_desc"><div class='inline'></div></span>
272
+
273
+ </li>
274
+
275
+
217
276
  <li class="public ">
218
277
  <span class="summary_signature">
219
278
 
@@ -353,7 +412,7 @@
353
412
  <li class="public ">
354
413
  <span class="summary_signature">
355
414
 
356
- <a href="#config_file-instance_method" title="#config_file (instance method)">#<strong>config_file</strong> &#x21d2; Object </a>
415
+ <a href="#configure-instance_method" title="#configure (instance method)">#<strong>configure</strong>(opt = {}) &#x21d2; Object </a>
357
416
 
358
417
 
359
418
 
@@ -367,7 +426,8 @@
367
426
 
368
427
 
369
428
 
370
- <span class="summary_desc"><div class='inline'></div></span>
429
+ <span class="summary_desc"><div class='inline'><p>Read user configuration and merge with defaults.</p>
430
+ </div></span>
371
431
 
372
432
  </li>
373
433
 
@@ -375,7 +435,7 @@
375
435
  <li class="public ">
376
436
  <span class="summary_signature">
377
437
 
378
- <a href="#config_file=-instance_method" title="#config_file= (instance method)">#<strong>config_file=</strong>(file) &#x21d2; Object </a>
438
+ <a href="#default_config_file-instance_method" title="#default_config_file (instance method)">#<strong>default_config_file</strong> &#x21d2; Object </a>
379
439
 
380
440
 
381
441
 
@@ -397,7 +457,7 @@
397
457
  <li class="public ">
398
458
  <span class="summary_signature">
399
459
 
400
- <a href="#configure-instance_method" title="#configure (instance method)">#<strong>configure</strong>(opt = {}) &#x21d2; Object </a>
460
+ <a href="#exact_match%3F-instance_method" title="#exact_match? (instance method)">#<strong>exact_match?</strong> &#x21d2; Boolean </a>
401
461
 
402
462
 
403
463
 
@@ -411,7 +471,7 @@
411
471
 
412
472
 
413
473
 
414
- <span class="summary_desc"><div class='inline'><p>Read user configuration and merge with defaults.</p>
474
+ <span class="summary_desc"><div class='inline'><p>Check if configuration enforces exact string matching.</p>
415
475
  </div></span>
416
476
 
417
477
  </li>
@@ -420,29 +480,7 @@
420
480
  <li class="public ">
421
481
  <span class="summary_signature">
422
482
 
423
- <a href="#default_config_file-instance_method" title="#default_config_file (instance method)">#<strong>default_config_file</strong> &#x21d2; Object </a>
424
-
425
-
426
-
427
- </span>
428
-
429
-
430
-
431
-
432
-
433
-
434
-
435
-
436
-
437
- <span class="summary_desc"><div class='inline'></div></span>
438
-
439
- </li>
440
-
441
-
442
- <li class="public ">
443
- <span class="summary_signature">
444
-
445
- <a href="#from-instance_method" title="#from (instance method)">#<strong>from</strong>(user_config) &#x21d2; Object </a>
483
+ <a href="#from-instance_method" title="#from (instance method)">#<strong>from</strong>(user_config) &#x21d2; Hash </a>
446
484
 
447
485
 
448
486
 
@@ -590,9 +628,37 @@
590
628
  <h2>Instance Attribute Details</h2>
591
629
 
592
630
 
593
- <span id=""></span>
631
+ <span id="config_file=-instance_method"></span>
594
632
  <div class="method_details first">
595
- <h3 class="signature first" id="ignore_local=-instance_method">
633
+ <h3 class="signature first" id="config_file-instance_method">
634
+
635
+ #<strong>config_file</strong> &#x21d2; <tt>Object</tt>
636
+
637
+
638
+
639
+
640
+
641
+ </h3>
642
+ </div>
643
+
644
+
645
+ <span id="force_answer=-instance_method"></span>
646
+ <div class="method_details ">
647
+ <h3 class="signature " id="force_answer-instance_method">
648
+
649
+ #<strong>force_answer</strong> &#x21d2; <tt>Object</tt>
650
+
651
+
652
+
653
+
654
+
655
+ </h3>
656
+ </div>
657
+
658
+
659
+ <span id=""></span>
660
+ <div class="method_details ">
661
+ <h3 class="signature " id="ignore_local=-instance_method">
596
662
 
597
663
  #<strong>ignore_local=</strong>(value) &#x21d2; <tt>Object</tt> <span class="extras">(writeonly)</span>
598
664
 
@@ -723,30 +789,6 @@
723
789
 
724
790
 
725
791
 
726
- </h3>
727
- </div>
728
-
729
- <div class="method_details ">
730
- <h3 class="signature " id="config_file-instance_method">
731
-
732
- #<strong>config_file</strong> &#x21d2; <tt>Object</tt>
733
-
734
-
735
-
736
-
737
-
738
- </h3>
739
- </div>
740
-
741
- <div class="method_details ">
742
- <h3 class="signature " id="config_file=-instance_method">
743
-
744
- #<strong>config_file=</strong>(file) &#x21d2; <tt>Object</tt>
745
-
746
-
747
-
748
-
749
-
750
792
  </h3>
751
793
  </div>
752
794
 
@@ -802,24 +844,41 @@
802
844
 
803
845
 
804
846
 
847
+ </h3>
848
+ </div>
849
+
850
+ <div class="method_details ">
851
+ <h3 class="signature " id="exact_match?-instance_method">
852
+
853
+ #<strong>exact_match?</strong> &#x21d2; <tt>Boolean</tt>
854
+
855
+
856
+
857
+
858
+
805
859
  </h3><div class="docstring">
806
860
  <div class="discussion">
807
-
861
+ <p>Check if configuration enforces exact string matching</p>
862
+
808
863
 
809
864
  </div>
810
865
  </div>
811
866
  <div class="tags">
812
867
 
813
- <p class="tag_title">Raises:</p>
814
- <ul class="raise">
868
+ <p class="tag_title">Returns:</p>
869
+ <ul class="return">
815
870
 
816
871
  <li>
817
872
 
818
873
 
819
- <span class='type'>(<tt>DoingRuntimeError</tt>)</span>
874
+ <span class='type'>(<tt>Boolean</tt>)</span>
820
875
 
821
876
 
822
877
 
878
+ &mdash;
879
+ <div class='inline'><p>exact matching enabled</p>
880
+ </div>
881
+
823
882
  </li>
824
883
 
825
884
  </ul>
@@ -830,7 +889,7 @@
830
889
  <div class="method_details ">
831
890
  <h3 class="signature " id="from-instance_method">
832
891
 
833
- #<strong>from</strong>(user_config) &#x21d2; <tt>Object</tt>
892
+ #<strong>from</strong>(user_config) &#x21d2; <tt><span class='object_link'><a href="../Hash.html" title="Hash (class)">Hash</a></span></tt>
834
893
 
835
894
 
836
895
 
@@ -838,17 +897,52 @@
838
897
 
839
898
  </h3><div class="docstring">
840
899
  <div class="discussion">
841
- <p>It takes the input, fills in the defaults where values do not exist.</p>
842
-
843
- <p>user_config - a Hash or Configuration of overrides.</p>
844
-
845
- <p>Returns a Configuration filled with defaults.</p>
900
+ <p>It takes the input, fills in the defaults where values
901
+ do not exist.</p>
846
902
 
847
903
 
848
904
  </div>
849
905
  </div>
850
906
  <div class="tags">
907
+ <p class="tag_title">Parameters:</p>
908
+ <ul class="param">
909
+
910
+ <li>
911
+
912
+ <span class='name'>user_config</span>
913
+
914
+
915
+ <span class='type'></span>
916
+
917
+
918
+
919
+ &mdash;
920
+ <div class='inline'><p>a Hash or Configuration of
921
+ overrides.</p>
922
+ </div>
923
+
924
+ </li>
925
+
926
+ </ul>
927
+
928
+ <p class="tag_title">Returns:</p>
929
+ <ul class="return">
930
+
931
+ <li>
932
+
933
+
934
+ <span class='type'>(<tt><span class='object_link'><a href="../Hash.html" title="Hash (class)">Hash</a></span></tt>)</span>
935
+
936
+
937
+
938
+ &mdash;
939
+ <div class='inline'><p>a Configuration filled with
940
+ defaults.</p>
941
+ </div>
942
+
943
+ </li>
851
944
 
945
+ </ul>
852
946
 
853
947
  </div>
854
948
  </div>
@@ -1006,7 +1100,7 @@ matched, first match wins)</p>
1006
1100
  </div>
1007
1101
 
1008
1102
  <div id="footer">
1009
- Generated on Sun Nov 28 05:27:33 2021 by
1103
+ Generated on Mon Dec 20 15:39:46 2021 by
1010
1104
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1011
1105
  0.9.26 (ruby-3.0.1).
1012
1106
  </div>
File without changes
@@ -176,7 +176,7 @@
176
176
  </div>
177
177
 
178
178
  <div id="footer">
179
- Generated on Sun Nov 28 05:27:33 2021 by
179
+ Generated on Mon Dec 20 15:39:46 2021 by
180
180
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
181
181
  0.9.26 (ruby-3.0.1).
182
182
  </div>
@@ -176,7 +176,7 @@
176
176
  </div>
177
177
 
178
178
  <div id="footer">
179
- Generated on Sun Nov 28 05:27:33 2021 by
179
+ Generated on Mon Dec 20 15:39:46 2021 by
180
180
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
181
181
  0.9.26 (ruby-3.0.1).
182
182
  </div>
@@ -176,7 +176,7 @@
176
176
  </div>
177
177
 
178
178
  <div id="footer">
179
- Generated on Sun Nov 28 05:27:33 2021 by
179
+ Generated on Mon Dec 20 15:39:46 2021 by
180
180
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
181
181
  0.9.26 (ruby-3.0.1).
182
182
  </div>
@@ -176,7 +176,7 @@
176
176
  </div>
177
177
 
178
178
  <div id="footer">
179
- Generated on Sun Nov 28 05:27:33 2021 by
179
+ Generated on Mon Dec 20 15:39:46 2021 by
180
180
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
181
181
  0.9.26 (ruby-3.0.1).
182
182
  </div>
@@ -176,7 +176,7 @@
176
176
  </div>
177
177
 
178
178
  <div id="footer">
179
- Generated on Sun Nov 28 05:27:33 2021 by
179
+ Generated on Mon Dec 20 15:39:46 2021 by
180
180
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
181
181
  0.9.26 (ruby-3.0.1).
182
182
  </div>
@@ -238,7 +238,7 @@
238
238
  </div>
239
239
 
240
240
  <div id="footer">
241
- Generated on Sun Nov 28 05:27:33 2021 by
241
+ Generated on Mon Dec 20 15:39:46 2021 by
242
242
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
243
243
  0.9.26 (ruby-3.0.1).
244
244
  </div>
@@ -176,7 +176,7 @@
176
176
  </div>
177
177
 
178
178
  <div id="footer">
179
- Generated on Sun Nov 28 05:27:33 2021 by
179
+ Generated on Mon Dec 20 15:39:46 2021 by
180
180
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
181
181
  0.9.26 (ruby-3.0.1).
182
182
  </div>
@@ -176,7 +176,7 @@
176
176
  </div>
177
177
 
178
178
  <div id="footer">
179
- Generated on Sun Nov 28 05:27:33 2021 by
179
+ Generated on Mon Dec 20 15:39:46 2021 by
180
180
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
181
181
  0.9.26 (ruby-3.0.1).
182
182
  </div>
@@ -181,7 +181,7 @@
181
181
  </div>
182
182
 
183
183
  <div id="footer">
184
- Generated on Sun Nov 28 05:27:33 2021 by
184
+ Generated on Mon Dec 20 15:39:45 2021 by
185
185
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
186
186
  0.9.26 (ruby-3.0.1).
187
187
  </div>
@@ -354,7 +354,7 @@
354
354
  </div>
355
355
 
356
356
  <div id="footer">
357
- Generated on Sun Nov 28 05:27:33 2021 by
357
+ Generated on Mon Dec 20 15:39:45 2021 by
358
358
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
359
359
  0.9.26 (ruby-3.0.1).
360
360
  </div>