standup_md 0.1.3 → 0.2.0

data/lib/standup_md.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-
+require 'yaml'
 require 'date'
 require 'fileutils'
 require_relative 'standup_md/version'
@@ -12,19 +12,17 @@ require_relative 'standup_md/version'
 class StandupMD
 
   ##
-  # Convenience method for calling +new+ + +load+
+  # Convenience method for calling +new+ + +load+. Accepts a +YAML+ config file
+  # as an argument, and yields the standup instance if a block is given.
   #
-  # @param [Hash] attributes Attributes to set before loading.
+  # @param [String] config_file File path to config file.
   #
   # @example
   #   su = StandupMD.load(bullet_character: '*')
-  def self.load(attributes = {})
-    self.new do |s|
-      attributes.each do |k, v|
-        next unless s.respond_to?(k)
-        s.send("#{k}=", v)
-      end
-    end.load
+  def self.load(config_file = nil)
+    s = new(config_file)
+    yield s if block_given?
+    s.load
   end
 
   # :section: Attributes that aren't settable by user, but are gettable.
@@ -48,9 +46,10 @@ class StandupMD
   attr_reader :file
 
   ##
-  # The file that contains previous entries. When last month's file exists, but
-  # this month's doesn't or is empty, previous_file should equal last month's
-  # file.
+  # The file that contains the previous entry. If previous entry was same month,
+  # previous_file will be the same as file. If previous entry was last month,
+  # and a file exists for last month, previous_file is last month's file.
+  # If neither is true, returns an empty string.
   #
   # @return [String]
   #
@@ -112,6 +111,19 @@ class StandupMD
 
   # :section: Attributes that are settable by the user, but have custom setters.
 
+  ##
+  # The configuration file. Default is +nil+. If set to a string, and the file
+  # exists, it is used to set options.
+  #
+  # @return [String] file path
+  attr_reader :config_file
+
+  ##
+  # The options from +config_file+ as a hash.
+  #
+  # @return [Hash] Options from +config_file+
+  attr_reader :config
+
   ##
   # The directory where the markdown files are kept.
   #
@@ -220,17 +232,23 @@ class StandupMD
   attr_accessor :notes_header
 
   ##
-  # Constructor. Yields the instance so you can pass a block to access setters.
+  # Constructor. Takes a path to a +YAML+ configuration file as an argument. If
+  # passed, settings from the config file will be set. After +config_file+ is
+  # loaded, yields +self+ so you can pass a block to access setters,
+  # overwriting settings from +config_file+.
+  #
+  # @param [String] config_file The config file, if any, to load.
   #
   # @return [self]
   #
   # @example
-  #   su = StandupMD.new do |s|
+  #   su = StandupMD.new('~/.standup_md.yml') do |s|
   #     s.directory = @workdir
   #     s.file_name_format = '%y_%m.markdown'
   #     s.bullet_character = '*'
   #   end
-  def initialize
+  def initialize(config_file = nil)
+    @config = {}
     @notes = []
     @header_depth = 1
     @sub_header_depth = 2
@@ -245,12 +263,21 @@ class StandupMD
     @impediments_header = 'Impediments'
     @notes_header = 'Notes'
     @sub_header_order = %w[previous current impediments notes]
+    @config_file_loaded = false
+    @config_file = config_file && File.expand_path(config_file)
+
+    load_config_file if config_file
 
     yield self if block_given?
   end
 
-  # :section: Booleans
-  # Helper methods for booleans.
+  ##
+  # Has a config file been loaded?
+  #
+  # @return [Boolean]
+  def config_file_loaded?
+    @config_file_loaded
+  end
 
   ##
   # Has the file been written since instantiated?
@@ -276,9 +303,6 @@ class StandupMD
     @entry_previously_added
   end
 
-  # :section: Custom setters
-  # Setters that required validations.
-
   ##
   # Setter for current entry tasks.
   #
@@ -334,6 +358,18 @@ class StandupMD
     @bullet_character = character
   end
 
+  ##
+  # Setter for directory. Must be expanded in case the user uses `~` for home.
+  # If the directory doesn't exist, it will be created. To reset instance
+  # variables after changing the directory, you'll need to call load.
+  #
+  # @param [String] file
+  #
+  # @return [String]
+  def config_file=(config_file)
+    @config_file = File.expand_path(config_file)
+  end
+
   ##
   # Setter for directory. Must be expanded in case the user uses `~` for home.
   # If the directory doesn't exist, it will be created. To reset instance
@@ -343,7 +379,6 @@ class StandupMD
   #
   # @return [String]
   def directory=(directory)
-    # TODO test this
     directory = File.expand_path(directory)
     FileUtils.mkdir_p(directory) unless File.directory?(directory)
     @directory = directory
@@ -359,7 +394,7 @@ class StandupMD
     if !depth.between?(1, 5)
       raise 'Header depth out of bounds (1..5)'
     elsif depth >= sub_header_depth
-      raise 'header_depth must be larger than sub_header_depth'
+      @sub_header_depth = depth + 1
     end
     @header_depth = depth
   end
@@ -374,7 +409,7 @@ class StandupMD
     if !depth.between?(2, 6)
       raise 'Sub-header depth out of bounds (2..6)'
     elsif depth <= header_depth
-      raise 'sub_header_depth must be smaller than header_depth'
+      @header_depth = depth - 1
     end
     @sub_header_depth = depth
   end
@@ -391,9 +426,6 @@ class StandupMD
     @sub_header_order = array
   end
 
-  # :section: Misc
-  # Misc.
-
   ##
   # Return a copy of the sub-header order so the user can't modify the array.
   #
@@ -402,6 +434,18 @@ class StandupMD
     @sub_header_order.dup
   end
 
+  ##
+  # Loads the config file
+  #
+  # @return [Hash] The config options
+  def load_config_file
+    raise 'No config file set' if config_file.nil?
+    raise "File #{config_file} does not exist" unless File.file?(config_file)
+    @config = YAML::load_file(config_file)
+    @config_file_loaded = true
+    @config.each { |k, v| send("#{k}=", v) }
+  end
+
   ##
   # Writes a new entry to the file if the first entry in the file isn't today.
   #
@@ -477,11 +521,6 @@ class StandupMD
     @today
   end
 
-  ##
-  # The file that contains the previous entry. If previous entry was same month,
-  # previous_file will be the same as file. If previous entry was last month,
-  # and a file exists for last month, previous_file is last month's file.
-  # If neither is true, returns an empty string.
   def get_previous_file # :nodoc:
     return file if File.file?(file) && !File.zero?(file)
     prev_month_file = File.expand_path(File.join(

data/lib/standup_md/cli.rb

@@ -1,5 +1,4 @@
 require 'json'
-require 'yaml'
 require 'optparse'
 require_relative '../standup_md'
 
@@ -58,8 +57,13 @@ class StandupMD
     #
     # @return [StandupMD]
     def standup
-      @standup ||= ::StandupMD.new do |s|
-        echo 'Runtime options:'
+      cf = File.file?(PREFERENCE_FILE) ? PREFERENCE_FILE : nil
+      @standup ||= ::StandupMD.new(cf) do |s|
+        if s.config.any?
+          echo 'Config options:'
+          s.config.each { |k, v| echo "  #{k} = #{v}" }
+        end
+        echo 'Runtime options:' if preferences.any?
         preferences.each do |k, v|
           echo "  #{k} = #{v}"
           s.send("#{k}=", v)
@@ -134,7 +138,7 @@ class StandupMD
     ##
     # Opens the file in an editor. Abandons the script.
     def edit
-      echo "  Opening file in #{editor}"
+      echo "Opening file in #{editor}"
       exec("#{editor} #{standup.file}")
     end
 
@@ -143,7 +147,7 @@ class StandupMD
     #
     # @return [Boolean] true if file was written
     def write_file
-      echo '  Writing file'
+      echo 'Writing file'
       standup.write
     end
 
@@ -295,7 +299,7 @@ class StandupMD
         end
       end.parse!(options)
 
-      (File.file?(PREFERENCE_FILE) ? YAML.load_file(PREFERENCE_FILE) : {}).merge(prefs)
+      prefs
     end
   end
 end

data/lib/standup_md/version.rb

@@ -4,6 +4,6 @@ class StandupMD
   #
   # @example
   #  StandupMD::VERSION
-  #  # => '0.1.3'
-  VERSION = '0.1.3'
+  #  # => '0.2.0'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: standup_md
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Evan Gray
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-01 00:00:00.000000000 Z
+date: 2020-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -69,9 +69,6 @@ files:
 - doc/README_md.html
 - doc/StandupMD.html
 - doc/StandupMD/Cli.html
-- doc/TestCli.html
-- doc/TestHelper.html
-- doc/TestStandupMD.html
 - doc/created.rid
 - doc/css/fonts.css
 - doc/css/rdoc.css

data/doc/TestCli.html

@@ -1,792 +0,0 @@
-<!DOCTYPE html>
-
-<html>
-<head>
-<meta charset="UTF-8">
-
-<title>class TestCli - RDoc Documentation</title>
-
-<script type="text/javascript">
-  var rdoc_rel_prefix = "./";
-  var index_rel_prefix = "./";
-</script>
-
-<script src="./js/navigation.js" defer></script>
-<script src="./js/search.js" defer></script>
-<script src="./js/search_index.js" defer></script>
-<script src="./js/searcher.js" defer></script>
-<script src="./js/darkfish.js" defer></script>
-
-<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>
-    <a href="./index.html" rel="home">Home</a>
-  </h2>
-
-  <div id="table-of-contents-navigation">
-    <a href="./table_of_contents.html#pages">Pages</a>
-    <a href="./table_of_contents.html#classes">Classes</a>
-    <a href="./table_of_contents.html#methods">Methods</a>
-  </div>
-</div>
-
-    <div id="search-section" role="search" class="project-section initially-hidden">
-  <form action="#" method="get" accept-charset="utf-8">
-    <div id="search-field-wrapper">
-      <input id="search-field" role="combobox" aria-label="Search"
-             aria-autocomplete="list" aria-controls="search-results"
-             type="text" name="search" placeholder="Search" spellcheck="false"
-             title="Type to search, Up and Down to navigate, Enter to load">
-    </div>
-
-    <ul id="search-results" aria-label="Search Results"
-        aria-busy="false" aria-expanded="false"
-        aria-atomic="false" class="initially-hidden"></ul>
-  </form>
-</div>
-
-  </div>
-
-  
-
-  <div id="class-metadata">
-    
-    <div id="parent-class-section" class="nav-section">
-  <h3>Parent</h3>
-
-  
-  <p class="link">Test::Unit::TestCase
-  
-</div>
-
-    <div id="includes-section" class="nav-section">
-  <h3>Included Modules</h3>
-
-  <ul class="link-list">
-  
-  
-    <li><a class="include" href="TestHelper.html">TestHelper</a>
-  
-  
-  </ul>
-</div>
-
-    
-    <!-- Method Quickref -->
-<div id="method-list-section" class="nav-section">
-  <h3>Methods</h3>
-
-  <ul class="link-list" role="directory">
-    
-    <li ><a href="#method-i-setup">#setup</a>
-    
-    <li ><a href="#method-i-should_append-3F">#should_append?</a>
-    
-    <li ><a href="#method-i-teardown">#teardown</a>
-    
-    <li ><a href="#method-i-test_PREFERENCE_FILE">#test_PREFERENCE_FILE</a>
-    
-    <li ><a href="#method-i-test_append_previous-3F">#test_append_previous?</a>
-    
-    <li ><a href="#method-i-test_edit-3F">#test_edit?</a>
-    
-    <li ><a href="#method-i-test_editor">#test_editor</a>
-    
-    <li ><a href="#method-i-test_initialize">#test_initialize</a>
-    
-    <li ><a href="#method-i-test_json-3F">#test_json?</a>
-    
-    <li ><a href="#method-i-test_options">#test_options</a>
-    
-    <li ><a href="#method-i-test_preferences">#test_preferences</a>
-    
-    <li ><a href="#method-i-test_print_all_entries-3F">#test_print_all_entries?</a>
-    
-    <li ><a href="#method-i-test_print_current_entry-3F">#test_print_current_entry?</a>
-    
-    <li ><a href="#method-i-test_self_execute">#test_self_execute</a>
-    
-    <li ><a href="#method-i-test_standup">#test_standup</a>
-    
-    <li ><a href="#method-i-test_verbose-3F">#test_verbose?</a>
-    
-    <li ><a href="#method-i-test_write-3F">#test_write?</a>
-    
-  </ul>
-</div>
-
-  </div>
-</nav>
-
-<main role="main" aria-labelledby="class-TestCli">
-  <h1 id="class-TestCli" class="class">
-    class TestCli
-  </h1>
-
-  <section class="description">
-    
-<p>The test suite for <code>Cli</code>.</p>
-
-  </section>
-
-  
-  <section id="5Buntitled-5D" class="documentation-section">
-    
-
-    
-
-    
-
-    
-
-    
-     <section id="public-instance-5Buntitled-5D-method-details" class="method-section">
-       <header>
-         <h3>Public Instance Methods</h3>
-       </header>
-
-    
-      <div id="method-i-setup" class="method-detail ">
-        
-        <div class="method-heading">
-          <span class="method-name">setup</span><span
-            class="method-args">()</span>
-          
-          <span class="method-click-advice">click to toggle source</span>
-          
-        </div>
-        
-
-        <div class="method-description">
-          
-          <p>Set working directory, current month&#39;s file, and last month&#39;s file, which will be created and destroyed for each test.</p>
-          
-          
-
-          
-          <div class="method-source-code" id="setup-source">
-            <pre><span class="ruby-comment"># File test/standup_md/cli_test.rb, line 12</span>
-<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">setup</span>
-  <span class="ruby-ivar">@workdir</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-identifier">__dir__</span>, <span class="ruby-string">&#39;files&#39;</span>)
-  <span class="ruby-ivar">@current_test_file</span> =
-    <span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-ivar">@workdir</span>, <span class="ruby-constant">Date</span>.<span class="ruby-identifier">today</span>.<span class="ruby-identifier">strftime</span>(<span class="ruby-string">&#39;%Y_%m.md&#39;</span>))
-  <span class="ruby-ivar">@previous_month_test_file</span> =
-    <span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-ivar">@workdir</span>, <span class="ruby-constant">Date</span>.<span class="ruby-identifier">today</span>.<span class="ruby-identifier">prev_month</span>.<span class="ruby-identifier">strftime</span>(<span class="ruby-string">&#39;%Y_%m.md&#39;</span>))
-  <span class="ruby-ivar">@options</span> = [<span class="ruby-string">&#39;--no-edit&#39;</span>, <span class="ruby-string">&#39;--no-write&#39;</span>, <span class="ruby-node">&quot;--directory=#{@workdir}&quot;</span>]
-<span class="ruby-keyword">end</span></pre>
-          </div>
-          
-        </div>
-
-        
-
-        
-      </div>
-
-    
-      <div id="method-i-should_append-3F" class="method-detail ">
-        
-        <div class="method-heading">
-          <span class="method-name">should_append?</span><span
-            class="method-args">()</span>
-          
-          <span class="method-click-advice">click to toggle source</span>
-          
-        </div>
-        
-
-        <div class="method-description">
-          
-          <p>True only if <code>--no-append</code> and <code>--previous-entry-tasks</code> are passed.</p>
-          
-          
-
-          
-          <div class="method-source-code" id="should_append-3F-source">
-            <pre><span class="ruby-comment"># File test/standup_md/cli_test.rb, line 161</span>
-<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">should_append?</span>
-  <span class="ruby-identifier">c</span> = <span class="ruby-identifier">cli</span>
-  <span class="ruby-identifier">refute</span>(<span class="ruby-identifier">c</span>.<span class="ruby-identifier">should_append?</span>)
-
-  <span class="ruby-identifier">c</span> = <span class="ruby-identifier">cli</span>[<span class="ruby-string">&#39;--no-append&#39;</span>]
-  <span class="ruby-identifier">refute</span>(<span class="ruby-identifier">c</span>.<span class="ruby-identifier">should_append?</span>)
-
-  <span class="ruby-identifier">c</span> = <span class="ruby-identifier">cli</span>([<span class="ruby-string">&#39;--no-append&#39;</span>, <span class="ruby-string">&#39;--previous-entry-tasks=&quot;test one&quot;,&quot;test two&quot;&#39;</span>])
-  <span class="ruby-identifier">refute</span>(<span class="ruby-identifier">c</span>.<span class="ruby-identifier">should_append?</span>)
-
-  <span class="ruby-identifier">c</span> = <span class="ruby-identifier">cli</span>([<span class="ruby-string">&#39;--previous-entry-tasks=&quot;test one&quot;,&quot;test two&quot;&#39;</span>])
-  <span class="ruby-identifier">assert</span>(<span class="ruby-identifier">c</span>.<span class="ruby-identifier">should_append?</span>)
-<span class="ruby-keyword">end</span></pre>
-          </div>
-          
-        </div>
-
-        
-
-        
-      </div>
-
-    
-      <div id="method-i-teardown" class="method-detail ">
-        
-        <div class="method-heading">
-          <span class="method-name">teardown</span><span
-            class="method-args">()</span>
-          
-          <span class="method-click-advice">click to toggle source</span>
-          
-        </div>
-        
-
-        <div class="method-description">
-          
-          <p>Destroy the working directory and its contents.</p>
-          
-          
-
-          
-          <div class="method-source-code" id="teardown-source">
-            <pre><span class="ruby-comment"># File test/standup_md/cli_test.rb, line 23</span>
-<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">teardown</span>
-  <span class="ruby-constant">FileUtils</span>.<span class="ruby-identifier">rm_r</span>(<span class="ruby-ivar">@workdir</span>) <span class="ruby-keyword">if</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">directory?</span>(<span class="ruby-ivar">@workdir</span>)
-  <span class="ruby-constant">FileUtils</span>.<span class="ruby-identifier">rm</span>(<span class="ruby-ivar">@current_test_file</span>) <span class="ruby-keyword">if</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">file?</span>(<span class="ruby-ivar">@current_test_file</span>)
-<span class="ruby-keyword">end</span></pre>
-          </div>
-          
-        </div>
-
-        
-
-        
-      </div>
-
-    
-      <div id="method-i-test_PREFERENCE_FILE" class="method-detail ">
-        
-        <div class="method-heading">
-          <span class="method-name">test_PREFERENCE_FILE</span><span
-            class="method-args">()</span>
-          
-          <span class="method-click-advice">click to toggle source</span>
-          
-        </div>
-        
-
-        <div class="method-description">
-          
-          <p>The user&#39;s preference file is a string.</p>
-          
-          
-
-          
-          <div class="method-source-code" id="test_PREFERENCE_FILE-source">
-            <pre><span class="ruby-comment"># File test/standup_md/cli_test.rb, line 30</span>
-<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">test_PREFERENCE_FILE</span>
-  <span class="ruby-identifier">assert_equal</span>(
-    <span class="ruby-constant">File</span>.<span class="ruby-identifier">expand_path</span>(<span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-constant">ENV</span>[<span class="ruby-string">&#39;HOME&#39;</span>], <span class="ruby-string">&#39;.standup_md.yml&#39;</span>)),
-    <span class="ruby-constant">StandupMD</span><span class="ruby-operator">::</span><span class="ruby-constant">Cli</span><span class="ruby-operator">::</span><span class="ruby-constant">PREFERENCE_FILE</span>
-  )
-<span class="ruby-keyword">end</span></pre>
-          </div>
-          
-        </div>
-
-        
-
-        
-      </div>
-
-    
-      <div id="method-i-test_append_previous-3F" class="method-detail ">
-        
-        <div class="method-heading">
-          <span class="method-name">test_append_previous?</span><span
-            class="method-args">()</span>
-          
-          <span class="method-click-advice">click to toggle source</span>
-          
-        </div>
-        
-
-        <div class="method-description">
-          
-          <p>True by default. False if flag is passed.</p>
-          
-          
-
-          
-          <div class="method-source-code" id="test_append_previous-3F-source">
-            <pre><span class="ruby-comment"># File test/standup_md/cli_test.rb, line 151</span>
-<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">test_append_previous?</span>
-  <span class="ruby-identifier">c</span> = <span class="ruby-identifier">cli</span>
-  <span class="ruby-identifier">assert</span>(<span class="ruby-identifier">c</span>.<span class="ruby-identifier">append_previous?</span>)
-
-  <span class="ruby-identifier">c</span> = <span class="ruby-identifier">cli</span>([<span class="ruby-string">&#39;--no-append-previous&#39;</span>])
-  <span class="ruby-identifier">refute</span>(<span class="ruby-identifier">c</span>.<span class="ruby-identifier">append_previous?</span>)
-<span class="ruby-keyword">end</span></pre>
-          </div>
-          
-        </div>
-
-        
-
-        
-      </div>
-
-    
-      <div id="method-i-test_edit-3F" class="method-detail ">
-        
-        <div class="method-heading">
-          <span class="method-name">test_edit?</span><span
-            class="method-args">()</span>
-          
-          <span class="method-click-advice">click to toggle source</span>
-          
-        </div>
-        
-
-        <div class="method-description">
-          
-          <p>True by default. False if flag is passed.</p>
-          
-          
-
-          
-          <div class="method-source-code" id="test_edit-3F-source">
-            <pre><span class="ruby-comment"># File test/standup_md/cli_test.rb, line 141</span>
-<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">test_edit?</span>
-  <span class="ruby-identifier">c</span> = <span class="ruby-identifier">cli</span>
-  <span class="ruby-identifier">assert</span>(<span class="ruby-identifier">c</span>.<span class="ruby-identifier">edit?</span>)
-
-  <span class="ruby-identifier">c</span> = <span class="ruby-identifier">cli</span>([<span class="ruby-string">&#39;--no-edit&#39;</span>])
-  <span class="ruby-identifier">refute</span>(<span class="ruby-identifier">c</span>.<span class="ruby-identifier">edit?</span>)
-<span class="ruby-keyword">end</span></pre>
-          </div>
-          
-        </div>
-
-        
-
-        
-      </div>
-
-    
-      <div id="method-i-test_editor" class="method-detail ">
-        
-        <div class="method-heading">
-          <span class="method-name">test_editor</span><span
-            class="method-args">()</span>
-          
-          <span class="method-click-advice">click to toggle source</span>
-          
-        </div>
-        
-
-        <div class="method-description">
-          
-          <p>The editor should be set by preferences, or env, or set to &#39;vim&#39;.</p>
-          
-          
-
-          
-          <div class="method-source-code" id="test_editor-source">
-            <pre><span class="ruby-comment"># File test/standup_md/cli_test.rb, line 75</span>
-<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">test_editor</span>
-  <span class="ruby-identifier">c</span> = <span class="ruby-identifier">cli</span>
-  <span class="ruby-keyword">if</span> <span class="ruby-constant">ENV</span>[<span class="ruby-string">&#39;VISUAL&#39;</span>]
-    <span class="ruby-identifier">assert_equal</span>(<span class="ruby-constant">ENV</span>[<span class="ruby-string">&#39;VISUAL&#39;</span>], <span class="ruby-identifier">c</span>.<span class="ruby-identifier">editor</span>)
-  <span class="ruby-keyword">elsif</span> <span class="ruby-constant">ENV</span>[<span class="ruby-string">&#39;EDITOR&#39;</span>]
-    <span class="ruby-identifier">assert_equal</span>(<span class="ruby-constant">ENV</span>[<span class="ruby-string">&#39;EDITOR&#39;</span>], <span class="ruby-identifier">c</span>.<span class="ruby-identifier">editor</span>)
-  <span class="ruby-keyword">else</span>
-    <span class="ruby-identifier">assert_equal</span>(<span class="ruby-string">&#39;vim&#39;</span>, <span class="ruby-identifier">c</span>.<span class="ruby-identifier">editor</span>)
-  <span class="ruby-keyword">end</span>
-
-  <span class="ruby-identifier">c</span> = <span class="ruby-identifier">cli</span>([<span class="ruby-string">&#39;--editor=mate&#39;</span>])
-  <span class="ruby-identifier">assert_equal</span>(<span class="ruby-string">&#39;mate&#39;</span>, <span class="ruby-identifier">c</span>.<span class="ruby-identifier">editor</span>)
-<span class="ruby-keyword">end</span></pre>
-          </div>
-          
-        </div>
-
-        
-
-        
-      </div>
-
-    
-      <div id="method-i-test_initialize" class="method-detail ">
-        
-        <div class="method-heading">
-          <span class="method-name">test_initialize</span><span
-            class="method-args">()</span>
-          
-          <span class="method-click-advice">click to toggle source</span>
-          
-        </div>
-        
-
-        <div class="method-description">
-          
-          <p>The <code>initialize</code> method should accept the same parameters as <code>exectute</code>.</p>
-          
-          
-
-          
-          <div class="method-source-code" id="test_initialize-source">
-            <pre><span class="ruby-comment"># File test/standup_md/cli_test.rb, line 62</span>
-<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">test_initialize</span>
-  <span class="ruby-identifier">assert_nothing_raised</span> { <span class="ruby-constant">StandupMD</span><span class="ruby-operator">::</span><span class="ruby-constant">Cli</span>.<span class="ruby-identifier">new</span>(<span class="ruby-ivar">@options</span>) }
-<span class="ruby-keyword">end</span></pre>
-          </div>
-          
-        </div>
-
-        
-
-        
-      </div>
-
-    
-      <div id="method-i-test_json-3F" class="method-detail ">
-        
-        <div class="method-heading">
-          <span class="method-name">test_json?</span><span
-            class="method-args">()</span>
-          
-          <span class="method-click-advice">click to toggle source</span>
-          
-        </div>
-        
-
-        <div class="method-description">
-          
-          <p>False by default. True if flag is passed.</p>
-          
-          
-
-          
-          <div class="method-source-code" id="test_json-3F-source">
-            <pre><span class="ruby-comment"># File test/standup_md/cli_test.rb, line 101</span>
-<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">test_json?</span>
-  <span class="ruby-identifier">c</span> = <span class="ruby-identifier">cli</span>
-  <span class="ruby-identifier">refute</span>(<span class="ruby-identifier">c</span>.<span class="ruby-identifier">json?</span>)
-
-  <span class="ruby-identifier">c</span> = <span class="ruby-identifier">cli</span>([<span class="ruby-string">&#39;-j&#39;</span>])
-  <span class="ruby-identifier">assert</span>(<span class="ruby-identifier">c</span>.<span class="ruby-identifier">json?</span>)
-<span class="ruby-keyword">end</span></pre>
-          </div>
-          
-        </div>
-
-        
-
-        
-      </div>
-
-    
-      <div id="method-i-test_options" class="method-detail ">
-        
-        <div class="method-heading">
-          <span class="method-name">test_options</span><span
-            class="method-args">()</span>
-          
-          <span class="method-click-advice">click to toggle source</span>
-          
-        </div>
-        
-
-        <div class="method-description">
-          
-          <p>The <code>options</code> should be an array of options passed from the command line.</p>
-          
-          
-
-          
-          <div class="method-source-code" id="test_options-source">
-            <pre><span class="ruby-comment"># File test/standup_md/cli_test.rb, line 46</span>
-<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">test_options</span>
-  <span class="ruby-identifier">c</span> = <span class="ruby-identifier">cli</span>(<span class="ruby-ivar">@options</span>)
-  <span class="ruby-identifier">assert_equal</span>(<span class="ruby-ivar">@options</span>, <span class="ruby-identifier">c</span>.<span class="ruby-identifier">options</span>)
-<span class="ruby-keyword">end</span></pre>
-          </div>
-          
-        </div>
-
-        
-
-        
-      </div>
-
-    
-      <div id="method-i-test_preferences" class="method-detail ">
-        
-        <div class="method-heading">
-          <span class="method-name">test_preferences</span><span
-            class="method-args">()</span>
-          
-          <span class="method-click-advice">click to toggle source</span>
-          
-        </div>
-        
-
-        <div class="method-description">
-          
-          <p>The <code>preferences</code> are the settings after <code>options</code> are parsed.</p>
-          
-          
-
-          
-          <div class="method-source-code" id="test_preferences-source">
-            <pre><span class="ruby-comment"># File test/standup_md/cli_test.rb, line 53</span>
-<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">test_preferences</span>
-  <span class="ruby-identifier">c</span> = <span class="ruby-identifier">cli</span>(<span class="ruby-ivar">@options</span>)
-  <span class="ruby-identifier">assert_equal</span>(<span class="ruby-keyword">false</span>, <span class="ruby-identifier">c</span>.<span class="ruby-identifier">instance_variable_get</span>(<span class="ruby-string">&#39;@write&#39;</span>))
-  <span class="ruby-identifier">assert_equal</span>(<span class="ruby-keyword">false</span>, <span class="ruby-identifier">c</span>.<span class="ruby-identifier">instance_variable_get</span>(<span class="ruby-string">&#39;@edit&#39;</span>))
-  <span class="ruby-identifier">assert_equal</span>(<span class="ruby-ivar">@workdir</span>, <span class="ruby-identifier">c</span>.<span class="ruby-identifier">preferences</span>[<span class="ruby-string">&#39;directory&#39;</span>])
-<span class="ruby-keyword">end</span></pre>
-          </div>
-          
-        </div>
-
-        
-
-        
-      </div>
-
-    
-      <div id="method-i-test_print_all_entries-3F" class="method-detail ">
-        
-        <div class="method-heading">
-          <span class="method-name">test_print_all_entries?</span><span
-            class="method-args">()</span>
-          
-          <span class="method-click-advice">click to toggle source</span>
-          
-        </div>
-        
-
-        <div class="method-description">
-          
-          <p>False by default. True if flag is passed.</p>
-          
-          
-
-          
-          <div class="method-source-code" id="test_print_all_entries-3F-source">
-            <pre><span class="ruby-comment"># File test/standup_md/cli_test.rb, line 111</span>
-<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">test_print_all_entries?</span>
-  <span class="ruby-identifier">c</span> = <span class="ruby-identifier">cli</span>
-  <span class="ruby-identifier">refute</span>(<span class="ruby-identifier">c</span>.<span class="ruby-identifier">print_all_entries?</span>)
-
-  <span class="ruby-identifier">c</span> = <span class="ruby-identifier">cli</span>([<span class="ruby-string">&#39;-a&#39;</span>])
-  <span class="ruby-identifier">assert</span>(<span class="ruby-identifier">c</span>.<span class="ruby-identifier">print_all_entries?</span>)
-<span class="ruby-keyword">end</span></pre>
-          </div>
-          
-        </div>
-
-        
-
-        
-      </div>
-
-    
-      <div id="method-i-test_print_current_entry-3F" class="method-detail ">
-        
-        <div class="method-heading">
-          <span class="method-name">test_print_current_entry?</span><span
-            class="method-args">()</span>
-          
-          <span class="method-click-advice">click to toggle source</span>
-          
-        </div>
-        
-
-        <div class="method-description">
-          
-          <p>False by default. True if flag is passed.</p>
-          
-          
-
-          
-          <div class="method-source-code" id="test_print_current_entry-3F-source">
-            <pre><span class="ruby-comment"># File test/standup_md/cli_test.rb, line 91</span>
-<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">test_print_current_entry?</span>
-  <span class="ruby-identifier">c</span> = <span class="ruby-identifier">cli</span>
-  <span class="ruby-identifier">refute</span>(<span class="ruby-identifier">c</span>.<span class="ruby-identifier">print_current_entry?</span>)
-
-  <span class="ruby-identifier">c</span> = <span class="ruby-identifier">cli</span>([<span class="ruby-string">&#39;-c&#39;</span>])
-  <span class="ruby-identifier">assert</span>(<span class="ruby-identifier">c</span>.<span class="ruby-identifier">print_current_entry?</span>)
-<span class="ruby-keyword">end</span></pre>
-          </div>
-          
-        </div>
-
-        
-
-        
-      </div>
-
-    
-      <div id="method-i-test_self_execute" class="method-detail ">
-        
-        <div class="method-heading">
-          <span class="method-name">test_self_execute</span><span
-            class="method-args">()</span>
-          
-          <span class="method-click-advice">click to toggle source</span>
-          
-        </div>
-        
-
-        <div class="method-description">
-          
-          <p>The <code>execute</code> method is the entry point for the Cli. It&#39;s parameter is an array of command-line flags</p>
-          
-          
-
-          
-          <div class="method-source-code" id="test_self_execute-source">
-            <pre><span class="ruby-comment"># File test/standup_md/cli_test.rb, line 40</span>
-<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">test_self_execute</span>
-  <span class="ruby-identifier">assert_nothing_raised</span> { <span class="ruby-constant">StandupMD</span><span class="ruby-operator">::</span><span class="ruby-constant">Cli</span>.<span class="ruby-identifier">execute</span>(<span class="ruby-ivar">@options</span>) }
-<span class="ruby-keyword">end</span></pre>
-          </div>
-          
-        </div>
-
-        
-
-        
-      </div>
-
-    
-      <div id="method-i-test_standup" class="method-detail ">
-        
-        <div class="method-heading">
-          <span class="method-name">test_standup</span><span
-            class="method-args">()</span>
-          
-          <span class="method-click-advice">click to toggle source</span>
-          
-        </div>
-        
-
-        <div class="method-description">
-          
-          <p>Creates the instance of <code>StandupMD</code>.</p>
-          
-          
-
-          
-          <div class="method-source-code" id="test_standup-source">
-            <pre><span class="ruby-comment"># File test/standup_md/cli_test.rb, line 68</span>
-<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">test_standup</span>
-  <span class="ruby-identifier">c</span> = <span class="ruby-identifier">cli</span>
-  <span class="ruby-identifier">assert_instance_of</span>(<span class="ruby-constant">StandupMD</span>, <span class="ruby-identifier">c</span>.<span class="ruby-identifier">standup</span>)
-<span class="ruby-keyword">end</span></pre>
-          </div>
-          
-        </div>
-
-        
-
-        
-      </div>
-
-    
-      <div id="method-i-test_verbose-3F" class="method-detail ">
-        
-        <div class="method-heading">
-          <span class="method-name">test_verbose?</span><span
-            class="method-args">()</span>
-          
-          <span class="method-click-advice">click to toggle source</span>
-          
-        </div>
-        
-
-        <div class="method-description">
-          
-          <p>False by default. True if flag is passed.</p>
-          
-          
-
-          
-          <div class="method-source-code" id="test_verbose-3F-source">
-            <pre><span class="ruby-comment"># File test/standup_md/cli_test.rb, line 121</span>
-<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">test_verbose?</span>
-  <span class="ruby-identifier">c</span> = <span class="ruby-identifier">cli</span>
-  <span class="ruby-identifier">refute</span>(<span class="ruby-identifier">c</span>.<span class="ruby-identifier">verbose?</span>)
-
-  <span class="ruby-identifier">c</span> = <span class="ruby-identifier">cli</span>([<span class="ruby-string">&#39;-v&#39;</span>])
-  <span class="ruby-identifier">assert</span>(<span class="ruby-identifier">c</span>.<span class="ruby-identifier">verbose?</span>)
-<span class="ruby-keyword">end</span></pre>
-          </div>
-          
-        </div>
-
-        
-
-        
-      </div>
-
-    
-      <div id="method-i-test_write-3F" class="method-detail ">
-        
-        <div class="method-heading">
-          <span class="method-name">test_write?</span><span
-            class="method-args">()</span>
-          
-          <span class="method-click-advice">click to toggle source</span>
-          
-        </div>
-        
-
-        <div class="method-description">
-          
-          <p>True by default. False if flag is passed.</p>
-          
-          
-
-          
-          <div class="method-source-code" id="test_write-3F-source">
-            <pre><span class="ruby-comment"># File test/standup_md/cli_test.rb, line 131</span>
-<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">test_write?</span>
-  <span class="ruby-identifier">c</span> = <span class="ruby-identifier">cli</span>
-  <span class="ruby-identifier">assert</span>(<span class="ruby-identifier">c</span>.<span class="ruby-identifier">write?</span>)
-
-  <span class="ruby-identifier">c</span> = <span class="ruby-identifier">cli</span>([<span class="ruby-string">&#39;--no-write&#39;</span>])
-  <span class="ruby-identifier">refute</span>(<span class="ruby-identifier">c</span>.<span class="ruby-identifier">write?</span>)
-<span class="ruby-keyword">end</span></pre>
-          </div>
-          
-        </div>
-
-        
-
-        
-      </div>
-
-    
-    </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>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
-</footer>
-