dsu 2.2.1 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 331d6a98a37267f72d525f38e9010da69de44144ce12fb8610a21db86e738dd0
-  data.tar.gz: e380e7a42eebb5535db7419170cab3f16354187a1a30556f3cc0ec4eccdbdcd0
+  metadata.gz: dac644f91b9d952fc3ef289c0ed147f428fcb485418af0e93a64c1478670bf15
+  data.tar.gz: c605401ea6b2917af9a6c96617fcc4c2b7b57963282654e0e189ec57e3f5dc05
 SHA512:
-  metadata.gz: 378484c87521d25af3885615c60cb1f8c520c1e80d8dbbaa4a6838a80e4001382516bf83731e0ca186530482154a92041e316cb453d530dc209f91155e5254ea
-  data.tar.gz: c0a98718ea256ef9e37e0b6b1056eb29dfd33d3bb0ede8e75e418c12bf2393b94d6fd7bdc482a160a03433873c8fbd078a5105c1e866d005e720d6f5ef9f189f
+  metadata.gz: dbbb3642b22b661b68c14dab8236b553cd5dc4a4c9be80fb6fdce07dc344276a235f68b8593cab8279a09ecf68827c0c1c86283276f89440c5dc9f166c95a57c
+  data.tar.gz: a0727206ac2d647abafb20975eb88b396e1ff5abe37e98ae5f4502a99dbe43f19767d51a5611155bb1848dace96c17ba5d235ff0a1ca9ded099f9f44634d8a89

data/CHANGELOG.md

@@ -1,3 +1,25 @@
+## [2.3.0] 2023-12-25
+
+Enhancements
+
+- Added `dsu export` command to export all DSU entries or DSU entries between two given dates. Entries are written to a comma-delimited csv file located in your OS temp folder. For more information see `dsu help export` or the README.md file.
+
+Changes
+
+- Updated README.md to reflect new `dsu export` command.
+- Fix misspelling of "cancelable" to "cancellable" in the codebase.
+- Update ruby gems.
+
+## [2.2.2] 2023-12-23
+
+Changes
+
+- README.md updates.
+
+Bug fix
+
+- Fix `dsu config` shortcut command mapping bug that caused `dsu c` to display `dsu delete` command help instead of `dsu config` command help.
+
 ## [2.2.1] 2023-12-23
 
 Changes

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    dsu (2.2.1)
+    dsu (2.3.0)
       activemodel (>= 7.0.8, < 8.0)
       activesupport (>= 7.0.8, < 8.0)
       colorize (>= 0.8.1, < 1.0)
@@ -98,7 +98,7 @@ GEM
       rubocop (~> 1.41)
     rubocop-factory_bot (2.24.0)
       rubocop (~> 1.33)
-    rubocop-performance (1.20.0)
+    rubocop-performance (1.20.1)
       rubocop (>= 1.48.1, < 2.0)
       rubocop-ast (>= 1.30.0, < 2.0)
     rubocop-rspec (2.25.0)

data/README.md

@@ -1,8 +1,8 @@
 # `dsu`- Streamline Your Daily Stand-Up Meeting Participation!
 
 [![Ruby](https://github.com/gangelo/dsu/actions/workflows/ruby.yml/badge.svg)](https://github.com/gangelo/dsu/actions/workflows/ruby.yml)
-[![GitHub version](http://badge.fury.io/gh/gangelo%2Fdsu.svg)](https://badge.fury.io/gh/gangelo%2Fdsu)
-[![Gem Version](https://badge.fury.io/rb/dsu.svg)](https://badge.fury.io/rb/dsu)
+[![GitHub version](http://badge.fury.io/gh/gangelo%2Fdsu.svg?refresh=2)](https://badge.fury.io/gh/gangelo%2Fdsu)
+[![Gem Version](https://badge.fury.io/rb/dsu.svg?refresh=2)](https://badge.fury.io/rb/dsu)
 [![Documentation](http://img.shields.io/badge/docs-rdoc.info-blue.svg)](http://www.rubydoc.info/gems/dsu/)
 [![Report Issues](https://img.shields.io/badge/report-issues-red.svg)](https://github.com/gangelo/dsu/issues)
 [![License](http://img.shields.io/badge/license-MIT-yellowgreen.svg)](#license)
@@ -42,6 +42,7 @@ Commands:
   dsu config|c SUBCOMMAND          # Manage configuration...
   dsu delete|d SUBCOMMAND          # Delete DSU entries...
   dsu edit|e SUBCOMMAND            # Edit DSU entries...
+  dsu export|x SUBCOMMAND          # Export DSU entries...
   dsu help [COMMAND]               # Describe available...
   dsu info|i                       # Displays information...
   dsu list|l SUBCOMMAND            # Displays DSU entries...
@@ -58,8 +59,9 @@ The folowing section outlines how to use the `dsu` gem.
 ## Adding DSU Entries
 The next thing you may want to do is `add` some DSU activities (entries) for a particular day:
 
-`dsu add [OPTIONS] DESCRIPTION`
-`dsu a [OPTIONS] DESCRIPTION`
+`$ dsu add [OPTIONS] DESCRIPTION`
+
+`$ dsu a [OPTIONS] DESCRIPTION`
 
 Adding DSU entry using this command will _add_ the DSU entry for the given day or date, and then _display_ the DSU entries for that day or date.
 
@@ -69,18 +71,21 @@ Adding DSU entry using this command will _add_ the DSU entry for the given day o
 If you need to add a DSU entry for the current day (today), you can use the `-n`|`--today` option. Today (`-n`) is the default; therefore, the `-n` flag is optional if you want to add a DSU entry for the _current day_ (today). For example, the below commands will both accomplish the same thing:
 
 `$ dsu add [-n|--today] "Pair with John on ticket IN-12345"`
+
 `$ dsu a "Pair with John on ticket IN-12345"`
 
 ### Yesterday
 If for some reason you need to add a DSU entry for yesterday, you can use the `-y`| `--yesterday` option. Both of the below commands accomplish the same thing:
 
 `$ dsu add --yesterday "Pick up ticket IN-12345"`
+
 `$ dsu a -y "Pick up ticket IN-12345"`
 
 ### Tomorrow
 If you need to add a DSU entry for tomorrow, you can use the `-t`|`--tomorrow` option:
 
 `$ dsu add --tomorrow "Pick up ticket IN-12345"`
+
 `$ dsu a -t "Pick up ticket IN-12345"`
 
 ### Miscellaneous Date
@@ -91,6 +96,7 @@ Both of the below examples will accomplish the same thing, assuming the current
 **NOTE:** When **including year**, dates must be entered in `YYYY/MM/DD` format.
 
 `$ dsu add --date 2023/12/31 "Attend New Years Coffee Meet & Greet"`
+
 `$ dsu a -d 12/31 "Attend New Years Coffee Meet & Greet"`
 
 See the [Dates](#dates) section for more information on acceptable DATE formats used by `dsu`.
@@ -100,13 +106,13 @@ You can display DSU entries for a particular day or date using any of the follow
 
 - `$ dsu list today`
 - `$ dsu l n` # Equivalent to the above, only using shortcuts
-- `$ dsu list tomorrow|t`
+- `$ dsu list tomorrow`
 - `$ dsu l t` # Equivalent to the above, only using shortcuts
-- `$ dsu list yesterday|y`
+- `$ dsu list yesterday`
 - `$ dsu l y` # Equivalent to the above, only using shortcuts
-- `$ dsu list date|d DATE|MNEMONIC`
+- `$ dsu list date DATE|MNEMONIC`
 - `$ dsu l d DATE|MNEMONIC` # Equivalent to the above, only using shortcuts
-- `$ dsu list dates|dd OPTIONS`
+- `$ dsu list dates OPTIONS`
 - `$ dsu l dd OPTIONS` # Equivalent to the above, only using shortcuts
 
 See the [Dates](#dates) section for more information on acceptable DATE formats used by `dsu`.
@@ -118,6 +124,7 @@ See the [Mnemonics](#mnemonics) section for more information on acceptable MNEMO
 The following displays the entries for "Today", where `Time.now == '2023-05-06 08:54:57.6861 -0400'`
 
 `$ dsu list today`
+
 `$ dsu l t`
 ```shell
 #=>
@@ -130,7 +137,9 @@ Friday, (Yesterday) 2023-05-05
 ```
 
 `$ dsu list date 5/7/2023`
+
 `$ dsu list d 2023/7/5`
+
 `$ dsu l d 7/5` # When omitting YYYY, MM/DD is assumed
 
 ```shell
@@ -151,22 +160,27 @@ For more information, see the [Mnemonics](#mnemonics) section for more informati
 
 ##### Display the DSU entries for the last 3 days
 `$ dsu list dates --from yesterday --to -2`
+
 `$ dsu l dd -f y -t -2`
 
 ##### Display the DSU entries for 1/1 to 1/4 for the current year
 `$ dsu list dates --from 1/1 --to +3`
+
 `$ dsu l dd -f 1/1 -t +3`
 
 ##### Display the DSU entries for 1/2 to 1/5
 `$ dsu list dates --from 1/5 --to -3`
+
 `$ dsu l dd -f 1/5 -t -3`
 
 ##### Display the DSU entries for the last week
 `$ dsu list dates --from today --to -6`
+
 `$ dsu l dd -f n -t -6`
 
 ##### Display the DSU entries back 1 week from yesterday's date
 `$ dsu list dates --from -7 --to +6`
+
 `$ dsu l dd -f -7 -t +6`
 
 **NOTE:** **The above example is silly,** but it illustrates the fact that you can use relative mnemonics for both `--from` and `--to` options. While you *can* use relative mnemonics for both the `--from` and `--to` options, there is usually a more intuitive way.
@@ -176,6 +190,7 @@ For example:
 This can be accomplished MUCH easier by using the `yesterday` mnemonic. This will display the DSU entries back 1 week from yesterday's date.
 
 `$ dsu list dates --from yesterday --to -6`
+
 `$ dsu l dd -f y -t -6`
 
 ## Browsing DSU Entries
@@ -214,6 +229,7 @@ If no entries exist for the DSU date, the editor will open and allow you to add
 The following will edit your DSU entry group entries for "Today", where `Time.now == '2023-05-09 12:13:45.8273 -0400'`. Simply follow the directions in the editor file, then save and close your editor to apply the changes:
 
 `$ dsu edit today`
+
 `$ dsu e n`
 
 ```shell
@@ -257,20 +273,22 @@ from: Interative planning meeting 11:00AM.
 
 #### Add an Entry
 
-Simply type a new entry on a separate line. *Note: any entry that starts with a `#` in the first character position will be ignored.*
+Simply type a new entry on a separate line.
 
 For example...
 ```
 Add me to this entry group.
 ```
 
+**NOTE:** Any entry that starts with a `#` in the first character position will be ignored.*
+
 #### Delete an Entry
 
 Simply delete the entry.
 
 For example...
 ```
-# Delete this this entry from the editor file
+# Delete this entry from the editor file
 from: Interative planning meeting 11:00AM.
   to: <deleted>
 ```
@@ -315,6 +333,7 @@ See the [Mnemonics](#mnemonics) section for more information on acceptable MNEMO
 The following example deletes the entry group and *all* entries for today's date.
 
 `$ dsu delete today`
+
 `$ dsu d n`
 ```shell
 #=>
@@ -324,6 +343,7 @@ Deleted 1 entry group(s).
 The following example deletes the entry group and *all* entries for yesterday's date.
 
 `$ dsu delete yesterday`
+
 `$ dsu d y`
 ```shell
 #=>
@@ -333,6 +353,7 @@ Deleted 1 entry group(s).
 The following example deletes the entry group and *all* entries for tomorrow's date.
 
 `$ dsu delete tomorrow`
+
 `$ dsu d t`
 ```shell
 #=>
@@ -343,6 +364,7 @@ Deleted 1 entry group(s).
 The following deletes the entry group and all entries for 12/17 of the current year.
 
 `$ dsu delete date 12/17`
+
 `$ dsu d d 12/17`
 ```shell
 #=>
@@ -353,12 +375,44 @@ Deleted 1 entry group(s)
 The following deletes the entry group and all entries for the past week, starting from today (12/17/2023).
 
 `$ dsu delete dates --from today --to -6`
+
 `$ dsu d dd -f n -t -6`
 ```shell
 #=>
 Are you sure you want to delete all the entries for 2023-12-11 thru 2023-12-17 (7 entry groups)? [y/N]> y
 Deleted 7 entry group(s).
 ```
+
+## Exporting DSU Entries
+
+Some ingenious soul may want to write a utility at some point, so `dsu` provides the means to export its data into a `csv` file for convenience. Of course, if you feel so inclined, you may also use the `dsu` entry group `json` files directly. The `dsu` entry group `json` files can be located by running the `dsu info` command, and locating the "Entries folder" value.
+
+If you want to use a `csv` file, you can export `dsu` entries to a `csv` file by using any of the following commands:
+
+- `$ dsu export all`
+- `$ dsu x a` # Equivalent to the above, only using shortcuts
+- `$ dsu export dates OPTIONS`
+- `$ dsu x dd OPTIONS` # Equivalent to the above, only using shortcuts
+
+**NOTE:** Each `export` command will prompt you to confirm the export. If confirmed, `dsu` will write a `csv` file to your operating systems temp folder, in the following format: `"dsu-<timestamp>-<from date>-thru-<to date>.csv"`:
+
+Where:
+- <timestamp> = '%Y%m%d%H%M%S'
+- <from date> = the date of the earliest entry group exported (if `export all`) or the earliest date of the entry group dates to be exported (if `export dates`).
+- <to date> = the date of the most resent entry group exported (if `export all`) or the most recent date of the entry group dates to be exported (if `export dates`).
+-
+### For example
+
+The following command, when run on December 25, 2023, at 20:15:46...
+
+`$ dsu export dates -f 1/1/1999 -t 12/23/2023`
+
+...will export `dsu` entries for all Entry Groups that fall between the dates of January 1st, 1999 through December 23rd 2023 in the time zone it was executed, and write them to the following file:
+
+`/var/folders/yv/5n77gtzn7z33ytwgr9mlbbrhf5rws6/T/dsu-20231225201546-1999-01-01-thru-2023-12-23.csv`
+
+For more information, see `dsu` help (`$ dsu export` or `dsu help export`) for more information.
+
 ## Customizing the `dsu` Configuration File
 To customize the `dsu` configuration file, you may follow the instructions outlined here. It is only recommended that you customize the `dsu` configuration file *only* if you are working with an official release (`n.n.n.n`).
 

data/lib/dsu/cli.rb

@@ -7,6 +7,7 @@ require_relative 'subcommands/browse'
 require_relative 'subcommands/config'
 require_relative 'subcommands/delete'
 require_relative 'subcommands/edit'
+require_relative 'subcommands/export'
 require_relative 'subcommands/list'
 require_relative 'subcommands/theme'
 
@@ -18,6 +19,7 @@ module Dsu
     map I18n.t('commands.config.key_mappings') => :config
     map I18n.t('commands.delete.key_mappings') => :delete
     map I18n.t('commands.edit.key_mappings') => :edit
+    map I18n.t('commands.export.key_mappings') => :export
     map I18n.t('commands.help.key_mappings') => :help
     map I18n.t('commands.info.key_mappings') => :info
     map I18n.t('commands.list.key_mappings') => :list
@@ -60,6 +62,9 @@ module Dsu
     desc I18n.t('commands.edit.desc'), I18n.t('commands.edit.usage')
     subcommand :edit, Subcommands::Edit
 
+    desc I18n.t('commands.export.desc'), I18n.t('commands.export.usage')
+    subcommand :export, Subcommands::Export
+
     desc I18n.t('commands.theme.desc'), I18n.t('commands.theme.usage')
     subcommand :theme, Subcommands::Theme
 

data/lib/dsu/models/entry_group.rb

@@ -120,9 +120,7 @@ module Dsu
             next unless entry_file_name.match?(ENTRIES_FILE_NAME_REGEX)
 
             entry_date = File.basename(entry_file_name, '.*')
-            file_path = entries_path_for(time: Time.parse(entry_date))
-            entry_group_hash = read!(file_path: file_path)
-            Services::EntryGroup::HydratorService.new(entry_group_hash: entry_group_hash).call
+            find time: Time.parse(entry_date)
           end
         end
 
@@ -167,6 +165,12 @@ module Dsu
           end
         end
 
+        def entry_groups(between:)
+          entry_group_times(between: between).filter_map do |time|
+            Models::EntryGroup.find(time: Time.parse(time))
+          end
+        end
+
         def find(time:)
           file_path = entries_path_for(time: time)
           entry_group_hash = read!(file_path: file_path)

data/lib/dsu/presenters/base_presenter_ex.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'delegate'
+require_relative '../models/color_theme'
+require_relative '../support/color_themable'
+
+module Dsu
+  module Presenters
+    class BasePresenterEx
+      include Support::ColorThemable
+
+      def initialize(options: {})
+        @options = options || {}
+        @color_theme = Models::ColorTheme.find(theme_name: theme_name)
+      end
+
+      private
+
+      attr_reader :color_theme, :options
+
+      def theme_name
+        @theme_name ||= options.fetch(:theme_name, Models::Configuration.new.theme_name)
+      end
+    end
+  end
+end

data/lib/dsu/presenters/export/all_presenter.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require_relative '../../models/entry_group'
+require_relative '../../services/entry_group/exporter_service'
+require_relative '../../support/ask'
+require_relative '../base_presenter_ex'
+require_relative 'messages'
+require_relative 'service_callable'
+
+module Dsu
+  module Presenters
+    module Export
+      class AllPresenter < BasePresenterEx
+        include Messages
+        include ServiceCallable
+        include Support::Ask
+
+        def render(response:)
+          return display_cancelled_message unless response
+
+          export_file_path = exporter_service_call
+
+          display_exported_message
+          display_exported_to_message(file_path: export_file_path)
+        end
+
+        def display_export_prompt
+          yes?(prompt_with_options(prompt: export_prompt, options: export_prompt_options))
+        end
+
+        private
+
+        def entry_groups
+          @entry_groups ||= Models::EntryGroup.all
+        end
+
+        def export_prompt
+          I18n.t('subcommands.export.prompts.export_all_confirm', count: entry_groups.count)
+        end
+
+        def export_prompt_options
+          I18n.t('subcommands.export.prompts.options')
+        end
+      end
+    end
+  end
+end

data/lib/dsu/presenters/export/dates_presenter.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require_relative '../../models/entry_group'
+require_relative '../../support/ask'
+require_relative '../base_presenter_ex'
+require_relative 'messages'
+require_relative 'service_callable'
+
+module Dsu
+  module Presenters
+    module Export
+      class DatesPresenter < BasePresenterEx
+        include Messages
+        include ServiceCallable
+        include Support::Ask
+
+        def initialize(from:, to:, options: {})
+          super(options: options)
+
+          @from = from
+          @to = to
+        end
+
+        def render(response:)
+          return display_cancelled_message unless response
+
+          export_file_path = exporter_service_call
+
+          display_exported_message
+          display_exported_to_message(file_path: export_file_path)
+        end
+
+        def display_export_prompt
+          yes?(prompt_with_options(prompt: export_prompt, options: export_prompt_options))
+        end
+
+        private
+
+        attr_reader :from, :to, :options
+
+        def entry_groups
+          Models::EntryGroup.entry_groups(between: [from, to])
+        end
+
+        def export_prompt
+          I18n.t('subcommands.export.prompts.export_dates_confirm',
+            from: from.to_date, to: to.to_date, count: entry_groups.count)
+        end
+
+        def export_prompt_options
+          I18n.t('subcommands.export.prompts.options')
+        end
+      end
+    end
+  end
+end

data/lib/dsu/presenters/export/messages.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require_relative '../../models/entry_group'
+require_relative '../base_presenter_ex'
+
+module Dsu
+  module Presenters
+    module Export
+      module Messages
+        def display_export_prompt
+          raise NotImplementedError
+        end
+
+        private
+
+        def display_cancelled_message
+          puts apply_theme(I18n.t('subcommands.export.messages.cancelled'), theme_color: color_theme.info)
+        end
+
+        def display_exported_message
+          puts apply_theme(I18n.t('subcommands.export.messages.exported'), theme_color: color_theme.success)
+        end
+
+        def display_exported_to_message(file_path:)
+          puts apply_theme(I18n.t('subcommands.export.messages.exported_to', file_path: file_path),
+            theme_color: color_theme.success)
+        end
+      end
+    end
+  end
+end

data/lib/dsu/presenters/export/service_callable.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require_relative '../../services/entry_group/exporter_service'
+
+module Dsu
+  module Presenters
+    module Export
+      module ServiceCallable
+        private
+
+        def exporter_service_call
+          @exporter_service_call ||= begin
+            exporter_service = Services::EntryGroup::ExporterService.new(entry_groups: entry_groups, options: options)
+            exporter_service.call
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dsu/services/entry_group/exporter_service.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require 'csv'
+require_relative '../../models/entry_group'
+require_relative '../../support/fileable'
+
+module Dsu
+  module Services
+    module EntryGroup
+      class ExporterService
+        include Support::Fileable
+
+        def initialize(entry_groups:, options: {})
+          raise ArgumentError, 'Argument entry_groups is nil' if entry_groups.nil?
+
+          @entry_groups = entry_groups
+          @options = options
+        end
+
+        def call
+          CSV.open(export_file_name, 'w') do |csv|
+            csv << %i[version entry_group entry_no total_entries entry_group_entry]
+
+            entry_groups.each do |entry_group|
+              next unless entry_group.exist?
+
+              entry_group.entries.each_with_index do |entry, index|
+                csv << [
+                  entry_group.version,
+                  entry_group.time.to_date,
+                  index + 1,
+                  entry_group.entries.count,
+                  entry.description
+                ]
+              end
+            end
+          end
+
+          export_file_name
+        end
+
+        def export_file_name
+          @export_file_name ||= begin
+            file_name = "dsu-#{export_timestamp}-#{times.min.to_date}-thru-#{times.max.to_date}.csv"
+            File.join(temp_folder, file_name)
+          end
+        end
+
+        private
+
+        attr_reader :entry_groups, :options
+
+        def times
+          @times ||= entry_groups.map(&:time)
+        end
+
+        def export_timestamp
+          Time.now.in_time_zone.strftime('%Y%m%d%H%M%S')
+        end
+      end
+    end
+  end
+end

data/lib/dsu/subcommands/delete.rb

@@ -91,7 +91,7 @@ module Dsu
           message = I18n.t('subcommands.delete.messages.deleted', count: deleted_count)
           Views::Shared::Success.new(messages: message).render
         else
-          message = I18n.t('subcommands.delete.messages.canceled')
+          message = I18n.t('subcommands.delete.messages.cancelled')
           Views::Shared::Info.new(messages: message).render
         end
       end

data/lib/dsu/subcommands/export.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require_relative '../support/command_options/dsu_times'
+require_relative '../support/command_options/time_mnemonic'
+require_relative '../support/time_formatable'
+require_relative '../views/export'
+require_relative '../views/shared/error'
+require_relative 'base_subcommand'
+
+module Dsu
+  module Subcommands
+    class Export < BaseSubcommand
+      include Support::CommandOptions::TimeMnemonic
+      include Support::TimeFormatable
+
+      # TODO: I18n.
+      map %w[a] => :all
+      map %w[dd] => :dates
+
+      desc I18n.t('subcommands.export.all.desc'), I18n.t('subcommands.export.all.usage')
+      long_desc I18n.t('subcommands.export.all.long_desc')
+      option :prompts, type: :hash, default: {}, hide: true, aliases: '-p'
+      def all
+        Views::Export.new(presenter: all_presenter(options: options)).render
+      end
+
+      desc I18n.t('subcommands.export.dates.desc'), I18n.t('subcommands.export.dates.usage')
+      long_desc I18n.t('subcommands.export.dates.long_desc',
+        date_option_description: date_option_description,
+        mnemonic_option_description: mnemonic_option_description)
+      option :from, type: :string, required: true, aliases: '-f', banner: 'DATE|MNEMONIC'
+      option :to, type: :string, required: true, aliases: '-t', banner: 'DATE|MNEMONIC'
+      option :prompts, type: :hash, default: {}, hide: true, aliases: '-p'
+      def dates
+        options = configuration.to_h.merge(self.options).with_indifferent_access
+        times, errors = Support::CommandOptions::DsuTimes.dsu_times_for(from_option: options[:from], to_option: options[:to]) # rubocop:disable Layout/LineLength
+        if errors.any?
+          Views::Shared::Error.new(messages: errors).render
+          return
+        end
+
+        times = times_sort(times: times, entries_display_order: options[:entries_display_order])
+        Views::Export.new(presenter: dates_presenter_for(from: times.min, to: times.max, options: options)).render
+      rescue ArgumentError => e
+        Views::Shared::Error.new(messages: e.message).render
+      end
+
+      private
+
+      def all_presenter(options:)
+        Presenters::Export::AllPresenter.new(options: options)
+      end
+
+      def dates_presenter_for(from:, to:, options:)
+        Presenters::Export::DatesPresenter.new(from: from, to: to, options: options)
+      end
+    end
+  end
+end

data/lib/dsu/subcommands/theme.rb

@@ -40,7 +40,7 @@ module Dsu
             Views::Shared::Info.new(messages: "\n#{message}").render
             true
           else
-            message = I18n.t('subcommands.theme.create.messages.canceled')
+            message = I18n.t('subcommands.theme.create.messages.cancelled')
             Views::Shared::Info.new(messages: "\n#{message}").render
             false
           end
@@ -71,7 +71,7 @@ module Dsu
             change_theme
             I18n.t('subcommands.theme.delete.messages.deleted', theme_name: theme_name)
           else
-            I18n.t('subcommands.theme.delete.messages.canceled')
+            I18n.t('subcommands.theme.delete.messages.cancelled')
           end
           Views::Shared::Info.new(messages: "\n#{message}").render
         end

data/lib/dsu/support/color_themable.rb

@@ -6,10 +6,12 @@ module Dsu
   module Support
     module ColorThemable
       def prompt_with_options(prompt:, options:)
+        # HACK: This module needs to be refactored to be more generic.
+        target_color_theme = defined?(color_theme) ? color_theme : self
         options = "[#{options.join('/')}]"
-        "#{apply_theme(prompt, theme_color: self.prompt)} " \
-          "#{apply_theme(options, theme_color: prompt_options)}" \
-          "#{apply_theme('>', theme_color: self.prompt)}"
+        "#{apply_theme(prompt, theme_color: target_color_theme.prompt)} " \
+          "#{apply_theme(options, theme_color: target_color_theme.prompt_options)}" \
+          "#{apply_theme('>', theme_color: target_color_theme.prompt)}"
       end
 
       module_function

data/lib/dsu/version.rb

@@ -2,5 +2,5 @@
 
 module Dsu
   VERSION_REGEX = /\A\d+\.\d+\.\d+(\.(alpha|rc)\.\d+)?\z/
-  VERSION = '2.2.1'
+  VERSION = '2.3.0'
 end

data/lib/dsu/views/export.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require_relative '../models/color_theme'
+require_relative '../models/configuration'
+require_relative '../support/color_themable'
+
+module Dsu
+  module Views
+    class Export
+      include Support::ColorThemable
+
+      def initialize(presenter:)
+        @presenter = presenter
+      end
+
+      def render
+        response = presenter.display_export_prompt
+        presenter.render response: response
+      end
+
+      private
+
+      attr_reader :presenter
+    end
+  end
+end

data/lib/locales/en/commands.yml

@@ -58,13 +58,17 @@ en:
       desc: config|c SUBCOMMAND
       usage: Manage configuration file for this gem
     delete:
-      key_mappings: c
+      key_mappings: d
       desc: delete|d SUBCOMMAND
       usage: Delete DSU entries for the given SUBCOMMAND
     edit:
       desc: edit|e SUBCOMMAND
       usage: Edit DSU entries for the given SUBCOMMAND
       key_mappings: e
+    export:
+      key_mappings: x
+      desc: export|x SUBCOMMAND
+      usage: Export DSU entries for the given SUBCOMMAND
     info:
       key_mappings: i
       desc: info|i

data/lib/locales/en/subcommands.yml

@@ -118,9 +118,9 @@ en:
         long_desc: |
           Deletes the DSU entries for the given OPTIONS.
 
-          $ dsu dates OPTIONS
+          $ dsu delete dates OPTIONS
 
-          $ dsu dd OPTIONS
+          $ dsu d dd OPTIONS
 
           OPTIONS:
 
@@ -191,7 +191,7 @@ en:
           $ dsu delete y
       messages:
         deleted: Deleted %{count} entry group(s).
-        canceled: Canceled.
+        cancelled: Cancelled.
       prompts:
         are_you_sure: Are you sure you want to delete all the entries for %{dates} (%{count} entry groups)?
     edit:
@@ -217,6 +217,76 @@ en:
         usage: Edits the DSU entries for yesterday
         long_desc: |
           Edits the DSU entries for yesterday.
+    export:
+      dates:
+        desc: dates|dd OPTIONS
+        usage: Exports the DSU entries for the OPTIONS provided
+        long_desc: |
+          Exports the DSU entries for the given OPTIONS.
+
+          $ dsu export dates OPTIONS
+
+          $ dsu x dd OPTIONS
+
+          OPTIONS:
+
+          -f|--from DATE|MNEMONIC: The DATE or MNEMONIC that represents the start of the range of DSU dates to export. If a relative mnemonic is used (+/-n, e.g +1, -1, etc.), the date calculated will be relative to the current date (e.g. `<MNEMONIC>.to_i.days.from_now(Time.now)`).
+
+          -t|--to DATE|MNEMONIC: The DATE or MNEMONIC that represents the end of the range of DSU dates to export. If a relative mnemonic 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.
+
+          %{date_option_description}
+
+          %{mnemonic_option_description}
+
+          EXAMPLES:
+
+          NOTE: All examples can substitute their respective short form options (e.g. `-f`, `-t`, etc. for `--from`, `--to`, etc.).
+
+          The below will export the DSU entries for the range of dates from 1/1 to 1/4 for the current year:
+
+          $ dsu export dates --from 1/1 --to +3
+
+          This will export the DSU entries for the range of dates from 1/2 to 1/5 for the year 2022:
+
+          $ dsu x dd --from 1/5/2022 --to -3
+
+          This (assuming "today" is 1/10) will export the DSU entries for the last week 1/10 to 1/3 of the current year:
+
+          $ dsu export dates --from today --to -7
+
+          This (assuming "today" is 5/23) will export the DSU entries for the last week 5/16 to 5/22.
+          This example simply illustrates the fact that you can use relative mnemonics for
+          both `--from` and `--to` options; this doesn't mean you should do so...
+
+          While you can use relative mnemonics for both `--from` and `--to` options,
+          there is always a more intuitive way. The below example basically exports one week of DSU entries back 1 week from yesterday's date:
+
+          $ dsu export dates --from -7 --to +6
+
+          The above can be accomplished MUCH easier by simply using the `yesterday` mnemonic...
+
+          This (assuming "today" is 5/23) will delete the DSU entries back 1 week from yesterday's date 5/16 to 5/22:
+
+          $ dsu x dd --from yesterday --to -6
+      all:
+        desc: all|a
+        usage: Exports all DSU entries
+        long_desc: |
+          Exports all DSU entries.
+
+          $ dsu export all
+
+          $ dsu x a
+      messages:
+        exported: Export successful.
+        exported_to: Entry groups exported to %{file_path}.
+        cancelled: Cancelled.
+      prompts:
+        export_all_confirm: Export all the entries (%{count} entry groups)?
+        export_dates_confirm: Export all the entries for %{from} thru %{to} (%{count} entry groups)?
+        options:
+          - y
+          - N
     list:
       date:
         desc: date|d DATE|MNEMONIC
@@ -233,9 +303,9 @@ en:
         long_desc: |
           Displays the DSU entries for the given OPTIONS.
 
-          $ dsu dates OPTIONS
+          $ dsu list dates OPTIONS
 
-          $ dsu dd OPTIONS
+          $ dsu l dd OPTIONS
 
           OPTIONS:
 
@@ -331,7 +401,7 @@ en:
           already_exists: Color theme "%{theme_name}" already exists.
         messages:
           created: Created color theme "%{theme_name}".
-          canceled: Canceled.
+          cancelled: Cancelled.
       delete:
         desc: delete THEME_NAME
         usage: Deletes the existing dsu color theme THEME_NAME
@@ -344,7 +414,7 @@ en:
         errors:
           cannot_delete: Color theme "%{theme_name}" cannot be deleted.
         messages:
-          canceled: Canceled.
+          cancelled: Cancelled.
           deleted: Deleted color theme "%{theme_name}".
       list:
         desc: list

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dsu
 version: !ruby/object:Gem::Version
-  version: 2.2.1
+  version: 2.3.0
 platform: ruby
 authors:
 - Gene M. Angelo, Jr.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-12-24 00:00:00.000000000 Z
+date: 2023-12-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -179,11 +179,16 @@ files:
 - lib/dsu/models/entry_group.rb
 - lib/dsu/models/migration_version.rb
 - lib/dsu/presenters/base_presenter.rb
+- lib/dsu/presenters/base_presenter_ex.rb
 - lib/dsu/presenters/color_theme_presenter.rb
 - lib/dsu/presenters/color_theme_show_presenter.rb
 - lib/dsu/presenters/configuration_presenter.rb
 - lib/dsu/presenters/entry_group_presenter.rb
 - lib/dsu/presenters/entry_presenter.rb
+- lib/dsu/presenters/export/all_presenter.rb
+- lib/dsu/presenters/export/dates_presenter.rb
+- lib/dsu/presenters/export/messages.rb
+- lib/dsu/presenters/export/service_callable.rb
 - lib/dsu/services/color_theme/hydrator_service.rb
 - lib/dsu/services/configuration/hydrator_service.rb
 - lib/dsu/services/entry/hydrator_service.rb
@@ -191,6 +196,7 @@ files:
 - lib/dsu/services/entry_group/counter_service.rb
 - lib/dsu/services/entry_group/deleter_service.rb
 - lib/dsu/services/entry_group/editor_service.rb
+- lib/dsu/services/entry_group/exporter_service.rb
 - lib/dsu/services/entry_group/hydrator_service.rb
 - lib/dsu/services/migration_version/hydrator_service.rb
 - lib/dsu/services/stderr_redirector_service.rb
@@ -202,6 +208,7 @@ files:
 - lib/dsu/subcommands/config.rb
 - lib/dsu/subcommands/delete.rb
 - lib/dsu/subcommands/edit.rb
+- lib/dsu/subcommands/export.rb
 - lib/dsu/subcommands/list.rb
 - lib/dsu/subcommands/theme.rb
 - lib/dsu/support/ask.rb
@@ -237,6 +244,7 @@ files:
 - lib/dsu/views/entry_group/shared/no_entries_to_display_for_week_of.rb
 - lib/dsu/views/entry_group/shared/no_entries_to_display_for_year_of.rb
 - lib/dsu/views/entry_group/show.rb
+- lib/dsu/views/export.rb
 - lib/dsu/views/shared/error.rb
 - lib/dsu/views/shared/info.rb
 - lib/dsu/views/shared/message.rb