dsu 2.4.3 → 3.0.0.alpha.0

data/lib/dsu/support/descriptable.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
+require_relative 'short_string'
+
 module Dsu
   module Support
     module Descriptable
-      DESCRIPTION_MAX_COUNT = 25
-
       class << self
         def included(base)
           base.extend(ClassMethods)
@@ -18,26 +18,10 @@ module Dsu
       end
 
       module ClassMethods
-        def short_description(string:, count: DESCRIPTION_MAX_COUNT, elipsis: '...')
-          return elipsis unless string.is_a?(String)
-
-          elipsis_length = elipsis.length
-          count = elipsis_length if count.nil? || count < elipsis_length
-
-          return string if string.length <= count
-
-          tokens = string.split
-          string = ''
-
-          return "#{tokens.first[0...(count - elipsis_length)]}#{elipsis}" if tokens.count == 1
-
-          tokens.each do |token|
-            break if string.length + token.length + elipsis_length > count
-
-            string = "#{string} #{token}"
-          end
+        include ShortString
 
-          "#{string.strip}#{elipsis}"
+        def short_description(string:, count: ShortString::SHORT_STRING_MAX_COUNT, elipsis: '...')
+          short_string(string: string, count: count, elipsis: elipsis)
         end
       end
     end

data/lib/dsu/support/fileable.rb

@@ -26,7 +26,8 @@ module Dsu
       # Entries
 
       def entries_folder
-        File.join(dsu_folder, 'entries')
+        project_folder = project_folder_for(project_name: Models::Project.current_project_name)
+        File.join(project_folder, 'entries')
       end
 
       def entries_file_name(time:, file_name_format: nil)
@@ -88,6 +89,43 @@ module Dsu
         File.join(gem_dir, 'lib/seed_data')
       end
 
+      # Projects
+
+      # Returns the folder where all the projects are stored.
+      def projects_folder
+        File.join(dsu_folder, 'projects')
+      end
+
+      # Current project
+
+      # Contains the name of the file that contains the current
+      # dsu project currently being used.
+      def current_project_file_name
+        'current_project.json'
+      end
+
+      # The complete path to the current project file.
+      def current_project_file
+        File.join(dsu_folder, current_project_file_name)
+      end
+
+      # Project helpers
+
+      # Returns the path of the project with the given name.
+      def project_folder_for(project_name:)
+        raise I18n.t('errors.project_name_invalid', project_name: '{{blank}}') if project_name.blank?
+
+        File.join(projects_folder, project_name)
+      end
+      alias project_folder project_folder_for
+
+      def project_file_for(project_name:)
+        project_folder = project_folder_for(project_name: project_name)
+
+        File.join(project_folder, 'project.json')
+      end
+      alias project_file project_file_for
+
       extend self # rubocop:disable Style/ModuleFunction
     end
   end

data/lib/dsu/support/project_file_system.rb

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+
+require 'fileutils'
+require 'pathname'
+require_relative '../crud/json_file'
+require_relative '../migration/version'
+require_relative '../models/configuration'
+require_relative 'fileable'
+
+module Dsu
+  module Support
+    module ProjectFileSystem
+      class << self
+        def included(base)
+          base.extend(ClassMethods)
+        end
+      end
+
+      def exist?
+        self.class.project_file_exist?(project_name: project_name)
+      end
+      alias persisted? exist?
+
+      def project_initialized?
+        self.class.project_initialized?(project_name: project_name)
+      end
+
+      def project_number
+        self.class.project_number_for(project_name: project_name)
+      end
+
+      module ClassMethods
+        include Fileable
+
+        # Returns the currently selected (used) project name
+        # from dsu/current_project.json
+        def current_project_name
+          Crud::JsonFile.read!(file_path: current_project_file).fetch(:project_name)
+        end
+
+        def default_project_name
+          Models::Configuration.new.default_project
+        end
+
+        def initialize_project(project_name:)
+          return if project_initialized?(project_name: project_name)
+
+          # TODO: Don't know if I like this here.
+          unless current_project_file_exist?
+            file_data = {
+              version: Dsu::Migration::VERSION,
+              project_name: default_project_name
+            }
+            Crud::JsonFile.write!(file_data: file_data, file_path: current_project_file)
+          end
+
+          # Creates dsu/projects/<project_name>
+          FileUtils.mkdir_p(project_folder_for(project_name: project_name))
+        end
+
+        def project_initialized?(project_name:)
+          # Checking these files, checks all the containing folders also
+          current_project_file_exist? &&
+            project_folder_exist?(project_name: project_name)
+        end
+
+        # Does dsu/projects/<project_name>/project.json file exist?
+        def project_file_exist?(project_name:)
+          project_file_path = project_file_for(project_name: project_name)
+          File.exist?(project_file_path)
+        end
+        alias exist? project_file_exist?
+        alias persisted? project_file_exist?
+
+        # Does dsu/current_project.json file exist?
+        def current_project_file_exist?
+          File.exist?(current_project_file)
+        end
+        alias current_project_file_persisted? current_project_file_exist?
+
+        # Does dsu/projects folder exist?
+        def projects_folder_exist?
+          Dir.exist?(projects_folder)
+        end
+
+        # Does dsu/projects/<project_name> folder exist?
+        def project_folder_exist?(project_name:)
+          Dir.exist?(project_folder_for(project_name: project_name))
+        end
+
+        def project_metadata
+          project_folder_names.each_with_index.with_object([]) do |(project_name, index), array|
+            array << {
+              project_number: index + 1,
+              project_name: project_name,
+              current_project: project_name == current_project_name,
+              default_projet: project_name == default_project_name
+            }
+          end
+        end
+
+        def project_number_for(project_name:)
+          project_metadata.find do |metadata|
+            metadata[:project_name] == project_name
+          end&.[](:project_number) || -1
+        end
+
+        private
+
+        def project_folder_names
+          Pathname.new(projects_folder)
+            .children
+            .select(&:directory?)
+            .map(&:basename)
+            .map(&:to_s)
+            .sort { |a, b| a.casecmp(b) }
+        end
+      end
+    end
+  end
+end

data/lib/dsu/support/short_string.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Dsu
+  module Support
+    module ShortString
+      SHORT_STRING_MAX_COUNT = 25
+
+      module_function
+
+      def short_string(string:, count: SHORT_STRING_MAX_COUNT, elipsis: '...')
+        return '' if string.blank?
+        return string if string.length <= count
+
+        # Trim to max count and cut at the last space within the limit
+        trimmed_string = string[0...count].rpartition(' ')[0]
+
+        # If no space found, trim by characters
+        trimmed_string = string[0...(count - elipsis.length)] if trimmed_string.empty? && !string.empty?
+
+        "#{trimmed_string}#{elipsis}"
+      end
+    end
+  end
+end

data/lib/dsu/support/time_comparable.rb

@@ -5,6 +5,8 @@ module Dsu
     module TimeComparable
       TIME_COMPARABLE_FORMAT_SPECIFIER = '%Y%m%d'
 
+      module_function
+
       def time_equal?(other_time:)
         time_equal_compare_string_for(time: time) == time_equal_compare_string_for(time: other_time)
       end

data/lib/dsu/support/transform_project_name.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Dsu
+  module Support
+    module TransformProjectName
+      TRANSFORM_PROJECT_NAME_REGEX = %r{[^/\w\s]|_}
+      TRANSFORM_PROJECT_NAME_SEPARATOR = '-'
+
+      module_function
+
+      def transform_project_name(project_name, options: {})
+        normalized_name = project_name
+          .gsub(TRANSFORM_PROJECT_NAME_REGEX, ' ')   # Replace non-word characters and underscores with space
+          .strip                                     # Remove leading and trailing spaces
+          .squeeze(' ')                              # Convert consecutive spaces to a single space
+          .tr(' ', TRANSFORM_PROJECT_NAME_SEPARATOR) # Replace spaces with hyphens
+          .squeeze(TRANSFORM_PROJECT_NAME_SEPARATOR) # Ensure no consecutive hyphens
+
+        normalized_name.downcase! if options[:downcase]
+        normalized_name
+      end
+    end
+  end
+end

data/lib/dsu/validators/project_name_validator.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require_relative '../support/field_errors'
+require_relative '../support/short_string'
+
+# https://guides.rubyonrails.org/active_record_validations.html#validates-with
+module Dsu
+  module Validators
+    # TODO: I18n.
+    class ProjectNameValidator < ActiveModel::Validator
+      include Support::FieldErrors
+      include Support::ShortString
+
+      def validate(record)
+        unless record.project_name.is_a?(String)
+          record.errors.add(:project_name, 'is the wrong object type. ' \
+                                           "\"String\" was expected, but \"#{record.project.class}\" was received.")
+          return
+        end
+
+        unless record.project_name.present?
+          record.errors.add(:project_name, :blank, '')
+
+          return
+        end
+
+        validate_project_name record
+      end
+
+      private
+
+      def validate_project_name(record)
+        project_name = record.project_name
+
+        return if project_name.length.between?(min_project_name_length(record), max_project_name_length(record))
+
+        if project_name.length < min_project_name_length(record)
+          # TODO: I18n.
+          record.errors.add(:project_name, "is too short: \"#{record.project_name}\" " \
+                                           "(minimum is #{min_project_name_length(record)} characters).")
+        elsif project_name.length > max_project_name_length(record)
+          # TODO: I18n.
+          short_project_name = short_string(string: project_name, count: max_project_name_length(record))
+          record.errors.add(:project_name, "is too long: \"#{short_project_name}\" " \
+                                           "(maximum is #{max_project_name_length(record)} characters).")
+        end
+      end
+
+      def min_project_name_length(record)
+        record.class::MIN_PROJECT_NAME_LENGTH
+      end
+
+      def max_project_name_length(record)
+        record.class::MAX_PROJECT_NAME_LENGTH
+      end
+    end
+  end
+end

data/lib/dsu/version.rb

@@ -2,5 +2,5 @@
 
 module Dsu
   VERSION_REGEX = /\A\d+\.\d+\.\d+(\.(alpha|rc)\.\d+)?\z/
-  VERSION = '2.4.3'
+  VERSION = '3.0.0.alpha.0'
 end

data/lib/dsu/views/base_list_view.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require_relative '../env'
+require_relative '../models/color_theme'
+require_relative '../support/color_themable'
+
+module Dsu
+  module Views
+    class BaseListView
+      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
+        yield
+      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 theme_name
+        @theme_name ||= options.fetch(:theme_name, Models::Configuration.new.theme_name)
+      end
+
+      def formatted_index(index:)
+        apply_theme("#{format('%02s', index + 1)}. ",
+          theme_color: color_theme.index)
+      end
+    end
+  end
+end

data/lib/dsu/views/export.rb

@@ -1,28 +1,82 @@
 # frozen_string_literal: true
 
 require_relative '../models/color_theme'
-require_relative '../models/configuration'
+require_relative '../support/ask'
 require_relative '../support/color_themable'
 
 module Dsu
   module Views
     class Export
+      include Support::Ask
       include Support::ColorThemable
 
-      def initialize(presenter:)
+      def initialize(presenter:, options:)
         @presenter = presenter
+        @options = options&.dup || {}
+        @color_theme = Models::ColorTheme.find(theme_name: theme_name)
       end
 
       def render
-        return presenter.display_nothing_to_export_message if presenter.nothing_to_export?
+        return display_nothing_to_export_message if presenter.nothing_to_export?
 
-        response = presenter.display_export_prompt
-        presenter.render response: response
+        response = display_export_prompt
+        if presenter.respond response: response
+          display_exported_message
+          display_exported_to_message(file_path: presenter.export_file_path)
+        else
+          display_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 :presenter
+      attr_reader :presenter, :color_theme, :options
+
+      def project_name
+        presenter.project_name
+      end
+
+      def display_export_prompt
+        response = ask_while(prompt_with_options(prompt: export_prompt,
+          options: export_prompt_options), options: options) do |input|
+          message = I18n.t('information.input.try_again', options: export_prompt_options.join(','))
+          puts apply_theme(message, theme_color: color_theme.info) unless export_prompt_options.include?(input)
+          export_prompt_options.include?(input)
+        end
+        response == export_prompt_options.first
+      end
+
+      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
+
+      def display_nothing_to_export_message
+        puts apply_theme(I18n.t('subcommands.export.messages.nothing_to_export'), theme_color: color_theme.info)
+      end
+
+      def export_prompt
+        I18n.t('subcommands.export.prompts.export_all_confirm', count: presenter.entry_group_count)
+      end
+
+      def export_prompt_options
+        I18n.t('subcommands.export.prompts.options')
+      end
+
+      def theme_name
+        @theme_name ||= options.fetch(:theme_name, Models::Configuration.new.theme_name)
+      end
     end
   end
 end

data/lib/dsu/views/import.rb

@@ -1,29 +1,105 @@
 # frozen_string_literal: true
 
 require_relative '../models/color_theme'
-require_relative '../models/configuration'
+require_relative '../support/ask'
 require_relative '../support/color_themable'
 
 module Dsu
   module Views
     class Import
+      include Support::Ask
       include Support::ColorThemable
 
-      def initialize(presenter:)
+      def initialize(presenter:, options:)
         @presenter = presenter
+        @options = options&.dup || {}
+        @color_theme = Models::ColorTheme.find(theme_name: theme_name)
       end
 
       def render
-        return presenter.display_import_file_not_exist_message unless presenter.import_file_path_exist?
-        return presenter.display_nothing_to_import_message if presenter.nothing_to_import?
+        return display_import_file_not_exist_message unless presenter.import_file_path_exist?
+        return display_nothing_to_import_message if presenter.nothing_to_import?
 
-        response = presenter.display_import_prompt
-        presenter.render response: response
+        response = display_import_prompt
+        return display_cancelled_message unless response
+
+        response = display_project_override_prompt if presenter.overriding_project?
+        return display_cancelled_message unless response
+
+        display_import_messages presenter.respond
+      rescue StandardError => e
+        puts apply_theme(e.backtrace_locations.join("\n"), theme_color: color_theme.error) if Dsu.env.local?
+        message = I18n.t('subcommands.import.messages.import_error_raised', error: e.message)
+        puts apply_theme(message, theme_color: color_theme.error)
       end
 
       private
 
-      attr_reader :presenter
+      attr_reader :presenter, :color_theme, :options
+
+      def display_import_prompt
+        response = ask_while(prompt_with_options(prompt: import_prompt,
+          options: import_prompt_options), options: options) do |input|
+          message = I18n.t('information.input.try_again', options: import_prompt_options.join(','))
+          puts apply_theme(message, theme_color: color_theme.info) unless import_prompt_options.include?(input)
+          import_prompt_options.include?(input)
+        end
+        response == import_prompt_options.first
+      end
+
+      def display_project_override_prompt
+        response = ask_while(prompt_with_options(prompt: project_override_prompt,
+          options: import_prompt_options), options: options) do |input|
+          message = I18n.t('information.input.try_again', options: import_prompt_options.join(','))
+          puts apply_theme(message, theme_color: color_theme.info) unless import_prompt_options.include?(input)
+          import_prompt_options.include?(input)
+        end
+        response == import_prompt_options.first
+      end
+
+      def display_cancelled_message
+        puts apply_theme(I18n.t('subcommands.import.messages.cancelled'), 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
+
+      def import_prompt
+        I18n.t('subcommands.import.prompts.import_all_confirm',
+          count: presenter.import_entry_groups_count, project: presenter.project_name)
+      end
+
+      def project_override_prompt
+        I18n.t('subcommands.import.prompts.project_override_confirm')
+      end
+
+      def import_prompt_options
+        I18n.t('subcommands.import.prompts.options')
+      end
+
+      def display_import_file_not_exist_message
+        puts apply_theme(I18n.t('subcommands.import.messages.file_not_exist',
+          file_path: presenter.import_file_path), 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
+
+      def theme_name
+        @theme_name ||= options.fetch(:theme_name, Models::Configuration.new.theme_name)
+      end
     end
   end
 end

data/lib/dsu/views/import_dates.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require_relative 'import'
+
+module Dsu
+  module Views
+    class ImportDates < Import
+      private
+
+      def import_prompt
+        I18n.t('subcommands.import.prompts.import_dates_confirm',
+          from: presenter.from.to_date, to: presenter.to.to_date,
+          count: presenter.import_entry_groups_count, project: presenter.project_name)
+      end
+    end
+  end
+end