dsu 0.1.0.alpha.1 → 0.1.0.alpha.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 83344cb778f73a92d994326c2ed1e7b807f7cd76b2f8281e21a4595f5a8dda3e
-  data.tar.gz: 0d4efd94ab1c8a8030e8ca91479c90102a298fd6562dd70defd76718459819a6
+  metadata.gz: b4558fb1982f908fef50a51ab4ed6351c3d3ae86c15eb4f7bd75bb34001cdf95
+  data.tar.gz: de047ffc2ebf972aec082ad886e1961d433f2e58e13bafeac85156ba6b91a936
 SHA512:
-  metadata.gz: 45cddb27387615f47a8a251dffe678ef16119fb0c04b77eb1312d198f5559f877f20b5d761544995238813ea528548b355c66c5331b83751ea02e813ef79986c
-  data.tar.gz: bb5b48f4df258847f54fa66df6f44d3bfbc143531b24bfff538edd48540e80e88a385eb3bdf7cd5c54ada859579ad93f7c61ae2f4e903c579c05b0a484c518c9
+  metadata.gz: e8e7e4af769b2290898c60147d02672b90e392ee612a553ade98d5cdb65f686bc9ed889746849deb912b18d7e25bbee150929f7e0917f62cfff9a6be51625fc9
+  data.tar.gz: b37d468fbef6a2038c4d92fa347dbfd333d3d8a661f43d57c4a66af42123c3e06e2aca1e6b9866a8ec00862cfe8c82846a488dc95bcc74fe02b3d3d1b3346a24

data/CHANGELOG.md

@@ -1,2 +1,15 @@
 ## [0.1.0.alpha.1] - 2023-05-06
 - Initial (alpha) release. See README.md for instructions.
+
+## [0.1.0.alpha.2] - 2023-05-08
+* ATTENTION: After installing this pre-release, run `dsu config info` and take note of the `entries_folder` config option value (e.g. something like '/Users/<whoami>/dsu/entries' on a nix os). You'll need to delete the entry group files therein ( <YYYY>-<MM>-<DD>.json e.g. 2023-05-07.json) to avoid errors when running this version of `dsu`.
+* WIP (not fully implemented yet)
+  - Added `dsu edit` command to edit an existing entry.
+* Changes
+  - Remove Entry#long_description and make Entry#description longer (to 256 bytes max).
+  - Added `dsu` short-cut commands|options `a|-a`, `c|-c`, `e|-e` and `l|-l` for `add`, `config`, `edit` and `list` commands respectively. For example, can now do `dsu a` or `dsu -a` instead of `dsu add`.
+   - Added `dsu list` short-cut subcommand|options `d|-d`, `n|-n`, `t|-t` and `y|-y` for `date DATE`, `today`, `tomorrow` and `yesterday` subcommands respectively. For example, can now do `dsu n` or `dsu -n` instead of `dsu today` to list your DSU entries for "today".
+  - `dsu list` commands now lists all DSU entries from the date being requested (SUBCOMMAND i.e. `today`, `tomorrow`, `yesterday` or `date`), back to and including the previous Friday IF the date being being requested falls on a Monday or weekend. This is so that the DSU entries for the weekend and previous Friday can be shared at DSU if you hold a DSU on the weekend (if you're insane enough to work and have DSU on the weekend) or on a Monday if you happened to work on the weekend as well.
+  - `dsu config info` now displays the default configuration being used if no configuration file is being used.
+* Bug fixes
+  - Fix bug that fails to load/use configuration file options when a config file exists.

data/Gemfile.lock

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

data/README.md

@@ -7,7 +7,7 @@
 [![License](http://img.shields.io/badge/license-MIT-yellowgreen.svg)](#license)
 
 ## About
-`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.
+`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. If the 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, so that you can share what you did over the weekend (if anything) and the previous Friday.
 
 **NOTE:** This gem is in development (alpha version). Please see the [WIP Notes](#wip-notes) section for current `dsu` features.
 
@@ -19,22 +19,21 @@ After installation (`gem install dsu`), the first thing you may want to do is ru
 ```shell
 #=>
 Commands:
-  dsu --version, -v                                 # Displays...
-  dsu add [OPTIONS] DESCRIPTION [LONG-DESCRIPTION]  # Adds a dsu entry...
-  dsu config SUBCOMMAND                             # Manage...
-  dsu help [COMMAND]                                # Describe...
-  dsu today                                         # Displays...
-  dsu tomorrow                                      # Displays...
-  dsu yesterday                                     # Displays...
+  dsu add, -a [OPTIONS] DESCRIPTION  # Adds a DSU entry having DESCRIPTION to the date associated with the given OPTION
+  dsu config, -c SUBCOMMAND          # Manage configuration...
+  dsu edit, -e SUBCOMMAND            # Edit DSU entries...
+  dsu help [COMMAND]                 # Describe available...
+  dsu list, -l SUBCOMMAND            # Displays DSU entries...
+  dsu version, -v                    # Displays this gem version
 
 Options:
   [--debug], [--no-debug]
 ```
 
-The next thing you may want to do is add some DSU activities (entries) for a particular day:
+The next thing you may want to do is `add` some DSU activities (entries) for a particular day:
 
 ### Adding DSU Entries
-`dsu add [OPTIONS] DESCRIPTION [LONG-DESCRIPTION]`
+`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`).
 
@@ -58,18 +57,18 @@ If you need to add a DSU entry for a date other than yesterday, today or tomorro
 
 `$ dsu add -d "2022-12-31" "Attend company New Years Coffee Meet & Greet"`
 
-### Display 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 (see [WIP Notes](#wip-notes) for caveats when displaying DSU entries for a particular day or date):
+### 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 today`
-`dsu tomorrow`
-`dsu yesterday`
-`dsu date`
+- `$ dsu list today|n`
+- `$ dsu list tomorrow|t`
+- `$ dsu list yesterday|y`
+- `$ dsu list date|d DATE`
 
 #### Examples
 The following displays the entries for "Today", where `Time.now == '2023-05-06 08:54:57.6861 -0400'`
 
-`$ dsu today`
+`$ dsu list today`
 ```shell
 #=>
 Saturday, (Today) 2023-05-06
@@ -81,7 +80,10 @@ Friday, (Yesterday) 2023-05-05
   2. f7d3018c Attend new hire meet & greet
 ```
 
-`$ dsu date "2023-05-06"`
+`$ 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.`:
+
 ```shell
 #=>
 Saturday, (Today) 2023-05-06
@@ -93,13 +95,53 @@ Friday, (Yesterday) 2023-05-05
   2. f7d3018c Attend new hire meet & greet
 ```
 
+### Customizing the `dsu` Configuration File
 
-## WIP Notes
-This gem is in development (alpha release) and currently does not provide the ability to UPDATE or DELETE activities. These features will be added in future releases.
+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
+
+```shell
+# Creates a dsu configuration file in your home folder.
+$ dsu config init
+
+#=>
+Configuration file (/Users/<whoami>/.dsu) created.
+Config file (/Users/<whoami>/.dsu) contents:
+---
+entries_display_order: desc
+entries_file_name: "%Y-%m-%d.json"
+entries_folder: "/Users/<whoami>/dsu/entries"
+```
+
+Where `<whoami>` would be your username (`$ whoami` on nix systems)
 
-In addition to this...
+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.
 
-`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 to display the previous Friday's activities (as well as Saturday and Sunday) if "Today" happens to fall on a Monday.
+##### Configuration File Options
+###### 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
+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: `'/Users/<whoami>/dsu/entries'` on nix systems.
+
+Where `<whoami>` would be your username (`$ whoami` on nix systems)
+
+## WIP Notes
+This gem is in development (alpha release) and currently does not provide the ability to UPDATE or DELETE activities. These features will be added in future releases.
 
 ## Installation
 
@@ -117,7 +159,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/dsu. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/dsu/blob/main/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/gangelo/dsu. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/dsu/blob/main/CODE_OF_CONDUCT.md).
 
 ## License
 

data/lib/dsu/base_cli.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require 'bundler'
+require 'thor'
+require_relative 'command_services/add_entry_service'
+require_relative 'models/entry_group'
+require_relative 'services/configuration_loader_service'
+require_relative 'services/entry_group_hydrator_service'
+require_relative 'services/entry_group_reader_service'
+require_relative 'support/colorable'
+require_relative 'support/configuration'
+require_relative 'support/entry_group_viewable'
+require_relative 'support/times_sortable'
+require_relative 'version'
+require_relative 'views/entry_group/show'
+
+module Dsu
+  #
+  # The `dsu` command.
+  #
+  class BaseCLI < ::Thor
+    include Support::Colorable
+    include Support::EntryGroupViewable
+    include Support::TimesSortable
+
+    class_option :debug, type: :boolean, default: false
+
+    default_command :help
+
+    class << self
+      def exit_on_failure?
+        false
+      end
+
+      def date_option_description
+        <<-DATE_OPTION_DESC
+          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.`
+        DATE_OPTION_DESC
+      end
+    end
+
+    def initialize(*args)
+      super
+
+      @configuration = Services::ConfigurationLoaderService.new.call
+    end
+
+    private
+
+    attr_reader :configuration
+
+    def sorted_dsu_times_for(times:)
+      times_sort(times: times_for(times: times), entries_display_order: entries_display_order)
+    end
+
+    def entries_display_order
+      @entries_display_order ||= configuration[:entries_display_order]
+    end
+  end
+end

data/lib/dsu/cli.rb

@@ -1,123 +1,88 @@
 # frozen_string_literal: true
 
-require 'bundler'
-require 'thor'
-require_relative 'command_services/add_entry_service'
-require_relative 'models/entry_group'
-require_relative 'services/configuration_loader_service'
-require_relative 'services/entry_group_hydrator_service'
-require_relative 'services/entry_group_reader_service'
+require 'time'
+require_relative 'base_cli'
 require_relative 'subcommands/config'
-require_relative 'version'
-require_relative 'views/entry_group/show'
+require_relative 'subcommands/edit'
+require_relative 'subcommands/list'
 
 module Dsu
   #
   # The `dsu` command.
   #
-  class CLI < ::Thor
-    class_option :debug, type: :boolean, default: false
+  class CLI < BaseCLI
+    # map %w[add -a] => :add
+    # map %w[config -c] => :config
+    # map %w[edit -e] => :edit
+    # #map %w[help -h] => :help
+    # map %w[list -l] => :list
+    # map %w[version -v] => :version
+
+    map %w[a -a] => :add
+    map %w[c -c] => :config
+    map %w[e -e] => :edit
+    map %w[l -l] => :list
+    map %w[v -v] => :version
+
+    desc 'add, -a [OPTIONS] DESCRIPTION',
+      'Adds a DSU entry having DESCRIPTION to the date associated with the given OPTION'
+    long_desc <<-LONG_DESC
+      NAME
+      \x5
+      `DSU add, -a [OPTIONS] DESCRIPTION` -- will add a DSU entry having DESCRIPTION to the date associated with the given OPTION.
 
-    map %w[--version -v] => :version
-    # map %w[--interactive -i] => :interactive
+      SYNOPSIS
+      \x5
+      `dsu add, -a [-d DATE|-n|-t|-y] DESCRIPTION`
 
-    default_command :help
+      OPTIONS:
+      \x5
+      -d DATE: Adds a DSU entry having DESCRIPTION to the DATE.
 
-    class << self
-      def exit_on_failure?
-        false
-      end
-    end
+      \x5 #{date_option_description}
 
-    def initialize(*args)
-      super
+      \x5 -n: Adds a DSU entry having DESCRIPTION to today's date (`Time.now`).
 
-      @configuration = Services::ConfigurationLoaderService.new.call
-    end
+      \x5 -t: Adds a DSU entry having DESCRIPTION to tomorrow's date (`Time.new.tomorrow`).
+
+      \x5 -y: Adds a DSU entry having DESCRIPTION to yesterday's date (`Time.new.yesterday`).
 
-    desc 'add [OPTIONS] DESCRIPTION [LONG-DESCRIPTION]',
-      'Adds a dsu entry for the date associated with the given option.'
-    long_desc <<-LONG_DESC
-      TBD
     LONG_DESC
     option :date, type: :string, aliases: '-d'
-    option :next_day, type: :boolean, aliases: '-n'
-    option :previous_day, type: :boolean, aliases: '-p'
-    option :today, type: :boolean, aliases: '-t', default: true
-
-    def add(description, long_description = nil)
-      entry = Models::Entry.new(description: description, long_description: long_description)
-      time = if options[:date].present?
-        Time.parse(options[:date])
-      elsif options[:next_day].present?
-        1.day.from_now
-      elsif options[:previous_day].present?
-        1.day.ago
-      elsif options[:today].present?
-        Time.now
+    option :tomorrow, type: :boolean, aliases: '-t'
+    option :yesterday, type: :boolean, aliases: '-y'
+    option :today, type: :boolean, aliases: '-n', default: true
+
+    def add(description)
+      times = if options[:date].present?
+        time = Time.parse(options[:date])
+        [time, time.yesterday]
       else
-        raise 'No date option specified.'
-      end
-      display_entry_group(time: 1.day.ago(time))
-      puts
-      CommandServices::AddEntryService.new(entry: entry, time: time).call
-      display_entry_group(time: time)
-    end
-
-    desc 'today',
-      'Displays the dsu entries for today.'
-    long_desc <<-LONG_DESC
-      Displays the dsu entries for today. This command has no options.
-    LONG_DESC
-    def today
-      time = Time.now
-      sort_times(times: [1.day.ago(time), time]).each do |time| # rubocop:disable Lint/ShadowingOuterLocalVariable
-        display_entry_group(time: time)
-        puts
-      end
-    end
-
-    desc 'tomorrow',
-      'Displays the dsu entries for tomorrow.'
-    long_desc <<-LONG_DESC
-      Displays the dsu entries for tomorrow. This command has no options.
-    LONG_DESC
-    def tomorrow
-      time = Time.now
-      sort_times(times: [1.day.from_now(time), time]).each do |time| # rubocop:disable Lint/ShadowingOuterLocalVariable
-        display_entry_group(time: time)
-        puts
+        time = Time.now
+        if options[:tomorrow].present?
+          [time.tomorrow, time.tomorrow.yesterday]
+        elsif options[:yesterday].present?
+          [time.yesterday, time.yesterday.yesterday]
+        elsif options[:today].present?
+          [time, time.yesterday]
+        end
       end
-    end
-
-    desc 'yesterday',
-      'Displays the dsu entries for yesterday.'
-    long_desc <<-LONG_DESC
-      Displays the dsu entries for yesterday. This command has no options.
-    LONG_DESC
-    def yesterday
-      time = Time.now
-      sort_times(times: [1.day.ago(time), 2.days.ago(time)]).each do |time| # rubocop:disable Lint/ShadowingOuterLocalVariable
-        display_entry_group(time: time)
+      entry = Models::Entry.new(description: description)
+      # NOTE: We need to add the Entry to the date that is the furthest in the future
+      # (time.max) because this is the DSU entry that the user specified.
+      CommandServices::AddEntryService.new(entry: entry, time: times.max).call
+      sorted_dsu_times_for(times: times).each do |t|
+        view_entry_group(time: t)
         puts
       end
     end
 
-    desc 'date',
-      'Displays the dsu entries for DATE.'
-    long_desc <<-LONG_DESC
-      Displays the dsu entries for DATE, where DATE is any date string that can be parsed using `Time.parse`. For example: `require 'time'; Time.parse("2023-01-01")`.
-    LONG_DESC
-    def date(date)
-      time = Time.parse(date)
-      sort_times(times: [1.day.ago(time), time]).each do |time| # rubocop:disable Lint/ShadowingOuterLocalVariable
-        display_entry_group(time: time)
-        puts
-      end
-    end
+    desc 'list, -l SUBCOMMAND',
+      'Displays DSU entries for the given SUBCOMMAND'
+    subcommand :list, Subcommands::List
 
     # TODO: Implement this.
-    # desc 'interactive', 'Opens a dsu interactive session'
+    # desc 'interactive', 'Opens a DSU interactive session'
     # long_desc ''
     # option :next_day, type: :boolean, aliases: '-n'
     # option :previous_day, type: :boolean, aliases: '-p'
@@ -135,44 +100,30 @@ module Dsu
     #   say 'Done.'
     # end
 
-    desc 'config SUBCOMMAND', 'Manage configuration file for this gem'
+    desc 'config, -c SUBCOMMAND',
+      'Manage configuration file for this gem'
     subcommand :config, Subcommands::Config
 
-    desc '--version, -v', 'Displays this gem version'
+    desc 'edit, -e SUBCOMMAND',
+      'Edit DSU entries for the given SUBCOMMAND'
+    subcommand :edit, Subcommands::Edit
+
+    desc 'version, -v',
+      'Displays this gem version'
     def version
       say VERSION
     end
 
     private
 
-    attr_reader :configuration
-
     def display_interactive_help
       say 'Interactive Mode Commands:'
       say '---'
       say '[h]: show this help screen'
-      say '[n]: next day'
-      say '[p]: previous day'
-      say '[t]: today'
+      say '[t]: next day'
+      say '[y]: previous day'
+      say '[n]: today'
       say '[x|q|exit|quit]: Exit interactive mode'
     end
-
-    def display_entry_group(time:)
-      entry_group = if Models::EntryGroup.exists?(time: time)
-        entry_group_json = Services::EntryGroupReaderService.new(time: time).call
-        Services::EntryGroupHydratorService.new(entry_group_json: entry_group_json).call
-      else
-        Models::EntryGroup.new(time: time)
-      end
-      Views::EntryGroup::Show.new(entry_group: entry_group).display
-    end
-
-    def sort_times(times:)
-      if configuration[:entries_display_order] == 'asc'
-        times.sort # sort ascending
-      elsif configuration[:entries_display_order] == 'desc'
-        times.sort.reverse # sort descending
-      end
-    end
   end
 end

data/lib/dsu/models/entry.rb

@@ -11,21 +11,18 @@ module Dsu
         message: 'is the wrong format. ' \
                  '0-9, a-f, and 8 characters were expected.' \
       }
-      validates :description, presence: true, length: { minimum: 2, maximum: 80 }
-      validates :long_description, length: { minimum: 2, maximum: 256 }, allow_nil: true
+      validates :description, presence: true, length: { minimum: 2, maximum: 256 }
 
-      def initialize(description:, uuid: nil, long_description: nil)
+      def initialize(description:, uuid: nil)
         raise ArgumentError, 'description is nil' if description.nil?
         raise ArgumentError, 'description is the wrong object type' unless description.is_a?(String)
         raise ArgumentError, 'uuid is the wrong object type' unless uuid.is_a?(String) || uuid.nil?
-        raise ArgumentError, 'long_description is the wrong object type' unless long_description.is_a?(String) || long_description.nil?
 
         uuid ||= SecureRandom.uuid[0..7]
 
         super(hash: {
           uuid: uuid,
-          description: description,
-          long_description: long_description
+          description: description
         })
       end
 
@@ -33,16 +30,10 @@ module Dsu
         %i[uuid description]
       end
 
-      def long_description?
-        long_description.present?
-      end
-
       def ==(other)
         return false unless other.is_a?(Entry)
 
-        uuid == other.uuid &&
-          description == other.description &&
-          long_description == other.long_description
+        uuid == other.uuid && description == other.description
       end
     end
   end

data/lib/dsu/models/entry_group.rb

@@ -34,6 +34,8 @@ module Dsu
           Dsu::Services::EntryGroupReaderService.entry_group_file_exists?(time: time)
         end
 
+        # Loads the EntryGroup from the file system and returns an
+        # instantiated EntryGroup object.
         def load(time: nil)
           new(**hydrated_entry_group_hash_for(time: time))
         end

data/lib/dsu/services/configuration_loader_service.rb

@@ -11,23 +11,29 @@ module Dsu
 
       attr_reader :default_options
 
-      def initialize(default_options: Dsu::Support::Configuration::DEFAULT_DSU_OPTIONS)
-        @default_options = default_options
+      def initialize(default_options: nil)
+        unless default_options.nil? ||
+               default_options.is_a?(Hash) ||
+               default_options.is_a?(ActiveSupport::HashWithIndifferentAccess)
+          raise ArgumentError, 'default_options must be a Hash'
+        end
+
+        @default_options = default_options || Support::Configuration::DEFAULT_DSU_OPTIONS
+        @default_options = @default_options.with_indifferent_access if @default_options.is_a?(Hash)
       end
 
       def call
-        load_config.merge(default_options || {}).presence&.with_indifferent_access || raise('No configuration options found')
+        return default_options unless config_file?
+
+        config_options.with_indifferent_access
       end
 
       private
 
       attr_writer :default_options
 
-      def load_config
-        return {} unless config_file?
-
-        yaml_options = File.read(config_file)
-        YAML.safe_load ERB.new(yaml_options).result
+      def config_options
+        @config_options ||= YAML.safe_load(ERB.new(File.read(config_file)).result)
       end
     end
   end

data/lib/dsu/subcommands/edit.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+require_relative '../base_cli'
+require_relative '../models/entry_group'
+require_relative '../support/time_formatable'
+require_relative '../views/entry_group/edit'
+
+module Dsu
+  module Subcommands
+    class Edit < Dsu::BaseCLI
+      include Support::TimeFormatable
+
+      map %w[d] => :date
+      map %w[n] => :today
+      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
+      def today
+        edit_entry_group(time: Time.now)
+      end
+
+      desc 'tomorrow, t',
+        'Edits the DSU entries for tomorrow.'
+      long_desc <<-LONG_DESC
+        Edits the DSU entries for tomorrow.
+      LONG_DESC
+      def tomorrow
+        edit_entry_group(time: Time.now.tomorrow)
+      end
+
+      desc 'yesterday, y',
+        'Edits the DSU entries for yesterday.'
+      long_desc <<-LONG_DESC
+        Edits the DSU entries for yesterday.
+      LONG_DESC
+      def yesterday
+        edit_entry_group(time: Time.now.yesterday)
+      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)
+        edit_entry_group(time: Time.parse(date))
+      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)
+        # system("${EDITOR:-nano} #{file_path}")
+
+        output = capture_stdxxx do
+          Views::EntryGroup::Edit.new(entry_group: entry_group).render
+        end
+        say output, SUCCESS
+      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/subcommands/list.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+require_relative '../base_cli'
+
+module Dsu
+  module Subcommands
+    class List < Dsu::BaseCLI
+      map %w[d] => :date
+      map %w[n] => :today
+      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
+      def today
+        time = Time.now
+        sorted_dsu_times_for(times: [time, time.yesterday]).each do |t|
+          view_entry_group(time: t)
+          puts
+        end
+      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
+      def tomorrow
+        time = Time.now
+        sorted_dsu_times_for(times: [time.tomorrow, time]).each do |t|
+          view_entry_group(time: t)
+          puts
+        end
+      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
+      def yesterday
+        time = Time.now
+        sorted_dsu_times_for(times: [time.yesterday, time.yesterday.yesterday]).each do |t|
+          view_entry_group(time: t)
+          puts
+        end
+      end
+
+      desc 'date, d DATE',
+        'Displays the DSU entries for DATE'
+      long_desc <<-LONG_DESC
+      Displays the DSU entries for DATE.
+        \x5 #{date_option_description}
+      LONG_DESC
+      def date(date)
+        time = Time.parse(date)
+        sorted_dsu_times_for(times: [time, time.yesterday]).each do |t|
+          view_entry_group(time: t)
+          puts
+        end
+      rescue ArgumentError => e
+        say "Error: #{e.message}", ERROR
+        exit 1
+      end
+    end
+  end
+end

data/lib/dsu/support/configuration.rb

@@ -22,7 +22,7 @@ module Dsu
         # asc or desc, ascending or descending, respectively.
         'entries_display_order' => 'desc',
         'entries_file_name' => '%Y-%m-%d.json',
-        'entries_folder' => "#{FolderLocations.root_folder}/dsu/entries",
+        'entries_folder' => "#{FolderLocations.root_folder}/dsu/entries"
       }.freeze
       # rubocop:enable Style/StringHashKeys
 
@@ -43,6 +43,7 @@ module Dsu
         delete_config_file config_file: config_file
       end
 
+      # TODO: Move this to a view (e.g. views/configuration/show.rb)
       def print_config_file
         if config_file?
           say "Config file (#{config_file}) contents:", SUCCESS
@@ -50,6 +51,11 @@ module Dsu
           say hash.to_yaml.gsub("\n-", "\n\n-"), SUCCESS
         else
           say "Config file (#{config_file}) does not exist.", WARNING
+          say ''
+          say 'The default configuration is being used:'
+          DEFAULT_DSU_OPTIONS.each_with_index do |config_entry, index|
+            say "#{index + 1}. #{config_entry[0]}: '#{config_entry[1]}'"
+          end
         end
       end
 

data/lib/dsu/support/entry_group_viewable.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Dsu
+  module Support
+    module EntryGroupViewable
+      module_function
+
+      def view_entry_group(time:)
+        entry_group = if Models::EntryGroup.exists?(time: time)
+          entry_group_json = Services::EntryGroupReaderService.new(time: time).call
+          Services::EntryGroupHydratorService.new(entry_group_json: entry_group_json).call
+        else
+          Models::EntryGroup.new(time: time)
+        end
+        Views::EntryGroup::Show.new(entry_group: entry_group).render
+      end
+    end
+  end
+end

data/lib/dsu/support/time_formatable.rb

@@ -13,29 +13,23 @@ module Dsu
       def formatted_time(time:)
         time = time.localtime if time.utc?
 
-        today_yesterday_or_tomorrow = if today?(time: time)
+        today_yesterday_or_tomorrow = if time.today?
           'Today'
-        elsif yesterday?(time: time)
+        elsif time.yesterday?
           'Yesterday'
-        elsif tomorrow?(time: time)
+        elsif time.tomorrow?
           'Tomorrow'
         end
 
-        return time.strftime('%A, %Y-%m-%d') unless today_yesterday_or_tomorrow
+        time_zone = timezone_for(time: time)
 
-        time.strftime("%A, (#{today_yesterday_or_tomorrow}) %Y-%m-%d")
-      end
-
-      def today?(time:)
-        time.strftime('%Y%m%d') == Time.now.strftime('%Y%m%d')
-      end
+        return time.strftime("%A, %Y-%m-%d #{time_zone}") unless today_yesterday_or_tomorrow
 
-      def yesterday?(time:)
-        time.strftime('%Y%m%d') == 1.day.ago(Time.now).strftime('%Y%m%d')
+        time.strftime("%A, (#{today_yesterday_or_tomorrow}) %Y-%m-%d #{time_zone}")
       end
 
-      def tomorrow?(time:)
-        time.strftime('%Y%m%d') == 1.day.from_now(Time.now).strftime('%Y%m%d')
+      def timezone_for(time:)
+        time.zone
       end
     end
   end

data/lib/dsu/support/times_sortable.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Dsu
+  module Support
+    module TimesSortable
+      module_function
+
+      def times_sort(times:, entries_display_order: nil)
+        entries_display_order ||= 'asc'
+        unless %w[asc desc].include? entries_display_order
+          raise "Invalid entries_display_order: #{entries_display_order}"
+        end
+
+        if entries_display_order == 'asc'
+          times.sort # sort ascending
+        elsif entries_display_order == 'desc'
+          times.sort.reverse # sort descending
+        end
+      end
+
+      def times_for(times:)
+        start_date = times.max
+        return times unless start_date.monday? || start_date.on_weekend?
+
+        # (0..3).map { |num| start_date - num.days }
+        # (start_date..-start_date.friday?).map { |time| time }
+        # (0..3).map { |num| start_date - num.days if start_date.on_weekend? || start_date.monday? }
+        # If the start_date is a weekend or a Monday, then we need to include
+        # start_date along with all the dates up to and including the previous
+        # Monday.
+        (0..3).filter_map do |num|
+          time = start_date - num.days
+          next unless time == start_date || time.on_weekend? || time.friday?
+
+          time
+        end
+      end
+    end
+  end
+end

data/lib/dsu/version.rb

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

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

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require 'time'
+require 'active_support/core_ext/numeric/time'
+require_relative '../../models/entry_group'
+require_relative '../../support/colorable'
+require_relative '../../support/say'
+require_relative '../../support/time_formatable'
+
+module Dsu
+  module Views
+    module EntryGroup
+      class Edit
+        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 nil' if options.nil?
+          raise ArgumentError, 'options is the wrong object type' unless options.is_a?(Hash)
+
+          @entry_group = entry_group
+          @options = options || {}
+        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
+
+        private
+
+        attr_reader :entry_group, :options
+
+        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?
+
+          say ''
+
+          entry_group.entries.each do |entry|
+            say "#{entry.uuid} #{entry.description}"
+          end
+
+          say ''
+          say '# To EDIT a DSU entry, change the description, then save and close your editor.'
+          say "# To DELETE a DSU entry, delete the entry or replace the sha with a 'd', " \
+              'then save and close your editor.'
+          say '# To REORDER a DSU entry, reorder the DSU entries in order preference, ' \
+              'then save and close your editor.'
+        end
+      end
+    end
+  end
+end

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

@@ -29,18 +29,18 @@ module Dsu
           # Just in case the entry group is invalid, we'll
           # validate it before displaying it.
           entry_group.validate!
-          display_entry_group!
+          render_entry_group!
         rescue ActiveModel::ValidationError
           puts "Error(s) encountered: #{entry_group.errors.full_messages}"
           raise
         end
-        alias display call
+        alias render call
 
         private
 
         attr_reader :entry_group, :options
 
-        def display_entry_group!
+        def render_entry_group!
           say formatted_time(time: entry_group.time), HIGHLIGHT
           say('(no entries available for this day)') and return if entry_group.entries.empty?
 
@@ -48,10 +48,6 @@ module Dsu
             prefix = "#{format('%03s', index + 1)}. #{entry.uuid}"
             description = colorize_string(string: entry.description, mode: :bold)
             say "#{prefix} #{description}"
-            next unless entry.long_description?
-
-            long_description = colorize_string(string: entry.long_description, mode: :bold)
-            say "#{''.ljust(prefix.length)} #{long_description}"
           end
         end
       end

data/lib/dsu.rb

@@ -5,34 +5,6 @@ require 'active_support/core_ext/object/blank'
 require 'active_support/core_ext/hash/indifferent_access'
 require 'active_support/core_ext/numeric/time'
 
-# # Require relative all files under dsu/services folder (recursively)
-# Dir.glob("#{__dir__}/dsu/services/**/*.rb").each do |file|
-#   require file
-# end
-
-# # Require relative all files under dsu/support folder (recursively)
-# Dir.glob("#{__dir__}/dsu/support/**/*.rb").each do |file|
-#   require file
-# end
-
-# Dir.glob("#{__dir__}/dsu/validators/**/*.rb").each do |file|
-#   require file
-# end
-
-# [
-#   "#{__dir__}/dsu/services/**/*.rb"
-#   "#{__dir__}/dsu/support/**/*.rb",
-#   "#{__dir__}/dsu/validators/**/*.rb"
-# ]
-
 Dir.glob("#{__dir__}/dsu/**/*.rb").each do |file|
   require file
 end
-
-require_relative 'dsu/cli'
-require_relative 'dsu/version'
-
-# The main namespace for this dsu gem.
-module Dsu
-  # Your code goes here...
-end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dsu
 version: !ruby/object:Gem::Version
-  version: 0.1.0.alpha.1
+  version: 0.1.0.alpha.2
 platform: ruby
 authors:
 - Gene M. Angelo, Jr.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-05-06 00:00:00.000000000 Z
+date: 2023-05-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -140,6 +140,7 @@ files:
 - bin/setup
 - exe/dsu
 - lib/dsu.rb
+- lib/dsu/base_cli.rb
 - lib/dsu/cli.rb
 - lib/dsu/command_services/add_entry_service.rb
 - lib/dsu/models/entry.rb
@@ -151,6 +152,8 @@ files:
 - lib/dsu/services/entry_group_writer_service.rb
 - lib/dsu/services/entry_hydrator_service.rb
 - lib/dsu/subcommands/config.rb
+- lib/dsu/subcommands/edit.rb
+- lib/dsu/subcommands/list.rb
 - lib/dsu/support/ask.rb
 - lib/dsu/support/colorable.rb
 - lib/dsu/support/commander/command.rb
@@ -159,14 +162,17 @@ files:
 - lib/dsu/support/configuration.rb
 - lib/dsu/support/entry_group_fileable.rb
 - lib/dsu/support/entry_group_loadable.rb
+- lib/dsu/support/entry_group_viewable.rb
 - lib/dsu/support/field_errors.rb
 - lib/dsu/support/folder_locations.rb
 - lib/dsu/support/interactive/cli.rb
 - lib/dsu/support/say.rb
 - lib/dsu/support/time_formatable.rb
+- lib/dsu/support/times_sortable.rb
 - lib/dsu/validators/entries_validator.rb
 - lib/dsu/validators/time_validator.rb
 - lib/dsu/version.rb
+- lib/dsu/views/entry_group/edit.rb
 - lib/dsu/views/entry_group/show.rb
 - sig/dsu.rbs
 homepage: https://github.com/gangelo/dsu