dsu 2.4.4 → 3.0.0.alpha.0

data/lib/dsu/models/project.rb

@@ -0,0 +1,295 @@
+# frozen_string_literal: true
+
+require 'fileutils'
+
+require_relative '../crud/json_file'
+require_relative '../migration/version'
+require_relative '../models/configuration'
+require_relative '../services/project/hydrator_service'
+require_relative '../services/project/rename_service'
+require_relative '../support/descriptable'
+require_relative '../support/fileable'
+require_relative '../support/project_file_system'
+require_relative '../validators/description_validator'
+require_relative '../validators/project_name_validator'
+require_relative '../validators/version_validator'
+
+module Dsu
+  module Models
+    # This class represents a project. A project is a collection of entry groups.
+    class Project
+      include ActiveModel::Model
+      include Support::Descriptable
+      include Support::Fileable
+      include Support::ProjectFileSystem
+
+      VERSION = Migration::VERSION
+      MIN_PROJECT_NAME_LENGTH = 2
+      MAX_PROJECT_NAME_LENGTH = 24
+      MIN_DESCRIPTION_LENGTH = 2
+      MAX_DESCRIPTION_LENGTH = 32
+
+      attr_reader :project_name, :current_project_file, :description, :version, :options
+
+      validates_with Validators::DescriptionValidator
+      validates_with Validators::ProjectNameValidator
+      validates_with Validators::VersionValidator
+
+      def initialize(project_name:, description: nil, version: nil, options: {})
+        raise ArgumentError, 'project_name is blank' if project_name.blank?
+        raise ArgumentError, 'version is the wrong object type' unless version.is_a?(Integer) || version.nil?
+
+        self.project_name = project_name
+        self.description = description
+        self.version = version || VERSION
+        self.options = options || {}
+      end
+
+      # Override == and hash so that we can compare Entry Group objects.
+      def ==(other)
+        other.is_a?(Project) &&
+          project_name == other.project_name &&
+          description == other.description &&
+          version == other.version
+      end
+      alias eql? ==
+
+      def can_delete?
+        self.class.can_delete?(project_name: project_name)
+      end
+
+      def create
+        self.class.create(project_name: project_name, description: description)
+      end
+      alias save create
+
+      def create!
+        self.class.create!(project_name: project_name, description: description)
+      end
+      alias save! create!
+
+      def current_project?
+        self.class.current_project?(project_name: project_name)
+      end
+
+      def default!
+        return if default_project?
+
+        self.class.default!(project: self)
+      end
+
+      def default_project?
+        self.class.default_project?(project_name: project_name)
+      end
+
+      def delete
+        self.class.delete(project_name: project_name)
+      end
+
+      def delete!
+        self.class.delete!(project_name: project_name)
+      end
+
+      def hash
+        [project_name, description, version].map(&:hash).hash
+      end
+
+      def project_file
+        self.class.project_file(project_name: project_name)
+      end
+
+      def project_folder
+        self.class.project_folder(project_name: project_name)
+      end
+
+      def rename!(new_project_name:, new_project_description: nil)
+        self.class.rename!(project_name: project_name,
+          new_project_name: new_project_name, new_project_description: new_project_description, options: options)
+      end
+
+      def to_h
+        {
+          version: version,
+          project_name: project_name,
+          description: description
+        }
+      end
+
+      # def update
+      #   self.class.update(project_name: project_name, description: description, version: version, options: options)
+      # end
+
+      # def update!
+      #   self.class.update!(project_name: project_name, description: description, version: version, options: options)
+      # end
+
+      def use!
+        return if current_project?
+
+        self.class.use!(project: self)
+      end
+
+      class << self
+        delegate :project_file_for, :project_folder_for, to: Support::Fileable
+
+        def all
+          project_metadata.map do |metadata|
+            find(project_name: metadata[:project_name])
+          end
+        end
+
+        def can_delete?(project_name:)
+          exist?(project_name: project_name) &&
+            # Cannot delete the last project.
+            count > 1 &&
+            # Do not allow the project to be deleted if it
+            # is currently the default project.
+            # The user needs to change to another default
+            # project before they can delete this project.
+            !default_project?(project_name: project_name)
+        end
+
+        def count
+          project_metadata.count
+        end
+
+        def create(project_name:, description: nil, options: {})
+          Models::Project.new(project_name: project_name, description: description, options: options).tap do |project|
+            project.validate!
+            initialize_project(project_name: project_name)
+            Crud::JsonFile.write!(file_data: project.to_h,
+              file_path: project_file_for(project_name: project_name))
+          end
+        end
+        alias update create
+
+        def create!(project_name:, description: nil, options: {})
+          if exist?(project_name: project_name)
+            raise I18n.t('models.project.errors.already_exists', project_name: project_name)
+          end
+
+          create(project_name: project_name, description: description, options: options)
+        end
+        alias update! create!
+
+        def current_project
+          find(project_name: current_project_name)
+        end
+
+        def current_project?(project_name:)
+          current_project_name == project_name
+        end
+
+        def default!(project:)
+          project.validate!
+
+          Models::Configuration.new.tap do |configuration|
+            configuration.default_project = project.project_name
+            configuration.save!
+          end
+        end
+
+        def default_project
+          find(project_name: default_project_name)
+        end
+
+        def default_project?(project_name:)
+          project_name == default_project_name
+        end
+
+        def delete(project_name:)
+          return false unless can_delete?(project_name: project_name)
+
+          project_folder = project_folder_for(project_name: project_name)
+          FileUtils.rm_rf(project_folder)
+
+          true
+        end
+
+        def delete!(project_name:)
+          unless exist?(project_name: project_name)
+            raise I18n.t('models.project.errors.does_not_exist', project_name: project_name)
+          end
+
+          raise I18n.t('models.project.errors.delete_only_project', project_name: project_name) unless count > 1
+
+          if default_project?(project_name: project_name)
+            raise I18n.t('models.project.errors.delete_default_project', project_name: project_name)
+          end
+
+          delete(project_name: project_name)
+        end
+
+        def find(project_name:)
+          unless project_folder_exist?(project_name: project_name)
+            raise I18n.t('models.project.errors.does_not_exist', project_name: project_name)
+          end
+
+          project_file = project_file_for(project_name: project_name)
+
+          unless project_file_exist?(project_name: project_name)
+            raise I18n.t('models.project.errors.project_file_not_exist', project_file: project_file)
+          end
+
+          project_hash = Crud::JsonFile.read!(file_path: project_file)
+          Services::Project::HydratorService.new(project_hash: project_hash).call
+        end
+
+        # project_number is 1 based.
+        def find_by_number(project_number:)
+          project = project_metadata.find do |metadata|
+            metadata[:project_number] == project_number.to_i
+          end
+          return unless project
+
+          find(project_name: project[:project_name])
+        end
+
+        # def find_or_create(project_name:)
+        #   find_or_initialize(project_name: project_name).tap do |project|
+        #     project.save! unless project.persisted?
+        #   end
+        # end
+
+        def find_or_initialize(project_name:)
+          return Models::Project.new(project_name: project_name) unless project_file_exist?(project_name: project_name)
+
+          project_file = project_file_for(project_name: project_name)
+          project_hash = Crud::JsonFile.read!(file_path: project_file)
+          Services::Project::HydratorService.new(project_hash: project_hash).call
+        end
+
+        def rename!(project_name:, new_project_name:, new_project_description: nil, options: {})
+          Services::Project::RenameService.new(from_project_name: project_name,
+            to_project_name: new_project_name, to_project_description: new_project_description, options: options).call
+        end
+
+        def use!(project:)
+          project.validate!
+
+          current_project_hash = { version: project.version, project_name: project.project_name }
+          Crud::JsonFile.write!(file_data: current_project_hash, file_path: current_project_file)
+        end
+      end
+
+      private
+
+      attr_writer :current_project_file, :options, :version
+
+      def description=(value)
+        @description = if value.blank?
+          "#{project_name} project"
+        else
+          value
+        end
+      end
+
+      def project_name=(value)
+        @project_name = begin
+          @current_project_file = project_folder_for(project_name: value)
+          value
+        end
+      end
+    end
+  end
+end

data/lib/dsu/presenters/base_presenter_ex.rb

@@ -1,26 +1,15 @@
 # frozen_string_literal: true
 
-require 'delegate'
-require_relative '../models/color_theme'
-require_relative '../support/color_themable'
-
 module Dsu
   module Presenters
     class BasePresenterEx
-      include Support::ColorThemable
-
       def initialize(options: {})
         @options = options&.dup || {}
-        @color_theme = Models::ColorTheme.find(theme_name: theme_name)
       end
 
       private
 
-      attr_reader :color_theme, :options
-
-      def theme_name
-        @theme_name ||= options.fetch(:theme_name, Models::Configuration.new.theme_name)
-      end
+      attr_accessor :options
     end
   end
 end

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

@@ -2,32 +2,26 @@
 
 require_relative '../../models/entry_group'
 require_relative '../../services/entry_group/exporter_service'
-require_relative '../../support/ask'
 require_relative '../base_presenter_ex'
-require_relative 'messages'
-require_relative 'nothing_to_export'
-require_relative 'service_callable'
 
 module Dsu
   module Presenters
     module Export
       class AllPresenter < BasePresenterEx
-        include Messages
-        include NothingToExport
-        include ServiceCallable
-        include Support::Ask
+        attr_reader :export_file_path
 
-        def render(response:)
-          return display_cancelled_message unless response
+        def respond(response:)
+          return false unless response
 
-          export_file_path = exporter_service_call
+          @export_file_path = exporter_service.call
+        end
 
-          display_exported_message
-          display_exported_to_message(file_path: export_file_path)
+        def nothing_to_export?
+          entry_group_count.zero?
         end
 
-        def display_export_prompt
-          yes?(prompt_with_options(prompt: export_prompt, options: export_prompt_options), options: options)
+        def entry_group_count
+          entry_groups&.count || 0
         end
 
         private
@@ -36,12 +30,13 @@ module Dsu
           @entry_groups ||= Models::EntryGroup.all
         end
 
-        def export_prompt
-          I18n.t('subcommands.export.prompts.export_all_confirm', count: entry_groups.count)
+        def exporter_service
+          Services::EntryGroup::ExporterService.new(project_name: project_name,
+            entry_groups: entry_groups, options: options)
         end
 
-        def export_prompt_options
-          I18n.t('subcommands.export.prompts.options')
+        def project_name
+          @project_name ||= Models::Project.current_project.project_name
         end
       end
     end

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

@@ -1,39 +1,36 @@
 # frozen_string_literal: true
 
 require_relative '../../models/entry_group'
-require_relative '../../support/ask'
+require_relative '../../services/entry_group/exporter_service'
 require_relative '../base_presenter_ex'
-require_relative 'messages'
-require_relative 'nothing_to_export'
-require_relative 'service_callable'
 
 module Dsu
   module Presenters
     module Export
       class DatesPresenter < BasePresenterEx
-        include Messages
-        include NothingToExport
-        include ServiceCallable
-        include Support::Ask
+        attr_reader :export_file_path
 
         def initialize(from:, to:, options: {})
           super(options: options)
 
           @from = from
           @to = to
+
+          self.options[:times] = [from, to]
         end
 
-        def render(response:)
-          return display_cancelled_message unless response
+        def respond(response:)
+          return false unless response
 
-          export_file_path = exporter_service_call
+          @export_file_path = exporter_service.call
+        end
 
-          display_exported_message
-          display_exported_to_message(file_path: export_file_path)
+        def nothing_to_export?
+          entry_groups.empty?
         end
 
-        def display_export_prompt
-          yes?(prompt_with_options(prompt: export_prompt, options: export_prompt_options), options: options)
+        def entry_group_count
+          entry_groups&.count || 0
         end
 
         private
@@ -44,13 +41,13 @@ module Dsu
           Models::EntryGroup.entry_groups(between: [from, to])
         end
 
-        def export_prompt
-          I18n.t('subcommands.export.prompts.export_dates_confirm',
-            from: from.to_date, to: to.to_date, count: entry_groups.count)
+        def exporter_service
+          Services::EntryGroup::ExporterService.new(project_name: project_name,
+            entry_groups: entry_groups, options: options)
         end
 
-        def export_prompt_options
-          I18n.t('subcommands.export.prompts.options')
+        def project_name
+          @project_name ||= Models::Project.current_project.project_name
         end
       end
     end

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

@@ -2,20 +2,18 @@
 
 require_relative '../../models/entry_group'
 require_relative '../../services/entry_group/importer_service'
-require_relative '../../support/ask'
 require_relative '../base_presenter_ex'
+require_relative 'import_entry'
 require_relative 'import_file'
-require_relative 'messages'
-require_relative 'service_callable'
 
 module Dsu
   module Presenters
     module Import
       class AllPresenter < BasePresenterEx
+        include ImportEntry
         include ImportFile
-        include Messages
-        include ServiceCallable
-        include Support::Ask
+
+        attr_reader :import_file_path, :import_messages
 
         def initialize(import_file_path:, options: {})
           super(options: options)
@@ -23,38 +21,35 @@ module Dsu
           @import_file_path = import_file_path
         end
 
-        def render(response:)
-          return display_cancelled_message unless response
-
-          display_import_messages importer_service_call
+        def respond
+          @import_messages = importer_service.call
         end
 
-        def display_import_prompt
-          yes?(prompt_with_options(prompt: import_prompt, options: import_prompt_options), options: options)
+        def project_name
+          @project_name ||= Models::Project.current_project.project_name
         end
 
         private
 
-        attr_reader :import_file_path, :options
-
         def import_entry_groups
           @import_entry_groups ||= CSV.foreach(import_file_path,
-            headers: true).with_object({}) do |entry_group_entry, entry_groups_hash|
-            next unless entry_group_entry['version'].to_i == Dsu::Migration::VERSION
+            headers: true, header_converters: :symbol).with_object({}) do |entry_group_entry, entry_groups_hash|
+            next unless import_entry?(entry_group_entry)
 
-            Date.parse(entry_group_entry['entry_group']).to_s.tap do |time|
-              entry_groups_hash[time] = [] unless entry_groups_hash.key?(time)
-              entry_groups_hash[time] << entry_group_entry['entry_group_entry']
+            project_name = entry_group_entry[:project_name]
+            entry_groups_hash[project_name] = {} unless entry_groups_hash.key?(project_name)
+
+            Date.parse(entry_group_entry[:entry_group]).to_s.tap do |time|
+              entry_groups_hash[project_name][time] = [] unless entry_groups_hash[project_name].key?(time)
+              entry_groups_hash[project_name][time] << entry_group_entry[:entry_group_entry]
             end
           end
         end
 
-        def import_prompt
-          I18n.t('subcommands.import.prompts.import_all_confirm', count: import_entry_groups.count)
-        end
-
-        def import_prompt_options
-          I18n.t('subcommands.import.prompts.options')
+        def importer_service
+          @importer_service ||= Services::EntryGroup::ImporterService.new(
+            import_projects: import_entry_groups, options: options
+          )
         end
       end
     end

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

@@ -2,20 +2,18 @@
 
 require_relative '../../models/entry_group'
 require_relative '../../services/entry_group/importer_service'
-require_relative '../../support/ask'
 require_relative '../base_presenter_ex'
+require_relative 'import_entry'
 require_relative 'import_file'
-require_relative 'messages'
-require_relative 'service_callable'
 
 module Dsu
   module Presenters
     module Import
       class DatesPresenter < BasePresenterEx
+        include ImportEntry
         include ImportFile
-        include Messages
-        include ServiceCallable
-        include Support::Ask
+
+        attr_reader :from, :to, :import_file_path, :import_messages
 
         def initialize(from:, to:, import_file_path:, options: {})
           super(options: options)
@@ -25,47 +23,47 @@ module Dsu
           @import_file_path = import_file_path
         end
 
-        def render(response:)
-          return display_cancelled_message unless response
-
-          display_import_messages importer_service_call
+        def respond
+          @import_messages = importer_service.call
         end
 
-        def display_import_prompt
-          yes?(prompt_with_options(prompt: import_prompt, options: import_prompt_options), options: options)
+        def project_name
+          @project_name ||= Models::Project.current_project.project_name
         end
 
         private
 
-        attr_reader :from, :to, :import_file_path, :options
-
         def import_entry_groups
           @import_entry_groups ||= CSV.foreach(import_file_path,
-            headers: true).with_object({}) do |entry_group_entry, entry_groups_hash|
-            next unless entry_group_entry['version'].to_i == Dsu::Migration::VERSION
+            headers: true, header_converters: :symbol).with_object({}) do |entry_group_entry, entry_groups_hash|
+            next unless import_entry?(entry_group_entry)
+
+            entry_group_time = middle_of_day_for(entry_group_entry[:entry_group])
+            next unless time_between_to_and_from_dates?(entry_group_time)
 
-            entry_group_time = middle_of_day_for(entry_group_entry['entry_group'])
-            next unless entry_group_time.to_date.between?(from.to_date, to.to_date)
+            project_name = entry_group_entry[:project_name]
+            entry_groups_hash[project_name] = {} unless entry_groups_hash.key?(project_name)
 
             entry_group_time.to_date.to_s.tap do |time|
-              entry_groups_hash[time] = [] unless entry_groups_hash.key?(time)
-              entry_groups_hash[time] << entry_group_entry['entry_group_entry']
+              entry_groups_hash[project_name][time] = [] unless entry_groups_hash[project_name].key?(time)
+              entry_groups_hash[project_name][time] << entry_group_entry[:entry_group_entry]
             end
           end
         end
 
-        def import_prompt
-          I18n.t('subcommands.import.prompts.import_dates_confirm',
-            from: from.to_date, to: to.to_date, count: import_entry_groups.keys.count)
-        end
-
-        def import_prompt_options
-          I18n.t('subcommands.import.prompts.options')
+        def time_between_to_and_from_dates?(entry_group_time)
+          entry_group_time.to_date.between?(from.to_date, to.to_date)
         end
 
         def middle_of_day_for(date_string)
           Time.parse(date_string).in_time_zone.middle_of_day
         end
+
+        def importer_service
+          @importer_service ||= Services::EntryGroup::ImporterService.new(
+            import_projects: import_entry_groups, options: options
+          )
+        end
       end
     end
   end

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require_relative '../../migration/version'
+
+module Dsu
+  module Presenters
+    module Import
+      module ImportEntry
+        def overriding_project?
+          options&.fetch(:override, false)
+        end
+
+        private
+
+        def import_entry?(entry_group_entry)
+          entry_group_entry[:version].to_i == Dsu::Migration::VERSION &&
+            (overriding_project? || entry_group_entry[:project_name] == project_name)
+        end
+      end
+    end
+  end
+end

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

@@ -11,7 +11,7 @@ module Dsu
         def nothing_to_import?
           return true unless import_file_path_exist?
 
-          import_entry_groups.empty?
+          import_entry_groups.count.zero?
         end
 
         def import_entry_groups
@@ -19,6 +19,14 @@ module Dsu
           # Example: { '2023-12-32' => ['Entry description 1', 'Entry description 2', ...] }
           raise NotImplementedError
         end
+
+        def import_entry_groups_count
+          if overriding_project?
+            import_entry_groups&.first&.count || 0
+          else
+            import_entry_groups[project_name]&.count || 0
+          end
+        end
       end
     end
   end