dsu 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 01e8ee8331cd245ac664fd67acbc1cb3ffdab02f0693acdce44d73a9f9d7d161
-  data.tar.gz: 1e83c417a55ccffe97b616ac907264dd589da4bafc333ff572f44574b4a671c2
+  metadata.gz: f500cfe8707d939020d669f5196f30167ae14195827f96066a594463b549d6d7
+  data.tar.gz: 4399c77c765050e3af7b6c2310c57063c6a89e46c8a0d69fadac6936a7269501
 SHA512:
-  metadata.gz: 0d3c6832cbbea8cc42aef3d947d6040963fb182318578bd98e52a6c2be435767fb2d0a1755927657068a74ebec88003fbfcc17108072a41d2aabc5b6dd3f507c
-  data.tar.gz: e0fc66db534b39c8fa72ef2bffaa49f3f3bcde9dc18d8facd5573462cf389188d3359f3501d11570529dd8ee1dee76b1c468ec6cb3aa3ec21ed44d26751d1b0c
+  metadata.gz: 9db967077cdbb83eff72ae203f87c88d3bf835f0339b4ec9e15db9fa2918dc0275a01fa6ff2752019505eaf8ffe61fece1dccd64b5255ad74fcbe449acdca22d
+  data.tar.gz: ed725fc2bba98f3a4b8ad2ec3e4e6fc1e36e9a3e20102580f406ec6ea253e7a99a61edbc0b3832473491ff93dd97099db38aa2cd060e6d6c3b4571b33f180840

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## [1.2.0] 2023-05-26
+* Changes
+  - Various refactors.
+  - Bring test coverage to >= 85%.
+## [1.1.2] 2023-05-26
+* Changes
+  - Various refactors.
+  - Add more test coverage.
 ## [1.1.1] - 2023-05-23
 * See previous alpha releases for changes.
 ## [1.1.1.alpha.2] - 2023-05-23

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    dsu (1.1.1)
+    dsu (1.2.0)
       activemodel (~> 7.0, >= 7.0.4.3)
       activesupport (~> 7.0, >= 7.0.4)
       colorize (~> 0.8.1)

data/README.md

@@ -1,4 +1,4 @@
-# `dsu` (alpha)
+# `dsu`
 
 [![GitHub version](http://badge.fury.io/gh/gangelo%2Fdsu.svg)](https://badge.fury.io/gh/gangelo%2Fdsu)
 [![Gem Version](https://badge.fury.io/rb/dsu.svg)](https://badge.fury.io/rb/dsu)
@@ -7,7 +7,9 @@
 [![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. 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.
+`dsu` is a simple, but powerful little gem I wrote for myself to help me manage my Agile DSU (Daily Stand Up) participation. How? by providing a simple command line interface (CLI) which allows me to create, read, update, and delete (CRUD) DSU entries on a daily basis. During my DSU, I'm then able to list, recall and share my DSU activities with my team. DSU entries are grouped by day and are viewed in simple text format from the command line, in a myriad of ways, to meet my personal needs. When viewing DSU entries for a particular day, `dsu` will automatically display the previous day's activities as well, using the typical "what I did yesterday", "What I'm doing today" DSU paradigm. If the DSU date I am trying to view falls on a weekend or Monday, `dsu` will automatically display back to and including the weekend and previous Friday (inclusive), so that I can share what I did over the weekend (if anything) and "last" Friday.
+
+You may want to install it and give it a try. If you happen to find `dsu` helpful, give it a star and tell a friend `:)`
 
 ## Help
 
@@ -52,7 +54,10 @@ If you need to add a DSU entry for tomorrow, you can use the `-t`|`--tomorrow` o
 
 ### Miscellaneous Date
 
-`$ dsu add -d "2022-12-31" "Attend company New Years Coffee Meet & Greet"`
+Both of the below examples will accomplish the same thing, assuming the current year is 2023; the current year is assumed if omitted:
+
+`$ dsu add -d "12/31/2023" "Attend company New Years Coffee Meet & Greet"`
+`$ dsu add -d "12/31" "Attend company New Years Coffee Meet & Greet"`
 
 See the [Dates](#dates) section for more information on acceptable DATE formats used by `dsu`.
 
@@ -62,7 +67,13 @@ You can display DSU entries for a particular day or date (`date`) using any of t
 - `$ dsu list today|n`
 - `$ dsu list tomorrow|t`
 - `$ dsu list yesterday|y`
-- `$ dsu list date|d DATE`
+- `$ dsu list date|d DATE|MNEUMONIC`
+- `$ dsu list dates|dd OPTIONS`
+
+See the [Dates](#dates) section for more information on acceptable DATE formats used by `dsu`.
+See the [Mneumonics](#mneumonics) section for more information on acceptable MNEUMONIC rules and formats used by `dsu`.
+
+IMPORTANT: In some cases the behavior RDNs have on some commands are context dependent; in such cases the behavior will be noted in the help appropriate to the command, for example see the following `dsu` command help: `dsu list help date` and `dsu list help dates`.
 
 ### Examples
 The following displays the entries for "Today", where `Time.now == '2023-05-06 08:54:57.6861 -0400'`
@@ -78,9 +89,8 @@ Friday, (Yesterday) 2023-05-05
   2. Attend new hire meet & greet
 ```
 
-`$ dsu list date "2023-05-06"`
-
-See the [Dates](#dates) section for more information on acceptable DATE formats used by `dsu`.
+`$ dsu list date 5/6/2023`
+`$ dsu list date 5/6`
 
 ```shell
 #=>
@@ -91,11 +101,45 @@ Friday, (Yesterday) 2023-05-05
   1. Pick up ticket IN-12345
   2. Attend new hire meet & greet
 ```
+
+#### Listing Date Ranges
+For more information, see the [Mneumonics](#mneumonics) section for more information on acceptable MNEUMONIC rules and formats used by `dsu`.
+
+Output omitted for brevity...
+
+Display the DSU entries for the last 3 days.
+
+`dsu list dates --from yesterday --to -2`
+
+Display the DSU entries for 1/1 to 1/4.
+
+`dsu list dates --from 1/1 --to +3`
+
+Display the DSU entries for 1/2 to 1/5.
+
+`dsu list dates --from 1/5 --to -3`
+
+Display the DSU entries for the last week.
+
+`dsu list dates --from today --to -7`
+
+Display the DSU entries back 1 week from yesterday's date. *This example is silly,* but it illustrates the fact that you can use relative mneumonics for both `--from` and `--to` options. While you *can* use relative mneumonics for both `--from` and `--to` options, there is always a more intuitive way.
+
+`dsu list dates --from -7 --to +6`
+
+The above can be accomplished MUCH easier by using the `yesterday` mneumonic. This will display the DSU entries back 1 week from yesterday's date.
+
+`dsu list dates --from yesterday --to -6`
+
 ## 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 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).*
+You can edit DSU entry groups by date. `dsu` will allow you to edit a DSU entry group using the `dsu edit SUBCOMMAND` date (`n|today|t|tomorrow|y|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 for the DSU date, the editor will open and allow you to add entries for that date. If you have the `:carry_over_entries_to_today` configuration option setting set to `true`, entries from the last DSU date will be copied into the editor for your convenience.
 
-Note: See the "[Customizing the `dsu` Configuration File](#customizing-the-dsu-configuration-file)"" section to configure `dsu` to use the editor of your choice.
+*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 and other configuration options to make editing more convenient.
 
 - `$ dsu edit today|n`
 - `$ dsu edit tomorrow|t`
@@ -111,15 +155,22 @@ 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
-# [ENTRY DESCRIPTION]
+################################################################################
+# Editing DSU Entries for Tuesday, (Today) 2023-05-23 EDT
+################################################################################
+
+################################################################################
+# DSU ENTRIES
+################################################################################
 
 Interative planning meeting 11:00AM.
 Pair with Chad on ticket 31211.
 Investigate spike ticket 31255.
 Review Kelsey's PR ticket 30721.
 
-# INSTRUCTIONS:
+################################################################################
+# INSTRUCTIONS
+################################################################################
 #    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.
@@ -128,6 +179,7 @@ Review Kelsey's PR ticket 30721.
 # REORDER a DSU entry: reorder the ENTRY DESCRIPTIONs in order preference.
 #
 # *** When you are done, save and close your editor ***
+################################################################################
 ```
 
 #### Edit an Entry
@@ -193,7 +245,9 @@ Config file (/Users/<whoami>/.dsu) contents:
 editor: nano
 entries_display_order: desc
 entries_file_name: "%Y-%m-%d.json"
-entries_folder: "/Users/<whoami>/dsu/entries"
+entries_folder: "/Users/gangelo/dsu/entries"
+carry_over_entries_to_today: false
+include_all: false
 ```
 
 Where `<whoami>` would be your username (`$ whoami` on nix systems)
@@ -228,11 +282,34 @@ Default: `'/Users/<whoami>/dsu/entries'` on nix systems.
 
 Where `<whoami>` would be your username (`$ whoami` on nix systems)
 
+##### carry_over_entries_to_today
+Applicable to the `dsu edit` command.  Valid values are `true|false`. If `true`, when editing DSU entries *for the first time* on any  given day (e.g. `dsu edit today`), DSU entries from the previous day will be copied into the editing session. If there are no DSU entries from the previous day, `dsu` will search backwards up to 7 days to find a DSU date that has entries to copy. If after searching back 7 days, no DSU entries are found, the editor session will simply start with no previous DSU entries.
+
+Default: false
+
+##### include_all
+Applicable to `dsu` commands that display DSU date lists (e.g. `dsu list` commands). Valid values are `true|false`. If `true`, all DSU dates within the specified range will be displayed. If `false`, DSU dates between the first and last DSU dates that have NO entries *will NOT be displayed*. The default is taken from the dsu configuration setting `:include_all`, see `dsu config info`.
+
+Default: false
+
 ## 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.`
+DATE may be any date string that can be parsed using `Time.parse`. Consequently, you may 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/2023'); Time.parse('1/2') # etc.`
+
+## Mneumonics
+
+These notes apply to anywhere MNEUMONIC is used...
+
+A *mneumonic* may be any of the following: `n|today|t|tomorrow|y|yesterday|+n|-n`.
+
+Where `n`, `t`, `y` are aliases for `today`, `tomorrow`, and `yesterday`, respectively.
+
+Where `+n`, `-n` are relative date mneumonics (RDNs). Generally speaking, RDNs are relative to the current date. For example, a RDN of `+1` would be equal to `Time.now + 1.day` (or tomorrow), and a RDN of `-1` would be equal to `Time.now - 1.day` (or yesterday).
+
+NOTE: In some cases the behavior RDNs have on some commands are context dependent; in such cases the behavior will be noted in the help appropriate to the command, for example see the following `dsu` command help: `dsu list help date` and `dsu list help dates`.
+
 
 ## Installation
 

data/lib/dsu/models/entry_group.rb

@@ -16,8 +16,8 @@ module Dsu
     # This class represents a group of entries for a given day. IOW,
     # things someone might want to share at their daily standup (DSU).
     class EntryGroup
-      include ActiveModel::Model
       extend Support::EntryGroupLoadable
+      include ActiveModel::Model
       include Support::TimeFormatable
 
       attr_accessor :time
@@ -58,10 +58,7 @@ module Dsu
       end
 
       def clone
-        clone = super
-
-        clone.entries = clone.entries.map(&:clone)
-        clone
+        self.class.new(time: time, entries: entries.map(&:clone))
       end
 
       def entries=(entries)

data/lib/dsu/services/ai/tense_translator_service.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require 'net/http'
+require 'json'
+
+module Dsu
+  module Services
+    module AI
+      # SERVICE_URI = URI('https://api.openai.com/v1/chat/completions').freeze
+
+      # class TenseTranslatorService
+      #   def initialize(entries:, options: {})
+      #     @entries = entries
+      #     @options = options.merge({ tense: :past })
+      #   end
+
+      #   def call
+      #     request = Net::HTTP::Post.new(SERVICE_URI.path)
+      #     request['Content-Type'] = 'application/json'
+      #     request['Authorization'] = "Bearer #{configuration[:ai_api_key]}"
+
+      #     request.body = request_body
+
+      #     response = http.request(request)
+      #     JSON.parse(response.body)
+      #   end
+
+      #   private
+
+      #   attr_reader :entries, :options
+
+      #   def http
+      #     Net::HTTP.new(SERVICE_URI.host, SERVICE_URI.port).tap do |http|
+      #       http.use_ssl = true
+      #     end
+      #   end
+
+      #   def request_body
+      #     {
+      #       messages: [
+      #         {
+      #           role: 'system',
+      #           content: 'You are a helpful assistant.'
+      #         },
+      #         {
+      #           role: 'user',
+      #           content: message
+      #         }
+      #       ]
+      #     }.to_json
+      #   end
+
+      #   def instructions
+      #     @instructions ||= "Please translate the following sentences into the past #{options[:tense]}:\n\n"
+      #   end
+
+      #   def message
+      #     @message ||= "#{instructions}\n\n#{entries.map(&:description).join("\n")}"
+      #   end
+      # end
+    end
+  end
+end

data/lib/dsu/support/entry_group_fileable.rb

@@ -8,58 +8,36 @@ module Dsu
     # TODO: I hate this module; refactor it!!!
     # This module expects the following attributes to be defined: :time, :options
     module EntryGroupFileable
-      extend Support::Configurable
-
-      class << self
-        def entry_group_file_exists?(time:)
-          File.exist?(entry_group_file_path(time: time))
-        end
-
-        def entry_group_file_path(time:)
-          File.join(entries_folder, entries_file_name(time: time))
-        end
-
-        def entries_folder
-          configuration[:entries_folder]
-        end
-
-        def entries_file_name(time:)
-          time.strftime(configuration[:entries_file_name])
-        end
-
-        # def configuration
-        #   Services::ConfigurationLoaderService.new.call
-        # end
-      end
+      include Support::Configurable
 
       def entry_group_file_exists?
-        EntryGroupFileable.entry_group_file_exists?(time: time)
+        File.exist?(entry_group_file_path)
       end
 
+      private
+
       def entry_group_path_exists?
         Dir.exist?(entries_folder)
       end
 
       def entry_group_file_path
-        EntryGroupFileable.entry_group_file_path(time: time)
+        File.join(entries_folder, entries_file_name)
       end
 
       def entries_folder
-        @entries_folder ||= EntryGroupFileable.entries_folder
+        @entries_folder ||= configuration_or_options_configuration[:entries_folder]
       end
 
       def entries_file_name
-        @entries_file_name ||= EntryGroupFileable.entries_file_name(time: time)
+        @entries_file_name ||= time.strftime(configuration_or_options_configuration[:entries_file_name])
       end
 
       def create_entry_group_path_if!
         FileUtils.mkdir_p(entries_folder) unless entry_group_path_exists?
       end
 
-      private
-
-      def configuration
-        @configuration ||= options[:configuration] || EntryGroupFileable.configuration
+      def configuration_or_options_configuration
+        @configuration_or_options_configuration ||= options[:configuration] || configuration
       end
     end
   end

data/lib/dsu/validators/description_validator.rb

@@ -12,8 +12,8 @@ module Dsu
         end
 
         unless description.is_a?(String)
-          record.errors.add(field, 'is the wrong object type. ' \
-                                   "\"String\" was expected, but \"#{description.class}\" was received.")
+          record.errors.add(:description, 'is the wrong object type. ' \
+                                          "\"String\" was expected, but \"#{description.class}\" was received.")
           return
         end
 

data/lib/dsu/validators/entries_validator.rb

@@ -11,12 +11,14 @@ module Dsu
 
       def validate(record)
         unless record.entries.is_a?(Array)
-          record.errors.add(:entries_entry, 'is the wrong object type. ' \
-                                            "\"Array\" was expected, but \"#{record.entries.class}\" was received.")
+          record.errors.add(:entries, 'is the wrong object type. ' \
+                                      "\"Array\" was expected, but \"#{record.entries.class}\" was received.")
+          return
         end
 
-        validate_entry_types record
-        validate_unique_entry record
+        return if validate_entry_types record
+        return if validate_unique_entry record
+
         validate_entries record
       end
 
@@ -26,10 +28,12 @@ module Dsu
         record.entries.each do |entry|
           next if entry.is_a? Dsu::Models::Entry
 
-          record.errors.add(:entries_entry, 'entry Array element is the wrong object type. ' \
-                                            "\"Entry\" was expected, but \"#{entry.class}\" was received.",
+          record.errors.add(:entries, 'Array element is the wrong object type. ' \
+                                      "\"Entry\" was expected, but \"#{entry.class}\" was received.",
             type: Support::FieldErrors::FIELD_TYPE_ERROR)
         end
+
+        record.errors.any?
       end
 
       def validate_unique_entry(record)
@@ -42,10 +46,12 @@ module Dsu
 
         non_unique_descriptions = descriptions.select { |description| descriptions.count(description) > 1 }.uniq
         if non_unique_descriptions.any?
-          record.errors.add(:entries_entry, 'contains a duplicate entry: ' \
-                                            "#{format_non_unique_descriptions(non_unique_descriptions)}.",
+          record.errors.add(:entries, 'Array contains a duplicate entry: ' \
+                                      "#{format_non_unique_descriptions(non_unique_descriptions)}.",
             type: Support::FieldErrors::FIELD_DUPLICATE_ERROR)
         end
+
+        record.errors.any?
       end
 
       def validate_entries(record)

data/lib/dsu/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Dsu
-  VERSION = '1.1.1'
+  VERSION = '1.2.0'
 end

data/lib/dsu.rb

@@ -7,10 +7,6 @@ require 'pry-byebug' if ENV['DEV_ENV']
 require 'thor'
 require 'time'
 
-Dir.glob("#{__dir__}/lib/core/**/*.rb").each do |file|
-  require file
-end
-
 Dir.glob("#{__dir__}/dsu/**/*.rb").each do |file|
   require file
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dsu
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Gene M. Angelo, Jr.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-05-23 00:00:00.000000000 Z
+date: 2023-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -118,18 +118,25 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
-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"
+description: '    dsu is a small, but powerful gem that helps manage your Agile DSU
+  (Daily Stand Up) participation. How? by providing a simple command-line interface
+  (CLI) which allows you to create, read, update, and delete (CRUD) your DSU entries
+  (activities). During your DSU, you can use dsu''s CLI to list and share what you
+  did "yesterday" and what you plan on doing "Today" with your team. DSU entries are
+  grouped by day and can be viewed in simple text format from the command-line. When
+  displaying DSU entries for a particular day, dsu will also display DSU entries for
+  the previous day. If the day you are trying to display falls on a weekend or Monday,
+  dsu will automatically search back to include the weekend and previous Friday dates
+  and display the entries; this is so that you can share what you did over the weekend
+  (if anything) and the previous Friday with your team. When searching for "Yesterday''s"
+  DSU entries, dsu will automatically search back a maximimum of 7 days to find DSU
+  entries to share. This could be helpful if, for example, if you are sharing what
+  you plan to do today (Wednesday), but were sick yesterday (Tuesday); dsu in this
+  case will display the last DSU entries it can find searching backwards a maximum
+  of 7 days. dsu does a LOT more and is perfect for command-line junkies and those
+  who LOVE simplicity. Give it a try and a star if you like it!
+
+  '
 email:
 - public.gma@gmail.com
 executables:
@@ -158,6 +165,7 @@ files:
 - lib/dsu/core/ruby/not_today.rb
 - lib/dsu/models/entry.rb
 - lib/dsu/models/entry_group.rb
+- lib/dsu/services/ai/tense_translator_service.rb
 - lib/dsu/services/configuration_loader_service.rb
 - lib/dsu/services/entry_group_deleter_service.rb
 - lib/dsu/services/entry_group_editor_service.rb