standup_md 0.3.3 → 0.3.8

data/lib/standup_md.rb

@@ -34,7 +34,7 @@ module StandupMD
   # @example
   #   StandupMD.configure { |s| s.cli.editor = 'mate' }
   def self.configure
-    yield self.config
+    yield config
   end
 
   ##
@@ -52,6 +52,7 @@ module StandupMD
   def self.load_config_file(file)
     file = ::File.expand_path(file)
     raise "File #{file} does not exist." unless ::File.file?(file)
+
     @config_file_loaded = true
     load file
   end

data/lib/standup_md/cli.rb

@@ -4,7 +4,6 @@ require 'optparse'
 require_relative 'cli/helpers'
 
 module StandupMD
-
   ##
   # Class for handing the command-line interface.
   class Cli
@@ -66,10 +65,10 @@ module StandupMD
       @preference_file_loaded = false
       @options = options
       load_preferences if load_config
-      set_preferences(options)
+      load_runtime_preferences(options)
       @file = StandupMD::File.find_by_date(@config.date)
       @file.load
-      @entry = set_entry(@file)
+      @entry = new_entry(@file)
     end
 
     ##

data/lib/standup_md/cli/helpers.rb

@@ -2,11 +2,9 @@
 
 module StandupMD
   class Cli
-
     ##
     # Module responsible for reading and writing standup files.
     module Helpers
-
       ##
       # Print an entry to the command line.
       #
@@ -15,99 +13,108 @@ module StandupMD
       # @return [nil]
       def print(entry)
         if entry.nil?
-          puts "No record found for #{StandupMD.config.cli.date}"
+          puts "No record found for #{config.cli.date}"
           return
         end
-        puts '#' * StandupMD.config.file.header_depth + ' ' + entry.date.strftime(StandupMD.config.file.header_date_format)
-        StandupMD.config.file.sub_header_order.each do |attr|
-          tasks = entry.send(attr)
+        puts header(entry)
+        config.file.sub_header_order.each do |header_type|
+          tasks = entry.public_send(header_type)
           next if !tasks || tasks.empty?
-          puts '#' * StandupMD.config.file.sub_header_depth + ' ' + StandupMD.config.file.send("#{attr}_header").capitalize
-          tasks.each { |task| puts StandupMD.config.file.bullet_character + ' ' + task }
+
+          puts sub_header(header_type)
+          tasks.each { |task| puts config.file.bullet_character + ' ' + task }
         end
         puts
       end
 
       private
 
+      ##
+      # Helper for accessing config.
+      #
+      # @return [StandupMD::Config]
+      def config # :nodoc:
+        StandupMD.config
+      end
+
       ##
       # Parses options passed at runtime and concatenates them with the options
       # in the user's preferences file. Reveal source to see options.
       #
       # @return [Hash]
-      def set_preferences(options)
+      def load_runtime_preferences(options)
         OptionParser.new do |opts|
           opts.banner = 'The Standup Doctor'
-          opts.version = "[StandupMD] #{::StandupMD::VERSION}"
+          opts.version = "[StandupMD] #{::StandupMD::Version}"
           opts.on(
             '--current ARRAY', Array,
             "List of current entry's tasks"
-          ) { |v| StandupMD.config.entry.current = v }
+          ) { |v| config.entry.current = v }
 
           opts.on(
             '--previous ARRAY', Array,
             "List of precious entry's tasks"
-          ) { |v| StandupMD.config.entry.previous = v }
+          ) { |v| config.entry.previous = v }
 
           opts.on(
             '--impediments ARRAY', Array,
             'List of impediments for current entry'
-          ) { |v| StandupMD.config.entry.impediments = v }
+          ) { |v| config.entry.impediments = v }
 
           opts.on(
             '--notes ARRAY', Array,
             'List of notes for current entry'
-          ) { |v| StandupMD.config.entry.notes = v }
+          ) { |v| config.entry.notes = v }
 
           opts.on(
             '--sub-header-order ARRAY', Array,
             'The order of the sub-headers when writing the file'
-          ) { |v| StandupMD.config.file.sub_header_order = v }
+          ) { |v| config.file.sub_header_order = v }
 
           opts.on(
             '-f', '--file-name-format STRING',
             'Date-formattable string to use for standup file name'
-          ) { |v| StandupMD.config.file.name_format = v }
+          ) { |v| config.file.name_format = v }
 
           opts.on(
             '-E', '--editor EDITOR',
             'Editor to use for opening standup files'
-          ) { |v| StandupMD.config.cli.editor = v }
+          ) { |v| config.cli.editor = v }
 
           opts.on(
             '-d', '--directory DIRECTORY',
             'The directories where standup files are located'
-          ) { |v| StandupMD.config.file.directory = v }
+          ) { |v| config.file.directory = v }
 
           opts.on(
             '-w', '--[no-]write',
             "Write current entry if it doesn't exist. Default is true"
-          ) { |v| StandupMD.config.cli.write = v }
+          ) { |v| config.cli.write = v }
 
           opts.on(
             '-a', '--[no-]auto-fill-previous',
             "Auto-generate 'previous' tasks for new entries. Default is true"
-          ) { |v| StandupMD.config.cli.auto_fill_previous = v }
+          ) { |v| config.cli.auto_fill_previous = v }
 
           opts.on(
             '-e', '--[no-]edit',
             'Open the file in the editor. Default is true'
-          ) { |v| StandupMD.config.cli.edit = v }
+          ) { |v| config.cli.edit = v }
 
           opts.on(
             '-v', '--[no-]verbose',
             'Verbose output. Default is false.'
-          ) { |v| StandupMD.config.cli.verbose = v }
+          ) { |v| config.cli.verbose = v }
 
           opts.on(
             '-p', '--print [DATE]',
             'Print current entry.',
             'If DATE is passed, will print entry for DATE, if it exists.',
-            'DATE must be in the same format as file-name-format',
+            'DATE must be in the same format as file-name-format'
           ) do |v|
-            StandupMD.config.cli.print = true
-            StandupMD.config.cli.date =
-              v.nil? ? Date.today : Date.strptime(v, StandupMD.config.file.header_date_format)
+            config.cli.print = true
+            config.cli.date =
+              v.nil? ? Date.today : Date.strptime(v, config.file.header_date_format)
           end
         end.parse!(options)
       end
@@ -116,16 +123,16 @@ module StandupMD
       # The entry for today.
       #
       # @return [StandupMD::Entry]
-      def set_entry(file)
-        entry = file.entries.find(StandupMD.config.cli.date)
-        if entry.nil? && StandupMD.config.cli.date == Date.today
+      def new_entry(file)
+        entry = file.entries.find(config.cli.date)
+        if entry.nil? && config.cli.date == Date.today
           previous_entry = set_previous_entry(file)
           entry = StandupMD::Entry.new(
-            StandupMD.config.cli.date,
-            StandupMD.config.entry.current,
+            config.cli.date,
+            config.entry.current,
             previous_entry,
-            StandupMD.config.entry.impediments,
-            StandupMD.config.entry.notes
+            config.entry.impediments,
+            config.entry.notes
           )
           file.entries << entry
         end
@@ -137,8 +144,10 @@ module StandupMD
       #
       # @return [Array]
       def set_previous_entry(file)
-        return [] unless StandupMD.config.cli.auto_fill_previous
+        return config.entry.previous_entry unless config.cli.auto_fill_previous
+
         return prev_entry(prev_file.load.entries) if file.new? && prev_file
+
         prev_entry(file.entries)
       end
 
@@ -150,6 +159,7 @@ module StandupMD
       # @return [StandupMD::Entry]
       def prev_entry(entries)
         return [] if entries.empty?
+
         entries.last.current
       end
 
@@ -160,6 +170,28 @@ module StandupMD
       def prev_file
         StandupMD::File.find_by_date(Date.today.prev_month)
       end
+
+      ##
+      # The header.
+      #
+      # @param [StandupMD::Entry] entry
+      #
+      # @return [String]
+      def header(entry)
+        '#' * config.file.header_depth + ' ' +
+          entry.date.strftime(config.file.header_date_format)
+      end
+
+      ##
+      # The sub-header.
+      #
+      # @param [String] header_type
+      #
+      # @return [String]
+      def sub_header(header_type)
+        '#' * config.file.sub_header_depth + ' ' +
+          config.file.public_send("#{header_type}_header").capitalize
+      end
     end
   end
 end

data/lib/standup_md/config.rb

@@ -6,11 +6,9 @@ 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.
     #

data/lib/standup_md/config/cli.rb

@@ -4,11 +4,9 @@ require 'date'
 
 module StandupMD
   class Config
-
     ##
     # The configuration class for StandupMD::Cli
     class Cli
-
       ##
       # The default options.
       #
@@ -22,8 +20,8 @@ module StandupMD
         print: false,
         auto_fill_previous: true,
         preference_file:
-          ::File.expand_path(::File.join(ENV['HOME'], '.standuprc')),
-      }
+          ::File.expand_path(::File.join(ENV['HOME'], '.standuprc'))
+      }.freeze
 
       ##
       # The editor to use when opening standup files. If one is not set, the

data/lib/standup_md/config/entry.rb

@@ -2,11 +2,9 @@
 
 module StandupMD
   class Config
-
     ##
     # The configuration class for StandupMD::Entry
     class Entry
-
       ##
       # The default options.
       #
@@ -15,8 +13,8 @@ module StandupMD
         current: ["<!-- ADD TODAY'S WORK HERE -->"],
         previous: [],
         impediments: ['None'],
-        notes: [],
-      }
+        notes: []
+      }.freeze
 
       ##
       # Tasks for "Current" section.

data/lib/standup_md/entry.rb

@@ -3,7 +3,6 @@
 require 'json'
 
 module StandupMD
-
   ##
   # Class for handling single entries. Includes the comparable module, and
   # compares by date.
@@ -39,7 +38,7 @@ module StandupMD
     attr_accessor :previous
 
     ##
-    # Iimpediments for this entry.
+    # Impediments for this entry.
     #
     # @return [Array]
     attr_accessor :impediments
@@ -56,15 +55,13 @@ module StandupMD
     #
     # @return [StandupMD::Entry]
     def self.create
-      entry = new(
+      new(
         Date.today,
         config.current,
         config.previous,
         config.impediments,
         config.notes
-      )
-      yield config if block_given?
-      entry
+      ).tap { |entry| yield entry if block_given? }
     end
 
     ##

data/lib/standup_md/entry_list.rb

@@ -1,10 +1,12 @@
 # frozen_string_literal: true
 
-module StandupMD
+require 'forwardable'
 
+module StandupMD
   ##
   # Enumerable list of entries.
   class EntryList
+    extend Forwardable
     include Enumerable
 
     ##
@@ -29,12 +31,6 @@ module StandupMD
       @entries = entries
     end
 
-    ##
-    # Iterate over the list and yield each entry.
-    def each(&block)
-      @entries.each(&block)
-    end
-
     ##
     # Appends entries to list.
     #
@@ -51,8 +47,12 @@ module StandupMD
     ##
     # 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 }
+    #
+    # @param [Date] date
+    #
+    # @return [StandupMD::Entry]
+    def find(date)
+      entries.bsearch { |e| e.date == date }
     end
 
     ##
@@ -129,38 +129,21 @@ module StandupMD
       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
+    # :section: Delegators
 
     ##
-    # The last entry in the list. This method assumes the list has
-    # already been sorted.
+    # The following are forwarded to @entries, which is the underly array of
+    # entries.
     #
-    # @return [StandupMD::Entry]
-    def last
-      to_a.last
-    end
-
-    ##
-    # How many entries are in the list.
+    # +each+:: Iterate over each entry.
     #
-    # @return [Integer]
-    def size
-      @entries.size
-    end
-
-    ##
-    # Is the list empty?
+    # +empty?+:: Is the list empty?
     #
-    # @return [Boolean] true if empty
-    def empty?
-      @entries.empty?
-    end
+    # +size+:: How many items are in the list?
+    #
+    # +first+:: The first record in the list.
+    #
+    # +last+:: The last record in the list.
+    def_delegators :@entries, :each, :empty?, :size, :first, :last
   end
 end

data/lib/standup_md/file.rb

@@ -5,7 +5,6 @@ require 'fileutils'
 require_relative 'file/helpers'
 
 module StandupMD
-
   ##
   # Class for handling reading and writing standup files.
   class File
@@ -26,6 +25,11 @@ module StandupMD
     #
     # @return [StandupMD::File]
     def self.load(file_name)
+      unless ::File.directory?(config.directory)
+        raise "Dir #{config.directory} not found." unless config.create
+
+        FileUtils.mkdir_p(config.directory)
+      end
       new(file_name).load
     end
 
@@ -34,10 +38,14 @@ module StandupMD
     #
     # @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
+      unless ::File.directory?(config.directory)
+        raise "Dir #{config.directory} not found." unless config.create
+
+        FileUtils.mkdir_p(config.directory)
       end
+      file = Dir.entries(config.directory).bsearch { |f| f == file_name }
+      raise "File #{file_name} not found." if file.nil? && !config.create
+
       new(file_name)
     end
 
@@ -46,8 +54,12 @@ module StandupMD
     #
     # @param [Date] date
     def self.find_by_date(date)
-      unless date.is_a?(Date)
-        raise ArgumentError, "Argument must be a Date object"
+      raise ArgumentError, 'Must be a Date object' unless date.is_a?(Date)
+
+      unless ::File.directory?(config.directory)
+        raise "Dir #{config.directory} not found." unless config.create
+
+        FileUtils.mkdir_p(config.directory)
       end
       find(date.strftime(config.name_format))
     end
@@ -79,6 +91,7 @@ module StandupMD
 
       unless ::File.directory?(@config.directory)
         raise "Dir #{@config.directory} not found." unless @config.create
+
         FileUtils.mkdir_p(@config.directory)
       end
 
@@ -86,6 +99,7 @@ module StandupMD
 
       unless ::File.file?(@name)
         raise "File #{@name} not found." unless @config.create
+
         FileUtils.touch(@name)
       end
 
@@ -124,21 +138,23 @@ module StandupMD
     # @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)
+
+        if 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)
+          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
@@ -158,10 +174,10 @@ module StandupMD
     # 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
+    # @param [Hash] {start_date: Date, end_date: Date}
     #
     # @return [Boolean] true if successful
-    def write(dates = {})
+    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)
@@ -169,9 +185,10 @@ module StandupMD
         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)
+            tasks = entry.public_send(attr)
             next if !tasks || tasks.empty?
-            f.puts sub_header(@config.send("#{attr}_header").capitalize)
+
+            f.puts sub_header(@config.public_send("#{attr}_header").capitalize)
             tasks.each { |task| f.puts @config.bullet_character + ' ' + task }
           end
           f.puts