standup_md 0.3.17 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f155bb0cdeacfcf00716bfd5cfbc67a9e5d6d1d8be2b89c35d0f148ec782b264
-  data.tar.gz: fa9f7a3d971f45f79f2f819fcaa05c761bdf2cd3d9b4de3abc942b320ca4765d
+  metadata.gz: 2734d31b2ce72d31aceeb789f562b015c4f0e7422b3a755992df7c1f293a7051
+  data.tar.gz: 651d1f6f9a613366b90e2b26ba83b8e05dd80dbc5d8bde3a0fcc7d07b57acef1
 SHA512:
-  metadata.gz: b22a137af1ae2a03cead81ffce5b46f517721dd22f5364318e595ebe7e22d6b9eb7e2ed05021acaec9a3f5d0f76769c98d73a898ee908be58656c4d7f01a60f8
-  data.tar.gz: 5cbbf132c3cbec6e1b6290c1d1b13f8c7f8f25aa6b02d0e51052964b4688dcad7350488cc17810b1f87a9098bdcba21824e752c9fd7bbc71e21d3edeb86ab112
+  metadata.gz: 5df3037a20d107f82cc34533f89ab8c31a2ba13eb8180b5931b052c500c5c1f7c4922d22ffed254c5fb9e9d7623b5bb207ed5d5c0c22773bcc972a91bba061d4
+  data.tar.gz: c99e5cf930d4dcf84e6089d458321b00f427ab0c124ecf3b02b8e98d79ba416d5c629793f6f77a8cf1a0337b05ed620600833f1ad8fa2775d7e6eb7205ec22ed

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    standup_md (0.3.17)
+    standup_md (1.0.0)
 
 GEM
   remote: https://rubygems.org/
@@ -115,7 +115,7 @@ CHECKSUMS
   standard (1.54.0) sha256=7a4b08f83d9893083c8f03bc486f0feeb6a84d48233b40829c03ef4767ea0100
   standard-custom (1.0.2) sha256=424adc84179a074f1a2a309bb9cf7cd6bfdb2b6541f20c6bf9436c0ba22a652b
   standard-performance (1.9.0) sha256=49483d31be448292951d80e5e67cdcb576c2502103c7b40aec6f1b6e9c88e3f2
-  standup_md (0.3.17)
+  standup_md (1.0.0)
   stringio (3.2.0) sha256=c37cb2e58b4ffbd33fe5cd948c05934af997b36e0b6ca6fdf43afa234cf222e1
   test-unit (3.7.8) sha256=689d1ca53f4d46f678b4e5d68d8e4294f87fc5e8b9238cc4de7c5727e8d65943
   tsort (0.2.0) sha256=9650a793f6859a43b6641671278f79cfead60ac714148aabe4e3f0060480089f

data/README.md

@@ -180,6 +180,7 @@ StandupMD.configure do |c|
   c.file.sub_header_order   = %w[previous current impediments notes]
   c.file.directory          = ::File.join(ENV["HOME"], ".cache", "standup_md")
   c.file.bullet_character   = "-"
+  c.file.indent_width       = 2
   c.file.name_format        = "%Y_%m.md"
   c.file.create             = true
 
@@ -218,6 +219,7 @@ Some of these options can be changed at runtime. They are as follows.
     --impediments ARRAY        List of impediments for current entry
     --notes ARRAY              List of notes for current entry
     --sub-header-order ARRAY   The order of the sub-headers when writing the file
+    --indent-width INTEGER     Number of spaces used for each nested task level
 -f, --file-name-format STRING  Date-formattable string to use for standup file name
 -E, --editor EDITOR            Editor to use for opening standup files
 -d, --directory DIRECTORY      The directories where standup files are located
@@ -275,6 +277,7 @@ StandupMD.configure do |c|
   c.file.previous_header    = "Yesterday"
   c.file.impediments_header = "Hold-ups"
   c.file.bullet_character   = "*"
+  c.file.indent_width       = 2
   c.file.header_date_format = "%m/%d/%Y"
   c.file.sub_header_order   = %w[current previous impediments notes]
 end

data/completion/zsh/_standup

@@ -62,6 +62,7 @@ _arguments -s -S \
   '--impediments[List of impediments for current entry]:impediments:_standup_array_values' \
   '--notes[List of notes for current entry]:notes:_standup_array_values' \
   '--sub-header-order[The order of the sub-headers when writing the file]:sub-header order:_standup_sub_header_order' \
+  '--indent-width[Number of spaces used for each nested task level]:indent width:' \
   '(-f --file-name-format)-f[Date-formattable string to use for standup file name]:strftime format:' \
   '(-f --file-name-format)--file-name-format[Date-formattable string to use for standup file name]:strftime format:' \
   '(-E --editor)-E[Editor to use for opening standup files]:editor:_path_commands' \

data/lib/standup_md/cli/helpers.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "standup_md/parsers/markdown"
+
 module StandupMD
   class Cli
     ##
@@ -20,7 +22,9 @@ module StandupMD
           next if !tasks || tasks.empty?
 
           puts sub_header(header_type)
-          tasks.each { |task| puts "#{config.file.bullet_character} #{task}" }
+          entry.public_send("#{header_type}_tasks").each do |task|
+            puts parser.task_line(task)
+          end
         end
         puts
       end
@@ -69,6 +73,11 @@ module StandupMD
             "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"
@@ -217,7 +226,11 @@ module StandupMD
       # @return [String]
       def sub_header(header_type)
         "#" * config.file.sub_header_depth + " " +
-          config.file.public_send("#{header_type}_header").capitalize
+          config.file.public_send("#{header_type}_header")
+      end
+
+      def parser
+        StandupMD::Parsers::Markdown.new(config.file)
       end
     end
   end

data/lib/standup_md/config/file.rb

@@ -20,6 +20,7 @@ module StandupMD
         sub_header_order: %w[previous current impediments notes],
         directory: ::File.join(ENV["HOME"], ".cache", "standup_md"),
         bullet_character: "-",
+        indent_width: 2,
         name_format: "%Y_%m.md",
         create: true
       }.freeze
@@ -56,6 +57,14 @@ module StandupMD
       # @default "-" (dash)
       attr_reader :bullet_character
 
+      ##
+      # Number of spaces used for each nested task level.
+      #
+      # @return [Integer]
+      #
+      # @default 2
+      attr_reader :indent_width
+
       ##
       # String to be used as "Current" header.
       #
@@ -186,6 +195,18 @@ module StandupMD
         @bullet_character = char
       end
 
+      ##
+      # Setter for indent_width. Must be a positive integer.
+      #
+      # @param [Integer] width
+      #
+      # @return [Integer]
+      def indent_width=(width)
+        raise "Indent width must be a positive integer" unless width.is_a?(Integer) && width.positive?
+
+        @indent_width = width
+      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

data/lib/standup_md/entry.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "json"
+require "standup_md/section"
 
 module StandupMD
   ##
@@ -9,6 +10,8 @@ module StandupMD
   class Entry
     include Comparable
 
+    SECTION_TYPES = %i[current previous impediments notes].freeze
+
     ##
     # Access to the class's configuration.
     #
@@ -25,30 +28,6 @@ module StandupMD
     # @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
-
-    ##
-    # Impediments 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.
@@ -81,10 +60,43 @@ module StandupMD
 
       @config = self.class.config
       @date = date
-      @current = current
-      @previous = previous
-      @impediments = impediments
-      @notes = notes
+      @sections = {}
+      self.current = current
+      self.previous = previous
+      self.impediments = impediments
+      self.notes = notes
+    end
+
+    SECTION_TYPES.each do |type|
+      define_method(type) do
+        section(type).tasks.map(&:to_s)
+      end
+
+      define_method("#{type}=") do |tasks|
+        set_section(type, tasks)
+      end
+
+      define_method("#{type}_tasks") do
+        section(type).tasks
+      end
+    end
+
+    ##
+    # Sections for this entry.
+    #
+    # @return [Array<StandupMD::Section>]
+    def sections
+      SECTION_TYPES.map { |type| section(type) }
+    end
+
+    ##
+    # Find a section by type.
+    #
+    # @param [Symbol, String] type
+    #
+    # @return [StandupMD::Section]
+    def section(type)
+      @sections[type.to_sym] ||= Section.new(type)
     end
 
     ##
@@ -115,5 +127,11 @@ module StandupMD
     def to_json
       to_h.to_json
     end
+
+    private
+
+    def set_section(type, tasks)
+      @sections[type.to_sym] = Section.new(type, tasks || [])
+    end
   end
 end

data/lib/standup_md/file.rb

@@ -2,14 +2,12 @@
 
 require "date"
 require "fileutils"
-require "standup_md/file/helpers"
+require "standup_md/parsers/markdown"
 
 module StandupMD
   ##
   # Class for handling reading and writing standup files.
   class File
-    include StandupMD::File::Helpers
-
     class << self
       ##
       # Access to the class's configuration.
@@ -88,6 +86,7 @@ module StandupMD
     # @return [StandupMP::File]
     def initialize(file_name)
       @config = self.class.config
+      @parser = StandupMD::Parsers::Markdown.new(@config)
       if file_name.include?(::File::SEPARATOR)
         raise ArgumentError,
           "#{file_name} contains directory. Please use `StandupMD.config.file.directory=`"
@@ -137,40 +136,14 @@ module StandupMD
 
     ##
     # 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 header?(line)
-          unless record.empty?
-            entry_list << new_entry(record)
-            record = {}
-          end
-          record["header"] = line.sub(/^\#{#{@config.header_depth}}\s*/, "")
-          section_type = @config.notes_header
-          record[section_type] = []
-        elsif 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
+      @entries = @parser.read(name)
       self
-    rescue => e
-      raise "File malformation: #{e}"
     end
 
     ##
@@ -185,20 +158,7 @@ module StandupMD
       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.public_send(attr)
-            next if !tasks || tasks.empty?
-
-            f.puts sub_header(@config.public_send("#{attr}_header").capitalize)
-            tasks.each { |task| f.puts "#{@config.bullet_character} #{task}" }
-          end
-          f.puts
-        end
-      end
-      true
+      @parser.write(name, sorted_entries, start_date: start_date, end_date: end_date)
     end
   end
 end

data/lib/standup_md/parsers/markdown.rb

@@ -0,0 +1,168 @@
+# frozen_string_literal: true
+
+require "date"
+require "standup_md/entry"
+require "standup_md/entry_list"
+require "standup_md/section"
+require "standup_md/task"
+require "standup_md/title"
+
+module StandupMD
+  module Parsers
+    ##
+    # Parser and renderer for the markdown standup format.
+    class Markdown
+      ##
+      # Access to file configuration.
+      #
+      # @return [StandupMD::Config::File]
+      attr_reader :config
+
+      ##
+      # Constructs an instance of +StandupMD::Parsers::Markdown+.
+      #
+      # @param [StandupMD::Config::File] config
+      def initialize(config = StandupMD.config.file)
+        @config = config
+      end
+
+      ##
+      # Reads entries from a markdown standup file.
+      #
+      # @param [String] file_name
+      #
+      # @return [StandupMD::EntryList]
+      def read(file_name)
+        entry_list = EntryList.new
+        record = nil
+        section = nil
+
+        ::File.foreach(file_name) do |line|
+          line.chomp!
+          next if line.strip.empty?
+
+          if header?(line)
+            entry_list << entry(record) if record
+            record = {title: title(line), sections: {}}
+            section = section(:notes)
+            record[:sections][:notes] = section
+          elsif sub_header?(line)
+            section = section(section_type(line))
+            record[:sections][section.type] = section
+          else
+            section << task(line)
+          end
+        end
+
+        entry_list << entry(record) if record
+        entry_list.sort
+      rescue => e
+        raise "File malformation: #{e}"
+      end
+
+      ##
+      # Writes entries to a markdown standup file.
+      #
+      # @param [String] file_name
+      # @param [StandupMD::EntryList] entries
+      # @param [Date] start_date
+      # @param [Date] end_date
+      #
+      # @return [Boolean]
+      def write(file_name, entries, start_date:, end_date:)
+        ::File.open(file_name, "w") do |f|
+          entries.filter(start_date, end_date).sort_reverse.each do |entry|
+            f.puts Title.new(entry.date).to_markdown
+            config.sub_header_order.each do |attr|
+              section = Section.new(attr, entry.public_send("#{attr}_tasks"))
+              next if section.empty?
+
+              f.puts section.to_markdown
+            end
+            f.puts
+          end
+        end
+        true
+      end
+
+      ##
+      # Renders a task as a markdown list item.
+      #
+      # @param [String, StandupMD::Task] task
+      #
+      # @return [String]
+      def task_line(task)
+        build_task(task).to_markdown
+      end
+
+      private
+
+      def header?(line)
+        line.match?(header_regex)
+      end
+
+      def sub_header?(line)
+        line.match?(sub_header_regex)
+      end
+
+      def header_regex
+        /^#{"#" * config.header_depth}\s+/
+      end
+
+      def sub_header_regex
+        /^#{"#" * config.sub_header_depth}\s+/
+      end
+
+      def title(line)
+        line.sub(/^\#{#{config.header_depth}}\s*/, "")
+      end
+
+      def section(type)
+        Section.new(type)
+      end
+
+      def section_type(line)
+        sub_header = line.sub(/^\#{#{config.sub_header_depth}}\s*/, "")
+        Entry::SECTION_TYPES.each do |type|
+          header = config.public_send("#{type}_header")
+          return type if sub_header.include?(header)
+        end
+        raise "Unrecognized header [#{sub_header}]"
+      end
+
+      def task(line)
+        match = line.match(task_regex)
+        return Task.new(line) unless match
+
+        Task.new(
+          match[:text],
+          indent_level: match[:indent].size / config.indent_width
+        )
+      end
+
+      def task_regex
+        /\A(?<indent>\s*)#{Regexp.escape(config.bullet_character)}\s*(?<text>.*)\z/
+      end
+
+      def entry(record)
+        Entry.new(
+          Date.strptime(record[:title], config.header_date_format),
+          tasks(record, :current),
+          tasks(record, :previous),
+          tasks(record, :impediments),
+          tasks(record, :notes)
+        )
+      end
+
+      def tasks(record, type)
+        record[:sections].fetch(type, Section.new(type)).tasks
+      end
+
+      def build_task(task)
+        return task if task.is_a?(Task)
+
+        Task.new(task)
+      end
+    end
+  end
+end

data/lib/standup_md/section.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require "standup_md/task"
+
+module StandupMD
+  ##
+  # A named section of a standup entry, such as current, previous,
+  # impediments, or notes.
+  class Section
+    ##
+    # The semantic section type.
+    #
+    # @return [Symbol]
+    attr_reader :type
+
+    ##
+    # Tasks for the section.
+    #
+    # @return [Array<StandupMD::Task>]
+    attr_reader :tasks
+
+    ##
+    # Constructs an instance of +StandupMD::Section+.
+    #
+    # @param [Symbol, String] type
+    # @param [Array<String, StandupMD::Task>] tasks
+    def initialize(type, tasks = [])
+      @type = type.to_sym
+      @tasks = tasks.map { |task| build_task(task) }
+    end
+
+    ##
+    # Adds a task to the section.
+    #
+    # @param [String, StandupMD::Task] task
+    #
+    # @return [Array<StandupMD::Task>]
+    def <<(task)
+      tasks << build_task(task)
+    end
+
+    ##
+    # Is the section empty?
+    #
+    # @return [Boolean]
+    def empty?
+      tasks.empty?
+    end
+
+    ##
+    # The configured section heading.
+    #
+    # @return [String]
+    def to_s
+      StandupMD.config.file.public_send("#{type}_header")
+    end
+
+    ##
+    # The section rendered as markdown lines.
+    #
+    # @return [Array<String>]
+    def to_markdown
+      [
+        "#" * StandupMD.config.file.sub_header_depth + " " + to_s,
+        *tasks.map(&:to_markdown)
+      ]
+    end
+
+    private
+
+    def build_task(task)
+      return task if task.is_a?(Task)
+
+      Task.new(task)
+    end
+  end
+end

data/lib/standup_md/task.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module StandupMD
+  ##
+  # A single standup task. The text stays format-neutral, while indentation
+  # level lets parsers render nested tasks for their own formats.
+  class Task
+    ##
+    # The task text.
+    #
+    # @return [String]
+    attr_reader :text
+
+    ##
+    # The nesting level of the task.
+    #
+    # @return [Integer]
+    attr_reader :indent_level
+
+    ##
+    # Constructs an instance of +StandupMD::Task+.
+    #
+    # @param [String] text
+    # @param [Integer] indent_level
+    def initialize(text, indent_level: 0)
+      unless indent_level.is_a?(Integer) && !indent_level.negative?
+        raise ArgumentError, "Indent level must be a non-negative integer"
+      end
+
+      @text = text.to_s
+      @indent_level = indent_level
+    end
+
+    ##
+    # The format-neutral task text.
+    #
+    # @return [String]
+    def to_s
+      text
+    end
+
+    ##
+    # The task rendered as a markdown list item.
+    #
+    # @return [String]
+    def to_markdown
+      indent = " " * StandupMD.config.file.indent_width * indent_level
+      "#{indent}#{StandupMD.config.file.bullet_character} #{text}"
+    end
+
+    ##
+    # Compares task contents.
+    def ==(other)
+      return text == other if other.is_a?(String)
+      return false unless other.is_a?(Task)
+
+      text == other.text && indent_level == other.indent_level
+    end
+  end
+end

data/lib/standup_md/title.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require "date"
+
+module StandupMD
+  ##
+  # The title for a standup entry.
+  class Title
+    ##
+    # The entry date.
+    #
+    # @return [Date]
+    attr_reader :date
+
+    ##
+    # Constructs an instance of +StandupMD::Title+.
+    #
+    # @param [Date] date
+    def initialize(date)
+      raise ArgumentError, "Must be a Date object" unless date.is_a?(Date)
+
+      @date = date
+    end
+
+    ##
+    # The configured title text.
+    #
+    # @return [String]
+    def to_s
+      date.strftime(StandupMD.config.file.header_date_format)
+    end
+
+    ##
+    # The title rendered as markdown.
+    #
+    # @return [String]
+    def to_markdown
+      "#" * StandupMD.config.file.header_depth + " " + to_s
+    end
+  end
+end

data/lib/standup_md/version.rb

@@ -9,19 +9,19 @@ module StandupMD
     # Major version.
     #
     # @return [Integer]
-    MAJOR = 0
+    MAJOR = 1
 
     ##
     # Minor version.
     #
     # @return [Integer]
-    MINOR = 3
+    MINOR = 0
 
     ##
     # Patch version.
     #
     # @return [Integer]
-    PATCH = 17
+    PATCH = 0
 
     ##
     # Version as +[MAJOR, MINOR, PATCH]+

data/lib/standup_md.rb

@@ -1,11 +1,15 @@
 # frozen_string_literal: true
 
 require "standup_md/version"
-require "standup_md/file"
+require "standup_md/config"
+require "standup_md/task"
+require "standup_md/title"
+require "standup_md/section"
 require "standup_md/entry"
 require "standup_md/entry_list"
+require "standup_md/parsers/markdown"
+require "standup_md/file"
 require "standup_md/cli"
-require "standup_md/config"
 
 ##
 # The main module for the gem. Provides access to configuration classes.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: standup_md
 version: !ruby/object:Gem::Version
-  version: 0.3.17
+  version: 1.0.0
 platform: ruby
 authors:
 - Evan Gray
@@ -119,7 +119,10 @@ files:
 - 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/parsers/markdown.rb
+- lib/standup_md/section.rb
+- lib/standup_md/task.rb
+- lib/standup_md/title.rb
 - lib/standup_md/version.rb
 - standup_md.gemspec
 homepage: https://evanthegrayt.github.io/standup_md/

data/lib/standup_md/file/helpers.rb

@@ -1,65 +0,0 @@
-# frozen_string_literal: true
-
-module StandupMD
-  class File
-    ##
-    # Module responsible for reading and writing standup files.
-    module Helpers # :nodoc:
-      private
-
-      def header?(line) # :nodoc:
-        line.match(header_regex)
-      end
-
-      def sub_header?(line) # :nodoc:
-        line.match(sub_header_regex)
-      end
-
-      def header_regex # :nodoc:
-        /^#{"#" * StandupMD.config.file.header_depth}\s+/
-      end
-
-      def sub_header_regex # :nodoc:
-        /^#{"#" * StandupMD.config.file.sub_header_depth}\s+/
-      end
-
-      def bullet_character_regex # :nodoc:
-        /\s*#{StandupMD.config.file.bullet_character}\s*/
-      end
-
-      def determine_section_type(line) # :nodoc:
-        line = line.sub(/^\#{#{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(subhead)
-        "#" * StandupMD.config.file.sub_header_depth + " " + subhead
-      end
-    end
-  end
-end