dsu 2.0.8 → 2.1.2

data/lib/locales/en/subcommands.yml

@@ -0,0 +1,348 @@
+# lib/dsu/subcommands
+en:
+  subcommands:
+    config:
+      delete:
+        desc: delete
+        usage: Deletes the configuration file
+        long_desc: |
+          Deletes the configuration file.
+
+          EXAMPLES:
+
+          dsu config delete
+
+          NOTES
+
+          Deleting the dsu configuration file will simply cause dsu to use the default configuration options (`Dsu::Models::Configuration::DEFAULT_CONFIGURATION`).
+      info:
+        desc: info
+        usage: Displays information about this gem configuration
+        long_desc: |
+          Displays information about this gem configuration.
+
+          EXAMPLES:
+
+          $ dsu config info
+      init:
+        desc: init
+        usage: Creates and initializes a .dsu file in your home folder
+        long_desc: |
+          Creates and initializes a .dsu file in your home folder (%{home_folder}) that may be edited.
+
+          EXAMPLES:
+
+          $ dsu config init
+
+          CONFIGURATION FILE ENTRIES
+
+          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.
+
+          Default: "nano" on nix sytems.
+
+          entries_display_order:
+
+          The order by which entries will be displayed, "asc" or "desc" (ascending or descending, respectively).
+
+          Default: "desc"
+
+          carry_over_entries_to_today:
+
+          Applicable to the `dsu edit` command. Valid values are true|false. If true, when editing DSU entries for the first time on any given day (e.g. `dsu edit today`), DSU entries from the previous day will be copied into the current editing session. If there are no DSU entries from the previous day, dsu will search backwards up to 7 days to find a DSU date that has entries to copy. If after searching back 7 days, no DSU entries are found, the editor session will simply provide no previous DSU entries.
+
+          Default: false
+
+          include_all:
+
+          Applicable to dsu commands that display DSU date lists (e.g. `dsu list` commands). Valid values are true|false. If true, all DSU dates within the specified range will be displayed, regardless of whether or not a particular date has entries. If false, only DSU dates between the first and last DSU dates that have entries will be displayed.
+
+          Default: false
+
+          theme_name:
+
+          Default: "default"
+    delete:
+      date:
+        desc: date|d DATE|MNEMONIC
+        usage: Deletes the DSU entries for the given DATE or MNEMONIC
+        long_desc: |
+          Deletes the DSU entries for the given DATE or MNEMONIC.
+
+          %{date_option_description}
+
+          %{mnemonic_option_description}
+      dates:
+        desc: dates|dd OPTIONS
+        usage: Deletes the DSU entries for the OPTIONS provided
+        long_desc: |
+          Deletes the DSU entries for the given OPTIONS.
+
+          $ dsu dates OPTIONS
+
+          $ dsu dd OPTIONS
+
+          OPTIONS:
+
+          -f|--from DATE|MNEMONIC: The DATE or MNEMONIC that represents the start of the range of DSU dates to delete. If a relative mnemonic is used (+/-n, e.g +1, -1, etc.), the date calculated will be relative to the current date (e.g. `<MNEMONIC>.to_i.days.from_now(Time.now)`).
+
+          -t|--to DATE|MNEMONIC: The DATE or MNEMONIC that represents the end of the range of DSU dates to delete. If a relative mnemonic 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}
+
+          %{mnemonic_option_description}
+
+          EXAMPLES:
+
+          NOTE: All examples can substitute their respective short form options (e.g. `-f`, `-t`, etc. for `--from`, `--to`, etc.).
+
+          The below will delete the DSU entries for the range of dates from 1/1 to 1/4 for the current year:
+
+          $ dsu delete dates --from 1/1 --to +3
+
+          This will delete the DSU entries for the range of dates from 1/2 to 1/5 for the year 2022:
+
+          $ dsu delete dates --from 1/5/2022 --to -3
+
+          This (assuming "today" is 1/10) will delete the DSU entries for the last week 1/10 to 1/3 of the current year:
+
+          $ dsu delete dates --from today --to -7
+
+          This (assuming "today" is 5/23) will delete the DSU entries for the last week 5/16 to 5/22.
+          This example simply illustrates the fact that you can use relative mnemonics for
+          both `--from` and `--to` options; this doesn't mean you should do so...
+
+          While you can use relative mnemonics for both `--from` and `--to` options,
+          there is always a more intuitive way. The below example basically deletes one week of DSU entries back 1 week from yesterday's date:
+
+          $ dsu delete dates --from -7 --to +6
+
+          The above can be accomplished MUCH easier by simply using the `yesterday` mnemonic...
+
+          This (assuming "today" is 5/23) will delete the DSU entries back 1 week from yesterday's date 5/16 to 5/22:
+
+          $ dsu delete dates --from yesterday --to -6
+      today:
+        desc: today|n
+        usage: Deletes the DSU entries for today
+        long_desc: |
+          Deletes the DSU entries for today.
+
+          $ dsu delete today
+
+          $ dsu delete n
+      tomorrow:
+        desc: tomorrow|t
+        usage: Deletes the DSU entries for tomorrow
+        long_desc: |
+          Deletes the DSU entries for tomorrow.
+
+          $ dsu delete tomorrow
+
+          $ dsu delete t
+      yesterday:
+        desc: yesterday|y
+        usage: Deletes the DSU entries for yesterday
+        long_desc: |
+          Deletes the DSU entries for yesterday.
+
+          $ dsu delete yesterday
+
+          $ dsu delete y
+      messages:
+        deleted: Deleted %{count} entry group(s).
+        canceled: Canceled.
+      prompts:
+        are_you_sure: Are you sure you want to delete all the entries for %{dates} (%{count} entry groups)?
+    edit:
+      date:
+        desc: date|d DATE
+        usage: Edits the DSU entries for DATE
+        long_desc: |
+          Edits the DSU entries for DATE.
+
+          %{date_option_description}
+      today:
+        desc: today|n
+        usage: Edits the DSU entries for today
+        long_desc: |
+          Edits the DSU entries for today.
+      tomorrow:
+        desc: tomorrow|t
+        usage: Edits the DSU entries for tomorrow
+        long_desc: |
+          Edits the DSU entries for tomorrow.
+      yesterday:
+        desc: yesterday|y
+        usage: Edits the DSU entries for yesterday
+        long_desc: |
+          Edits the DSU entries for yesterday.
+    list:
+      date:
+        desc: date|d DATE|MNEMONIC
+        usage: Displays the DSU entries for the given DATE or MNEMONIC
+        long_desc: |
+          Displays the DSU entries for the given DATE or MNEMONIC.
+
+          %{date_option_description}
+
+          %{mnemonic_option_description}
+      dates:
+        desc: dates|dd OPTIONS
+        usage: Displays the DSU entries for the OPTIONS provided
+        long_desc: |
+          Displays the DSU entries for the given OPTIONS.
+
+          $ dsu dates OPTIONS
+
+          $ dsu 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 MNEMONIC that represents the start of the range of DSU dates to display. If a relative mnemonic is used (+/-n, e.g +1, -1, etc.), the date calculated will be relative to the current date (e.g. `<MNEMONIC>.to_i.days.from_now(Time.now)`).
+
+          -t|--to DATE|MNEMONIC: The DATE or MNEMONIC that represents the end of the range of DSU dates to display. If a relative mnemonic 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}
+
+          %{mnemonic_option_description}
+
+          EXAMPLES:
+
+          NOTE: All example results are subject to the `--include-all|-a` option.
+
+          NOTE: All examples can substitute their respective short form options (e.g. `-f`, `-t`, etc. for `--from`, `--to`, etc.).
+
+          The below will display the DSU entries for the range of dates from 1/1 to 1/4 for the current year:
+
+          $ 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 for the year 2022:
+
+          $ dsu list dates --from 1/5/2022 --to -3
+
+          This (assuming "today" is 1/10) will display the DSU entries for the last week 1/10 to 1/3 of the current year:
+
+          $ 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 mnemonics for
+          both `--from` and `--to` options; this doesn't mean you should do so...
+
+          While you can use relative mnemonics 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` mnemonic...
+
+          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
+      today:
+        desc: today|n
+        usage: Displays the DSU entries for today
+        long_desc: |
+          Displays the DSU entries for today.
+
+          $ dsu list today
+
+          $ dsu list n
+      tomorrow:
+        desc: tomorrow|t
+        usage: Displays the DSU entries for tomorrow
+        long_desc: |
+          Displays the DSU entries for tomorrow.
+
+          $ dsu list tomorrow
+
+          $ dsu list t
+      yesterday:
+        desc: yesterday|y
+        usage: Displays the DSU entries for yesterday
+        long_desc: |
+          Displays the DSU entries for yesterday.
+
+          $ dsu list yesterday
+
+          $ dsu list y
+    theme:
+      create:
+        desc: create THEME_NAME [OPTIONS]
+        usage: Creates a dsu color theme named THEME_NAME
+        long_desc: |
+          Creates a dsu color theme named THEME_NAME in the %{themes_folder} folder.
+
+          $ 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.
+        prompts:
+          create_theme: Create color theme "%{theme_name}"?
+        errors:
+          already_exists: Color theme "%{theme_name}" already exists.
+        messages:
+          created: Created color theme "%{theme_name}".
+          canceled: Canceled.
+      delete:
+        desc: delete THEME_NAME
+        usage: Deletes the existing dsu color theme THEME_NAME
+        long_desc: |
+          Deletes the existing dsu color theme THEME_NAME in the %{themes_folder} folder.
+
+          $ dsu theme delete THEME_NAME
+        prompts:
+          delete_theme: Delete color theme "%{theme_name}"?
+        errors:
+          cannot_delete: Color theme "%{theme_name}" cannot be deleted.
+        messages:
+          canceled: Canceled.
+          deleted: Deleted color theme "%{theme_name}".
+      list:
+        desc: list
+        usage: Lists the available dsu color themes.
+        long_desc: |
+          Lists the available dsu color themes in the %{themes_folder} folder.
+
+          $ dsu theme list
+      use:
+        desc: use [THEME_NAME]
+        usage: Sets the dsu color theme to THEME_NAME
+        long_desc: |
+          Sets the dsu color theme to THEME_NAME.
+
+          $ dsu theme use [THEME_NAME]
+
+          NOTES
+
+          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.
+        messages:
+          using_color_theme: Using color theme "%{theme_name}".
+      show:
+        desc: show THEME_NAME
+        usage: Displays the dsu color theme THEME_NAME
+        long_desc: |
+          Displays the dsu color theme THEME_NAME.
+
+          $ dsu theme show THEME_NAME
+      generic:
+        color_theme: "%{theme_name} color theme"
+        errors:
+          does_not_exist: Color theme "%{theme_name}" does not exist.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dsu
 version: !ruby/object:Gem::Version
-  version: 2.0.8
+  version: 2.1.2
 platform: ruby
 authors:
 - Gene M. Angelo, Jr.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-12-02 00:00:00.000000000 Z
+date: 2023-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -130,30 +130,18 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '2.0'
-description: '    dsu is a small, but powerful gem that helps manage your Agile DSU
-  (Daily Stand Up) participation. How? by providing a simple command-line interface
-  (CLI) which allows you to create, read, update, and delete (CRUD) your DSU entries
-  (activities). During your DSU, you can use dsu''s CLI to list and share what you
-  did "yesterday" and what you plan on doing "Today" with your team. DSU entries are
-  grouped by day and can be viewed in simple text format from the command-line. When
-  displaying DSU entries for a particular day, dsu will also display DSU entries for
-  the previous day. If the day you are trying to display falls on a weekend or Monday,
-  dsu will automatically search back to include the weekend and previous Friday dates
-  and display the entries; this is so that you can share what you did over the weekend
-  (if anything) and the previous Friday with your team. When searching for "Yesterday''s"
-  DSU entries, dsu will automatically search back a maximimum of 7 days to find DSU
-  entries to share. This could be helpful if, for example, if you are sharing what
-  you plan to do today (Wednesday), but were sick yesterday (Tuesday); dsu in this
-  case will display the last DSU entries it can find searching backwards a maximum
-  of 7 days. dsu does a LOT more and is perfect for command-line junkies and those
-  who LOVE simplicity. Give it a try and a star if you like it!
-
-  '
+description: "    Get ready to jazz and snazz up your daily stand-ups with dsu, the
+  agile developer's new best friend! This handy command-line gem is all about making
+  your Daily Stand-Up (DSU) participation smooth, fun, and super efficient. Effortlessly
+  create, update, and organize your DSU entries, turning the task of tracking and
+  sharing your daily activities into a breeze. With its intuitive interface and smart
+  date management, dsu ensures you’re always ready to inform your team about your
+  recent progress and upcoming plans. Perfect for command-line tool enthusiasts, dsu
+  brings a dash of simplicity and fun, fun, fun to your daily agile routine!\n"
 email:
 - public.gma@gmail.com
 executables:
 - dsu
-- dsu_migrate.rb
 extensions: []
 extra_rdoc_files: []
 files:
@@ -172,7 +160,6 @@ files:
 - bin/dsu
 - bin/setup
 - exe/dsu
-- exe/dsu_migrate.rb
 - lib/core/ruby/color_theme_colors.rb
 - lib/core/ruby/color_theme_mode.rb
 - lib/core/ruby/wrap_and_join.rb
@@ -199,6 +186,8 @@ files:
 - lib/dsu/services/color_theme/hydrator_service.rb
 - lib/dsu/services/configuration/hydrator_service.rb
 - lib/dsu/services/entry/hydrator_service.rb
+- lib/dsu/services/entry_group/counter_service.rb
+- lib/dsu/services/entry_group/deleter_service.rb
 - lib/dsu/services/entry_group/editor_service.rb
 - lib/dsu/services/entry_group/hydrator_service.rb
 - lib/dsu/services/migration_version/hydrator_service.rb
@@ -208,6 +197,7 @@ files:
 - lib/dsu/services/temp_file/writer_service.rb
 - lib/dsu/subcommands/base_subcommand.rb
 - lib/dsu/subcommands/config.rb
+- lib/dsu/subcommands/delete.rb
 - lib/dsu/subcommands/edit.rb
 - lib/dsu/subcommands/list.rb
 - lib/dsu/subcommands/theme.rb
@@ -217,14 +207,13 @@ files:
 - lib/dsu/support/command_hookable.rb
 - lib/dsu/support/command_options/dsu_times.rb
 - lib/dsu/support/command_options/time.rb
-- lib/dsu/support/command_options/time_mneumonic.rb
-- lib/dsu/support/command_options/time_mneumonics.rb
+- lib/dsu/support/command_options/time_mnemonic.rb
+- lib/dsu/support/command_options/time_mnemonics.rb
 - lib/dsu/support/descriptable.rb
 - lib/dsu/support/entry_group_viewable.rb
 - lib/dsu/support/field_errors.rb
 - lib/dsu/support/fileable.rb
 - lib/dsu/support/presentable.rb
-- lib/dsu/support/subcommand_help_colorizeable.rb
 - lib/dsu/support/time_comparable.rb
 - lib/dsu/support/time_formatable.rb
 - lib/dsu/support/times_sortable.rb
@@ -247,6 +236,12 @@ files:
 - lib/dsu/views/shared/model_errors.rb
 - lib/dsu/views/shared/success.rb
 - lib/dsu/views/shared/warning.rb
+- lib/locales/en/active_record.yml
+- lib/locales/en/commands.yml
+- lib/locales/en/miscellaneous.yml
+- lib/locales/en/presenters.yml
+- lib/locales/en/services.yml
+- lib/locales/en/subcommands.yml
 - lib/seed_data/themes/cherry.json
 - lib/seed_data/themes/default.json
 - lib/seed_data/themes/lemon.json
@@ -269,7 +264,11 @@ post_install_message: |
   View the dsu README.md here: https://github.com/gangelo/dsu
   View the dsu CHANGELOG.md: https://github.com/gangelo/dsu/blob/main/CHANGELOG.md
 
-  Try a dsu theme by running `dsu theme list` and then `dsu theme use THEME_NAME` where THEME_NAME is the name of the theme you want to try :)
+  Dsu now has a delete command! Try it out by running `dsu delete help`.
+
+  Try a dsu theme by running `dsu theme list` and then `dsu theme use THEME_NAME` where THEME_NAME is the name of the theme you want to try.
+
+  :)
 rdoc_options: []
 require_paths:
 - lib

data/exe/dsu_migrate.rb

@@ -1,43 +0,0 @@
-#!/usr/bin/env ruby
-
-# frozen_string_literal: true
-
-require 'bundler/setup'
-# require 'highline'
-require 'dsu'
-
-# def run_migrations?
-#   puts '***********************************************'
-#   puts '***        Migrations are pending!          ***'
-#   puts '***  This is a pre-release version of dsu.  ***'
-#   puts '***    It is highly recommended you exit    ***'
-#   puts '***           this installation!            ***'
-#   puts '***********************************************'
-#   prompt = 'What do you want to do?' \
-#            "\n  c = Continue (install and run migrations)." \
-#            "\n  x = Exit (recommended)." \
-#            "\n> "
-#   input = HighLine.new.ask(prompt, String) do |question|
-#     question.default = 'x'
-#     question.readline = true
-#     question.in = %w[x c]
-#   end
-#   input == 'c'
-# end
-
-def run_migrations!
-  # return 1 unless run_migrations?
-
-  puts 'Running migrations...'
-  Dsu::Migration::Service.run_migrations!
-  0
-rescue StandardError => e
-  puts "Error running migrations: #{e.message}"
-  1
-end
-
-if Dsu::Migration::Service.run_migrations?
-  exit run_migrations!
-else
-  exit 0
-end

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

@@ -1,108 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'time_mneumonics'
-
-module Dsu
-  module Support
-    module CommandOptions
-      # The purpose of this module is to take a command option that is a string and return a Time object.
-      # The command option is expected to be a time mneumoic.
-      module TimeMneumonic
-        include TimeMneumonics
-
-        module_function
-
-        def time_from_mneumonic(command_option:, relative_time: nil)
-          time_from_mneumonic!(command_option: command_option, relative_time: relative_time)
-        rescue ArgumentError
-          nil
-        end
-
-        # command_option: is expected to me a time mneumonic. If relative_time is NOT nil, all
-        # time mneumonics are relative to relative_time. Otherwise, they are relative to Time.now.
-        # relative_time: is a Time object that is required IF command_option is expected to be
-        # a relative time mneumonic. Otherwise, it is optional.
-        def time_from_mneumonic!(command_option:, relative_time: nil)
-          validate_argument!(command_option: command_option, command_option_name: :command_option)
-          unless relative_time.nil? || relative_time.is_a?(::Time)
-            raise ArgumentError, "relative_time is not a Time object: \"#{relative_time}\""
-          end
-
-          relative_time ||= ::Time.now
-
-          time_for_mneumonic(mneumonic: command_option, relative_time: relative_time)
-        end
-
-        # This method returns true if mneumonic is a valid mneumonic OR
-        # a relative time mneumonic.
-        def time_mneumonic?(mneumonic)
-          mneumonic?(mneumonic) || relative_time_mneumonic?(mneumonic)
-        end
-
-        # This method returns true if mneumonic is a valid relative
-        # time mneumonic.
-        def relative_time_mneumonic?(mneumonic)
-          return false unless mneumonic.is_a?(String)
-
-          mneumonic.match?(RELATIVE_REGEX)
-        end
-
-        # Add private_class_methods here.
-
-        # Returns a Time object from a mneumonic.
-        def time_for_mneumonic(mneumonic:, relative_time:)
-          time = relative_time
-          if today_mneumonic?(mneumonic)
-            time
-          elsif tomorrow_mneumonic?(mneumonic)
-            time.tomorrow
-          elsif yesterday_mneumonic?(mneumonic)
-            time.yesterday
-          elsif relative_time_mneumonic?(mneumonic)
-            relative_time_for(days_from_now: mneumonic, time: time)
-          end
-        end
-
-        def relative_time_for(days_from_now:, time:)
-          days_from_now.to_i.days.from_now(time)
-        end
-
-        # This method returns true if mneumonic is a valid time mneumonic.
-        # This method will return false if mneumonic is an invalid mneumonic
-        # OR if mneumonic is a relative time mneumonic.
-        def mneumonic?(mneumonic)
-          today_mneumonic?(mneumonic) ||
-            tomorrow_mneumonic?(mneumonic) ||
-            yesterday_mneumonic?(mneumonic)
-        end
-
-        def today_mneumonic?(mneumonic)
-          TODAY.include?(mneumonic)
-        end
-
-        def tomorrow_mneumonic?(mneumonic)
-          TOMORROW.include?(mneumonic)
-        end
-
-        def yesterday_mneumonic?(mneumonic)
-          YESERDAY.include?(mneumonic)
-        end
-
-        def validate_argument!(command_option:, command_option_name:)
-          raise ArgumentError, "#{command_option_name} cannot be nil." if command_option.nil?
-          raise ArgumentError, "#{command_option_name} cannot be blank." if command_option.blank?
-          unless command_option.is_a?(String)
-            raise ArgumentError, "#{command_option_name} must be a String: \"#{command_option}\""
-          end
-          unless time_mneumonic?(command_option)
-            raise ArgumentError, "#{command_option_name} is an invalid mneumonic: \"#{command_option}\"."
-          end
-        end
-
-        private_class_method :time_for_mneumonic, :relative_time_for,
-          :mneumonic?, :today_mneumonic?, :tomorrow_mneumonic?,
-          :yesterday_mneumonic?, :validate_argument!
-      end
-    end
-  end
-end

data/lib/dsu/support/subcommand_help_colorizeable.rb

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../models/color_theme'
-require_relative '../support/color_themable'
-
-module Dsu
-  module Support
-    module SubcommandHelpColorizable
-      class << self
-        def included(base)
-          base.extend(ClassMethods)
-        end
-
-        module ClassMethods
-          def command_help(shell, subcommand = false) # rubocop:disable Style/OptionalBooleanParameter
-            help_text = Services::StdoutRedirectorService.call { super }
-            puts apply_theme(help_text, theme_color: color_theme.help)
-          end
-
-          def color_theme
-            @color_theme ||= Models::ColorTheme.current_or_default
-          end
-        end
-      end
-    end
-  end
-end