doto 0.0.1.pre.alpha.1

data/lib/doto/views/shared/error.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require_relative 'message'
+
+module Doto
+  module Views
+    module Shared
+      class Error < Message
+        def initialize(messages:, header: nil, options: {})
+          options = { header: header, output_stream: $stderr }.merge(options)
+
+          super(messages: messages, message_type: :error, options: options)
+        end
+      end
+    end
+  end
+end

data/lib/doto/views/shared/info.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require_relative 'message'
+
+module Doto
+  module Views
+    module Shared
+      class Info < Message
+        def initialize(messages:, header: nil, options: {})
+          options = { header: header, output_stream: $stdout }.merge(options)
+
+          super(messages: messages, message_type: :info, options: options)
+        end
+      end
+    end
+  end
+end

data/lib/doto/views/shared/message.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+require_relative '../../models/color_theme'
+
+module Doto
+  module Views
+    module Shared
+      class Message
+        include Support::ColorThemable
+
+        MESSAGE_TYPES = %i[error info success warning].freeze
+
+        def initialize(messages:, message_type:, options: {})
+          messages = [messages] unless messages.is_a?(Array)
+          messages = messages.select(&:present?)
+
+          validate_arguments!(messages, message_type, options)
+
+          @messages = messages
+          @message_type = message_type
+          @options = options || {}
+          @message_color = color_theme.public_send(message_type)
+          @header = options[:header]
+          @ordered_list = options.fetch(:ordered_list, true)
+        end
+
+        def render
+          output_stream.puts to_s
+        end
+
+        def to_s
+          return if messages.empty?
+
+          strings = []
+
+          strings << apply_theme(header, theme_color: color_theme.header) if header.present?
+
+          strings << if messages.one?
+            apply_theme(messages[0], theme_color: message_color)
+          else
+            messages.each_with_index.map do |message, index|
+              message = "#{index + 1}. #{message}" if ordered_list?
+              apply_theme(message, theme_color: message_color)
+            end
+          end
+
+          strings.flatten.join("\n")
+        end
+
+        private
+
+        attr_reader :messages, :message_color, :message_type, :header, :options
+
+        def color_theme
+          @color_theme ||= begin
+            theme_name = options.fetch(:theme_name, Models::Configuration.new.theme_name)
+            Models::ColorTheme.find(theme_name: theme_name)
+          end
+        end
+
+        def ordered_list?
+          @ordered_list
+        end
+
+        def output_stream
+          @output_stream ||= options.fetch(:output_stream, $stdout)
+        end
+
+        def validate_arguments!(messages, message_type, options)
+          raise ArgumentError, 'messages is empty' if messages.empty?
+          unless Models::ColorTheme::DEFAULT_THEME_COLORS.key?(message_type)
+            raise ArgumentError, 'message_type is not a valid message type'
+          end
+          raise ArgumentError, 'options is nil' if options.nil?
+
+          %i[\[\] fetch].each do |method|
+            next if options.respond_to?(method)
+
+            raise ArgumentError, "options does not respond to :#{method}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/doto/views/shared/model_errors.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative 'error'
+
+module Doto
+  module Views
+    module Shared
+      class ModelErrors < Error
+        def initialize(model:, options: {})
+          raise ArgumentError, 'model is nil' if model.nil?
+          raise ArgumentError, "model is the wrong object type: \"#{model}\"" unless model.is_a?(ActiveModel::Model)
+
+          # TODO: I18n.
+          header = options[:header] || 'The following ERRORS were encountered; changes could not be saved:'
+          super(messages: model.errors.full_messages, header: header, options: options)
+
+          @model = model
+        end
+
+        def render
+          return if model.valid?
+
+          super
+        end
+
+        private
+
+        attr_reader :model
+      end
+    end
+  end
+end

data/lib/doto/views/shared/success.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require_relative 'message'
+
+module Doto
+  module Views
+    module Shared
+      class Success < Message
+        def initialize(messages:, header: nil, options: {})
+          options = { header: header, output_stream: $stdout }.merge(options)
+
+          super(messages: messages, message_type: :success, options: options)
+        end
+      end
+    end
+  end
+end

data/lib/doto/views/shared/warning.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require_relative 'message'
+
+module Doto
+  module Views
+    module Shared
+      class Warning < Message
+        def initialize(messages:, header: nil, options: {})
+          options = { header: header, output_stream: $stdout }.merge(options)
+
+          super(messages: messages, message_type: :warning, options: options)
+        end
+      end
+    end
+  end
+end

data/lib/doto.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'active_support/core_ext/hash/indifferent_access'
+require 'active_support/core_ext/object/blank'
+require 'i18n'
+require 'thor'
+require 'time'
+
+I18n.load_path += Dir[File.join(__dir__, 'locales/**/*', '*.yml')]
+# I18n.default_locale = :en # (note that `en` is already the default!)
+
+Dir.glob("#{__dir__}/core/**/*.rb").each do |file|
+  require file
+end
+
+Array.include(WrapAndJoin)
+Hash.include(ColorThemeColors)
+Hash.include(ColorThemeMode)
+
+require_relative 'doto/env'
+require 'pry-byebug' if Doto.env.development?
+
+Dir.glob("#{__dir__}/doto/**/*.rb").each { |file| require file }
+
+unless Doto.env.test? || Doto.env.development?
+  # NOTE: Add a new migration service to the array whenever a new migration is created.
+  options = { pretend: false }
+  migration_services = [
+    Doto::Migration::V20230613121411::Service.new(options: options),
+    Doto::Migration::V20240210161248::Service.new(options: options)
+  ]
+  Doto::Migration::Migrator.migrate_if!(migration_services: migration_services)
+end

data/lib/locales/en/active_record.yml

@@ -0,0 +1,17 @@
+en:
+  models:
+    project:
+      errors:
+        already_exists: "Project '%{project_name}' already exists."
+        delete_default_project: "Project '%{project_name}' is the default project. Change to a different default project before deleting this project."
+        delete_only_project: "Project '%{project_name}' is the only project and cannot be deleted."
+        does_not_exist: "Project '%{project_name}' does not exist."
+        new_project_already_exists: "Project cannot be renamed to '%{project_name}' because the project already exists."
+        project_file_not_exist: "Project file '%{project_file}' does not exist."
+  activerecord:
+    errors:
+      models:
+        some_model:
+          attributes:
+            some_attribute:
+              some_error: Some error

data/lib/locales/en/commands.yml

@@ -0,0 +1,165 @@
+# lib/doto/cli.rb
+#
+# NOTE:
+#
+# Commands should have the following layout:
+#
+# en:
+#   commands:
+#     my_command:
+#       key_mappings: thor key mappings
+#       desc:         thor command description
+#       usage:        thor command usage
+#       long_desc:    thor long description
+#
+# Place key_mappings: at the top of the command entries:
+#
+# en:
+#   commands:
+#     my_command:
+#       key_mappings: m # Single mapping
+#       key_mappings:   # Array of mappings
+#         - 'm'
+#         - '-m'
+en:
+  commands:
+    add:
+      key_mappings: a
+      desc: add|a [OPTIONS] DESCRIPTION
+      usage: Adds a TODO entry having DESCRIPTION to the date associated with the given OPTION
+      long_desc: |
+        Will add a TODO entry having DESCRIPTION to the date associated with the given OPTION.
+
+        $ doto add [-d DATE|MNEMONIC|-n|-t|-y] DESCRIPTION
+
+        $ doto a [-d DATE|MNEMONIC|-n|-t|-y] DESCRIPTION
+
+        OPTIONS:
+
+        -d DATE|MNEMONIC: Adds a TODO entry having DESCRIPTION to the DATE or date referenced by the MNEMONIC.
+
+        %{date_option_description}
+
+        %{mnemonic_option_description}
+
+        -n: Adds a TODO entry having DESCRIPTION to today's date (`Time.now`).
+
+        -t: Adds a TODO entry having DESCRIPTION to tomorrow's date (`Time.new.tomorrow`).
+
+        -y: Adds a TODO entry having DESCRIPTION to yesterday's date (`Time.new.yesterday`).
+
+        DESCRIPTION
+
+        Must be be between 2 and 256 characters (inclusive) in length.
+    browse:
+      key_mappings: b
+      desc: browse|b SUBCOMMAND
+      usage: Browse TODO entries by the given SUBCOMMAND
+    config:
+      key_mappings: c
+      desc: config|c SUBCOMMAND
+      usage: Manage configuration file for this gem
+    delete:
+      key_mappings: d
+      desc: delete|d SUBCOMMAND
+      usage: Delete TODO entries for the given SUBCOMMAND
+    edit:
+      desc: edit|e SUBCOMMAND
+      usage: Edit TODO entries for the given SUBCOMMAND
+      key_mappings: e
+    export:
+      key_mappings: x
+      desc: export|x SUBCOMMAND
+      usage: Export TODO entries for the given SUBCOMMAND
+    import:
+      key_mappings: m
+      desc: import|m SUBCOMMAND
+      usage: Imports TODO entries for the given SUBCOMMAND
+    info:
+      key_mappings: i
+      desc: info|i
+      usage: Displays information about this TODO release
+      info: |
+        Doto Info
+        --------------------------------------------------
+                      Doto version: %{doto_version}
+            Configuration version: %{configuration_version}
+              Entry group version: %{entry_group_version}
+              Color theme version: %{color_theme_version}
+
+                    Config folder: %{config_folder}
+                      Root folder: %{root_folder}
+                   Entries folder: %{entries_folder}
+                    Themes folder: %{themes_folder}
+                       Gem folder: %{gem_folder}
+                      Temp folder: %{temp_folder}
+
+         Migration version folder: %{migration_version_folder}
+            Migration file folder: %{migration_file_folder}
+    list:
+      key_mappings: l
+      desc: list|l SUBCOMMAND
+      usage: Displays TODO entries for the given SUBCOMMAND
+    project:
+      key_mappings: p
+      desc: project|p SUBCOMMAND
+      usage: Manage TODO projects for the given SUBCOMMAND
+    theme:
+      key_mappings: t
+      desc: theme|t SUBCOMMAND
+      usage: Manage TODO themes
+    version:
+      key_mappings:
+        - v
+        - '-v'
+      desc: version|v|-v
+      usage: Displays the TODO version for this gem
+  # Should these options go under their respective commands
+  # (e.g. commands.options.date.name, commands.options.today.aliases, etc.)?
+  options:
+    date:
+      aliases: -d
+      name: 'date'
+    date_or_mnemonic:
+      aliases: -d
+      name: 'date'
+      banner: 'DATE|MNEMONIC'
+    today:
+      aliases: -n
+      name: 'today'
+    tomorrow:
+      aliases: -t
+      name: 'tomorrow'
+    yesterday:
+      aliases: -y
+      name: 'yesterday'
+    include_all: Include dates that have no TODO entries
+    date_option_description: |
+      DATE
+
+      In the format of: [d]d-|/[m]m-|/[-|/yyyy].
+
+      This may be any date string that can be parsed using ruby's `Time.parse`.
+      Consequently, you may use use '-' or '/' as date separators,
+      as well as omit the year if the date you want to display is the
+      current year (e.g. <month>/<day>, or 1/31). Leading zeroes are optional.
+      For example: `require 'time'; Time.parse('1/2') # etc.`
+
+      IMPORTANT: If you include the year as part of your date string, the format of
+      the date must be <day>/<month>/<year>, where <day> and <month> may include optional
+      leading zeroes, and <year> must be in the format of yyyy. For example
+      `require 'time'; Time.parse('31/1/2023') # etc.`
+    mnemonic_option_description: |
+      MNEMONIC
+
+      This may be any of the following: n|today|t|tomorrow|y|yesterday|+n|-n.
+
+      Where n, t, y are aliases for today, tomorrow, and yesterday, respectively.
+
+      Where +n, -n are relative date mnemonics (RDMs). Generally speaking,
+      RDMs are relative to the current date. For example, a RDM of +1 would be
+      equal to `Time.now + 1.day` (tomorrow), and a RDM of -1 would be equal to
+      `Time.now - 1.day` (yesterday).
+
+      In some cases the behavior RDMs have on some commands are context dependent;
+      in such cases the behavior will be noted.

data/lib/locales/en/miscellaneous.yml

@@ -0,0 +1,29 @@
+en:
+  configuration:
+    errors:
+      theme_file_missing: Theme file "%{theme_path}" does not exist.
+      project_path_missing: Default project "%{project_folder}" does not exist.
+  errors:
+    error: "Error: %{message}"
+    from_option_invalid: Option -f, [--from=DATE|MNEMONIC] value is invalid ["%{from_option}"]
+    to_option_invalid: Option -t, [--to=DATE|MNEMONIC] value is invalid ["%{to_option}"]
+    project_name_invalid: Project name "%{project_name}" is invalid.
+  headers:
+    entry:
+      could_not_be_added: "An error was encountered; the entry could not be added:"
+  messages:
+    configuration_file:
+      already_exists: Configuration file (%{configuration_file}) already exists.
+      created: Configuration file (%{configuration_file}) created.
+      deleted: Configuration file (%{configuration_file}) deleted.
+      destination_folder_does_not_exist: "Destination folder for configuration file (%{configuration_folder}) does not exist."
+      does_not_exist: "Configuration file (%{configuration_file}) does not exist."
+  information:
+    dates:
+      through: "%{from} thru %{to}"
+    input:
+      try_again: "Please try again. Valid options are [%{options}]."
+  migrations:
+    error:
+      missing_current_migration_service: "No migration service handles the current migration: %{migration_version}."
+      failed: "Error running migrations: %{message}"

data/lib/locales/en/presenters.yml

@@ -0,0 +1,19 @@
+en:
+  presenters:
+    color_theme_presenter:
+      headers:
+        color_themes: Color Themes
+        current_theme: "* current theme"
+    color_theme_show_presenter:
+      headers:
+        number: No.
+        color: Color
+        values: Values
+        viewing_color_theme: "Viewing color theme: %{theme_name}"
+        footer_example: Footer example
+    configuration_presenter:
+      headers:
+        file_contents: "Configuration file contents (%{config_path})"
+    entry_group_presenter:
+      headers:
+        no_entries_available: (no entries available for this day)

data/lib/locales/en/services.yml

@@ -0,0 +1,14 @@
+en:
+  services:
+    editor_service:
+      errors:
+        temp_file_error: |
+          Failed to open temporary file in editor '%{editor}'; the system error returned was: '%{status}'.
+          Check your EDITOR environment variable and the doto editor configuration option (run `doto config info`).
+          Run `doto help config` for more information.
+      messages:
+        editing: "Editing entry group %{formatted_time}..."
+    entry_group:
+      importer_service:
+        errors:
+          project_mismatch: The current project "%{current_project_name}" does not match the project "%{import_project_name}" being imported.