dsu 2.3.1 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a8d5e213674fcc08f03c21defe8712674ebf58ce5d68910d36a8e149f287f8d3
-  data.tar.gz: ebba09045768d12985eecba52f432edd9461d2814b2f437518f829e6aa3dc9cd
+  metadata.gz: '049f61bd321689f9690d42ba2cb72e0901c63e78a1c6454ee8fe0126e8dc0396'
+  data.tar.gz: e1687331fa05a352b29800f86b43de93b780a8efa50d74e1be13ce83fa331b23
 SHA512:
-  metadata.gz: b4d11fe31ae4bf5e783f3c3b5c064a052f537f23423fd7cb290a8d6d325820bf202ee33dd0b41ab8928651e3272522974efdae58a4ba474d5116cedd2a3fc4a7
-  data.tar.gz: 174da97c30f0d3467e0c2e22f7d573de4131507f6a26a6be0591c1051457a0edb2bc81ed10b6d54016d019952cfcd705a3beba3029f8fcc259d66d5839b30c68
+  metadata.gz: 2d5547b1ce5e805ec2ea8399ed01b76a7c03180b3ddc14b1ad9225cbacec79dbc963b37b24224fac6397b0a88b51772741e0a2840db70064f37f179b2e1d7aa5
+  data.tar.gz: a0146a22e7fe3404ee63de7f26d1ce66d945685ec21e41fd1b20eaed4b5cea037920552a5dc52be26c6394dfdf90ff9382d8702ffcfe3b9de571e9b1c0d59e6d

data/CHANGELOG.md

@@ -1,3 +1,21 @@
+## [2.4.0] 2024-01-01
+
+Enhancements
+
+- Add `dsu import` command to import DSU entries from a comma-delimited csv file. See `dsu help import` for more information.
+- Update README.md to reflect new `dsu import` command.
+
+Changes
+
+- Update ruby gems.
+
+## [2.3.2] 2023-12-30
+
+Changes
+
+- Display a "Nothing to export" message if no entries are found, rather than prompting the user "export 0 entry groups" when using the `dsu export` command.
+- Add specs for Export::AllPresenter and Export::DatesPresenter
+
 ## [2.3.1] 2023-12-25
 
 Changes

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    dsu (2.3.1)
+    dsu (2.4.0)
       activemodel (>= 7.0.8, < 8.0)
       activesupport (>= 7.0.8, < 8.0)
       colorize (>= 0.8.1, < 1.0)
@@ -37,13 +37,38 @@ GEM
     dotenv (2.8.1)
     drb (2.2.0)
       ruby2_keywords
-    factory_bot (6.4.2)
+    dry-configurable (1.1.0)
+      dry-core (~> 1.0, < 2)
+      zeitwerk (~> 2.6)
+    dry-core (1.0.1)
+      concurrent-ruby (~> 1.0)
+      zeitwerk (~> 2.6)
+    dry-inflector (1.0.0)
+    dry-initializer (3.1.1)
+    dry-logic (1.5.0)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 1.0, < 2)
+      zeitwerk (~> 2.6)
+    dry-schema (1.13.3)
+      concurrent-ruby (~> 1.0)
+      dry-configurable (~> 1.0, >= 1.0.1)
+      dry-core (~> 1.0, < 2)
+      dry-initializer (~> 3.0)
+      dry-logic (>= 1.4, < 2)
+      dry-types (>= 1.7, < 2)
+      zeitwerk (~> 2.6)
+    dry-types (1.7.1)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 1.0)
+      dry-inflector (~> 1.0)
+      dry-logic (~> 1.4)
+      zeitwerk (~> 2.6)
+    factory_bot (6.4.5)
       activesupport (>= 5.0.0)
     ffaker (2.23.0)
     i18n (1.14.1)
       concurrent-ruby (~> 1.0)
     json (2.7.1)
-    kwalify (0.7.2)
     language_server-protocol (3.17.0.3)
     method_source (1.0.0)
     minitest (5.20.0)
@@ -62,10 +87,11 @@ GEM
     racc (1.7.3)
     rainbow (3.1.1)
     rake (13.1.0)
-    reek (6.1.4)
-      kwalify (~> 0.7.0)
+    reek (6.2.0)
+      dry-schema (~> 1.13.0)
       parser (~> 3.2.0)
       rainbow (>= 2.0, < 4.0)
+      rexml (~> 3.1)
     regexp_parser (2.8.3)
     rexml (3.2.6)
     rspec (3.12.0)
@@ -114,10 +140,11 @@ GEM
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.4)
     thor (1.3.0)
-    thor_nested_subcommand (1.0.4)
+    thor_nested_subcommand (1.0.5)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.5.0)
+    zeitwerk (2.6.12)
 
 PLATFORMS
   x86_64-darwin-19

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?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)
+[![GitHub version](http://badge.fury.io/gh/gangelo%2Fdsu.svg?refresh=4)](https://badge.fury.io/gh/gangelo%2Fdsu)
+[![Gem Version](https://badge.fury.io/rb/dsu.svg?refresh=4)](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)
@@ -44,6 +44,7 @@ Commands:
   dsu edit|e SUBCOMMAND            # Edit DSU entries...
   dsu export|x SUBCOMMAND          # Export DSU entries...
   dsu help [COMMAND]               # Describe available...
+  dsu import|m SUBCOMMAND          # Imports DSU entries...
   dsu info|i                       # Displays information...
   dsu list|l SUBCOMMAND            # Displays DSU entries...
   dsu theme|t SUBCOMMAND           # Manage DSU themes...
@@ -413,6 +414,43 @@ The following command, when run on December 25, 2023, at 20:15:46...
 
 For more information, see `dsu` help (`$ dsu export` or `dsu help export`) for more information.
 
+## Importing DSU Entries
+
+`dsu` provides a means to import entry group entry data from a previously exported `csv` file (see [Exporting DSU Entries](#exporting-dsu-entries)).
+
+If you want to import a previously expoeted `csv` file, you can import `dsu` entries from a `csv` file by using any of the following commands:
+
+- `$ dsu import all`
+- `$ dsu m a` # Equivalent to the above, only using shortcuts
+- `$ dsu import dates OPTIONS`
+- `$ dsu m dd OPTIONS` # Equivalent to the above, only using shortcuts
+
+**NOTE:** Each `import` command will prompt you to confirm the import. If confirmed, `dsu` will import the entry group entry data from the `csv` file into `dsu`.
+
+### For example
+
+### Importing all entries from a `csv` file
+You can import _all_ entry group entries from a `csv` file.
+
+The following command will import all the `dsu` entries from the given `csv` file, and merge the imported entries with any existing entry group entries you may have:
+
+`$ dsu import all -i ~/Downloads/dsu-20231225201546-2023-01-01-thru-2024-01-01.csv`
+
+The following command will import all the `dsu` entries from the given `csv` file, and **_overwrite_** all entry groups entries with the same entry group date using the `dsu export all` shortcut command:
+
+`$ dsu m a -m false -i ~/Downloads/dsu-20231225201546-2023-01-01-thru-2024-01-01.csv`
+
+### Importing specific entries from a `csv` file
+You can import _specific_ entry group entries from a `csv` file for a date range.
+
+The following command will import the `dsu` entries from the given `csv` file for the given date range, and merge the imported entries with any existing entry group entries you may have:
+
+`$ dsu import dates --from 1/1/2023 --to 12/31/2023 -i ~/Downloads/dsu-20231225201546-2023-01-01-thru-2024-01-01.csv`
+
+The following command will import the `dsu` entries from the given `csv` file for the given date range, and **_overwrite_** all entry groups entries with the same entry group date using the `dsu import dates` shortcut command:
+
+`$ dsu m dd -m false -f 1/1/2023 -t 12/31/2023 -i ~/Downloads/dsu-20231225201546-2023-01-01-thru-2024-01-01.csv`
+
 ## 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

@@ -8,6 +8,7 @@ require_relative 'subcommands/config'
 require_relative 'subcommands/delete'
 require_relative 'subcommands/edit'
 require_relative 'subcommands/export'
+require_relative 'subcommands/import'
 require_relative 'subcommands/list'
 require_relative 'subcommands/theme'
 
@@ -21,6 +22,7 @@ module Dsu
     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.import.key_mappings') => :import
     map I18n.t('commands.info.key_mappings') => :info
     map I18n.t('commands.list.key_mappings') => :list
     map I18n.t('commands.theme.key_mappings') => :theme
@@ -68,6 +70,9 @@ module Dsu
     desc I18n.t('commands.theme.desc'), I18n.t('commands.theme.usage')
     subcommand :theme, Subcommands::Theme
 
+    desc I18n.t('commands.import.desc'), I18n.t('commands.import.usage')
+    subcommand :import, Subcommands::Import
+
     desc I18n.t('commands.info.desc'), I18n.t('commands.info.usage')
     def info
       configuration_version = Models::Configuration::VERSION

data/lib/dsu/models/color_theme.rb

@@ -54,6 +54,9 @@ module Dsu
         description: 'Default theme.'
       }.merge(DEFAULT_THEME_COLORS).freeze
 
+      MIN_DESCRIPTION_LENGTH = 2
+      MAX_DESCRIPTION_LENGTH = 256
+
       # TODO: Validate other attrs.
       validates_with Validators::DescriptionValidator
       validates_with Validators::ColorThemeValidator

data/lib/dsu/models/entry.rb

@@ -14,6 +14,9 @@ module Dsu
       include Support::Descriptable
       include Support::Presentable
 
+      MIN_DESCRIPTION_LENGTH = 2
+      MAX_DESCRIPTION_LENGTH = 256
+
       validates_with Validators::DescriptionValidator
 
       attr_reader :description, :options

data/lib/dsu/models/entry_group.rb

@@ -191,13 +191,19 @@ module Dsu
         end
 
         def write(file_data:, file_path:)
-          delete(file_path: file_path) and return true if file_data[:entries].empty?
+          if file_data[:entries].empty?
+            superclass.delete(file_path: file_path)
+            return true
+          end
 
           super
         end
 
         def write!(file_data:, file_path:)
-          delete!(file_path: file_path) and return if file_data[:entries].empty?
+          if file_data[:entries].empty?
+            superclass.delete!(file_path: file_path)
+            return
+          end
 
           super
         end

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

@@ -5,6 +5,7 @@ require_relative '../../services/entry_group/exporter_service'
 require_relative '../../support/ask'
 require_relative '../base_presenter_ex'
 require_relative 'messages'
+require_relative 'nothing_to_export'
 require_relative 'service_callable'
 
 module Dsu
@@ -12,6 +13,7 @@ module Dsu
     module Export
       class AllPresenter < BasePresenterEx
         include Messages
+        include NothingToExport
         include ServiceCallable
         include Support::Ask
 
@@ -25,7 +27,7 @@ module Dsu
         end
 
         def display_export_prompt
-          yes?(prompt_with_options(prompt: export_prompt, options: export_prompt_options))
+          yes?(prompt_with_options(prompt: export_prompt, options: export_prompt_options), options: options)
         end
 
         private

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

@@ -4,6 +4,7 @@ require_relative '../../models/entry_group'
 require_relative '../../support/ask'
 require_relative '../base_presenter_ex'
 require_relative 'messages'
+require_relative 'nothing_to_export'
 require_relative 'service_callable'
 
 module Dsu
@@ -11,6 +12,7 @@ module Dsu
     module Export
       class DatesPresenter < BasePresenterEx
         include Messages
+        include NothingToExport
         include ServiceCallable
         include Support::Ask
 
@@ -31,7 +33,7 @@ module Dsu
         end
 
         def display_export_prompt
-          yes?(prompt_with_options(prompt: export_prompt, options: export_prompt_options))
+          yes?(prompt_with_options(prompt: export_prompt, options: export_prompt_options), options: options)
         end
 
         private

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

@@ -1,8 +1,5 @@
 # frozen_string_literal: true
 
-require_relative '../../models/entry_group'
-require_relative '../base_presenter_ex'
-
 module Dsu
   module Presenters
     module Export
@@ -11,6 +8,10 @@ module Dsu
           raise NotImplementedError
         end
 
+        def display_nothing_to_export_message
+          puts apply_theme(I18n.t('subcommands.export.messages.nothing_to_export'), theme_color: color_theme.info)
+        end
+
         private
 
         def display_cancelled_message

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Dsu
+  module Presenters
+    module Export
+      module NothingToExport
+        def nothing_to_export?
+          entry_groups.empty?
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require_relative '../../models/entry_group'
+require_relative '../../services/entry_group/importer_service'
+require_relative '../../support/ask'
+require_relative '../base_presenter_ex'
+require_relative 'import_file'
+require_relative 'messages'
+require_relative 'service_callable'
+
+module Dsu
+  module Presenters
+    module Import
+      class AllPresenter < BasePresenterEx
+        include ImportFile
+        include Messages
+        include ServiceCallable
+        include Support::Ask
+
+        def initialize(import_file_path:, options: {})
+          super(options: options)
+
+          @import_file_path = import_file_path
+        end
+
+        def render(response:)
+          return display_cancelled_message unless response
+
+          display_import_messages importer_service_call
+        end
+
+        def display_import_prompt
+          yes?(prompt_with_options(prompt: import_prompt, options: import_prompt_options), options: options)
+        end
+
+        private
+
+        attr_reader :import_file_path, :options
+
+        def import_entry_groups
+          @import_entry_groups ||= CSV.foreach(import_file_path,
+            headers: true).with_object({}) do |entry_group_entry, entry_groups_hash|
+            next unless entry_group_entry['version'].to_i == Dsu::Migration::VERSION
+
+            Date.parse(entry_group_entry['entry_group']).to_s.tap do |time|
+              entry_groups_hash[time] = [] unless entry_groups_hash.key?(time)
+              entry_groups_hash[time] << entry_group_entry['entry_group_entry']
+            end
+          end
+        end
+
+        def import_prompt
+          I18n.t('subcommands.import.prompts.import_all_confirm', count: import_entry_groups.count)
+        end
+
+        def import_prompt_options
+          I18n.t('subcommands.import.prompts.options')
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require_relative '../../models/entry_group'
+require_relative '../../services/entry_group/importer_service'
+require_relative '../../support/ask'
+require_relative '../base_presenter_ex'
+require_relative 'import_file'
+require_relative 'messages'
+require_relative 'service_callable'
+
+module Dsu
+  module Presenters
+    module Import
+      class DatesPresenter < BasePresenterEx
+        include ImportFile
+        include Messages
+        include ServiceCallable
+        include Support::Ask
+
+        def initialize(from:, to:, import_file_path:, options: {})
+          super(options: options)
+
+          @from = from.beginning_of_day
+          @to = to.end_of_day
+          @import_file_path = import_file_path
+        end
+
+        def render(response:)
+          return display_cancelled_message unless response
+
+          display_import_messages importer_service_call
+        end
+
+        def display_import_prompt
+          yes?(prompt_with_options(prompt: import_prompt, options: import_prompt_options), options: options)
+        end
+
+        private
+
+        attr_reader :from, :to, :import_file_path, :options
+
+        def import_entry_groups
+          @import_entry_groups ||= CSV.foreach(import_file_path,
+            headers: true).with_object({}) do |entry_group_entry, entry_groups_hash|
+            next unless entry_group_entry['version'].to_i == Dsu::Migration::VERSION
+
+            entry_group_time = middle_of_day_for(entry_group_entry['entry_group'])
+            next unless entry_group_time.to_date.between?(from.to_date, to.to_date)
+
+            entry_group_time.to_date.to_s.tap do |time|
+              entry_groups_hash[time] = [] unless entry_groups_hash.key?(time)
+              entry_groups_hash[time] << entry_group_entry['entry_group_entry']
+            end
+          end
+        end
+
+        def import_prompt
+          I18n.t('subcommands.import.prompts.import_dates_confirm',
+            from: from.to_date, to: to.to_date, count: import_entry_groups.keys.count)
+        end
+
+        def import_prompt_options
+          I18n.t('subcommands.import.prompts.options')
+        end
+
+        def middle_of_day_for(date_string)
+          Time.parse(date_string).in_time_zone.middle_of_day
+        end
+      end
+    end
+  end
+end

data/lib/dsu/presenters/import/import_file.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Dsu
+  module Presenters
+    module Import
+      module ImportFile
+        def import_file_path_exist?
+          File.exist? import_file_path
+        end
+
+        def nothing_to_import?
+          return true unless import_file_path_exist?
+
+          import_entry_groups.empty?
+        end
+
+        def import_entry_groups
+          # Should return a Hash of entry group entries
+          # Example: { '2023-12-32' => ['Entry description 1', 'Entry description 2', ...] }
+          raise NotImplementedError
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Dsu
+  module Presenters
+    module Import
+      module Messages
+        def display_import_prompt
+          raise NotImplementedError
+        end
+
+        def display_import_file_not_exist_message
+          puts apply_theme(I18n.t('subcommands.import.messages.file_not_exist',
+            file_path: import_file_path), theme_color: color_theme.info)
+        end
+
+        def display_nothing_to_import_message
+          puts apply_theme(I18n.t('subcommands.import.messages.nothing_to_import'), theme_color: color_theme.info)
+        end
+
+        private
+
+        def display_cancelled_message
+          puts apply_theme(I18n.t('subcommands.import.messages.cancelled'), theme_color: color_theme.info)
+        end
+
+        def display_import_messages(import_results)
+          import_results.each_pair do |entry_group_date, errors|
+            if errors.empty?
+              puts apply_theme(I18n.t('subcommands.import.messages.import_success',
+                date: entry_group_date), theme_color: color_theme.success)
+            else
+              errors.each do |error|
+                puts apply_theme(I18n.t('subcommands.import.messages.import_error',
+                  date: entry_group_date, error: error), theme_color: color_theme.error)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require_relative '../../services/entry_group/importer_service'
+
+module Dsu
+  module Presenters
+    module Import
+      module ServiceCallable
+        private
+
+        def importer_service_call
+          @importer_service_call ||= begin
+            importer_service = Services::EntryGroup::ImporterService.new(import_entry_groups: import_entry_groups,
+              options: options)
+            importer_service.call
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -11,51 +11,69 @@ module Dsu
         include Support::Fileable
 
         def initialize(entry_groups:, options: {})
-          raise ArgumentError, 'Argument entry_groups is nil' if entry_groups.nil?
+          raise ArgumentError, 'Argument entry_groups is blank' if entry_groups.blank?
+          raise ArgumentError, 'Argument entry_groups are not all valid' unless entry_groups.all?(&:valid?)
+
+          validate_entry_group_entries_present! entry_groups
 
           @entry_groups = entry_groups
           @options = options
         end
 
         def call
-          CSV.open(export_file_name, 'w') do |csv|
+          CSV.open(export_file_path, '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
+              export_entry_group(entry_group: entry_group, csv: csv)
             end
           end
 
-          export_file_name
+          export_file_path
         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
+        def export_file_path
+          @export_file_path ||= File.join(temp_folder, export_file_name)
         end
 
         private
 
         attr_reader :entry_groups, :options
 
+        def export_entry_data(entry_group:, entry:, entry_index:)
+          [
+            entry_group.version,
+            entry_group.time.to_date,
+            entry_index + 1,
+            entry_group.entries.count,
+            entry.description
+          ]
+        end
+
+        def export_entry_group(entry_group:, csv:)
+          entry_group.entries.each_with_index do |entry, index|
+            csv << export_entry_data(entry_group: entry_group, entry: entry, entry_index: index)
+          end
+        end
+
+        def export_file_name
+          "dsu-#{timestamp}-#{times.min.to_date}-thru-#{times.max.to_date}.csv"
+        end
+
         def times
           @times ||= entry_groups.map(&:time)
         end
 
-        def export_timestamp
-          Time.now.in_time_zone.strftime('%Y%m%d%H%M%S')
+        def timestamp
+          @timestamp ||= Time.now.in_time_zone.strftime('%Y%m%d%H%M%S')
+        end
+
+        def validate_entry_group_entries_present!(entry_groups)
+          entry_groups.each do |entry_group|
+            next if entry_group.entries.present?
+
+            raise ArgumentError, "Argument entry_groups entry group for #{entry_group.time_yyyy_mm_dd} has no entries"
+          end
         end
       end
     end

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

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+require 'csv'
+require_relative '../../models/entry_group'
+
+module Dsu
+  module Services
+    module EntryGroup
+      # Expects a hash having the following format:
+      # {
+      #   "2023-12-29" => ["Entry 1 description", "Entry 2 description", ...],
+      #   "2023-12-30" => ["Entry 1 description", ...],
+      #   "2023-12-31" => ["Entry 1 description", ...]
+      # }
+      class ImporterService
+        include Support::Fileable
+
+        def initialize(import_entry_groups:, options: {})
+          raise ArgumentError, 'Argument import_entry_groups is blank' if import_entry_groups.blank?
+
+          @import_entry_groups = import_entry_groups
+          @options = options
+        end
+
+        def call
+          import!
+        end
+
+        private
+
+        attr_reader :import_entry_groups, :options
+
+        def import!
+          import_entry_groups.each_pair do |entry_group_date, entry_descriptions|
+            entry_group_for(entry_group_date).tap do |entry_group|
+              entry_descriptions.each do |entry_description|
+                add_entry_group_entry_if(entry_group: entry_group, entry_description: entry_description)
+              end
+
+              import_messages[entry_group.time_yyyy_mm_dd] = []
+
+              unless entry_group.save
+                entry_group.errors.full_messages.each do |error|
+                  import_messages[entry_group.time_yyyy_mm_dd] << error
+                end
+              end
+            end
+          end
+
+          import_messages
+        end
+
+        def entry_group_for(entry_group_date)
+          time = Time.parse(entry_group_date).in_time_zone
+          if merge?
+            Models::EntryGroup.find_or_initialize(time: time)
+          else
+            Models::EntryGroup.new(time: time, options: options)
+          end
+        end
+
+        def add_entry_group_entry_if(entry_group:, entry_description:)
+          entry = Models::Entry.new(description: entry_description)
+          return entry_group.entries << entry if replace?
+          return if entry_group.entries.include?(entry)
+
+          entry_group.entries << entry
+        end
+
+        def merge?
+          options.fetch(:merge, true)
+        end
+
+        def replace?
+          !merge?
+        end
+
+        def import_messages
+          @import_messages ||= {}
+        end
+      end
+    end
+  end
+end

data/lib/dsu/subcommands/export.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require_relative '../presenters/export/all_presenter'
+require_relative '../presenters/export/dates_presenter'
 require_relative '../support/command_options/dsu_times'
 require_relative '../support/command_options/time_mnemonic'
 require_relative '../support/time_formatable'
@@ -39,7 +41,6 @@ module Dsu
           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

data/lib/dsu/subcommands/import.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+require_relative '../presenters/import/all_presenter'
+require_relative '../presenters/import/dates_presenter'
+require_relative '../support/command_options/dsu_times'
+require_relative '../support/command_options/time_mnemonic'
+require_relative '../support/time_formatable'
+require_relative '../views/import'
+require_relative '../views/shared/error'
+require_relative 'base_subcommand'
+
+module Dsu
+  module Subcommands
+    class Import < BaseSubcommand
+      include Support::CommandOptions::TimeMnemonic
+      include Support::TimeFormatable
+
+      # TODO: I18n.
+      map %w[a] => :all
+      map %w[dd] => :dates
+
+      desc I18n.t('subcommands.import.all.desc'), I18n.t('subcommands.import.all.usage')
+      long_desc I18n.t('subcommands.import.all.long_desc')
+      option :import_file, type: :string, required: true, aliases: '-i', banner: 'IMPORT_CVS_FILE'
+      option :merge, type: :boolean, default: true, aliases: '-m'
+      option :prompts, type: :hash, default: {}, hide: true, aliases: '-p'
+      def all
+        Views::Import.new(presenter: all_presenter(import_file_path: options[:import_file],
+          options: options)).render
+      end
+
+      desc I18n.t('subcommands.import.dates.desc'), I18n.t('subcommands.import.dates.usage')
+      long_desc I18n.t('subcommands.import.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 :import_file, type: :string, required: true, aliases: '-i', banner: 'IMPORT_CVS_FILE'
+      option :merge, type: :boolean, default: true, aliases: '-m'
+      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
+
+        Views::Import.new(presenter: dates_presenter_for(from: times.min,
+          to: times.max,
+          import_file_path: options[:import_file],
+          options: options)).render
+      rescue ArgumentError => e
+        Views::Shared::Error.new(messages: e.message).render
+      end
+
+      private
+
+      def all_presenter(import_file_path:, options:)
+        Presenters::Import::AllPresenter.new(import_file_path: import_file_path, options: options)
+      end
+
+      def dates_presenter_for(from:, to:, import_file_path:, options:)
+        Presenters::Import::DatesPresenter.new(from: from, to: to, import_file_path: import_file_path, options: options)
+      end
+    end
+  end
+end

data/lib/dsu/support/ask.rb

@@ -13,7 +13,10 @@ module Dsu
       def yes?(prompt, options: {})
         auto_prompt = auto_prompt(prompt, options)
 
-        return auto_prompt unless auto_prompt.nil?
+        unless auto_prompt.nil?
+          puts prompt
+          return auto_prompt
+        end
 
         Thor::Base.shell.new.yes?(prompt)
       end
@@ -21,9 +24,10 @@ module Dsu
       private
 
       def auto_prompt(prompt, options)
+        options = options.with_indifferent_access
         prompt = Utils.strip_escapes(prompt)
         @auto_prompt ||= begin
-          value = options.dig('prompts', prompt) || options.dig('prompts', 'any')
+          value = options.dig(:prompts, prompt) || options.dig(:prompts, :any)
           value = (value == 'true' unless value.nil?)
           value
         end

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

@@ -21,7 +21,7 @@ module Dsu
           errors << I18n.t('errors.to_option_invalid', to_option: to_option) if to_time.nil?
           return [[], errors] if errors.any?
 
-          min_time, max_time = [from_time, to_time].sort
+          min_time, max_time = [from_time, to_time].minmax
           [(min_time.to_date..max_time.to_date).map(&:to_time), []]
         end
 

data/lib/dsu/validators/description_validator.rb

@@ -12,6 +12,7 @@ module Dsu
         end
 
         unless description.is_a?(String)
+          # TODO: I18n.
           record.errors.add(:description, 'is the wrong object type. ' \
                                           "\"String\" was expected, but \"#{description.class}\" was received.")
           return
@@ -25,16 +26,26 @@ module Dsu
       def validate_description(record)
         description = record.description
 
-        return if description.length.between?(2, 256)
+        return if description.length.between?(min_description_length(record), max_description_length(record))
 
-        if description.length < 2
+        if description.length < min_description_length(record)
           # TODO: I18n.
-          record.errors.add(:description, "is too short: \"#{record.short_description}\" (minimum is 2 characters).")
-        elsif description.length > 256
+          record.errors.add(:description, "is too short: \"#{record.short_description}\" " \
+                                          "(minimum is #{min_description_length(record)} characters).")
+        elsif description.length > max_description_length(record)
           # TODO: I18n.
-          record.errors.add(:description, "is too long: \"#{record.short_description}\" (maximum is 256 characters).")
+          record.errors.add(:description, "is too long: \"#{record.short_description}\" " \
+                                          "(maximum is #{max_description_length(record)} characters).")
         end
       end
+
+      def min_description_length(record)
+        record.class::MIN_DESCRIPTION_LENGTH
+      end
+
+      def max_description_length(record)
+        record.class::MAX_DESCRIPTION_LENGTH
+      end
     end
   end
 end

data/lib/dsu/validators/entries_validator.rb

@@ -6,6 +6,7 @@ require_relative '../support/field_errors'
 # https://guides.rubyonrails.org/active_record_validations.html#validates-with
 module Dsu
   module Validators
+    # TODO: I18n.
     class EntriesValidator < ActiveModel::Validator
       include Support::FieldErrors
 

data/lib/dsu/version.rb

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

data/lib/dsu/views/export.rb

@@ -14,6 +14,8 @@ module Dsu
       end
 
       def render
+        return presenter.display_nothing_to_export_message if presenter.nothing_to_export?
+
         response = presenter.display_export_prompt
         presenter.render response: response
       end

data/lib/dsu/views/import.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative '../models/color_theme'
+require_relative '../models/configuration'
+require_relative '../support/color_themable'
+
+module Dsu
+  module Views
+    class Import
+      include Support::ColorThemable
+
+      def initialize(presenter:)
+        @presenter = presenter
+      end
+
+      def render
+        return presenter.display_import_file_not_exist_message unless presenter.import_file_path_exist?
+        return presenter.display_nothing_to_import_message if presenter.nothing_to_import?
+
+        response = presenter.display_import_prompt
+        presenter.render response: response
+      end
+
+      private
+
+      attr_reader :presenter
+    end
+  end
+end

data/lib/locales/en/commands.yml

@@ -69,6 +69,10 @@ en:
       key_mappings: x
       desc: export|x SUBCOMMAND
       usage: Export DSU entries for the given SUBCOMMAND
+    import:
+      key_mappings: m
+      desc: import|m SUBCOMMAND
+      usage: Imports DSU entries for the given SUBCOMMAND
     info:
       key_mappings: i
       desc: info|i

data/lib/locales/en/subcommands.yml

@@ -280,6 +280,7 @@ en:
       messages:
         exported: Export successful.
         exported_to: Entry groups exported to %{file_path}.
+        nothing_to_export: No entry groups to export.
         cancelled: Cancelled.
       prompts:
         export_all_confirm: Export all the entries (%{count} entry groups)?
@@ -287,6 +288,98 @@ en:
         options:
           - y
           - N
+    import:
+      dates:
+        desc: dates|dd OPTIONS
+        usage: Imports the DSU entries given the OPTIONS provided
+        long_desc: |
+          Imports the DSU entries for the given OPTIONS provided.
+
+          $ dsu import dates OPTIONS
+
+          $ dsu m dd OPTIONS
+
+          OPTIONS:
+
+          -i|--import-file IMPORT_CVS_FILE: The IMPORT_CVS_FILE file to import. IMPORT_CVS_FILE should be a fully qualified path to a file that was previously created as a result of running `dsu export`. see `dsu help export`.
+
+          -m|--merge true|false (default: true): If true, imported entries will be added to the entry group if the entry group already exists. If false, the imported entries will replace all existing entries for the entry group if the entry group already exists. If the entry group does not exist, it will be created using the imported entries.
+
+          -f|--from DATE|MNEMONIC: The DATE or MNEMONIC that represents the start of the range of DSU dates to import. 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 import. 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 import the DSU entries for the range of dates from 1/1 to 1/4 for the current year, from the import file, and replace all the entries for the respective entry groups imported:
+
+          $ dsu import dates --from 1/1 --to +3 -i /path/to/import.csv -m false
+
+          This will import the DSU entries for the range of dates from 1/2 to 1/5 for the year 2022, from the import file, and merge all the entries for the respective entry groups imported:
+
+          $ dsu m dd --from 1/5/2022 --to -3 -i /path/to/import.csv
+
+          This (assuming "today" is 1/10) will import the DSU entries for the last week 1/10 to 1/3 of the current year, from the import file, and merge all the entries for the respective entry groups imported:
+
+          $ dsu import dates --from today --to -7 -i /path/to/import.csv -m true
+
+          This (assuming "today" is 5/23) will import 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 imports one week of DSU entries back 1 week from yesterday's date, from the import file, and merge all the entries for the respective entry groups imported:
+
+          $ dsu import dates --from -7 --to +6 -i /path/to/import.csv
+
+          The above can be accomplished MUCH easier by simply using the `yesterday` mnemonic...
+
+          This (assuming "today" is 5/23) will import the DSU entries back 1 week from yesterday's date 5/16 to 5/22, from the import file, and merge all the entries for the respective entry groups imported:
+
+          $ dsu m dd --from yesterday --to -6 -i /path/to/import.csv
+      all:
+        desc: all|a OPTIONS
+        usage: Imports all DSU entries from a given DSU export .csv file
+        long_desc: |
+          Imports all DSU entries from a given DSU export .csv file.
+
+          $ dsu import all OPTIONS
+
+          $ dsu m a OPTIONS
+
+          OPTIONS:
+
+          -i|--import-file IMPORT_CVS_FILE: The IMPORT_CVS_FILE file to import. IMPORT_CVS_FILE should be a fully qualified path to a file that was previously created as a result of running `dsu export`. see `dsu help export`.
+
+          -m|--merge true|false (default: true): If true, imported entries will be added to the entry group if the entry group already exists. If false, the imported entries will replace all existing entries for the entry group if the entry group already exists. If the entry group does not exist, it will be created using the imported entries.
+
+          EXAMPLES:
+
+          This will import all the DSU entries from the import file, and replace all the entries for the respective entry groups imported:
+
+          $ dsu import all -i /path/to/import.csv -m false
+
+          This will import all the DSU entries from the import file, and merge all the entries for the respective entry groups imported:
+
+          $ dsu import all -i /path/to/import.csv
+      messages:
+        import_success: Entry group for %{date} imported successfully.
+        import_error: "Entry group for %{date} imported with an error: %{error}."
+        nothing_to_import: No entry groups to import.
+        cancelled: Cancelled.
+        file_not_exist: Import file %{file_path} does not exist.
+      prompts:
+        import_all_confirm: Import all entry groups (%{count} entry groups)?
+        import_dates_confirm: Import all the entry groups for %{from} thru %{to} (%{count} entry groups)?
+        options:
+          - y
+          - N
     list:
       date:
         desc: date|d DATE|MNEMONIC

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dsu
 version: !ruby/object:Gem::Version
-  version: 2.3.1
+  version: 2.4.0
 platform: ruby
 authors:
 - Gene M. Angelo, Jr.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-12-26 00:00:00.000000000 Z
+date: 2024-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -188,7 +188,13 @@ files:
 - lib/dsu/presenters/export/all_presenter.rb
 - lib/dsu/presenters/export/dates_presenter.rb
 - lib/dsu/presenters/export/messages.rb
+- lib/dsu/presenters/export/nothing_to_export.rb
 - lib/dsu/presenters/export/service_callable.rb
+- lib/dsu/presenters/import/all_presenter.rb
+- lib/dsu/presenters/import/dates_presenter.rb
+- lib/dsu/presenters/import/import_file.rb
+- lib/dsu/presenters/import/messages.rb
+- lib/dsu/presenters/import/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
@@ -198,6 +204,7 @@ files:
 - 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/entry_group/importer_service.rb
 - lib/dsu/services/migration_version/hydrator_service.rb
 - lib/dsu/services/stderr_redirector_service.rb
 - lib/dsu/services/stdout_redirector_service.rb
@@ -209,6 +216,7 @@ files:
 - lib/dsu/subcommands/delete.rb
 - lib/dsu/subcommands/edit.rb
 - lib/dsu/subcommands/export.rb
+- lib/dsu/subcommands/import.rb
 - lib/dsu/subcommands/list.rb
 - lib/dsu/subcommands/theme.rb
 - lib/dsu/support/ask.rb
@@ -245,6 +253,7 @@ files:
 - 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/import.rb
 - lib/dsu/views/shared/error.rb
 - lib/dsu/views/shared/info.rb
 - lib/dsu/views/shared/message.rb
@@ -281,28 +290,25 @@ post_install_message: |
   View the dsu README.md here: https://github.com/gangelo/dsu
   View the dsu CHANGELOG.md: https://github.com/gangelo/dsu/blob/main/CHANGELOG.md
 
+  Dsu now has a import command! Try it out by running `dsu import help`.
   Dsu now has a export command! Try it out by running `dsu export help`.
   Dsu now has a browse command! Try it out by running `dsu browse help`.
-
-  Dsu now has a festive "christmas" theme! Try it out by running `dsu theme use christmas`.
   Dsu now has a "light" theme for light background terminals! Try it out by running `dsu theme use light`.
-
   Dsu now has a delete command! Try it out by running `dsu delete help`.
 
   Try a dsu theme by running `dsu theme list` and then `dsu theme use THEME_NAME` where THEME_NAME is the name of the theme you want to try.
 
   :)
 
-  Merry CHRISTmas, New Years and Happy holidays from dsu!
-       *
-      /*\
-     */*|\*
-    /*/|\*\
-   */**|\*\*
-  *//*|*\*\*\
-      |||
-      |||
-      |||
+  Happy New Year 2024 from dsu!
+
+   *        *        *
+   *     *  .     *  .     *
+  *  *      *   *      *   *
+   *     *     *     *     *
+      *        *        *
+
+  May your year be filled with sparks of joy and innovation!
 rdoc_options: []
 require_paths:
 - lib