dsu 2.0.8 → 2.1.1

data/lib/dsu/subcommands/theme.rb

@@ -11,142 +11,108 @@ require_relative 'base_subcommand'
 module Dsu
   module Subcommands
     class Theme < BaseSubcommand
-      map %w[c] => :create if Dsu.env.test?
-      map %w[d] => :delete if Dsu.env.test?
+      map %w[c] => :create if Dsu.env.local?
+      map %w[d] => :delete if Dsu.env.local?
       map %w[l] => :list
       map %w[s] => :show
       map %w[u] => :use
 
-      if Dsu.env.test?
-        desc 'create THEME_NAME [OPTIONS]',
-          'Creates a dsu color theme named THEME_NAME.'
-        long_desc <<-LONG_DESC
-        Create a dsu color theme named THEME_NAME in the #{Support::Fileable.themes_folder} folder.
-
-        SYNOPSIS
-
-        `dsu create THEME_NAME [-d|--description DESCRIPTION]`
-
-        OPTIONS:
-
-        -d|--description DESCRIPTION: Creates the dsu color theme with having DESCRIPTION as the color theme description.
-
-        DESCRIPTION:
-
-        Must be be between 2 and 256 characters (inclusive) in length.
-        LONG_DESC
+      if Dsu.env.local?
+        desc I18n.t('subcommands.theme.create.desc'), I18n.t('subcommands.theme.create.usage')
+        long_desc I18n.t('subcommands.theme.create.long_desc', themes_folder: Support::Fileable.themes_folder)
         option :description, type: :string, aliases: '-d', banner: 'DESCRIPTION'
         option :prompts, type: :hash, default: {}, hide: true, aliases: '-p'
         def create(theme_name)
           if Models::ColorTheme.exist?(theme_name: theme_name)
-            Views::Shared::Error.new(messages: "Color theme \"#{theme_name}\" already exists.").render
+            message = I18n.t('subcommands.theme.create.errors.already_exists', theme_name: theme_name)
+            Views::Shared::Error.new(messages: message).render
             return false
           end
-          prompt = color_theme.prompt_with_options(prompt: "Create color theme \"#{theme_name}\"?", options: %w[y N])
+          prompt_string = I18n.t('subcommands.theme.create.prompts.create_theme', theme_name: theme_name)
+          prompt = color_theme.prompt_with_options(prompt: prompt_string, options: %w[y N])
           if yes?(prompt, options: options)
             theme_hash = Models::ColorTheme::DEFAULT_THEME.dup
-            theme_hash[:description] = options[:description] || "#{theme_name.capitalize} color theme"
+            theme_hash[:description] = options[:description] || I18n.t('subcommands.theme.generic.color_theme',
+              theme_name: theme_name.capitalize)
             Models::ColorTheme.new(theme_name: theme_name, theme_hash: theme_hash).save!
-            Views::Shared::Info.new(messages: "\nCreated color theme \"#{theme_name}\".").render
+            message = I18n.t('subcommands.theme.create.messages.created', theme_name: theme_name)
+            Views::Shared::Info.new(messages: "\n#{message}").render
             true
           else
-            Views::Shared::Info.new(messages: "\nCanceled.").render
+            message = I18n.t('subcommands.theme.create.messages.canceled')
+            Views::Shared::Info.new(messages: "\n#{message}").render
             false
           end
         end
 
-        desc 'delete THEME_NAME',
-          'Deletes the existing dsu color theme THEME_NAME.'
-        long_desc <<-LONG_DESC
-        NAME
-
-        `dsu delete [THEME_NAME]` -- will delete the dsu color theme named THEME_NAME located in the #{Support::Fileable.themes_folder} folder.
-        LONG_DESC
+        desc I18n.t('subcommands.theme.delete.desc'), I18n.t('subcommands.theme.delete.usage')
+        long_desc I18n.t('subcommands.theme.delete.long_desc', themes_folder: Support::Fileable.themes_folder)
         option :prompts, type: :hash, default: {}, hide: true, aliases: '-p'
-        def delete(theme_name)
+        def delete(theme_name) # rubocop:disable Metrics/MethodLength
           display_dsu_header
 
           if theme_name == Models::ColorTheme::DEFAULT_THEME_NAME
-            display_dsu_header
-            Views::Shared::Error.new(messages: "Color theme \"#{theme_name}\" cannot be deleted.").render
+            message = I18n.t('subcommands.theme.delete.errors.cannot_delete', theme_name: theme_name)
+            Views::Shared::Error.new(messages: message).render
             return
           end
 
           unless Models::ColorTheme.exist?(theme_name: theme_name)
-            Views::Shared::Error.new(messages: "Color theme \"#{theme_name}\" does not exist.").render
+            message = I18n.t('subcommands.theme.generic.errors.does_not_exist', theme_name: theme_name)
+            Views::Shared::Error.new(messages: message).render
             return
           end
 
-          prompt = color_theme.prompt_with_options(prompt: "Delete color theme \"#{theme_name}\"?",
-            options: %w[y N])
-          if yes?(prompt, options: options)
+          prompt_string = I18n.t('subcommands.theme.delete.prompts.delete_theme', theme_name: theme_name)
+          prompt = color_theme.prompt_with_options(prompt: prompt_string, options: %w[y N])
+          message = if yes?(prompt, options: options)
             Models::ColorTheme.delete!(theme_name: theme_name)
-            Views::Shared::Info.new(messages: "\nDeleted color theme \"#{theme_name}\".").render
+            change_theme
+            I18n.t('subcommands.theme.delete.messages.deleted', theme_name: theme_name)
           else
-            Views::Shared::Info.new(messages: "\nCanceled.").render
+            I18n.t('subcommands.theme.delete.messages.canceled')
           end
+          Views::Shared::Info.new(messages: "\n#{message}").render
         end
       end
 
-      desc 'list',
-        'Lists the available dsu color themes.'
-      long_desc <<-LONG_DESC
-      NAME
-
-      `dsu list` -- lists the available dsu color themes located in the #{Support::Fileable.themes_folder} folder.
-      LONG_DESC
+      desc I18n.t('subcommands.theme.list.desc'), I18n.t('subcommands.theme.list.usage')
+      long_desc I18n.t('subcommands.theme.list.long_desc', themes_folder: Support::Fileable.themes_folder)
       def list
         Views::ColorTheme::Index.new.render
       end
 
-      desc 'use THEME_NAME',
-        'Sets THEME_NAME as the current DSU color theme.'
-      long_desc <<-LONG_DESC
-      NAME
-
-      `dsu theme use [THEME_NAME]` -- sets the dsu color theme to THEME_NAME.
-
-      SYNOPSIS
-
-      If THEME_NAME is not provided, the default theme will be used.
-      If THEME_NAME does not exist, you will be given the option to create a new theme.
-
-      LONG_DESC
+      desc I18n.t('subcommands.theme.use.desc'), I18n.t('subcommands.theme.use.usage')
+      long_desc I18n.t('subcommands.theme.use.long_desc')
       option :prompts, type: :hash, default: {}, hide: true, aliases: '-p'
       def use(theme_name = Models::ColorTheme::DEFAULT_THEME_NAME)
-        if Dsu.env.test? && !Models::ColorTheme.exist?(theme_name: theme_name)
-          display_dsu_header
-          return unless create(theme_name)
-        end
+        display_dsu_header
+
+        return if Dsu.env.local? && !Models::ColorTheme.exist?(theme_name: theme_name) && !create(theme_name)
 
         unless Models::ColorTheme.exist?(theme_name: theme_name)
-          display_dsu_header
-          Views::Shared::Error.new(messages: "Color theme \"#{theme_name}\" does not exist.").render
+          message = I18n.t('subcommands.theme.generic.errors.does_not_exist', theme_name: theme_name)
+          Views::Shared::Error.new(messages: message).render
           return
         end
 
-        configuration.theme_name = theme_name
-        configuration.save!
+        change_theme theme_name: theme_name
         # We need to display the header after the theme is updated so that it is displayed in the
         # correct theme color.
-        display_dsu_header
-        Views::Shared::Info.new(messages: "Using color theme \"#{theme_name}\".").render
+        message = I18n.t('subcommands.theme.use.messages.using_color_theme', theme_name: theme_name)
+        Views::Shared::Info.new(messages: message).render
       end
 
-      desc 'show THEME_NAME',
-        'Displays the dsu color theme.'
-      long_desc <<-LONG_DESC
-      NAME
-
-      `dsu show THEME_NAME` -- displays the dsu color theme for THEME_NAME.
-      LONG_DESC
+      desc I18n.t('subcommands.theme.show.desc'), I18n.t('subcommands.theme.show.usage')
+      long_desc I18n.t('subcommands.theme.show.long_desc')
       def show(theme_name = configuration.theme_name)
         if Dsu::Models::ColorTheme.exist?(theme_name: theme_name)
           Views::ColorTheme::Show.new(theme_name: theme_name).render
           return
         end
 
-        Views::Shared::Error.new(messages: "Color theme \"#{theme_name}\" does not exist.").render
+        message = I18n.t('subcommands.theme.generic.errors.does_not_exist', theme_name: theme_name)
+        Views::Shared::Error.new(messages: message).render
       end
 
       private
@@ -154,6 +120,11 @@ module Dsu
       def display_dsu_header
         self.class.display_dsu_header
       end
+
+      def change_theme(theme_name: Models::ColorTheme::DEFAULT_THEME_NAME)
+        configuration.theme_name = theme_name
+        configuration.save!
+      end
     end
   end
 end

data/lib/dsu/support/ask.rb

@@ -23,7 +23,7 @@ module Dsu
       def auto_prompt(prompt, options)
         prompt = Utils.strip_escapes(prompt)
         @auto_prompt ||= begin
-          value = options.dig('prompts', prompt)
+          value = options.dig('prompts', prompt) || options.dig('prompts', 'any')
           value = (value == 'true' unless value.nil?)
           value
         end

data/lib/dsu/support/command_hookable.rb

@@ -35,11 +35,13 @@ module Dsu
         def suspend_header?(args, _options)
           return false unless args.count > 1
 
+          # TODO: I18n?
           true if args[0] == 'theme' && %w[use delete].include?(args[1])
         end
 
         def display_dsu_footer
           puts apply_theme('_' * 35, theme_color: color_theme.dsu_footer)
+          # TODO: I18n.
           footer = apply_theme("Theme: #{color_theme.theme_name}", theme_color: color_theme.dsu_footer)
           puts footer
         end

data/lib/dsu/support/command_options/dsu_times.rb

@@ -17,8 +17,8 @@ module Dsu
           to_time = dsu_to_time_for(to_option: to_option, from_time: from_time)
 
           errors = []
-          errors << "Option -f, [--from=DATE|MNEMONIC] value is invalid [\"#{from_option}\"]" if from_time.nil?
-          errors << "Option -t, [--to=DATE|MNEMONIC] value is invalid [\"#{to_option}\"]" if to_time.nil?
+          errors << I18n.t('errors.from_option_invalid', from_option: from_option) if from_time.nil?
+          errors << I18n.t('errors.to_option_invalid', to_option: to_option) if to_time.nil?
           return [[], errors] if errors.any?
 
           min_time, max_time = [from_time, to_time].sort

data/lib/dsu/support/command_options/time.rb

@@ -67,6 +67,7 @@ module Dsu
 
         def valid_time!(time_parts:)
           time_string = time_string_for(time_parts: time_parts)
+          # TODO: I18n.
           Date.strptime(time_string, '%Y/%m/%d').to_time
         end
 

data/lib/dsu/support/command_options/time_mneumonics.rb

@@ -4,6 +4,7 @@ module Dsu
   module Support
     module CommandOptions
       module TimeMneumonics
+        # 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.1'
 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,90 @@
+# lib/dsu/cli.rb
+en:
+  commands:
+    add:
+      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:
+      desc: config|-c SUBCOMMAND
+      usage: Manage configuration file for this gem
+    delete:
+      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
+    info:
+      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:
+      desc: list|-l SUBCOMMAND
+      usage: Displays DSU entries for the given SUBCOMMAND
+    theme:
+      desc: theme|-t SUBCOMMAND
+      usage: Manage DSU themes
+    version:
+      desc: version|-v
+      usage: Displays the DSU version for this gem
+  options:
+    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.`
+    mneumonic_option_description: |
+      MNEUMONIC
+
+      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 mneumonics (RDNs). Generally speaking,
+      RDNs are relative to the current date. For example, a RDN of +1 would be
+      equal to `Time.now + 1.day` (tomorrow), and a RDN of -1 would be equal to
+      `Time.now - 1.day` (yesterday).
+
+      In some cases the behavior RDNs 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}..."