doto 0.0.1.pre.alpha.1

data/lib/doto/migration/migrator.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require_relative '../env'
+require_relative 'version'
+
+module Doto
+  module Migration
+    class Migrator
+      class << self
+        def migrate_if!(migration_services: [])
+          return if migration_services.any? do |migration_service|
+            migration_service.migrate_if!
+            migration_service.class.migrates_to_latest_migration_version?
+          end
+
+          raise I18n.t('migrations.error.missing_current_migration_service', migration_version: Migration::VERSION)
+        rescue StandardError => e
+          puts I18n.t('migrations.error.failed', message: e.message)
+          exit 1 unless Doto.env.test?
+        end
+      end
+    end
+  end
+end

data/lib/doto/migration/raw_helpers/color_theme_hash.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Doto
+  module Migration
+    module RawHelpers
+      module ColorThemeHash
+        def to_h
+          read.merge(version: version)
+        end
+      end
+    end
+  end
+end

data/lib/doto/migration/raw_helpers/configuration_hash.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Doto
+  module Migration
+    module RawHelpers
+      module ConfigurationHash
+        attr_accessor :default_project
+
+        def to_h
+          read.merge(version: version, default_project: default_project)
+        end
+      end
+    end
+  end
+end

data/lib/doto/migration/raw_helpers/entry_group_hash.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Doto
+  module Migration
+    module RawHelpers
+      module EntryGroupHash
+        def to_h
+          read.merge(version: version)
+        end
+      end
+    end
+  end
+end

data/lib/doto/migration/raw_json_file.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative '../crud/json_file'
+
+module Doto
+  module Migration
+    class RawJsonFile < Crud::JsonFile
+      public :read, :read!, :version=
+
+      def to_h
+        read.merge(version: version)
+      end
+    end
+  end
+end

data/lib/doto/migration/raw_json_files.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require 'fileutils'
+require 'pathname'
+
+require_relative 'raw_json_file'
+
+module Doto
+  module Migration
+    class RawJsonFiles
+      attr_reader :folder
+
+      def initialize(folder)
+        @folder = folder
+      end
+
+      def each_file(regex: //)
+        return unless folder_exist?
+
+        Pathname.new(folder).children.each do |child|
+          next unless child.file? && child.to_s.match?(regex)
+
+          yield RawJsonFile.new(child)
+        end
+      end
+
+      def folder_exist?
+        self.class.folder_exist?(folder: folder)
+      end
+
+      class << self
+        def folder_exist?(folder:)
+          Dir.exist?(folder)
+        end
+      end
+
+      private
+
+      attr_writer :folder
+
+      def safe_cp_r(source, destination)
+        Pathname.new(source).find do |source_path|
+          next if source_path.directory?
+
+          relative_path = source_path.relative_path_from(Pathname.new(source))
+          target_path = Pathname.new(destination).join(relative_path)
+
+          next if target_path.exist?
+
+          FileUtils.mkdir_p(target_path.dirname)
+          FileUtils.cp(source_path, target_path)
+        end
+      end
+    end
+  end
+end

data/lib/doto/migration/v20230613121411/service.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+require_relative '../base_service'
+require_relative '../raw_helpers/entry_group_hash'
+require_relative '../version'
+
+module Doto
+  module Migration
+    module V20230613121411
+      class Service < BaseService
+        class << self
+          def from_migration_version
+            0
+          end
+
+          def to_migration_version
+            20230613121411 # rubocop:disable Style/NumericLiterals
+          end
+        end
+
+        private
+
+        def run_migration!
+          super
+
+          raise_backup_folder_does_not_exist_error_if!
+
+          delete_old_config_file
+          delete_old_themes_folder
+
+          copy_new_doto_folders
+          copy_new_doto_configuration
+          migrate_entry_groups
+        end
+
+        def config_file_from
+          File.join(root_folder, '.doto')
+        end
+
+        def doto_folder_from
+          File.join(root_folder, 'doto')
+        end
+
+        def entries_folder_from
+          File.join(doto_folder_from, 'entries')
+        end
+
+        def themes_folder_from
+          File.join(doto_folder_from, 'themes')
+        end
+
+        def copy_new_doto_folders
+          puts 'Copying new doto folders...'
+
+          FileUtils.cp_r(File.join(seed_data_folder, '.'), File.join(root_folder, 'doto')) unless pretend?
+        end
+
+        def copy_new_doto_configuration
+          puts 'Copying new doto configuration...'
+
+          FileUtils.cp(seed_data_configuration, config_folder) unless pretend?
+        end
+
+        def migrate_entry_groups
+          puts 'Migrating entry groups...'
+
+          return if pretend?
+
+          puts "\tUpdating entry group version..."
+
+          RawJsonFiles.new(entries_folder_from).each_file(regex: /\d{4}-\d{2}-\d{2}.json/) do |raw_entry_group|
+            raw_entry_group.extend(RawHelpers::EntryGroupHash)
+            raw_entry_group.version = to_migration_version
+            raw_entry_group.save!
+          end
+        end
+
+        def delete_old_config_file
+          puts 'Deleting old configuration file...'
+
+          return if pretend?
+
+          File.delete(config_file_from) if File.file?(config_file_from)
+        end
+
+        def delete_old_themes_folder
+          puts 'Deleting old themes folder...'
+
+          FileUtils.rm_rf(themes_folder_from) unless pretend?
+        end
+      end
+    end
+  end
+end

data/lib/doto/migration/v20240210161248/service.rb

@@ -0,0 +1,148 @@
+# frozen_string_literal: true
+
+require_relative '../base_service'
+require_relative '../raw_helpers/color_theme_hash'
+require_relative '../raw_helpers/configuration_hash'
+require_relative '../raw_helpers/entry_group_hash'
+require_relative '../raw_json_file'
+require_relative '../version'
+
+module Doto
+  module Migration
+    module V20240210161248
+      class Service < BaseService
+        class << self
+          def from_migration_version
+            20230613121411 # rubocop:disable Style/NumericLiterals
+          end
+
+          def to_migration_version
+            20240210161248 # rubocop:disable Style/NumericLiterals
+          end
+        end
+
+        private
+
+        def run_migration!
+          super
+
+          raise_backup_folder_does_not_exist_error_if!
+
+          add_new_color_themes
+          create_default_project
+          create_current_project_file
+          update_configuration
+          update_entry_groups
+          update_color_themes
+          delete_old_entry_folder
+
+          puts 'Migration completed successfully.'
+        end
+
+        def doto_folder_from
+          File.join(root_folder, 'doto')
+        end
+
+        def entries_folder_from
+          File.join(doto_folder_from, 'entries')
+        end
+
+        def themes_folder_from
+          File.join(doto_folder_from, 'themes')
+        end
+
+        def add_new_color_themes
+          puts 'Copying new color themes...'
+
+          FileUtils.mkdir_p(themes_folder_from) unless pretend?
+
+          %w[light.json christmas.json].each do |theme_file|
+            destination_theme_file_path = File.join(themes_folder_from, theme_file)
+            # Don't skip these theme files because they were deployed in the previous
+            # doto version with bugs. We need to overwrite them with this new version.
+            # next if File.exist?(destination_theme_file_path)
+
+            source_theme_file_path = File.join(seed_data_folder, 'themes', theme_file)
+            FileUtils.cp(source_theme_file_path, destination_theme_file_path) unless pretend?
+          end
+        end
+
+        def create_default_project
+          puts "Creating default project \"#{default_project_name}\"..."
+
+          return if pretend?
+
+          FileUtils.cp_r(File.join(seed_data_folder, 'projects', '.'),
+            File.join(doto_folder, 'projects'))
+        end
+
+        def create_current_project_file
+          puts 'Creating current project file...'
+
+          return if pretend?
+
+          # NOTE: doto_folder won't change and is safe to use here.
+          FileUtils.cp(File.join(seed_data_folder, 'current_project.json'), doto_folder)
+        end
+
+        def update_configuration
+          puts 'Updating configuration...'
+
+          return if pretend?
+
+          # NOTE: config_path won't change and is safe to use here.
+          RawJsonFile.new(config_path).tap do |configuration_file|
+            configuration_file.extend(RawHelpers::ConfigurationHash)
+            configuration_file.version = to_migration_version
+            configuration_file.default_project = default_project_name
+          end.save!
+        end
+
+        def update_entry_groups
+          puts 'Updating entry groups...'
+
+          return if pretend?
+
+          puts "\tCopying entries to default project \"#{default_project_name}\"..."
+
+          entries_folder_to = File.join(doto_folder, 'projects', default_project_name, 'entries')
+          FileUtils.cp_r(File.join(entries_folder_from, '.'), entries_folder_to)
+
+          puts "\tUpdating entry group version..."
+
+          RawJsonFiles.new(entries_folder_to).each_file(regex: /\d{4}-\d{2}-\d{2}.json/) do |raw_entry_group|
+            raw_entry_group.extend(RawHelpers::EntryGroupHash)
+            raw_entry_group.version = to_migration_version
+            raw_entry_group.save!
+          end
+        end
+
+        def update_color_themes
+          puts 'Updating color themes...'
+
+          FileUtils.cp_r(File.join(backup_folder, 'themes', '.'), themes_folder) unless pretend?
+
+          puts "\tUpdating color theme version..."
+
+          themes_folder_to = File.join(doto_folder, 'themes')
+
+          RawJsonFiles.new(themes_folder_to).each_file(regex: /.+.json/) do |raw_entry_group|
+            raw_entry_group.extend(RawHelpers::ColorThemeHash)
+            raw_entry_group.version = to_migration_version
+            raw_entry_group.save! unless pretend?
+          end
+        end
+
+        def delete_old_entry_folder
+          puts 'Cleaning up old entries...'
+
+          FileUtils.rm_rf(File.join(entries_folder_from)) unless pretend?
+        end
+
+        def default_project_name
+          'default'
+        end
+      end
+    end
+  end
+end

data/lib/doto/migration/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Doto
+  module Migration
+    VERSION = 20240210161248 # rubocop:disable Style/NumericLiterals
+  end
+end

data/lib/doto/models/color_theme.rb

@@ -0,0 +1,224 @@
+# frozen_string_literal: true
+
+require_relative '../crud/json_file'
+require_relative '../migration/version'
+require_relative '../support/color_themable'
+require_relative '../support/descriptable'
+require_relative '../support/fileable'
+require_relative '../support/presentable'
+require_relative '../validators/color_theme_validator'
+require_relative '../validators/description_validator'
+require_relative '../validators/version_validator'
+require_relative 'configuration'
+
+module Doto
+  module Models
+    # This class represents a doto color theme.
+    class ColorTheme < Crud::JsonFile
+      include Support::ColorThemable
+      include Support::Descriptable
+      include Support::Fileable
+      include Support::Presentable
+
+      THEME_FILE_NAME_REGEX = /.+.json/
+
+      VERSION = Migration::VERSION
+
+      DEFAULT_THEME_NAME = 'default'
+      # Theme colors key/value pair format:
+      # <key>: { color: <color> [, mode: <mode>] [, background: <background>] }
+      # Where <color> (required) == any color represented in the colorize gem `String.colors` array.
+      #       <mode> (optional, default is :default) == any mode represented in the colorize gem `String.modes` array.
+      #       <background> (optional, default is :default) == any color represented in the colorize gem
+      #                    `String.colors` array.
+      DEFAULT_THEME_COLORS = {
+        help: { color: :cyan },
+        doto_header: { color: :white, mode: :bold, background: :cyan },
+        doto_footer: { color: :cyan },
+        header: { color: :cyan, mode: :bold },
+        subheader: { color: :cyan, mode: :underline },
+        body: { color: :cyan },
+        footer: { color: :light_cyan },
+        date: { color: :cyan, mode: :bold },
+        index: { color: :light_cyan },
+        # Status colors.
+        info: { color: :cyan },
+        success: { color: :green },
+        warning: { color: :yellow },
+        error: { color: :light_yellow, background: :red },
+        # Prompts
+        prompt: { color: :cyan, mode: :bold },
+        prompt_options: { color: :white, mode: :bold }
+      }.freeze
+      DEFAULT_THEME = {
+        version: VERSION,
+        description: 'Default theme.'
+      }.merge(DEFAULT_THEME_COLORS).freeze
+
+      MIN_DESCRIPTION_LENGTH = 2
+      MAX_DESCRIPTION_LENGTH = 256
+
+      # TODO: Validate other attrs.
+      validates_with Validators::DescriptionValidator
+      validates_with Validators::ColorThemeValidator
+      validates_with Validators::VersionValidator
+
+      attr_reader :theme_name, :options
+
+      def initialize(theme_name:, theme_hash: nil, options: {})
+        raise ArgumentError, 'theme_name is nil.' if theme_name.nil?
+        raise ArgumentError, "theme_name is the wrong object type: \"#{theme_name}\"." unless theme_name.is_a?(String)
+        unless theme_hash.is_a?(Hash) || theme_hash.nil?
+          raise ArgumentError, "theme_hash is the wrong object type: \"#{theme_hash}\"."
+        end
+
+        FileUtils.mkdir_p themes_folder
+
+        @theme_name = theme_name
+        @options = options || {}
+
+        super(self.class.send(:themes_path, theme_name: @theme_name))
+
+        theme_hash ||= DEFAULT_THEME.merge(description: "#{@theme_name.capitalize} theme")
+
+        # Color themes I expect will change a lot, so we're using
+        # a little meta-programming here to dynamically create
+        # public attr_readers and private attr_writers based on the
+        # keys in DEFAULT_THEME, then assign those attributes from
+        # the values in theme_hash. theme_hash will be guaranteed to
+        # have the same keys as DEFAULT_THEME.keys at this point
+        # because we called ensure_theme_hash! above.
+        DEFAULT_THEME.each_key do |attr|
+          self.class.class_eval do
+            attr_reader attr
+            attr_writer attr
+            private :"#{attr}="
+          end
+          attr_value = theme_hash[attr]
+          attr_value = attr_value.merge_default_colors if default_theme_color_keys.include?(attr)
+          send(:"#{attr}=", attr_value)
+        end
+      end
+
+      def delete
+        self.class.delete(theme_name: theme_name)
+      end
+
+      def delete!
+        self.class.delete!(theme_name: theme_name)
+      end
+
+      def exist?
+        self.class.exist?(theme_name: theme_name)
+      end
+
+      class << self
+        delegate :themes_folder, :themes_path, to: Support::Fileable
+
+        def all
+          Dir.glob("#{themes_folder}/*").map do |file_path|
+            theme_name = File.basename(file_path, '.*')
+            find(theme_name: theme_name)
+          end
+        end
+
+        def configuration
+          Models::Configuration.new
+        end
+
+        def current
+          theme_name = configuration.theme_name
+          return unless exist?(theme_name: theme_name)
+
+          find(theme_name: theme_name)
+        end
+
+        # Returns the current color theme if it exists; otherwise,
+        # it returns the default color theme.
+        def current_or_default
+          current || default
+        end
+
+        def default
+          new(theme_name: DEFAULT_THEME_NAME, theme_hash: DEFAULT_THEME)
+        end
+
+        def delete(theme_name:)
+          superclass.delete(file_path: themes_path(theme_name: theme_name))
+        end
+
+        def delete!(theme_name:)
+          superclass.delete!(file_path: themes_path(theme_name: theme_name))
+        end
+
+        def ensure_color_theme_color_defaults_for(theme_hash: DEFAULT_THEME)
+          theme_hash = theme_hash.dup
+
+          theme_hash.each_pair do |key, value|
+            next unless default_theme_color_keys.include?(key)
+
+            theme_hash[key] = value.merge_default_colors
+          end
+          theme_hash
+        end
+
+        def exist?(theme_name:)
+          superclass.file_exist?(file_path: themes_path(theme_name: theme_name))
+        end
+
+        def find(theme_name:)
+          theme_hash = read!(file_path: themes_path(theme_name: theme_name))
+          Services::ColorTheme::HydratorService.new(theme_name: theme_name, theme_hash: theme_hash).call
+        end
+
+        def find_or_create(theme_name:)
+          return find(theme_name: theme_name) if exist?(theme_name: theme_name)
+
+          new(theme_name: theme_name).tap(&:write!)
+        end
+
+        def find_or_initialize(theme_name:)
+          return find(theme_name: theme_name) if exist?(theme_name: theme_name)
+
+          new(theme_name: theme_name)
+        end
+
+        private
+
+        def default_theme_color_keys
+          DEFAULT_THEME_COLORS.keys
+        end
+      end
+
+      def to_h
+        {}.tap do |hash|
+          DEFAULT_THEME.each_key do |key|
+            hash[key] = public_send(key)
+          end
+        end
+      end
+
+      def ==(other)
+        return false unless other.is_a?(self.class)
+        return false unless other.theme_name == theme_name
+
+        DEFAULT_THEME.keys.all? { |key| public_send(key) == other.public_send(key) }
+      end
+      alias eql? ==
+
+      def hash
+        DEFAULT_THEME.keys.map { |key| public_send(key) }.tap do |hashes|
+          hashes << theme_name.hash
+        end.hash
+      end
+
+      private
+
+      attr_writer :theme_name, :description
+
+      def default_theme_color_keys
+        @default_theme_color_keys ||= self.class.send(:default_theme_color_keys)
+      end
+    end
+  end
+end