standup_md 0.2.1 → 0.3.0

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
+
+    ##
+    # 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
+
+    ##
+    # 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 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
+
+    ##
+    # 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
+  end
+end

data/lib/standup_md/file.rb

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

data/lib/standup_md/file/helpers.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module StandupMD
+  class File
+
+    ##
+    # Module responsible for reading and writing standup files.
+    module Helpers # :nodoc:
+
+      private
+
+      def is_header?(line) # :nodoc:
+        line.match(header_regex)
+      end
+
+      def is_sub_header?(line) # :nodoc:
+        line.match(sub_header_regex)
+      end
+
+      def header_regex # :nodoc:
+        %r{^#{'#' * StandupMD.config.file.header_depth}\s+}
+      end
+
+      def sub_header_regex # :nodoc:
+        %r{^#{'#' * StandupMD.config.file.sub_header_depth}\s+}
+      end
+
+      def bullet_character_regex # :nodoc:
+        %r{\s*#{StandupMD.config.file.bullet_character}\s*}
+      end
+
+      def determine_section_type(line) # :nodoc:
+        line = line.sub(%r{^\#{#{StandupMD.config.file.sub_header_depth}}\s*}, '')
+          [
+            StandupMD.config.file.current_header,
+            StandupMD.config.file.previous_header,
+            StandupMD.config.file.impediments_header,
+            StandupMD.config.file.notes_header
+        ].each { |header| return header if line.include?(header) }
+        raise "Unrecognized header [#{line}]"
+      end
+
+      def new_entry(record) # :nodoc:
+        Entry.new(
+          Date.strptime(record['header'], StandupMD.config.file.header_date_format),
+          record[StandupMD.config.file.current_header],
+          record[StandupMD.config.file.previous_header],
+          record[StandupMD.config.file.impediments_header],
+          record[StandupMD.config.file.notes_header]
+        )
+      end
+
+      def header(date)
+        '#' * StandupMD.config.file.header_depth + ' ' + date.strftime(StandupMD.config.file.header_date_format)
+      end
+
+      def sub_header(sh)
+        '#' * StandupMD.config.file.sub_header_depth + ' ' + sh
+      end
+    end
+  end
+end

data/lib/standup_md/version.rb

@@ -1,9 +1,11 @@
-class StandupMD
+# frozen_string_literal: true
+
+module StandupMD
   ##
   # The gem verision
   #
   # @example
   #  StandupMD::VERSION
-  #  # => '0.2.1'
-  VERSION = '0.2.1'
+  #  # => '0.3.0'
+  VERSION = '0.3.0'
 end

data/standup_md.gemspec

@@ -36,4 +36,5 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
   spec.add_development_dependency 'rake', '~> 13.0', '>= 13.0.1'
   spec.add_development_dependency 'test-unit', '~> 3.3', '>= 3.3.5'
+  spec.add_development_dependency 'simplecov'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: standup_md
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Evan Gray
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-03 00:00:00.000000000 Z
+date: 2020-06-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -50,6 +50,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.3.5
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Generate and edit standups in markdown format
 email: evanthegrayt@vivaldi.net
 executables:
@@ -69,6 +83,15 @@ files:
 - doc/README_md.html
 - doc/StandupMD.html
 - doc/StandupMD/Cli.html
+- doc/StandupMD/Cli/Helpers.html
+- doc/StandupMD/Config.html
+- doc/StandupMD/Config/Cli.html
+- doc/StandupMD/Config/Entry.html
+- doc/StandupMD/Config/EntryList.html
+- doc/StandupMD/Config/File.html
+- doc/StandupMD/Entry.html
+- doc/StandupMD/EntryList.html
+- doc/StandupMD/File.html
 - doc/created.rid
 - doc/css/fonts.css
 - doc/css/rdoc.css
@@ -115,6 +138,16 @@ files:
 - doc/table_of_contents.html
 - lib/standup_md.rb
 - lib/standup_md/cli.rb
+- lib/standup_md/cli/helpers.rb
+- lib/standup_md/config.rb
+- lib/standup_md/config/cli.rb
+- lib/standup_md/config/entry.rb
+- lib/standup_md/config/entry_list.rb
+- lib/standup_md/config/file.rb
+- lib/standup_md/entry.rb
+- lib/standup_md/entry_list.rb
+- lib/standup_md/file.rb
+- lib/standup_md/file/helpers.rb
 - lib/standup_md/version.rb
 - standup_md.gemspec
 homepage: https://evanthegrayt.github.io/standup_md/