doing 2.0.9.pre → 2.0.15

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 (86) hide show
  1. checksums.yaml +4 -4
  2. data/.yardoc/checksums +20 -0
  3. data/.yardoc/complete +0 -0
  4. data/.yardoc/object_types +0 -0
  5. data/.yardoc/objects/root.dat +0 -0
  6. data/.yardoc/proxy_types +0 -0
  7. data/.yardopts +1 -0
  8. data/CHANGELOG.md +21 -1
  9. data/Gemfile.lock +20 -10
  10. data/README.md +1 -1
  11. data/Rakefile +10 -1
  12. data/bin/doing +106 -38
  13. data/doc/Array.html +135 -0
  14. data/doc/Doing/Color.html +506 -0
  15. data/doc/Doing/Configuration.html +680 -0
  16. data/doc/Doing/Errors/DoingNoTraceError.html +186 -0
  17. data/doc/Doing/Errors/DoingRuntimeError.html +186 -0
  18. data/doc/Doing/Errors/DoingStandardError.html +186 -0
  19. data/doc/Doing/Errors/EmptyInput.html +186 -0
  20. data/doc/Doing/Errors/NoResults.html +186 -0
  21. data/doc/Doing/Errors/PluginException.html +248 -0
  22. data/doc/Doing/Errors/UserCancelled.html +186 -0
  23. data/doc/Doing/Errors/WrongCommand.html +186 -0
  24. data/doc/Doing/Errors.html +191 -0
  25. data/doc/Doing/Hooks.html +364 -0
  26. data/doc/Doing/Item.html +1385 -0
  27. data/doc/Doing/Items.html +393 -0
  28. data/doc/Doing/LogAdapter.html +1650 -0
  29. data/doc/Doing/Note.html +535 -0
  30. data/doc/Doing/Pager.html +268 -0
  31. data/doc/Doing/Plugins.html +849 -0
  32. data/doc/Doing/Util.html +870 -0
  33. data/doc/Doing/WWID.html +4827 -0
  34. data/doc/Doing.html +145 -0
  35. data/doc/GLI/Commands/MarkdownDocumentListener.html +763 -0
  36. data/doc/GLI/Commands.html +115 -0
  37. data/doc/GLI.html +115 -0
  38. data/doc/Hash.html +332 -0
  39. data/doc/Status.html +292 -0
  40. data/doc/String.html +1714 -0
  41. data/doc/Symbol.html +250 -0
  42. data/doc/Time.html +182 -0
  43. data/doc/_index.html +411 -0
  44. data/doc/class_list.html +51 -0
  45. data/doc/css/common.css +1 -0
  46. data/doc/css/full_list.css +58 -0
  47. data/doc/css/style.css +497 -0
  48. data/doc/file.README.html +123 -0
  49. data/doc/file_list.html +56 -0
  50. data/doc/frames.html +17 -0
  51. data/doc/index.html +123 -0
  52. data/doc/js/app.js +314 -0
  53. data/doc/js/full_list.js +216 -0
  54. data/doc/js/jquery.js +4 -0
  55. data/doc/method_list.html +1867 -0
  56. data/doc/top-level-namespace.html +112 -0
  57. data/doing.gemspec +6 -1
  58. data/doing.rdoc +16 -16
  59. data/example_plugin.rb +6 -6
  60. data/lib/completion/_doing.zsh +24 -20
  61. data/lib/completion/doing.bash +41 -30
  62. data/lib/completion/doing.fish +50 -1
  63. data/lib/doing/array.rb +15 -2
  64. data/lib/doing/configuration.rb +14 -12
  65. data/lib/doing/hash.rb +1 -1
  66. data/lib/doing/item.rb +104 -19
  67. data/lib/doing/log_adapter.rb +132 -119
  68. data/lib/doing/note.rb +1 -1
  69. data/lib/doing/plugin_manager.rb +5 -5
  70. data/lib/doing/plugins/export/csv_export.rb +1 -1
  71. data/lib/doing/plugins/export/template_export.rb +5 -7
  72. data/lib/doing/plugins/import/calendar_import.rb +1 -1
  73. data/lib/doing/plugins/import/doing_import.rb +4 -4
  74. data/lib/doing/plugins/import/timing_import.rb +5 -3
  75. data/lib/doing/string.rb +77 -24
  76. data/lib/doing/symbol.rb +9 -5
  77. data/lib/doing/time.rb +1 -1
  78. data/lib/doing/util.rb +18 -11
  79. data/lib/doing/version.rb +1 -1
  80. data/lib/doing/wwid.rb +513 -372
  81. data/lib/doing/wwidfile.rb +5 -5
  82. data/lib/doing.rb +2 -1
  83. data/lib/examples/plugins/say_export.rb +6 -6
  84. data/rdocfixer.rb +1 -1
  85. data/yard_templates/default/method_details/setup.rb +3 -0
  86. metadata +111 -4
data/lib/doing/wwidfile.rb CHANGED
@@ -49,9 +49,9 @@ module Doing
49
49
  end
50
50
 
51
51
  ##
52
- ## @brief Adds a section.
52
+ ## Adds a section.
53
53
  ##
54
- ## @param title (String) The new section title
54
+ ## @param title [String] The new section title
55
55
  ##
56
56
  def add_section(title)
57
57
  if section_titles.include?(title.cap_first)
@@ -64,10 +64,10 @@ module Doing
64
64
  end
65
65
 
66
66
  ##
67
- ## @brief Attempt to match a string with an existing section
67
+ ## Attempt to match a string with an existing section
68
68
  ##
69
- ## @param frag (String) The user-provided string
70
- ## @param guessed (Boolean) already guessed and failed
69
+ ## @param frag [String] The user-provided string
70
+ ## @param guessed [Boolean] already guessed and failed
71
71
  ##
72
72
  def guess_section(frag, guessed: false, suggest: false)
73
73
  return 'All' if frag =~ /^all$/i
data/lib/doing.rb CHANGED
@@ -8,6 +8,7 @@ require 'pp'
8
8
  require 'csv'
9
9
  require 'tempfile'
10
10
  require 'chronic'
11
+ # require 'amatch'
11
12
  require 'haml'
12
13
  require 'json'
13
14
  require 'logger'
@@ -35,7 +36,7 @@ require 'doing/pager'
35
36
  module Doing
36
37
  class << self
37
38
  #
38
- # @brief Fetch the logger
39
+ # Fetch the logger
39
40
  #
40
41
  # @return the LogAdapter instance.
41
42
  #
data/lib/examples/plugins/say_export.rb CHANGED
@@ -26,7 +26,7 @@
26
26
 
27
27
  module Doing
28
28
  ##
29
- ## @brief Plugin class
29
+ ## Plugin class
30
30
  ##
31
31
  class SayExport
32
32
  include Doing::Util
@@ -65,7 +65,7 @@ module Doing
65
65
  ##
66
66
  ## wwid.config['plugins'][PLUGIN_NAME][KEY]
67
67
  ##
68
- ## @brief Method to return plugin settings (required)
68
+ ## Method to return plugin settings (required)
69
69
  ##
70
70
  ## @return Hash of settings for this plugin
71
71
  ##
@@ -87,7 +87,7 @@ module Doing
87
87
  ## included in settings. The method should return a
88
88
  ## string (not output it to the STDOUT).
89
89
  ##
90
- ## @brief Method to return template (optional)
90
+ ## Method to return template (optional)
91
91
  ##
92
92
  ## @param trigger The trigger passed to the
93
93
  ## template function. When this
@@ -96,7 +96,7 @@ module Doing
96
96
  ## used to determine which one is
97
97
  ## output.
98
98
  ##
99
- ## @return (String) template contents
99
+ ## @return [String] template contents
100
100
  ##
101
101
  def self.template(trigger)
102
102
  return unless trigger =~ /^say(it)?$/
@@ -105,7 +105,7 @@ module Doing
105
105
 
106
106
 
107
107
  ##
108
- ## @brief Render data received from an output
108
+ ## Render data received from an output
109
109
  ## command
110
110
  ##
111
111
  ## @param wwid The wwid object with config
@@ -117,7 +117,7 @@ module Doing
117
117
  ## flags passed to command
118
118
  ## (variables[:options])
119
119
  ##
120
- ## @return (String) Rendered output
120
+ ## @return [String] Rendered output
121
121
  ##
122
122
  def self.render(wwid, items, variables: {})
123
123
  return if items.nil? || items.empty?
data/rdocfixer.rb CHANGED
@@ -3,7 +3,7 @@
3
3
  input = $stdin.read
4
4
 
5
5
  input.gsub!(/\n\n( +)##\n/, "\n\n")
6
- input.gsub!(/## @brief +/, '## ')
6
+ input.gsub!(/## +/, '## ')
7
7
  input.gsub!(/## @param +(\w+)(?: +(.*?))?$/, '## - +\1+ -- \2')
8
8
  input.gsub!(/## @returns? +(.*?)$/, '## Returns \1')
9
9
  input.gsub!(/(?<= )##(?= |\n)/, '#')
data/yard_templates/default/method_details/setup.rb ADDED
@@ -0,0 +1,3 @@
1
+ def source
2
+ return
3
+ end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: doing
3
3
  version: !ruby/object:Gem::Version
4
- version: 2.0.9.pre
4
+ version: 2.0.15
5
5
  platform: ruby
6
6
  authors:
7
7
  - Brett Terpstra
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2021-11-18 00:00:00.000000000 Z
11
+ date: 2021-11-22 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: safe_yaml
@@ -86,6 +86,62 @@ dependencies:
86
86
  - - "~>"
87
87
  - !ruby/object:Gem::Version
88
88
  version: 3.4.4
89
+ - !ruby/object:Gem::Dependency
90
+ name: yard
91
+ requirement: !ruby/object:Gem::Requirement
92
+ requirements:
93
+ - - ">="
94
+ - !ruby/object:Gem::Version
95
+ version: '0'
96
+ type: :development
97
+ prerelease: false
98
+ version_requirements: !ruby/object:Gem::Requirement
99
+ requirements:
100
+ - - ">="
101
+ - !ruby/object:Gem::Version
102
+ version: '0'
103
+ - !ruby/object:Gem::Dependency
104
+ name: redcarpet
105
+ requirement: !ruby/object:Gem::Requirement
106
+ requirements:
107
+ - - ">="
108
+ - !ruby/object:Gem::Version
109
+ version: '0'
110
+ type: :development
111
+ prerelease: false
112
+ version_requirements: !ruby/object:Gem::Requirement
113
+ requirements:
114
+ - - ">="
115
+ - !ruby/object:Gem::Version
116
+ version: '0'
117
+ - !ruby/object:Gem::Dependency
118
+ name: github-markup
119
+ requirement: !ruby/object:Gem::Requirement
120
+ requirements:
121
+ - - ">="
122
+ - !ruby/object:Gem::Version
123
+ version: '0'
124
+ type: :development
125
+ prerelease: false
126
+ version_requirements: !ruby/object:Gem::Requirement
127
+ requirements:
128
+ - - ">="
129
+ - !ruby/object:Gem::Version
130
+ version: '0'
131
+ - !ruby/object:Gem::Dependency
132
+ name: parallel_tests
133
+ requirement: !ruby/object:Gem::Requirement
134
+ requirements:
135
+ - - ">="
136
+ - !ruby/object:Gem::Version
137
+ version: '0'
138
+ type: :development
139
+ prerelease: false
140
+ version_requirements: !ruby/object:Gem::Requirement
141
+ requirements:
142
+ - - ">="
143
+ - !ruby/object:Gem::Version
144
+ version: '0'
89
145
  - !ruby/object:Gem::Dependency
90
146
  name: gli
91
147
  requirement: !ruby/object:Gem::Requirement
@@ -176,6 +232,12 @@ extensions: []
176
232
  extra_rdoc_files:
177
233
  - README.md
178
234
  files:
235
+ - ".yardoc/checksums"
236
+ - ".yardoc/complete"
237
+ - ".yardoc/object_types"
238
+ - ".yardoc/objects/root.dat"
239
+ - ".yardoc/proxy_types"
240
+ - ".yardopts"
179
241
  - AUTHORS
180
242
  - CHANGELOG.md
181
243
  - COMMANDS.md
@@ -186,6 +248,50 @@ files:
186
248
  - Rakefile
187
249
  - _config.yml
188
250
  - bin/doing
251
+ - doc/Array.html
252
+ - doc/Doing.html
253
+ - doc/Doing/Color.html
254
+ - doc/Doing/Configuration.html
255
+ - doc/Doing/Errors.html
256
+ - doc/Doing/Errors/DoingNoTraceError.html
257
+ - doc/Doing/Errors/DoingRuntimeError.html
258
+ - doc/Doing/Errors/DoingStandardError.html
259
+ - doc/Doing/Errors/EmptyInput.html
260
+ - doc/Doing/Errors/NoResults.html
261
+ - doc/Doing/Errors/PluginException.html
262
+ - doc/Doing/Errors/UserCancelled.html
263
+ - doc/Doing/Errors/WrongCommand.html
264
+ - doc/Doing/Hooks.html
265
+ - doc/Doing/Item.html
266
+ - doc/Doing/Items.html
267
+ - doc/Doing/LogAdapter.html
268
+ - doc/Doing/Note.html
269
+ - doc/Doing/Pager.html
270
+ - doc/Doing/Plugins.html
271
+ - doc/Doing/Util.html
272
+ - doc/Doing/WWID.html
273
+ - doc/GLI.html
274
+ - doc/GLI/Commands.html
275
+ - doc/GLI/Commands/MarkdownDocumentListener.html
276
+ - doc/Hash.html
277
+ - doc/Status.html
278
+ - doc/String.html
279
+ - doc/Symbol.html
280
+ - doc/Time.html
281
+ - doc/_index.html
282
+ - doc/class_list.html
283
+ - doc/css/common.css
284
+ - doc/css/full_list.css
285
+ - doc/css/style.css
286
+ - doc/file.README.html
287
+ - doc/file_list.html
288
+ - doc/frames.html
289
+ - doc/index.html
290
+ - doc/js/app.js
291
+ - doc/js/full_list.js
292
+ - doc/js/jquery.js
293
+ - doc/method_list.html
294
+ - doc/top-level-namespace.html
189
295
  - doing.gemspec
190
296
  - doing.rdoc
191
297
  - example_plugin.rb
@@ -248,6 +354,7 @@ files:
248
354
  - scripts/generate_bash_completions.rb
249
355
  - scripts/generate_fish_completions.rb
250
356
  - scripts/generate_zsh_completions.rb
357
+ - yard_templates/default/method_details/setup.rb
251
358
  homepage: http://brettterpstra.com/project/doing/
252
359
  licenses:
253
360
  - MIT
@@ -270,9 +377,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
270
377
  version: '0'
271
378
  required_rubygems_version: !ruby/object:Gem::Requirement
272
379
  requirements:
273
- - - ">"
380
+ - - ">="
274
381
  - !ruby/object:Gem::Version
275
- version: 1.3.1
382
+ version: '0'
276
383
  requirements: []
277
384
  rubygems_version: 3.2.16
278
385
  signing_key: