dsu 0.1.0.alpha.5 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d8563782a0b4d22e374313aa3373b38e62dec995a6f6d996eaa5fa9c58b0d1cb
-  data.tar.gz: 65ebebe762dac44300a6d163c03275eaffd66018a83f9836b3f12cb6333569ad
+  metadata.gz: fa1b6f69c4de21d556a38cd96f29ba9ad8b7b4b2a9f5d34cda7fccb61f15d63f
+  data.tar.gz: 7376022ead177228164448d6fa4b8ee554a35611d45450955c586ed1bf84462a
 SHA512:
-  metadata.gz: a412bf735ce124b6df3bb419a1ed925b6b9aaf6cc7e8fdb13773fd883886119d92c03cb4bc68633d57bcfd293c274db16d5504200790f9be65d5d3d3f3e5e21e
-  data.tar.gz: bf7ac4a28753385155d6e0cd7f1694723deaa3ad0d0e41205f63446c78a2a8b0b09d42f4e5557d3c3aef4befa8a6d46e568d308a1d9fb6c9a0f4110d301c025d
+  metadata.gz: 7128d03202e5f9536e6fda51c2dab009dd0ed32f56f00e17b6d1c96cb5420daa8dd0ab71c69d25f811ee41acf14cda05d133211f3b9480b70907736201d7162b
+  data.tar.gz: bc276d357add40377ec88b79b8379fad502cea936440c31a81e7e0ed18c1ad766244f0a09b9eb33a1536a0d60d2c7140b429d5643aa6a3d51b2f362cdec60673

data/.rubocop.yml

@@ -10,7 +10,7 @@ AllCops:
     - '.idea/**/*'
     - 'init/*'
     - 'Rakefile'
-#    - '*.gemspec'
+    - '*.gemspec'
 #    - 'spec/**/*'
     - 'vendor/**/*'
     - 'scratch*.rb'

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+## [1.0.0] - 2023-05-18
+* First official release.
+* NOTE: If you have been using the alpha version of `dsu`, you will need to delete the `entries` folder (e.g. `/Users/<whoami>/dsu/entries` on a nix os) as the old entries .json files are incompatible with this official release.
+* Changes from the alpha version
+  - When editing an entry group, editor commands are no longer necessary. Simply add, remove or change entries as needed. See the README.md for more information.
+  - When editing an entry group and saving the results, take note of the folowing behavior:
+    - Entering duplicate entries are not allowed, only one entry with a given description is allowed per entry group.
+    - Entering entries whose descriptions are < 2 or > 256 characters will fail validation and will not be saved.
+    - When editing and encountering any of the aforementioned, the errors will be displayed to the console after the editor file is saved.
+  - Sha's are no longer being used, as I've not found a good use (currently) to use them. I may add them back in the future if I find a good use for them (tracking entries across entry groups, etc.).
+  - When adding an entry (`dsu add OPTION`), it used to be that after the entry was added, the entry group for the date being edited would be displayed, as well as "yesterday's" date. This is no longer the case; now, only the entry group for the date being edited is displayed.
 ## [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.

data/Gemfile.lock

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

data/README.md

@@ -9,8 +9,6 @@
 ## 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. 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.
-
 ## Help
 
 After installation (`gem install dsu`), the first thing you may want to do is run the `dsu` help:
@@ -97,7 +95,7 @@ Friday, (Yesterday) 2023-05-05
 ```
 ## 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. 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.*
+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 the the date, the editor will allow you to add entries for that date. *NOTE: duplicate entries are not allowed; that is, the entry DESCRIPTION need to be unique within an entry group. Non-unique entries will not be added to the entry group. The same holds true for entries whose DESCRIPTION that do not pass validation (between 2 and 256 characters (inclusive) in length).*
 
 Note: See the "[Customizing the `dsu` Configuration File](#customizing-the-dsu-configuration-file)"" section to configure `dsu` to use the editor of your choice.
 
@@ -116,20 +114,19 @@ The following will edit your DSU entry group entries for "Today", where `Time.no
 ```shell
 #=> In your editor, you will see...
 # Editing DSU Entries for Tuesday, (Today) 2023-05-09 EDT
-
-# [SHA/COMMAND] [DESCRIPTION]
-3849f0c0 Interative planning meeting 11:00AM.
-586478f5 Pair with Chad on ticket 31211.
-9e5f82c8 Investigate spike ticket 31255.
-59b25ca7 Review Kelsey's PR ticket 30721.
+# [ENTRY DESCRIPTION]
+Interative planning meeting 11:00AM.
+Pair with Chad on ticket 31211.
+Investigate spike ticket 31255.
+Review Kelsey's PR ticket 30721.
 
 # INSTRUCTIONS:
-# ADD a DSU entry: use one of the following commands: [+|a|add] followed by the description.
-# EDIT a DSU entry: change the description.
-# DELETE a DSU entry: delete the entry or replace the sha with one of the following commands: [-|d|delete].
-# NOTE: deleting all the entries will delete the entry group file;
-#       this is preferable if this is what you want to do :)
-# REORDER a DSU entry: reorder the DSU entries in order preference.
+#    ADD a DSU entry: type an ENTRY DESCRIPTION on a new line.
+#   EDIT a DSU entry: change the existing ENTRY DESCRIPTION.
+# DELETE a DSU entry: delete the ENTRY DESCRIPTION.
+#  NOTE: deleting all of the ENTRY DESCRIPTIONs will delete the entry group file;
+#        this is preferable if this is what you want to do :)
+# REORDER a DSU entry: reorder the ENTRY DESCRIPTIONs in order preference.
 #
 # *** When you are done, save and close your editor ***
 ```
@@ -140,32 +137,28 @@ Simply change the entry descripton text.
 
 For example...
 ```
-from: 3849f0c0 Interative planning meeting 11:00AM.
-  to: 3849f0c0 Interative planning meeting 12:00AM.
+from: Interative planning meeting 11:00AM.
+  to: Interative planning meeting 12:00AM.
 ```
 
 #### Add an Entry
 
-Replace the entry `sha` one of the add commands: `[+|a|add]`.
+Simply type a new entry on a separate line. *Note: any entry that starts with a `#` in the first character position will be ignored.*
 
 For example...
 ```
-+ Add me to this entry group.
+Add me to this entry group.
 ```
 
 #### Delete an Entry
 
-Simply delete the entry or replace the entry `sha` one of the delete commands: `[-|d|delete]`.
+Simply delete the entry.
 
 For example...
 ```
 # Delete this this entry from the editor file
-3849f0c0 Interative planning meeting 11:00AM.
-```
-or
-```
-from: 3849f0c0 Interative planning meeting 11:00AM.
-  to: - Interative planning meeting 11:00AM.
+from: Interative planning meeting 11:00AM.
+  to: <deleted>
 ```
 
 #### Reorder Entries
@@ -174,14 +167,14 @@ Simply reorder the entries in the editor.
 
 For example...
 ```
-from: 3849f0c0 Interative planning meeting 11:00AM.
-      586478f5 Pair with Chad on ticket 31211.
-      9e5f82c8 Investigate spike ticket 31255.
-      59b25ca7 Review Kelsey's PR ticket 30721.
-  to: 59b25ca7 Review Kelsey's PR ticket 30721.
-      9e5f82c8 Investigate spike ticket 31255.
-      586478f5 Pair with Chad on ticket 31211.
-      3849f0c0 Interative planning meeting 11:00AM.
+from: Interative planning meeting 11:00AM.
+      Pair with Chad on ticket 31211.
+      Investigate spike ticket 31255.
+      Review Kelsey's PR ticket 30721.
+  to: Review Kelsey's PR ticket 30721.
+      Investigate spike ticket 31255.
+      Pair with Chad on ticket 31211.
+      Interative planning meeting 11:00AM.
 ```
 
 ## Customizing the `dsu` Configuration File
@@ -242,12 +235,6 @@ 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/base_cli.rb

@@ -15,9 +15,6 @@ require_relative 'version'
 require_relative 'views/entry_group/show'
 
 module Dsu
-  #
-  # The `dsu` command.
-  #
   class BaseCLI < ::Thor
     include Support::Colorable
     include Support::EntryGroupViewable

data/lib/dsu/cli.rb

@@ -30,14 +30,21 @@ module Dsu
       \x5
       -d DATE: Adds a DSU entry having DESCRIPTION to the DATE.
 
-      \x5 #{date_option_description}
+      \x5
+      #{date_option_description}
 
-      \x5 -n: Adds a DSU entry having DESCRIPTION to today's date (`Time.now`).
+      \x5
+      -n: Adds a DSU entry having DESCRIPTION to today's date (`Time.now`).
 
-      \x5 -t: Adds a DSU entry having DESCRIPTION to tomorrow's date (`Time.new.tomorrow`).
+      \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`).
+      \x5
+      -y: Adds a DSU entry having DESCRIPTION to yesterday's date (`Time.new.yesterday`).
 
+      DESCRIPTION:
+      \x5
+      Must be be between 2 and 256 characters (inclusive) in length.
     LONG_DESC
     option :date, type: :string, aliases: '-d'
     option :tomorrow, type: :boolean, aliases: '-t'
@@ -45,52 +52,50 @@ module Dsu
     option :today, type: :boolean, aliases: '-n', default: true
 
     def add(description)
-      times = if options[:date].present?
-        time = Time.parse(options[:date])
-        [time, time.yesterday]
+      time = if options[:date].present?
+        Time.parse(options[:date])
       else
-        time = Time.now
         if options[:tomorrow].present?
-          [time.tomorrow, time.tomorrow.yesterday]
+          Time.now.tomorrow
         elsif options[:yesterday].present?
-          [time.yesterday, time.yesterday.yesterday]
+          Time.now.yesterday
         elsif options[:today].present?
-          [time, time.yesterday]
+          Time.now
         end
       end
       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
+      CommandServices::AddEntryService.new(entry: entry, time: time).call
+      view_entry_group(time: time)
     end
 
+    # def add(description)
+    #   times = if options[:date].present?
+    #     time = Time.parse(options[:date])
+    #     [time, time.yesterday]
+    #   else
+    #     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
+    #   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 'list, -l SUBCOMMAND',
       'Displays DSU entries for the given SUBCOMMAND'
     subcommand :list, Subcommands::List
 
-    # TODO: Implement this.
-    # desc 'interactive', 'Opens a DSU interactive session'
-    # long_desc ''
-    # option :next_day, type: :boolean, aliases: '-n'
-    # option :previous_day, type: :boolean, aliases: '-p'
-    # option :today, type: :boolean, aliases: '-t'
-
-    # # https://stackoverflow.com/questions/4604905/interactive-prompt-with-thor
-    # def interactive
-    #   exit_commands = %w[x q exit quit]
-    #   display_interactive_help
-    #   loop do
-    #     command = ask('dsu > ')
-    #     display_interactive_help if command == 'h'
-    #     break if exit_commands.include? command
-    #   end
-    #   say 'Done.'
-    # end
-
     desc 'config, -c SUBCOMMAND',
       'Manage configuration file for this gem'
     subcommand :config, Subcommands::Config
@@ -104,17 +109,5 @@ module Dsu
     def version
       say VERSION
     end
-
-    private
-
-    def display_interactive_help
-      say 'Interactive Mode Commands:'
-      say '---'
-      say '[h]: show this help screen'
-      say '[t]: next day'
-      say '[y]: previous day'
-      say '[n]: today'
-      say '[x|q|exit|quit]: Exit interactive mode'
-    end
   end
 end

data/lib/dsu/command_services/add_entry_service.rb

@@ -1,60 +1,60 @@
 # frozen_string_literal: true
 
-require_relative '../services/entry_group_writer_service'
 require_relative '../models/entry'
+require_relative '../services/entry_group_writer_service'
+require_relative '../support/colorable'
+require_relative '../support/descriptable'
 require_relative '../support/entry_group_loadable'
 require_relative '../support/folder_locations'
+require_relative '../support/say'
+require_relative '../views/shared/messages'
 
 module Dsu
   module CommandServices
-    # This class adds (does NOT update) an entry to an entry group.
+    # This class adds (does NOT update) an entry to an entry group by
+    # writing it to the appropriate entry group json file.
     class AddEntryService
-      include Dsu::Support::EntryGroupLoadable
-      include Dsu::Support::FolderLocations
+      include Support::Colorable
+      include Support::Descriptable
+      include Support::EntryGroupLoadable
+      include Support::FolderLocations
+      include Support::Say
 
       attr_reader :entry, :entry_group, :time
 
+      delegate :description, to: :entry
+
       # :entry is an Entry object
       # :time is a Time object; the time of the entry group.
       def initialize(entry:, time:)
         raise ArgumentError, 'entry is nil' if entry.nil?
-        raise ArgumentError, 'entry is the wrong object type' unless entry.is_a?(Dsu::Models::Entry)
+        raise ArgumentError, 'entry is the wrong object type' unless entry.is_a?(Models::Entry)
         raise ArgumentError, 'time is nil' if time.nil?
         raise ArgumentError, 'time is the wrong object type' unless time.is_a?(Time)
 
         @entry = entry
         @time = time
-        @entry_group = Dsu::Models::EntryGroup.load(time: time)
+        @entry_group = Models::EntryGroup.load(time: time)
       end
 
       def call
         entry.validate!
         save_entry_group!
-        entry.uuid
-      rescue ActiveModel::ValidationError
-        puts "Error(s) encountered: #{entry.errors.full_messages}"
-        raise
+        entry
+      rescue ActiveModel::ValidationError => e
+        header = 'An error was encountered; the entry could not be added added:'
+        Views::Shared::Messages.new(messages: e.message, message_type: :error, options: { header: header }).render
       end
 
       private
 
       attr_writer :entry, :entry_group, :time
 
-      def entry_exists?
-        @entry_exists ||= entry_group.entries.include? entry.uuid
-      end
-
-      def entry_group_hash
-        @entry_group_hash ||= entry_group_hash_for time: time
-      end
-
       def save_entry_group!
-        raise "Entry #{entry.uuid} already exists in entry group #{time}" if entry_exists?
-
         entry_group.entries << entry
         entry_group.validate!
 
-        Dsu::Services::EntryGroupWriterService.new(entry_group: entry_group).call
+        Services::EntryGroupWriterService.new(entry_group: entry_group).call
       end
     end
   end

data/lib/dsu/models/entry.rb

@@ -1,44 +1,56 @@
 # frozen_string_literal: true
 
-require 'deco_lite'
+require 'active_model'
 require 'securerandom'
 require_relative '../support/descriptable'
+require_relative '../validators/description_validator'
 
 module Dsu
   module Models
-    class Entry < DecoLite::Model
+    # This class represents something someone might want to share at their
+    # daily standup (DSU).
+    class Entry
+      include ActiveModel::Model
       include Support::Descriptable
 
-      ENTRY_UUID_REGEX = /\A[0-9a-f]{8}\z/i
+      validates_with Validators::DescriptionValidator
 
-      validates :uuid, presence: true, format: {
-        with: ENTRY_UUID_REGEX,
-        message: 'is the wrong format. ' \
-                 '0-9, a-f, and 8 characters were expected.' \
-      }
-      validates :description, presence: true, length: { minimum: 2, maximum: 256 }
+      attr_reader :description
 
-      def initialize(description:, uuid: nil)
-        raise ArgumentError, 'description is nil' if description.nil?
+      def initialize(description:)
         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?
 
-        uuid ||= SecureRandom.uuid[0..7]
+        self.description = description
+      end
+
+      class << self
+        def clean_description(description)
+          return if description.nil?
+
+          description.strip.gsub(/\s+/, ' ')
+        end
+      end
 
-        super(hash: {
-          uuid: uuid,
-          description: description
-        })
+      def description=(description)
+        @description = self.class.clean_description description
       end
 
-      def required_fields
-        %i[uuid description]
+      def to_h
+        { description: description }
       end
 
+      # Override == and hash so that we can compare Entry objects based
+      # on description alone. This is useful for comparing entries in
+      # an array, for example.
       def ==(other)
         return false unless other.is_a?(Entry)
 
-        uuid == other.uuid && description == other.description
+        description == other.description
+      end
+      alias eql? ==
+
+      def hash
+        description.hash
       end
     end
   end