nikki 0.4.0 → 0.4.1

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.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 3af1b34692ff19d9c2da510c3cd4296ec5283e4c
4
- data.tar.gz: e1ca1aa574afb7d2d01d43fc157f32c1aa46e9c4
3
+ metadata.gz: 5f4869dbfb65368dfe3d24270d486ab1df5e218b
4
+ data.tar.gz: f94760768fb43c40cb31abbb95f78b3aef20d34e
5
5
  SHA512:
6
- metadata.gz: 608f65b0730f0c3bed2e61c514de86b31dc1a4c9e1830ee5b4f7d735fd8fdd225640785680e5749b34c675ee52167c6c58c1c97ac8e876ac9551c8446aa45ffd
7
- data.tar.gz: 0b85588e5f356e7943d8d18be449294822918e7e4a5f08571f27d1bef5256aed0689e87fe3146ab3a3e64716b57686b59f12efcb5cadea22194f858dddbdc51c
6
+ metadata.gz: 9fe3da2238dfa17fdfeb2d363b4e7fe74f2d25739744e501638309a403ecd9340a6486699ffec1798b19dfd8ab30ed7dc5c437bcfe0a901c1b0cca30121b39ab
7
+ data.tar.gz: 3264db6cb465d22e9dddf576c401e76fa760d795ac0ef5ac92ae48b77c32032467e6b80aa439a01754c11114dd2f3f947ba66730d64bb988cb1c4a39495cb14b
data/.gitignore CHANGED
@@ -2,18 +2,12 @@
2
2
  *.rbc
3
3
  .bundle
4
4
  .config
5
- .yardoc
6
5
  Gemfile.lock
7
6
  InstalledFiles
8
- _yardoc
7
+ tags
9
8
  coverage
10
- doc/
11
9
  lib/bundler/man
12
10
  pkg
13
- rdoc
14
11
  spec/reports
15
- test/tmp
16
- test/version_tmp
17
12
  tmp
18
- .codekit
19
13
  .DS_STORE
data/README.md CHANGED
@@ -28,7 +28,8 @@ Or install it yourself as:
28
28
  nikki config # Change Nikki's settings.
29
29
  nikki help [COMMAND] # Describe available commands or one specific command
30
30
  nikki new ENTRY # Creates a new entry in the Nikki journal.
31
- nikki open # Opens current year's journal file in editor.
31
+ nikki open # Open current year's journal file in editor.
32
+ nikki setup # Creates new Nikki and config files.
32
33
 
33
34
  ## Contributing
34
35
 
@@ -0,0 +1,596 @@
1
+ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4
+ <head>
5
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
6
+ <title>
7
+ Class: Generator
8
+
9
+ &mdash; Documentation by YARD 0.8.7.4
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
14
+
15
+ <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
16
+
17
+ <link rel="stylesheet" href="css/cucumber.css" type="text/css" charset="utf-8" />
18
+
19
+ <script type="text/javascript" charset="utf-8">
20
+ hasFrames = window.top.frames.main ? true : false;
21
+ relpath = '';
22
+ framesUrl = "frames.html#!Generator.html";
23
+ </script>
24
+
25
+
26
+ <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
27
+
28
+ <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
29
+
30
+ <script type="text/javascript" charset="utf-8" src="js/cucumber.js"></script>
31
+
32
+
33
+ </head>
34
+ <body>
35
+ <div id="header">
36
+ <div id="menu">
37
+
38
+ <a href="_index.html">Index (G)</a> &raquo;
39
+
40
+
41
+ <span class="title">Generator</span>
42
+
43
+
44
+ <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
45
+ </div>
46
+
47
+ <div id="search">
48
+
49
+ <a class="full_list_link" id="feature_list_link"
50
+ href="feature_list.html">
51
+ Features
52
+ </a>
53
+
54
+ <a class="full_list_link" id="tag_list_link"
55
+ href="tag_list.html">
56
+ Tags
57
+ </a>
58
+
59
+ <a class="full_list_link" id="class_list_link"
60
+ href="class_list.html">
61
+ Class List
62
+ </a>
63
+
64
+ <a class="full_list_link" id="method_list_link"
65
+ href="method_list.html">
66
+ Method List
67
+ </a>
68
+
69
+ <a class="full_list_link" id="file_list_link"
70
+ href="file_list.html">
71
+ File List
72
+ </a>
73
+
74
+ </div>
75
+ <div class="clear"></div>
76
+ </div>
77
+
78
+ <iframe id="search_frame"></iframe>
79
+
80
+ <div id="content"><h1>Class: Generator
81
+
82
+
83
+
84
+ </h1>
85
+
86
+ <dl class="box">
87
+
88
+ <dt class="r1">Inherits:</dt>
89
+ <dd class="r1">
90
+ <span class="inheritName">Thor</span>
91
+
92
+ <ul class="fullTree">
93
+ <li>Object</li>
94
+
95
+ <li class="next">Thor</li>
96
+
97
+ <li class="next">Generator</li>
98
+
99
+ </ul>
100
+ <a href="#" class="inheritanceTree">show all</a>
101
+
102
+ </dd>
103
+
104
+
105
+
106
+
107
+
108
+
109
+
110
+
111
+
112
+ <dt class="r2 last">Defined in:</dt>
113
+ <dd class="r2 last">lib/nikki.rb</dd>
114
+
115
+ </dl>
116
+ <div class="clear"></div>
117
+
118
+ <h2>Overview</h2><div class="docstring">
119
+ <div class="discussion">
120
+
121
+ <p>This is the main class that interfaces with Thor&#39;s methods and does all
122
+ the heavy lifting for Nikki. It&#39;s a bit of a “God” object. Sorries.</p>
123
+
124
+
125
+ </div>
126
+ </div>
127
+ <div class="tags">
128
+
129
+ <p class="tag_title">Author:</p>
130
+ <ul class="author">
131
+
132
+ <li>
133
+
134
+
135
+
136
+
137
+
138
+ <div class='inline'>
139
+ <p>Brandon Pittman</p>
140
+ </div>
141
+
142
+ </li>
143
+
144
+ </ul>
145
+
146
+ </div>
147
+
148
+
149
+
150
+
151
+
152
+
153
+
154
+ <h2>
155
+ Instance Method Summary
156
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
157
+ </h2>
158
+
159
+ <ul class="summary">
160
+
161
+ <li class="public ">
162
+ <span class="summary_signature">
163
+
164
+ <a href="#config-instance_method" title="#config (instance method)">- (Object) <strong>config</strong> </a>
165
+
166
+
167
+
168
+ </span>
169
+
170
+
171
+
172
+
173
+
174
+
175
+
176
+
177
+
178
+ <span class="summary_desc"><div class='inline'>
179
+ <p>Configure Nikki&#39;s settings.</p>
180
+ </div></span>
181
+
182
+ </li>
183
+
184
+
185
+ <li class="public ">
186
+ <span class="summary_signature">
187
+
188
+ <a href="#new-instance_method" title="#new (instance method)">- (Object) <strong>new</strong>(*args) </a>
189
+
190
+
191
+
192
+ </span>
193
+
194
+
195
+
196
+
197
+
198
+
199
+
200
+
201
+
202
+ <span class="summary_desc"><div class='inline'>
203
+ <p>Add entry to journal Will open your configured text editor on OS X if you
204
+ didn&#39;t update the journal the previous day.</p>
205
+ </div></span>
206
+
207
+ </li>
208
+
209
+
210
+ <li class="public ">
211
+ <span class="summary_signature">
212
+
213
+ <a href="#open-instance_method" title="#open (instance method)">- (Object) <strong>open</strong> </a>
214
+
215
+
216
+
217
+ </span>
218
+
219
+
220
+
221
+
222
+
223
+
224
+
225
+
226
+
227
+ <span class="summary_desc"><div class='inline'>
228
+ <p>Open Nikki journal in configured text editor.</p>
229
+ </div></span>
230
+
231
+ </li>
232
+
233
+
234
+ <li class="public ">
235
+ <span class="summary_signature">
236
+
237
+ <a href="#setup-instance_method" title="#setup (instance method)">- (Object) <strong>setup</strong> </a>
238
+
239
+
240
+
241
+ </span>
242
+
243
+
244
+
245
+
246
+
247
+
248
+
249
+
250
+
251
+ <span class="summary_desc"><div class='inline'>
252
+ <p>This methods creates the “.nikki” directory, config file and journal file.</p>
253
+ </div></span>
254
+
255
+ </li>
256
+
257
+
258
+ </ul>
259
+
260
+
261
+
262
+
263
+
264
+ <div id="instance_method_details" class="method_details_list">
265
+ <h2>Instance Method Details</h2>
266
+
267
+
268
+ <div class="method_details first">
269
+ <h3 class="signature first" id="config-instance_method">
270
+
271
+ - (<tt>Object</tt>) <strong>config</strong>
272
+
273
+
274
+
275
+
276
+
277
+ </h3><div class="docstring">
278
+ <div class="discussion">
279
+
280
+ <p>Configure Nikki&#39;s settings</p>
281
+
282
+
283
+ </div>
284
+ </div>
285
+ <div class="tags">
286
+ <p class="tag_title">Parameters:</p>
287
+ <ul class="param">
288
+
289
+ <li>
290
+
291
+ <span class='name'>--editor</span>
292
+
293
+
294
+ <span class='type'>(<tt>String</tt>)</span>
295
+
296
+
297
+
298
+ &mdash;
299
+ <div class='inline'>
300
+ <p>(<a href=":editor">read_config</a>) Sets Nikki&#39;s editor to open journal
301
+ file</p>
302
+ </div>
303
+
304
+ </li>
305
+
306
+ <li>
307
+
308
+ <span class='name'>--yesterday</span>
309
+
310
+
311
+ <span class='type'></span>
312
+
313
+
314
+
315
+ &mdash;
316
+ <div class='inline'>
317
+ <p>Set `<a href=":updated">settings</a>` to yesterday</p>
318
+ </div>
319
+
320
+ </li>
321
+
322
+ <li>
323
+
324
+ <span class='name'>--today</span>
325
+
326
+
327
+ <span class='type'></span>
328
+
329
+
330
+
331
+ &mdash;
332
+ <div class='inline'>
333
+ <p>Set `<a href=":updated">settings</a>` to today</p>
334
+ </div>
335
+
336
+ </li>
337
+
338
+ <li>
339
+
340
+ <span class='name'>--print</span>
341
+
342
+
343
+ <span class='type'></span>
344
+
345
+
346
+
347
+ &mdash;
348
+ <div class='inline'>
349
+ <p>Prints Nikki&#39;s configuration settings to STDOUT</p>
350
+ </div>
351
+
352
+ </li>
353
+
354
+ <li>
355
+
356
+ <span class='name'>--latest</span>
357
+
358
+
359
+ <span class='type'></span>
360
+
361
+
362
+
363
+ &mdash;
364
+ <div class='inline'>
365
+ <p>Prints Nikki&#39;s latest entries to STDOUT</p>
366
+ </div>
367
+
368
+ </li>
369
+
370
+ </ul>
371
+
372
+
373
+ </div><table class="source_code">
374
+ <tr>
375
+ <td>
376
+ <pre class="lines">
377
+
378
+
379
+ 64
380
+ 65
381
+ 66
382
+ 67
383
+ 68
384
+ 69
385
+ 70
386
+ 71
387
+ 72</pre>
388
+ </td>
389
+ <td>
390
+ <pre class="code"><span class="info file"># File 'lib/nikki.rb', line 64</span>
391
+
392
+ <span class='kw'>def</span> <span class='id identifier rubyid_config'>config</span>
393
+ <span class='id identifier rubyid_settings'>settings</span> <span class='op'>=</span> <span class='id identifier rubyid_read_config'>read_config</span>
394
+ <span class='id identifier rubyid_settings'>settings</span><span class='lbracket'>[</span><span class='symbol'>:editor</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:editor</span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='id identifier rubyid_read_config'>read_config</span><span class='lbracket'>[</span><span class='symbol'>:editor</span><span class='rbracket'>]</span>
395
+ <span class='id identifier rubyid_settings'>settings</span><span class='lbracket'>[</span><span class='symbol'>:updated</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='const'>Date</span><span class='period'>.</span><span class='id identifier rubyid_today'>today</span><span class='op'>-</span><span class='int'>1</span> <span class='kw'>if</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:yesterday</span><span class='rbracket'>]</span>
396
+ <span class='id identifier rubyid_settings'>settings</span><span class='lbracket'>[</span><span class='symbol'>:updated</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='const'>Date</span><span class='period'>.</span><span class='id identifier rubyid_today'>today</span> <span class='kw'>if</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:today</span><span class='rbracket'>]</span>
397
+ <span class='id identifier rubyid_write_config'>write_config</span><span class='lparen'>(</span><span class='id identifier rubyid_settings'>settings</span><span class='rparen'>)</span>
398
+ <span class='id identifier rubyid_puts'>puts</span> <span class='id identifier rubyid_settings'>settings</span><span class='period'>.</span><span class='id identifier rubyid_to_yaml'>to_yaml</span> <span class='kw'>if</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:print</span><span class='rbracket'>]</span>
399
+ <span class='id identifier rubyid_puts'>puts</span> <span class='id identifier rubyid_latest'>latest</span> <span class='kw'>if</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:latest</span><span class='rbracket'>]</span>
400
+ <span class='kw'>end</span></pre>
401
+ </td>
402
+ </tr>
403
+ </table>
404
+ </div>
405
+
406
+ <div class="method_details ">
407
+ <h3 class="signature " id="new-instance_method">
408
+
409
+ - (<tt>Object</tt>) <strong>new</strong>(*args)
410
+
411
+
412
+
413
+
414
+
415
+ </h3><div class="docstring">
416
+ <div class="discussion">
417
+
418
+ <p>Add entry to journal Will open your configured text editor on OS X if you
419
+ didn&#39;t update the journal the previous day. This will allow you to add
420
+ missing entries in bulk. It reads the settings in from the config YAML file
421
+ and changes the date updated. It does the same with the journal file,
422
+ reading in the YAML and merging the hash of entries, and then saves the
423
+ YAML back again. There&#39;s also a method to check off a corresponding
424
+ task in OmniFocus at the end.</p>
425
+
426
+
427
+ </div>
428
+ </div>
429
+ <div class="tags">
430
+ <p class="tag_title">Parameters:</p>
431
+ <ul class="param">
432
+
433
+ <li>
434
+
435
+ <span class='name'>entry</span>
436
+
437
+
438
+ <span class='type'>(<tt>String</tt>)</span>
439
+
440
+
441
+
442
+ &mdash;
443
+ <div class='inline'>
444
+ <p>entry to add to the journal</p>
445
+ </div>
446
+
447
+ </li>
448
+
449
+ </ul>
450
+
451
+
452
+ </div><table class="source_code">
453
+ <tr>
454
+ <td>
455
+ <pre class="lines">
456
+
457
+
458
+ 28
459
+ 29
460
+ 30
461
+ 31
462
+ 32
463
+ 33
464
+ 34
465
+ 35
466
+ 36
467
+ 37
468
+ 38
469
+ 39</pre>
470
+ </td>
471
+ <td>
472
+ <pre class="code"><span class="info file"># File 'lib/nikki.rb', line 28</span>
473
+
474
+ <span class='kw'>def</span> <span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_args'>args</span><span class='rparen'>)</span>
475
+ <span class='id identifier rubyid_settings'>settings</span> <span class='op'>=</span> <span class='id identifier rubyid_read_config'>read_config</span>
476
+ <span class='id identifier rubyid_settings'>settings</span><span class='lbracket'>[</span><span class='symbol'>:updated</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_today'>today</span>
477
+ <span class='id identifier rubyid_entry'>entry</span> <span class='op'>=</span> <span class='id identifier rubyid_args'>args</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'> </span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
478
+ <span class='id identifier rubyid_entry_hash'>entry_hash</span> <span class='op'>=</span> <span class='lbrace'>{</span> <span class='id identifier rubyid_today'>today</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_entry'>entry</span> <span class='rbrace'>}</span>
479
+ <span class='id identifier rubyid_journal'>journal</span> <span class='op'>=</span> <span class='id identifier rubyid_read_file'>read_file</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='id identifier rubyid_entry_hash'>entry_hash</span><span class='rparen'>)</span>
480
+ <span class='id identifier rubyid_write_file'>write_file</span><span class='lparen'>(</span><span class='id identifier rubyid_journal'>journal</span><span class='rparen'>)</span>
481
+ <span class='id identifier rubyid_open'>open</span> <span class='kw'>unless</span> <span class='id identifier rubyid_updated_yesterday?'>updated_yesterday?</span>
482
+ <span class='id identifier rubyid_write_config'>write_config</span><span class='lparen'>(</span><span class='id identifier rubyid_settings'>settings</span><span class='rparen'>)</span>
483
+ <span class='id identifier rubyid_add_to_omnifocus'>add_to_omnifocus</span>
484
+ <span class='id identifier rubyid_puts'>puts</span> <span class='id identifier rubyid_latest'>latest</span>
485
+ <span class='kw'>end</span></pre>
486
+ </td>
487
+ </tr>
488
+ </table>
489
+ </div>
490
+
491
+ <div class="method_details ">
492
+ <h3 class="signature " id="open-instance_method">
493
+
494
+ - (<tt>Object</tt>) <strong>open</strong>
495
+
496
+
497
+
498
+
499
+
500
+ </h3><div class="docstring">
501
+ <div class="discussion">
502
+
503
+ <p>Open Nikki journal in configured text editor</p>
504
+
505
+
506
+ </div>
507
+ </div>
508
+ <div class="tags">
509
+
510
+
511
+ </div><table class="source_code">
512
+ <tr>
513
+ <td>
514
+ <pre class="lines">
515
+
516
+
517
+ 44
518
+ 45
519
+ 46
520
+ 47
521
+ 48
522
+ 49
523
+ 50</pre>
524
+ </td>
525
+ <td>
526
+ <pre class="code"><span class="info file"># File 'lib/nikki.rb', line 44</span>
527
+
528
+ <span class='kw'>def</span> <span class='id identifier rubyid_open'>open</span>
529
+ <span class='kw'>if</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:marked</span><span class='rbracket'>]</span>
530
+ <span class='backtick'>%x{</span><span class='tstring_content'>open -a Marked </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_file'>file</span><span class='embexpr_end'>}</span><span class='tstring_end'>}</span></span>
531
+ <span class='kw'>else</span>
532
+ <span class='backtick'>%x{</span><span class='tstring_content'>open -a &quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_editor'>editor</span><span class='embexpr_end'>}</span><span class='tstring_content'>&quot; </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_file'>file</span><span class='embexpr_end'>}</span><span class='tstring_end'>}</span></span>
533
+ <span class='kw'>end</span>
534
+ <span class='kw'>end</span></pre>
535
+ </td>
536
+ </tr>
537
+ </table>
538
+ </div>
539
+
540
+ <div class="method_details ">
541
+ <h3 class="signature " id="setup-instance_method">
542
+
543
+ - (<tt>Object</tt>) <strong>setup</strong>
544
+
545
+
546
+
547
+
548
+
549
+ </h3><div class="docstring">
550
+ <div class="discussion">
551
+
552
+ <p>This methods creates the “.nikki” directory, config file and journal file.</p>
553
+
554
+
555
+ </div>
556
+ </div>
557
+ <div class="tags">
558
+
559
+
560
+ </div><table class="source_code">
561
+ <tr>
562
+ <td>
563
+ <pre class="lines">
564
+
565
+
566
+ 14
567
+ 15
568
+ 16
569
+ 17
570
+ 18</pre>
571
+ </td>
572
+ <td>
573
+ <pre class="code"><span class="info file"># File 'lib/nikki.rb', line 14</span>
574
+
575
+ <span class='kw'>def</span> <span class='id identifier rubyid_setup'>setup</span>
576
+ <span class='id identifier rubyid_create_path'>create_path</span>
577
+ <span class='id identifier rubyid_create_file'>create_file</span>
578
+ <span class='id identifier rubyid_create_config_file'>create_config_file</span>
579
+ <span class='kw'>end</span></pre>
580
+ </td>
581
+ </tr>
582
+ </table>
583
+ </div>
584
+
585
+ </div>
586
+
587
+ </div>
588
+
589
+ <div id="footer">
590
+ Generated on Fri May 30 09:21:12 2014 by
591
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
592
+ 0.8.7.4 (ruby-2.1.2).
593
+ </div>
594
+
595
+ </body>
596
+ </html>