standup_md 0.3.16 → 0.3.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 171d0b1fdd697049f52d50db4d1b0ccb95db648dc70b67957c612ebdf74c57b2
-  data.tar.gz: 1c2347af65439e1d8263715eeb3d9b45b4cbc020793ddb1a51dbbd71ee71159b
+  metadata.gz: f155bb0cdeacfcf00716bfd5cfbc67a9e5d6d1d8be2b89c35d0f148ec782b264
+  data.tar.gz: fa9f7a3d971f45f79f2f819fcaa05c761bdf2cd3d9b4de3abc942b320ca4765d
 SHA512:
-  metadata.gz: faca92ff7d839b8fb83c579bc203ba3477e975d225f2fd7ef5c3c8b37625a674ed6a7e89e7f9033c2169f5cc6f52c0e7ae9a046fb29880bd95f1ac7a56bc400c
-  data.tar.gz: f365e31e43288e039e9c35b887f905a5def1233200d34fead1a250df79215f107cc5ff16534e503d074f1e2b29620fad64b285f94ce68042226cc3a6a1e04fcf
+  metadata.gz: b22a137af1ae2a03cead81ffce5b46f517721dd22f5364318e595ebe7e22d6b9eb7e2ed05021acaec9a3f5d0f76769c98d73a898ee908be58656c4d7f01a60f8
+  data.tar.gz: 5cbbf132c3cbec6e1b6290c1d1b13f8c7f8f25aa6b02d0e51052964b4688dcad7350488cc17810b1f87a9098bdcba21824e752c9fd7bbc71e21d3edeb86ab112

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    standup_md (0.3.16)
+    standup_md (0.3.17)
 
 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 (0.3.16)
+  standup_md (0.3.17)
   stringio (3.2.0) sha256=c37cb2e58b4ffbd33fe5cd948c05934af997b36e0b6ca6fdf43afa234cf222e1
   test-unit (3.7.8) sha256=689d1ca53f4d46f678b4e5d68d8e4294f87fc5e8b9238cc4de7c5727e8d65943
   tsort (0.2.0) sha256=9650a793f6859a43b6641671278f79cfead60ac714148aabe4e3f0060480089f

data/README.md

@@ -59,6 +59,17 @@ cd standup_md
 rake install
 ```
 
+### Zsh Completion
+The gem ships with a zsh completion file at `completion/zsh/_standup`. RubyGems
+doesn't automatically add gem-provided completion directories to zsh's `fpath`,
+so you'll need to add the completion directory yourself after installation.
+
+For setup instructions and example, run the following.
+
+```sh
+standup --zsh-completion
+```
+
 ## Usage
 ### Command Line
 For the most basic usage, simply call the executable.
@@ -214,6 +225,7 @@ Some of these options can be changed at runtime. They are as follows.
 -a  --[no-]auto-fill-previous  Auto-generate 'previous' tasks for new entries
 -e  --[no-]edit                Open the file in the editor. Default is true
 -v, --[no-]verbose             Verbose output. Default is false.
+    --zsh-completion           Print zsh completion setup instructions
 -p, --print [DATE]             Print current entry.
                                If DATE is passed, will print entry for DATE, if it exists.
                                DATE must be in the same format as file-name-format

data/completion/zsh/_standup

@@ -0,0 +1,80 @@
+#compdef standup
+
+_standup_array_values() {
+  _message -e values 'comma-separated list'
+}
+
+_standup_sub_header_order() {
+  local -a headers
+
+  headers=(
+    'previous:previous entry tasks'
+    'current:current entry tasks'
+    'impediments:current entry impediments'
+    'notes:current entry notes'
+  )
+
+  _values -s , 'sub-header' $headers
+}
+
+_standup_dates() {
+  local directory="${STANDUP_MD_DIR:-$HOME/.cache/standup_md}"
+  local index
+  local file
+  local -a dates
+
+  for (( index = 1; index <= $#words; index++ )); do
+    case "$words[index]" in
+      --directory=*)
+        directory="${words[index]#--directory=}"
+        ;;
+      --directory|-d)
+        if (( index < $#words )); then
+          directory="$words[index + 1]"
+        fi
+        ;;
+    esac
+  done
+
+  directory=${~directory}
+  if [[ -d "$directory" ]]; then
+    for file in "$directory"/*.md(N); do
+      file="${file:t:r}"
+      if [[ "$file" == <->_<-> ]]; then
+        dates+=("${file/_/-}:standup file ${file}.md")
+      fi
+    done
+  fi
+
+  if (( ${#dates} )); then
+    _describe -t dates 'standup date' dates
+  else
+    _message -e dates 'date (YYYY-MM or YYYY-MM-DD)'
+  fi
+}
+
+_arguments -s -S \
+  '(- *)'{-h,--help}'[show help]' \
+  '(- *)--version[show version]' \
+  '(- *)--zsh-completion[print zsh completion setup instructions]' \
+  '--current[List of current entry tasks]:tasks:_standup_array_values' \
+  '--previous[List of previous entry tasks]:tasks:_standup_array_values' \
+  '--impediments[List of impediments for current entry]:impediments:_standup_array_values' \
+  '--notes[List of notes for current entry]:notes:_standup_array_values' \
+  '--sub-header-order[The order of the sub-headers when writing the file]:sub-header order:_standup_sub_header_order' \
+  '(-f --file-name-format)-f[Date-formattable string to use for standup file name]:strftime format:' \
+  '(-f --file-name-format)--file-name-format[Date-formattable string to use for standup file name]:strftime format:' \
+  '(-E --editor)-E[Editor to use for opening standup files]:editor:_path_commands' \
+  '(-E --editor)--editor[Editor to use for opening standup files]:editor:_path_commands' \
+  '(-d --directory)-d[The directory where standup files are located]:directory:_directories' \
+  '(-d --directory)--directory[The directory where standup files are located]:directory:_directories' \
+  '(-w --write --no-write)'{-w,--write}'[write current entry if it does not exist]' \
+  '(-w --write --no-write)--no-write[do not write current entry if it does not exist]' \
+  '(-a --auto-fill-previous --no-auto-fill-previous)'{-a,--auto-fill-previous}'[auto-generate previous tasks for new entries]' \
+  '(-a --auto-fill-previous --no-auto-fill-previous)--no-auto-fill-previous[do not auto-generate previous tasks for new entries]' \
+  '(-e --edit --no-edit)'{-e,--edit}'[open the file in the editor]' \
+  '(-e --edit --no-edit)--no-edit[do not open the file in the editor]' \
+  '(-v --verbose --no-verbose)'{-v,--verbose}'[use verbose output]' \
+  '(-v --verbose --no-verbose)--no-verbose[disable verbose output]' \
+  '(-p --print)'{-p,--print}'[print current entry]::date:_standup_dates' \
+  '1:standup file date:_standup_dates'

data/lib/standup_md/cli/helpers.rb

@@ -104,6 +104,11 @@ module StandupMD
             "Verbose output. Default is false."
           ) { |v| config.cli.verbose = v }
 
+          opts.on(
+            "--zsh-completion",
+            "Print zsh completion setup instructions"
+          ) { @zsh_completion_requested = true }
+
           opts.on(
             "-p", "--print [DATE]",
             "Print current entry.",
@@ -115,6 +120,12 @@ module StandupMD
               v.nil? ? Date.today : Date.strptime(v, config.file.header_date_format)
           end
         end.parse!(options)
+        if zsh_completion_requested?
+          raise OptionParser::InvalidArgument, options.join(" ") unless options.empty?
+
+          return
+        end
+
         unless options.empty?
           @file_date_argument = true
           config.cli.date = parse_file_date(options.shift)

data/lib/standup_md/cli.rb

@@ -9,6 +9,10 @@ module StandupMD
   class Cli
     include Helpers
 
+    ZSH_COMPLETION_FILE = ::File.expand_path(
+      ::File.join(__dir__, "..", "..", "completion", "zsh", "_standup")
+    ).freeze
+
     ##
     # Access to the class's configuration.
     #
@@ -25,10 +29,45 @@ module StandupMD
       puts msg if config.verbose
     end
 
+    ##
+    # Prints zsh completion setup instructions.
+    #
+    # @return [String]
+    def self.zsh_completion_instructions
+      completion_dir = ::File.dirname(ZSH_COMPLETION_FILE)
+
+      <<~INSTRUCTIONS
+        Zsh completion file:
+          #{ZSH_COMPLETION_FILE}
+
+        To load it directly, add this before compinit runs:
+
+          fpath=("#{completion_dir}" $fpath)
+          autoload -Uz compinit
+          compinit
+
+        Or symlink it into your own completion directory:
+
+          mkdir -p ~/.zsh/completions
+          ln -sf "#{ZSH_COMPLETION_FILE}" ~/.zsh/completions/_standup
+
+        Then make sure that directory is in fpath before compinit runs:
+
+          fpath=(~/.zsh/completions $fpath)
+          autoload -Uz compinit
+          compinit
+      INSTRUCTIONS
+    end
+
     ##
     # Creates an instance of +StandupMD+ and runs what the user requested.
     def self.execute(options = [])
       new(options).tap do |exe|
+        if exe.zsh_completion_requested?
+          puts zsh_completion_instructions
+          next
+        end
+
         exe.write_file if exe.write?
         if config.print
           exe.print(exe.entry)
@@ -64,6 +103,14 @@ module StandupMD
       @file_date_argument
     end
 
+    ##
+    # Was zsh completion output requested?
+    #
+    # @return [Boolean]
+    def zsh_completion_requested?
+      @zsh_completion_requested
+    end
+
     ##
     # Constructor. Sets defaults.
     #
@@ -72,9 +119,14 @@ module StandupMD
       @config = self.class.config
       @preference_file_loaded = false
       @file_date_argument = false
+      @zsh_completion_requested = false
       @options = options
+      return if load_zsh_completion_request(options)
+
       load_preferences if load_config
       load_runtime_preferences(options)
+      return if zsh_completion_requested?
+
       @file = find_file
       @file&.load
       @entry = @file.nil? ? nil : new_entry(@file)
@@ -137,6 +189,19 @@ module StandupMD
 
     private
 
+    ##
+    # Detects zsh completion setup requests before loading user preferences.
+    #
+    # @return [Boolean]
+    def load_zsh_completion_request(options)
+      return false unless options.include?("--zsh-completion")
+
+      invalid_options = options - ["--zsh-completion"]
+      raise OptionParser::InvalidArgument, invalid_options.join(" ") unless invalid_options.empty?
+
+      @zsh_completion_requested = true
+    end
+
     ##
     # Is this a read-only action?
     #

data/lib/standup_md/version.rb

@@ -21,7 +21,7 @@ module StandupMD
     # Patch version.
     #
     # @return [Integer]
-    PATCH = 16
+    PATCH = 17
 
     ##
     # Version as +[MAJOR, MINOR, PATCH]+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: standup_md
 version: !ruby/object:Gem::Version
-  version: 0.3.16
+  version: 0.3.17
 platform: ruby
 authors:
 - Evan Gray
@@ -107,6 +107,7 @@ files:
 - Rakefile
 - _config.yml
 - bin/standup
+- completion/zsh/_standup
 - lib/standup_md.rb
 - lib/standup_md/cli.rb
 - lib/standup_md/cli/helpers.rb