standup_md 0.3.2 → 0.3.7

data/lib/standup_md.rb

@@ -8,7 +8,7 @@ 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
 
@@ -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

@@ -1,14 +1,14 @@
+# frozen_string_literal: true
+
 require_relative 'config/cli'
 require_relative 'config/file'
 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

@@ -1,12 +1,28 @@
 # frozen_string_literal: true
+
 require 'date'
 
 module StandupMD
   class Config
-
     ##
     # 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'))
+      }.freeze
+
       ##
       # 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 +49,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 +57,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 +65,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
       #
@@ -82,24 +98,9 @@ module StandupMD
       ##
       # Sets all config values back to their defaults.
       #
-      # @return [Boolean] true if successful
+      # @return [Hash]
       def reset
-        @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'
+        DEFAULTS.each { |k, v| instance_variable_set("@#{k}", v) }
       end
     end
   end

data/lib/standup_md/config/entry.rb

@@ -2,10 +2,19 @@
 
 module StandupMD
   class Config
-
     ##
     # The configuration class for StandupMD::Entry
     class Entry
+      ##
+      # The default options.
+      #
+      # @return [Hash]
+      DEFAULTS = {
+        current: ["<!-- ADD TODAY'S WORK HERE -->"],
+        previous: [],
+        impediments: ['None'],
+        notes: []
+      }.freeze
 
       ##
       # Tasks for "Current" section.
@@ -48,13 +57,9 @@ module StandupMD
       ##
       # Sets all config values back to their defaults.
       #
-      # @return [Boolean] true if successful
+      # @return [Hash]
       def reset
-        @current = ["<!-- ADD TODAY'S WORK HERE -->"]
-        @previous = []
-        @impediments = ['None']
-        @notes = []
-        true
+        DEFAULTS.each { |k, v| instance_variable_set("@#{k}", v) }
       end
     end
   end

data/lib/standup_md/config/entry_list.rb

@@ -7,6 +7,12 @@ module StandupMD
     # The configuration class for StandupMD::EntryList
     class EntryList
 
+      ##
+      # The default options.
+      #
+      # @return [Hash]
+      DEFAULTS = {}
+
       ##
       # Initializes the config with default values.
       def initalize
@@ -16,10 +22,9 @@ module StandupMD
       ##
       # Sets all config values back to their defaults.
       #
-      # @return [Boolean] true if successful
+      # @return [Hash]
       def reset
-        # TODO add order ascending or decending.
-        true
+        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.
       #
@@ -122,21 +144,9 @@ module StandupMD
       ##
       # Sets all config values back to their defaults.
       #
-      # @return [Boolean] true if successful
+      # @return [Hash]
       def reset
-        @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
+        DEFAULTS.each { |k, v| instance_variable_set("@#{k}", v) }
       end
 
       ##