standup_md 1.0.0 → 2.0.0

data/lib/standup_md/cli/helpers.rb

@@ -1,11 +1,12 @@
 # frozen_string_literal: true
 
 require "standup_md/parsers/markdown"
+require "standup_md/post"
 
 module StandupMD
   class Cli
     ##
-    # Module responsible for reading and writing standup files.
+    # Helpers for CLI commands and option handling.
     module Helpers
       ##
       # Print an entry to the command line.
@@ -16,17 +17,26 @@ module StandupMD
       def print(entry)
         return puts "No record found for #{config.cli.date}" if entry.nil?
 
-        puts header(entry)
-        config.file.sub_header_order.each do |header_type|
-          tasks = entry.public_send(header_type)
-          next if !tasks || tasks.empty?
+        $stdout.print markdown.render_entry(entry)
+      end
 
-          puts sub_header(header_type)
-          entry.public_send("#{header_type}_tasks").each do |task|
-            puts parser.task_line(task)
-          end
-        end
-        puts
+      ##
+      # Post an entry to the configured chat adapter.
+      #
+      # @param [StandupMD::Entry] entry
+      #
+      # @return [StandupMD::Post::Result, nil]
+      def post(entry)
+        return puts "No record found for #{config.cli.date}" if entry.nil?
+
+        result = StandupMD::Post.post(
+          entry,
+          adapter: config.cli.post_adapter,
+          channel: config.cli.post_channel,
+          config: config
+        )
+        puts "Could not post to #{result.adapter}: #{result.error}" if result.failure?
+        result
       end
 
       private
@@ -36,12 +46,12 @@ module StandupMD
       #
       # @return [StandupMD::Config]
       def config # :nodoc:
-        StandupMD.config
+        @config
       end
 
       ##
-      # Parses options passed at runtime and concatenates them with the options
-      # in the user's preferences file. Reveal source to see options.
+      # Parses options passed at runtime into this CLI invocation's config
+      # snapshot. Reveal source to see options.
       #
       # @return [Hash]
       def load_runtime_preferences(options)
@@ -55,7 +65,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(
@@ -68,21 +78,6 @@ module StandupMD
             "List of notes for current entry"
           ) { |v| config.entry.notes = v }
 
-          opts.on(
-            "--sub-header-order ARRAY", Array,
-            "The order of the sub-headers when writing the file"
-          ) { |v| config.file.sub_header_order = v }
-
-          opts.on(
-            "--indent-width INTEGER", Integer,
-            "Number of spaces used for each nested task level"
-          ) { |v| config.file.indent_width = v }
-
-          opts.on(
-            "-f", "--file-name-format STRING",
-            "Date-formattable string to use for standup file name"
-          ) { |v| config.file.name_format = v }
-
           opts.on(
             "-E", "--editor EDITOR",
             "Editor to use for opening standup files"
@@ -90,7 +85,7 @@ module StandupMD
 
           opts.on(
             "-d", "--directory DIRECTORY",
-            "The directories where standup files are located"
+            "The directory where standup files are located"
           ) { |v| config.file.directory = v }
 
           opts.on(
@@ -122,12 +117,26 @@ module StandupMD
             "-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"
+            "DATE must be in the same format as the entry header date."
           ) do |v|
             config.cli.print = true
             config.cli.date =
               v.nil? ? Date.today : Date.strptime(v, config.file.header_date_format)
           end
+
+          opts.on(
+            "-P", "--post [PLATFORM]",
+            "Post current entry to a chat client. Defaults to Slack.",
+            "If PLATFORM is passed, use that post adapter."
+          ) do |v|
+            config.cli.post = true
+            config.cli.post_adapter = v.nil? ? config.post.default_adapter : v.to_sym
+          end
+
+          opts.on(
+            "--post-channel CHANNEL",
+            "Channel, room, or conversation to post to"
+          ) { |v| config.cli.post_channel = v }
         end.parse!(options)
         if zsh_completion_requested?
           raise OptionParser::InvalidArgument, options.join(" ") unless options.empty?
@@ -160,14 +169,17 @@ 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
+        if file.new?
+          previous_file = prev_file_exists?
+          return prev_entry_tasks(previous_file.load.entries) if previous_file
+        end
 
-        prev_entry(file.entries)
+        prev_entry_tasks(file.entries)
       end
 
       ##
@@ -190,46 +202,36 @@ 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
 
       ##
       # The previous month's file.
       #
+      # @param [StandupMD::Config::File] config
+      #
       # @return [StandupMD::File]
-      def prev_file
-        StandupMD::File.find_by_date(Date.today.prev_month)
+      def prev_file(config: self.config.file)
+        StandupMD::File.find_by_date(Date.today.prev_month, config: config)
       end
 
-      ##
-      # The header.
-      #
-      # @param [StandupMD::Entry] entry
-      #
-      # @return [String]
-      def header(entry)
-        "#" * config.file.header_depth + " " +
-          entry.date.strftime(config.file.header_date_format)
+      def prev_file_exists?
+        without_file_creation { |file_config| prev_file(config: file_config) }
+      rescue StandupMD::File::NotFoundError
+        nil
       end
 
       ##
-      # The sub-header.
+      # Markdown renderer used for CLI output.
       #
-      # @param [String] header_type
-      #
-      # @return [String]
-      def sub_header(header_type)
-        "#" * config.file.sub_header_depth + " " +
-          config.file.public_send("#{header_type}_header")
-      end
-
-      def parser
+      # @return [StandupMD::Parsers::Markdown]
+      def markdown
         StandupMD::Parsers::Markdown.new(config.file)
       end
     end

data/lib/standup_md/cli.rb

@@ -5,10 +5,14 @@ require "standup_md/cli/helpers"
 
 module StandupMD
   ##
-  # Class for handing the command-line interface.
+  # Class for handling the command-line interface.
   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
@@ -18,7 +22,7 @@ module StandupMD
     #
     # @return [StandupMD::Config::Cli]
     def self.config
-      @config ||= StandupMD.config.cli
+      StandupMD.config.cli
     end
 
     ##
@@ -69,14 +73,22 @@ module StandupMD
         end
 
         exe.write_file if exe.write?
-        if config.print
+        if exe.config.cli.print
           exe.print(exe.entry)
-        elsif config.edit
+        elsif exe.config.cli.post
+          exe.post(exe.entry)
+        elsif exe.config.cli.edit
           exe.edit
         end
       end
     end
 
+    ##
+    # Runtime configuration snapshot for this CLI invocation.
+    #
+    # @return [StandupMD::Config]
+    attr_reader :config
+
     ##
     # The entry searched for, usually today.
     #
@@ -116,7 +128,7 @@ module StandupMD
     #
     # @param [Array] options
     def initialize(options = [], load_config: true)
-      @config = self.class.config
+      @config = nil
       @preference_file_loaded = false
       @file_date_argument = false
       @zsh_completion_requested = false
@@ -124,6 +136,7 @@ module StandupMD
       return if load_zsh_completion_request(options)
 
       load_preferences if load_config
+      @config = StandupMD.config.copy
       load_runtime_preferences(options)
       return if zsh_completion_requested?
 
@@ -137,11 +150,12 @@ module StandupMD
     #
     # @return [nil]
     def load_preferences
-      if ::File.exist?(@config.preference_file)
-        ::StandupMD.load_config_file(@config.preference_file)
+      preference_file = StandupMD.config.cli.preference_file
+      if ::File.exist?(preference_file)
+        ::StandupMD.load_config_file(preference_file)
         @preference_file_loaded = true
       else
-        echo "Preference file #{@config.preference_file} does not exist."
+        self.class.echo "Preference file #{preference_file} does not exist."
       end
     end
 
@@ -158,8 +172,8 @@ module StandupMD
     #
     # @return [nil]
     def edit
-      echo "Opening file in #{@config.editor}"
-      exec("#{@config.editor} #{file.name}")
+      echo "Opening file in #{@config.cli.editor}"
+      exec("#{@config.cli.editor} #{file.name}")
     end
 
     ##
@@ -176,7 +190,15 @@ module StandupMD
     #
     # @return [Boolean]
     def write?
-      !!(@config.write && !read_only? && entry)
+      !!(@config.cli.write && !read_only? && entry)
+    end
+
+    ##
+    # Should the CLI post the entry to a chat adapter?
+    #
+    # @return [Boolean]
+    def post?
+      @config.cli.post
     end
 
     ##
@@ -184,7 +206,7 @@ module StandupMD
     #
     # @return [nil]
     def echo(msg)
-      self.class.echo(msg)
+      puts msg if @config&.cli&.verbose
     end
 
     private
@@ -207,7 +229,7 @@ module StandupMD
     #
     # @return [Boolean]
     def read_only?
-      @config.print || file_date_argument?
+      @config.cli.print || @config.cli.post || file_date_argument?
     end
 
     ##
@@ -215,11 +237,13 @@ module StandupMD
     #
     # @return [StandupMD::File, nil]
     def find_file
-      return StandupMD::File.find_by_date(@config.date) unless read_only?
+      return StandupMD::File.find_by_date(@config.cli.date, config: @config.file) unless read_only?
 
-      without_file_creation { StandupMD::File.find_by_date(@config.date) }
-    rescue
-      raise unless @config.print
+      without_file_creation do |file_config|
+        StandupMD::File.find_by_date(@config.cli.date, config: file_config)
+      end
+    rescue StandupMD::File::NotFoundError
+      raise unless @config.cli.print || @config.cli.post
 
       nil
     end
@@ -229,11 +253,9 @@ module StandupMD
     #
     # @return [StandupMD::File]
     def without_file_creation
-      original_create = config.file.create
-      config.file.create = false
-      yield
-    ensure
-      config.file.create = original_create
+      file_config = @config.file.copy
+      file_config.create = false
+      yield file_config
     end
   end
 end

data/lib/standup_md/config/cli.rb

@@ -12,18 +12,27 @@ module StandupMD
       #
       # @return [Hash]
       DEFAULTS = {
-        date: Date.today,
-        editor: ENV["VISUAL"] || ENV["EDITOR"] || "vim",
+        date: -> { Date.today },
+        editor: -> { ENV["VISUAL"] || ENV["EDITOR"] || "vim" },
         verbose: false,
         edit: true,
         write: true,
         print: false,
+        post: false,
+        post_adapter: nil,
+        post_channel: nil,
         auto_fill_previous: true,
         preference_file: ::File.expand_path(
           ::File.join(ENV["HOME"], ".standuprc")
         )
       }.freeze
 
+      ##
+      # Attributes copied into request-scoped config snapshots.
+      #
+      # @return [Array<Symbol>]
+      CONFIG_ATTRIBUTES = DEFAULTS.keys.freeze
+
       ##
       # The editor to use when opening standup files. If one is not set, the
       # first of $VISUAL, $EDITOR, or vim will be used, in that order.
@@ -34,7 +43,7 @@ module StandupMD
       attr_accessor :editor
 
       ##
-      # Should the cli print verbose output?
+      # Should the CLI print verbose output?
       #
       # @param [Boolean] verbose
       #
@@ -42,7 +51,7 @@ module StandupMD
       attr_accessor :verbose
 
       ##
-      # Should the cli edit?
+      # Should the CLI edit?
       #
       # @param [Boolean] edit
       #
@@ -50,7 +59,7 @@ module StandupMD
       attr_accessor :edit
 
       ##
-      # Should the cli automatically write the new entry to the file?
+      # Should the CLI automatically write the new entry to the file?
       #
       # @param [Boolean] write
       #
@@ -58,13 +67,37 @@ module StandupMD
       attr_accessor :write
 
       ##
-      # Should the cli print the entry to the command line?
+      # Should the CLI print the entry to the command line?
       #
       # @param [Boolean] print
       #
       # @return [Boolean]
       attr_accessor :print
 
+      ##
+      # Should the CLI post the entry to a chat client?
+      #
+      # @param [Boolean] post
+      #
+      # @return [Boolean]
+      attr_accessor :post
+
+      ##
+      # The chat adapter to use for posting.
+      #
+      # @param [String, Symbol, nil] post_adapter
+      #
+      # @return [String, Symbol, nil]
+      attr_accessor :post_adapter
+
+      ##
+      # The channel to use for posting.
+      #
+      # @param [String, nil] post_channel
+      #
+      # @return [String, nil]
+      attr_accessor :post_channel
+
       ##
       # The date to use to find the entry.
       #
@@ -101,7 +134,37 @@ module StandupMD
       #
       # @return [Hash]
       def reset
-        DEFAULTS.each { |k, v| instance_variable_set("@#{k}", v) }
+        DEFAULTS.each do |key, value|
+          instance_variable_set("@#{key}", copy_default(resolve_default(value)))
+        end
+      end
+
+      ##
+      # Copies values from another CLI config.
+      #
+      # @param [StandupMD::Config::Cli] config
+      #
+      # @return [StandupMD::Config::Cli]
+      def copy_from(config)
+        CONFIG_ATTRIBUTES.each do |attribute|
+          instance_variable_set(
+            "@#{attribute}",
+            copy_default(config.public_send(attribute))
+          )
+        end
+        self
+      end
+
+      private
+
+      def resolve_default(value)
+        value.respond_to?(:call) ? value.call : value
+      end
+
+      def copy_default(value)
+        return value.dup if value.is_a?(Array) || value.is_a?(Hash)
+
+        value
       end
     end
   end

data/lib/standup_md/config/entry.rb

@@ -16,6 +16,12 @@ module StandupMD
         notes: []
       }.freeze
 
+      ##
+      # Attributes copied into request-scoped config snapshots.
+      #
+      # @return [Array<Symbol>]
+      CONFIG_ATTRIBUTES = DEFAULTS.keys.freeze
+
       ##
       # Tasks for "Current" section.
       #
@@ -59,7 +65,31 @@ module StandupMD
       #
       # @return [Hash]
       def reset
-        DEFAULTS.each { |k, v| instance_variable_set("@#{k}", v) }
+        DEFAULTS.each { |k, v| instance_variable_set("@#{k}", copy_default(v)) }
+      end
+
+      ##
+      # Copies values from another entry config.
+      #
+      # @param [StandupMD::Config::Entry] config
+      #
+      # @return [StandupMD::Config::Entry]
+      def copy_from(config)
+        CONFIG_ATTRIBUTES.each do |attribute|
+          instance_variable_set(
+            "@#{attribute}",
+            copy_default(config.public_send(attribute))
+          )
+        end
+        self
+      end
+
+      private
+
+      def copy_default(value)
+        return value.dup if value.is_a?(Array) || value.is_a?(Hash)
+
+        value
       end
     end
   end

data/lib/standup_md/config/file.rb

@@ -25,6 +25,12 @@ module StandupMD
         create: true
       }.freeze
 
+      ##
+      # Attributes copied into request-scoped config snapshots.
+      #
+      # @return [Array<Symbol>]
+      CONFIG_ATTRIBUTES = DEFAULTS.keys.freeze
+
       ##
       # Number of octothorps that should preface entry headers.
       #
@@ -153,7 +159,31 @@ module StandupMD
       #
       # @return [Hash]
       def reset
-        DEFAULTS.each { |k, v| instance_variable_set("@#{k}", v) }
+        DEFAULTS.each { |k, v| instance_variable_set("@#{k}", copy_default(v)) }
+      end
+
+      ##
+      # Builds an independent copy of this file config.
+      #
+      # @return [StandupMD::Config::File]
+      def copy
+        self.class.new.copy_from(self)
+      end
+
+      ##
+      # Copies values from another file config.
+      #
+      # @param [StandupMD::Config::File] config
+      #
+      # @return [StandupMD::Config::File]
+      def copy_from(config)
+        CONFIG_ATTRIBUTES.each do |attribute|
+          instance_variable_set(
+            "@#{attribute}",
+            copy_default(config.public_send(attribute))
+          )
+        end
+        self
       end
 
       ##
@@ -209,17 +239,21 @@ module StandupMD
 
       ##
       # 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.
+      # home. Directory creation is handled by StandupMD::File.
       #
       # @param [String] directory
       #
       # @return [String]
       def directory=(directory)
-        @directory = ::File.expand_path(directory).tap do |directory|
-          FileUtils.mkdir_p(directory) unless ::File.directory?(directory)
-        end
+        @directory = ::File.expand_path(directory)
+      end
+
+      private
+
+      def copy_default(value)
+        return value.dup if value.is_a?(Array) || value.is_a?(Hash)
+
+        value
       end
     end
   end