doc/StandupMD/Cli.html in standup_md-0.3.6 vs doc/StandupMD/Cli.html in standup_md-0.3.7
- old
+ new
@@ -19,12 +19,10 @@
<link href="../css/fonts.css" rel="stylesheet">
<link href="../css/rdoc.css" rel="stylesheet">
-
-
<body id="top" role="document" class="class">
<nav role="navigation">
<div id="project-navigation">
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
<h2>
@@ -57,55 +55,42 @@
<div id="class-metadata">
- <div id="parent-class-section" class="nav-section">
+
+<div id="parent-class-section" class="nav-section">
<h3>Parent</h3>
-
<p class="link">Object
-
</div>
- <div id="includes-section" class="nav-section">
+
+<div id="includes-section" class="nav-section">
<h3>Included Modules</h3>
<ul class="link-list">
-
-
<li><a class="include" href="Cli/Helpers.html">StandupMD::Cli::Helpers</a>
-
-
</ul>
</div>
- <!-- Method Quickref -->
+
+<!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
<h3>Methods</h3>
<ul class="link-list" role="directory">
-
<li ><a href="#method-c-config">::config</a>
-
<li ><a href="#method-c-echo">::echo</a>
-
<li ><a href="#method-c-execute">::execute</a>
-
<li ><a href="#method-c-new">::new</a>
-
<li ><a href="#method-i-echo">#echo</a>
-
<li ><a href="#method-i-edit">#edit</a>
-
<li ><a href="#method-i-load_preferences">#load_preferences</a>
-
<li ><a href="#method-i-preference_file_loaded-3F">#preference_file_loaded?</a>
-
<li ><a href="#method-i-write_file">#write_file</a>
-
</ul>
</div>
</div>
</nav>
@@ -119,168 +104,119 @@
<p>Class for handing the command-line interface.</p>
</section>
-
<section id="5Buntitled-5D" class="documentation-section">
-
-
-
-
<section class="attribute-method-details" class="method-section">
<header>
<h3>Attributes</h3>
</header>
-
<div id="attribute-i-entry" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">entry</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
-
<p>The entry searched for, usually today.</p>
<p>@return [StandupMD::Entry]</p>
-
</div>
</div>
-
<div id="attribute-i-file" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">file</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
-
<p>The file loaded.</p>
<p>@return [StandupMD::File]</p>
-
</div>
</div>
-
<div id="attribute-i-options" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">options</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
-
<p>Arguments passed at runtime.</p>
<p>@return [Array] ARGV</p>
-
</div>
</div>
-
</section>
-
-
+
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Class Methods</h3>
</header>
-
<div id="method-c-config" class="method-detail ">
-
<div class="method-heading">
<span class="method-name">config</span><span
class="method-args">()</span>
-
<span class="method-click-advice">click to toggle source</span>
-
</div>
-
<div class="method-description">
-
<p>Access to the class's configuration.</p>
<p>@return [StandupMD::Config::Cli]</p>
-
-
-
<div class="method-source-code" id="config-source">
<pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line 16</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">config</span>
<span class="ruby-ivar">@config</span> <span class="ruby-operator">||=</span> <span class="ruby-constant">StandupMD</span>.<span class="ruby-identifier">config</span>.<span class="ruby-identifier">cli</span>
<span class="ruby-keyword">end</span></pre>
</div>
-
</div>
-
-
</div>
-
<div id="method-c-echo" class="method-detail ">
-
<div class="method-heading">
<span class="method-name">echo</span><span
class="method-args">(msg)</span>
-
<span class="method-click-advice">click to toggle source</span>
-
</div>
-
<div class="method-description">
-
<p>Prints output if <code>verbose</code> is true.</p>
<p>@return [nil]</p>
-
-
-
<div class="method-source-code" id="echo-source">
<pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line 24</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">echo</span>(<span class="ruby-identifier">msg</span>)
<span class="ruby-identifier">puts</span> <span class="ruby-identifier">msg</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">config</span>.<span class="ruby-identifier">verbose</span>
<span class="ruby-keyword">end</span></pre>
</div>
-
</div>
-
-
</div>
-
<div id="method-c-execute" class="method-detail ">
-
<div class="method-heading">
<span class="method-name">execute</span><span
class="method-args">(options = [])</span>
-
<span class="method-click-advice">click to toggle source</span>
-
</div>
-
<div class="method-description">
-
<p>Creates an instance of <code>StandupMD</code> and runs what the user requested.</p>
-
-
-
<div class="method-source-code" id="execute-source">
<pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line 30</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">execute</span>(<span class="ruby-identifier">options</span> = [])
<span class="ruby-identifier">exe</span> = <span class="ruby-identifier">new</span>(<span class="ruby-identifier">options</span>)
@@ -290,39 +226,27 @@
<span class="ruby-keyword">elsif</span> <span class="ruby-identifier">config</span>.<span class="ruby-identifier">edit</span>
<span class="ruby-identifier">exe</span>.<span class="ruby-identifier">edit</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
-
</div>
-
-
</div>
-
<div id="method-c-new" class="method-detail ">
-
<div class="method-heading">
<span class="method-name">new</span><span
class="method-args">(options = [], load_config = true)</span>
-
<span class="method-click-advice">click to toggle source</span>
-
</div>
-
<div class="method-description">
-
<p>Constructor. Sets defaults.</p>
<p>@param [Array] options</p>
-
-
-
<div class="method-source-code" id="new-source">
<pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line 63</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">options</span> = [], <span class="ruby-identifier">load_config</span> = <span class="ruby-keyword">true</span>)
<span class="ruby-ivar">@config</span> = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">config</span>
<span class="ruby-ivar">@preference_file_loaded</span> = <span class="ruby-keyword">false</span>
@@ -332,118 +256,81 @@
<span class="ruby-ivar">@file</span> = <span class="ruby-constant">StandupMD</span><span class="ruby-operator">::</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">find_by_date</span>(<span class="ruby-ivar">@config</span>.<span class="ruby-identifier">date</span>)
<span class="ruby-ivar">@file</span>.<span class="ruby-identifier">load</span>
<span class="ruby-ivar">@entry</span> = <span class="ruby-identifier">new_entry</span>(<span class="ruby-ivar">@file</span>)
<span class="ruby-keyword">end</span></pre>
</div>
-
</div>
-
-
</div>
-
</section>
-
+
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Instance Methods</h3>
</header>
-
<div id="method-i-echo" class="method-detail ">
-
<div class="method-heading">
<span class="method-name">echo</span><span
class="method-args">(msg)</span>
-
<span class="method-click-advice">click to toggle source</span>
-
</div>
-
<div class="method-description">
-
<p>Quick access to <a href="Cli.html#method-c-echo"><code>Cli.echo</code></a>.</p>
<p>@return [nil]</p>
-
-
-
<div class="method-source-code" id="echo-source">
<pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line 117</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">echo</span>(<span class="ruby-identifier">msg</span>)
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">echo</span>(<span class="ruby-identifier">msg</span>)
<span class="ruby-keyword">end</span></pre>
</div>
-
</div>
-
-
</div>
-
<div id="method-i-edit" class="method-detail ">
-
<div class="method-heading">
<span class="method-name">edit</span><span
class="method-args">()</span>
-
<span class="method-click-advice">click to toggle source</span>
-
</div>
-
<div class="method-description">
-
<p>Opens the file in an editor. Abandons the script.</p>
<p>@return [nil]</p>
-
-
-
<div class="method-source-code" id="edit-source">
<pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line 99</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">edit</span>
<span class="ruby-identifier">echo</span> <span class="ruby-node">"Opening file in #{@config.editor}"</span>
<span class="ruby-identifier">exec</span>(<span class="ruby-node">"#{@config.editor} #{file.name}"</span>)
<span class="ruby-keyword">end</span></pre>
</div>
-
</div>
-
-
</div>
-
<div id="method-i-load_preferences" class="method-detail ">
-
<div class="method-heading">
<span class="method-name">load_preferences</span><span
class="method-args">()</span>
-
<span class="method-click-advice">click to toggle source</span>
-
</div>
-
<div class="method-description">
-
<p>Load the preference file.</p>
<p>@return [nil]</p>
-
-
-
<div class="method-source-code" id="load_preferences-source">
<pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line 78</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">load_preferences</span>
<span class="ruby-keyword">if</span> <span class="ruby-operator">::</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">exist?</span>(<span class="ruby-ivar">@config</span>.<span class="ruby-identifier">preference_file</span>)
<span class="ruby-operator">::</span><span class="ruby-constant">StandupMD</span>.<span class="ruby-identifier">load_config_file</span>(<span class="ruby-ivar">@config</span>.<span class="ruby-identifier">preference_file</span>)
@@ -451,98 +338,69 @@
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">echo</span> <span class="ruby-node">"Preference file #{@config.preference_file} does not exist."</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
-
</div>
-
-
</div>
-
<div id="method-i-preference_file_loaded-3F" class="method-detail ">
-
<div class="method-heading">
<span class="method-name">preference_file_loaded?</span><span
class="method-args">()</span>
-
<span class="method-click-advice">click to toggle source</span>
-
</div>
-
<div class="method-description">
-
<p>Has the preference file been loaded?</p>
<p>@return boolean</p>
-
-
-
<div class="method-source-code" id="preference_file_loaded-3F-source">
<pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line 91</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">preference_file_loaded?</span>
<span class="ruby-ivar">@preference_file_loaded</span>
<span class="ruby-keyword">end</span></pre>
</div>
-
</div>
-
-
</div>
-
<div id="method-i-write_file" class="method-detail ">
-
<div class="method-heading">
<span class="method-name">write_file</span><span
class="method-args">()</span>
-
<span class="method-click-advice">click to toggle source</span>
-
</div>
-
<div class="method-description">
-
<p>Writes entries to the file.</p>
<p>@return [Boolean] true if file was written</p>
-
-
-
<div class="method-source-code" id="write_file-source">
<pre><span class="ruby-comment"># File lib/standup_md/cli.rb, line 108</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">write_file</span>
<span class="ruby-identifier">echo</span> <span class="ruby-node">"Writing file #{file.name}"</span>
<span class="ruby-identifier">file</span>.<span class="ruby-identifier">write</span>
<span class="ruby-keyword">end</span></pre>
</div>
-
</div>
-
-
</div>
-
</section>
-
- </section>
+ </section>
</main>
<footer id="validator-badges" role="contentinfo">
<p><a href="https://validator.w3.org/check/referer">Validate</a>
- <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.2.1.
+ <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.3.0.
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>