dsu 0.1.0.alpha.3 → 0.1.0.alpha.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: abbd29418f4cd3c86a0e826ed9a43d7aba9e11d455c1fcd34024eeb6f1cff0b2
-  data.tar.gz: e99710491e91d8302582bec2e201244616a126d509e8915c57a5b13e54581418
+  metadata.gz: c27f3abb1daf923976963a1612f08258fd8a0460d672c1674dc2c149aa69ed03
+  data.tar.gz: 8611ccb51518e24f9497ffc0c02a7b1dd567321419728f727969718620da5b59
 SHA512:
-  metadata.gz: 46bb2a7b817f6dcc413dbf343598dd9c016752eb84657f7b47c0bb19a923618c0e7ef0dc0e59f2a410808537ead6b26f2e647faabe93932c931cf1040be63acb
-  data.tar.gz: 348649411b52ed829e640e7c1e5a7d00c6df99bbaa80051a9f98176d34a0c078db4de035ba2a8137bb3295a57e5a500f223a3c7f7c7bf2868356bc226933467c
+  metadata.gz: d1b1bcd4f9222bf2629ffa0d02434b429280f20e760676f2cde2eaca40860f56952995ce7a69628981cc0f7caf941a48c07cca91a9c1f96b4334e872d5a7374a
+  data.tar.gz: 0436e614b146dbfd71ca098cc699d7b6de99cafe47cfbad8141ac6268853b6f7d68285d8222053796bb2db729cf86c14e03e3fa3f2dca97554fd78998449fbbe

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## [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.4)
       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
@@ -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`).
 
-#### 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,7 +95,7 @@ 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.
 
@@ -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,6 +236,12 @@ 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).
 

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.4'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dsu
 version: !ruby/object:Gem::Version
-  version: 0.1.0.alpha.3
+  version: 0.1.0.alpha.4
 platform: ruby
 authors:
 - Gene M. Angelo, Jr.
@@ -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: