dsu 2.0.7 → 2.1.1

data/lib/dsu/services/entry_group/deleter_service.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative '../../models/entry_group'
+
+module Dsu
+  module Services
+    module EntryGroup
+      class DeleterService
+        def initialize(times:, options: {})
+          raise ArgumentError, 'Argument times is nil' if times.nil?
+
+          @times = times
+          @options = options
+        end
+
+        def call
+          deleted_entry_groups = 0
+
+          times.each do |time|
+            next unless Models::EntryGroup.exist?(time: time)
+
+            Models::EntryGroup.delete(time: time)
+            deleted_entry_groups += 1
+          end
+
+          deleted_entry_groups
+        end
+
+        private
+
+        attr_reader :times, :options
+      end
+    end
+  end
+end

data/lib/dsu/services/entry_group/editor_service.rb

@@ -40,8 +40,9 @@ module Dsu
         # Renders the edit view to a string so we can write it to a temporary file
         # and edit it. The edits will be used to update the entry group.
         def render_edit_view
-          puts apply_theme("Editing entry group #{formatted_time(time: entry_group.time)}...",
-            theme_color: color_theme.header)
+          message = I18n.t('services.editor_service.messages.editing',
+            formatted_time: formatted_time(time: entry_group.time))
+          puts apply_theme(message, theme_color: color_theme.header)
           # TODO: Call #render_as_string directly below?
           StdoutRedirectorService.call { Views::EntryGroup::Edit.new(entry_group: entry_group).render }
           # Views::EntryGroup::Edit.new(entry_group: entry_group).render_as_string
@@ -63,15 +64,10 @@ module Dsu
 
               process_entry_group!(entry_group_with_edits)
             else
-              puts apply_theme(
-                [
-                  "Failed to open temporary file in editor '#{configuration.editor}'; " \
-                  "the system error returned was: '#{$CHILD_STATUS}'.",
-                  'Either set the EDITOR environment variable ' \
-                  'or set the dsu editor configuration option (`$ dsu config info`).',
-                  'Run `$ dsu help config` for more information.'
-                ], theme_color: color_theme.error
-              )
+              message_array = I18n.t('services.editor_service.errors.temp_file_error',
+                editor: configuration.editor,
+                status: $CHILD_STATUS).split("\n")
+              puts apply_theme(message_array, theme_color: color_theme.error)
             end
           end
         end

data/lib/dsu/subcommands/config.rb

@@ -18,99 +18,40 @@ module Dsu
         end
       end
 
-      desc 'info', 'Displays information about this gem configuration'
-      long_desc <<-LONG_DESC
-        NAME
-
-        `dsu config info` -- Displays information about this gem configuration.
-
-        SYNOPSIS
-
-        dsu config info
-      LONG_DESC
+      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 ENV['DEV_ENV']
-        desc 'init', 'Creates and initializes a .dsu file in your home folder'
-        long_desc <<-LONG_DESC
-          NAME
-
-          `dsu config init` -- will create and initialize a .dsu file ("#{Dsu::Support::Fileable.root_folder}/.dsu") that you may edit. Otherwise, the default configuration will be used.
-
-          SYNOPSIS
-
-          dsu config init
-
-          CONFIGURATION FILE OPTIONS
-
-          The following configuration file options are available:
-
-          version:
-
-          The configuration version - DO NOT ALTER THIS VALUE!
-
-          editor:
-
-          The default editor to use when editing entry groups if the EDITOR environment variable on your system is not set. The default is 'nano'. You'll need to change the default editor on Windows systems.
-
-          entries_display_order:
-
-          The order by which entries will be displayed, :asc or :desc (ascending or descending, respectively).
-
-          Default: :desc
-
-          entries_file_name:
-
-          The entries file name format. It is recommended that you do not change this. The file name must include `%Y`, `%m` and `%d` `Time` formatting specifiers to make sure the file name is unique and able to be located by `dsu` functions. For example, the default file name is `%Y-%m-%d.json`; however, something like `%m-%d-%Y.json` or `entry-group-%m-%d-%Y.json` would work as well.
-
-          ATTENTION: Please keep in mind that if you change this value `dsu` will not recognize entry files using a different format. You would (at this time), have to manually rename any existing entry file names to the new format.
-
-          Default: '%Y-%m-%d.json'
-
-          entries_folder:
-
-          This is the folder where `dsu` stores entry files. You may change this to anything you want. `dsu` will create this folder for you, as long as your system's write permissions allow this.
-
-          ATTENTION: Please keep in mind that if you change this value `dsu` will not be able to find entry files in any previous folder. You would (at this time), have to manually mode any existing entry files to this new folder.
-
-          Default: "'#{Dsu::Support::Fileable.root_folder}/dsu/entries'"
-        LONG_DESC
+      if Dsu.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: Dsu::Support::Fileable.root_folder)
         def init
           exit 1 if configuration_errors_or_wanings?
 
           Models::Configuration.default.tap do |configuration|
             configuration.save!
-            messages = ["Configuration file (#{Models::Configuration.config_file}) created."]
+            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 'delete', 'Deletes the configuration file'
-        long_desc <<-LONG_DESC
-          NAME
-
-          `dsu config delete` -- Deletes the configuration.
-
-          SYNOPSIS
-
-          dsu config delete
-
-          NOTES
-
-          Deleting the dsu configuration file will simply cause dsu to use the default configuration options (`Dsu::Models::Configuration::DEFAULT_CONFIGURATION`).
-        LONG_DESC
+        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 = ["Configuration file (#{Models::Configuration.config_file}) does not 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 = ["Configuration file (#{Models::Configuration.config_file}) deleted."]
+          messages = [I18n.t('messages.configuration_file.deleted',
+            configuration_file: Models::Configuration.config_file)]
           Views::Shared::Success.new(messages: messages).render
         end
       end
@@ -119,10 +60,12 @@ module Dsu
 
       def configuration_errors_or_wanings?
         if Models::Configuration.exist?
-          messages = ["Configuration file (#{Models::Configuration.config_file}) already exists"]
+          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 = ["Destination folder for configuration file (#{Models::Configuration.config_folder}) does not exist"] # rubocop:disable Layout/LineLength
+          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

data/lib/dsu/subcommands/delete.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+require_relative '../services/entry_group/counter_service'
+require_relative '../services/entry_group/deleter_service'
+require_relative '../support/command_options/dsu_times'
+require_relative '../support/command_options/time_mneumonic'
+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 Dsu
+  module Subcommands
+    class Delete < BaseSubcommand
+      include Support::CommandOptions::TimeMneumonic
+      include Support::TimeFormatable
+
+      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,
+        mneumonic_option_description: mneumonic_option_description)
+      option :prompts, type: :hash, default: {}, hide: true, aliases: '-p'
+      def date(date_or_mneumonic)
+        time = if time_mneumonic?(date_or_mneumonic)
+          time_from_mneumonic(command_option: date_or_mneumonic)
+        else
+          Time.parse(date_or_mneumonic)
+        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,
+        mneumonic_option_description: mneumonic_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::DsuTimes.dsu_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.canceled')
+          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

data/lib/dsu/subcommands/edit.rb

@@ -12,50 +12,36 @@ module Dsu
       map %w[t] => :tomorrow
       map %w[y] => :yesterday
 
-      desc 'today, n',
-        'Edits the DSU entries for today.'
-      long_desc <<-LONG_DESC
-       Edits the DSU entries for today.
-      LONG_DESC
+      desc I18n.t('subcommands.edit.date.desc'), I18n.t('subcommands.edit.date.usage')
+      long_desc I18n.t('subcommands.edit.date.long_desc', date_option_description: date_option_description)
+      def date(date)
+        entry_group = Models::EntryGroup.edit(time: Time.parse(date))
+        Views::EntryGroup::Show.new(entry_group: entry_group).render
+      rescue ArgumentError => e
+        puts apply_theme(I18n.t('errors.error', message: e.message), theme_color: color_theme.error)
+        exit 1
+      end
+
+      desc I18n.t('subcommands.edit.today.desc'), I18n.t('subcommands.edit.today.usage')
+      long_desc I18n.t('subcommands.edit.today.long_desc')
       def today
         entry_group = Models::EntryGroup.edit(time: Time.now)
         Views::EntryGroup::Show.new(entry_group: entry_group).render
       end
 
-      desc 'tomorrow, t',
-        'Edits the DSU entries for tomorrow.'
-      long_desc <<-LONG_DESC
-        Edits the DSU entries for tomorrow.
-      LONG_DESC
+      desc I18n.t('subcommands.edit.tomorrow.desc'), I18n.t('subcommands.edit.tomorrow.usage')
+      long_desc I18n.t('subcommands.edit.tomorrow.long_desc')
       def tomorrow
         entry_group = Models::EntryGroup.edit(time: Time.now.tomorrow)
         Views::EntryGroup::Show.new(entry_group: entry_group).render
       end
 
-      desc 'yesterday, y',
-        'Edits the DSU entries for yesterday.'
-      long_desc <<-LONG_DESC
-        Edits the DSU entries for yesterday.
-      LONG_DESC
+      desc I18n.t('subcommands.edit.yesterday.desc'), I18n.t('subcommands.edit.yesterday.usage')
+      long_desc I18n.t('subcommands.edit.yesterday.long_desc')
       def yesterday
         entry_group = Models::EntryGroup.edit(time: Time.now.yesterday)
         Views::EntryGroup::Show.new(entry_group: entry_group).render
       end
-
-      desc 'date, d DATE',
-        'Edits the DSU entries for DATE.'
-      long_desc <<-LONG_DESC
-        Edits the DSU entries for DATE.
-
-        \x5 #{date_option_description}
-      LONG_DESC
-      def date(date)
-        entry_group = Models::EntryGroup.edit(time: Time.parse(date))
-        Views::EntryGroup::Show.new(entry_group: entry_group).render
-      rescue ArgumentError => e
-        puts apply_theme("Error: #{e.message}", theme_color: color_theme.error)
-        exit 1
-      end
     end
   end
 end

data/lib/dsu/subcommands/list.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require_relative '../services/entry_group/counter_service'
 require_relative '../support/command_options/dsu_times'
 require_relative '../support/command_options/time_mneumonic'
 require_relative '../support/time_formatable'
@@ -19,52 +20,34 @@ module Dsu
       map %w[t] => :tomorrow
       map %w[y] => :yesterday
 
-      desc 'today, n',
-        'Displays the DSU entries for today'
-      long_desc <<-LONG_DESC
-        Displays the DSU entries for today. This command has no options.
-      LONG_DESC
-      option :include_all, type: :boolean, aliases: '-a', desc: 'Include dates that have no DSU entries'
+      desc I18n.t('subcommands.list.today.desc'), I18n.t('subcommands.list.today.usage')
+      long_desc I18n.t('subcommands.list.today.long_desc')
       def today
         time = Time.now
         times = sorted_dsu_times_for(times: [time.yesterday, time])
         view_list_for(times: times, options: options)
       end
 
-      desc 'tomorrow, t',
-        'Displays the DSU entries for tomorrow'
-      long_desc <<-LONG_DESC
-        Displays the DSU entries for tomorrow. This command has no options.
-      LONG_DESC
-      option :include_all, type: :boolean, aliases: '-a', desc: 'Include dates that have no DSU entries'
+      desc I18n.t('subcommands.list.tomorrow.desc'), I18n.t('subcommands.list.tomorrow.usage')
+      long_desc I18n.t('subcommands.list.tomorrow.long_desc')
       def tomorrow
         time = Time.now
         times = sorted_dsu_times_for(times: [time, time.tomorrow])
         view_list_for(times: times, options: options)
       end
 
-      desc 'yesterday, y',
-        'Displays the DSU entries for yesterday'
-      long_desc <<-LONG_DESC
-        Displays the DSU entries for yesterday. This command has no options.
-      LONG_DESC
-      option :include_all, type: :boolean, aliases: '-a', desc: 'Include dates that have no DSU entries'
+      desc I18n.t('subcommands.list.yesterday.desc'), I18n.t('subcommands.list.yesterday.usage')
+      long_desc I18n.t('subcommands.list.yesterday.long_desc')
       def yesterday
         time = Time.now
         times = sorted_dsu_times_for(times: [time.yesterday, time.yesterday.yesterday])
         view_list_for(times: times, options: options)
       end
 
-      desc 'date, d DATE|MNEUMONIC',
-        'Displays the DSU entries for the DATE or MNEUMONIC provided'
-      long_desc <<-LONG_DESC
-        Displays the DSU entries for the DATE or MNEUMONIC provided.
-
-        #{date_option_description}
-
-        #{mneumonic_option_description}
-      LONG_DESC
-      option :include_all, type: :boolean, aliases: '-a', desc: 'Include dates that have no DSU entries'
+      desc I18n.t('subcommands.list.date.desc'), I18n.t('subcommands.list.date.usage')
+      long_desc I18n.t('subcommands.list.date.long_desc',
+        date_option_description: date_option_description,
+        mneumonic_option_description: mneumonic_option_description)
       def date(date_or_mneumonic)
         time = if time_mneumonic?(date_or_mneumonic)
           time_from_mneumonic(command_option: date_or_mneumonic)
@@ -77,67 +60,13 @@ module Dsu
         Views::Shared::Error.new(messages: e.message).render
       end
 
-      desc 'dates|dd OPTIONS',
-        'Displays the DSU entries for the OPTIONS provided'
-      long_desc <<~LONG_DESC
-        NAME
-
-        $ dsu dates|dd OPTIONS -- will display the DSU entries for the OPTIONS provided.
-
-        SYNOPSIS
-
-        $ dsu dates|dd OPTIONS
-
-        OPTIONS
-
-        -a|--include-all true|false: If true, all DSU dates within the specified range will be displayed. If false, DSU dates between the first and last DSU dates that have NO entries will NOT be displayed.. The default is taken from the dsu configuration setting :include_all, see `dsu config info`.
-
-        -f|--from DATE|MNEMONIC: The DATE or MNEUMONIC that represents the start of the range of DSU dates to display. If a relative mneumonic is used (+/-n, e.g +1, -1, etc.), the date calculated will be relative to the current date (e.g. `<MNEUMONIC>.to_i.days.from_now(Time.now)`).
-
-        -t|--to DATE|MNEMONIC: The DATE or MNEUMONIC that represents the end of the range of DSU dates to display. If a relative mneumonic is used (+/-n, e.g +1, -1, etc.), the date calculated will be relative to the date that resulting from the `--from` option date calculation.
-
-        #{date_option_description}
-
-        #{mneumonic_option_description}
-
-        EXAMPLES
-
-        NOTE: All examples are subject to the `--include-all` option.
-
-        The below will display the DSU entries for the range of dates from 1/1 to 1/4:
-
-        $ dsu list dates --from 1/1 --to +3
-
-        This will display the DSU entries for the range of dates from 1/2 to 1/5:
-
-        $ dsu list dates --from 1/5 --to -3
-
-        This (assuming "today" is 1/10) will display the DSU entries for the last week 1/10 to 1/3:
-
-        $ dsu list dates --from today --to -7
-
-        This (assuming "today" is 5/23) will display the DSU entries for the last week 5/16 to 5/22.
-        This example simply illustrates the fact that you can use relative mneumonics for
-        both `--from` and `--to` options; this doesn't mean you should do so...
-
-        While you can use relative mneumonics for both `--from` and `--to` options,
-        there is always a more intuitive way. The below example basically lists one week
-        of DSU entries back 1 week from yesterday's date:
-
-        $ dsu list dates --from -7 --to +6
-
-        The above can be accomplished MUCH easier by simply using the `yesterday` mneumonic...
-
-        This (assuming "today" is 5/23) will display the DSU entries back 1 week from yesterday's date 5/16 to 5/22:
-
-        $ dsu list dates --from yesterday --to -6
-      LONG_DESC
-      # -f, --from FROM [DATE|MNEMONIC] (e.g. -f, --from 1/1[/yyy]|n|t|y|today|tomorrow|yesterday)
+      desc I18n.t('subcommands.list.dates.desc'), I18n.t('subcommands.list.dates.usage')
+      long_desc I18n.t('subcommands.list.dates.long_desc',
+        date_option_description: date_option_description,
+        mneumonic_option_description: mneumonic_option_description)
       option :from, type: :string, required: true, aliases: '-f', banner: 'DATE|MNEMONIC'
-      # -t, --to TO [DATE|MNEMONIC] (e.g. -t, --to 1/1[/yyy]|n|t|y|today|tomorrow|yesterday)
       option :to, type: :string, required: true, aliases: '-t', banner: 'DATE|MNEMONIC'
-      # Include dates that have no DSU entries.
-      option :include_all, type: :boolean, aliases: '-a', desc: 'Include dates that have no DSU entries'
+      option :include_all, default: false, type: :boolean, aliases: '-a', desc: I18n.t('cli.options.include_all')
       def dates
         options = configuration.to_h.merge(self.options).with_indifferent_access
         times, errors = Support::CommandOptions::DsuTimes.dsu_times_for(from_option: options[:from], to_option: options[:to]) # rubocop:disable Layout/LineLength
@@ -149,9 +78,10 @@ module Dsu
         # NOTE: special sort here, unlike the other commands where rules for
         # displaying DSU entries are applied; this is more of a list command.
         times = times_sort(times: times, entries_display_order: options[:entries_display_order])
-        view_entry_groups(times: times, options: options) do |total_entry_groups, _total_entry_groups_not_shown|
-          # nothing_to_display_banner_for(times) if total_entry_groups.zero?
-          Views::EntryGroup::Shared::NoEntriesToDisplay.new(times: times, options: options) if total_entry_groups.zero?
+        view_entry_groups(times: times, options: options) do |_total_entry_groups, _total_entry_groups_not_shown|
+          if Services::EntryGroup::CounterService.new(times: times).call.zero?
+            Views::EntryGroup::Shared::NoEntriesToDisplay.new(times: times, options: options).render
+          end
         end
       rescue ArgumentError => e
         Views::Shared::Error.new(messages: e.message).render