standup_md 0.2.1 → 0.3.0

data/lib/standup_md/config.rb

@@ -0,0 +1,45 @@
+require_relative 'config/cli'
+require_relative 'config/file'
+require_relative 'config/entry'
+require_relative 'config/entry_list'
+
+module StandupMD
+
+  ##
+  # This class provides a connector from StandupMD to the configuration classes.
+  class Config
+
+    ##
+    # Reader for Cli config.
+    #
+    # @return [StandupMD::Config::Cli]
+    attr_reader :cli
+
+    ##
+    # Reader for File config.
+    #
+    # @return [StandupMD::Config::File]
+    attr_reader :file
+
+    ##
+    # Reader for Entry config.
+    #
+    # @return [StandupMD::Config::Entry]
+    attr_reader :entry
+
+    ##
+    # Reader for EntryList config.
+    #
+    # @return [StandupMD::Config::EntryList]
+    attr_reader :entry_list
+
+    ##
+    # Builds the links to the configuration classes.
+    def initialize
+      @cli        = StandupMD::Config::Cli.new
+      @file       = StandupMD::Config::File.new
+      @entry      = StandupMD::Config::Entry.new
+      @entry_list = StandupMD::Config::EntryList.new
+    end
+  end
+end

data/lib/standup_md/config/cli.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+require 'date'
+
+module StandupMD
+  class Config
+
+    ##
+    # The configuration class for StandupMD::Cli
+    class Cli
+      ##
+      # 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.
+      #
+      # @param [String] editor
+      #
+      # @return [String]
+      attr_accessor :editor
+
+      ##
+      # Should the cli print verbose output?
+      #
+      # @param [Boolean] verbose
+      #
+      # @return [Boolean]
+      attr_accessor :verbose
+
+      ##
+      # Should the cli edit?
+      #
+      # @param [Boolean] edit
+      #
+      # @return [Boolean]
+      attr_accessor :edit
+
+      ##
+      # Should the cli write the file?
+      #
+      # @param [Boolean] write
+      #
+      # @return [Boolean]
+      attr_accessor :write
+
+      ##
+      # Should the cli print the entry?
+      #
+      # @param [Boolean] print
+      #
+      # @return [Boolean]
+      attr_accessor :print
+
+      ##
+      # The date to use to find the file.
+      #
+      # @param [Date] date
+      #
+      # @return [Date]
+      attr_accessor :date
+
+      ##
+      # The preference file for Cli.
+      #
+      # @param [String] preference
+      #
+      # @return [String]
+      attr_accessor :preference_file
+
+      ##
+      # When writing a new entry, should 'previous' be pulled from the last
+      # entry?
+      #
+      # @param [Boolean] auto_fill_previous
+      #
+      # @return [Boolean]
+      attr_accessor :auto_fill_previous
+
+      ##
+      # Initializes the config with default values.
+      def initialize
+        reset_values
+      end
+
+      ##
+      # Sets all config values back to their defaults.
+      #
+      # @return [Boolean] true if successful
+      def reset_values
+        @date = Date.today
+        @editor = set_editor
+        @verbose = false
+        @edit = true
+        @write = true
+        @print = false
+        @auto_fill_previous = true
+        @preference_file = ::File.expand_path(::File.join(ENV['HOME'], '.standuprc'))
+      end
+
+      private
+
+      def set_editor # :nodoc:
+        return ENV['VISUAL'] if ENV['VISUAL']
+        return ENV['EDITOR'] if ENV['EDITOR']
+        'vim'
+      end
+    end
+  end
+end

data/lib/standup_md/config/entry.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module StandupMD
+  class Config
+
+    ##
+    # The configuration class for StandupMD::Entry
+    class Entry
+
+      ##
+      # Tasks for "Current" section.
+      #
+      # @param [Array] current
+      #
+      # @return [Array]
+      attr_accessor :current
+
+      ##
+      # Tasks for "Previous" section.
+      #
+      # @param [Array] previous
+      #
+      # @return [Array]
+      attr_accessor :previous
+
+      ##
+      # Impediments for this entry.
+      #
+      # @param [Array] impediments
+      #
+      # @return [Array]
+      attr_accessor :impediments
+
+      ##
+      # Notes for this entry.
+      #
+      # @param [Array] notes
+      #
+      # @return [Array]
+      attr_accessor :notes
+
+      ##
+      # Initializes the config with default values.
+      def initialize
+        reset_values
+      end
+
+      ##
+      # Sets all config values back to their defaults.
+      #
+      # @return [Boolean] true if successful
+      def reset_values
+        @current = ["<!-- ADD TODAY'S WORK HERE -->"]
+        @previous = []
+        @impediments = ['None']
+        @notes = []
+        true
+      end
+    end
+  end
+end

data/lib/standup_md/config/entry_list.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module StandupMD
+  class Config
+
+    ##
+    # The configuration class for StandupMD::EntryList
+    class EntryList
+
+      ##
+      # Initializes the config with default values.
+      def initalize
+        reset_values
+      end
+
+      ##
+      # Sets all config values back to their defaults.
+      #
+      # @return [Boolean] true if successful
+      def reset_values
+        # TODO add order ascending or decending.
+        true
+      end
+    end
+  end
+end

data/lib/standup_md/config/file.rb

@@ -0,0 +1,199 @@
+module StandupMD
+  class Config
+
+    ##
+    # The configuration class for StandupMD::File
+    class File
+      ##
+      # Number of octothorps that should preface entry headers.
+      #
+      # @return [Integer] between 1 and 5
+      #
+      # @default 1
+      attr_reader :header_depth
+
+      ##
+      # Number of octothorps that should preface sub-headers.
+      #
+      # @return [Integer] between 2 and 6
+      #
+      # @default 2
+      attr_reader :sub_header_depth
+
+      ##
+      # The directory in which the files are located.
+      #
+      # @return [String]
+      #
+      # @default "~/.cache/standup_md"
+      attr_reader :directory
+
+      ##
+      # Character used as bullets for list entries.
+      #
+      # @return [String] either - (dash) or * (asterisk)
+      #
+      # @default "-" (dash)
+      attr_reader :bullet_character
+
+      ##
+      # String to be used as "Current" header.
+      #
+      # @param [String] header
+      #
+      # @return [String]
+      #
+      # @default "Current"
+      attr_accessor :current_header
+
+      ##
+      # String to be used as "Previous" header.
+      #
+      # @param [String] header
+      #
+      # @return [String]
+      #
+      # @default "Previous"
+      attr_accessor :previous_header
+
+      ##
+      # String to be used as "Impediments" header.
+      #
+      # @param [String] header
+      #
+      # @return [String]
+      #
+      # @default "Impediments"
+      attr_accessor :impediments_header
+
+      ##
+      # String to be used as "Notes" header.
+      #
+      # @param [String] header
+      #
+      # @return [String]
+      #
+      # @default "Notes"
+      attr_accessor :notes_header
+
+      ##
+      # Preferred order for sub-headers.
+      #
+      # @param [Array] sub_header_order
+      #
+      # @return [Array]
+      #
+      # @default %w[previous current impediment notes]
+      attr_accessor :sub_header_order
+
+      ##
+      # Format to be used for standup file names. Should be parse-able by
+      # strftime, and should be a monthly date.
+      #
+      # @param [String] name_format
+      #
+      # @return [String]
+      #
+      # @default "%Y_%m.md"
+      attr_accessor :name_format
+
+      ##
+      # The date format for entry headers. Will be parsed by +strftime+.
+      #
+      # @param [String] format
+      #
+      # @return [String]
+      attr_accessor :header_date_format
+
+      ##
+      # Should the file be created if it doesn't exist?
+      #
+      # @param [Boolean] create
+      #
+      # @return [boolean]
+      attr_accessor :create
+
+      ##
+      # Initializes the config with default values.
+      def initialize
+        reset_values
+      end
+
+      ##
+      # Sets all config values back to their defaults.
+      #
+      # @return [Boolean] true if successful
+      def reset_values
+        @header_date_format = '%Y-%m-%d'
+        @header_depth = 1
+        @sub_header_depth = 2
+        @current_header = 'Current'
+        @previous_header = 'Previous'
+        @impediments_header = 'Impediments'
+        @notes_header = 'Notes'
+        @sub_header_order = %w[previous current impediments notes]
+        @directory = ::File.join(ENV['HOME'], '.cache', 'standup_md')
+        @bullet_character = '-'
+        @name_format = '%Y_%m.md'
+        @create = true
+        true
+      end
+
+      ##
+      # Number of octothorps (#) to use before the main header.
+      #
+      # @param [Integer] depth
+      #
+      # @return [Integer]
+      def header_depth=(depth)
+        if !depth.between?(1, 5)
+          raise 'Header depth out of bounds (1..5)'
+        elsif depth >= sub_header_depth
+          @sub_header_depth = depth + 1
+        end
+        @header_depth = depth
+      end
+
+      ##
+      # Number of octothorps (#) to use before sub headers (Current, Previous,
+      # etc).
+      #
+      # @param [Integer] depth
+      #
+      # @return [Integer]
+      def sub_header_depth=(depth)
+        if !depth.between?(2, 6)
+          raise 'Sub-header depth out of bounds (2..6)'
+        elsif depth <= header_depth
+          @header_depth = depth - 1
+        end
+        @sub_header_depth = depth
+      end
+
+      ##
+      # Setter for bullet_character. Must be * (asterisk) or - (dash).
+      #
+      # @param [String] character
+      #
+      # @return [String]
+      def bullet_character=(char)
+        raise 'Must be "-" or "*"' unless %w[- *].include?(char)
+        @bullet_character = char
+      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] directory
+      #
+      # @return [String]
+      def directory=(directory)
+        directory = ::File.expand_path(directory)
+        FileUtils.mkdir_p(directory) unless ::File.directory?(directory)
+        @directory = directory
+      end
+    end
+  end
+end

data/lib/standup_md/entry.rb

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+require 'json'
+
+module StandupMD
+
+  ##
+  # Class for handling single entries. Includes the comparable module, and
+  # compares by date.
+  class Entry
+    include Comparable
+
+    ##
+    # Access to the class's configuration.
+    #
+    # @return [StandupMD::Config::Entry]
+    def self.config
+      @config ||= StandupMD.config.entry
+    end
+
+    ##
+    # The date of the entry.
+    #
+    # @param [Date] date
+    #
+    # @return [Date]
+    attr_accessor :date
+
+    ##
+    # The tasks for today.
+    #
+    # @return [Array]
+    attr_accessor :current
+
+    ##
+    # The tasks from the previous day.
+    #
+    # @return [Array]
+    attr_accessor :previous
+
+    ##
+    # Iimpediments for this entry.
+    #
+    # @return [Array]
+    attr_accessor :impediments
+
+    ##
+    # Nnotes to add to this entry.
+    #
+    # @return [Array]
+    attr_accessor :notes
+
+    ##
+    # Creates a generic entry. Default values can be set via configuration.
+    # Yields the entry if a block is passed so you can change values.
+    #
+    # @return [StandupMD::Entry]
+    def self.create
+      entry = new(
+        Date.today,
+        config.current,
+        config.previous,
+        config.impediments,
+        config.notes
+      )
+      yield config if block_given?
+      entry
+    end
+
+    ##
+    # Constructs instance of +StandupMD::Entry+.
+    #
+    # @param [Date] date
+    #
+    # @param [Array] current
+    #
+    # @param [Array] previous
+    #
+    # @param [Array] impediments
+    #
+    # @param [Array] notes
+    def initialize(date, current, previous, impediments, notes = [])
+      raise unless date.is_a?(Date)
+      @config = self.class.config
+
+      @date           = date
+      @current        = current
+      @previous       = previous
+      @impediments    = impediments
+      @notes          = notes
+    end
+
+    ##
+    # Sorting method for Comparable. Entries are compared by date.
+    def <=>(other)
+      date <=> other.date
+    end
+
+    ##
+    # Entry as a hash .
+    #
+    # @return [Hash]
+    def to_h
+      {
+        date => {
+          'current'     => current,
+          'previous'    => previous,
+          'impediments' => impediments,
+          'notes'       => notes
+        }
+      }
+    end
+
+    ##
+    # Entry as a json object.
+    #
+    # @return [String]
+    def to_json
+      to_h.to_json
+    end
+  end
+end