dsu 2.0.8 → 2.1.2

data/lib/dsu/support/command_options/{time_mneumonics.rb → time_mnemonics.rb}

@@ -3,7 +3,8 @@
 module Dsu
   module Support
     module CommandOptions
-      module TimeMneumonics
+      module TimeMnemonics
+        # TODO: I18n.
         TODAY = %w[n today].freeze
         TOMORROW = %w[t tomorrow].freeze
         YESERDAY = %w[y yesterday].freeze

data/lib/dsu/support/time_formatable.rb

@@ -10,6 +10,7 @@ module Dsu
     module TimeFormatable
       module_function
 
+      # TODO: I18n.
       def formatted_time(time:)
         time = time.localtime if time.utc?
 
@@ -28,10 +29,12 @@ module Dsu
         time.strftime("%A, (#{today_yesterday_or_tomorrow}) %Y-%m-%d #{time_zone}")
       end
 
+      # TODO: I18n.
       def mm_dd(time:, separator: '/')
         time.strftime("%m#{separator}%d")
       end
 
+      # TODO: I18n.
       def mm_dd_yyyy(time:, separator: '/')
         time.strftime("%m#{separator}%d#{separator}%Y")
       end
@@ -40,6 +43,16 @@ module Dsu
         time.zone
       end
 
+      # TODO: I18n.
+      def yyyy_mm_dd_or_through_for(times:)
+        return yyyy_mm_dd(time: times[0]) if times.one?
+
+        times = [yyyy_mm_dd(time: times.min), yyyy_mm_dd(time: times.max)]
+
+        I18n.t('information.dates.through', from: times[0], to: times[1])
+      end
+
+      # TODO: I18n.
       def yyyy_mm_dd(time:, separator: '-')
         time.strftime("%Y#{separator}%m#{separator}%d")
       end

data/lib/dsu/validators/description_validator.rb

@@ -28,8 +28,10 @@ module Dsu
         return if description.length.between?(2, 256)
 
         if description.length < 2
+          # TODO: I18n.
           record.errors.add(:description, "is too short: \"#{record.short_description}\" (minimum is 2 characters).")
         elsif description.length > 256
+          # TODO: I18n.
           record.errors.add(:description, "is too long: \"#{record.short_description}\" (maximum is 256 characters).")
         end
       end

data/lib/dsu/validators/entries_validator.rb

@@ -46,6 +46,7 @@ module Dsu
 
         non_unique_descriptions = descriptions.select { |description| descriptions.count(description) > 1 }.uniq
         non_unique_descriptions.each do |non_unique_description|
+          # TODO: I18n.
           record.errors.add(:entries,
             "array contains duplicate entry: \"#{short_description(non_unique_description)}\".",
             type: Support::FieldErrors::FIELD_DUPLICATE_ERROR)

data/lib/dsu/version.rb

@@ -2,5 +2,5 @@
 
 module Dsu
   VERSION_REGEX = /\A\d+\.\d+\.\d+(\.alpha\.\d+)?\z/
-  VERSION = '2.0.8'
+  VERSION = '2.1.2'
 end

data/lib/dsu/views/color_theme/show.rb

@@ -11,6 +11,7 @@ require_relative '../shared/warning'
 module Dsu
   module Views
     module ColorTheme
+      # TODO: I18n this class.
       class Show
         include Support::ColorThemable
 

data/lib/dsu/views/entry_group/edit.rb

@@ -6,6 +6,7 @@ require_relative '../../models/entry_group'
 module Dsu
   module Views
     module EntryGroup
+      # TODO: I18n this class.
       class Edit
         def initialize(entry_group:, options: {})
           raise ArgumentError, 'entry_group is nil' if entry_group.nil?
@@ -98,7 +99,7 @@ module Dsu
         end
 
         def previous_entry_group?
-          previous_entry_group.entries.present?
+          previous_entry_group&.entries&.present?
         end
 
         def previous_entry_group

data/lib/dsu/views/entry_group/shared/no_entries_to_display.rb

@@ -21,8 +21,9 @@ module Dsu
             @options = options || {}
           end
 
+          # TODO: I18n.
           def render
-            entry_group_times.sort!
+            times.sort!
             time_range = "#{formatted_time(time: times.first)} " \
                          "through #{formatted_time(time: times.last)}"
             message = "(nothing to display for #{time_range})"
@@ -31,6 +32,8 @@ module Dsu
 
           private
 
+          attr_reader :times, :options
+
           def color_theme
             @color_theme ||= Models::ColorTheme.current_or_default
           end

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

@@ -10,6 +10,7 @@ module Dsu
           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)
 

data/lib/dsu.rb

@@ -2,9 +2,13 @@
 
 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
@@ -24,7 +28,7 @@ if !(Dsu.env.test? || Dsu.env.development?) && Dsu::Migration::Service.run_migra
   begin
     Dsu::Migration::Service.new.call
   rescue StandardError => e
-    puts "Error running migrations: #{e.message}"
+    puts I18n.t('errors.migration.error', message: e.message)
     exit 1
   end
 end

data/lib/locales/en/active_record.yml

@@ -0,0 +1,8 @@
+en:
+  activerecord:
+    errors:
+      models:
+        some_model:
+          attributes:
+            some_attribute:
+              some_error: Some error

data/lib/locales/en/commands.yml

@@ -0,0 +1,136 @@
+# lib/dsu/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 DSU entry having DESCRIPTION to the date associated with the given OPTION
+      long_desc: |
+        Will add a DSU entry having DESCRIPTION to the date associated with the given OPTION.
+
+        $ dsu add [-d DATE|-n|-t|-y] DESCRIPTION
+
+        $ dsu a [-d DATE|-n|-t|-y] DESCRIPTION
+
+        OPTIONS:
+
+        -d DATE: Adds a DSU entry having DESCRIPTION to the DATE.
+
+        %{date_option_description}
+
+        -n: Adds a DSU entry having DESCRIPTION to today's date (`Time.now`).
+
+        -t: Adds a DSU entry having DESCRIPTION to tomorrow's date (`Time.new.tomorrow`).
+
+        -y: Adds a DSU entry having DESCRIPTION to yesterday's date (`Time.new.yesterday`).
+
+        DESCRIPTION
+
+        Must be be between 2 and 256 characters (inclusive) in length.
+    config:
+      key_mappings: c
+      desc: config|c SUBCOMMAND
+      usage: Manage configuration file for this gem
+    delete:
+      key_mappings: c
+      desc: delete|d SUBCOMMAND
+      usage: Delete DSU entries for the given SUBCOMMAND
+    edit:
+      desc: edit|e SUBCOMMAND
+      usage: Edit DSU entries for the given SUBCOMMAND
+      key_mappings: e
+    info:
+      key_mappings: i
+      desc: info|i
+      usage: Displays information about this DSU release
+      info: |
+        Dsu Info
+        --------------------------------------------------
+                      Dsu version: %{dsu_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 DSU entries for the given SUBCOMMAND
+    theme:
+      key_mappings: t
+      desc: theme|t SUBCOMMAND
+      usage: Manage DSU themes
+    version:
+      key_mappings:
+        - v
+        - '-v'
+      desc: version|v|-v
+      usage: Displays the DSU 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'
+    today:
+      aliases: -n
+      name: 'today'
+    tomorrow:
+      aliases: -t
+      name: 'tomorrow'
+    yesterday:
+      aliases: -y
+      name: 'yesterday'
+    include_all: Include dates that have no DSU entries
+    date_option_description: |
+      DATE
+
+      This may be any date string that can be parsed using `Time.parse`.
+      Consequently, you may use also use '/' 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). For example: `require 'time';
+      Time.parse('01/02/2023'); Time.parse('1/2') # 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,23 @@
+en:
+  configuration:
+    errors:
+      theme_file_missing: Theme file "%{theme_path}" 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}"]
+    migration:
+      error: "Error running migrations: %{message}"
+  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}"

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,10 @@
+en:
+  services:
+    editor_service:
+      errors:
+        temp_file_error: |
+          Failed to open temporary file in editor '%{editor}'; the system error returned was: '%{status}'.
+          Either set the EDITOR environment variable or set the dsu editor configuration option (`$ dsu config info`).
+          Run `$ dsu help config` for more information.
+      messages:
+        editing: "Editing entry group %{formatted_time}..."