fix: Resolve bug in stringify logic for cli object cmds

The stringify logic(which may not be needed?) that enables users
to use the object store as a simple key/value string store had a
bug in the logic which checked out large the bytes were before
inserting it into the buffer.

This changes resolves that error and also adds some more documentation
around these commands.

TODO.md

@@ -22,7 +22,6 @@ thought into this feature that it can become a game changer for Gofer as a whole
 
 # Small things I want to keep track of that I definitely need to do.
 
-* Revisit making it so that object and secret stores can icrementally upload
 * When the user tries to get a run and the status if failed, we should automaticallly print the failed reasonings and
   then tell the user how to go about finding more information.
 * When the user runs the pipeline config on it's own we should pretty print the json so that it's debuggable easily.

gofer/src/cli/pipeline/object.rs

@@ -1,6 +1,6 @@
 use crate::cli::Cli;
 use anyhow::{bail, Context, Result};
-use bytes::{Buf, BufMut};
+use bytes::BufMut;
 use clap::{Args, Subcommand};
 use comfy_table::{Cell, CellAlignment, Color, ContentArrangement};
 use futures::StreamExt;
@@ -26,6 +26,10 @@ pub enum ObjectCommands {
     },
 
     /// Read an object from the pipeline store
+    #[command(after_help = r#"Examples:
+  gofer pipeline object get simple test > /tmp/gofer_test
+  gofer pipeline object get simple test --stringify
+"#)]
     Get {
         /// Pipeline Identifier.
         id: String,
@@ -44,6 +48,10 @@ pub enum ObjectCommands {
     /// on configuration). Once this limit is reached the _oldest_ object will be removed to make space for the new object.
     ///
     /// You can store both regular text values or read in entire files using the '@' symbol and piping.
+    #[command(after_help = r#"Examples:
+  gofer pipeline object put simple test ~/.bin/gofer
+  echo "hello" > gofer pipeline object put simple test @
+"#)]
     Put {
         /// Pipeline Identifier.
         id: String,
@@ -163,7 +171,9 @@ impl Cli {
             while let Some(chunk) = object.next().await {
                 let chunk = chunk?;
 
-                if buffer.remaining() > chunk.len() {
+                let remaining_space = buffer.capacity() - buffer.len();
+
+                if remaining_space > chunk.len() {
                     buffer.put(chunk);
                 } else {
                     bail!("Could not stringify object; object larger than 1KB");

gofer/src/cli/run/object.rs

@@ -1,6 +1,6 @@
 use crate::cli::Cli;
 use anyhow::{bail, Context, Result};
-use bytes::{Buf, BufMut};
+use bytes::BufMut;
 use clap::{Args, Subcommand};
 use comfy_table::{Cell, CellAlignment, Color, ContentArrangement};
 use futures::StreamExt;
@@ -29,6 +29,10 @@ pub enum ObjectCommands {
     },
 
     /// Read an object from the run store
+    #[command(after_help = r#"Examples:
+  gofer run object get simple 1 test > /tmp/gofer_test
+  gofer run object get simple 1 test --stringify
+"#)]
     Get {
         /// Pipeline Identifier.
         pipeline_id: String,
@@ -53,6 +57,10 @@ pub enum ObjectCommands {
     /// Run objects are kept individual to each run and removed after a certain run limit. This means that after a certain
     /// amount of runs for a particular pipeline a run's objects will be discarded. The limit of amount of objects you can
     /// store per run is of a much higher limit.
+    #[command(after_help = r#"Examples:
+  gofer run object put simple 1 test ~/.bin/gofer
+  echo "hello" > gofer run object put simple 1 test @
+"#)]
     Put {
         /// Pipeline Identifier.
         pipeline_id: String,
@@ -197,7 +205,9 @@ impl Cli {
             while let Some(chunk) = object.next().await {
                 let chunk = chunk?;
 
-                if buffer.remaining() > chunk.len() {
+                let remaining_space = buffer.capacity() - buffer.len();
+
+                if remaining_space > chunk.len() {
                     buffer.put(chunk);
                 } else {
                     bail!("Could not stringify object; object larger than 1KB");