standup_md 0.3.0 → 0.3.5

data/lib/standup_md.rb

@@ -8,12 +8,12 @@ require_relative 'standup_md/cli'
 require_relative 'standup_md/config'
 
 ##
-# The class for handing reading/writing of entries.
+# The main module for the gem. Provides access to configuration classes.
 module StandupMD
   @config_file_loaded = false
 
   ##
-  # Shorthand for +StanupMD::Cli+
+  # Method for accessing the configuration.
   #
   # @return [StanupMD::Cli]
   def self.config

data/lib/standup_md/cli/helpers.rb

@@ -18,11 +18,11 @@ module StandupMD
           puts "No record found for #{StandupMD.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)
+        StandupMD.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
+          puts sub_header(header_type)
           tasks.each { |task| puts StandupMD.config.file.bullet_character + ' ' + task }
         end
         puts
@@ -137,7 +137,9 @@ module StandupMD
       #
       # @return [Array]
       def set_previous_entry(file)
-        return [] unless StandupMD.config.cli.auto_fill_previous
+        unless StandupMD.config.cli.auto_fill_previous
+          return Standup.config.entry.previous_entry
+        end
         return prev_entry(prev_file.load.entries) if file.new? && prev_file
         prev_entry(file.entries)
       end
@@ -160,6 +162,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)
+        '#' * StandupMD.config.file.header_depth + ' ' +
+          entry.date.strftime(StandupMD.config.file.header_date_format)
+      end
+
+      ##
+      # The sub-header.
+      #
+      # @param [String] header_type
+      #
+      # @return [String]
+      def sub_header(header_type)
+        '#' * StandupMD.config.file.sub_header_depth + ' ' +
+          StandupMD.config.file.public_send("#{header_type}_header").capitalize
+      end
     end
   end
 end

data/lib/standup_md/config.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'config/cli'
 require_relative 'config/file'
 require_relative 'config/entry'

data/lib/standup_md/config/cli.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'date'
 
 module StandupMD
@@ -7,6 +8,23 @@ module StandupMD
     ##
     # The configuration class for StandupMD::Cli
     class Cli
+
+      ##
+      # The default options.
+      #
+      # @return [Hash]
+      DEFAULTS = {
+        date: Date.today,
+        editor: ENV['VISUAL'] || ENV['EDITOR'] || 'vim',
+        verbose: false,
+        edit: true,
+        write: true,
+        print: false,
+        auto_fill_previous: true,
+        preference_file:
+          ::File.expand_path(::File.join(ENV['HOME'], '.standuprc')),
+      }
+
       ##
       # 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.
@@ -33,7 +51,7 @@ module StandupMD
       attr_accessor :edit
 
       ##
-      # Should the cli write the file?
+      # Should the cli automatically write the new entry to the file?
       #
       # @param [Boolean] write
       #
@@ -41,7 +59,7 @@ module StandupMD
       attr_accessor :write
 
       ##
-      # Should the cli print the entry?
+      # Should the cli print the entry to the command line?
       #
       # @param [Boolean] print
       #
@@ -49,7 +67,7 @@ module StandupMD
       attr_accessor :print
 
       ##
-      # The date to use to find the file.
+      # The date to use to find the entry.
       #
       # @param [Date] date
       #
@@ -76,30 +94,15 @@ module StandupMD
       ##
       # Initializes the config with default values.
       def initialize
-        reset_values
+        reset
       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'
+      # @return [Hash]
+      def reset
+        DEFAULTS.each { |k, v| instance_variable_set("@#{k}", v) }
       end
     end
   end

data/lib/standup_md/config/entry.rb

@@ -7,6 +7,17 @@ module StandupMD
     # The configuration class for StandupMD::Entry
     class Entry
 
+      ##
+      # The default options.
+      #
+      # @return [Hash]
+      DEFAULTS = {
+        current: ["<!-- ADD TODAY'S WORK HERE -->"],
+        previous: [],
+        impediments: ['None'],
+        notes: [],
+      }
+
       ##
       # Tasks for "Current" section.
       #
@@ -42,19 +53,15 @@ module StandupMD
       ##
       # Initializes the config with default values.
       def initialize
-        reset_values
+        reset
       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
+      # @return [Hash]
+      def reset
+        DEFAULTS.each { |k, v| instance_variable_set("@#{k}", v) }
       end
     end
   end

data/lib/standup_md/config/entry_list.rb

@@ -7,19 +7,24 @@ module StandupMD
     # The configuration class for StandupMD::EntryList
     class EntryList
 
+      ##
+      # The default options.
+      #
+      # @return [Hash]
+      DEFAULTS = {}
+
       ##
       # Initializes the config with default values.
       def initalize
-        reset_values
+        reset
       end
 
       ##
       # Sets all config values back to their defaults.
       #
-      # @return [Boolean] true if successful
-      def reset_values
-        # TODO add order ascending or decending.
-        true
+      # @return [Hash]
+      def reset
+        DEFAULTS.each { |k, v| instance_variable_set("@#{k}", v) }
       end
     end
   end

data/lib/standup_md/config/file.rb

@@ -1,9 +1,31 @@
+# frozen_string_literal: true
+
 module StandupMD
   class Config
 
     ##
     # The configuration class for StandupMD::File
     class File
+
+      ##
+      # The default options.
+      #
+      # @return [Hash]
+      DEFAULTS = {
+        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,
+      }
+
       ##
       # Number of octothorps that should preface entry headers.
       #
@@ -116,27 +138,15 @@ module StandupMD
       ##
       # Initializes the config with default values.
       def initialize
-        reset_values
+        reset
       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
+      # @return [Hash]
+      def reset
+        DEFAULTS.each { |k, v| instance_variable_set("@#{k}", v) }
       end
 
       ##

data/lib/standup_md/entry.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'json'
 
 module StandupMD
@@ -38,7 +39,7 @@ module StandupMD
     attr_accessor :previous
 
     ##
-    # Iimpediments for this entry.
+    # Impediments for this entry.
     #
     # @return [Array]
     attr_accessor :impediments

data/lib/standup_md/entry_list.rb

@@ -1,10 +1,12 @@
 # frozen_string_literal: true
+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,24 +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 }
-    end
-
-    ##
-    # How many entries are in the list.
     #
-    # @return [Integer]
-    def size
-      @entries.size
-    end
-
-    ##
-    # Is the list empty?
+    # @param [Date] date
     #
-    # @return [Boolean] true if empty
-    def empty?
-      @entries.empty?
+    # @return [StandupMD::Entry]
+    def find(date)
+      entries.bsearch { |e| e.date == date }
     end
 
     ##
@@ -124,24 +108,6 @@ module StandupMD
       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.
     #
@@ -162,5 +128,22 @@ module StandupMD
     def to_json
       to_h.to_json
     end
+
+    # :section: Delegators
+
+    ##
+    # The following are forwarded to @entries, which is the underly array of
+    # entries.
+    #
+    # +each+:: Iterate over each entry.
+    #
+    # +empty?+:: Is the list empty?
+    #
+    # +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

@@ -19,6 +19,16 @@ module StandupMD
       @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.
     #
@@ -138,6 +148,7 @@ module StandupMD
       entry_list << new_entry(record) unless record.empty?
       @loaded = true
       @entries = entry_list.sort
+      self
     rescue => e
       raise "File malformation: #{e}"
     end
@@ -147,7 +158,7 @@ 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 = {})
@@ -158,9 +169,9 @@ 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