standup_md 0.0.10

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 (64) hide show
  1. checksums.yaml +7 -0
  2. data/.github/workflows/ruby.yml +24 -0
  3. data/.gitignore +1 -0
  4. data/Gemfile +10 -0
  5. data/Gemfile.lock +23 -0
  6. data/LICENSE +21 -0
  7. data/README.md +252 -0
  8. data/Rakefile +36 -0
  9. data/_config.yml +1 -0
  10. data/bin/standup +5 -0
  11. data/doc/README_md.html +290 -0
  12. data/doc/StandupMD/Cli.html +898 -0
  13. data/doc/StandupMD.html +1453 -0
  14. data/doc/TestHelper.html +282 -0
  15. data/doc/TestStandupMD.html +1938 -0
  16. data/doc/created.rid +8 -0
  17. data/doc/css/fonts.css +167 -0
  18. data/doc/css/rdoc.css +611 -0
  19. data/doc/fonts/Lato-Light.ttf +0 -0
  20. data/doc/fonts/Lato-LightItalic.ttf +0 -0
  21. data/doc/fonts/Lato-Regular.ttf +0 -0
  22. data/doc/fonts/Lato-RegularItalic.ttf +0 -0
  23. data/doc/fonts/SourceCodePro-Bold.ttf +0 -0
  24. data/doc/fonts/SourceCodePro-Regular.ttf +0 -0
  25. data/doc/images/add.png +0 -0
  26. data/doc/images/arrow_up.png +0 -0
  27. data/doc/images/brick.png +0 -0
  28. data/doc/images/brick_link.png +0 -0
  29. data/doc/images/bug.png +0 -0
  30. data/doc/images/bullet_black.png +0 -0
  31. data/doc/images/bullet_toggle_minus.png +0 -0
  32. data/doc/images/bullet_toggle_plus.png +0 -0
  33. data/doc/images/date.png +0 -0
  34. data/doc/images/delete.png +0 -0
  35. data/doc/images/find.png +0 -0
  36. data/doc/images/loadingAnimation.gif +0 -0
  37. data/doc/images/macFFBgHack.png +0 -0
  38. data/doc/images/package.png +0 -0
  39. data/doc/images/page_green.png +0 -0
  40. data/doc/images/page_white_text.png +0 -0
  41. data/doc/images/page_white_width.png +0 -0
  42. data/doc/images/plugin.png +0 -0
  43. data/doc/images/ruby.png +0 -0
  44. data/doc/images/tag_blue.png +0 -0
  45. data/doc/images/tag_green.png +0 -0
  46. data/doc/images/transparent.png +0 -0
  47. data/doc/images/wrench.png +0 -0
  48. data/doc/images/wrench_orange.png +0 -0
  49. data/doc/images/zoom.png +0 -0
  50. data/doc/index.html +286 -0
  51. data/doc/js/darkfish.js +84 -0
  52. data/doc/js/navigation.js +105 -0
  53. data/doc/js/navigation.js.gz +0 -0
  54. data/doc/js/search.js +110 -0
  55. data/doc/js/search_index.js +1 -0
  56. data/doc/js/search_index.js.gz +0 -0
  57. data/doc/js/searcher.js +229 -0
  58. data/doc/js/searcher.js.gz +0 -0
  59. data/doc/table_of_contents.html +551 -0
  60. data/lib/standup_md/cli.rb +301 -0
  61. data/lib/standup_md/version.rb +9 -0
  62. data/lib/standup_md.rb +530 -0
  63. data/standup_md.gemspec +36 -0
  64. metadata +108 -0
@@ -0,0 +1,282 @@
1
+ <!DOCTYPE html>
2
+
3
+ <html>
4
+ <head>
5
+ <meta charset="UTF-8">
6
+
7
+ <title>module TestHelper - RDoc Documentation</title>
8
+
9
+ <script type="text/javascript">
10
+ var rdoc_rel_prefix = "./";
11
+ var index_rel_prefix = "./";
12
+ </script>
13
+
14
+ <script src="./js/navigation.js" defer></script>
15
+ <script src="./js/search.js" defer></script>
16
+ <script src="./js/search_index.js" defer></script>
17
+ <script src="./js/searcher.js" defer></script>
18
+ <script src="./js/darkfish.js" defer></script>
19
+
20
+ <link href="./css/fonts.css" rel="stylesheet">
21
+ <link href="./css/rdoc.css" rel="stylesheet">
22
+
23
+
24
+
25
+
26
+ <body id="top" role="document" class="module">
27
+ <nav role="navigation">
28
+ <div id="project-navigation">
29
+ <div id="home-section" role="region" title="Quick navigation" class="nav-section">
30
+ <h2>
31
+ <a href="./index.html" rel="home">Home</a>
32
+ </h2>
33
+
34
+ <div id="table-of-contents-navigation">
35
+ <a href="./table_of_contents.html#pages">Pages</a>
36
+ <a href="./table_of_contents.html#classes">Classes</a>
37
+ <a href="./table_of_contents.html#methods">Methods</a>
38
+ </div>
39
+ </div>
40
+
41
+ <div id="search-section" role="search" class="project-section initially-hidden">
42
+ <form action="#" method="get" accept-charset="utf-8">
43
+ <div id="search-field-wrapper">
44
+ <input id="search-field" role="combobox" aria-label="Search"
45
+ aria-autocomplete="list" aria-controls="search-results"
46
+ type="text" name="search" placeholder="Search" spellcheck="false"
47
+ title="Type to search, Up and Down to navigate, Enter to load">
48
+ </div>
49
+
50
+ <ul id="search-results" aria-label="Search Results"
51
+ aria-busy="false" aria-expanded="false"
52
+ aria-atomic="false" class="initially-hidden"></ul>
53
+ </form>
54
+ </div>
55
+
56
+ </div>
57
+
58
+
59
+
60
+ <div id="class-metadata">
61
+
62
+
63
+
64
+
65
+ <!-- Method Quickref -->
66
+ <div id="method-list-section" class="nav-section">
67
+ <h3>Methods</h3>
68
+
69
+ <ul class="link-list" role="directory">
70
+
71
+ <li ><a href="#method-i-cli">#cli</a>
72
+
73
+ <li ><a href="#method-i-create_standup_file">#create_standup_file</a>
74
+
75
+ <li ><a href="#method-i-fixtures">#fixtures</a>
76
+
77
+ <li ><a href="#method-i-standup">#standup</a>
78
+
79
+ </ul>
80
+ </div>
81
+
82
+ </div>
83
+ </nav>
84
+
85
+ <main role="main" aria-labelledby="module-TestHelper">
86
+ <h1 id="module-TestHelper" class="module">
87
+ module TestHelper
88
+ </h1>
89
+
90
+ <section class="description">
91
+
92
+ <p>Module to include in tests that provides helper functions.</p>
93
+
94
+ </section>
95
+
96
+
97
+ <section id="5Buntitled-5D" class="documentation-section">
98
+
99
+
100
+
101
+
102
+
103
+
104
+
105
+
106
+
107
+ <section id="public-instance-5Buntitled-5D-method-details" class="method-section">
108
+ <header>
109
+ <h3>Public Instance Methods</h3>
110
+ </header>
111
+
112
+
113
+ <div id="method-i-cli" class="method-detail ">
114
+
115
+ <div class="method-heading">
116
+ <span class="method-name">cli</span><span
117
+ class="method-args">(options = [])</span>
118
+
119
+ <span class="method-click-advice">click to toggle source</span>
120
+
121
+ </div>
122
+
123
+
124
+ <div class="method-description">
125
+
126
+ <p>Creates instance of <code>CLI</code>.</p>
127
+
128
+ <p>@param [Array] options Parsed by <code>getopts</code></p>
129
+
130
+ <p>@return [StandupMD::CLI]</p>
131
+
132
+
133
+
134
+
135
+ <div class="method-source-code" id="cli-source">
136
+ <pre><span class="ruby-comment"># File test/test_helper.rb, line 58</span>
137
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">cli</span>(<span class="ruby-identifier">options</span> = [])
138
+ <span class="ruby-constant">StandupMD</span><span class="ruby-operator">::</span><span class="ruby-constant">CLI</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">options</span>)
139
+ <span class="ruby-keyword">end</span></pre>
140
+ </div>
141
+
142
+ </div>
143
+
144
+
145
+
146
+
147
+ </div>
148
+
149
+
150
+ <div id="method-i-create_standup_file" class="method-detail ">
151
+
152
+ <div class="method-heading">
153
+ <span class="method-name">create_standup_file</span><span
154
+ class="method-args">(file, fixture = &#39;previous_entry&#39;)</span>
155
+
156
+ <span class="method-click-advice">click to toggle source</span>
157
+
158
+ </div>
159
+
160
+
161
+ <div class="method-description">
162
+
163
+ <p>Creates the standup file with entries.</p>
164
+
165
+ <p>@param [String] file The name of the file to create</p>
166
+
167
+ <p>@param [String] fixture Fixture to add to the file</p>
168
+
169
+ <p>@return [Hash]</p>
170
+
171
+
172
+
173
+
174
+ <div class="method-source-code" id="create_standup_file-source">
175
+ <pre><span class="ruby-comment"># File test/test_helper.rb, line 42</span>
176
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">create_standup_file</span>(<span class="ruby-identifier">file</span>, <span class="ruby-identifier">fixture</span> = <span class="ruby-string">&#39;previous_entry&#39;</span>)
177
+ <span class="ruby-identifier">dir</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">dirname</span>(<span class="ruby-identifier">file</span>)
178
+ <span class="ruby-constant">FileUtils</span>.<span class="ruby-identifier">mkdir</span>(<span class="ruby-identifier">dir</span>) <span class="ruby-keyword">unless</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">directory?</span>(<span class="ruby-identifier">dir</span>)
179
+ <span class="ruby-constant">File</span>.<span class="ruby-identifier">open</span>(<span class="ruby-identifier">file</span>, <span class="ruby-string">&#39;w&#39;</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">f</span><span class="ruby-operator">|</span>
180
+ <span class="ruby-identifier">f</span>.<span class="ruby-identifier">puts</span> <span class="ruby-identifier">fixtures</span>[<span class="ruby-identifier">fixture</span>]
181
+ <span class="ruby-identifier">f</span>.<span class="ruby-identifier">puts</span>
182
+ <span class="ruby-identifier">f</span>.<span class="ruby-identifier">puts</span> <span class="ruby-identifier">fixtures</span>[<span class="ruby-string">&#39;current_entry&#39;</span>]
183
+ <span class="ruby-keyword">end</span>
184
+ <span class="ruby-keyword">end</span></pre>
185
+ </div>
186
+
187
+ </div>
188
+
189
+
190
+
191
+
192
+ </div>
193
+
194
+
195
+ <div id="method-i-fixtures" class="method-detail ">
196
+
197
+ <div class="method-heading">
198
+ <span class="method-name">fixtures</span><span
199
+ class="method-args">()</span>
200
+
201
+ <span class="method-click-advice">click to toggle source</span>
202
+
203
+ </div>
204
+
205
+
206
+ <div class="method-description">
207
+
208
+ <p>Reads the fixtures in as a hash.</p>
209
+
210
+ <p>@return [Hash]</p>
211
+
212
+
213
+
214
+
215
+ <div class="method-source-code" id="fixtures-source">
216
+ <pre><span class="ruby-comment"># File test/test_helper.rb, line 15</span>
217
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">fixtures</span>
218
+ <span class="ruby-ivar">@test_helper_fixtures</span> <span class="ruby-operator">||=</span> <span class="ruby-constant">YAML</span>.<span class="ruby-identifier">load</span>(<span class="ruby-constant">ERB</span>.<span class="ruby-identifier">new</span>(<span class="ruby-constant">File</span>.<span class="ruby-identifier">read</span>(
219
+ <span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-identifier">__dir__</span>, <span class="ruby-string">&#39;fixtures.yml.erb&#39;</span>)
220
+ )).<span class="ruby-identifier">result</span>(<span class="ruby-identifier">binding</span>))
221
+ <span class="ruby-keyword">end</span></pre>
222
+ </div>
223
+
224
+ </div>
225
+
226
+
227
+
228
+
229
+ </div>
230
+
231
+
232
+ <div id="method-i-standup" class="method-detail ">
233
+
234
+ <div class="method-heading">
235
+ <span class="method-name">standup</span><span
236
+ class="method-args">(directory, args = {})</span>
237
+
238
+ <span class="method-click-advice">click to toggle source</span>
239
+
240
+ </div>
241
+
242
+
243
+ <div class="method-description">
244
+
245
+ <p>Creates <code>StandupUP</code> instance. Directory must be passed, usually a subdirectory of <code>test</code>, so we don&#39;t overwrite the user&#39;s standup file.</p>
246
+
247
+ <p>@param [String] directory @param [Hash] args Optional hash of attributes to set</p>
248
+
249
+ <p>@return [StandupMD]</p>
250
+
251
+
252
+
253
+
254
+ <div class="method-source-code" id="standup-source">
255
+ <pre><span class="ruby-comment"># File test/test_helper.rb, line 29</span>
256
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">standup</span>(<span class="ruby-identifier">directory</span>, <span class="ruby-identifier">args</span> = {})
257
+ <span class="ruby-identifier">args</span>[<span class="ruby-string">&#39;directory&#39;</span>] = <span class="ruby-identifier">directory</span>
258
+ <span class="ruby-constant">StandupMD</span>.<span class="ruby-identifier">load</span>(<span class="ruby-identifier">args</span>)
259
+ <span class="ruby-keyword">end</span></pre>
260
+ </div>
261
+
262
+ </div>
263
+
264
+
265
+
266
+
267
+ </div>
268
+
269
+
270
+ </section>
271
+
272
+ </section>
273
+
274
+ </main>
275
+
276
+
277
+ <footer id="validator-badges" role="contentinfo">
278
+ <p><a href="https://validator.w3.org/check/referer">Validate</a>
279
+ <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.1.2.
280
+ <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
281
+ </footer>
282
+