dsu 0.1.0.alpha.3 → 0.1.0.alpha.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: abbd29418f4cd3c86a0e826ed9a43d7aba9e11d455c1fcd34024eeb6f1cff0b2
-  data.tar.gz: e99710491e91d8302582bec2e201244616a126d509e8915c57a5b13e54581418
+  metadata.gz: d8563782a0b4d22e374313aa3373b38e62dec995a6f6d996eaa5fa9c58b0d1cb
+  data.tar.gz: 65ebebe762dac44300a6d163c03275eaffd66018a83f9836b3f12cb6333569ad
 SHA512:
-  metadata.gz: 46bb2a7b817f6dcc413dbf343598dd9c016752eb84657f7b47c0bb19a923618c0e7ef0dc0e59f2a410808537ead6b26f2e647faabe93932c931cf1040be63acb
-  data.tar.gz: 348649411b52ed829e640e7c1e5a7d00c6df99bbaa80051a9f98176d34a0c078db4de035ba2a8137bb3295a57e5a500f223a3c7f7c7bf2868356bc226933467c
+  metadata.gz: a412bf735ce124b6df3bb419a1ed925b6b9aaf6cc7e8fdb13773fd883886119d92c03cb4bc68633d57bcfd293c274db16d5504200790f9be65d5d3d3f3e5e21e
+  data.tar.gz: bf7ac4a28753385155d6e0cd7f1694723deaa3ad0d0e41205f63446c78a2a8b0b09d42f4e5557d3c3aef4befa8a6d46e568d308a1d9fb6c9a0f4110d301c025d

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## [0.1.0.alpha.5] - 2023-05-12
+* Changes
+  - `dsu edit SUBCOMMAND` will now allow editing of an entry group for a date that does not yet exist. This will allow you to add entries in the editor using `+|a|add DESCRIPTION`. Be sure to follow the instructions in the editor when editing entry group entries.
+  - `dsu edit SUBCOMMAND` will gracefully display an error if the entry sha (Entry#uuid) or entry discription (Entry#description) are not unique. In this case, the entry will not be added to the entry group.
+  NOTE: Not all edge cases are being handled currently by `dsu edit SUBCOMMAND`.
+  - `dsu add OPTION` will raise an error if the entry discription (Entry#description) are not unique. This will be handled gracefully in a future release.
+## [0.1.0.alpha.4] - 2023-05-09
+* Changes
+  - Gemfile gemspec description changes.
 ## [0.1.0.alpha.3] - 2023-05-09
 * Changes
   - Entry groups are now editable using the `dsu edit SUBCOMMAND` command. See the README.md or `dsu help edit` for more information.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    dsu (0.1.0.alpha.3)
+    dsu (0.1.0.alpha.5)
       activesupport (~> 7.0, >= 7.0.4)
       colorize (~> 0.8.1)
       deco_lite (~> 1.3)

data/README.md

@@ -11,7 +11,7 @@
 
 **NOTE:** This gem is in development (alpha version). Please see the [WIP Notes](#wip-notes) section for current `dsu` features.
 
-## Quick Start
+## Help
 
 After installation (`gem install dsu`), the first thing you may want to do is run the `dsu` help:
 ### Displaying Help
@@ -19,7 +19,7 @@ After installation (`gem install dsu`), the first thing you may want to do is ru
 ```shell
 #=>
 Commands:
-  dsu add, -a [OPTIONS] DESCRIPTION  # Adds a DSU entry having DESCRIPTION to the date associated with the given OPTION
+  dsu add, -a [OPTIONS] DESCRIPTION  # Adds a DSU entry...
   dsu config, -c SUBCOMMAND          # Manage configuration...
   dsu edit, -e SUBCOMMAND            # Edit DSU entries...
   dsu help [COMMAND]                 # Describe available...
@@ -32,32 +32,33 @@ Options:
 
 The next thing you may want to do is `add` some DSU activities (entries) for a particular day:
 
-### Adding DSU Entries
+## Adding DSU Entries
 `dsu add [OPTIONS] DESCRIPTION`
 
-Adding DSU entry using this command will _add_ the DSU entry for the given day (or date, `-d`), and also _display_ the given day's (or date's, `-d`) DSU entries, as well as the DSU entries for the previous day relative to the given day or date (`-d`).
+Adding DSU entry using this command will _add_ the DSU entry for the given day (or date, `-d`), and also _display_ the given day's (or date's, `-d`) DSU entries, as well as the DSU entries for the previous day relative to the given day or date (`-d`). *NOTE: You cannot add duplicate entry group entries; that is, the entry DESCRIPTION needs to be unique within an entry group.*
 
-#### Today
-If you need to add a DSU entry to the current day (today), you can use the `-t, [--today]` option. Today (`-t`) is the default; therefore, the `-t` flag is optional when adding DSU entries for the current day:
+### Today
+If you need to add a DSU entry to the current day (today), you can use the `-n`|`--today` option. Today (`-n`) is the default; therefore, the `-n` flag is optional when adding DSU entries for the current day:
 
-`$ dsu add [-t] "Pair with John on ticket IN-12345"`
+`$ dsu add -n|-today "Pair with John on ticket IN-12345"`
 
-#### Yesterday
-If for some reason you need to add a DSU entry for the previous day, you can use the `-p, [--previous-day]` option:
+### Yesterday
+If for some reason you need to add a DSU entry for yesterday, you can use the `-y`| `--yesterday` option:
 
-`$ dsu add -p "Pick up ticket IN-12345"`
+`$ dsu add -y|--yesterday "Pick up ticket IN-12345"`
 
-#### Tomorrow
-If you need to add a DSU entry for the previous day, you can use the `-n, [--next-day]` option:
+### Tomorrow
+If you need to add a DSU entry for tomorrow, you can use the `-t`|`--tomorrow` option:
 
-`$ dsu add -n "Pick up ticket IN-12345"`
+`$ dsu add -t|--tomorrow "Pick up ticket IN-12345"`
 
-#### Miscellaneous Date
-If you need to add a DSU entry for a date other than yesterday, today or tomorrow, you can use the `-d, [--date=DATE]` option, where DATE is any date string that can be parsed using `Time.parse`. For example: `require 'time'; Time.parse("2023-01-01")`:
+### Miscellaneous Date
 
 `$ dsu add -d "2022-12-31" "Attend company New Years Coffee Meet & Greet"`
 
-### Displaying DSU Entries
+See the [Dates](#dates) section for more information on acceptable DATE formats used by `dsu`.
+
+## Displaying DSU Entries
 You can display DSU entries for a particular day or date (`date`) using any of the following commands. When displaying DSU entries for a particular day or date (`date`), `dsu` will display the given day or date's (`date`) DSU entries, as well as the DSU entries for the _previous_ day, relative to the given day or date. If the date or day you are trying to view falls on a weekend or Monday, `dsu` will display back to, and including the weekend and previous Friday inclusive; this is so that you can share what you did over the weekend (if anything) and the previous Friday at your DSU:
 
 - `$ dsu list today|n`
@@ -65,7 +66,7 @@ You can display DSU entries for a particular day or date (`date`) using any of t
 - `$ dsu list yesterday|y`
 - `$ dsu list date|d DATE`
 
-#### Examples
+### Examples
 The following displays the entries for "Today", where `Time.now == '2023-05-06 08:54:57.6861 -0400'`
 
 `$ dsu list today`
@@ -82,7 +83,7 @@ Friday, (Yesterday) 2023-05-05
 
 `$ dsu list date "2023-05-06"`
 
-Where DATE 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 thee 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('2023-01-02'); Time.parse('1/2') # etc.`:
+See the [Dates](#dates) section for more information on acceptable DATE formats used by `dsu`.
 
 ```shell
 #=>
@@ -94,9 +95,9 @@ Friday, (Yesterday) 2023-05-05
   1. edc25a9a Pick up ticket IN-12345
   2. f7d3018c Attend new hire meet & greet
 ```
-### Editing DSU Entries
+## Editing DSU Entries
 
-You can edit DSU entry groups by date. `dsu` will allow you to edit a DSU entry group using the `dsu edit SUBCOMMAND` date (today|tomorrow|yesterday|date DATE) you specify. `dsu edit` will open your DSU entry group entries in your editor, where you'll be able to perform editing functions against one or all of the entries.
+You can edit DSU entry groups by date. `dsu` will allow you to edit a DSU entry group using the `dsu edit SUBCOMMAND` date (today|tomorrow|yesterday|date DATE) you specify. `dsu edit` will open your DSU entry group entries in your editor, where you'll be able to perform editing functions against one or all of the entries. If no entries exist in the entry group, you can add entries using any of the the *add* (`+|a|add`) editor commands, followed by the entry description. *NOTE: you cannot add duplicate entries; that is, the entry SHA and DESCRIPTION need to be unique within an entry group. Non-unique entries will not be added to the entry group.*
 
 Note: See the "[Customizing the `dsu` Configuration File](#customizing-the-dsu-configuration-file)"" section to configure `dsu` to use the editor of your choice.
 
@@ -105,7 +106,7 @@ Note: See the "[Customizing the `dsu` Configuration File](#customizing-the-dsu-c
 - `$ dsu edit yesterday|y`
 - `$ dsu edit date|d DATE`
 
-#### Examples
+### Examples
 
 The following will edit your DSU entry group entries for "Today", where `Time.now == '2023-05-09 12:13:45.8273 -0400'`. Simply follow the directions in the editor file, then save and close your editor to apply the changes:
 
@@ -133,7 +134,7 @@ The following will edit your DSU entry group entries for "Today", where `Time.no
 # *** When you are done, save and close your editor ***
 ```
 
-##### Edit an Entry
+#### Edit an Entry
 
 Simply change the entry descripton text.
 
@@ -143,7 +144,7 @@ from: 3849f0c0 Interative planning meeting 11:00AM.
   to: 3849f0c0 Interative planning meeting 12:00AM.
 ```
 
-##### Add an Entry
+#### Add an Entry
 
 Replace the entry `sha` one of the add commands: `[+|a|add]`.
 
@@ -152,7 +153,7 @@ For example...
 + Add me to this entry group.
 ```
 
-##### Delete an Entry
+#### Delete an Entry
 
 Simply delete the entry or replace the entry `sha` one of the delete commands: `[-|d|delete]`.
 
@@ -167,7 +168,7 @@ from: 3849f0c0 Interative planning meeting 11:00AM.
   to: - Interative planning meeting 11:00AM.
 ```
 
-##### Reorder Entries
+#### Reorder Entries
 
 Simply reorder the entries in the editor.
 
@@ -183,11 +184,11 @@ from: 3849f0c0 Interative planning meeting 11:00AM.
       3849f0c0 Interative planning meeting 11:00AM.
 ```
 
-### Customizing the `dsu` Configuration File
+## Customizing the `dsu` Configuration File
 
 It is **not** recommended that you create and customize a `dsu` configuration file while this gem is in alpha release. This is because changes to what configuration options are available may take place while in alpha that could break `dsu`. If you *do* want to create and customize the `dsu` configuration file reglardless, you may do the following.
 
-#### Initializing/Customizing the `dsu` Configuration File
+### Initializing/Customizing the `dsu` Configuration File
 
 ```shell
 # Creates a dsu configuration file in your home folder.
@@ -207,25 +208,26 @@ Where `<whoami>` would be your username (`$ whoami` on nix systems)
 
 Once the configuration file is created, you can locate where the `dsu` configuration file is located by running `$ dsu config info` and taking note of the confiruration file path. You may then edit this file using your favorite editor.
 
-##### Configuration File Options
-###### editor
+#### Configuration File Options
+
+##### editor
 This is the default editor to use when editing entry groups if the EDITOR environment variable on your system is not set.
 
 Default: `nano` (you'll need to change the default editor on Windows systems)
 
-###### entries_display_order
+##### entries_display_order
 Valid values are 'asc' and 'desc', and will sort listed DSU entries in ascending or descending order respectfully, by day.
 
 Default: `'desc'`
 
-###### entries_file_name
+##### 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
+##### 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.
@@ -234,9 +236,18 @@ Default: `'/Users/<whoami>/dsu/entries'` on nix systems.
 
 Where `<whoami>` would be your username (`$ whoami` on nix systems)
 
+## Dates
+
+These notes apply to anywhere DATE is used...
+
+DATE 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('2023-01-02'); Time.parse('1/2') # etc.`
+
 ## WIP Notes
 This gem is in development (alpha release).
 
+- Not all edge cases are being handled currently by `dsu edit SUBCOMMAND`.
+- `dsu add OPTION` will raise an error if the entry discription (Entry#description) are not unique. This will be handled gracefully in a future release.
+
 ## Installation
 
     $ gem install dsu

data/lib/dsu/models/entry.rb

@@ -2,12 +2,17 @@
 
 require 'deco_lite'
 require 'securerandom'
+require_relative '../support/descriptable'
 
 module Dsu
   module Models
     class Entry < DecoLite::Model
+      include Support::Descriptable
+
+      ENTRY_UUID_REGEX = /\A[0-9a-f]{8}\z/i
+
       validates :uuid, presence: true, format: {
-        with: /\A[0-9a-f]{8}\z/i,
+        with: ENTRY_UUID_REGEX,
         message: 'is the wrong format. ' \
                  '0-9, a-f, and 8 characters were expected.' \
       }

data/lib/dsu/models/entry_group.rb

@@ -1,17 +1,21 @@
 # frozen_string_literal: true
 
 require 'deco_lite'
-require_relative '../support/entry_group_loadable'
+require_relative '../services/entry_group_editor_service'
 require_relative '../services/entry_group_deleter_service'
 require_relative '../services/entry_group_reader_service'
 require_relative '../services/entry_group_writer_service'
+require_relative '../support/entry_group_loadable'
+require_relative '../support/time_formatable'
 require_relative '../validators/entries_validator'
 require_relative '../validators/time_validator'
+require_relative 'entry'
 
 module Dsu
   module Models
     class EntryGroup < DecoLite::Model
       extend Support::EntryGroupLoadable
+      include Support::TimeFormatable
 
       validates_with Validators::EntriesValidator, fields: [:entries]
       validates_with Validators::TimeValidator, fields: [:time]
@@ -36,6 +40,16 @@ module Dsu
           Services::EntryGroupDeleterService.new(time: time, options: options).call
         end
 
+        def edit(time:, options: {})
+          # NOTE: Uncomment this line to prohibit edits on
+          # Entry Groups that do not exist (i.e. have no entries).
+          # return new(time: time) unless exists?(time: time)
+
+          load(time: time).tap do |entry_group|
+            entry_group.edit(options: options)
+          end
+        end
+
         def exists?(time:)
           Dsu::Services::EntryGroupReaderService.entry_group_file_exists?(time: time)
         end
@@ -53,15 +67,18 @@ module Dsu
           entry_group_hash = entry_group_hash_for(time: time)
           hydrate_entry_group_hash(entry_group_hash: entry_group_hash, time: time)
         end
+
+        def unique?(entry:)
+
+        end
       end
 
       def required_fields
         %i[time entries]
       end
 
-      def save!
-        validate!
-        Services::EntryGroupWriterService.new(entry_group: self).call
+      def edit(options: {})
+        Services::EntryGroupEditorService.new(entry_group: self, options: options).call
         self
       end
 
@@ -71,6 +88,15 @@ module Dsu
         self
       end
 
+      def entries?
+        entries.any?
+      end
+
+      def save!
+        validate!
+        Services::EntryGroupWriterService.new(entry_group: self).call
+      end
+
       def to_h
         super.tap do |hash|
           hash[:entries] = hash[:entries].dup
@@ -80,10 +106,67 @@ module Dsu
         end
       end
 
-      def to_h_localized
-        to_h.tap do |hash|
-          hash[:time] = hash[:time].localtime
+      def check_unique(sha_or_editor_command:, description:)
+        raise ArgumentError, 'sha_or_editor_command is nil' if sha_or_editor_command.nil?
+        raise ArgumentError, 'description is nil' if description.nil?
+        raise ArgumentError, 'sha_or_editor_command is the wrong object type' unless sha_or_editor_command.is_a?(String)
+        raise ArgumentError, 'description is the wrong object type' unless description.is_a?(String)
+
+        if entries.blank?
+          entry_unique_hash = entry_unique_hash_for(uuid_unique: true, description_unique: true)
+          return entry_unique_struct_from(entry_unique_hash: entry_unique_hash)
         end
+
+        entry_hash = entries.each_with_object({}) do |entry_group_entry, hash|
+          hash[entry_group_entry.uuid] = entry_group_entry.description
+        end
+
+        # It is possible that sha_or_editor_command may have an editor command (e.g. +|a|add). If this
+        # is the case, just treat it as unique because when the entry is added, it will get a unique uuid.
+        uuid_unique = !sha_or_editor_command.match?(Entry::ENTRY_UUID_REGEX) || !entry_hash.key?(sha_or_editor_command)
+        entry_unique_hash = entry_unique_hash_for(
+          uuid: sha_or_editor_command,
+          uuid_unique: uuid_unique,
+          description: description,
+          description_unique: !entry_hash.value?(description)
+        )
+        entry_unique_struct_from(entry_unique_hash: entry_unique_hash)
+      end
+
+      def entry_unique_hash_for(uuid_unique:, description_unique:, uuid: nil, description: nil)
+        {
+          uuid: uuid,
+          uuid_unique: uuid_unique,
+          description: description,
+          description_unique: description_unique,
+          formatted_time: Support::TimeFormatable.formatted_time(time: time)
+        }
+      end
+
+      def entry_unique_struct_from(entry_unique_hash:)
+        Struct.new(*entry_unique_hash.keys, keyword_init: true) do
+          def unique?
+            uuid_unique? && description_unique?
+          end
+
+          def uuid_unique?
+            uuid_unique
+          end
+
+          def description_unique?
+            description_unique
+          end
+
+          def messages
+            return [] if unique?
+
+            short_description = Models::Entry.short_description(string: description)
+
+            messages = []
+            messages << "#uuid is not unique: \"#{uuid} #{short_description}\"" unless uuid_unique?
+            messages << "#description is not unique: \"#{uuid} #{short_description}\""
+          end
+        end.new(**entry_unique_hash)
       end
     end
   end

data/lib/dsu/services/configuration_loader_service.rb

@@ -9,8 +9,6 @@ module Dsu
     class ConfigurationLoaderService
       include Dsu::Support::Configuration
 
-      attr_reader :default_options
-
       def initialize(default_options: nil)
         unless default_options.nil? ||
                default_options.is_a?(Hash) ||
@@ -18,7 +16,7 @@ module Dsu
           raise ArgumentError, 'default_options must be a Hash or ActiveSupport::HashWithIndifferentAccess'
         end
 
-        @default_options ||= default_options || {}
+        @default_options = default_options || {}
         @default_options = @default_options.with_indifferent_access if @default_options.is_a?(Hash)
       end
 
@@ -28,6 +26,8 @@ module Dsu
 
       private
 
+      attr_reader :default_options
+
       def config_options
         return Support::Configuration::DEFAULT_DSU_OPTIONS unless config_file?
 

data/lib/dsu/services/entry_group_editor_service.rb

@@ -0,0 +1,148 @@
+# frozen_string_literal: true
+
+require_relative '../models/entry'
+require_relative '../support/colorable'
+require_relative '../support/say'
+require_relative '../support/time_formatable'
+require_relative 'configuration_loader_service'
+
+module Dsu
+  module Services
+    class EntryGroupEditorService
+      include Support::Colorable
+      include Support::Say
+      include Support::TimeFormatable
+
+      def initialize(entry_group:, options: {})
+        raise ArgumentError, 'entry_group is nil' if entry_group.nil?
+        raise ArgumentError, 'entry_group is the wrong object type' unless entry_group.is_a?(Models::EntryGroup)
+        raise ArgumentError, 'options is the wrong object type' unless options.is_a?(Hash) || options.nil?
+
+        @entry_group = entry_group
+        @options = options || {}
+      end
+
+      def call
+        edit_view = render_edit_view
+        edit!(edit_view: edit_view)
+        # NOTE: Return the original entry group object as any permanent changes
+        # will have been applied to it.
+        entry_group
+      end
+
+      private
+
+      attr_reader :entry_group, :options
+
+      # 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
+        say "Editing entry group #{formatted_time(time: entry_group.time)}...", HIGHLIGHT
+        capture_stdxxx { Views::EntryGroup::Edit.new(entry_group: entry_group).render }
+      end
+
+      # Writes the temporary file contents to disk and opens it in the editor.
+      def edit!(edit_view:)
+        Services::TempFileWriterService.new(tmp_file_content: edit_view).call do |tmp_file_path|
+          unless Kernel.system("${EDITOR:-#{configuration[:editor]}} #{tmp_file_path}")
+            say "Failed to open temporary file in editor '#{configuration[:editor]}';" \
+                "the system error returned was: '#{$CHILD_STATUS}'.", ERROR
+            say 'Either set the EDITOR environment variable ' \
+                'or set the dsu editor configuration option (`$ dsu config init`).', ERROR
+            say 'Run `$ dsu help config` for more information.', ERROR
+
+            system('dsu help config')
+
+            return # rubocop:disable Lint/NonLocalExitFromIterator: This is not an iterator.
+          end
+
+          update_entry_group!(tmp_file_path: tmp_file_path)
+        end
+      end
+
+      # TODO: Clean this up
+      def update_entry_group!(tmp_file_path:)
+        errors = []
+        entry_group.entries = entries = []
+        Services::TempFileReaderService.new(tmp_file_path: tmp_file_path).call do |tmp_file_line|
+          next if comment_or_empty?(tmp_file_line: tmp_file_line)
+
+          entry_info = editor_entry_info_from(tmp_file_line: tmp_file_line)
+          next if entry_info.empty?
+          next if delete_entry_cmd?(sha: entry_info[:sha])
+          next unless add_entry_cmd?(sha: entry_info[:sha]) || sha?(sha: entry_info[:sha])
+
+          entry_info[:sha_or_editor_command] = entry_info[:sha]
+          entry_info[:sha] = nil if add_entry_cmd?(sha: entry_info[:sha])
+
+          entry = Models::Entry.new(uuid: entry_info[:sha], description: entry_info[:description])
+          entry_group.check_unique(sha_or_editor_command: entry_info[:sha_or_editor_command],
+            description: entry_info[:description]).tap do |status|
+            entries << entry and next if status.unique?
+
+            errors << status.messages
+          end
+        end
+
+        # Display any errors encountered.
+        if errors.any?
+          say 'Error: one or more entry values were not unique within the entry group entries:', ERROR
+          errors.flatten.each { |message| say "Error: #{message}", ERROR }
+        end
+
+        # Save or delete any entries.
+        entry_group.entries = entries
+        entry_group.delete and return unless entry_group.entries?
+
+        entry_group.save!
+      end
+
+      def sha?(sha:)
+        sha.match?(Models::Entry::ENTRY_UUID_REGEX)
+      end
+
+      def delete_entry_cmd?(sha:)
+        %w[- d delete].include?(sha)
+      end
+
+      def add_entry_cmd?(sha:)
+        %w[+ a add].include?(sha)
+      end
+
+      def comment_or_empty?(tmp_file_line:)
+        ['#', nil].include? tmp_file_line[0]
+      end
+
+      def editor_entry_info_from(tmp_file_line:)
+        match_data = tmp_file_line.match(/(\S+)\s(.+)/)
+        {
+          sha: match_data[1]&.strip,
+          description: match_data[2]&.strip
+        }
+      rescue StandardError
+        {}
+      end
+
+      # TODO: Add this to a module.
+      # https://stackoverflow.com/questions/4459330/how-do-i-temporarily-redirect-stderr-in-ruby/4459463#4459463
+      def capture_stdxxx
+        # The output stream must be an IO-like object. In this case we capture it in
+        # an in-memory IO object so we can return the string value. You can assign any
+        # IO object here.
+        string_io = StringIO.new
+        prev_stdout, $stdout = $stdout, string_io # rubocop:disable Style/ParallelAssignment
+        prev_stderr, $stderr = $stderr, string_io # rubocop:disable Style/ParallelAssignment
+        yield
+        string_io.string
+      ensure
+        # Restore the previous value of stderr and stdout (typically equal to STDERR).
+        $stdout = prev_stdout
+        $stderr = prev_stderr
+      end
+
+      def configuration
+        @configuration ||= ConfigurationLoaderService.new.call
+      end
+    end
+  end
+end

data/lib/dsu/services/entry_group_writer_service.rb

@@ -26,6 +26,7 @@ module Dsu
         entry_group.validate!
         create_entry_group_path_if!
         write_entry_group_to_file!
+        entry_group
       rescue ActiveModel::ValidationError
         puts "Error(s) encountered: #{entry_group.errors.full_messages}"
         raise

data/lib/dsu/services/temp_file_reader_service.rb

@@ -3,29 +3,29 @@
 module Dsu
   module Services
     class TempFileReaderService
-      def initialize(temp_file_path:, options: {})
-        raise ArgumentError, 'temp_file_path is nil' if temp_file_path.nil?
-        raise ArgumentError, 'temp_file_path is the wrong object type' unless temp_file_path.is_a?(String)
-        raise ArgumentError, 'temp_file_path is empty' if temp_file_path.empty?
-        raise ArgumentError, 'temp_file_path does not exist' unless File.exist?(temp_file_path)
+      def initialize(tmp_file_path:, options: {})
+        raise ArgumentError, 'tmp_file_path is nil' if tmp_file_path.nil?
+        raise ArgumentError, 'tmp_file_path is the wrong object type' unless tmp_file_path.is_a?(String)
+        raise ArgumentError, 'tmp_file_path is empty' if tmp_file_path.empty?
+        raise ArgumentError, 'tmp_file_path does not exist' unless File.exist?(tmp_file_path)
         raise ArgumentError, 'options is nil' if options.nil?
         raise ArgumentError, 'options is the wrong object type' unless options.is_a?(Hash)
 
-        @temp_file_path = temp_file_path
+        @tmp_file_path = tmp_file_path
         @options = options || {}
       end
 
       def call
         raise ArgumentError, 'no block given' unless block_given?
 
-        File.foreach(temp_file_path) do |line|
+        File.foreach(tmp_file_path) do |line|
           yield line.strip
         end
       end
 
       private
 
-      attr_reader :temp_file_path, :options
+      attr_reader :tmp_file_path, :options
     end
   end
 end

data/lib/dsu/services/temp_file_writer_service.rb

@@ -5,13 +5,13 @@ require 'tempfile'
 module Dsu
   module Services
     class TempFileWriterService
-      def initialize(temp_file_content:, options: {})
-        raise ArgumentError, 'temp_file_content is nil' if temp_file_content.nil?
-        raise ArgumentError, 'temp_file_content is the wrong object type' unless temp_file_content.is_a?(String)
+      def initialize(tmp_file_content:, options: {})
+        raise ArgumentError, 'tmp_file_content is nil' if tmp_file_content.nil?
+        raise ArgumentError, 'tmp_file_content is the wrong object type' unless tmp_file_content.is_a?(String)
         raise ArgumentError, 'options is nil' if options.nil?
         raise ArgumentError, 'options is the wrong object type' unless options.is_a?(Hash)
 
-        @temp_file_content = temp_file_content
+        @tmp_file_content = tmp_file_content
         @options = options || {}
       end
 
@@ -19,7 +19,7 @@ module Dsu
         raise ArgumentError, 'no block given' unless block_given?
 
         Tempfile.new('dsu').tap do |file|
-          file.write("#{temp_file_content}\n")
+          file.write("#{tmp_file_content}\n")
           file.close
           yield file.path
         end.unlink
@@ -27,7 +27,7 @@ module Dsu
 
       private
 
-      attr_reader :temp_file_content, :options
+      attr_reader :tmp_file_content, :options
     end
   end
 end

data/lib/dsu/subcommands/edit.rb

@@ -1,19 +1,12 @@
 # frozen_string_literal: true
 
-require 'English'
 require_relative '../base_cli'
 require_relative '../models/entry_group'
-require_relative '../services/temp_file_reader_service'
-require_relative '../services/temp_file_writer_service'
-require_relative '../support/time_formatable'
-require_relative '../views/entry_group/edit'
 require_relative '../views/entry_group/show'
 
 module Dsu
   module Subcommands
     class Edit < Dsu::BaseCLI
-      include Support::TimeFormatable
-
       map %w[d] => :date
       map %w[n] => :today
       map %w[t] => :tomorrow
@@ -25,7 +18,8 @@ module Dsu
        Edits the DSU entries for today.
       LONG_DESC
       def today
-        Views::EntryGroup::Show.new(entry_group: edit_entry_group(time: Time.now)).render
+        entry_group = Models::EntryGroup.edit(time: Time.now)
+        Views::EntryGroup::Show.new(entry_group: entry_group).render
       end
 
       desc 'tomorrow, t',
@@ -34,7 +28,8 @@ module Dsu
         Edits the DSU entries for tomorrow.
       LONG_DESC
       def tomorrow
-        Views::EntryGroup::Show.new(entry_group: edit_entry_group(time: Time.now.tomorrow)).render
+        entry_group = Models::EntryGroup.edit(time: Time.now.tomorrow)
+        Views::EntryGroup::Show.new(entry_group: entry_group).render
       end
 
       desc 'yesterday, y',
@@ -43,7 +38,8 @@ module Dsu
         Edits the DSU entries for yesterday.
       LONG_DESC
       def yesterday
-        Views::EntryGroup::Show.new(entry_group: edit_entry_group(time: Time.now.yesterday)).render
+        entry_group = Models::EntryGroup.edit(time: Time.now.yesterday)
+        Views::EntryGroup::Show.new(entry_group: entry_group).render
       end
 
       desc 'date, d DATE',
@@ -54,79 +50,12 @@ module Dsu
         \x5 #{date_option_description}
       LONG_DESC
       def date(date)
-        Views::EntryGroup::Show.new(entry_group: edit_entry_group(time: Time.parse(date))).render
+        entry_group = Models::EntryGroup.edit(time: Time.parse(date))
+        Views::EntryGroup::Show.new(entry_group: entry_group).render
       rescue ArgumentError => e
         say "Error: #{e.message}", ERROR
         exit 1
       end
-
-      private
-
-      def edit_entry_group(time:)
-        formatted_time = formatted_time(time: time)
-        unless Models::EntryGroup.exists?(time: time)
-          say "No DSU entries exist for #{formatted_time}"
-          exit 1
-        end
-
-        say "Editing DSU entries for #{formatted_time}..."
-        entry_group = Models::EntryGroup.load(time: time)
-
-        # This renders the view to a string...
-        output = capture_stdxxx do
-          Views::EntryGroup::Edit.new(entry_group: entry_group).render
-        end
-        # ...which is then written to a temp file.
-        Services::TempFileWriterService.new(temp_file_content: output).call do |temp_file_path|
-          unless system("${EDITOR:-#{configuration[:editor]}} #{temp_file_path}")
-            say "Failed to open temporary file in editor '#{configuration[:editor]}';" \
-                "the system error returned was: '#{$CHILD_STATUS}'.", ERROR
-            say 'Either set the EDITOR environment variable ' \
-                'or set the dsu editor configuration option (`$ dsu config init`).', ERROR
-            say 'Run `$ dsu help config` for more information.', ERROR
-            system('dsu help config')
-            exit 1
-          end
-          entries = []
-          Services::TempFileReaderService.new(temp_file_path: temp_file_path).call do |temp_file_line|
-            # Skip comments and blank lines.
-            next if ['#', nil].include? temp_file_line[0]
-
-            match_data = temp_file_line.match(/(\S+)\s(.+)/)
-            # TODO: Error handling if match_data is nil.
-            entry_sha = match_data[1]
-            entry_description = match_data[2]
-
-            next if %w[- d delete].include?(entry_sha) # delete the entry
-
-            entry_sha = nil if %w[+ a add].include?(entry_sha) # add the new entry
-            entries << Models::Entry.new(uuid: entry_sha, description: entry_description)
-          end
-
-          entry_group.entries = entries
-
-          return entry_group.delete if entries.empty?
-
-          entry_group.save!
-        end
-        entry_group
-      end
-
-      # https://stackoverflow.com/questions/4459330/how-do-i-temporarily-redirect-stderr-in-ruby/4459463#4459463
-      def capture_stdxxx
-        # The output stream must be an IO-like object. In this case we capture it in
-        # an in-memory IO object so we can return the string value. You can assign any
-        # IO object here.
-        string_io = StringIO.new
-        prev_stdout, $stdout = $stdout, string_io # rubocop:disable Style/ParallelAssignment
-        prev_stderr, $stderr = $stderr, string_io # rubocop:disable Style/ParallelAssignment
-        yield
-        string_io.string
-      ensure
-        # Restore the previous value of stderr and stdout (typically equal to STDERR).
-        $stdout = prev_stdout
-        $stderr = prev_stderr
-      end
     end
   end
 end

data/lib/dsu/support/descriptable.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Dsu
+  module Support
+    module Descriptable
+      class << self
+        def included(mod)
+          mod.extend(ClassMethods)
+        end
+      end
+
+      def short_description
+        return '' if description.blank?
+
+        self.class.short_description(string: description)
+      end
+
+      module ClassMethods
+        def short_description(string:, count: 25, elipsis: '...')
+          return elipsis unless string.is_a?(String)
+
+          elipsis_length = elipsis.length
+          count = elipsis_length if count.nil? || count < elipsis_length
+
+          return string if string.length <= count
+
+          tokens = string.split
+          string = ''
+
+          return "#{tokens.first[0..(count - elipsis_length)]}#{elipsis}" if tokens.count == 1
+
+          tokens.each do |token|
+            break if string.length + token.length + elipsis_length > count
+
+            string = "#{string} #{token}"
+          end
+
+          "#{string.strip}#{elipsis}"
+        end
+      end
+    end
+  end
+end

data/lib/dsu/validators/entries_validator.rb

@@ -24,7 +24,8 @@ module Dsu
           end
 
           validate_entry_types field, entries, record
-          validate_unique_entry_uuids field, entries, record
+          validate_unique_entry_attr :uuid, field, entries, record
+          validate_unique_entry_attr :description, field, entries, record
         end
       end
 
@@ -42,17 +43,17 @@ module Dsu
         end
       end
 
-      def validate_unique_entry_uuids(field, entries, record)
+      def validate_unique_entry_attr(attr, field, entries, record)
         return unless entries.is_a? Array
 
         entry_objects = entries.select { |entry| entry.is_a?(Dsu::Models::Entry) }
 
-        uuids = entry_objects.map(&:uuid)
-        return if uuids.uniq.length == uuids.length
+        attrs = entry_objects.map(&attr)
+        return if attrs.uniq.length == attrs.length
 
-        non_unique_uuids = uuids.select { |element| uuids.count(element) > 1 }.uniq
-        if non_unique_uuids.any?
-          record.errors.add(field, "contains duplicate UUIDs: #{non_unique_uuids.join(', ')}.",
+        non_unique_attrs = attrs.select { |attr| attrs.count(attr) > 1 }.uniq # rubocop:disable Lint/ShadowingOuterLocalVariable
+        if non_unique_attrs.any?
+          record.errors.add(field, "contains duplicate ##{attr}s: #{non_unique_attrs.join(', ')}.",
             type: Dsu::Support::FieldErrors::FIELD_DUPLICATE_ERROR)
         end
       end

data/lib/dsu/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Dsu
-  VERSION = '0.1.0.alpha.3'
+  VERSION = '0.1.0.alpha.5'
 end

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

@@ -42,13 +42,15 @@ module Dsu
 
         def render_entry_group!
           say "# Editing DSU Entries for #{formatted_time(time: entry_group.time)}"
-          say('(no entries available for this day)') and return if entry_group.entries.empty?
-
+          # TODO: Display entry group entries from the previous DSU date so they can be
+          # easily copied over; or, add them to the current entry group entries below as
+          # a "# [+|a|add] <entry group from previous DSU entry description>" (e.g. commented
+          # out) by default?
           say ''
           say '# [SHA/COMMAND] [DESCRIPTION]'
 
           entry_group.entries.each do |entry|
-            say "#{entry.uuid} #{entry.description}"
+            say "#{entry.uuid} #{entry.description.strip}"
           end
 
           say ''

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

@@ -26,13 +26,7 @@ module Dsu
         end
 
         def call
-          # Just in case the entry group is invalid, we'll
-          # validate it before displaying it.
-          entry_group.validate!
           render_entry_group!
-        rescue ActiveModel::ValidationError
-          puts "Error(s) encountered: #{entry_group.errors.full_messages}"
-          raise
         end
         alias render call
 
@@ -47,7 +41,9 @@ module Dsu
           entry_group.entries.each_with_index do |entry, index|
             prefix = "#{format('%03s', index + 1)}. #{entry.uuid}"
             description = colorize_string(string: entry.description, mode: :bold)
-            say "#{prefix} #{description}"
+            entry_info = "#{prefix} #{description}"
+            entry_info = "#{entry_info} (validation failed)" unless entry.valid?
+            say entry_info
           end
         end
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dsu
 version: !ruby/object:Gem::Version
-  version: 0.1.0.alpha.3
+  version: 0.1.0.alpha.5
 platform: ruby
 authors:
 - Gene M. Angelo, Jr.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-05-09 00:00:00.000000000 Z
+date: 2023-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -112,12 +112,18 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
-description: |2
-      dsu is little 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) noteworthy activities that you performed during your day. During your DSU, you can then easily recall and share these these activities with your team. Activities are grouped by day and can be viewed in simple text format from the command line. When viewing a particular day, dsu will automatically display the previous day's activities as well. This is useful for remembering what you did yesterday, so you can share your "Today" and "Yesterday" activities with your team during your DSU.
-
-      NOTE: This gem is currently in development (alpha release) and does not provide the ability to UPDATE or DELETE activities. These features will be added in future releases.
-
-      IN ADDITION TO THIS: dsu's current behavior when viewing a particular day is to display the previous day's activities. This behavior is not necessarily ideal when sharing activities for a DSU that occurs on a Monday. This is because Monday's DSU typically includes sharing what you did on last FRIDAY (not necessarily "Yesterday"), as well as what you plan on doing "Today". This behavior will be changed in a future release as well, to display the previous Friday's activities (as well as Saturday and Sunday) if "Today" happens to be Monday.
+description: "    dsu is little 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) noteworthy activities that
+  you performed during your day. During your DSU, you can then easily recall and share
+  these these activities with your team. Activities are grouped by day and can be
+  viewed in simple text format from the command line. When displaying DSU entries
+  for a particular day or date (date), dsu will display the given day or date's (date)
+  DSU entries, as well as the DSU entries for the previous day, relative to the given
+  day or date. If the date or day you are trying to view falls on a weekend or Monday,
+  dsu will display back to, and including the weekend and previous Friday inclusive;
+  this is so that you can share what you did over the weekend (if anything) and the
+  previous Friday at your DSU.\n"
 email:
 - public.gma@gmail.com
 executables:
@@ -147,6 +153,7 @@ files:
 - lib/dsu/models/entry_group.rb
 - lib/dsu/services/configuration_loader_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/entry_group_reader_service.rb
 - lib/dsu/services/entry_group_writer_service.rb
@@ -162,6 +169,7 @@ files:
 - lib/dsu/support/commander/command_help.rb
 - lib/dsu/support/commander/subcommand.rb
 - lib/dsu/support/configuration.rb
+- lib/dsu/support/descriptable.rb
 - lib/dsu/support/entry_group_fileable.rb
 - lib/dsu/support/entry_group_loadable.rb
 - lib/dsu/support/entry_group_viewable.rb