standup_md 0.2.1 → 0.3.0

data/lib/standup_md/cli.rb

@@ -1,29 +1,50 @@
-require 'json'
+# frozen_string_literal: true
+
 require 'optparse'
-require_relative '../standup_md'
+require_relative 'cli/helpers'
+
+module StandupMD
 
-class StandupMD
   ##
   # Class for handing the command-line interface.
   class Cli
+    include Helpers
+
+    ##
+    # Access to the class's configuration.
+    #
+    # @return [StandupMD::Config::Cli]
+    def self.config
+      @config ||= StandupMD.config.cli
+    end
 
     ##
-    # The user's preference file.
-    PREFERENCE_FILE =
-      File.expand_path(File.join(ENV['HOME'], '.standup_md.yml')).freeze
+    # Prints output if +verbose+ is true.
+    #
+    # @return [nil]
+    def self.echo(msg)
+      puts msg if config.verbose
+    end
 
     ##
     # Creates an instance of +StandupMD+ and runs what the user requested.
     def self.execute(options = [])
       exe = new(options)
-      exe.append_to_previous_entry_tasks if exe.should_append?
 
-      exe.print_current_entry if exe.print_current_entry?
-      exe.print_all_entries   if exe.print_all_entries?
-      exe.write_file          if exe.write?
-      exe.edit                if exe.edit?
+      exe.write_file if config.write
+      if config.print
+        exe.print(exe.entry)
+      elsif config.edit
+        exe.edit
+      end
     end
 
+    ##
+    # The entry searched for, usually today.
+    #
+    # @return [StandupMD::Entry]
+    attr_reader :entry
+
     ##
     # Arguments passed at runtime.
     #
@@ -31,115 +52,54 @@ class StandupMD
     attr_reader :options
 
     ##
-    # Preferences after reading config file and parsing ARGV.
+    # The file loaded.
     #
-    # @return [Array]
-    attr_reader :preferences
+    # @return [StandupMD::File]
+    attr_reader :file
 
     ##
     # Constructor. Sets defaults.
     #
     # @param [Array] options
-    def initialize(options)
-      @edit                = true
-      @write               = true
-      @append_previous     = true
-      @print_current_entry = false
-      @json                = false
-      @verbose             = false
-      @print_all_entries   = false
-      @options             = options
-      @preferences         = get_preferences
+    def initialize(options = [], load_config = true)
+      @config = self.class.config
+      @preference_file_loaded = false
+      @options = options
+      load_preferences if load_config
+      set_preferences(options)
+      @file = StandupMD::File.find_by_date(@config.date)
+      @file.load
+      @entry = set_entry(@file)
     end
 
     ##
-    # Sets up an instance of +StandupMD+ and passes all user preferences.
-    #
-    # @return [StandupMD]
-    def standup
-      cf = File.file?(PREFERENCE_FILE) ? PREFERENCE_FILE : nil
-      @standup ||= ::StandupMD.new(cf) do |s|
-        if s.config.any?
-          echo 'Config options:'
-          s.config.each { |k, v| echo "  #{k} = #{v}" }
-        end
-        echo 'Runtime options:' if preferences.any?
-        preferences.each do |k, v|
-          echo "  #{k} = #{v}"
-          s.send("#{k}=", v)
-        end
-      end.load
-    end
-
-    ##
-    # Tries to determine the editor, first by checking if the user has one set
-    # in their preferences. If not, the +VISUAL+ and +EDITOR+ environmental
-    # variables are checked. If none of the above are set, defaults to +vim+.
-    #
-    # @return [String] The editor
-    def editor
-      @editor ||=
-        if standup.config.key?('editor')
-          echo "Editor set to [#{standup.config['editor']}] via preferences"
-          standup.config['editor']
-        elsif ENV['VISUAL']
-          echo "Editor set to [#{ENV['VISUAL']}] (ENV['VISUAL'])"
-          ENV['VISUAL']
-        elsif ENV['EDITOR']
-          echo "Editor set to [#{ENV['EDITOR']}] (ENV['EDITOR'])"
-          ENV['EDITOR']
-        else
-          echo "Editor set to [vim] (default)"
-          'vim'
-        end
-    end
-
-    ##
-    # Prints all entries to the command line.
-    #
-    # @return [nil]
-    def print_all_entries
-      echo 'Display all entries'
-      unless json?
-        standup.all_entries.keys.reverse.each do |head|
-          print_entry(head, standup.all_entries[head])
-        end
-        return
-      end
-      echo '  ...as json'
-      puts standup.all_entries.to_json
-    end
-
-    ##
-    # Prints the current entry to the command line.
+    # Load the preference file.
     #
     # @return [nil]
-    def print_current_entry
-      echo 'Print current entry'
-      unless json?
-        print_entry(standup.header, standup.current_entry)
-        return
+    def load_preferences
+      if ::File.exist?(@config.preference_file)
+        ::StandupMD.load_config_file(@config.preference_file)
+        @preference_file_loaded = true
+      else
+        echo "Preference file #{@config.preference_file} does not exist."
       end
-      echo '  ...as json'
-      entry = {standup.header => standup.current_entry}.to_json
-      puts entry
     end
 
     ##
-    # Appends entries passed at runtime to existing previous entries.
+    # Has the preference file been loaded?
     #
-    # @return [Hash]
-    def append_to_previous_entry_tasks
-      echo 'Appending previous entry tasks'
-      additions = preferences.delete('previous_entry_tasks')
-      standup.previous_entry_tasks.concat(additions)
+    # @return boolean
+    def preference_file_loaded?
+      @preference_file_loaded
     end
 
     ##
     # Opens the file in an editor. Abandons the script.
+    #
+    # @return [nil]
     def edit
-      echo "Opening file in #{editor}"
-      exec("#{editor} #{standup.file}")
+      echo "Opening file in #{@config.editor}"
+      exec("#{@config.editor} #{file.name}")
     end
 
     ##
@@ -147,159 +107,16 @@ class StandupMD
     #
     # @return [Boolean] true if file was written
     def write_file
-      echo 'Writing file'
-      standup.write
-    end
-
-    ##
-    # Should current entry be printed? If true, disables editing.
-    #
-    # @return [Boolean] Default is false
-    def print_current_entry?
-      @print_current_entry
-    end
-
-    ##
-    # If printing an entry, should it be printed as json?
-    #
-    # @return [Boolean] Default is false
-    def json?
-      @json
-    end
-
-    ##
-    # Should all entries be printed? If true, disables editing.
-    #
-    # @return [Boolean] Default is false
-    def print_all_entries?
-      @print_all_entries
+      echo "Writing file #{file.name}"
+      file.write
     end
 
     ##
-    # Should debug info be printed?
-    #
-    # @return [Boolean] Default is false
-    def verbose?
-      @verbose
-    end
-
-    ##
-    # Should the file be written?
-    #
-    # @return [Boolean] Default is true
-    def write?
-      @write
-    end
-
-    ##
-    # Should the standup file be opened in the editor?
-    #
-    # @return [Boolean] Default is true
-    def edit?
-      @edit
-    end
-
-    ##
-    # Should `previous_entry_tasks` be appended? If false,
-    # +previous_entry_tasks+ will be overwritten.
-    #
-    # @return [Boolean] Default is true
-    def append_previous?
-      @append_previous
-    end
-
-    ##
-    # Did the user pass +previous_entry_tasks+, and should we append?
-    #
-    # @return [Boolean]
-    def should_append?
-      preferences.key?('previous_entry_tasks') && append_previous?
-    end
-
-    ##
-    # Prints output if +verbose+ is true.
+    # Quick access to Cli.echo.
     #
     # @return [nil]
     def echo(msg)
-      puts msg if verbose?
-    end
-
-    private
-
-    ##
-    # Prints entries to the command line as markdown.
-    def print_entry(head, s_heads) # :nodoc:
-      puts '#' * standup.header_depth + ' ' + head
-      s_heads.each do |s_head, tasks|
-        puts '#' * standup.sub_header_depth + ' ' + s_head
-        tasks.each { |task| puts standup.bullet_character + ' ' + task }
-      end
-      puts
-    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 get_preferences # :nodoc:
-      prefs = {}
-
-      OptionParser.new do |opts|
-        opts.banner = 'The Standup Doctor'
-        opts.version = ::StandupMD::VERSION
-        opts.on('--current-entry-tasks=ARRAY', Array, "List of current entry's tasks") do |v|
-          prefs['current_entry_tasks'] = v
-        end
-        opts.on('--previous-entry-tasks=ARRAY', Array, "List of precious entry's tasks") do |v|
-          prefs['previous_entry_tasks'] = v
-        end
-        opts.on('--impediments=ARRAY', Array, 'List of impediments for current entry') do |v|
-          prefs['impediments'] = v
-        end
-        opts.on('--notes=ARRAY', Array, 'List of notes for current entry') do |v|
-          prefs['notes'] = v
-        end
-        opts.on('--sub-header-order=ARRAY', Array, 'The order of the sub-headers when writing the file') do |v|
-          prefs['sub_header_order'] = v
-        end
-        opts.on('--[no-]append-previous', 'Append previous tasks? Default is true') do |v|
-          @append_previous = v
-        end
-        opts.on('-f', '--file-name-format=STRING', 'Date-formattable string to use for standup file name') do |v|
-          prefs['file_name_format'] = v
-        end
-        opts.on('-e', '--editor=EDITOR', 'Editor to use for opening standup files') do |v|
-          @editor = v
-        end
-        opts.on('-d', '--directory=DIRECTORY', 'The directories where standup files are located') do |v|
-          prefs['directory'] = v
-        end
-        opts.on('--[no-]write', "Write current entry if it doesn't exist. Default is true") do |v|
-          @write = v
-        end
-        opts.on('--[no-]edit', 'Open the file in the editor. Default is true') do |v|
-          @edit = v
-        end
-        opts.on('-j', '--[no-]json', 'Print output as formatted json. Default is false.') do |v|
-          @json = v
-        end
-        opts.on('-v', '--[no-]verbose', 'Verbose output. Default is false.') do |v|
-          @verbose = v
-        end
-        opts.on('-c', '--current', 'Print current entry. Disables editing and writing') do |v|
-          @print_current_entry = v
-          @edit = false
-          @write = false
-        end
-        opts.on('-a', '--all', 'Print all previous entries. Disables editing and writing') do |v|
-          @print_all_entries = v
-          @edit = false
-          @write = false
-        end
-      end.parse!(options)
-
-      prefs
+      self.class.echo(msg)
     end
   end
 end

data/lib/standup_md/cli/helpers.rb

@@ -0,0 +1,165 @@
+# frozen_string_literal: true
+
+module StandupMD
+  class Cli
+
+    ##
+    # Module responsible for reading and writing standup files.
+    module Helpers
+
+      ##
+      # Print an entry to the command line.
+      #
+      # @param [StandupMD::Entry] entry
+      #
+      # @return [nil]
+      def print(entry)
+        if entry.nil?
+          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)
+          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 }
+        end
+        puts
+      end
+
+      private
+
+      ##
+      # 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)
+        OptionParser.new do |opts|
+          opts.banner = 'The Standup Doctor'
+          opts.version = "[StandupMD] #{::StandupMD::VERSION}"
+          opts.on(
+            '--current ARRAY', Array,
+            "List of current entry's tasks"
+          ) { |v| StandupMD.config.entry.current = v }
+
+          opts.on(
+            '--previous ARRAY', Array,
+            "List of precious entry's tasks"
+          ) { |v| StandupMD.config.entry.previous = v }
+
+          opts.on(
+            '--impediments ARRAY', Array,
+            'List of impediments for current entry'
+          ) { |v| StandupMD.config.entry.impediments = v }
+
+          opts.on(
+            '--notes ARRAY', Array,
+            'List of notes for current entry'
+          ) { |v| StandupMD.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 }
+
+          opts.on(
+            '-f', '--file-name-format STRING',
+            'Date-formattable string to use for standup file name'
+          ) { |v| StandupMD.config.file.name_format = v }
+
+          opts.on(
+            '-E', '--editor EDITOR',
+            'Editor to use for opening standup files'
+          ) { |v| StandupMD.config.cli.editor = v }
+
+          opts.on(
+            '-d', '--directory DIRECTORY',
+            'The directories where standup files are located'
+          ) { |v| StandupMD.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 }
+
+          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 }
+
+          opts.on(
+            '-e', '--[no-]edit',
+            'Open the file in the editor. Default is true'
+          ) { |v| StandupMD.config.cli.edit = v }
+
+          opts.on(
+            '-v', '--[no-]verbose',
+            'Verbose output. Default is false.'
+          ) { |v| StandupMD.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',
+          ) do |v|
+            StandupMD.config.cli.print = true
+            StandupMD.config.cli.date =
+              v.nil? ? Date.today : Date.strptime(v, StandupMD.config.file.header_date_format)
+          end
+        end.parse!(options)
+      end
+
+      ##
+      # 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
+          previous_entry = set_previous_entry(file)
+          entry = StandupMD::Entry.new(
+            StandupMD.config.cli.date,
+            StandupMD.config.entry.current,
+            previous_entry,
+            StandupMD.config.entry.impediments,
+            StandupMD.config.entry.notes
+          )
+          file.entries << entry
+        end
+        entry
+      end
+
+      ##
+      # The "previous" entries.
+      #
+      # @return [Array]
+      def set_previous_entry(file)
+        return [] unless StandupMD.config.cli.auto_fill_previous
+        return prev_entry(prev_file.load.entries) if file.new? && prev_file
+        prev_entry(file.entries)
+      end
+
+      ##
+      # The previous entry.
+      #
+      # @param [StandupMD::EntryList] entries
+      #
+      # @return [StandupMD::Entry]
+      def prev_entry(entries)
+        return [] if entries.empty?
+        entries.last.current
+      end
+
+      ##
+      # The previous month's file.
+      #
+      # @return [StandupMD::File]
+      def prev_file
+        StandupMD::File.find_by_date(Date.today.prev_month)
+      end
+    end
+  end
+end