standup_md 0.3.3 → 0.3.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 49f9ad4ada41c9372b1d3ffebb4f44fff6cb96249224c9b62c5063e1836a4c8f
-  data.tar.gz: da5aa3a5e2cfc882372ef5899694941d32702049323d615acc36644733dabe12
+  metadata.gz: 57e3f70a3f6a38b1c9d6efa8b1f72dffc678771bd1404c4ff218840efcd24be5
+  data.tar.gz: 8f68954fa77c186804ce05f14f2903d8e7e36d978c8ec75453153f18e48490e7
 SHA512:
-  metadata.gz: 35587b73b6ec5d9d2388ce4d4b95185b982486414f3c5a5874fd7c73ee84dfcab6ba4b0109fcac33bf89576517a48f3a9730e85238ee53557f3b0047e6548c19
-  data.tar.gz: d772849128665813f3326fa41a684607e1231cd7065828f933dc5b50e51b0f909ef24862020d08af39f2bb2cd07e749c02c0347c00d923fb9ee38f14c69808c3
+  metadata.gz: af2637941f87f5a3aab89ae2cd5a44d750e58d289ce0a5c9f21aeba6708c4e847794065a5c86520ece53f1a1475e15079f3a924b70724e4b6258ee14cdcf9a6d
+  data.tar.gz: cf88b88ad98241a3caded35085a5031fa8ebb3b0c64124d2d32dd3f7ad1ec1ff2ff52b566c7316738e43b56e642522b5f6e6e107cd55ccaea1732eb233683c26

data/Gemfile.lock

@@ -1,23 +1,25 @@
 PATH
   remote: .
   specs:
-    standup_md (0.3.0)
+    standup_md (0.3.7)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    docile (1.3.2)
-    power_assert (1.2.0)
-    rake (13.0.1)
-    simplecov (0.18.5)
+    docile (1.3.5)
+    power_assert (2.0.0)
+    rake (13.0.3)
+    simplecov (0.21.2)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
-    simplecov-html (0.12.2)
-    test-unit (3.3.5)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.2)
+    test-unit (3.4.1)
       power_assert
 
 PLATFORMS
-  ruby
+  x86_64-darwin-20
 
 DEPENDENCIES
   rake (~> 13.0, >= 13.0.1)
@@ -26,4 +28,4 @@ DEPENDENCIES
   test-unit (~> 3.3, >= 3.3.5)
 
 BUNDLED WITH
-   2.1.4
+   2.2.16

data/README.md

@@ -1,4 +1,5 @@
 # The Standup Doctor
+<!-- vi: set ts=4 sw=4 : -->
 [![Build Status](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2Fevanthegrayt%2Fstandup_md%2Fbadge%3Fref%3Dmaster&style=flat)](https://actions-badge.atrox.dev/evanthegrayt/standup_md/goto?ref=master)
 [![Gem Version](https://badge.fury.io/rb/standup_md.svg)](https://badge.fury.io/rb/standup_md)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
@@ -12,26 +13,6 @@ View on: [Github](https://github.com/evanthegrayt/standup_md) |
 [GitHub Pages](https://evanthegrayt.github.io/standup_md/) |
 [RubyGems](https://rubygems.org/gems/standup_md)
 
-## Table of Contents
-- [About](#about)
-- [Installation](#Installation)
-  - [Via RubyGems](#via-rubygems)
-  - [Manual Installation](#manual-installation)
-- [Usage](#usage)
-  - [Command Line](#command-line)
-    - [CLI Examples](#cli-examples)
-      - [Adding an entry for today via editor](#adding-an-entry-for-today-via-editor)
-      - [Copy the entry for today to clipboard](#copy-the-entry-for-today-to-clipboard)
-      - [Add entry to file without opening it](#add-entry-to-file-without-opening-it)
-      - [Find an entry by date and print it](#find-an-entry-by-date-and-print-it)
-    - [Customization and Runtime Options](#customization-and-runtime-options)
-    - [Using existing standup files](#using-existing-standup-files)
-  - [API](#api)
-    - [API Examples](#api-examples)
-    - [Documentation](https://evanthegrayt.github.io/standup_md/doc/index.html)
-- [Reporting Bugs and Requesting Features](#reporting-bugs-and-requesting-features)
-- [Self-Promotion](#self-promotion)
-
 ## About
 I've now been at two separate companies where we post our daily standups in a
 chat client, such as Slack, Mattermost, or Riot. Typing out my standup every day
@@ -45,10 +26,15 @@ for the current month in your preferred editor. If an entry for today is already
 present, no text will be generated. If an entry for today doesn't exist, one
 will be generated with your preferred values. When generating, if a previous
 entry exists, it will be added to today's entry as your previous day's work. See
-[example](#example). There's also a very robust API if you'd like to use this
-in your own code somehow.
+[example](#cli-examples). There's also a very robust API if you'd like to use
+this in your own code somehow.
 
 ## Installation
+If you don't have the permissions to install system-wide gems, you're probabaly
+also running an older version of ruby. I recommend installing
+[rbenv](https://github.com/rbenv/rbenv#installation), and then installing an
+up-to-date version of ruby.
+
 ### Via RubyGems
 Just install the gem!
 
@@ -167,6 +153,8 @@ them again.
 
 
 #### Available Config File Options and Defaults
+For command-line usage, this file needs to be named `~/.standuprc`. To use in a
+rails project, create an initializer (`config/initializers/standup_md.rb`).
 
 ```ruby
 StandupMD.configure do |c|
@@ -205,7 +193,15 @@ StandupMD.configure do |c|
 end
 ```
 
+Any options not set in this file will retain their default values. Note that if
+you change `file_name_format`, and don't use a month or year, there will only
+ever be one standup file. This could cause issues long-term, as the files will
+get large over time and possibly cause performance issues.
+
+
 #### Executable Flags
+Some of these options can be changed at runtime. They are as follows.
+
 ```
     --current ARRAY            List of current entry's tasks
     --previous ARRAY           List of precious entry's tasks
@@ -224,11 +220,6 @@ end
                                DATE must be in the same format as file-name-format
 ```
 
-Any options not set in this file will retain their default values. Note that if
-you change `file_name_format`, and don't use a month or year, there will only
-ever be one standup file. This could cause issues long-term, as the files will
-get large over time and possibly cause performance issues.
-
 #### Using Existing Standup Files
 If you already have a directory of existing standup files, you can use them, but
 they must be in a format that the parser can understand. The default is:
@@ -282,12 +273,12 @@ end
 The API is fully documented in the
 [RDoc Documentation](https://evanthegrayt.github.io/standup_md/doc/index.html).
 
-This was mainly written as a command line utility, but the API is ridiculously
-robust, and is available for use in your own projects. A quick example of how
-to write a new entry via code could look like the following:
+This was mainly written as a command line utility, but the API is very robust,
+and is available for use in your own projects. A quick example of how to write a
+new entry via code could look like the following:
 
 ### API Examples
-
+#### Adding an entry for today
 ```ruby
 require 'standup_md'
 
@@ -315,10 +306,52 @@ end
 StandupMD::File.find_by_date(Date.today).load.write
 ```
 
+#### Finding a past entry
+```ruby
+require 'standup_md'
+
+date = Date.new(2020, 04, 15)
+file = StandupMD::File.find_by_date(date).load
+entry = file.entries.find(date)
+```
+
+## Vim
+While there's no official support for vim, you can add this to your `vimrc`
+file, or something like `~/.vim/plugin/standup.vim`.
+
+```vim
+command! -complete=custom,<SID>StandupCompletion -nargs=? -bang Standup
+    \ call s:OpenStandupFile(<bang>0, <f-args>)
+
+function! s:StandupCompletion(...) abort
+  let l:dir = get(g:, 'standup_dir', $HOME . '/.cache/standup_md') . '/'
+  if !isdirectory(l:dir) | return '' | endif
+  return join(map(glob(l:dir . '*.md', 0, 1), "fnamemodify(v:val, ':t')"), "\n")
+endfunction
+
+function! s:OpenStandupFile(split, ...)
+  let l:dir = get(g:, 'standup_dir', $HOME . '/.cache/standup_md') . '/'
+  let l:file = a:0 ? a:1 : get(g:, 'standup_file', strftime('%Y_%m.md'))
+  call system('standup --no-edit')
+  execute a:split ? 'vsplit' : 'split' l:dir . l:file
+endfunction
+```
+
+This makes the `:Standup` command, which opens the standup file in a split,
+while `:Standup!` opens it in a vertical split. If a file is passed to the
+command, that file will be opened. There's tab completion for this. Lastly,
+it allows for a few variables to be set for customization.
+
+```vim
+g:standup_dir = $HOME . '/.cache/standup_md' " the directory where your file are
+g:standup_file = strftime('%Y_%m.md')        " the file format to use
+```
+
 ## Reporting Bugs and Requesting Features
 If you have an idea or find a bug, please [create an
-issue](https://github.com/evanthegrayt/standup_md/issues/new). Just make sure the topic
-doesn't already exist. Better yet, you can always submit a Pull Request.
+issue](https://github.com/evanthegrayt/standup_md/issues/new). Just make sure
+the topic doesn't already exist. Better yet, you can always submit a Pull
+Request.
 
 ## Self-Promotion
 I do these projects for fun, and I enjoy knowing that they're helpful to people.

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'lib/standup_md'
 require 'bundler/gem_tasks'
 require 'rdoc/task'
@@ -16,4 +18,4 @@ RDoc::Task.new do |rdoc|
   rdoc.rdoc_files.include('README.md', 'lib/**/*.rb')
 end
 
-task :default => :test
+task default: :test

data/doc/README_md.html

@@ -21,8 +21,6 @@
 <link href="./css/rdoc.css" rel="stylesheet">
 
 
-
-
 <body id="top" role="document" class="file">
 <nav role="navigation">
   <div id="project-navigation">
@@ -61,7 +59,6 @@
 
   <ul class="link-list" role="directory">
     <li><a href="#label-The+Standup+Doctor">The Standup Doctor</a>
-    <li><a href="#label-Table+of+Contents">Table of Contents</a>
     <li><a href="#label-About">About</a>
     <li><a href="#label-Installation">Installation</a>
     <li><a href="#label-Via+RubyGems">Via RubyGems</a>
@@ -79,6 +76,9 @@
     <li><a href="#label-Using+Existing+Standup+Files">Using Existing Standup Files</a>
     <li><a href="#label-API">API</a>
     <li><a href="#label-API+Examples">API Examples</a>
+    <li><a href="#label-Adding+an+entry+for+today">Adding an entry for today</a>
+    <li><a href="#label-Finding+a+past+entry">Finding a past entry</a>
+    <li><a href="#label-Vim">Vim</a>
     <li><a href="#label-Reporting+Bugs+and+Requesting+Features">Reporting Bugs and Requesting Features</a>
     <li><a href="#label-Self-Promotion">Self-Promotion</a>
   </ul>
@@ -86,13 +86,12 @@
 
 
   <div id="project-metadata">
-    <div id="fileindex-section" class="nav-section">
+    
+<div id="fileindex-section" class="nav-section">
   <h3>Pages</h3>
 
   <ul class="link-list">
-  
     <li><a href="./README_md.html">README</a>
-  
   </ul>
 </div>
 
@@ -102,7 +101,7 @@
 <main role="main" aria-label="Page README.md">
 
 <h1 id="label-The+Standup+Doctor">The Standup Doctor<span><a href="#label-The+Standup+Doctor">&para;</a> <a href="#top">&uarr;</a></span></h1>
-
+<!-- vi: set ts=4 sw=4 : -->
 <p><a href="https://actions-badge.atrox.dev/evanthegrayt/standup_md/goto?ref=master"><img src="https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2Fevanthegrayt%2Fstandup_md%2Fbadge%3Fref%3Dmaster&style=flat"></a> <a href="https://badge.fury.io/rb/standup_md"><img src="https://badge.fury.io/rb/standup_md.svg"></a> <a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/License-MIT-yellow.svg"></a></p>
 
 <blockquote>
@@ -113,55 +112,16 @@
 
 <p>View on: <a href="https://github.com/evanthegrayt/standup_md">Github</a> | <a href="https://evanthegrayt.github.io/standup_md/">GitHub Pages</a> | <a href="https://rubygems.org/gems/standup_md">RubyGems</a></p>
 
-<h2 id="label-Table+of+Contents">Table of Contents<span><a href="#label-Table+of+Contents">&para;</a> <a href="#top">&uarr;</a></span></h2>
-<ul><li>
-<p><a href="#about">About</a></p>
-</li><li>
-<p><a href="#Installation">Installation</a></p>
-</li><li>
-<p><a href="#via-rubygems">Via RubyGems</a></p>
-</li><li>
-<p><a href="#manual-installation">Manual Installation</a></p>
-</li><li>
-<p><a href="#usage">Usage</a></p>
-</li><li>
-<p><a href="#command-line">Command Line</a></p>
-<ul><li>
-<p><a href="#cli-examples">CLI Examples</a></p>
-</li><li>
-<p><a href="#adding-an-entry-for-today-via-editor">Adding an entry for today via editor</a></p>
-</li><li>
-<p><a href="#copy-the-entry-for-today-to-clipboard">Copy the entry for today to clipboard</a></p>
-</li><li>
-<p><a href="#add-entry-to-file-without-opening-it">Add entry to file without opening it</a></p>
-</li><li>
-<p><a href="#find-an-entry-by-date-and-print-it">Find an entry by date and print it</a></p>
-</li><li>
-<p><a href="#customization-and-runtime-options">Customization and Runtime Options</a></p>
-</li><li>
-<p><a href="#using-existing-standup-files">Using existing standup files</a></p>
-</li></ul>
-</li><li>
-<p><a href="#api">API</a></p>
-<ul><li>
-<p><a href="#api-examples">API Examples</a></p>
-</li><li>
-<p><a href="https://evanthegrayt.github.io/standup_md/doc/index.html">Documentation</a></p>
-</li></ul>
-</li><li>
-<p><a href="#reporting-bugs-and-requesting-features">Reporting Bugs and Requesting Features</a></p>
-</li><li>
-<p><a href="#self-promotion">Self-Promotion</a></p>
-</li></ul>
-
 <h2 id="label-About">About<span><a href="#label-About">&para;</a> <a href="#top">&uarr;</a></span></h2>
 
 <p>I&#39;ve now been at two separate companies where we post our daily standups in a chat client, such as Slack, Mattermost, or Riot. Typing out my standup every day became tedious, as I&#39;d have to look up what I did the day before, copy and paste yesterday&#39;s work into a new entry, and add today&#39;s tasks. This gem automates most of this process, along with providing means of opening the file in your editor, and finding and displaying entries from the command line.</p>
 
-<p>In a nutshell, calling <code>standup</code> from the command line will open a standup file for the current month in your preferred editor. If an entry for today is already present, no text will be generated. If an entry for today doesn&#39;t exist, one will be generated with your preferred values. When generating, if a previous entry exists, it will be added to today&#39;s entry as your previous day&#39;s work. See <a href="#example">example</a>. There&#39;s also a very robust API if you&#39;d like to use this in your own code somehow.</p>
+<p>In a nutshell, calling <code>standup</code> from the command line will open a standup file for the current month in your preferred editor. If an entry for today is already present, no text will be generated. If an entry for today doesn&#39;t exist, one will be generated with your preferred values. When generating, if a previous entry exists, it will be added to today&#39;s entry as your previous day&#39;s work. See <a href="#cli-examples">example</a>. There&#39;s also a very robust API if you&#39;d like to use this in your own code somehow.</p>
 
 <h2 id="label-Installation">Installation<span><a href="#label-Installation">&para;</a> <a href="#top">&uarr;</a></span></h2>
 
+<p>If you don&#39;t have the permissions to install system-wide gems, you&#39;re probabaly also running an older version of ruby. I recommend installing <a href="https://github.com/rbenv/rbenv#installation">rbenv</a>, and then installing an up-to-date version of ruby.</p>
+
 <h3 id="label-Via+RubyGems">Via RubyGems<span><a href="#label-Via+RubyGems">&para;</a> <a href="#top">&uarr;</a></span></h3>
 
 <p>Just install the gem!</p>
@@ -250,6 +210,8 @@ rake install</pre>
 
 <h4 id="label-Available+Config+File+Options+and+Defaults">Available Config File Options and Defaults<span><a href="#label-Available+Config+File+Options+and+Defaults">&para;</a> <a href="#top">&uarr;</a></span></h4>
 
+<p>For command-line usage, this file needs to be named <code>~/.standuprc</code>. To use in a rails project, create an initializer (<code>config/initializers/standup_md.rb</code>).</p>
+
 <pre class="ruby"><span class="ruby-constant">StandupMD</span>.<span class="ruby-identifier">configure</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">c</span><span class="ruby-operator">|</span>
   <span class="ruby-comment"># Defaults for how the file is formatted.</span>
   <span class="ruby-comment"># See https://evanthegrayt.github.io/standup_md/doc/StandupMD/Config/Cli.html</span>
@@ -286,8 +248,12 @@ rake install</pre>
 <span class="ruby-keyword">end</span>
 </pre>
 
+<p>Any options not set in this file will retain their default values. Note that if you change <code>file_name_format</code>, and don&#39;t use a month or year, there will only ever be one standup file. This could cause issues long-term, as the files will get large over time and possibly cause performance issues.</p>
+
 <h4 id="label-Executable+Flags">Executable Flags<span><a href="#label-Executable+Flags">&para;</a> <a href="#top">&uarr;</a></span></h4>
 
+<p>Some of these options can be changed at runtime. They are as follows.</p>
+
 <pre>--current ARRAY            List of current entry&#39;s tasks
     --previous ARRAY           List of precious entry&#39;s tasks
     --impediments ARRAY        List of impediments for current entry
@@ -304,8 +270,6 @@ rake install</pre>
                                If DATE is passed, will print entry for DATE, if it exists.
                                DATE must be in the same format as file-name-format</pre>
 
-<p>Any options not set in this file will retain their default values. Note that if you change <code>file_name_format</code>, and don&#39;t use a month or year, there will only ever be one standup file. This could cause issues long-term, as the files will get large over time and possibly cause performance issues.</p>
-
 <h4 id="label-Using+Existing+Standup+Files">Using Existing Standup Files<span><a href="#label-Using+Existing+Standup+Files">&para;</a> <a href="#top">&uarr;</a></span></h4>
 
 <p>If you already have a directory of existing standup files, you can use them, but they must be in a format that the parser can understand. The default is:</p>
@@ -352,10 +316,12 @@ rake install</pre>
 
 <p>The API is fully documented in the <a href="https://evanthegrayt.github.io/standup_md/doc/index.html">RDoc Documentation</a>.</p>
 
-<p>This was mainly written as a command line utility, but the API is ridiculously robust, and is available for use in your own projects. A quick example of how to write a new entry via code could look like the following:</p>
+<p>This was mainly written as a command line utility, but the API is very robust, and is available for use in your own projects. A quick example of how to write a new entry via code could look like the following:</p>
 
 <h3 id="label-API+Examples">API Examples<span><a href="#label-API+Examples">&para;</a> <a href="#top">&uarr;</a></span></h3>
 
+<h4 id="label-Adding+an+entry+for+today">Adding an entry for today<span><a href="#label-Adding+an+entry+for+today">&para;</a> <a href="#top">&uarr;</a></span></h4>
+
 <pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">&#39;standup_md&#39;</span>
 
 <span class="ruby-constant">StandupMD</span>.<span class="ruby-identifier">configure</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">c</span><span class="ruby-operator">|</span>
@@ -380,6 +346,40 @@ rake install</pre>
 <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-constant">Date</span>.<span class="ruby-identifier">today</span>).<span class="ruby-identifier">load</span>.<span class="ruby-identifier">write</span>
 </pre>
 
+<h4 id="label-Finding+a+past+entry">Finding a past entry<span><a href="#label-Finding+a+past+entry">&para;</a> <a href="#top">&uarr;</a></span></h4>
+
+<pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">&#39;standup_md&#39;</span>
+
+<span class="ruby-identifier">date</span> = <span class="ruby-constant">Date</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value">2020</span>, <span class="ruby-value">04</span>, <span class="ruby-value">15</span>)
+<span class="ruby-identifier">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-identifier">date</span>).<span class="ruby-identifier">load</span>
+<span class="ruby-identifier">entry</span> = <span class="ruby-identifier">file</span>.<span class="ruby-identifier">entries</span>.<span class="ruby-identifier">find</span>(<span class="ruby-identifier">date</span>)
+</pre>
+
+<h2 id="label-Vim">Vim<span><a href="#label-Vim">&para;</a> <a href="#top">&uarr;</a></span></h2>
+
+<p>While there&#39;s no official support for vim, you can add this to your <code>vimrc</code> file, or something like <code>~/.vim/plugin/standup.vim</code>.</p>
+
+<pre>command! -complete=custom,&lt;SID&gt;StandupCompletion -nargs=? -bang Standup
+    \ call s:OpenStandupFile(&lt;bang&gt;0, &lt;f-args&gt;)
+
+function! s:StandupCompletion(...) abort
+  let l:dir = get(g:, &#39;standup_dir&#39;, $HOME . &#39;/.cache/standup_md&#39;) . &#39;/&#39;
+  if !isdirectory(l:dir) | return &#39;&#39; | endif
+  return join(map(glob(l:dir . &#39;*.md&#39;, 0, 1), &quot;fnamemodify(v:val, &#39;:t&#39;)&quot;), &quot;\n&quot;)
+endfunction
+
+function! s:OpenStandupFile(split, ...)
+  let l:dir = get(g:, &#39;standup_dir&#39;, $HOME . &#39;/.cache/standup_md&#39;) . &#39;/&#39;
+  let l:file = a:0 ? a:1 : get(g:, &#39;standup_file&#39;, strftime(&#39;%Y_%m.md&#39;))
+  call system(&#39;standup --no-edit&#39;)
+  execute a:split ? &#39;vsplit&#39; : &#39;split&#39; l:dir . l:file
+endfunction</pre>
+
+<p>This makes the <code>:Standup</code> command, which opens the standup file in a split, while <code>:Standup!</code> opens it in a vertical split. If a file is passed to the command, that file will be opened. There&#39;s tab completion for this. Lastly, it allows for a few variables to be set for customization.</p>
+
+<pre>g:standup_dir = $HOME . &#39;/.cache/standup_md&#39; &quot; the directory where your file are
+g:standup_file = strftime(&#39;%Y_%m.md&#39;)        &quot; the file format to use</pre>
+
 <h2 id="label-Reporting+Bugs+and+Requesting+Features">Reporting Bugs and Requesting Features<span><a href="#label-Reporting+Bugs+and+Requesting+Features">&para;</a> <a href="#top">&uarr;</a></span></h2>
 
 <p>If you have an idea or find a bug, please <a href="https://github.com/evanthegrayt/standup_md/issues/new">create an issue</a>. Just make sure the topic doesn&#39;t already exist. Better yet, you can always submit a Pull Request.</p>
@@ -394,7 +394,7 @@ rake install</pre>
 
 <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>
 

data/doc/StandupMD.html

@@ -21,8 +21,6 @@
 <link href="./css/rdoc.css" rel="stylesheet">
 
 
-
-
 <body id="top" role="document" class="module">
 <nav role="navigation">
   <div id="project-navigation">
@@ -62,22 +60,17 @@
     
     
     
-    <!-- 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-config_file_loaded-3F">::config_file_loaded?</a>
-    
     <li ><a href="#method-c-configure">::configure</a>
-    
     <li ><a href="#method-c-load_config_file">::load_config_file</a>
-    
     <li ><a href="#method-c-reset_config">::reset_config</a>
-    
   </ul>
 </div>
 
@@ -95,230 +88,148 @@
 
   </section>
 
-  
   <section id="5Buntitled-5D" class="documentation-section">
-    
 
-    
 
-    
-    <section class="constants-list">
-      <header>
-        <h3>Constants</h3>
-      </header>
-      <dl>
-      
-        <dt id="VERSION">VERSION
-        
-        <dd><p>The gem verision</p>
-
-<p>@return [String]</p>
-        
-      
-      </dl>
-    </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>Method for accessing the configuration.</p>
 
 <p>@return [StanupMD::Cli]</p>
-          
-          
 
-          
           <div class="method-source-code" id="config-source">
             <pre><span class="ruby-comment"># File lib/standup_md.rb, line 19</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-operator">::</span><span class="ruby-constant">Config</span>.<span class="ruby-identifier">new</span>
 <span class="ruby-keyword">end</span></pre>
           </div>
-          
         </div>
 
-        
 
-        
       </div>
 
-    
       <div id="method-c-config_file_loaded-3F" class="method-detail ">
-        
         <div class="method-heading">
           <span class="method-name">config_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 a config file been loaded?</p>
 
 <p>@return [Boolean]</p>
-          
-          
 
-          
           <div class="method-source-code" id="config_file_loaded-3F-source">
             <pre><span class="ruby-comment"># File lib/standup_md.rb, line 44</span>
 <span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">config_file_loaded?</span>
   <span class="ruby-ivar">@config_file_loaded</span>
 <span class="ruby-keyword">end</span></pre>
           </div>
-          
         </div>
 
-        
 
-        
       </div>
 
-    
       <div id="method-c-configure" class="method-detail ">
-        
         <div class="method-heading">
           <span class="method-name">configure</span><span
             class="method-args">() { |config| ... }</span>
-          
           <span class="method-click-advice">click to toggle source</span>
-          
         </div>
-        
 
         <div class="method-description">
-          
           <p>Allows for configuration via a block. Useful when making config files.</p>
 
 <p>@example</p>
 
 <pre class="ruby"><span class="ruby-constant">StandupMD</span>.<span class="ruby-identifier">configure</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">s</span><span class="ruby-operator">|</span> <span class="ruby-identifier">s</span>.<span class="ruby-identifier">cli</span>.<span class="ruby-identifier">editor</span> = <span class="ruby-string">&#39;mate&#39;</span> }
 </pre>
-          
-          
 
-          
           <div class="method-source-code" id="configure-source">
             <pre><span class="ruby-comment"># File lib/standup_md.rb, line 36</span>
 <span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">configure</span>
-  <span class="ruby-keyword">yield</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">config</span>
+  <span class="ruby-keyword">yield</span> <span class="ruby-identifier">config</span>
 <span class="ruby-keyword">end</span></pre>
           </div>
-          
         </div>
 
-        
 
-        
       </div>
 
-    
       <div id="method-c-load_config_file" class="method-detail ">
-        
         <div class="method-heading">
           <span class="method-name">load_config_file</span><span
             class="method-args">(file)</span>
-          
           <span class="method-click-advice">click to toggle source</span>
-          
         </div>
-        
 
         <div class="method-description">
-          
           <p>Loads a config file.</p>
 
 <p>@param [String] file</p>
-          
-          
 
-          
           <div class="method-source-code" id="load_config_file-source">
             <pre><span class="ruby-comment"># File lib/standup_md.rb, line 52</span>
 <span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">load_config_file</span>(<span class="ruby-identifier">file</span>)
   <span class="ruby-identifier">file</span> = <span class="ruby-operator">::</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">expand_path</span>(<span class="ruby-identifier">file</span>)
   <span class="ruby-identifier">raise</span> <span class="ruby-node">&quot;File #{file} does not exist.&quot;</span> <span class="ruby-keyword">unless</span> <span class="ruby-operator">::</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">file?</span>(<span class="ruby-identifier">file</span>)
+
   <span class="ruby-ivar">@config_file_loaded</span> = <span class="ruby-keyword">true</span>
   <span class="ruby-identifier">load</span> <span class="ruby-identifier">file</span>
 <span class="ruby-keyword">end</span></pre>
           </div>
-          
         </div>
 
-        
 
-        
       </div>
 
-    
       <div id="method-c-reset_config" class="method-detail ">
-        
         <div class="method-heading">
           <span class="method-name">reset_config</span><span
             class="method-args">()</span>
-          
           <span class="method-click-advice">click to toggle source</span>
-          
         </div>
-        
 
         <div class="method-description">
-          
           <p>Reset all configuration values to their defaults.</p>
 
 <p>@return [StandupMD::Config]</p>
-          
-          
 
-          
           <div class="method-source-code" id="reset_config-source">
             <pre><span class="ruby-comment"># File lib/standup_md.rb, line 27</span>
 <span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">reset_config</span>
   <span class="ruby-ivar">@config</span> = <span class="ruby-constant">StandupMD</span><span class="ruby-operator">::</span><span class="ruby-constant">Config</span>.<span class="ruby-identifier">new</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>