RubyGems - nikki - Versions diffs - 0.5.3 → 0.5.4 - Mend

nikki 0.5.3 → 0.5.4

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 (28) hide show

checksums.yaml +4 -4
data/.gitignore +1 -0
data/lib/nikki/version.rb +1 -1
data/lib/nikki.rb +55 -59
metadata +3 -26
data/doc/Generator.html +0 -829
data/doc/Nikki.html +0 -153
data/doc/_index.html +0 -137
data/doc/class_list.html +0 -62
data/doc/css/common.css +0 -1
data/doc/css/cucumber.css +0 -227
data/doc/css/full_list.css +0 -57
data/doc/css/style.css +0 -339
data/doc/feature_list.html +0 -65
data/doc/file.README.html +0 -149
data/doc/file_list.html +0 -64
data/doc/frames.html +0 -26
data/doc/index.html +0 -149
data/doc/js/app.js +0 -219
data/doc/js/cucumber.js +0 -305
data/doc/js/full_list.js +0 -178
data/doc/js/jquery.js +0 -4
data/doc/method_list.html +0 -103
data/doc/requirements/step_transformers.html +0 -140
data/doc/requirements/tags.html +0 -193
data/doc/requirements.html +0 -132
data/doc/tag_list.html +0 -65
data/doc/top-level-namespace.html +0 -128

data/doc/Generator.html DELETED Viewed

@@ -1,829 +0,0 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
-  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-  <head>
-    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-<title>
-  Class: Generator
-    &mdash; Documentation by YARD 0.8.7.4
-</title>
-  <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
-  <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
-  <link rel="stylesheet" href="css/cucumber.css" type="text/css" charset="utf-8" />
-<script type="text/javascript" charset="utf-8">
-  hasFrames = window.top.frames.main ? true : false;
-  relpath = '';
-  framesUrl = "frames.html#!Generator.html";
-</script>
-  <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
-  <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
-  <script type="text/javascript" charset="utf-8" src="js/cucumber.js"></script>
-  </head>
-  <body>
-    <div id="header">
-      <div id="menu">
-    <a href="_index.html">Index (G)</a> &raquo;
-    <span class="title">Generator</span>
-  <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
-</div>
-      <div id="search">
-    <a class="full_list_link" id="feature_list_link"
-        href="feature_list.html">
-      Features
-    </a>
-    <a class="full_list_link" id="tag_list_link"
-        href="tag_list.html">
-      Tags
-    </a>
-    <a class="full_list_link" id="class_list_link"
-        href="class_list.html">
-      Class List
-    </a>
-    <a class="full_list_link" id="method_list_link"
-        href="method_list.html">
-      Method List
-    </a>
-    <a class="full_list_link" id="file_list_link"
-        href="file_list.html">
-      File List
-    </a>
-</div>
-      <div class="clear"></div>
-    </div>
-    <iframe id="search_frame"></iframe>
-    <div id="content"><h1>Class: Generator
-</h1>
-<dl class="box">
-    <dt class="r1">Inherits:</dt>
-    <dd class="r1">
-      <span class="inheritName">Thor</span>
-        <ul class="fullTree">
-          <li>Object</li>
-            <li class="next">Thor</li>
-            <li class="next">Generator</li>
-        </ul>
-        <a href="#" class="inheritanceTree">show all</a>
-      </dd>
-    <dt class="r2 last">Defined in:</dt>
-    <dd class="r2 last">lib/nikki.rb</dd>
-</dl>
-<div class="clear"></div>
-<h2>Overview</h2><div class="docstring">
-  <div class="discussion">
-<p>This is the main class that interfaces with Thor&#39;s methods and does all
-the heavy lifting for Nikki.  It&#39;s a bit of a “God” object. Sorries.</p>
-  </div>
-</div>
-<div class="tags">
-<p class="tag_title">Author:</p>
-<ul class="author">
-    <li>
-        <div class='inline'>
-<p>Brandon Pittman</p>
-</div>
-    </li>
-</ul>
-</div>
-    <h2>
-      Instance Method Summary
-      <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
-    </h2>
-    <ul class="summary">
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#config-instance_method" title="#config (instance method)">- (Object) <strong>config</strong> </a>
-  </span>
-    <span class="summary_desc"><div class='inline'>
-<p>Configure Nikki&#39;s settings.</p>
-</div></span>
-</li>
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#ls-instance_method" title="#ls (instance method)">- (String) <strong>ls</strong> </a>
-  </span>
-    <span class="summary_desc"><div class='inline'>
-<p>Display Nikki&#39;s latest entires.</p>
-</div></span>
-</li>
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#missed-instance_method" title="#missed (instance method)">- (Object) <strong>missed</strong>(entry) </a>
-  </span>
-    <span class="summary_desc"><div class='inline'>
-<p>Creates a new entry for yesterday.</p>
-</div></span>
-</li>
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#new-instance_method" title="#new (instance method)">- (Hash) <strong>new</strong>(entry, update = nil) </a>
-  </span>
-    <span class="summary_desc"><div class='inline'>
-<p>Add entry to journal Will open your configured text editor on OS X if you
-didn&#39;t update the journal the previous day.</p>
-</div></span>
-</li>
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#open-instance_method" title="#open (instance method)">- (Object) <strong>open</strong> </a>
-  </span>
-    <span class="summary_desc"><div class='inline'>
-<p>Open Nikki journal in configured text editor.</p>
-</div></span>
-</li>
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#publish-instance_method" title="#publish (instance method)">- (Object) <strong>publish</strong>(year) </a>
-  </span>
-    <span class="summary_desc"><div class='inline'>
-<p>method calls the `markdown` method and creates a MultiMarkdown document
-with one big description list.</p>
-</div></span>
-</li>
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#setup-instance_method" title="#setup (instance method)">- (Object) <strong>setup</strong> </a>
-  </span>
-    <span class="summary_desc"><div class='inline'>
-<p>This methods creates the “.nikki” directory, config file and journal file.</p>
-</div></span>
-</li>
-    </ul>
-  <div id="instance_method_details" class="method_details_list">
-    <h2>Instance Method Details</h2>
-      <div class="method_details first">
-  <h3 class="signature first" id="config-instance_method">
-    - (<tt>Object</tt>) <strong>config</strong>
-</h3><div class="docstring">
-  <div class="discussion">
-<p>Configure Nikki&#39;s settings</p>
-  </div>
-</div>
-<div class="tags">
-  <p class="tag_title">Parameters:</p>
-<ul class="param">
-    <li>
-        <span class='name'>options</span>
-        <span class='type'>(<tt>Hash</tt>)</span>
-        &mdash;
-        <div class='inline'>
-<p>The options for configuring Nikki</p>
-</div>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-85
-86
-87
-88
-89
-90
-91
-92
-93</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/nikki.rb', line 85</span>
-<span class='kw'>def</span> <span class='id identifier rubyid_config'>config</span>
-  <span class='id identifier rubyid_settings'>settings</span> <span class='op'>=</span> <span class='id identifier rubyid_read_config'>read_config</span>
-  <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>
-  <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>
-  <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>
-  <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>
-  <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>
-  <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>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <div class="method_details ">
-  <h3 class="signature " id="ls-instance_method">
-    - (<tt>String</tt>) <strong>ls</strong>
-</h3><div class="docstring">
-  <div class="discussion">
-<p>Display Nikki&#39;s latest entires</p>
-  </div>
-</div>
-<div class="tags">
-<p class="tag_title">Returns:</p>
-<ul class="return">
-    <li>
-        <span class='type'>(<tt>String</tt>)</span>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-68
-69
-70</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/nikki.rb', line 68</span>
-<span class='kw'>def</span> <span class='id identifier rubyid_ls'>ls</span>
-  <span class='id identifier rubyid_puts'>puts</span> <span class='id identifier rubyid_latest'>latest</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <div class="method_details ">
-  <h3 class="signature " id="missed-instance_method">
-    - (<tt>Object</tt>) <strong>missed</strong>(entry)
-</h3><div class="docstring">
-  <div class="discussion">
-<p>Creates a new entry for yesterday</p>
-  </div>
-</div>
-<div class="tags">
-  <p class="tag_title">Parameters:</p>
-<ul class="param">
-    <li>
-        <span class='name'>entry</span>
-        <span class='type'>(<tt>String</tt>)</span>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-55
-56
-57</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/nikki.rb', line 55</span>
-<span class='kw'>def</span> <span class='id identifier rubyid_missed'>missed</span><span class='lparen'>(</span><span class='id identifier rubyid_entry'>entry</span><span class='rparen'>)</span>
-  <span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_entry'>entry</span><span class='comma'>,</span> <span class='lparen'>(</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='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='rparen'>)</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <div class="method_details ">
-  <h3 class="signature " id="new-instance_method">
-    - (<tt>Hash</tt>) <strong>new</strong>(entry, update = nil)
-</h3><div class="docstring">
-  <div class="discussion">
-<p>Add entry to journal Will open your configured text editor on OS X if you
-didn&#39;t update the journal the previous day.  This will allow you to add
-missing entries in bulk.  It reads the settings in from the config YAML
-file and changes the date updated.  It does the same with the journal file,
-reading in the YAML and merging the hash of entries, and then saves the
-YAML back again. There&#39;s also a method to check off a corresponding
-task in OmniFocus at the end.</p>
-  </div>
-</div>
-<div class="tags">
-  <div class="examples">
-    <p class="tag_title">Examples:</p>
-      <pre class="example code"><code><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>nikki new &#39;This is a thing I learned today!&#39;</span><span class='tstring_end'>&quot;</span></span></code></pre>
-  </div>
-<p class="tag_title">Parameters:</p>
-<ul class="param">
-    <li>
-        <span class='name'>entry</span>
-        <span class='type'>(<tt>String</tt>)</span>
-        &mdash;
-        <div class='inline'>
-<p>entry to add to the journal</p>
-</div>
-    </li>
-    <li>
-        <span class='name'>update</span>
-        <span class='type'>(<tt>String</tt>)</span>
-        <em class="default">(defaults to: <tt>nil</tt>)</em>
-        &mdash;
-        <div class='inline'>
-<p>International date for update</p>
-</div>
-    </li>
-</ul>
-<p class="tag_title">Returns:</p>
-<ul class="return">
-    <li>
-        <span class='type'>(<tt>Hash</tt>)</span>
-        &mdash;
-        <div class='inline'>
-<p>Returns a Hash which is then saved in a YAML file.</p>
-</div>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-34
-35
-36
-37
-38
-39
-40
-41
-42
-43
-44
-45
-46
-47
-48
-49
-50</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/nikki.rb', line 34</span>
-<span class='kw'>def</span> <span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_entry'>entry</span><span class='comma'>,</span> <span class='id identifier rubyid_update'>update</span><span class='op'>=</span><span class='kw'>nil</span><span class='rparen'>)</span>
-  <span class='id identifier rubyid_settings'>settings</span> <span class='op'>=</span> <span class='id identifier rubyid_read_config'>read_config</span>
-  <span class='kw'>if</span> <span class='id identifier rubyid_update'>update</span>
-    <span class='id identifier rubyid_date'>date</span> <span class='op'>=</span> <span class='const'>Date</span><span class='period'>.</span><span class='id identifier rubyid_parse'>parse</span><span class='lparen'>(</span><span class='id identifier rubyid_update'>update</span><span class='rparen'>)</span>
-    <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_date'>date</span>
-  <span class='kw'>else</span>
-    <span class='id identifier rubyid_date'>date</span> <span class='op'>=</span> <span class='id identifier rubyid_today'>today</span>
-    <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>
-  <span class='kw'>end</span>
-  <span class='id identifier rubyid_entry_hash'>entry_hash</span> <span class='op'>=</span> <span class='lbrace'>{</span> <span class='id identifier rubyid_date'>date</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_entry'>entry</span> <span class='rbrace'>}</span>
-  <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>
-  <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>
-  <span class='id identifier rubyid_open'>open</span> <span class='kw'>unless</span> <span class='id identifier rubyid_updated_yesterday?'>updated_yesterday?</span>
-  <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>
-  <span class='id identifier rubyid_add_to_omnifocus'>add_to_omnifocus</span>
-  <span class='id identifier rubyid_puts'>puts</span> <span class='id identifier rubyid_latest'>latest</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <div class="method_details ">
-  <h3 class="signature " id="open-instance_method">
-    - (<tt>Object</tt>) <strong>open</strong>
-</h3><div class="docstring">
-  <div class="discussion">
-<p>Open Nikki journal in configured text editor</p>
-  </div>
-</div>
-<div class="tags">
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-61
-62
-63</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/nikki.rb', line 61</span>
-<span class='kw'>def</span> <span class='id identifier rubyid_open'>open</span>
-  <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>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <div class="method_details ">
-  <h3 class="signature " id="publish-instance_method">
-    - (<tt>Object</tt>) <strong>publish</strong>(year)
-</h3><div class="docstring">
-  <div class="discussion">
-<p>method calls the `markdown` method and creates a MultiMarkdown document
-with one big description list.  This format is subject to change, but for
-now, it seems good enough.</p>
-  </div>
-</div>
-<div class="tags">
-  <p class="tag_title">Parameters:</p>
-<ul class="param">
-    <li>
-        <span class='name'>year</span>
-        <span class='type'>(<tt>String</tt>)</span>
-        &mdash;
-        <div class='inline'>
-<p>of journal entries you wish to pubish as Markdown This</p>
-</div>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-100
-101
-102
-103
-104</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/nikki.rb', line 100</span>
-<span class='kw'>def</span> <span class='id identifier rubyid_publish'>publish</span><span class='lparen'>(</span><span class='id identifier rubyid_year'>year</span><span class='rparen'>)</span>
-  <span class='id identifier rubyid_md_path'>md_path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_path'>path</span><span class='embexpr_end'>}</span><span class='tstring_content'>nikki_markdown_</span><span class='embexpr_beg'>#{</span><span class='const'>Date</span><span class='period'>.</span><span class='id identifier rubyid_today'>today</span><span class='embexpr_end'>}</span><span class='tstring_content'>.md</span><span class='tstring_end'>&quot;</span></span>
-  <span class='const'>IO</span><span class='period'>.</span><span class='id identifier rubyid_write'>write</span><span class='lparen'>(</span><span class='id identifier rubyid_md_path'>md_path</span><span class='comma'>,</span> <span class='id identifier rubyid_markdown'>markdown</span><span class='lparen'>(</span><span class='id identifier rubyid_read_file'>read_file</span><span class='comma'>,</span> <span class='id identifier rubyid_year'>year</span><span class='period'>.</span><span class='id identifier rubyid_to_i'>to_i</span><span class='rparen'>)</span><span class='rparen'>)</span>
-  <span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Markdown saved to \&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_md_path'>md_path</span><span class='embexpr_end'>}</span><span class='tstring_content'>\&quot;.</span><span class='tstring_end'>&quot;</span></span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <div class="method_details ">
-  <h3 class="signature " id="setup-instance_method">
-    - (<tt>Object</tt>) <strong>setup</strong>
-</h3><div class="docstring">
-  <div class="discussion">
-<p>This methods creates the “.nikki” directory, config file and journal file.</p>
-  </div>
-</div>
-<div class="tags">
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-14
-15
-16
-17
-18</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/nikki.rb', line 14</span>
-<span class='kw'>def</span> <span class='id identifier rubyid_setup'>setup</span>
-  <span class='id identifier rubyid_create_path'>create_path</span>
-  <span class='id identifier rubyid_create_file'>create_file</span>
-  <span class='id identifier rubyid_create_config_file'>create_config_file</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-  </div>
-</div>
-    <div id="footer">
-  Generated on Tue Sep 30 15:46:41 2014 by
-  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.8.7.4 (ruby-2.1.2).
-</div>
-  </body>
-</html>