dsu 2.4.4 → 3.0.0.alpha.0

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

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require_relative '../../models/project'
+require_relative '../base_presenter_ex'
+
+module Dsu
+  module Presenters
+    module Project
+      class CreatePresenter < BasePresenterEx
+        delegate :project_name, to: :project
+
+        def initialize(project_name:, description:, options: {})
+          super(options: options)
+
+          @project = Models::Project.new(project_name: project_name, description: description, options: options)
+        end
+
+        def respond(response:)
+          return false unless response
+
+          project.create!
+        end
+
+        def project_already_exists?
+          project.exist?
+        end
+
+        def project_errors?
+          project.invalid?
+        end
+
+        def project_errors
+          return [] unless project_errors?
+
+          project.errors.full_messages
+        end
+
+        private
+
+        attr_reader :project, :options
+      end
+    end
+  end
+end

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

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require_relative '../../models/project'
+require_relative '../base_presenter_ex'
+
+module Dsu
+  module Presenters
+    module Project
+      class DeleteByNumberPresenter < 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
+          return false if project_does_not_exist? || project_default?
+
+          project.delete! if project&.present?
+        end
+
+        def project_does_not_exist?
+          !project&.exist?
+        end
+
+        def project_default?
+          project&.default_project?
+        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/delete_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 DeletePresenter < 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
+          return false if project_does_not_exist? || project_default?
+
+          project.delete! if project&.present?
+        end
+
+        def project_does_not_exist?
+          !project.exist?
+        end
+
+        def project_default?
+          project.default_project?
+        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/presenters/project/list_presenter.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require_relative '../../models/project'
+require_relative '../base_presenter_ex'
+
+module Dsu
+  module Presenters
+    module Project
+      class ListPresenter < BasePresenterEx
+        def initialize(options: {})
+          super(options: options)
+        end
+
+        def projects
+          @projects ||= Dsu::Models::Project.all
+        end
+
+        private
+
+        attr_reader :options
+      end
+    end
+  end
+end

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

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require_relative '../../models/project'
+require_relative '../base_presenter_ex'
+
+module Dsu
+  module Presenters
+    module Project
+      class RenameByNumberPresenter < BasePresenterEx
+        delegate :project_name, :description, to: :project, allow_nil: true
+
+        attr_reader :project_number
+
+        def initialize(project_number:, new_project_name:, new_project_description:, options: {})
+          super(options: options)
+
+          raise ArgumentError, 'project_number is blank' if project_number.blank?
+          raise ArgumentError, 'new_project_name is blank' if new_project_name.blank?
+
+          @project_number = project_number
+
+          @project = Models::Project.find_by_number(project_number: project_number)
+
+          @new_project = Models::Project.new(project_name: new_project_name.strip,
+            description: new_project_description&.strip, options: options).tap(&:validate)
+        end
+
+        def respond(response:)
+          return false unless response
+          return false if new_project.invalid?
+
+          project.rename!(new_project_name: new_project_name, new_project_description: new_project_description)
+        end
+
+        def project_does_not_exist?
+          return true unless project.present?
+
+          !project.exist?
+        end
+
+        def new_project_already_exists?
+          new_project.exist?
+        end
+
+        def new_project_name
+          new_project.project_name
+        end
+
+        def new_project_description
+          new_project.description
+        end
+
+        def new_project_errors
+          new_project.errors.full_messages
+        end
+
+        private
+
+        attr_reader :new_project, :project
+      end
+    end
+  end
+end

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

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require_relative '../../models/project'
+require_relative '../base_presenter_ex'
+
+module Dsu
+  module Presenters
+    module Project
+      class RenamePresenter < BasePresenterEx
+        delegate :project_name, :description, to: :project
+
+        def initialize(project_name:, new_project_name:, new_project_description:, options: {})
+          super(options: options)
+
+          raise ArgumentError, 'project_name is blank' if project_name.blank?
+          raise ArgumentError, 'new_project_name is blank' if new_project_name.blank?
+
+          @project = Models::Project.find_or_initialize(project_name: project_name)
+
+          @new_project = Models::Project.new(project_name: new_project_name.strip,
+            description: new_project_description&.strip, options: options).tap(&:validate)
+        end
+
+        def respond(response:)
+          return false unless response
+          return false if new_project.invalid?
+
+          project.rename!(new_project_name: new_project_name, new_project_description: new_project_description)
+        end
+
+        def project_does_not_exist?
+          !project.exist?
+        end
+
+        def new_project_already_exists?
+          new_project.exist?
+        end
+
+        def new_project_name
+          new_project.project_name
+        end
+
+        def new_project_description
+          new_project.description
+        end
+
+        def new_project_errors
+          new_project.errors.full_messages
+        end
+
+        private
+
+        attr_reader :new_project, :project
+      end
+    end
+  end
+end

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