standup_md 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2734d31b2ce72d31aceeb789f562b015c4f0e7422b3a755992df7c1f293a7051
-  data.tar.gz: 651d1f6f9a613366b90e2b26ba83b8e05dd80dbc5d8bde3a0fcc7d07b57acef1
+  metadata.gz: 74c06f0aa4db099f1e64131fdd7e184dd8270db7ee99dd97f9c2cd97374ccef1
+  data.tar.gz: 71e038fce40a7f972b058baee23a7cfbbc1b2eabdbb8f0ccee466ea6fdf70345
 SHA512:
-  metadata.gz: 5df3037a20d107f82cc34533f89ab8c31a2ba13eb8180b5931b052c500c5c1f7c4922d22ffed254c5fb9e9d7623b5bb207ed5d5c0c22773bcc972a91bba061d4
-  data.tar.gz: c99e5cf930d4dcf84e6089d458321b00f427ab0c124ecf3b02b8e98d79ba416d5c629793f6f77a8cf1a0337b05ed620600833f1ad8fa2775d7e6eb7205ec22ed
+  metadata.gz: 6321c1cf53d23f8a2cd05f191f87059bc9ac308951373ab391ef53c844289098b1edcd4fcb6ef107d7f5bea9f124f7cbd105d75c3d40c2f3fe689427be783264
+  data.tar.gz: 8cefeb0ac1a75a8313ebdaabed8edfdf5b928b73c625c3f3bafebe1b330fafe6d44de2ebc26aee9379ce811b376eac601edd23dc4870c6fafc9b5acc0babf1aa

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    standup_md (1.0.0)
+    standup_md (1.0.1)
 
 GEM
   remote: https://rubygems.org/
@@ -115,7 +115,7 @@ CHECKSUMS
   standard (1.54.0) sha256=7a4b08f83d9893083c8f03bc486f0feeb6a84d48233b40829c03ef4767ea0100
   standard-custom (1.0.2) sha256=424adc84179a074f1a2a309bb9cf7cd6bfdb2b6541f20c6bf9436c0ba22a652b
   standard-performance (1.9.0) sha256=49483d31be448292951d80e5e67cdcb576c2502103c7b40aec6f1b6e9c88e3f2
-  standup_md (1.0.0)
+  standup_md (1.0.1)
   stringio (3.2.0) sha256=c37cb2e58b4ffbd33fe5cd948c05934af997b36e0b6ca6fdf43afa234cf222e1
   test-unit (3.7.8) sha256=689d1ca53f4d46f678b4e5d68d8e4294f87fc5e8b9238cc4de7c5727e8d65943
   tsort (0.2.0) sha256=9650a793f6859a43b6641671278f79cfead60ac714148aabe4e3f0060480089f

data/README.md

@@ -1,7 +1,8 @@
 # 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)
+[![Gem Version](https://img.shields.io/gem/v/standup_md.svg)](https://rubygems.org/gems/standup_md)
+![Language: Ruby](https://img.shields.io/static/v1?label=language&message=Ruby&color=CC342D&style=flat&logo=ruby&logoColor=CC342D)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
 > The cure for all your standup woes.
@@ -151,16 +152,7 @@ You'll notice, a lot of settings don't have the ability to be changed at runtime
 when calling the executable. This is because the file structure is very
 important, and changing values that affect formatting will cause problems with
 the file parser. If you don't want to use a default, make the change in your
-config file before you start editing standups. There is an [open
-issue](https://github.com/evanthegrayt/standup_md/issues/16) for handling this
-for the user, but they're not available yet.
-
-There are no options to change the headers at runtime because it uses the
-headers to detect tasks from previous entries. If changed at runtime, this would
-cause errors. For this reason, if you don't like the default headers, change
-them in your configuration file after installation, and then try to not change
-them again.
-
+config file before you start editing standups.
 
 #### Available Config File Options and Defaults
 For command-line usage, this file needs to be named `~/.standuprc`. To use in a
@@ -215,7 +207,7 @@ 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
+    --previous ARRAY           List of previous entry's tasks
     --impediments ARRAY        List of impediments for current entry
     --notes ARRAY              List of notes for current entry
     --sub-header-order ARRAY   The order of the sub-headers when writing the file

data/lib/standup_md/cli/helpers.rb

@@ -18,11 +18,11 @@ module StandupMD
 
         puts header(entry)
         config.file.sub_header_order.each do |header_type|
-          tasks = entry.public_send(header_type)
-          next if !tasks || tasks.empty?
+          tasks = entry.public_send("#{header_type}_tasks")
+          next if tasks.empty?
 
           puts sub_header(header_type)
-          entry.public_send("#{header_type}_tasks").each do |task|
+          tasks.each do |task|
             puts parser.task_line(task)
           end
         end
@@ -55,7 +55,7 @@ module StandupMD
 
           opts.on(
             "--previous ARRAY", Array,
-            "List of precious entry's tasks"
+            "List of previous entry's tasks"
           ) { |v| config.entry.previous = v }
 
           opts.on(
@@ -160,14 +160,14 @@ module StandupMD
       end
 
       ##
-      # The "previous" entries.
+      # The "previous" tasks.
       #
       # @return [Array]
       def previous_entry(file)
-        return config.entry.previous_entry unless config.cli.auto_fill_previous
-        return prev_entry(prev_file.load.entries) if file.new? && prev_file
+        return config.entry.previous unless config.cli.auto_fill_previous
+        return prev_entry_tasks(prev_file.load.entries) if file.new? && prev_file
 
-        prev_entry(file.entries)
+        prev_entry_tasks(file.entries)
       end
 
       ##
@@ -190,13 +190,13 @@ module StandupMD
       end
 
       ##
-      # The previous entry.
+      # The previous entry's current tasks.
       #
       # @param [StandupMD::EntryList] entries
       #
-      # @return [StandupMD::Entry]
-      def prev_entry(entries)
-        entries.empty? ? [] : entries.last.current
+      # @return [Array<StandupMD::Task>]
+      def prev_entry_tasks(entries)
+        entries.empty? ? [] : entries.last.current_tasks
       end
 
       ##

data/lib/standup_md/cli.rb

@@ -9,6 +9,10 @@ module StandupMD
   class Cli
     include Helpers
 
+    ##
+    # Path to the bundled zsh completion script.
+    #
+    # @return [String]
     ZSH_COMPLETION_FILE = ::File.expand_path(
       ::File.join(__dir__, "..", "..", "completion", "zsh", "_standup")
     ).freeze

data/lib/standup_md/entry.rb

@@ -10,6 +10,10 @@ module StandupMD
   class Entry
     include Comparable
 
+    ##
+    # Section identifiers supported by each standup entry.
+    #
+    # @return [Array<Symbol>]
     SECTION_TYPES = %i[current previous impediments notes].freeze
 
     ##

data/lib/standup_md/parsers/markdown.rb

@@ -8,6 +8,8 @@ require "standup_md/task"
 require "standup_md/title"
 
 module StandupMD
+  ##
+  # Namespace for standup file parsers and renderers.
   module Parsers
     ##
     # Parser and renderer for the markdown standup format.

data/lib/standup_md/version.rb

@@ -21,7 +21,7 @@ module StandupMD
     # Patch version.
     #
     # @return [Integer]
-    PATCH = 0
+    PATCH = 1
 
     ##
     # Version as +[MAJOR, MINOR, PATCH]+
@@ -48,5 +48,9 @@ module StandupMD
     end
   end
 
+  ##
+  # Full gem version string.
+  #
+  # @return [String]
   VERSION = StandupMD::Version.to_s
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: standup_md
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Evan Gray