dsu 1.1.0.alpha.1 → 1.1.0.alpha.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a0558e3688ef13d3969d4f42575742be25b847b18e822c7042ed2de38ff6450f
-  data.tar.gz: f72bd36cb559f2f99ba51687ffa2d13cb56e94dfe64a80f2634d8ad727fb3531
+  metadata.gz: 3777862e1325eb15cbc55524b264de3bd503be3b551b8ed9dccbb913e4193dc8
+  data.tar.gz: 046f11a023fc2ade553fe962ec20a33e7ea72f9b03a8ad01917c5cc01ec6cd93
 SHA512:
-  metadata.gz: bd93da3534ed0d6d11522a4a7e5b9adb9b4ec56eabc0633f5f314ccdaa900f98bb7f451bc86b083bd58b2aafe920ac214ce3b1bd4fee940713af39edcc09d9bd
-  data.tar.gz: fe1c030e83a19732cabe66389f9849125e5c72e4e5f23a30de2d2cda3b0a01ed26d9fc63077b67c7e10e7b3f54a9c9ce4d4bf893c7ed432c7b0e1b6f1d62e469
+  metadata.gz: 4dfa639c9749044a738e0584f7bd84baf7a7ae509db6a7bb0787fa2b3dd0c92a0deac2d15a15865fdce7d9bed6adfef57b2ce6d244f10864febfc1a6e0ec6957
+  data.tar.gz: 83aa24e6ee5178c4e4aaf5e4d3847c0b9e21ed498d7a0751e093d06f6acee84496ce2e40c3c89ca6c849336a6c9ec0a0e9c7fbbe8dd6b45092d37c63e5d828b5

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## [1.1.1.alpha.2] - 2023-05-23
+* Changes
+  - For convenience, the `dsu list date` command now takes a MNEUMONIC in addition to a DATE. See `dsu list help date` for more information.
+* Bug fixes
+  - Fix a bug that did not display `dsu list dates SUBCOMMAND` date list properly when the `--from` option was a date mneumonic and the `--to` optoin was a relative time mneumonic (e.g. `dsu list dates -f today -t +1`). In this case, DSU dates `Time.now` and `Time.now.tomorrow` should be displayed; instead, the bug would consider the `--to` option as relative to `Time.now`, so only 1 DSU date (`Time.now` would be returned).
 ## [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.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    dsu (1.1.0.alpha.1)
+    dsu (1.1.0.alpha.2)
       activemodel (~> 7.0, >= 7.0.4.3)
       activesupport (~> 7.0, >= 7.0.4)
       colorize (~> 0.8.1)

data/lib/dsu/base_cli.rb

@@ -41,7 +41,16 @@ module Dsu
         <<-OPTION_DESC
           MNEUMONIC:
           \x5
-          This may be any of the following: DATE (see DATE)|n|today|t|tomorrow|y|yesterday.
+          This may be any of the following: n|today|t|tomorrow|y|yesterday|+n|-n.
+
+          \x5
+          Where n, t, y are aliases for today, tomorrow, and yesterday, respectively.
+
+          \x5
+          Where +n, -n are relative date mneumonics (RDNs). Generally speaking, RDNs are relative to the current date. For example, a RDN of +1 would be equal to `Time.now + 1.day` (tomorrow), and a RDN of -1 would be equal to `Time.now - 1.day` (yesterday).
+
+          \x5
+          In some cases the behavior RDNs have on some commands are context dependent; in such cases the behavior will be noted.
         OPTION_DESC
       end
     end

data/lib/dsu/subcommands/list.rb

@@ -49,14 +49,23 @@ module Dsu
         view_list_for(times: times)
       end
 
-      desc 'date, d DATE',
-        'Displays the DSU entries for DATE'
+      desc 'date, d DATE|MNEUMONIC',
+        'Displays the DSU entries for the DATE or MNEUMONIC provided'
       long_desc <<-LONG_DESC
-      Displays the DSU entries for DATE.
-        \x5 #{date_option_description}
+        Displays the DSU entries for the DATE or MNEUMONIC provided.
+
+        \x5
+        #{date_option_description}
+
+        \x5
+        #{mneumonic_option_description}
       LONG_DESC
-      def date(date)
-        time = Time.parse(date)
+      def date(param)
+        time = if time_mneumonic?(param)
+          time_from_mneumonic(command_option: param)
+        else
+          Time.parse(param)
+        end
         times = sorted_dsu_times_for(times: [time, time.yesterday])
         view_list_for(times: times)
       rescue ArgumentError => e
@@ -77,16 +86,53 @@ module Dsu
 
         OPTIONS:
         \x5
-        -f|--from DATE|MNEMONIC: ?.
+        -a|--include-all true|false: If true, all DSU dates within the specified range will be displayed. If false, DSU dates between the first and last DSU dates that have NO entries will NOT be displayed.. The default is taken from the dsu configuration setting :include_all, see `dsu config info`.
+
+        \x5
+        -f|--from DATE|MNEMONIC: The DATE or MNEUMONIC that represents the start of the range of DSU dates to display. If a relative mneumonic is used (+/-n, e.g +1, -1, etc.), the date calculated will be relative to the current date (e.g. `<MNEUMONIC>.to_i.days.from_now(Time.now)`).
 
         \x5
-        -t|--to DATE|MNEMONIC: ?.
+        -t|--to DATE|MNEMONIC: The DATE or MNEUMONIC that represents the end of the range of DSU dates to display. If a relative mneumonic is used (+/-n, e.g +1, -1, etc.), the date calculated will be relative to the date that resulting from the `--from` option date calculation.
 
         \x5
         #{date_option_description}
 
         \x5
         #{mneumonic_option_description}
+
+        \x5
+        EXAMPLES
+
+        \x5
+        NOTE: All examples are subject to the `--include-all` option.
+
+        \x5
+        # The below will display the DSU entries for the range of dates from 1/1 to 1/4.
+        \x5`dsu list dates --from 1/1 --to +3`
+
+        \x5
+        # will display the DSU entries for the range of dates from 1/2 to 1/5.
+        \x5`dsu list dates --from 1/5 --to -3`
+
+        \x5
+        # (assuming "today" is 1/10) will display the DSU entries for the last week 1/10 to 1/3.
+        \x5`dsu list dates --from today --to -7`
+
+        \x5
+        # (assuming "today" is 5/23) will display the DSU entries for the last week 5/16 to 5/22.
+        #
+        # This example simply illustrates the fact that you can use relative mneumonics for
+        # both `--from` and `--to` options; this doesn't mean you should do so...
+        #
+        # While you can use relative mneumonics for both `--from` and `--to` options,
+        # there is always a more intuitive way. The below example basically lists one week
+        # of DSU entries back 1 week from yesterday's date:
+        \x5`dsu list dates --from -7 --to +6`
+
+        \x5
+        # This can MUCH easily be accomplished by simply using the `yesterday` mneumonic:
+        # (assuming "today" is 5/23) will display the DSU entries back 1 week from yesterday's date 5/16 to 5/22.
+        \x5`dsu list dates --from yesterday --to -6`
       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'

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

@@ -19,7 +19,11 @@ module Dsu
             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 = if relative_time_mneumonic?(to_command_option)
+              time_from_mneumonic(command_option: to_command_option, relative_time: from_time)
+            elsif time_mneumonic?(to_command_option)
+              time_from_mneumonic(command_option: to_command_option)
+            end
             to_time ||= time_from_date_string(command_option: to_command_option)
 
             [from_time, to_time].sort

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

@@ -22,16 +22,11 @@ module Dsu
         # 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)
+          unless relative_time.nil? || relative_time.is_a?(::Time)
+            raise ArgumentError, "relative_time is not a Time object: \"#{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
+          relative_time ||= ::Time.now
 
           time_for_mneumonic(mneumonic: command_option, relative_time: relative_time)
         end
@@ -42,31 +37,19 @@ module Dsu
           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)
+        # This method returns true if mneumonic is a valid relative
+        # time mneumonic.
+        def relative_time_mneumonic?(mneumonic)
+          return false unless mneumonic.is_a?(String)
 
-            # 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)
+          mneumonic.match?(RELATIVE_REGEX)
+        end
 
-            return time.public_send(relative_time)
-          end
+        private
 
-          time = ::Time.now
+        # Returns a Time object from a mneumonic.
+        def time_for_mneumonic(mneumonic:, relative_time:)
+          time = relative_time
           if today_mneumonic?(mneumonic)
             time
           elsif tomorrow_mneumonic?(mneumonic)

data/lib/dsu/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dsu
 version: !ruby/object:Gem::Version
-  version: 1.1.0.alpha.1
+  version: 1.1.0.alpha.2
 platform: ruby
 authors:
 - Gene M. Angelo, Jr.