dsu 2.4.3 → 3.0.0.alpha.0

data/lib/dsu/presenters/project/use_by_number_presenter.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require_relative '../../models/project'
+require_relative '../base_presenter_ex'
+
+module Dsu
+  module Presenters
+    module Project
+      class UseByNumberPresenter < BasePresenterEx
+        attr_reader :project_number
+
+        delegate :project_name, to: :project, allow_nil: true
+        delegate :description, to: :project, prefix: true, allow_nil: true
+
+        def initialize(project_number:, options: {})
+          super(options: options)
+
+          raise ArgumentError, 'project_number is blank' if project_number.blank?
+
+          self.project_number = project_number
+        end
+
+        def respond(response:)
+          return false unless response
+
+          project.use! if project&.present?
+        end
+
+        def already_current_project?
+          project&.current_project?
+        end
+
+        def project_does_not_exist?
+          !project&.exist?
+        end
+
+        def project_errors
+          return false unless project&.persisted?
+
+          project.errors.full_messages
+        end
+
+        private
+
+        attr_writer :project_number
+
+        def project
+          @project ||= Models::Project.find_by_number(project_number: project_number)
+        end
+      end
+    end
+  end
+end

data/lib/dsu/presenters/project/use_presenter.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require_relative '../../models/project'
+require_relative '../base_presenter_ex'
+
+module Dsu
+  module Presenters
+    module Project
+      class UsePresenter < BasePresenterEx
+        attr_reader :project_name
+
+        delegate :description, to: :project, prefix: true, allow_nil: true
+
+        def initialize(project_name:, options: {})
+          super(options: options)
+
+          raise ArgumentError, 'project_name is blank' if project_name.blank?
+
+          self.project_name = project_name
+        end
+
+        def respond(response:)
+          return false unless response
+
+          project.use! if project&.present?
+        end
+
+        def already_current_project?
+          project&.current_project?
+        end
+
+        def project_does_not_exist?
+          !project.exist?
+        end
+
+        def project_errors
+          return false unless project.persisted?
+
+          project.errors.full_messages
+        end
+
+        private
+
+        attr_writer :project_name
+
+        def project
+          @project ||= Models::Project.find_or_initialize(project_name: project_name)
+        end
+      end
+    end
+  end
+end

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

@@ -3,26 +3,34 @@
 require 'csv'
 require_relative '../../models/entry_group'
 require_relative '../../support/fileable'
+require_relative '../../support/transform_project_name'
 
 module Dsu
   module Services
     module EntryGroup
+      # ExporterService exports entry groups to a CSV file.
+      # NOTE: This class exports all entries passed to it. It does not filter
+      # entries based on optional options[:time] that may be passed to it.
+      # Rather, times are used to determine the export file name only.
       class ExporterService
         include Support::Fileable
+        include Support::TransformProjectName
 
-        def initialize(entry_groups:, options: {})
+        def initialize(project_name:, entry_groups:, options: {})
+          raise ArgumentError, 'Argument project_name is blank' if project_name.blank?
           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
 
+          @project_name = project_name
           @entry_groups = entry_groups
           @options = options
         end
 
         def call
           CSV.open(export_file_path, 'w') do |csv|
-            csv << %i[version entry_group entry_no total_entries entry_group_entry]
+            csv << %i[project_name version entry_group entry_no total_entries entry_group_entry]
 
             entry_groups.each do |entry_group|
               export_entry_group(entry_group: entry_group, csv: csv)
@@ -38,10 +46,11 @@ module Dsu
 
         private
 
-        attr_reader :entry_groups, :options
+        attr_reader :project_name, :entry_groups, :options
 
         def export_entry_data(entry_group:, entry:, entry_index:)
           [
+            project_name,
             entry_group.version,
             entry_group.time.to_date,
             entry_index + 1,
@@ -57,11 +66,19 @@ module Dsu
         end
 
         def export_file_name
-          "dsu-#{timestamp}-#{times.min.to_date}-thru-#{times.max.to_date}.csv"
+          transformed_file_name = transform_project_name project_name, options: options
+          "dsu-export-#{transformed_file_name}-" \
+            "#{timestamp}-#{export_scope}-#{times.min.to_date}-thru-#{times.max.to_date}.csv"
+        end
+
+        def export_scope
+          return 'all-entry-groups' unless options.fetch(:times, nil)
+
+          'entry-groups'
         end
 
         def times
-          @times ||= entry_groups.map(&:time)
+          @times ||= options.fetch(:times, entry_groups.map(&:time))
         end
 
         def timestamp

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

@@ -2,23 +2,34 @@
 
 require 'csv'
 require_relative '../../models/entry_group'
+require_relative '../../models/project'
 
 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", ...]
+      # "Project 1 Name" => {
+      #     "2023-12-29" => ["Entry 1 description", "Entry 2 description", ...],
+      #     "2023-12-30" => ["Entry 1 description", ...],
+      #     "2023-12-31" => ["Entry 1 description", ...]
+      #   },
+      # "Project 2 Name" => {
+      #     "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?
+        def initialize(import_projects:, options: {})
+          raise ArgumentError, 'Argument import_projects is blank' if import_projects.blank?
+          raise ArgumentError, 'Argument import_projects is not a Hash' unless import_projects.is_a?(Hash)
 
-          @import_entry_groups = import_entry_groups
+          raise_if_more_than_one_project(import_projects)
+
+          @import_projects = import_projects
           @options = options
         end
 
@@ -28,10 +39,10 @@ module Dsu
 
         private
 
-        attr_reader :import_entry_groups, :options
+        attr_reader :import_projects, :options
 
         def import!
-          import_entry_groups.each_pair do |entry_group_date, entry_descriptions|
+          project_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)
@@ -67,6 +78,14 @@ module Dsu
           entry_group.entries << entry
         end
 
+        def project_entry_groups
+          @project_entry_groups ||= if override_project?
+            import_projects.values.first || {}
+          else
+            import_projects.fetch(current_project_name, {})
+          end
+        end
+
         def merge?
           options.fetch(:merge, true)
         end
@@ -75,9 +94,23 @@ module Dsu
           !merge?
         end
 
+        def override_project?
+          options.fetch(:override, false)
+        end
+
         def import_messages
           @import_messages ||= {}
         end
+
+        def current_project_name
+          @current_project_name ||= Models::Project.current_project.project_name
+        end
+
+        def raise_if_more_than_one_project(import_projects)
+          return if import_projects.keys.one?
+
+          raise ArgumentError, 'Only one project can be imported at a time'
+        end
       end
     end
   end

data/lib/dsu/services/project/hydrator_service.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require_relative '../../models/color_theme'
+
+module Dsu
+  module Services
+    module Project
+      class HydratorService
+        def initialize(project_hash:, options: {})
+          raise ArgumentError, 'project_hash is nil' if project_hash.nil?
+
+          unless project_hash.is_a?(Hash)
+            raise ArgumentError,
+              "project_hash is the wrong object type: \"#{project_hash}\""
+          end
+          raise ArgumentError, 'options is nil' if options.nil?
+          raise ArgumentError, "options is the wrong object type:\"#{options}\"" unless options.is_a?(Hash)
+
+          @project_hash = project_hash
+          @options = options || {}
+        end
+
+        def call
+          Models::Project.new(**hydrate)
+        end
+
+        private
+
+        attr_reader :project_hash, :options
+
+        # Not much going on here at all, but it's here for consistency.
+        # Perform any pre-processing of the project_hash here (e.g. symbolize keys,
+        # convert values to the correct type, etc.).
+        def hydrate
+          project_hash
+        end
+      end
+    end
+  end
+end

data/lib/dsu/services/project/rename_service.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+require_relative '../../models/project'
+require_relative '../../support/fileable'
+
+module Dsu
+  module Services
+    module Project
+      class RenameService
+        def initialize(from_project_name:, to_project_name:, to_project_description:, options: {})
+          @from_project_name = from_project_name
+          @to_project_name = to_project_name
+          @to_project_description = to_project_description
+          @options = options
+        end
+
+        def call
+          validate!
+
+          # NOTE: The default and current states need to be captured before
+          # the project is renamed.
+          rename!(
+            make_default: Models::Project.default_project?(project_name: from_project_name),
+            make_current: Models::Project.current_project?(project_name: from_project_name)
+          )
+        end
+
+        private
+
+        attr_reader :from_project_name, :to_project_name, :to_project_description, :options
+
+        def rename!(make_default:, make_current:)
+          move_project
+
+          Models::Project.update(project_name: to_project_name,
+            description: to_project_description, options: options).tap do |project|
+            project.default! if make_default
+            project.use! if make_current
+          end
+        end
+
+        def move_project
+          FileUtils.mv(Support::Fileable.project_folder_for(project_name: from_project_name), temp_project_folder)
+          FileUtils.mv(temp_project_folder, Support::Fileable.project_folder_for(project_name: to_project_name))
+        end
+
+        def temp_project_folder
+          @temp_project_folder ||= Support::Fileable.project_folder_for(project_name: SecureRandom.uuid)
+        end
+
+        def validate!
+          validate_from_project_name!
+          validate_to_project_name!
+        end
+
+        def validate_from_project_name!
+          unless Models::Project.project_file_exist?(project_name: from_project_name)
+            raise I18n.t('models.project.errors.does_not_exist', project_name: from_project_name)
+          end
+        end
+
+        def validate_to_project_name!
+          if Models::Project.project_file_exist?(project_name: to_project_name)
+            raise I18n.t('models.project.errors.new_project_already_exists', project_name: to_project_name)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dsu/subcommands/export.rb

@@ -23,7 +23,8 @@ module Dsu
       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
+        options = configuration.to_h.merge(self.options).with_indifferent_access
+        Views::Export.new(presenter: all_presenter(options: options), options: options).render
       end
 
       desc I18n.t('subcommands.export.dates.desc'), I18n.t('subcommands.export.dates.usage')
@@ -41,7 +42,8 @@ module Dsu
           return
         end
 
-        Views::Export.new(presenter: dates_presenter_for(from: times.min, to: times.max, options: options)).render
+        Views::Export.new(presenter:
+          dates_presenter_for(from: times.min, to: times.max, options: options), options: options).render
       rescue ArgumentError => e
         Views::Shared::Error.new(messages: e.message).render
       end

data/lib/dsu/subcommands/import.rb

@@ -6,6 +6,7 @@ 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/import_dates'
 require_relative '../views/shared/error'
 require_relative 'base_subcommand'
 
@@ -23,10 +24,12 @@ module Dsu
       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 :override, type: :boolean, default: false, aliases: '-o'
       option :prompts, type: :hash, default: {}, hide: true, aliases: '-p'
       def all
+        options = configuration.to_h.merge(self.options).with_indifferent_access
         Views::Import.new(presenter: all_presenter(import_file_path: options[:import_file],
-          options: options)).render
+          options: options), options: options).render
       end
 
       desc I18n.t('subcommands.import.dates.desc'), I18n.t('subcommands.import.dates.usage')
@@ -37,6 +40,7 @@ module Dsu
       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 :override, type: :boolean, default: false, aliases: '-o'
       option :prompts, type: :hash, default: {}, hide: true, aliases: '-p'
       def dates
         options = configuration.to_h.merge(self.options).with_indifferent_access
@@ -46,10 +50,10 @@ module Dsu
           return
         end
 
-        Views::Import.new(presenter: dates_presenter_for(from: times.min,
+        Views::ImportDates.new(presenter: dates_presenter_for(from: times.min,
           to: times.max,
           import_file_path: options[:import_file],
-          options: options)).render
+          options: options), options: options).render
       rescue ArgumentError => e
         Views::Shared::Error.new(messages: e.message).render
       end

data/lib/dsu/subcommands/project.rb

@@ -0,0 +1,149 @@
+# frozen_string_literal: true
+
+require_relative '../presenters/project/create_presenter'
+require_relative '../presenters/project/delete_presenter'
+require_relative '../presenters/project/list_presenter'
+require_relative '../presenters/project/use_by_number_presenter'
+require_relative '../presenters/project/use_presenter'
+require_relative '../views/project/create'
+require_relative '../views/project/use'
+require_relative '../views/project/use_by_number'
+require_relative '../views/shared/error'
+require_relative 'base_subcommand'
+
+module Dsu
+  module Subcommands
+    class Project < BaseSubcommand
+      # TODO: I18n.
+      map %w[c] => :create
+      map %w[d] => :delete
+      map %w[l] => :list
+      map %w[r] => :rename
+      map %w[u] => :use
+
+      desc I18n.t('subcommands.project.create.desc'), I18n.t('subcommands.project.create.usage')
+      long_desc I18n.t('subcommands.project.create.long_desc')
+      option :prompts, type: :hash, default: {}, hide: true, aliases: '-p'
+      def create(project_name = nil, description = nil)
+        project_name = project_name.to_s.strip
+        description = description.to_s.strip
+        if project_name.blank?
+          return Views::Shared::Error.new(
+            messages: I18n.t('subcommands.project.messages.project_name_blank')
+          ).render
+        end
+
+        options = configuration.to_h.merge(self.options).with_indifferent_access
+        presenter = Presenters::Project::CreatePresenter.new(project_name: project_name,
+          description: description, options: options)
+        Views::Project::Create.new(presenter: presenter, options: options).render
+      end
+
+      desc I18n.t('subcommands.project.delete.desc'), I18n.t('subcommands.project.delete.usage')
+      long_desc I18n.t('subcommands.project.delete.long_desc')
+      option :prompts, type: :hash, default: {}, hide: true, aliases: '-p'
+      def delete(project_name_or_number = nil)
+        options = configuration.to_h.merge(self.options).with_indifferent_access
+        presenter = delete_presenter_for(project_name_or_number, options: options)
+        delete_view_for(project_name_or_number, presenter: presenter, options: options).render
+      end
+
+      desc I18n.t('subcommands.project.list.desc'), I18n.t('subcommands.project.list.usage')
+      long_desc I18n.t('subcommands.project.list.long_desc')
+      option :prompts, type: :hash, default: {}, hide: true, aliases: '-p'
+      def list
+        options = configuration.to_h.merge(self.options).with_indifferent_access
+        presenter = Presenters::Project::ListPresenter.new(options: options)
+        Views::Project::List.new(presenter: presenter, options: options).render
+      end
+
+      desc I18n.t('subcommands.project.rename.desc'), I18n.t('subcommands.project.rename.usage')
+      long_desc I18n.t('subcommands.project.rename.long_desc')
+      option :prompts, type: :hash, default: {}, hide: true, aliases: '-p'
+      def rename(project_name_or_number = nil, new_project_name = nil, new_project_description = nil)
+        project_name_or_number = project_name_or_number.to_s.strip
+        new_project_name = new_project_name&.to_s&.strip
+        new_project_description = new_project_description&.to_s&.strip
+
+        if new_project_name.blank?
+          return Views::Shared::Error.new(
+            messages: I18n.t('subcommands.project.messages.new_project_name_blank')
+          ).render
+        end
+
+        options = configuration.to_h.merge(self.options).with_indifferent_access
+        presenter = rename_presenter_for(project_name_or_number, new_project_name: new_project_name,
+          new_project_description: new_project_description, options: options)
+        rename_view_for(project_name_or_number, presenter: presenter, options: options).render
+      end
+
+      desc I18n.t('subcommands.project.use.desc'), I18n.t('subcommands.project.use.usage')
+      long_desc I18n.t('subcommands.project.use.long_desc')
+      option :prompts, type: :hash, default: {}, hide: true, aliases: '-p'
+      def use(project_name_or_number = nil)
+        options = configuration.to_h.merge(self.options).with_indifferent_access
+        presenter = use_presenter_for(project_name_or_number, options: options)
+        use_view_for(project_name_or_number, presenter: presenter, options: options).render
+      end
+
+      private
+
+      def delete_view_for(project_name, presenter:, options:)
+        if project_number?(project_name)
+          Views::Project::DeleteByNumber.new(presenter: presenter, options: options)
+        else
+          Views::Project::Delete.new(presenter: presenter, options: options)
+        end
+      end
+
+      def delete_presenter_for(project_name, options:)
+        if project_number?(project_name)
+          Presenters::Project::DeleteByNumberPresenter.new(project_number: project_name.to_i, options: options)
+        else
+          project_name = Models::Project.default_project_name if project_name.blank?
+          Presenters::Project::DeletePresenter.new(project_name: project_name, options: options)
+        end
+      end
+
+      def rename_view_for(project_name, presenter:, options:)
+        if project_number?(project_name)
+          Views::Project::RenameByNumber.new(presenter: presenter, options: options)
+        else
+          Views::Project::Rename.new(presenter: presenter, options: options)
+        end
+      end
+
+      def rename_presenter_for(project_name, new_project_name:, new_project_description:, options:)
+        if project_number?(project_name)
+          Presenters::Project::RenameByNumberPresenter.new(project_number: project_name.to_i,
+            new_project_name: new_project_name, new_project_description: new_project_description, options: options)
+        else
+          project_name = Models::Project.default_project_name if project_name.blank?
+          Presenters::Project::RenamePresenter.new(project_name: project_name,
+            new_project_name: new_project_name, new_project_description: new_project_description, options: options)
+        end
+      end
+
+      def use_view_for(project_name, presenter:, options:)
+        if project_number?(project_name)
+          Views::Project::UseByNumber.new(presenter: presenter, options: options)
+        else
+          Views::Project::Use.new(presenter: presenter, options: options)
+        end
+      end
+
+      def use_presenter_for(project_name, options:)
+        if project_number?(project_name)
+          Presenters::Project::UseByNumberPresenter.new(project_number: project_name.to_i, options: options)
+        else
+          project_name = Models::Project.default_project_name if project_name.blank?
+          Presenters::Project::UsePresenter.new(project_name: project_name, options: options)
+        end
+      end
+
+      def project_number?(project_name)
+        /^[+-]?\d+(\.\d+)?$/.match?(project_name.to_s)
+      end
+    end
+  end
+end

data/lib/dsu/support/ask.rb

@@ -1,13 +1,20 @@
 # frozen_string_literal: true
 
+require 'io/console'
 require 'thor'
 
 module Dsu
   module Support
     module Ask
-      def ask(prompt)
-        options = {}
-        Thor::LineEditor.readline(prompt, options)
+      def ask_while(prompt, options: {}) # rubocop:disable Lint/UnusedMethodArgument
+        loop do
+          print prompt
+          char = $stdin.getch
+          puts char
+          return char if yield(char)
+
+          char
+        end
       end
 
       def yes?(prompt, options: {})

data/lib/dsu/support/color_themable.rb

@@ -8,7 +8,7 @@ module Dsu
       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('/')}]"
+        options = "[#{options.join(',')}]"
         "#{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)}"

data/lib/dsu/support/command_hookable.rb

@@ -2,6 +2,7 @@
 
 require_relative '../env'
 require_relative '../models/color_theme'
+require_relative '../models/project'
 require_relative '../services/stderr_redirector_service'
 require_relative '../views/shared/error'
 require_relative 'color_themable'
@@ -34,14 +35,18 @@ module Dsu
         end
 
         def display_dsu_footer
-          puts apply_theme('_' * 35, theme_color: color_theme.dsu_footer)
+          puts apply_theme('_' * 50, theme_color: color_theme.dsu_footer)
           # TODO: I18n.
-          puts apply_theme("dsu | Version: #{Dsu::VERSION} | Theme: #{color_theme.theme_name}",
+          puts apply_theme("dsu v#{Dsu::VERSION} | Project: #{project} | Theme: #{color_theme.theme_name}",
             theme_color: color_theme.dsu_footer)
         end
 
         private
 
+        def project
+          Models::Project.current_project_name
+        end
+
         def suspend_header?(args, _options)
           return false unless args.count > 1