doto 0.0.1.pre.alpha.1

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

@@ -0,0 +1,117 @@
+# frozen_string_literal: true
+
+require 'csv'
+require_relative '../../models/entry_group'
+require_relative '../../models/project'
+
+module Doto
+  module Services
+    module EntryGroup
+      # Expects a hash having the following format:
+      # {
+      # "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_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)
+
+          raise_if_more_than_one_project(import_projects)
+
+          @import_projects = import_projects
+          @options = options
+        end
+
+        def call
+          import!
+        end
+
+        private
+
+        attr_reader :import_projects, :options
+
+        def import!
+          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)
+              end
+
+              import_messages[entry_group.time_yyyy_mm_dd] = []
+
+              unless entry_group.save
+                entry_group.errors.full_messages.each do |error|
+                  import_messages[entry_group.time_yyyy_mm_dd] << error
+                end
+              end
+            end
+          end
+
+          import_messages
+        end
+
+        def entry_group_for(entry_group_date)
+          time = Time.parse(entry_group_date).in_time_zone
+          if merge?
+            Models::EntryGroup.find_or_initialize(time: time)
+          else
+            Models::EntryGroup.new(time: time, options: options)
+          end
+        end
+
+        def add_entry_group_entry_if(entry_group:, entry_description:)
+          entry = Models::Entry.new(description: entry_description)
+          return entry_group.entries << entry if replace?
+          return if entry_group.entries.include?(entry)
+
+          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
+
+        def replace?
+          !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
+end

data/lib/doto/services/migration_version/hydrator_service.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Doto
+  module Services
+    module MigrationVersion
+      class HydratorService
+        def initialize(migration_version_hash:, options: {})
+          raise ArgumentError, 'migration_version_hash is nil' if migration_version_hash.nil?
+
+          unless migration_version_hash.is_a?(Hash)
+            raise ArgumentError,
+              "migration_version_hash is the wrong object type: \"#{migration_version_hash}\""
+          end
+          raise ArgumentError, 'options is nil' if options.nil?
+          raise ArgumentError, "options is the wrong object type:\"#{options}\"" unless options.is_a?(Hash)
+
+          @migration_version_hash = migration_version_hash.dup
+          @options = options || {}
+        end
+
+        def call
+          hydrate
+        end
+
+        private
+
+        attr_reader :migration_version_hash, :options
+
+        def hydrate
+          migration_version_hash[:version] = migration_version_hash[:version].to_i
+          migration_version_hash
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require_relative '../../models/color_theme'
+
+module Doto
+  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/doto/services/project/rename_service.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+require_relative '../../models/project'
+require_relative '../../support/fileable'
+
+module Doto
+  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/doto/services/stderr_redirector_service.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Doto
+  module Services
+    # This service captures $stderr, resirects it to a StringIO object,
+    # and returns the string value.
+    # https://stackoverflow.com/questions/4459330/how-do-i-temporarily-redirect-stderr-in-ruby/4459463#4459463
+    module StderrRedirectorService
+      class << self
+        def call
+          raise ArgumentError, 'no block was provided' unless block_given?
+
+          # The output stream must be an IO-like object. In this case we capture it in
+          # an in-memory IO object so we can return the string value. Any IO object can
+          # be used here.
+          string_io = StringIO.new
+          original_stderr, $stderr = $stderr, string_io # rubocop:disable Style/ParallelAssignment
+          yield
+          string_io.string
+        ensure
+          # Restore the original $stderr.
+          $stderr = original_stderr
+        end
+      end
+    end
+  end
+end

data/lib/doto/services/stdout_redirector_service.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Doto
+  module Services
+    # This service captures $stdout, resirects it to a StringIO object,
+    # and returns the string value.
+    # https://stackoverflow.com/questions/4459330/how-do-i-temporarily-redirect-stderr-in-ruby/4459463#4459463
+    module StdoutRedirectorService
+      class << self
+        def call
+          raise ArgumentError, 'no block was provided' unless block_given?
+
+          # The output stream must be an IO-like object. In this case we capture it in
+          # an in-memory IO object so we can return the string value. Any IO object can
+          # be used here.
+          string_io = StringIO.new
+          original_stdout, $stdout = $stdout, string_io # rubocop:disable Style/ParallelAssignment
+          yield
+          string_io.string
+        ensure
+          # Restore the original $stdout.
+          $stdout = original_stdout
+        end
+      end
+    end
+  end
+end

data/lib/doto/services/temp_file/reader_service.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Doto
+  module Services
+    module TempFile
+      class ReaderService
+        def initialize(tmp_file_path:, options: {})
+          raise ArgumentError, 'tmp_file_path is nil' if tmp_file_path.nil?
+          raise ArgumentError, 'tmp_file_path is the wrong object type' unless tmp_file_path.is_a?(String)
+          raise ArgumentError, 'tmp_file_path is empty' if tmp_file_path.empty?
+          raise ArgumentError, 'tmp_file_path does not exist' unless File.exist?(tmp_file_path)
+          raise ArgumentError, 'options is nil' if options.nil?
+          raise ArgumentError, 'options is the wrong object type' unless options.is_a?(Hash)
+
+          @tmp_file_path = tmp_file_path
+          @options = options || {}
+        end
+
+        def call
+          raise ArgumentError, 'no block given' unless block_given?
+
+          File.foreach(tmp_file_path) do |line|
+            yield line.strip
+          end
+        end
+
+        private
+
+        attr_reader :tmp_file_path, :options
+      end
+    end
+  end
+end

data/lib/doto/services/temp_file/writer_service.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'tempfile'
+
+module Doto
+  module Services
+    module TempFile
+      class WriterService
+        def initialize(tmp_file_content:, options: {})
+          raise ArgumentError, 'tmp_file_content is nil' if tmp_file_content.nil?
+          raise ArgumentError, 'tmp_file_content is the wrong object type' unless tmp_file_content.is_a?(String)
+          raise ArgumentError, 'options is nil' if options.nil?
+          raise ArgumentError, 'options is the wrong object type' unless options.is_a?(Hash)
+
+          @tmp_file_content = tmp_file_content
+          @options = options || {}
+        end
+
+        def call
+          raise ArgumentError, 'no block given' unless block_given?
+
+          Tempfile.new('doto').tap do |file|
+            file.write("#{tmp_file_content}\n")
+            file.close
+            yield file.path
+          end.unlink
+        end
+
+        private
+
+        attr_reader :tmp_file_content, :options
+      end
+    end
+  end
+end

data/lib/doto/subcommands/base_subcommand.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require_relative '../base_cli'
+require_relative '../support/ask'
+
+module Doto
+  module Subcommands
+    class BaseSubcommand < Doto::BaseCLI
+      include Support::Ask
+    end
+  end
+end

data/lib/doto/subcommands/browse.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require 'io/console'
+
+require_relative '../services/stdout_redirector_service'
+require_relative '../support/command_options/doto_times'
+require_relative '../support/command_options/time_mnemonic'
+require_relative '../support/entry_group_browsable'
+require_relative '../support/time_formatable'
+require_relative '../views/entry_group/shared/no_entries_to_display'
+require_relative '../views/shared/error'
+require_relative 'base_subcommand'
+
+module Doto
+  module Subcommands
+    class Browse < BaseSubcommand
+      include Support::EntryGroupBrowsable
+      include Support::CommandOptions::TimeMnemonic
+      include Support::TimeFormatable
+
+      # TODO: I18n.
+      map %w[w] => :week
+      map %w[m] => :month
+      map %w[y] => :year
+
+      class_option :pager, default: true, type: :boolean, hide: true, aliases: '-p'
+      class_option :include_all, default: nil, type: :boolean, aliases: '-a',
+        desc: I18n.t('options.include_all')
+
+      desc I18n.t('subcommands.browse.week.desc'), I18n.t('subcommands.browse.week.usage')
+      long_desc I18n.t('subcommands.browse.week.long_desc')
+      def week
+        browse_entry_groups time: Time.now, options: options.merge({ browse: :week })
+      end
+
+      desc I18n.t('subcommands.browse.month.desc'), I18n.t('subcommands.browse.month.usage')
+      long_desc I18n.t('subcommands.browse.month.long_desc')
+      def month
+        browse_entry_groups time: Time.now, options: options.merge({ browse: :month })
+      end
+
+      desc I18n.t('subcommands.browse.year.desc'), I18n.t('subcommands.browse.year.usage')
+      long_desc I18n.t('subcommands.browse.year.long_desc')
+      def year
+        browse_entry_groups time: Time.now, options: options.merge({ browse: :year })
+      end
+    end
+  end
+end

data/lib/doto/subcommands/config.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+require_relative '../models/configuration'
+require_relative '../views/configuration/show'
+require_relative '../views/shared/model_errors'
+require_relative '../views/shared/success'
+require_relative '../views/shared/warning'
+require_relative 'base_subcommand'
+
+module Doto
+  module Subcommands
+    class Config < BaseSubcommand
+      default_command :help
+
+      class << self
+        def exit_on_failure?
+          false
+        end
+      end
+
+      desc I18n.t('subcommands.config.info.desc'), I18n.t('subcommands.config.info.usage')
+      long_desc I18n.t('subcommands.config.info.long_desc')
+      def info
+        configuration = Models::Configuration.new
+        Views::Configuration::Show.new(config: configuration).call
+      end
+
+      if Doto.env.development?
+        desc I18n.t('subcommands.config.init.desc'), I18n.t('subcommands.config.init.usage')
+        long_desc I18n.t('subcommands.config.init.long_desc', home_folder: Doto::Support::Fileable.root_folder)
+        def init
+          exit 1 if configuration_errors_or_wanings?
+
+          Models::Configuration.default.tap do |configuration|
+            configuration.save!
+            messages = [I18n.t('messages.configuration_file.created',
+              configuration_file: Models::Configuration.config_file)]
+            Views::Shared::Success.new(messages: messages).render
+            Views::Configuration::Show.new(config: configuration).render
+          end
+        end
+
+        desc I18n.t('subcommands.config.delete.desc'), I18n.t('subcommands.config.delete.usage')
+        long_desc I18n.t('subcommands.config.delete.long_desc')
+        def delete
+          unless Models::Configuration.exist?
+            messages = [I18n.t('messages.configuration_file.does_not_exist',
+              configuration_file: Models::Configuration.config_file)]
+            Views::Shared::Warning.new(messages: messages).render
+            exit 1
+          end
+          Models::Configuration.delete!
+          messages = [I18n.t('messages.configuration_file.deleted',
+            configuration_file: Models::Configuration.config_file)]
+          Views::Shared::Success.new(messages: messages).render
+        end
+      end
+
+      private
+
+      def configuration_errors_or_wanings?
+        if Models::Configuration.exist?
+          messages = [I18n.t('messages.configuration_file.already_exists',
+            configuration_file: Models::Configuration.config_file)]
+          Views::Shared::Warning.new(messages: messages).render
+        elsif !Dir.exist?(Models::Configuration.config_folder)
+          messages = [I18n.t('messages.configuration_file.destination_folder_does_not_exist',
+            configuration_file: Models::Configuration.config_file)]
+          Views::Shared::Error.new(messages: messages).render
+        else
+          configuration = Models::Configuration.default
+          return false if configuration.valid?
+
+          Views::Shared::ModelErrors.new(model: configuration).render
+        end
+
+        true
+      end
+    end
+  end
+end

data/lib/doto/subcommands/delete.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+require_relative '../services/entry_group/counter_service'
+require_relative '../services/entry_group/deleter_service'
+require_relative '../support/command_options/doto_times'
+require_relative '../support/command_options/time_mnemonic'
+require_relative '../support/time_formatable'
+require_relative '../views/entry_group/shared/no_entries_to_display'
+require_relative '../views/shared/error'
+require_relative 'base_subcommand'
+
+module Doto
+  module Subcommands
+    class Delete < BaseSubcommand
+      include Support::CommandOptions::TimeMnemonic
+      include Support::TimeFormatable
+
+      # TODO: I18n.
+      map %w[d] => :date
+      map %w[dd] => :dates
+      map %w[n] => :today
+      map %w[t] => :tomorrow
+      map %w[y] => :yesterday
+
+      desc I18n.t('subcommands.delete.today.desc'), I18n.t('subcommands.delete.today.usage')
+      long_desc I18n.t('subcommands.delete.today.long_desc')
+      option :prompts, type: :hash, default: {}, hide: true, aliases: '-p'
+      def today
+        delete_entry_groups_if times: [Time.now], options: options
+      end
+
+      desc I18n.t('subcommands.delete.tomorrow.desc'), I18n.t('subcommands.delete.tomorrow.usage')
+      long_desc I18n.t('subcommands.delete.tomorrow.long_desc')
+      option :prompts, type: :hash, default: {}, hide: true, aliases: '-p'
+      def tomorrow
+        delete_entry_groups_if times: [Time.now.tomorrow], options: options
+      end
+
+      desc I18n.t('subcommands.delete.yesterday.desc'), I18n.t('subcommands.delete.yesterday.usage')
+      long_desc I18n.t('subcommands.delete.yesterday.long_desc')
+      option :prompts, type: :hash, default: {}, hide: true, aliases: '-p'
+      def yesterday
+        delete_entry_groups_if times: [Time.now.yesterday], options: options
+      end
+
+      desc I18n.t('subcommands.delete.date.desc'), I18n.t('subcommands.delete.date.usage')
+      long_desc I18n.t('subcommands.delete.date.long_desc',
+        date_option_description: date_option_description,
+        mnemonic_option_description: mnemonic_option_description)
+      option :prompts, type: :hash, default: {}, hide: true, aliases: '-p'
+      def date(date_or_mnemonic)
+        time = if time_mnemonic?(date_or_mnemonic)
+          time_from_mnemonic(command_option: date_or_mnemonic)
+        else
+          Time.parse(date_or_mnemonic)
+        end
+        delete_entry_groups_if times: [time], options: options
+      rescue ArgumentError => e
+        Views::Shared::Error.new(messages: e.message).render
+      end
+
+      desc I18n.t('subcommands.delete.dates.desc'), I18n.t('subcommands.delete.dates.usage')
+      long_desc I18n.t('subcommands.delete.dates.long_desc',
+        date_option_description: date_option_description,
+        mnemonic_option_description: mnemonic_option_description)
+      option :from, type: :string, required: true, aliases: '-f', banner: 'DATE|MNEMONIC'
+      option :to, type: :string, required: true, aliases: '-t', banner: 'DATE|MNEMONIC'
+      option :prompts, type: :hash, default: {}, hide: true, aliases: '-p'
+      def dates
+        options = configuration.to_h.merge(self.options).with_indifferent_access
+        times, errors = Support::CommandOptions::DotoTimes.doto_times_for(from_option: options[:from], to_option: options[:to]) # rubocop:disable Layout/LineLength
+        if errors.any?
+          Views::Shared::Error.new(messages: errors).render
+          return
+        end
+
+        times = times_sort(times: times, entries_display_order: options[:entries_display_order])
+        delete_entry_groups_if times: times, options: options
+      rescue ArgumentError => e
+        Views::Shared::Error.new(messages: e.message).render
+      end
+
+      private
+
+      def delete_entry_groups_if(times:, options:)
+        prompt_string = I18n.t('subcommands.delete.prompts.are_you_sure',
+          dates: yyyy_mm_dd_or_through_for(times: times), count: total_entry_groups_for(times: times))
+        prompt = color_theme.prompt_with_options(prompt: prompt_string, options: %w[y N])
+        if yes?(prompt, options: options)
+          deleted_count = delete_entry_groups_for(times: times)
+          message = I18n.t('subcommands.delete.messages.deleted', count: deleted_count)
+          Views::Shared::Success.new(messages: message).render
+        else
+          message = I18n.t('subcommands.delete.messages.cancelled')
+          Views::Shared::Info.new(messages: message).render
+        end
+      end
+
+      def delete_entry_groups_for(times:)
+        Services::EntryGroup::DeleterService.new(times: times).call
+      end
+
+      def total_entry_groups_for(times:)
+        Services::EntryGroup::CounterService.new(times: times).call
+      end
+    end
+  end
+end