dsu 2.4.3 → 3.0.0.alpha.0

data/lib/locales/en/subcommands.yml

@@ -41,7 +41,7 @@ en:
         long_desc: |
           Deletes the configuration file.
 
-          EXAMPLES:
+          EXAMPLES
 
           dsu config delete
 
@@ -54,7 +54,7 @@ en:
         long_desc: |
           Displays information about this gem configuration.
 
-          EXAMPLES:
+          EXAMPLES
 
           $ dsu config info
       init:
@@ -63,7 +63,7 @@ en:
         long_desc: |
           Creates and initializes a .dsu file in your home folder (%{home_folder}) that may be edited.
 
-          EXAMPLES:
+          EXAMPLES
 
           $ dsu config init
 
@@ -132,7 +132,7 @@ en:
 
           %{mnemonic_option_description}
 
-          EXAMPLES:
+          EXAMPLES
 
           NOTE: All examples can substitute their respective short form options (e.g. `-f`, `-t`, etc. for `--from`, `--to`, etc.).
 
@@ -238,7 +238,7 @@ en:
 
           %{mnemonic_option_description}
 
-          EXAMPLES:
+          EXAMPLES
 
           NOTE: All examples can substitute their respective short form options (e.g. `-f`, `-t`, etc. for `--from`, `--to`, etc.).
 
@@ -287,7 +287,7 @@ en:
         export_dates_confirm: Export all the entries for %{from} thru %{to} (%{count} entry groups)?
         options:
           - y
-          - N
+          - n
     import:
       dates:
         desc: dates|dd OPTIONS
@@ -301,6 +301,8 @@ en:
 
           OPTIONS:
 
+          -o|--override true|false (default: false): If true, the import process will ignore the project name found in the import file and import the entries into the current project. If false, the import process will use the project name found in the import file.
+
           -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.
@@ -313,7 +315,13 @@ en:
 
           %{mnemonic_option_description}
 
-          EXAMPLES:
+          NOTES
+
+          Entry groups in the import file whose project name does not match the current project, will be ignored (see `dsu project use`).
+
+          If the `--override` option is used, the import process will ignore the project name found in the import file and import the entries into the current project.
+
+          EXAMPLES
 
           NOTE: All examples can substitute their respective short form options (e.g. `-f`, `-t`, etc. for `--from`, `--to`, etc.).
 
@@ -343,6 +351,10 @@ en:
           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
+
+          This (assuming the current year is 2024) will import the DSU entries for 1/1/2024 to 3/15/2024 from the import file, and ignore the project name found in the import file and import the entries into the current project:
+
+          $ dsu m dd -f 1/1 -t 3/15 -o true -i /path/to/import.csv
       all:
         desc: all|a OPTIONS
         usage: Imports all DSU entries from a given DSU export .csv file
@@ -355,31 +367,45 @@ en:
 
           OPTIONS:
 
+          -o|--override true|false (default: false): If true, the import process will ignore the project name found in the import file and import the entries into the current project. If false, the import process will use the project name found in the import file.
+
           -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:
+          NOTES
+
+          Entry groups in the import file whose project name does not match the current project, will be ignored (see `dsu project use`).
+
+          If the `--override` option is used, the import process will ignore the project name found in the import file and import the entries into the current project.
+
+          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
+          $ dsu import all -m false -i /path/to/import.csv
 
           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
+
+          This will import all the DSU entries from the import file, and ignore the project name found in the import file and import the entries into the current project:
+
+          $ dsu import all -o true -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}."
+        import_error: "Entry group for %{date} imported with an error: %{error}"
+        import_error_raised: "The entry groups failed to import. The following error was raised: \"%{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)?
+        import_all_confirm: Import all entry groups (%{count} entry groups) for project "%{project}"?
+        project_override_confirm: You have chosen to override the project found in the import file, are you sure you want to continue?
+        import_dates_confirm: Import all the entry groups for %{from} thru %{to} (%{count} entry groups) for project "%{project}"?
         options:
-          - y
-          - N
+          - Y
+          - n
     list:
       date:
         desc: date|d DATE|MNEMONIC
@@ -412,7 +438,7 @@ en:
 
           %{mnemonic_option_description}
 
-          EXAMPLES:
+          EXAMPLES
 
           NOTE: All example results are subject to the `--include-all|-a` option.
 
@@ -472,6 +498,212 @@ en:
           $ dsu list yesterday
 
           $ dsu list y
+    project:
+      create:
+        desc: create|c PROJECT_NAME [PROJECT_DESCRIPTION]
+        usage: Creates a dsu project using the given PROJECT_NAME and optional PROJECT_DESCRIPTION
+        long_desc: |
+          Creates a dsu project using the given PROJECT_NAME and optional PROJECT_DESCRIPTION.
+
+          dsu project create PROJECT_NAME [PROJECT_DESCRIPTION]
+
+          dsu p c PROJECT_NAME [PROJECT_DESCRIPTION]
+
+          PROJECT_NAME
+
+          The name of the project to create. PROJECT_NAME must be between 2 and 24 characters (inclusive) in length.
+
+          PROJECT_DESCRIPTION
+
+          Optional. The description of the project. PROJECT_DESCRIPTION must be between 2 and 32 characters (inclusive) in length. If PROJECT_DESCRIPTION is not provided, the project description will be "<PROJECT_NAME> project" where <PROJECT_NAME> = the name of the project.
+
+          EXAMPLES
+
+          $ dsu project create "My project" "My project description"
+
+          $ dsu p c "My project" "My project description"
+
+          The below example will create a project called "Alpa" with the description "Alpa project".
+
+          $ dsu p c "Alpha"
+        messages:
+          created: Created project "%{project_name}".
+        prompts:
+          create_confirm: Create project "%{project_name}"?
+          create_options:
+            - Y
+            - n
+          use_confirm: Use project "%{project_name}"?
+          use_options:
+            - Y
+            - n
+      delete:
+        desc: delete|d [PROJECT_NAME|PROJECT_NUMBER]
+        usage: Permanently deletes the DSU project indicated by the optional PROJECT_NAME or PROJECT_NUMBER
+        long_desc: |
+          Permanently deletes the DSU project indicated by given option PROJECT_NAME or PROJECT_NUMBER.
+
+          dsu project delete [PROJECT_NAME|PROJECT_NUMBER]
+
+          dsu p d [PROJECT_NAME|PROJECT_NUMBER]
+
+          PROJECT_NAME
+
+          The name of the project to delete.
+
+          PROJECT_NUMBER
+
+          The number of the project to delete. If PROJECT_NUMBER is used, the project equating to the nth project in the list of projects will be used (see `dsu project list`).
+
+          NOTES
+
+          PROJECT_NAME and PROJECT_NUMBER are optional. If neither are provided, the current, default project will be used.
+
+          EXAMPLES
+
+          $ dsu project delete "My project"
+
+          $ dsu p d "My project"
+
+          The below examples delete the project equating to the nth project in the list of projects (see `dsu project list`).
+
+          $ dsu project delete 2
+
+          $ dsu p d 2
+
+          The below examples delete the current, default project.
+
+          $ dsu project delete
+
+          $ dsu p d
+        messages:
+          deleted: Deleted project "%{project_name}".
+        prompts:
+          delete_confirm: Delete project "%{project_name} - %{description}"?
+          delete_options:
+            - Y
+            - n
+      list:
+        desc: list|l
+        usage: Lists all the DSU projects
+        long_desc: |
+          Lists all the DSU projects.
+
+          dsu project list
+
+          dsu p l
+
+          EXAMPLES
+
+          $ dsu project list
+
+          $ dsu p l
+      rename:
+        desc: rename|r PROJECT_NAME|PROJECT_NUMBER NEW_PROJECT_NAME [NEW_PROJECT_DESCRIPTION]
+        usage: Renames a dsu project using the given PROJECT_NAME or PROJECT_NUMBER, NEW_PROJECT_NAME and optional NEW_PROJECT_DESCRIPTION
+        long_desc: |
+          Renames a dsu project using the given PROJECT_NAME or PROJECT_NUMBER, NEW_PROJECT_NAME and optional NEW_PROJECT_DESCRIPTION
+
+          dsu project rename PROJECT_NAME|PROJECT_NUMBER NEW_PROJECT_NAME [NEW_PROJECT_DESCRIPTION]
+
+          dsu p r PROJECT_NAME|PROJECT_NUMBER NEW_PROJECT_NAME [NEW_PROJECT_DESCRIPTION]
+
+          PROJECT_NAME
+
+          The name of the project to create. PROJECT_NAME must be between 2 and 24 characters (inclusive) in length.
+
+          PROJECT_NUMBER
+
+          The number of the project to rename. If PROJECT_NUMBER is used, the project equating to the nth project in the list of projects will be used (see `dsu project list`).
+
+          NEW_PROJECT_NAME
+
+          The new name of the project. NEW_PROJECT_NAME must be between 2 and 24 characters (inclusive) in length.
+
+          NEW_PROJECT_DESCRIPTION
+
+          Optional. The description of the project. NEW_PROJECT_DESCRIPTION must be between 2 and 32 characters (inclusive) in length. If NEW_PROJECT_DESCRIPTION is not provided, the project description will be "<NEW_PROJECT_NAME> project" where <NEW_PROJECT_NAME> = the name of the project.
+
+          EXAMPLES
+
+          $ dsu project rename "My Project" "My New Project" "My new project description"
+
+          $ dsu p r "My Project" "My New Project" "My new project description"
+
+          $ dsu project rename 1 "My New Project" "My new project description"
+
+          $ dsu p r 1 "My New Project" "My new project description"
+
+          The below example will rename the project called "Alpa" with the "Beta" and add the description "Beta project".
+
+          $ dsu p r Alpha Beta
+        messages:
+          # created: Created project "%{project_name}".
+          new_project_already_exists: A project for new project name "%{new_project_name}" already exists.
+          # project_name_blank: No value provided for project name.
+          renamed_project: Renamed project "%{project_name}" to "%{new_project_name}".
+        prompts:
+          rename_confirm: Rename project "%{project_name}" to "%{new_project_name} - %{new_project_description}"?.
+          rename_options:
+            - Y
+            - n
+      use:
+        desc: use|u [PROJECT_NAME|PROJECT_NUMBER]
+        usage: Selects the DSU project to use, based on the given PROJECT_NAME or PROJECT_NUMBER
+        long_desc: |
+          Selects the DSU project to use, based on the given PROJECT_NAME or PROJECT_NUMBER.
+
+          dsu project use [PROJECT_NAME|PROJECT_NUMBER]
+
+          dsu p u [PROJECT_NAME|PROJECT_NUMBER]
+
+          PROJECT_NAME
+
+          The name of the project to use.
+
+          PROJECT_NUMBER
+
+          The number of the project to use. If PROJECT_NUMBER is used, the project equating to the nth project in the list of projects will be used (see `dsu project list`).
+
+          NOTES
+
+          PROJECT_NAME|PROJECT_NUMBER are optional. The project name or project number of the project to use. If PRONECT_NAME is not provided, the default project will be used. If PROJECT_NUMBER is used, the project equating to the nth project in the list of projects will be used (see `dsu project list`).
+
+          EXAMPLES
+
+          These will use the default project.
+
+          $ dsu project use
+
+          $ dsu p u
+
+          These will use the project named "My project".
+
+          $ dsu project use "My project"
+
+          $ dsu p u "My project"
+
+          These will use the 2nd project in the list of projects.
+
+          $ dsu project use 2
+
+          $ dsu p u 2
+        messages:
+          using_project: Now using project "%{project_name}".
+        prompts:
+          use_confirm: "Use project \"%{project_name} - %{description}\"?"
+          use_options:
+            - Y
+            - n
+      messages:
+        cancelled: Cancelled.
+        does_not_exist: Project "%{project_name}" does not exist.
+        no_projects: No projects are available to list.
+        number_does_not_exist: A project for number %{project_number} does not exist.
+        already_exists: Project "%{project_name}" already exists.
+        project_name_blank: No value provided for project name.
+        new_project_name_blank: No value provided for new project name.
+        already_current_project: Project "%{project_name}" is already the current project.
     theme:
       create:
         desc: create THEME_NAME [OPTIONS]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dsu
 version: !ruby/object:Gem::Version
-  version: 2.4.3
+  version: 3.0.0.alpha.0
 platform: ruby
 authors:
 - Gene M. Angelo, Jr.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-01-10 00:00:00.000000000 Z
+date: 2024-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -159,6 +159,7 @@ files:
 - bin/console
 - bin/dsu
 - bin/setup
+- current_project.bak
 - exe/dsu
 - lib/core/ruby/color_theme_colors.rb
 - lib/core/ruby/color_theme_mode.rb
@@ -176,6 +177,7 @@ files:
 - lib/dsu/models/entry.rb
 - lib/dsu/models/entry_group.rb
 - lib/dsu/models/migration_version.rb
+- lib/dsu/models/project.rb
 - lib/dsu/presenters/base_presenter.rb
 - lib/dsu/presenters/base_presenter_ex.rb
 - lib/dsu/presenters/color_theme_presenter.rb
@@ -189,14 +191,18 @@ files:
 - 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/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_entry.rb
 - lib/dsu/presenters/import/import_file.rb
-- lib/dsu/presenters/import/messages.rb
-- lib/dsu/presenters/import/service_callable.rb
+- lib/dsu/presenters/project/create_presenter.rb
+- lib/dsu/presenters/project/delete_by_number_presenter.rb
+- lib/dsu/presenters/project/delete_presenter.rb
+- lib/dsu/presenters/project/list_presenter.rb
+- lib/dsu/presenters/project/rename_by_number_presenter.rb
+- lib/dsu/presenters/project/rename_presenter.rb
+- lib/dsu/presenters/project/use_by_number_presenter.rb
+- lib/dsu/presenters/project/use_presenter.rb
 - lib/dsu/services/color_theme/hydrator_service.rb
 - lib/dsu/services/configuration/hydrator_service.rb
 - lib/dsu/services/entry/hydrator_service.rb
@@ -208,6 +214,8 @@ files:
 - 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/project/hydrator_service.rb
+- lib/dsu/services/project/rename_service.rb
 - lib/dsu/services/stderr_redirector_service.rb
 - lib/dsu/services/stdout_redirector_service.rb
 - lib/dsu/services/temp_file/reader_service.rb
@@ -220,6 +228,7 @@ files:
 - lib/dsu/subcommands/export.rb
 - lib/dsu/subcommands/import.rb
 - lib/dsu/subcommands/list.rb
+- lib/dsu/subcommands/project.rb
 - lib/dsu/subcommands/theme.rb
 - lib/dsu/support/ask.rb
 - lib/dsu/support/color_themable.rb
@@ -234,16 +243,21 @@ files:
 - lib/dsu/support/field_errors.rb
 - lib/dsu/support/fileable.rb
 - lib/dsu/support/presentable.rb
+- lib/dsu/support/project_file_system.rb
+- lib/dsu/support/short_string.rb
 - lib/dsu/support/time_comparable.rb
 - lib/dsu/support/time_formatable.rb
 - lib/dsu/support/times_sortable.rb
+- lib/dsu/support/transform_project_name.rb
 - lib/dsu/support/utils.rb
 - lib/dsu/validators/color_theme_validator.rb
 - lib/dsu/validators/description_validator.rb
 - lib/dsu/validators/entries_validator.rb
+- lib/dsu/validators/project_name_validator.rb
 - lib/dsu/validators/time_validator.rb
 - lib/dsu/validators/version_validator.rb
 - lib/dsu/version.rb
+- lib/dsu/views/base_list_view.rb
 - lib/dsu/views/color_theme/index.rb
 - lib/dsu/views/color_theme/show.rb
 - lib/dsu/views/configuration/show.rb
@@ -256,6 +270,15 @@ files:
 - lib/dsu/views/entry_group/show.rb
 - lib/dsu/views/export.rb
 - lib/dsu/views/import.rb
+- lib/dsu/views/import_dates.rb
+- lib/dsu/views/project/create.rb
+- lib/dsu/views/project/delete.rb
+- lib/dsu/views/project/delete_by_number.rb
+- lib/dsu/views/project/list.rb
+- lib/dsu/views/project/rename.rb
+- lib/dsu/views/project/rename_by_number.rb
+- lib/dsu/views/project/use.rb
+- lib/dsu/views/project/use_by_number.rb
 - lib/dsu/views/shared/error.rb
 - lib/dsu/views/shared/info.rb
 - lib/dsu/views/shared/message.rb
@@ -275,12 +298,14 @@ files:
 - lib/seed_data/themes/light.json
 - lib/seed_data/themes/matrix.json
 - lib/seed_data/themes/whiteout.json
+- project.bak
 - sig/dsu.rbs
 homepage: https://github.com/gangelo/dsu
 licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/gangelo/dsu
+  documentation_uri: https://github.com/gangelo/dsu/wiki
   source_code_uri: https://github.com/gangelo/dsu
   changelog_uri: https://github.com/gangelo/dsu/blob/main/CHANGELOG.md
   rubygems_mfa_required: 'true'
@@ -327,9 +352,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '4.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.2.15
 signing_key:

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

@@ -1,32 +0,0 @@
-# frozen_string_literal: true
-
-module Dsu
-  module Presenters
-    module Export
-      module Messages
-        def display_export_prompt
-          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
-          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/nothing_to_export.rb

@@ -1,13 +0,0 @@
-# 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/export/service_callable.rb

@@ -1,20 +0,0 @@
-# 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/presenters/import/messages.rb

@@ -1,42 +0,0 @@
-# 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

@@ -1,21 +0,0 @@
-# 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