nikki 0.5.3 → 0.5.4

Sign up to get free protection for your applications and to get access to all the features.
Files changed (28) hide show
  1. checksums.yaml +4 -4
  2. data/.gitignore +1 -0
  3. data/lib/nikki/version.rb +1 -1
  4. data/lib/nikki.rb +55 -59
  5. metadata +3 -26
  6. data/doc/Generator.html +0 -829
  7. data/doc/Nikki.html +0 -153
  8. data/doc/_index.html +0 -137
  9. data/doc/class_list.html +0 -62
  10. data/doc/css/common.css +0 -1
  11. data/doc/css/cucumber.css +0 -227
  12. data/doc/css/full_list.css +0 -57
  13. data/doc/css/style.css +0 -339
  14. data/doc/feature_list.html +0 -65
  15. data/doc/file.README.html +0 -149
  16. data/doc/file_list.html +0 -64
  17. data/doc/frames.html +0 -26
  18. data/doc/index.html +0 -149
  19. data/doc/js/app.js +0 -219
  20. data/doc/js/cucumber.js +0 -305
  21. data/doc/js/full_list.js +0 -178
  22. data/doc/js/jquery.js +0 -4
  23. data/doc/method_list.html +0 -103
  24. data/doc/requirements/step_transformers.html +0 -140
  25. data/doc/requirements/tags.html +0 -193
  26. data/doc/requirements.html +0 -132
  27. data/doc/tag_list.html +0 -65
  28. data/doc/top-level-namespace.html +0 -128
data/doc/file_list.html DELETED
@@ -1,64 +0,0 @@
1
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
- <html>
4
- <head>
5
- <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
6
-
7
- <link rel="stylesheet" href="css/full_list.css" type="text/css" media="screen" charset="utf-8" />
8
-
9
- <link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />
10
-
11
-
12
-
13
- <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
14
-
15
- <script type="text/javascript" charset="utf-8" src="js/full_list.js"></script>
16
-
17
-
18
- <title>File List</title>
19
- <base id="base_target" target="_parent" />
20
- </head>
21
- <body>
22
- <script type="text/javascript" charset="utf-8">
23
- if (window.top.frames.main) {
24
- document.getElementById('base_target').target = 'main';
25
- document.body.className = 'frames';
26
- }
27
- </script>
28
- <div id="content">
29
- <h1 id="full_list_header">File List</h1>
30
- <div id="nav">
31
-
32
- <span><a target="_self" href="feature_list.html">
33
- Features
34
- </a></span>
35
-
36
- <span><a target="_self" href="tag_list.html">
37
- Tags
38
- </a></span>
39
-
40
- <span><a target="_self" href="class_list.html">
41
- Classes
42
- </a></span>
43
-
44
- <span><a target="_self" href="method_list.html">
45
- Methods
46
- </a></span>
47
-
48
- <span><a target="_self" href="file_list.html">
49
- Files
50
- </a></span>
51
-
52
- </div>
53
- <div id="search">Search: <input type="text" /></div>
54
-
55
- <ul id="full_list" class="class">
56
-
57
-
58
- <li class="r1"><span class="object_link"><a href="index.html" title="README">README</a></a></li>
59
-
60
-
61
- </ul>
62
- </div>
63
- </body>
64
- </html>
data/doc/frames.html DELETED
@@ -1,26 +0,0 @@
1
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Frameset//EN"
2
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd">
3
-
4
- <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
5
- <head>
6
- <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
7
- <title>Documentation by YARD 0.8.7.4</title>
8
- </head>
9
- <script type="text/javascript" charset="utf-8">
10
- window.onload = function() {
11
- var match = unescape(window.location.hash).match(/^#!(.+)/);
12
- var name = match ? match[1] : 'index.html';
13
- name = name.replace(/^(\w+):\/\//, '').replace(/^\/\//, '');
14
- document.writeln('<frameset cols="20%,*">' +
15
- '<frame name="list" src="class_list.html" />' +
16
- '<frame name="main" src="' + escape(name) + '" />' +
17
- '</frameset>');
18
- }
19
- </script>
20
- <noscript>
21
- <frameset cols="20%,*">
22
- <frame name="list" src="class_list.html" />
23
- <frame name="main" src="index.html" />
24
- </frameset>
25
- </noscript>
26
- </html>
data/doc/index.html DELETED
@@ -1,149 +0,0 @@
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
- File: README
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#!file.README.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</a> &raquo;
39
- <span class="title">File: README</span>
40
-
41
-
42
- <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
43
- </div>
44
-
45
- <div id="search">
46
-
47
- <a class="full_list_link" id="feature_list_link"
48
- href="feature_list.html">
49
- Features
50
- </a>
51
-
52
- <a class="full_list_link" id="tag_list_link"
53
- href="tag_list.html">
54
- Tags
55
- </a>
56
-
57
- <a class="full_list_link" id="class_list_link"
58
- href="class_list.html">
59
- Class List
60
- </a>
61
-
62
- <a class="full_list_link" id="method_list_link"
63
- href="method_list.html">
64
- Method List
65
- </a>
66
-
67
- <a class="full_list_link" id="file_list_link"
68
- href="file_list.html">
69
- File List
70
- </a>
71
-
72
- </div>
73
- <div class="clear"></div>
74
- </div>
75
-
76
- <iframe id="search_frame"></iframe>
77
-
78
- <div id="content"><div id='filecontents'><p><a href="http://badge.fury.io/rb/nikki"><img src="https://badge.fury.io/rb/nikki.png" alt="Gem Version"></a>
79
- <a href="http://inch-ci.org/github/brandonpittman/nikki"><img src="http://inch-ci.org/github/brandonpittman/nikki.png" alt="Inline docs"></a></p>
80
-
81
- <h1>nikki</h1>
82
-
83
- <blockquote>
84
- <p>&quot;Record something new learned every day of the year.&quot;</p>
85
- </blockquote>
86
-
87
- <h3>Track newly learned things</h3>
88
-
89
- <p>In Japanese, &quot;nikki&quot; means &quot;daily journal&quot;. The idea behind <em>nikki</em> is to record one thing you learned today. If all goes well, you&#39;ve got a 365 line journal formatted in Markdown and ready to be posted to your blog on January 1st next year. The months are H1&#39;s and every day in the month is part of an ordered list. The journal file is saved at <code>~/.nikki_#{year}.md</code>.</p>
90
-
91
- <h2>Installation</h2>
92
-
93
- <p>Add this line to your application&#39;s Gemfile:</p>
94
-
95
- <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_gem'>gem</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>nikki</span><span class='tstring_end'>&#39;</span></span>
96
- </code></pre>
97
-
98
- <p>And then execute:</p>
99
-
100
- <pre class="code ruby"><code class="ruby">$ bundle
101
- </code></pre>
102
-
103
- <p>Or install it yourself as:</p>
104
-
105
- <pre class="code ruby"><code class="ruby">$ gem install nikki
106
- </code></pre>
107
-
108
- <h2>Usage</h2>
109
-
110
- <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_nikki'>nikki</span> <span class='id identifier rubyid_config'>config</span> <span class='comment'># Change Nikki&#39;s settings.
111
- </span><span class='id identifier rubyid_nikki'>nikki</span> <span class='id identifier rubyid_help'>help</span> <span class='lbracket'>[</span><span class='const'>COMMAND</span><span class='rbracket'>]</span> <span class='comment'># Describe available commands or one specific command
112
- </span><span class='id identifier rubyid_nikki'>nikki</span> <span class='id identifier rubyid_new'>new</span> <span class='const'>ENTRY</span> <span class='comment'># Creates a new entry in the Nikki journal.
113
- </span><span class='id identifier rubyid_nikki'>nikki</span> <span class='id identifier rubyid_open'>open</span> <span class='comment'># Open current year&#39;s journal file in editor.
114
- </span><span class='id identifier rubyid_nikki'>nikki</span> <span class='id identifier rubyid_publish'>publish</span> <span class='const'>YEAR</span> <span class='comment'># Save a MultiMarkdown-formatted version of a Nikki journal.
115
- </span><span class='id identifier rubyid_nikki'>nikki</span> <span class='id identifier rubyid_setup'>setup</span> <span class='comment'># Creates new Nikki and config files.
116
- </span></code></pre>
117
-
118
- <h2>Examples</h2>
119
-
120
- <h3>New entry</h3>
121
-
122
- <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_nikki'>nikki</span> <span class='id identifier rubyid_new'>new</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Brandon Pittman is a super cool guy.</span><span class='tstring_end'>&quot;</span></span>
123
- </code></pre>
124
-
125
- <h3>Configure Nikki</h3>
126
-
127
- <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_nikki'>nikki</span> <span class='id identifier rubyid_config'>config</span> <span class='op'>-</span><span class='op'>-</span><span class='id identifier rubyid_yesterday'>yesterday</span> <span class='comment'># Reset last updated `datetime`
128
- </span><span class='id identifier rubyid_nikki'>nikki</span> <span class='id identifier rubyid_config'>config</span> <span class='op'>-</span><span class='op'>-</span><span class='id identifier rubyid_list'>list</span> <span class='comment'># Prints latest entries
129
- </span></code></pre>
130
-
131
- <h2>Contributing</h2>
132
-
133
- <ol>
134
- <li>Fork it ( <a href="http://github.com/">http://github.com/</a><my-github-username>/nikki/fork )</li>
135
- <li>Create your feature branch (<code>git checkout -b my-new-feature</code>)</li>
136
- <li>Commit your changes (<code>git commit -am &#39;Add some feature&#39;</code>)</li>
137
- <li>Push to the branch (<code>git push origin my-new-feature</code>)</li>
138
- <li>Create new Pull Request</li>
139
- </ol>
140
- </div></div>
141
-
142
- <div id="footer">
143
- Generated on Tue Sep 30 15:46:41 2014 by
144
- <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
145
- 0.8.7.4 (ruby-2.1.2).
146
- </div>
147
-
148
- </body>
149
- </html>
data/doc/js/app.js DELETED
@@ -1,219 +0,0 @@
1
- function createSourceLinks() {
2
- $('.method_details_list .source_code').
3
- before("<span class='showSource'>[<a href='#' class='toggleSource'>View source</a>]</span>");
4
- $('.toggleSource').toggle(function() {
5
- $(this).parent().nextAll('.source_code').slideDown(100);
6
- $(this).text("Hide source");
7
- },
8
- function() {
9
- $(this).parent().nextAll('.source_code').slideUp(100);
10
- $(this).text("View source");
11
- });
12
- }
13
-
14
- function createDefineLinks() {
15
- var tHeight = 0;
16
- $('.defines').after(" <a href='#' class='toggleDefines'>more...</a>");
17
- $('.toggleDefines').toggle(function() {
18
- tHeight = $(this).parent().prev().height();
19
- $(this).prev().show();
20
- $(this).parent().prev().height($(this).parent().height());
21
- $(this).text("(less)");
22
- },
23
- function() {
24
- $(this).prev().hide();
25
- $(this).parent().prev().height(tHeight);
26
- $(this).text("more...");
27
- });
28
- }
29
-
30
- function createFullTreeLinks() {
31
- var tHeight = 0;
32
- $('.inheritanceTree').toggle(function() {
33
- tHeight = $(this).parent().prev().height();
34
- $(this).parent().toggleClass('showAll');
35
- $(this).text("(hide)");
36
- $(this).parent().prev().height($(this).parent().height());
37
- },
38
- function() {
39
- $(this).parent().toggleClass('showAll');
40
- $(this).parent().prev().height(tHeight);
41
- $(this).text("show all");
42
- });
43
- }
44
-
45
- function fixBoxInfoHeights() {
46
- $('dl.box dd.r1, dl.box dd.r2').each(function() {
47
- $(this).prev().height($(this).height());
48
- });
49
- }
50
-
51
- function searchFrameLinks() {
52
- $('.full_list_link').click(function() {
53
- toggleSearchFrame(this, $(this).attr('href'));
54
- return false;
55
- });
56
- }
57
-
58
- function toggleSearchFrame(id, link) {
59
- var frame = $('#search_frame');
60
- $('#search a').removeClass('active').addClass('inactive');
61
- if (frame.attr('src') == link && frame.css('display') != "none") {
62
- frame.slideUp(100);
63
- $('#search a').removeClass('active inactive');
64
- }
65
- else {
66
- $(id).addClass('active').removeClass('inactive');
67
- frame.attr('src', link).slideDown(100);
68
- }
69
- }
70
-
71
- function linkSummaries() {
72
- $('.summary_signature').click(function() {
73
- document.location = $(this).find('a').attr('href');
74
- });
75
- }
76
-
77
- function framesInit() {
78
- if (hasFrames) {
79
- document.body.className = 'frames';
80
- $('#menu .noframes a').attr('href', document.location);
81
- try {
82
- window.top.document.title = $('html head title').text();
83
- } catch(error) {
84
- // some browsers will not allow this when serving from file://
85
- // but we don't want to stop the world.
86
- }
87
- }
88
- else {
89
- $('#menu .noframes a').text('frames').attr('href', framesUrl);
90
- }
91
- }
92
-
93
- function keyboardShortcuts() {
94
- if (window.top.frames.main) return;
95
- $(document).keypress(function(evt) {
96
- if (evt.altKey || evt.ctrlKey || evt.metaKey || evt.shiftKey) return;
97
- if (typeof evt.target !== "undefined" &&
98
- (evt.target.nodeName == "INPUT" ||
99
- evt.target.nodeName == "TEXTAREA")) return;
100
- switch (evt.charCode) {
101
- case 67: case 99: $('#class_list_link').click(); break; // 'c'
102
- case 77: case 109: $('#method_list_link').click(); break; // 'm'
103
- case 70: case 102: $('#file_list_link').click(); break; // 'f'
104
- default: break;
105
- }
106
- });
107
- }
108
-
109
- function summaryToggle() {
110
- $('.summary_toggle').click(function() {
111
- if (localStorage) {
112
- localStorage.summaryCollapsed = $(this).text();
113
- }
114
- $('.summary_toggle').each(function() {
115
- $(this).text($(this).text() == "collapse" ? "expand" : "collapse");
116
- var next = $(this).parent().parent().nextAll('ul.summary').first();
117
- if (next.hasClass('compact')) {
118
- next.toggle();
119
- next.nextAll('ul.summary').first().toggle();
120
- }
121
- else if (next.hasClass('summary')) {
122
- var list = $('<ul class="summary compact" />');
123
- list.html(next.html());
124
- list.find('.summary_desc, .note').remove();
125
- list.find('a').each(function() {
126
- $(this).html($(this).find('strong').html());
127
- $(this).parent().html($(this)[0].outerHTML);
128
- });
129
- next.before(list);
130
- next.toggle();
131
- }
132
- });
133
- return false;
134
- });
135
- if (localStorage) {
136
- if (localStorage.summaryCollapsed == "collapse") {
137
- $('.summary_toggle').first().click();
138
- }
139
- else localStorage.summaryCollapsed = "expand";
140
- }
141
- }
142
-
143
- function fixOutsideWorldLinks() {
144
- $('a').each(function() {
145
- if (window.location.host != this.host) this.target = '_parent';
146
- });
147
- }
148
-
149
- function generateTOC() {
150
- if ($('#filecontents').length === 0) return;
151
- var _toc = $('<ol class="top"></ol>');
152
- var show = false;
153
- var toc = _toc;
154
- var counter = 0;
155
- var tags = ['h2', 'h3', 'h4', 'h5', 'h6'];
156
- var i;
157
- if ($('#filecontents h1').length > 1) tags.unshift('h1');
158
- for (i = 0; i < tags.length; i++) { tags[i] = '#filecontents ' + tags[i]; }
159
- var lastTag = parseInt(tags[0][1], 10);
160
- $(tags.join(', ')).each(function() {
161
- if ($(this).parents('.method_details .docstring').length != 0) return;
162
- if (this.id == "filecontents") return;
163
- show = true;
164
- var thisTag = parseInt(this.tagName[1], 10);
165
- if (this.id.length === 0) {
166
- var proposedId = $(this).attr('toc-id');
167
- if (typeof(proposedId) != "undefined") this.id = proposedId;
168
- else {
169
- var proposedId = $(this).text().replace(/[^a-z0-9-]/ig, '_');
170
- if ($('#' + proposedId).length > 0) { proposedId += counter; counter++; }
171
- this.id = proposedId;
172
- }
173
- }
174
- if (thisTag > lastTag) {
175
- for (i = 0; i < thisTag - lastTag; i++) {
176
- var tmp = $('<ol/>'); toc.append(tmp); toc = tmp;
177
- }
178
- }
179
- if (thisTag < lastTag) {
180
- for (i = 0; i < lastTag - thisTag; i++) toc = toc.parent();
181
- }
182
- var title = $(this).attr('toc-title');
183
- if (typeof(title) == "undefined") title = $(this).text();
184
- toc.append('<li><a href="#' + this.id + '">' + title + '</a></li>');
185
- lastTag = thisTag;
186
- });
187
- if (!show) return;
188
- html = '<div id="toc"><p class="title"><a class="hide_toc" href="#"><strong>Table of Contents</strong></a> <small>(<a href="#" class="float_toc">left</a>)</small></p></div>';
189
- $('#content').prepend(html);
190
- $('#toc').append(_toc);
191
- $('#toc .hide_toc').toggle(function() {
192
- $('#toc .top').slideUp('fast');
193
- $('#toc').toggleClass('hidden');
194
- $('#toc .title small').toggle();
195
- }, function() {
196
- $('#toc .top').slideDown('fast');
197
- $('#toc').toggleClass('hidden');
198
- $('#toc .title small').toggle();
199
- });
200
- $('#toc .float_toc').toggle(function() {
201
- $(this).text('float');
202
- $('#toc').toggleClass('nofloat');
203
- }, function() {
204
- $(this).text('left');
205
- $('#toc').toggleClass('nofloat');
206
- });
207
- }
208
-
209
- $(framesInit);
210
- $(createSourceLinks);
211
- $(createDefineLinks);
212
- $(createFullTreeLinks);
213
- $(fixBoxInfoHeights);
214
- $(searchFrameLinks);
215
- $(linkSummaries);
216
- $(keyboardShortcuts);
217
- $(summaryToggle);
218
- $(fixOutsideWorldLinks);
219
- $(generateTOC);