standup_md 1.0.1 → 2.0.0

data/lib/standup_md/cli.rb

@@ -5,7 +5,7 @@ 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
 
@@ -22,7 +22,7 @@ module StandupMD
     #
     # @return [StandupMD::Config::Cli]
     def self.config
-      @config ||= StandupMD.config.cli
+      StandupMD.config.cli
     end
 
     ##
@@ -73,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.
     #
@@ -120,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
@@ -128,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?
 
@@ -141,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
 
@@ -162,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
 
     ##
@@ -180,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
 
     ##
@@ -188,7 +206,7 @@ module StandupMD
     #
     # @return [nil]
     def echo(msg)
-      self.class.echo(msg)
+      puts msg if @config&.cli&.verbose
     end
 
     private
@@ -211,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
 
     ##
@@ -219,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
@@ -233,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

data/lib/standup_md/config/post.rb

@@ -0,0 +1,152 @@
+# frozen_string_literal: true
+
+require "standup_md/post"
+
+module StandupMD
+  class Config
+    ##
+    # The configuration class for chat posting.
+    class Post
+      ##
+      # The default posting options.
+      #
+      # @return [Hash]
+      DEFAULTS = {
+        default_adapter: :slack,
+        title: nil
+      }.freeze
+
+      ##
+      # Attributes copied into request-scoped config snapshots.
+      #
+      # @return [Array<Symbol>]
+      CONFIG_ATTRIBUTES = DEFAULTS.keys.freeze
+
+      ##
+      # The adapter used when `standup --post` is called without a platform.
+      #
+      # @return [Symbol]
+      attr_accessor :default_adapter
+
+      ##
+      # Format string for posted entry titles.
+      #
+      # This only affects messages sent through chat posting adapters. It does
+      # not change stored standup markdown files. Use `%s` as a placeholder for
+      # the normal entry title, such as the entry date. This is useful when chat
+      # clients post through workspace apps or bots with shared names like
+      # "StandupMD", but the message should still identify whose standup it is.
+      #
+      # @example Include the person's name after the entry date
+      #   StandupMD.config.post.title = "%s - Evan Gray"
+      #
+      # @return [String, nil]
+      attr_accessor :title
+
+      ##
+      # Registered adapter classes or instances.
+      #
+      # @return [Hash]
+      attr_reader :adapters
+
+      ##
+      # Non-secret adapter options.
+      #
+      # @return [Hash]
+      attr_reader :adapter_options
+
+      ##
+      # Initializes the config with default values.
+      def initialize
+        reset
+      end
+
+      ##
+      # Sets all config values back to their defaults.
+      #
+      # @return [Hash]
+      def reset
+        DEFAULTS.each { |k, v| instance_variable_set("@#{k}", v) }
+        @adapters = {}
+        @adapter_options = Hash.new { |hash, key| hash[key] = {} }
+        register_adapter(:slack, StandupMD::Post::Adapters::Slack)
+        DEFAULTS
+      end
+
+      ##
+      # Copies values from another post config.
+      #
+      # @param [StandupMD::Config::Post] config
+      #
+      # @return [StandupMD::Config::Post]
+      def copy_from(config)
+        CONFIG_ATTRIBUTES.each do |attribute|
+          instance_variable_set("@#{attribute}", config.public_send(attribute))
+        end
+        @adapters = config.adapters.dup
+        @adapter_options = Hash.new { |hash, key| hash[key] = {} }
+        config.adapter_options.each do |name, options|
+          @adapter_options[name] = options.dup
+        end
+        self
+      end
+
+      ##
+      # Registers a posting adapter.
+      #
+      # @param name [String, Symbol]
+      # @param adapter [Class, Object]
+      #
+      # @return [Class, Object]
+      def register_adapter(name, adapter)
+        adapters[name.to_sym] = adapter
+      end
+
+      ##
+      # Configures non-secret adapter options.
+      #
+      # @param name [String, Symbol]
+      # @param options [Hash]
+      #
+      # @return [Hash]
+      def configure_adapter(name, options = {})
+        options_for(name).merge!(symbolize_keys(options))
+      end
+
+      ##
+      # Returns non-secret options for an adapter.
+      #
+      # @param name [String, Symbol]
+      #
+      # @return [Hash]
+      def options_for(name)
+        adapter_options[name.to_sym]
+      end
+
+      ##
+      # Builds the adapter requested by name.
+      #
+      # @param name [String, Symbol, nil]
+      #
+      # @return [Object]
+      def build_adapter(name = nil)
+        adapter_name = (name || default_adapter).to_sym
+        adapter = adapters.fetch(adapter_name) do
+          raise StandupMD::Post::UnknownAdapter, "No post adapter registered for #{adapter_name}"
+        end
+        return adapter unless adapter.respond_to?(:new)
+        return adapter.new if adapter.instance_method(:initialize).arity.zero?
+
+        adapter.new(options_for(adapter_name))
+      end
+
+      private
+
+      def symbolize_keys(hash)
+        hash.each_with_object({}) do |(key, value), result|
+          result[key.to_sym] = value
+        end
+      end
+    end
+  end
+end

data/lib/standup_md/config.rb

@@ -3,7 +3,7 @@
 require "standup_md/config/cli"
 require "standup_md/config/file"
 require "standup_md/config/entry"
-require "standup_md/config/entry_list"
+require "standup_md/config/post"
 
 module StandupMD
   ##
@@ -28,10 +28,10 @@ module StandupMD
     attr_reader :entry
 
     ##
-    # Reader for EntryList config.
+    # Reader for Post config.
     #
-    # @return [StandupMD::Config::EntryList]
-    attr_reader :entry_list
+    # @return [StandupMD::Config::Post]
+    attr_reader :post
 
     ##
     # Builds the links to the configuration classes.
@@ -39,7 +39,20 @@ module StandupMD
       @cli = StandupMD::Config::Cli.new
       @file = StandupMD::Config::File.new
       @entry = StandupMD::Config::Entry.new
-      @entry_list = StandupMD::Config::EntryList.new
+      @post = StandupMD::Config::Post.new
+    end
+
+    ##
+    # Builds an independent snapshot of the current configuration.
+    #
+    # @return [StandupMD::Config]
+    def copy
+      self.class.new.tap do |config|
+        config.cli.copy_from(cli)
+        config.file.copy_from(file)
+        config.entry.copy_from(entry)
+        config.post.copy_from(post)
+      end
     end
   end
 end

data/lib/standup_md/entry.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require "json"
 require "standup_md/section"
 
 module StandupMD
@@ -21,7 +20,7 @@ module StandupMD
     #
     # @return [StandupMD::Config::Entry]
     def self.config
-      @config ||= StandupMD.config.entry
+      StandupMD.config.entry
     end
 
     ##
@@ -36,14 +35,33 @@ module StandupMD
     # Creates a generic entry. Default values can be set via configuration.
     # Yields the entry if a block is passed so you can change values.
     #
+    # @param [StandupMD::Config::Entry] config
+    #
+    # @param [Date] date
+    #
+    # @param [Array, nil] current
+    #
+    # @param [Array, nil] previous
+    #
+    # @param [Array, nil] impediments
+    #
+    # @param [Array, nil] notes
+    #
     # @return [StandupMD::Entry]
-    def self.create
+    def self.create(
+      config: StandupMD.config.entry,
+      date: Date.today,
+      current: nil,
+      previous: nil,
+      impediments: nil,
+      notes: nil
+    )
       new(
-        Date.today,
-        config.current,
-        config.previous,
-        config.impediments,
-        config.notes
+        date,
+        current || config.current,
+        previous || config.previous,
+        impediments || config.impediments,
+        notes || config.notes
       ).tap { |entry| yield entry if block_given? }
     end
 
@@ -62,7 +80,6 @@ module StandupMD
     def initialize(date, current, previous, impediments, notes = [])
       raise unless date.is_a?(Date)
 
-      @config = self.class.config
       @date = date
       @sections = {}
       self.current = current
@@ -110,7 +127,7 @@ module StandupMD
     end
 
     ##
-    # Entry as a hash .
+    # Entry as a hash.
     #
     # @return [Hash]
     def to_h
@@ -124,14 +141,6 @@ module StandupMD
       }
     end
 
-    ##
-    # Entry as a json object.
-    #
-    # @return [String]
-    def to_json
-      to_h.to_json
-    end
-
     private
 
     def set_section(type, tasks)