standup_md 0.2.1 → 0.3.4

data/lib/standup_md/entry.rb

@@ -0,0 +1,122 @@
+# 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

data/lib/standup_md/entry_list.rb

@@ -0,0 +1,166 @@
+# frozen_string_literal: true
+
+module StandupMD
+
+  ##
+  # Enumerable list of entries.
+  class EntryList
+    include Enumerable
+
+    ##
+    # Access to the class's configuration.
+    #
+    # @return [StandupMD::Config::EntryList]
+    def self.config
+      @config ||= StandupMD.config.entry_list
+    end
+
+    ##
+    # Contruct a list. Can pass any amount of +StandupMD::Entry+ instances.
+    #
+    # @param [Entry] entries
+    #
+    # @return [StandupMD::EntryList]
+    def initialize(*entries)
+      @config = self.class.config
+      unless entries.all? { |e| e.is_a?(StandupMD::Entry) }
+        raise ArgumentError, 'Entry must instance of StandupMD::Entry'
+      end
+      @entries = entries
+    end
+
+    ##
+    # Iterate over the list and yield each entry.
+    def each(&block)
+      @entries.each(&block)
+    end
+
+    ##
+    # Appends entries to list.
+    #
+    # @param [StandupMD::Entry] entry
+    #
+    # @return [Array]
+    def <<(entry)
+      unless entry.is_a?(StandupMD::Entry)
+        raise ArgumentError, 'Entry must instance of StandupMD::Entry'
+      end
+      @entries << entry
+    end
+
+    ##
+    # Finds an entry based on date. This method assumes the list has already
+    # been sorted.
+    def find(key)
+      to_a.bsearch { |e| e.date == key }
+    end
+
+    ##
+    # Returns a copy of self sorted by date.
+    #
+    # @return [StandupMD::EntryList]
+    def sort
+      self.class.new(*@entries.sort)
+    end
+
+    ##
+    # Replace entries with sorted entries by date.
+    #
+    # @return [StandupMD::EntryList]
+    def sort!
+      @entries = @entries.sort
+      self
+    end
+
+    ##
+    # Returns a copy of self sorted by date.
+    #
+    # @return [StandupMD::EntryList]
+    def sort_reverse
+      self.class.new(*@entries.sort.reverse)
+    end
+
+    ##
+    # Returns entries that are between the start and end date. This method
+    # assumes the list has already been sorted.
+    #
+    # @param [Date] start_date
+    #
+    # @param [Date] end_date
+    #
+    # @return [Array]
+    def filter(start_date, end_date)
+      self.class.new(
+        *@entries.select { |e| e.date.between?(start_date, end_date) }
+      )
+    end
+
+    ##
+    # Replaces entries with results of filter.
+    #
+    # @param [Date] start_date
+    #
+    # @param [Date] end_date
+    #
+    # @return [Array]
+    def filter!(start_date, end_date)
+      @entries = filter(start_date, end_date)
+      self
+    end
+
+    ##
+    # The list as a hash, with the dates as keys.
+    #
+    # @return [Hash]
+    def to_h
+      Hash[@entries.map { |e| [e.date, {
+        'current'     => e.current,
+        'previous'    => e.previous,
+        'impediments' => e.impediments,
+        'notes'       => e.notes
+      }]}]
+    end
+
+    ##
+    # The entry list as a json object.
+    #
+    # @return [String]
+    def to_json
+      to_h.to_json
+    end
+
+    ##
+    # The first entry in the list. This method assumes the list has
+    # already been sorted.
+    #
+    # @return [StandupMD::Entry]
+    def first
+      to_a.first
+    end
+
+    ##
+    # The last entry in the list. This method assumes the list has
+    # already been sorted.
+    #
+    # @return [StandupMD::Entry]
+    def last
+      to_a.last
+    end
+
+    ##
+    # How many entries are in the list.
+    #
+    # @return [Integer]
+    def size
+      @entries.size
+    end
+
+    ##
+    # Is the list empty?
+    #
+    # @return [Boolean] true if empty
+    def empty?
+      @entries.empty?
+    end
+  end
+end

data/lib/standup_md/file.rb

@@ -0,0 +1,183 @@
+# frozen_string_literal: true
+
+require 'date'
+require 'fileutils'
+require_relative 'file/helpers'
+
+module StandupMD
+
+  ##
+  # Class for handling reading and writing standup files.
+  class File
+    include StandupMD::File::Helpers
+
+    ##
+    # Access to the class's configuration.
+    #
+    # @return [StandupMD::Config::EntryList]
+    def self.config
+      @config ||= StandupMD.config.file
+    end
+
+    ##
+    # Convenience method for calling File.find(file_name).load
+    #
+    # @param [String] file_name
+    #
+    # @return [StandupMD::File]
+    def self.load(file_name)
+      new(file_name).load
+    end
+
+    ##
+    # Find standup file in directory by file name.
+    #
+    # @param [String] File_naem
+    def self.find(file_name)
+      file = Dir.entries(config.directory).bsearch { |f| f == file_name }
+      if file.nil? && !config.create
+        raise "File #{file_name} not found." unless config.create
+      end
+      new(file_name)
+    end
+
+    ##
+    # Find standup file in directory by Date object.
+    #
+    # @param [Date] date
+    def self.find_by_date(date)
+      unless date.is_a?(Date)
+        raise ArgumentError, "Argument must be a Date object"
+      end
+      find(date.strftime(config.name_format))
+    end
+
+    ##
+    # The list of entries in the file.
+    #
+    # @return [StandupMP::EntryList]
+    attr_reader :entries
+
+    ##
+    # The name of the file.
+    #
+    # @return [String]
+    attr_reader :name
+
+    ##
+    # Constructs the instance.
+    #
+    # @param [String] file_name
+    #
+    # @return [StandupMP::File]
+    def initialize(file_name)
+      @config = self.class.config
+      if file_name.include?(::File::SEPARATOR)
+        raise ArgumentError,
+          "#{file_name} contains directory. Please use `StandupMD.config.file.directory=`"
+      end
+
+      unless ::File.directory?(@config.directory)
+        raise "Dir #{@config.directory} not found." unless @config.create
+        FileUtils.mkdir_p(@config.directory)
+      end
+
+      @name = ::File.expand_path(::File.join(@config.directory, file_name))
+
+      unless ::File.file?(@name)
+        raise "File #{@name} not found." unless @config.create
+        FileUtils.touch(@name)
+      end
+
+      @new = ::File.zero?(@name)
+      @loaded = false
+    end
+
+    ##
+    # Was the file just now created?
+    #
+    # @return [Boolean] true if new
+    def new?
+      @new
+    end
+
+    ##
+    # Has the file been loaded?
+    #
+    # @return [Boolean] true if loaded
+    def loaded?
+      @loaded
+    end
+
+    ##
+    # Does the file exist?
+    #
+    # @return [Boolean] true if exists
+    def exist?
+      ::File.exist?(name)
+    end
+
+    ##
+    # Loads the file's contents.
+    # TODO clean up this method.
+    #
+    # @return [StandupMD::FileList]
+    def load
+      raise "File #{name} does not exist." unless ::File.file?(name)
+      entry_list = EntryList.new
+      record = {}
+      section_type = ''
+      ::File.foreach(name) do |line|
+        line.chomp!
+        next if line.strip.empty?
+        if is_header?(line)
+          unless record.empty?
+            entry_list << new_entry(record)
+            record = {}
+          end
+          record['header'] = line.sub(%r{^\#{#{@config.header_depth}}\s*}, '')
+            section_type = @config.notes_header
+            record[section_type] = []
+        elsif is_sub_header?(line)
+          section_type = determine_section_type(line)
+          record[section_type] = []
+        else
+          record[section_type] << line.sub(bullet_character_regex, '')
+        end
+      end
+      entry_list << new_entry(record) unless record.empty?
+      @loaded = true
+      @entries = entry_list.sort
+      self
+    rescue => e
+      raise "File malformation: #{e}"
+    end
+
+    ##
+    # Writes a new entry to the file if the first entry in the file isn't today.
+    # This method is destructive; if a file for entries in the date range
+    # already exists, it will be clobbered with the entries in the range.
+    #
+    # @param [Hash] {start_date: Date, end_date: Date}
+    #
+    # @return [Boolean] true if successful
+    def write(dates = {})
+      sorted_entries = entries.sort
+      start_date = dates.fetch(:start_date, sorted_entries.first.date)
+      end_date = dates.fetch(:end_date, sorted_entries.last.date)
+      ::File.open(name, 'w') do |f|
+        sorted_entries.filter(start_date, end_date).sort_reverse.each do |entry|
+          f.puts header(entry.date)
+          @config.sub_header_order.each do |attr|
+            tasks = entry.send(attr)
+            next if !tasks || tasks.empty?
+            f.puts sub_header(@config.send("#{attr}_header").capitalize)
+            tasks.each { |task| f.puts @config.bullet_character + ' ' + task }
+          end
+          f.puts
+        end
+      end
+      true
+    end
+  end
+end