standup_md 0.3.14 → 0.3.16

data/lib/standup_md/cli.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'optparse'
-require_relative 'cli/helpers'
+require "optparse"
+require "standup_md/cli/helpers"
 
 module StandupMD
   ##
@@ -29,7 +29,7 @@ module StandupMD
     # Creates an instance of +StandupMD+ and runs what the user requested.
     def self.execute(options = [])
       new(options).tap do |exe|
-        exe.write_file if config.write
+        exe.write_file if exe.write?
         if config.print
           exe.print(exe.entry)
         elsif config.edit
@@ -56,19 +56,28 @@ module StandupMD
     # @return [StandupMD::File]
     attr_reader :file
 
+    ##
+    # Was a file date argument passed?
+    #
+    # @return [Boolean]
+    def file_date_argument?
+      @file_date_argument
+    end
+
     ##
     # Constructor. Sets defaults.
     #
     # @param [Array] options
-    def initialize(options = [], load_config = true)
+    def initialize(options = [], load_config: true)
       @config = self.class.config
       @preference_file_loaded = false
+      @file_date_argument = false
       @options = options
       load_preferences if load_config
       load_runtime_preferences(options)
-      @file = StandupMD::File.find_by_date(@config.date)
-      @file.load
-      @entry = new_entry(@file)
+      @file = find_file
+      @file&.load
+      @entry = @file.nil? ? nil : new_entry(@file)
     end
 
     ##
@@ -87,7 +96,7 @@ module StandupMD
     ##
     # Has the preference file been loaded?
     #
-    # @return boolean
+    # @return [boolean]
     def preference_file_loaded?
       @preference_file_loaded
     end
@@ -111,11 +120,55 @@ module StandupMD
     end
 
     ##
-    # Quick access to Cli.echo.
+    # Should the file be written?
+    #
+    # @return [Boolean]
+    def write?
+      !!(@config.write && !read_only? && entry)
+    end
+
+    ##
+    # Quick access to +Cli.echo+.
     #
     # @return [nil]
     def echo(msg)
       self.class.echo(msg)
     end
+
+    private
+
+    ##
+    # Is this a read-only action?
+    #
+    # @return [Boolean]
+    def read_only?
+      @config.print || file_date_argument?
+    end
+
+    ##
+    # Finds the file, avoiding file creation for read-only actions.
+    #
+    # @return [StandupMD::File, nil]
+    def find_file
+      return StandupMD::File.find_by_date(@config.date) unless read_only?
+
+      without_file_creation { StandupMD::File.find_by_date(@config.date) }
+    rescue
+      raise unless @config.print
+
+      nil
+    end
+
+    ##
+    # Temporarily disables file creation while looking for a file.
+    #
+    # @return [StandupMD::File]
+    def without_file_creation
+      original_create = config.file.create
+      config.file.create = false
+      yield
+    ensure
+      config.file.create = original_create
+    end
   end
 end

data/lib/standup_md/config/cli.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'date'
+require "date"
 
 module StandupMD
   class Config
@@ -13,14 +13,14 @@ module StandupMD
       # @return [Hash]
       DEFAULTS = {
         date: Date.today,
-        editor: ENV['VISUAL'] || ENV['EDITOR'] || 'vim',
+        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')
+          ::File.join(ENV["HOME"], ".standuprc")
         )
       }.freeze
 

data/lib/standup_md/config/entry.rb

@@ -12,7 +12,7 @@ module StandupMD
       DEFAULTS = {
         current: ["<!-- ADD TODAY'S WORK HERE -->"],
         previous: [],
-        impediments: ['None'],
+        impediments: ["None"],
         notes: []
       }.freeze
 

data/lib/standup_md/config/entry_list.rb

@@ -9,7 +9,7 @@ module StandupMD
       # The default options.
       #
       # @return [Hash]
-      DEFAULTS = {}
+      DEFAULTS = {}.freeze
 
       ##
       # Initializes the config with default values.

data/lib/standup_md/config/file.rb

@@ -10,19 +10,19 @@ module StandupMD
       #
       # @return [Hash]
       DEFAULTS = {
-        header_date_format: '%Y-%m-%d',
+        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',
+        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,
-      }
+        directory: ::File.join(ENV["HOME"], ".cache", "standup_md"),
+        bullet_character: "-",
+        name_format: "%Y_%m.md",
+        create: true
+      }.freeze
 
       ##
       # Number of octothorps that should preface entry headers.
@@ -154,7 +154,7 @@ module StandupMD
       #
       # @return [Integer]
       def header_depth=(depth)
-        raise 'Header depth out of bounds (1..5)' if !depth.between?(1, 5)
+        raise "Header depth out of bounds (1..5)" if !depth.between?(1, 5)
 
         @sub_header_depth = depth + 1 if depth >= sub_header_depth
         @header_depth = depth
@@ -168,7 +168,7 @@ module StandupMD
       #
       # @return [Integer]
       def sub_header_depth=(depth)
-        raise 'Sub-header depth out of bounds (2..6)' if !depth.between?(2, 6)
+        raise "Sub-header depth out of bounds (2..6)" if !depth.between?(2, 6)
 
         @header_depth = depth - 1 if depth <= header_depth
         @sub_header_depth = depth

data/lib/standup_md/config.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
-require_relative 'config/cli'
-require_relative 'config/file'
-require_relative 'config/entry'
-require_relative 'config/entry_list'
+require "standup_md/config/cli"
+require "standup_md/config/file"
+require "standup_md/config/entry"
+require "standup_md/config/entry_list"
 
 module StandupMD
   ##
@@ -36,9 +36,9 @@ module StandupMD
     ##
     # Builds the links to the configuration classes.
     def initialize
-      @cli        = StandupMD::Config::Cli.new
-      @file       = StandupMD::Config::File.new
-      @entry      = StandupMD::Config::Entry.new
+      @cli = StandupMD::Config::Cli.new
+      @file = StandupMD::Config::File.new
+      @entry = StandupMD::Config::Entry.new
       @entry_list = StandupMD::Config::EntryList.new
     end
   end

data/lib/standup_md/entry.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'json'
+require "json"
 
 module StandupMD
   ##
@@ -100,10 +100,10 @@ module StandupMD
     def to_h
       {
         date => {
-          'current'     => current,
-          'previous'    => previous,
-          'impediments' => impediments,
-          'notes'       => notes
+          "current" => current,
+          "previous" => previous,
+          "impediments" => impediments,
+          "notes" => notes
         }
       }
     end

data/lib/standup_md/entry_list.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'forwardable'
+require "forwardable"
 
 module StandupMD
   ##
@@ -50,7 +50,7 @@ module StandupMD
     #
     # @return [StandupMD::Entry]
     def find(date)
-      entries.bsearch { |e| e.date == date }
+      entries.bsearch { |entry| date <=> entry.date }
     end
 
     ##
@@ -71,7 +71,7 @@ module StandupMD
     end
 
     ##
-    # Returns a copy of self sorted by date.
+    # Returns a copy of self sorted by date, reversed.
     #
     # @return [StandupMD::EntryList]
     def sort_reverse
@@ -111,12 +111,17 @@ module StandupMD
     #
     # @return [Hash]
     def to_h
-      Hash[@entries.map { |e| [e.date, {
-        'current'     => e.current,
-        'previous'    => e.previous,
-        'impediments' => e.impediments,
-        'notes'       => e.notes
-      }]}]
+      @entries.map do |e|
+        [
+          e.date,
+          {
+            "current" => e.current,
+            "previous" => e.previous,
+            "impediments" => e.impediments,
+            "notes" => e.notes
+          }
+        ]
+      end.to_h
     end
 
     ##
@@ -149,7 +154,7 @@ module StandupMD
     def validate_entry(entry)
       return if entry.is_a?(StandupMD::Entry)
 
-      raise ArgumentError, 'Entry must be an instance of StandupMD::Entry'
+      raise ArgumentError, "Entry must be an instance of StandupMD::Entry"
     end
   end
 end

data/lib/standup_md/file/helpers.rb

@@ -16,11 +16,11 @@ module StandupMD
       end
 
       def header_regex # :nodoc:
-        /^#{'#' * StandupMD.config.file.header_depth}\s+/
+        /^#{"#" * StandupMD.config.file.header_depth}\s+/
       end
 
       def sub_header_regex # :nodoc:
-        /^#{'#' * StandupMD.config.file.sub_header_depth}\s+/
+        /^#{"#" * StandupMD.config.file.sub_header_depth}\s+/
       end
 
       def bullet_character_regex # :nodoc:
@@ -28,7 +28,7 @@ module StandupMD
       end
 
       def determine_section_type(line) # :nodoc:
-        line = line.sub(/^\#{#{StandupMD.config.file.sub_header_depth}}\s*/, '')
+        line = line.sub(/^\#{#{StandupMD.config.file.sub_header_depth}}\s*/, "")
         [
           StandupMD.config.file.current_header,
           StandupMD.config.file.previous_header,
@@ -41,7 +41,7 @@ module StandupMD
       def new_entry(record) # :nodoc:
         Entry.new(
           Date.strptime(
-            record['header'],
+            record["header"],
             StandupMD.config.file.header_date_format
           ),
           record[StandupMD.config.file.current_header],
@@ -52,13 +52,13 @@ module StandupMD
       end
 
       def header(date)
-        '#' * StandupMD.config.file.header_depth +
-          ' ' +
+        "#" * 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
+        "#" * StandupMD.config.file.sub_header_depth + " " + subhead
       end
     end
   end

data/lib/standup_md/file.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require 'date'
-require 'fileutils'
-require_relative 'file/helpers'
+require "date"
+require "fileutils"
+require "standup_md/file/helpers"
 
 module StandupMD
   ##
@@ -10,58 +10,62 @@ module StandupMD
   class File
     include StandupMD::File::Helpers
 
-    ##
-    # Access to the class's configuration.
-    #
-    # @return [StandupMD::Config::EntryList]
-    def self.config
-      @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)
-      unless ::File.directory?(config.directory)
-        raise "Dir #{config.directory} not found." unless config.create
+    class << self
+      ##
+      # Access to the class's configuration.
+      #
+      # @return [StandupMD::Config::EntryList]
+      def config
+        @config ||= StandupMD.config.file
+      end
 
-        FileUtils.mkdir_p(config.directory)
+      ##
+      # Convenience method for calling File.find(file_name).load
+      #
+      # @param [String] file_name
+      #
+      # @return [StandupMD::File]
+      def 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
-      new(file_name).load
-    end
 
-    ##
-    # Find standup file in directory by file name.
-    #
-    # @param [String] File_naem
-    def self.find(file_name)
-      unless ::File.directory?(config.directory)
-        raise "Dir #{config.directory} not found." unless config.create
+      ##
+      # Find standup file in directory by file name.
+      #
+      # @param [String] File_naem
+      def find(file_name)
+        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
+          FileUtils.mkdir_p(config.directory)
+        end
+        file_path = ::File.join(config.directory, file_name)
+        unless ::File.file?(file_path) || config.create
+          raise "File #{file_name} not found."
+        end
 
-      new(file_name)
-    end
+        new(file_name)
+      end
 
-    ##
-    # Find standup file in directory by Date object.
-    #
-    # @param [Date] date
-    def self.find_by_date(date)
-      raise ArgumentError, 'Must be a Date object' unless date.is_a?(Date)
+      ##
+      # Find standup file in directory by Date object.
+      #
+      # @param [Date] date
+      def find_by_date(date)
+        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
+        unless ::File.directory?(config.directory)
+          raise "Dir #{config.directory} not found." unless config.create
 
-        FileUtils.mkdir_p(config.directory)
+          FileUtils.mkdir_p(config.directory)
+        end
+        find(date.strftime(config.name_format))
       end
-      find(date.strftime(config.name_format))
     end
 
     ##
@@ -141,7 +145,7 @@ module StandupMD
 
       entry_list = EntryList.new
       record = {}
-      section_type = ''
+      section_type = ""
       ::File.foreach(name) do |line|
         line.chomp!
         next if line.strip.empty?
@@ -151,14 +155,14 @@ module StandupMD
             entry_list << new_entry(record)
             record = {}
           end
-          record['header'] = line.sub(/^\#{#{@config.header_depth}}\s*/, '')
+          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, '')
+          record[section_type] << line.sub(bullet_character_regex, "")
         end
       end
       entry_list << new_entry(record) unless record.empty?
@@ -181,7 +185,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|
+      ::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|
@@ -189,7 +193,7 @@ module StandupMD
             next if !tasks || tasks.empty?
 
             f.puts sub_header(@config.public_send("#{attr}_header").capitalize)
-            tasks.each { |task| f.puts @config.bullet_character + ' ' + task }
+            tasks.each { |task| f.puts "#{@config.bullet_character} #{task}" }
           end
           f.puts
         end

data/lib/standup_md/version.rb

@@ -21,7 +21,7 @@ module StandupMD
     # Patch version.
     #
     # @return [Integer]
-    PATCH = 14
+    PATCH = 16
 
     ##
     # Version as +[MAJOR, MINOR, PATCH]+
@@ -36,7 +36,7 @@ module StandupMD
     #
     # @return [String]
     def self.to_s
-      to_a.join('.')
+      to_a.join(".")
     end
 
     ##
@@ -44,7 +44,7 @@ module StandupMD
     #
     # @return [Hash]
     def self.to_h
-      Hash[%i[major minor patch].zip(to_a)]
+      %i[major minor patch].zip(to_a).to_h
     end
   end
 

data/lib/standup_md.rb

@@ -1,22 +1,24 @@
 # frozen_string_literal: true
 
-require_relative 'standup_md/version'
-require_relative 'standup_md/file'
-require_relative 'standup_md/entry'
-require_relative 'standup_md/entry_list'
-require_relative 'standup_md/cli'
-require_relative 'standup_md/config'
+require "standup_md/version"
+require "standup_md/file"
+require "standup_md/entry"
+require "standup_md/entry_list"
+require "standup_md/cli"
+require "standup_md/config"
 
 ##
 # The main module for the gem. Provides access to configuration classes.
 module StandupMD
   @config_file_loaded = false
 
+  module_function
+
   ##
   # Method for accessing the configuration.
   #
-  # @return [StanupMD::Cli]
-  def self.config
+  # @return [StanupMD::Config]
+  def config
     @config || reset_config
   end
 
@@ -24,7 +26,7 @@ module StandupMD
   # Reset all configuration values to their defaults.
   #
   # @return [StandupMD::Config]
-  def self.reset_config
+  def reset_config
     @config = StandupMD::Config.new
   end
 
@@ -33,7 +35,7 @@ module StandupMD
   #
   # @example
   #   StandupMD.configure { |s| s.cli.editor = 'mate' }
-  def self.configure
+  def configure
     yield config
   end
 
@@ -41,7 +43,7 @@ module StandupMD
   # Has a config file been loaded?
   #
   # @return [Boolean]
-  def self.config_file_loaded?
+  def config_file_loaded?
     @config_file_loaded
   end
 
@@ -51,8 +53,8 @@ module StandupMD
   # @param [String] file
   #
   # @return [String] file
-  def self.load_config_file(file)
-    ::File.expand_path(file).tap do |file|
+  def load_config_file(config_file)
+    ::File.expand_path(config_file).tap do |file|
       raise "File #{file} does not exist." unless ::File.file?(file)
 
       @config_file_loaded = true