dsu 1.0.0 → 1.1.0.alpha.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fa1b6f69c4de21d556a38cd96f29ba9ad8b7b4b2a9f5d34cda7fccb61f15d63f
-  data.tar.gz: 7376022ead177228164448d6fa4b8ee554a35611d45450955c586ed1bf84462a
+  metadata.gz: a0558e3688ef13d3969d4f42575742be25b847b18e822c7042ed2de38ff6450f
+  data.tar.gz: f72bd36cb559f2f99ba51687ffa2d13cb56e94dfe64a80f2634d8ad727fb3531
 SHA512:
-  metadata.gz: 7128d03202e5f9536e6fda51c2dab009dd0ed32f56f00e17b6d1c96cb5420daa8dd0ab71c69d25f811ee41acf14cda05d133211f3b9480b70907736201d7162b
-  data.tar.gz: bc276d357add40377ec88b79b8379fad502cea936440c31a81e7e0ed18c1ad766244f0a09b9eb33a1536a0d60d2c7140b429d5643aa6a3d51b2f362cdec60673
+  metadata.gz: bd93da3534ed0d6d11522a4a7e5b9adb9b4ec56eabc0633f5f314ccdaa900f98bb7f451bc86b083bd58b2aafe920ac214ce3b1bd4fee940713af39edcc09d9bd
+  data.tar.gz: fe1c030e83a19732cabe66389f9849125e5c72e4e5f23a30de2d2cda3b0a01ed26d9fc63077b67c7e10e7b3f54a9c9ce4d4bf893c7ed432c7b0e1b6f1d62e469

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## [1.1.0.alpha.1] - 2023-05-23
+* Changes
+  - Added new configuration option `carry_over_entries_to_today` (`true|false`, default: `false`); if true, when editing DSU entries **for the first time** on any  given day (e.g. `dsu edit today`), DSU entries from the previous day will be copied to the editing session. If there are no DSU entries from the previous day, `dsu` will search backwards up to 7 days to find a DSU date that has entries to copy. If after searching back 7 days, no DSU entries are found, the editor session will simply start with no previous DSU entries.
+  - Added new configuration option `include_all` (`true|false`, default: `false`); if true, when using dsu commands that list date ranges (e.g. `dsu list dates`), the displayed list will include dates that have no dsu entries. If false, the displayed list will only include dates that have dsu entries. For all other `dsu list` commands, if true, this option will behave in the aforementioned manner. If false, the displayed list will unconditionally display the first and last dates regardless of whether or not the DSU date has entries or not; all other dates will not be displayed if the DSU date has no entries.
+  - Changed the look of the editor template when editing entry group entries.
 ## [1.0.0] - 2023-05-18
 * First official release.
 * NOTE: If you have been using the alpha version of `dsu`, you will need to delete the `entries` folder (e.g. `/Users/<whoami>/dsu/entries` on a nix os) as the old entries .json files are incompatible with this official release.

data/Gemfile.lock

@@ -1,10 +1,10 @@
 PATH
   remote: .
   specs:
-    dsu (1.0.0)
+    dsu (1.1.0.alpha.1)
+      activemodel (~> 7.0, >= 7.0.4.3)
       activesupport (~> 7.0, >= 7.0.4)
       colorize (~> 0.8.1)
-      deco_lite (~> 1.3)
       os (~> 1.1, >= 1.1.4)
       thor (~> 1.2, >= 1.2.1)
       thor_nested_subcommand (~> 1.0)
@@ -24,11 +24,6 @@ GEM
     coderay (1.1.3)
     colorize (0.8.1)
     concurrent-ruby (1.2.2)
-    deco_lite (1.5.3)
-      activemodel (~> 7.0, >= 7.0.3.1)
-      activesupport (~> 7.0, >= 7.0.3.1)
-      immutable_struct_ex (~> 0.2.0)
-      mad_flatter (~> 2.0)
     diff-lcs (1.5.0)
     docile (1.4.0)
     dotenv (2.8.1)
@@ -37,12 +32,8 @@ GEM
     ffaker (2.21.0)
     i18n (1.13.0)
       concurrent-ruby (~> 1.0)
-    immutable_struct_ex (0.2.3)
     json (2.6.3)
     kwalify (0.7.2)
-    mad_flatter (2.0.0)
-      activesupport (~> 7.0, >= 7.0.3.1)
-      immutable_struct_ex (~> 0.2.0)
     method_source (1.0.0)
     minitest (5.18.0)
     os (1.1.4)
@@ -76,7 +67,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
     rspec-support (3.12.0)
-    rubocop (1.50.2)
+    rubocop (1.51.0)
       json (~> 2.3)
       parallel (~> 1.10)
       parser (>= 3.2.0.0)
@@ -90,9 +81,9 @@ GEM
       parser (>= 3.2.1.0)
     rubocop-capybara (2.18.0)
       rubocop (~> 1.41)
-    rubocop-factory_bot (2.22.0)
+    rubocop-factory_bot (2.23.1)
       rubocop (~> 1.33)
-    rubocop-performance (1.17.1)
+    rubocop-performance (1.18.0)
       rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
     rubocop-rspec (2.22.0)
@@ -106,7 +97,7 @@ GEM
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.4)
-    thor (1.2.1)
+    thor (1.2.2)
     thor_nested_subcommand (1.0.0)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)

data/README.md

@@ -71,12 +71,11 @@ The following displays the entries for "Today", where `Time.now == '2023-05-06 0
 ```shell
 #=>
 Saturday, (Today) 2023-05-06
-  1. 587a2f29 Blocked for locally failing test IN-12345
-              Hope to pair with John on it
+  1. Blocked for locally failing test IN-12345
 
 Friday, (Yesterday) 2023-05-05
-  1. edc25a9a Pick up ticket IN-12345
-  2. f7d3018c Attend new hire meet & greet
+  1. Pick up ticket IN-12345
+  2. Attend new hire meet & greet
 ```
 
 `$ dsu list date "2023-05-06"`
@@ -86,12 +85,11 @@ See the [Dates](#dates) section for more information on acceptable DATE formats
 ```shell
 #=>
 Saturday, (Today) 2023-05-06
-  1. 587a2f29 Blocked for locally failing test IN-12345
-              Hope to pair with John on it
+  1. Blocked for locally failing test IN-12345
 
 Friday, (Yesterday) 2023-05-05
-  1. edc25a9a Pick up ticket IN-12345
-  2. f7d3018c Attend new hire meet & greet
+  1. Pick up ticket IN-12345
+  2. Attend new hire meet & greet
 ```
 ## Editing DSU Entries
 
@@ -115,6 +113,7 @@ The following will edit your DSU entry group entries for "Today", where `Time.no
 #=> In your editor, you will see...
 # Editing DSU Entries for Tuesday, (Today) 2023-05-09 EDT
 # [ENTRY DESCRIPTION]
+
 Interative planning meeting 11:00AM.
 Pair with Chad on ticket 31211.
 Investigate spike ticket 31255.

data/lib/dsu/base_cli.rb

@@ -30,9 +30,19 @@ module Dsu
       end
 
       def date_option_description
-        <<-DATE_OPTION_DESC
-          Where DATE may be any date string that can be parsed using `Time.parse`. Consequently, you may use also use '/' as date separators, as well as omit thee year if the date you want to display is the current year (e.g. <month>/<day>, or 1/31). For example: `require 'time'; Time.parse('2023-01-02'); Time.parse('1/2') # etc.`
-        DATE_OPTION_DESC
+        <<-OPTION_DESC
+          DATE:
+          \x5
+          This may be any date string that can be parsed using `Time.parse`. Consequently, you may use also use '/' as date separators, as well as omit thee year if the date you want to display is the current year (e.g. <month>/<day>, or 1/31). For example: `require 'time'; Time.parse('01/02/2023'); Time.parse('1/2') # etc.`
+        OPTION_DESC
+      end
+
+      def mneumonic_option_description
+        <<-OPTION_DESC
+          MNEUMONIC:
+          \x5
+          This may be any of the following: DATE (see DATE)|n|today|t|tomorrow|y|yesterday.
+        OPTION_DESC
       end
     end
 

data/lib/dsu/cli.rb

@@ -20,7 +20,7 @@ module Dsu
     long_desc <<-LONG_DESC
       NAME
       \x5
-      `DSU add, -a [OPTIONS] DESCRIPTION` -- will add a DSU entry having DESCRIPTION to the date associated with the given OPTION.
+      `dsu add, -a [OPTIONS] DESCRIPTION` -- will add a DSU entry having DESCRIPTION to the date associated with the given OPTION.
 
       SYNOPSIS
       \x5
@@ -54,14 +54,12 @@ module Dsu
     def add(description)
       time = if options[:date].present?
         Time.parse(options[:date])
-      else
-        if options[:tomorrow].present?
-          Time.now.tomorrow
-        elsif options[:yesterday].present?
-          Time.now.yesterday
-        elsif options[:today].present?
-          Time.now
-        end
+      elsif options[:tomorrow].present?
+        Time.now.tomorrow
+      elsif options[:yesterday].present?
+        Time.now.yesterday
+      elsif options[:today].present?
+        Time.now
       end
       entry = Models::Entry.new(description: description)
       CommandServices::AddEntryService.new(entry: entry, time: time).call

data/lib/dsu/core/ruby/not_today.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'active_support/core_ext/date/calculations'
+
+module DateAndTime
+  module Calculations
+    def not_today?
+      !today?
+    end
+  end
+end

data/lib/dsu/models/entry.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require 'active_model'
-require 'securerandom'
 require_relative '../support/descriptable'
 require_relative '../validators/description_validator'
 

data/lib/dsu/models/entry_group.rb

@@ -51,19 +51,6 @@ module Dsu
         def exists?(time:)
           Dsu::Services::EntryGroupReaderService.entry_group_file_exists?(time: time)
         end
-
-        # Loads the EntryGroup from the file system and returns an
-        # instantiated EntryGroup object.
-        def load(time: nil)
-          load_entry_group_file_for(time: time)
-        end
-
-        # This function returns a hash whose :time and :entries
-        # key values are hydrated with instantiated Time and Entry
-        # objects.
-        def load_entry_group_for(time:)
-          load_entry_group_file_for(time: time)
-        end
       end
 
       def valid_unique_entries
@@ -93,6 +80,10 @@ module Dsu
         self
       end
 
+      def time_formatted
+        formatted_time(time: time)
+      end
+
       def save!
         delete! and return if entries.empty?
 

data/lib/dsu/services/configuration_loader_service.rb

@@ -30,9 +30,25 @@ module Dsu
       attr_reader :default_options
 
       def config_options
-        return Support::Configuration::DEFAULT_DSU_OPTIONS unless config_file?
+        return default_config unless config_file?
 
-        @config_options ||= YAML.safe_load(ERB.new(File.read(config_file)).result)
+        @config_options ||= begin
+          loaded_config = YAML.safe_load(ERB.new(File.read(config_file)).result)
+          loaded_config = update_and_write_config_file!(loaded_config) unless loaded_config.keys == default_config.keys
+          loaded_config
+        end
+      end
+
+      def update_and_write_config_file!(loaded_config)
+        loaded_config = default_config.merge(loaded_config)
+        # TODO: Make this into a configuration writer service.
+        # TODO: Test this
+        File.write(config_file, loaded_config.to_yaml)
+        loaded_config
+      end
+
+      def default_config
+        Support::Configuration::DEFAULT_DSU_OPTIONS
       end
     end
   end

data/lib/dsu/services/entry_group_editor_service.rb

@@ -2,17 +2,18 @@
 
 require_relative '../models/entry'
 require_relative '../support/colorable'
+require_relative '../support/configurable'
 require_relative '../support/say'
 require_relative '../support/time_formatable'
 require_relative '../views/edited_entries/shared/errors'
 require_relative '../views/shared/messages'
-require_relative 'configuration_loader_service'
 require_relative 'stdout_redirector_service'
 
 module Dsu
   module Services
     class EntryGroupEditorService
       include Support::Colorable
+      include Support::Configurable
       include Support::Say
       include Support::TimeFormatable
 
@@ -90,10 +91,6 @@ module Dsu
         description = Models::Entry.clean_description(description)
         !(description.blank? || description[0] == '#')
       end
-
-      def configuration
-        @configuration ||= ConfigurationLoaderService.new.call
-      end
     end
   end
 end

data/lib/dsu/subcommands/list.rb

@@ -1,11 +1,17 @@
 # frozen_string_literal: true
 
 require_relative '../base_cli'
+require_relative '../support/command_options/dsu_times'
+require_relative '../support/time_formatable'
 
 module Dsu
   module Subcommands
     class List < Dsu::BaseCLI
+      include Support::CommandOptions::DsuTimes
+      include Support::TimeFormatable
+
       map %w[d] => :date
+      map %w[dd] => :dates
       map %w[n] => :today
       map %w[t] => :tomorrow
       map %w[y] => :yesterday
@@ -17,10 +23,8 @@ module Dsu
       LONG_DESC
       def today
         time = Time.now
-        sorted_dsu_times_for(times: [time, time.yesterday]).each do |t|
-          view_entry_group(time: t)
-          puts
-        end
+        times = sorted_dsu_times_for(times: [time, time.yesterday])
+        view_list_for(times: times)
       end
 
       desc 'tomorrow, t',
@@ -30,10 +34,8 @@ module Dsu
       LONG_DESC
       def tomorrow
         time = Time.now
-        sorted_dsu_times_for(times: [time.tomorrow, time]).each do |t|
-          view_entry_group(time: t)
-          puts
-        end
+        times = sorted_dsu_times_for(times: [time.tomorrow, time])
+        view_list_for(times: times)
       end
 
       desc 'yesterday, y',
@@ -43,10 +45,8 @@ module Dsu
       LONG_DESC
       def yesterday
         time = Time.now
-        sorted_dsu_times_for(times: [time.yesterday, time.yesterday.yesterday]).each do |t|
-          view_entry_group(time: t)
-          puts
-        end
+        times = sorted_dsu_times_for(times: [time.yesterday, time.yesterday.yesterday])
+        view_list_for(times: times)
       end
 
       desc 'date, d DATE',
@@ -57,14 +57,82 @@ module Dsu
       LONG_DESC
       def date(date)
         time = Time.parse(date)
-        sorted_dsu_times_for(times: [time, time.yesterday]).each do |t|
-          view_entry_group(time: t)
-          puts
+        times = sorted_dsu_times_for(times: [time, time.yesterday])
+        view_list_for(times: times)
+      rescue ArgumentError => e
+        say "Error: #{e.message}", ERROR
+        exit 1
+      end
+
+      desc 'dates, dd OPTIONS',
+        'Displays the DSU entries for the OPTIONS provided'
+      long_desc <<~LONG_DESC
+        NAME
+        \x5
+        `dsu dates|dd OPTIONS` -- will display the DSU entries for the OPTIONS provided.
+
+        SYNOPSIS
+        \x5
+        `dsu dates|dd OPTIONS`
+
+        OPTIONS:
+        \x5
+        -f|--from DATE|MNEMONIC: ?.
+
+        \x5
+        -t|--to DATE|MNEMONIC: ?.
+
+        \x5
+        #{date_option_description}
+
+        \x5
+        #{mneumonic_option_description}
+      LONG_DESC
+      # -f, --from FROM [DATE|MNEMONIC] (e.g. -f, --from 1/1[/yyy]|n|t|y|today|tomorrow|yesterday)
+      option :from, type: :string, aliases: '-f', banner: 'DATE|MNEMONIC'
+      # -t, --to TO [DATE|MNEMONIC] (e.g. -t, --to 1/1[/yyy]|n|t|y|today|tomorrow|yesterday)
+      option :to, type: :string, aliases: '-t', banner: 'DATE|MNEMONIC'
+
+      # Include dates that have no DSU entries.
+      option :include_all, type: :boolean, aliases: '-a'
+      def dates
+        options = configuration.merge(self.options)
+        times = dsu_times_from!(from_command_option: options[:from], to_command_option: options[:to])
+        # Note special sort here, unlike the other commands where rules for
+        # displaying DSU entries are applied; this is more of a list command.
+        times = times_sort(times: times, entries_display_order: entries_display_order)
+        view_entry_groups(times: times, options: options) do |total_entry_groups|
+          nothing_to_display_banner_for(times) if total_entry_groups.zero?
         end
       rescue ArgumentError => e
         say "Error: #{e.message}", ERROR
         exit 1
       end
+
+      private
+
+      def nothing_to_display_banner_for(entry_group_times)
+        entry_group_times.sort!
+        time_range = "#{formatted_time(time: entry_group_times.first)} " \
+                     "through #{formatted_time(time: entry_group_times.last)}"
+        say "(nothing to display for #{time_range})", INFO
+      end
+
+      # This method will unconditionally display the FIRST and LAST entry groups
+      # associated with the times provided by the <times> argument. All other
+      # entry groups will be conditionally displayed based on the :include_all
+      # value in the <options> argument.
+      def view_list_for(times:)
+        options = configuration.merge(self.options)
+        times_first_and_last = [times.first, times.last]
+        times.each do |time|
+          view_options = options.dup
+          view_options[:include_all] = true if times_first_and_last.include?(time)
+          view_entry_group(time: time, options: view_options) do
+            puts
+          end
+        end
+      end
     end
   end
 end

data/lib/dsu/support/command_options/dsu_times.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative 'time'
+require_relative 'time_mneumonic'
+require_relative 'time_mneumonics'
+
+module Dsu
+  module Support
+    module CommandOptions
+      module DsuTimes
+        include Time
+        include TimeMneumonic
+        include TimeMneumonics
+
+        # Returns an array of Time objects. The first element is the from time. The second element is the to time.
+        # Both arguments are expected to be command options that are time strings, time or relative time mneumonics.
+        def dsu_times_from!(from_command_option:, to_command_option:)
+          times = begin
+            from_time = time_from_mneumonic(command_option: from_command_option) if time_mneumonic?(from_command_option)
+            from_time ||= time_from_date_string(command_option: from_command_option)
+
+            to_time = time_from_mneumonic(command_option: to_command_option) if time_mneumonic?(to_command_option)
+            to_time ||= time_from_date_string(command_option: to_command_option)
+
+            [from_time, to_time].sort
+          end
+
+          (times.min.to_date..times.max.to_date).map(&:to_time)
+        end
+      end
+    end
+  end
+end

data/lib/dsu/support/command_options/time.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module Dsu
+  module Support
+    module CommandOptions
+      # The purpose of this module is to take a command option that is a string and return a Time object.
+      # The command option is expected to be a date in the format of [M]M/[D]D[/YYYY]. MM and DD with
+      # leading zeroes is optional (i.e. only M and D are required), YYYY is optionl and will be replaced
+      # with the current year if not provided.
+      module Time
+        DATE_CAPTURE_REGEX = %r{\A(?<month>0?[1-9]|1[0-2])/(?<day>0?[1-9]|1\d|2\d|3[01])(?:/(?<year>\d{4}))?\z}
+
+        def time_from_date_string!(command_option:)
+          raise ArgumentError, 'command_option is nil.' if command_option.nil?
+          raise ArgumentError, 'command_option is blank.' if command_option.blank?
+
+          unless command_option.is_a?(String)
+            raise ArgumentError, "command_option is not a String: \"#{command_option}\"."
+          end
+
+          time_parts = time_parts_for(time_string: command_option)
+          return unless time_parts?(time_parts: time_parts)
+
+          valid_time!(time_parts: time_parts)
+
+          # This will rescue errors resulting from calling Date.strptime with an invalid date string,
+          # and return a more meaningful error message.
+        rescue DateTime::Error
+          raise ArgumentError, "command_option is not a valid date: \"#{command_option}\"."
+        end
+
+        def time_from_date_string(command_option:)
+          time_from_date_string!(command_option: command_option)
+        rescue ArgumentError
+          nil
+        end
+
+        private
+
+        # This method returns the time parts for the given time string in a hash
+        # (i.e. month, day, year) IF the time string matches the DATE_CAPTURE_REGEX
+        # regex. Otherwise, it returns an empty hash.
+        def time_parts_for(time_string:)
+          match_data = DATE_CAPTURE_REGEX.match(time_string)
+          return {} if match_data.nil?
+
+          {
+            month: match_data[:month],
+            day: match_data[:day],
+            year: match_data[:year]
+          }
+        end
+
+        # This method returns true if the date passes the DATE_CAPTURE_REGEX regex match
+        # in #date_parts_for and returns a non-nil hash. Otherwise, it returns false.
+        # A non-nil hash returned from #date_parts_for doesn necessarily mean the date
+        # parts will equate to a valid date when parsed, it just means the date string
+        # matched the regex. Calling #valid_date! will raise an ArgumentError if the
+        # date parts do not equate to a valid date.
+        def time_parts?(time_parts:)
+          !time_parts.empty?
+        end
+
+        def valid_time!(time_parts:)
+          time_string = time_string_for(time_parts: time_parts)
+          Date.strptime(time_string, '%Y/%m/%d').to_time
+        end
+
+        def time_string_for(time_parts:)
+          # Replace the year with the current year if it is nil.
+          time_parts[:year] = ::Time.now.year if time_parts[:year].nil?
+          "#{time_parts[:year]}/#{time_parts[:month]}/#{time_parts[:day]}"
+        end
+      end
+    end
+  end
+end

data/lib/dsu/support/command_options/time_mneumonic.rb

@@ -0,0 +1,127 @@
+# frozen_string_literal: true
+
+require_relative 'time_mneumonics'
+
+module Dsu
+  module Support
+    module CommandOptions
+      # The purpose of this module is to take a command option that is a string and return a Time object.
+      # The command option is expected to be a time mneumoic.
+      module TimeMneumonic
+        include TimeMneumonics
+
+        def time_from_mneumonic(command_option:, relative_time: nil)
+          time_from_mneumonic!(command_option: command_option, relative_time: relative_time)
+        rescue ArgumentError
+          nil
+        end
+
+        # command_option: is expected to me a time mneumonic. If relative_time is NOT nil, all
+        # time mneumonics are relative to relative_time. Otherwise, they are relative to Time.now.
+        # relative_time: is a Time object that is required IF command_option is expected to be
+        # a relative time mneumonic. Otherwise, it is optional.
+        def time_from_mneumonic!(command_option:, relative_time: nil)
+          validate_argument!(command_option: command_option, command_option_name: :command_option)
+          unless relative_time.nil?
+            validate_argument!(command_option: relative_time, command_option_name: :relative_time)
+          end
+
+          # if relative_time_mneumonic?(command_option) && !relative_time.nil?
+          #   # If command_option is a relative time mneumonic, we need to get the time
+          #   # relative to relative_time using ::Time.now, and use the command_option
+          #   # as the relative time.
+          #   return time_from_mneumonic!(command_option: relative_time, relative_time: command_option)
+          # end
+
+          time_for_mneumonic(mneumonic: command_option, relative_time: relative_time)
+        end
+
+        # This method returns true if mneumonic is a valid mneumonic OR
+        # a relative time mneumonic.
+        def time_mneumonic?(mneumonic)
+          mneumonic?(mneumonic) || relative_time_mneumonic?(mneumonic)
+        end
+
+        private
+
+        # Returns a Time object from a mneumonic.
+        def time_for_mneumonic(mneumonic:, relative_time: nil)
+          # If relative_time is a relative time mneumonic, then we need to first
+          # convert mneumonic to a Time object first, so that we can calculate
+          # `relative_time.to_i.days.from_now(time)` to get the correct Time we
+          # need.
+          if relative_time_mneumonic?(relative_time)
+            time = time_for_mneumonic(mneumonic: mneumonic)
+            return relative_time_for(days_from_now: relative_time, time: time)
+          end
+
+          if mneumonic?(mneumonic) && mneumonic?(relative_time)
+            time = time_for_mneumonic(mneumonic: mneumonic)
+
+            # Simply return the time if relative_time is 'today'
+            # because 'today' relative to any time will always
+            # point to itself.
+            return time if today_mneumonic?(relative_time)
+
+            return time.public_send(relative_time)
+          end
+
+          time = ::Time.now
+          if today_mneumonic?(mneumonic)
+            time
+          elsif tomorrow_mneumonic?(mneumonic)
+            time.tomorrow
+          elsif yesterday_mneumonic?(mneumonic)
+            time.yesterday
+          elsif relative_time_mneumonic?(mneumonic)
+            relative_time_for(days_from_now: mneumonic, time: time)
+          end
+        end
+
+        def relative_time_for(days_from_now:, time:)
+          days_from_now.to_i.days.from_now(time)
+        end
+
+        # This method returns true if mneumonic is a valid time mneumonic.
+        # This method will return false if mneumonic is an invalid mneumonic
+        # OR if mneumonic is a relative time mneumonic.
+        def mneumonic?(mneumonic)
+          today_mneumonic?(mneumonic) ||
+            tomorrow_mneumonic?(mneumonic) ||
+            yesterday_mneumonic?(mneumonic)
+        end
+
+        # This method returns true if mneumonic is a valid relative
+        # time mneumonic.
+        def relative_time_mneumonic?(mneumonic)
+          return false unless mneumonic.is_a?(String)
+
+          mneumonic.match?(RELATIVE_REGEX)
+        end
+
+        def today_mneumonic?(mneumonic)
+          TODAY.include?(mneumonic)
+        end
+
+        def tomorrow_mneumonic?(mneumonic)
+          TOMORROW.include?(mneumonic)
+        end
+
+        def yesterday_mneumonic?(mneumonic)
+          YESERDAY.include?(mneumonic)
+        end
+
+        def validate_argument!(command_option:, command_option_name:)
+          raise ArgumentError, "#{command_option_name} cannot be nil." if command_option.nil?
+          raise ArgumentError, "#{command_option_name} cannot be blank." if command_option.blank?
+          unless command_option.is_a?(String)
+            raise ArgumentError, "#{command_option_name} must be a String: \"#{command_option}\""
+          end
+          unless time_mneumonic?(command_option)
+            raise ArgumentError, "#{command_option_name} is an invalid mneumonic: \"#{command_option}\"."
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dsu/support/command_options/time_mneumonics.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Dsu
+  module Support
+    module CommandOptions
+      module TimeMneumonics
+        TODAY = %w[n today].freeze
+        TOMORROW = %w[t tomorrow].freeze
+        YESERDAY = %w[y yesterday].freeze
+
+        RELATIVE_REGEX = /[+-]\d+/
+      end
+    end
+  end
+end

data/lib/dsu/support/configurable.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative '../services/configuration_loader_service'
+
+module Dsu
+  module Support
+    # This module provides a way to configure a class, so that it can
+    # be used in a test environment.
+    module Configurable
+      def configuration
+        @configuration ||= Services::ConfigurationLoaderService.new.call
+      end
+    end
+  end
+end

data/lib/dsu/support/configuration.rb

@@ -27,7 +27,19 @@ module Dsu
         # asc or desc, ascending or descending, respectively.
         'entries_display_order' => 'desc',
         'entries_file_name' => '%Y-%m-%d.json',
-        'entries_folder' => "#{FolderLocations.root_folder}/dsu/entries"
+        'entries_folder' => "#{FolderLocations.root_folder}/dsu/entries",
+        'carry_over_entries_to_today' => false,
+        # If true, when using dsu commands that list date ranges (e.g.
+        # `dsu list dates`), the displayed list will include dates that
+        # have no dsu entries. If false, the displayed list will only
+        # include dates that have dsu entries.
+        # For all other `dsu list` commands, if true, this option will
+        # behave in the aforementioned manner. If false, the displayed
+        # list will unconditionally display the first and last dates
+        # regardless of whether or not the DSU date has entries or not;
+        # all other dates will not be displayed if the DSU date has no
+        # entries.
+        'include_all' => false
       }.freeze
       # rubocop:enable Style/StringHashKeys
 

data/lib/dsu/support/entry_group_fileable.rb

@@ -1,14 +1,39 @@
 # frozen_string_literal: true
 
 require_relative '../services/configuration_loader_service'
+require_relative '../support/configurable'
 
 module Dsu
   module Support
+    # TODO: I hate this module; refactor it!!!
+    # This module expects the following attributes to be defined: :time, :options
     module EntryGroupFileable
-      module_function
+      extend Support::Configurable
+
+      class << self
+        def entry_group_file_exists?(time:)
+          File.exist?(entry_group_file_path(time: time))
+        end
+
+        def entry_group_file_path(time:)
+          File.join(entries_folder, entries_file_name(time: time))
+        end
+
+        def entries_folder
+          configuration[:entries_folder]
+        end
+
+        def entries_file_name(time:)
+          time.strftime(configuration[:entries_file_name])
+        end
+
+        # def configuration
+        #   Services::ConfigurationLoaderService.new.call
+        # end
+      end
 
       def entry_group_file_exists?
-        File.exist?(entry_group_file_path)
+        EntryGroupFileable.entry_group_file_exists?(time: time)
       end
 
       def entry_group_path_exists?
@@ -16,15 +41,15 @@ module Dsu
       end
 
       def entry_group_file_path
-        File.join(entries_folder, entries_file_name)
+        EntryGroupFileable.entry_group_file_path(time: time)
       end
 
       def entries_folder
-        @entries_folder ||= configuration[:entries_folder]
+        @entries_folder ||= EntryGroupFileable.entries_folder
       end
 
       def entries_file_name
-        @entries_file_name ||= time.strftime(configuration[:entries_file_name])
+        @entries_file_name ||= EntryGroupFileable.entries_file_name(time: time)
       end
 
       def create_entry_group_path_if!
@@ -34,7 +59,7 @@ module Dsu
       private
 
       def configuration
-        @configuration ||= options[:configuration] || Services::ConfigurationLoaderService.new.call
+        @configuration ||= options[:configuration] || EntryGroupFileable.configuration
       end
     end
   end

data/lib/dsu/support/entry_group_loadable.rb

@@ -8,12 +8,9 @@ require_relative '../models/entry_group'
 module Dsu
   module Support
     module EntryGroupLoadable
-      module_function
-
-      # returns a Hash having :time and :entries
-      # where entries == an Array of Entry Hashes
-      # representing the JSON Entry objects for :time.
-      def load_entry_group_file_for(time:)
+      # returns an EntryGroup object loaded from
+      # the entry group json file.
+      def load(time:)
         entry_group_json = Services::EntryGroupReaderService.new(time: time).call
         hash = if entry_group_json.present?
           JSON.parse(entry_group_json, symbolize_names: true).tap do |hash|
@@ -26,6 +23,8 @@ module Dsu
         Models::EntryGroup.new(**hydrate_entry_group_hash(hash: hash, time: time))
       end
 
+      module_function
+
       # Accepts an entry group hash and returns a
       # hydrated entry group hash:
       #

data/lib/dsu/support/entry_group_viewable.rb

@@ -3,17 +3,35 @@
 module Dsu
   module Support
     module EntryGroupViewable
-      module_function
-
-      def view_entry_group(time:)
-        entry_group = if Models::EntryGroup.exists?(time: time)
-          entry_group_json = Services::EntryGroupReaderService.new(time: time).call
-          Services::EntryGroupHydratorService.new(entry_group_json: entry_group_json).call
-        else
-          Models::EntryGroup.new(time: time)
+      def view_entry_groups(times:, options: {})
+        total_viewable_entry_groups = 0
+
+        times.each do |time|
+          view_entry_group(time: time, options: options) do
+            total_viewable_entry_groups += 1
+            puts
+          end
         end
+
+        yield total_viewable_entry_groups if block_given?
+      end
+
+      def view_entry_group(time:, options: {})
+        return unless show_entry_group?(time: time, options: options)
+
+        entry_group = Models::EntryGroup.load(time: time)
         Views::EntryGroup::Show.new(entry_group: entry_group).render
+
+        yield if block_given?
       end
+
+      private
+
+      def show_entry_group?(time:, options:)
+        Models::EntryGroup.exists?(time: time) || options[:include_all]
+      end
+
+      module_function :view_entry_group, :view_entry_groups, :show_entry_group?
     end
   end
 end

data/lib/dsu/support/times_sortable.rb

@@ -18,13 +18,11 @@ module Dsu
         end
       end
 
+      # TODO: Do we have something else we can use here?
       def times_for(times:)
         start_date = times.max
         return times unless start_date.monday? || start_date.on_weekend?
 
-        # (0..3).map { |num| start_date - num.days }
-        # (start_date..-start_date.friday?).map { |time| time }
-        # (0..3).map { |num| start_date - num.days if start_date.on_weekend? || start_date.monday? }
         # If the start_date is a weekend or a Monday, then we need to include
         # start_date along with all the dates up to and including the previous
         # Monday.

data/lib/dsu/validators/entries_validator.rb

@@ -12,7 +12,7 @@ module Dsu
       def validate(record)
         unless record.entries.is_a?(Array)
           record.errors.add(:entries_entry, 'is the wrong object type. ' \
-                                      "\"Array\" was expected, but \"#{record.entries.class}\" was received.")
+                                            "\"Array\" was expected, but \"#{record.entries.class}\" was received.")
         end
 
         validate_entry_types record
@@ -27,7 +27,7 @@ module Dsu
           next if entry.is_a? Dsu::Models::Entry
 
           record.errors.add(:entries_entry, 'entry Array element is the wrong object type. ' \
-                                      "\"Entry\" was expected, but \"#{entry.class}\" was received.",
+                                            "\"Entry\" was expected, but \"#{entry.class}\" was received.",
             type: Support::FieldErrors::FIELD_TYPE_ERROR)
         end
       end
@@ -43,7 +43,7 @@ module Dsu
         non_unique_descriptions = descriptions.select { |description| descriptions.count(description) > 1 }.uniq
         if non_unique_descriptions.any?
           record.errors.add(:entries_entry, 'contains a duplicate entry: ' \
-                                      "#{format_non_unique_descriptions(non_unique_descriptions)}.",
+                                            "#{format_non_unique_descriptions(non_unique_descriptions)}.",
             type: Support::FieldErrors::FIELD_DUPLICATE_ERROR)
         end
       end

data/lib/dsu/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Dsu
-  VERSION = '1.0.0'
+  VERSION = '1.1.0.alpha.1'
 end

data/lib/dsu/views/entry_group/edit.rb

@@ -1,17 +1,13 @@
 # frozen_string_literal: true
 
-require 'time'
-require 'active_support/core_ext/numeric/time'
 require_relative '../../models/entry_group'
-require_relative '../../support/time_formatable'
+require_relative '../../support/configurable'
 
 module Dsu
   module Views
     module EntryGroup
       class Edit
-        include Support::Colorable
-        include Support::Say
-        include Support::TimeFormatable
+        include Support::Configurable
 
         def initialize(entry_group:, options: {})
           raise ArgumentError, 'entry_group is nil' if entry_group.nil?
@@ -31,18 +27,16 @@ module Dsu
           # Just in case the entry group is invalid, we'll validate it before displaying it.
           entry_group.validate!
 
-          # TODO: Display entry group entries from the previous DSU date so they can be
-          # easily copied over; or, add them to the current entry group entries below as
-          # a "# [+|a|add] <entry group from previous DSU entry description>"
-          # (e.g. commented out) by default?
-
           <<~EDIT_VIEW
-            # Editing DSU Entries for #{formatted_time(time: entry_group.time)}
-            # [ENTRY DESCRIPTION]
+            #{banner_line}
+            # Editing DSU Entries for #{entry_group.time_formatted}
+            #{banner_line}
 
-            #{entry_group_entry_lines.each(&:strip).join("\n")}
+            #{entry_group_view&.chomp}
 
-            # INSTRUCTIONS:
+            #{banner_line}
+            # INSTRUCTIONS
+            #{banner_line}
             #    ADD a DSU entry: type an ENTRY DESCRIPTION on a new line.
             #   EDIT a DSU entry: change the existing ENTRY DESCRIPTION.
             # DELETE a DSU entry: delete the ENTRY DESCRIPTION.
@@ -51,6 +45,7 @@ module Dsu
             # REORDER a DSU entry: reorder the ENTRY DESCRIPTIONs in order preference.
             #
             # *** When you are done, save and close your editor ***
+            #{banner_line}
           EDIT_VIEW
         end
 
@@ -58,8 +53,68 @@ module Dsu
 
         attr_reader :entry_group, :options
 
+        def time
+          @time ||= entry_group.time
+        end
+
+        def banner_line
+          '#' * 80
+        end
+
+        def entry_group_view
+          return entry_group_entry_lines if entry_group.entries.any?
+          return previous_entry_group_entry_lines if carry_over_entries_to_today? && previous_entry_group?
+
+          <<~EDIT_VIEW
+            #{banner_line}
+            # ENTER DSU ENTRIES BELOW
+            #{banner_line}
+
+          EDIT_VIEW
+        end
+
         def entry_group_entry_lines
-          entry_group.entries.map(&:description)
+          raise 'No entries in entry group' if entry_group.entries.empty?
+
+          <<~EDIT_VIEW
+            #{banner_line}
+            # DSU ENTRIES
+            #{banner_line}
+
+            #{entry_group.entries.map(&:description).join("\n").chomp}
+          EDIT_VIEW
+        end
+
+        def previous_entry_group_entry_lines
+          raise 'carry_over_entries_to_today? is false' unless carry_over_entries_to_today?
+          raise 'Entries exist in entry_group' if entry_group.entries.any?
+          raise 'No previous entry group exists' unless previous_entry_group?
+
+          <<~EDIT_VIEW
+            #{banner_line}
+            # PREVIOUS DSU ENTRIES FROM #{previous_entry_group.time_formatted}
+            #{banner_line}
+
+            #{previous_entry_group.entries.map(&:description).join("\n").chomp}
+          EDIT_VIEW
+        end
+
+        def previous_entry_group?
+          previous_entry_group.present?
+        end
+
+        def previous_entry_group
+          # Go back a max of 7 days to find the previous entry group.
+          # TODO: Make this configurable or accept an option?
+          @previous_entry_group ||= (1..7).each do |days|
+            t = time.days_ago(days)
+            return Models::EntryGroup.load(time: t) if Support::EntryGroupFileable.entry_group_file_exists?(time: t)
+          end
+          nil
+        end
+
+        def carry_over_entries_to_today?
+          configuration[:carry_over_entries_to_today]
         end
       end
     end

data/lib/dsu.rb

@@ -1,9 +1,11 @@
 # frozen_string_literal: true
 
-require 'time'
-require 'active_support/core_ext/object/blank'
 require 'active_support/core_ext/hash/indifferent_access'
 require 'active_support/core_ext/numeric/time'
+require 'active_support/core_ext/object/blank'
+require 'pry-byebug' if ENV['DEV_ENV']
+require 'thor'
+require 'time'
 
 Dir.glob("#{__dir__}/lib/core/**/*.rb").each do |file|
   require file

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dsu
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0.alpha.1
 platform: ruby
 authors:
 - Gene M. Angelo, Jr.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-05-18 00:00:00.000000000 Z
+date: 2023-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -31,33 +31,39 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 7.0.4
 - !ruby/object:Gem::Dependency
-  name: colorize
+  name: activemodel
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.1
+        version: '7.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.4.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.1
+        version: '7.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.4.3
 - !ruby/object:Gem::Dependency
-  name: deco_lite
+  name: colorize
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: 0.8.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: 0.8.1
 - !ruby/object:Gem::Dependency
   name: os
   requirement: !ruby/object:Gem::Requirement
@@ -149,6 +155,7 @@ files:
 - lib/dsu/base_cli.rb
 - lib/dsu/cli.rb
 - lib/dsu/command_services/add_entry_service.rb
+- lib/dsu/core/ruby/not_today.rb
 - lib/dsu/models/entry.rb
 - lib/dsu/models/entry_group.rb
 - lib/dsu/services/configuration_loader_service.rb
@@ -166,6 +173,11 @@ files:
 - lib/dsu/subcommands/list.rb
 - lib/dsu/support/ask.rb
 - lib/dsu/support/colorable.rb
+- lib/dsu/support/command_options/dsu_times.rb
+- lib/dsu/support/command_options/time.rb
+- lib/dsu/support/command_options/time_mneumonic.rb
+- lib/dsu/support/command_options/time_mneumonics.rb
+- lib/dsu/support/configurable.rb
 - lib/dsu/support/configuration.rb
 - lib/dsu/support/descriptable.rb
 - lib/dsu/support/entry_group_fileable.rb
@@ -204,9 +216,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 3.0.1
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.3.22
 signing_key: