dsu 2.4.4 → 3.0.0.alpha.0

data/lib/dsu/views/project/use.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+require_relative '../../env'
+require_relative '../../models/color_theme'
+require_relative '../../support/ask'
+require_relative '../../support/color_themable'
+
+module Dsu
+  module Views
+    module Project
+      class Use
+        include Support::Ask
+        include Support::ColorThemable
+
+        attr_reader :presenter
+
+        def initialize(presenter:, options: {})
+          @presenter = presenter
+          @options = options&.dup || {}
+          @color_theme = Models::ColorTheme.find(theme_name: theme_name)
+        end
+
+        def render
+          return display_project_does_not_exist if presenter.project_does_not_exist?
+          return display_project_already_current_project if presenter.already_current_project?
+          return display_project_errors if presenter.project_errors.any?
+
+          response = display_project_use_prompt
+          if presenter.respond response: response
+            display_using_project_message
+          else
+            display_use_project_cancelled_message
+          end
+        rescue StandardError => e
+          puts apply_theme(e.message, theme_color: color_theme.error)
+          puts apply_theme(e.backtrace_locations.join("\n"), theme_color: color_theme.error) if Dsu.env.local?
+        end
+
+        private
+
+        attr_reader :color_theme, :options
+
+        def display_project_use_prompt
+          response = ask_while(prompt_with_options(prompt: use_prompt,
+            options: use_prompt_options), options: options) do |input|
+            message = I18n.t('information.input.try_again', options: use_prompt_options.join(','))
+            puts apply_theme(message, theme_color: color_theme.info) unless use_prompt_options.include?(input)
+            use_prompt_options.include?(input)
+          end
+          response == use_prompt_options.first
+        end
+
+        def display_use_project_cancelled_message
+          message = I18n.t('subcommands.project.messages.cancelled')
+          puts apply_theme(message, theme_color: color_theme.info)
+        end
+
+        def display_project_errors
+          errors = presenter.project_errors.join("\n")
+          puts apply_theme(errors, theme_color: color_theme.error)
+        end
+
+        def display_project_does_not_exist
+          message = I18n.t('subcommands.project.messages.does_not_exist',
+            project_name: presenter.project_name)
+          puts apply_theme(message, theme_color: color_theme.error)
+        end
+
+        def display_using_project_message
+          message = I18n.t('subcommands.project.use.messages.using_project',
+            project_name: presenter.project_name)
+          puts apply_theme(message, theme_color: color_theme.success)
+        end
+
+        def display_project_already_current_project
+          message = I18n.t('subcommands.project.messages.already_current_project',
+            project_name: presenter.project_name)
+          puts apply_theme(message, theme_color: color_theme.success)
+        end
+
+        def use_prompt
+          I18n.t('subcommands.project.use.prompts.use_confirm',
+            project_name: presenter.project_name,
+            description: presenter.project_description)
+        end
+
+        def use_prompt_options
+          I18n.t('subcommands.project.use.prompts.use_options')
+        end
+
+        def theme_name
+          @theme_name ||= options.fetch(:theme_name, Models::Configuration.new.theme_name)
+        end
+      end
+    end
+  end
+end

data/lib/dsu/views/project/use_by_number.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require_relative 'use'
+
+module Dsu
+  module Views
+    module Project
+      class UseByNumber < Use
+        private
+
+        def display_project_does_not_exist
+          message = I18n.t('subcommands.project.messages.number_does_not_exist',
+            project_number: presenter.project_number)
+          puts apply_theme(message, theme_color: color_theme.error)
+        end
+      end
+    end
+  end
+end

data/lib/dsu.rb

@@ -33,14 +33,6 @@ unless Dsu.env.test? || Dsu.env.development?
       exit 1
     end
   end
-  # TODO: Hack. Integrate this into the migration service
-  # so that this runs only if the migration version changes.
-  %w[light.json christmas.json].each do |theme_file|
-    destination_theme_file_path = File.join(Dsu::Support::Fileable.themes_folder, theme_file)
-    next if File.exist?(destination_theme_file_path)
-
-    source_theme_file_path = File.join(Dsu::Support::Fileable.seed_data_folder, 'themes', theme_file)
-    FileUtils.cp(source_theme_file_path, destination_theme_file_path)
-    puts I18n.t('migrations.information.theme_copied', from: source_theme_file_path, to: destination_theme_file_path)
-  end
+
+  Migration::Factory.migrate_if!
 end

data/lib/locales/en/active_record.yml

@@ -1,4 +1,13 @@
 en:
+  models:
+    project:
+      errors:
+        already_exists: "Project '%{project_name}' already exists."
+        delete_default_project: "Project '%{project_name}' is the default project. Change to a different default project before deleting this project."
+        delete_only_project: "Project '%{project_name}' is the only project and cannot be deleted."
+        does_not_exist: "Project '%{project_name}' does not exist."
+        new_project_already_exists: "Project cannot be renamed to '%{project_name}' because the project already exists."
+        project_file_not_exist: "Project file '%{project_file}' does not exist."
   activerecord:
     errors:
       models:

data/lib/locales/en/commands.yml

@@ -30,16 +30,18 @@ en:
       long_desc: |
         Will add a DSU entry having DESCRIPTION to the date associated with the given OPTION.
 
-        $ dsu add [-d DATE|-n|-t|-y] DESCRIPTION
+        $ dsu add [-d DATE|MNEMONIC|-n|-t|-y] DESCRIPTION
 
-        $ dsu a [-d DATE|-n|-t|-y] DESCRIPTION
+        $ dsu a [-d DATE|MNEMONIC|-n|-t|-y] DESCRIPTION
 
         OPTIONS:
 
-        -d DATE: Adds a DSU entry having DESCRIPTION to the DATE.
+        -d DATE|MNEMONIC: Adds a DSU entry having DESCRIPTION to the DATE or date referenced by the MNEMONIC.
 
         %{date_option_description}
 
+        %{mnemonic_option_description}
+
         -n: Adds a DSU entry having DESCRIPTION to today's date (`Time.now`).
 
         -t: Adds a DSU entry having DESCRIPTION to tomorrow's date (`Time.new.tomorrow`).
@@ -98,6 +100,10 @@ en:
       key_mappings: l
       desc: list|l SUBCOMMAND
       usage: Displays DSU entries for the given SUBCOMMAND
+    project:
+      key_mappings: p
+      desc: project|p SUBCOMMAND
+      usage: Manage DSU projects for the given SUBCOMMAND
     theme:
       key_mappings: t
       desc: theme|t SUBCOMMAND

data/lib/locales/en/miscellaneous.yml

@@ -2,10 +2,12 @@ en:
   configuration:
     errors:
       theme_file_missing: Theme file "%{theme_path}" does not exist.
+      project_path_missing: Default project "%{project_folder}" does not exist.
   errors:
     error: "Error: %{message}"
     from_option_invalid: Option -f, [--from=DATE|MNEMONIC] value is invalid ["%{from_option}"]
     to_option_invalid: Option -t, [--to=DATE|MNEMONIC] value is invalid ["%{to_option}"]
+    project_name_invalid: Project name "%{project_name}" is invalid.
   headers:
     entry:
       could_not_be_added: "An error was encountered; the entry could not be added:"
@@ -19,6 +21,8 @@ en:
   information:
     dates:
       through: "%{from} thru %{to}"
+    input:
+      try_again: "Please try again. Valid options are [%{options}]."
   migrations:
     error:
       failed: "Error running migrations: %{message}"

data/lib/locales/en/services.yml

@@ -8,3 +8,7 @@ en:
           Run `dsu help config` for more information.
       messages:
         editing: "Editing entry group %{formatted_time}..."
+    entry_group:
+      importer_service:
+        errors:
+          project_mismatch: The current project "%{current_project_name}" does not match the project "%{import_project_name}" being imported.

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]