Add up and down commands

Updated user guide
Updated screenshots
Bumped dependencies to new versions

Author: frossm

graphics/ScreenShot1.jpg

@@ -3,7 +3,7 @@
 
 	<groupId>org.fross</groupId>
 	<artifactId>rpncalc</artifactId>
-	<version>5.7.0</version>
+	<version>5.8.0</version>
 	<packaging>jar</packaging>
 
 	<name>rpncalc</name>
@@ -264,7 +264,7 @@
 		<dependency>
 			<groupId>org.jline</groupId>
 			<artifactId>jline-terminal-jansi</artifactId>
-			<version>3.29.0</version>
+			<version>3.30.3</version>
 		</dependency>
 
 		<!-- https://github.com/frossm/library -->
@@ -279,15 +279,15 @@
 		<dependency>
 			<groupId>org.junit.jupiter</groupId>
 			<artifactId>junit-jupiter</artifactId>
-			<version>5.13.0-M3</version>
+			<version>5.13.0-RC1</version>
 			<scope>test</scope>
 		</dependency>
 
 		<!-- https://mvnrepository.com/artifact/org.jline/jline-reader -->
 		<dependency>
 			<groupId>org.jline</groupId>
 			<artifactId>jline</artifactId>
-			<version>3.29.0</version>
+			<version>3.30.3</version>
 		</dependency>
 
 	</dependencies>

graphics/ScreenShot1.xcf

@@ -1,5 +1,5 @@
 name: rpncalc
-version: '5.7.0'
+version: '5.8.0'
 summary: The command line Reverse Polish Notation (RPN) calculator
 description: |
   RPNCalc is an easy to use command line based Reverse Polish

mdbook/src/Chapters/CalculatorCommands.md

@@ -51,7 +51,7 @@ public static void Parse(StackObj calcStack, StackObj calcStack2, String cmdInpu
       switch (cmdInputCmd) {
 
          /*------------------------------------------------------------------------------
-          * Stack Calculator Commands
+          * Calculator Commands
           *-----------------------------------------------------------------------------*/
          // Undo
          case "undo":
@@ -84,6 +84,16 @@ public static void Parse(StackObj calcStack, StackObj calcStack2, String cmdInpu
             StackCommands.cmdDelete(calcStack, cmdInputParam);
             break;
 
+         // Down: Shift the stack down so Line2 becomes Line1 and the original Line1 goes to the bottom
+         case "down":
+            StackCommands.cmdDown(calcStack);
+            break;
+
+         // Up: Shift the stack up so Line1 becomes Line2 and the last stack items moves into Line1
+         case "up":
+            StackCommands.cmdUp(calcStack);
+            break;
+
          // Factorial
          case "factorial":
          case "fact":

pom.xml

@@ -80,6 +80,7 @@ public static void Display() {
       Output.printColorln(Ansi.Color.WHITE, " copy [#]       Copy line1 or the provided line number and add it to the stack");
       Output.printColorln(Ansi.Color.WHITE, " d [#] [#-#]    Delete line1, the line number provided, or a range of lines provided");
       Output.printColorln(Ansi.Color.WHITE, " dice XdY       Roll a Y sided die X times. Default is 1d6");
+      Output.printColorln(Ansi.Color.WHITE, " down           Shift the stack down moving the Line1 to the bottom of the stack");
       Output.printColorln(Ansi.Color.WHITE, " fact           Take a factorial of line1. Decimals will be dropped");
       Output.printColorln(Ansi.Color.WHITE, " f              Flip the sign of the element at line1");
       Output.printColorln(Ansi.Color.WHITE, " int            Convert line1 to an integer. No rounding is performed");
@@ -95,6 +96,7 @@ public static void Display() {
       Output.printColorln(Ansi.Color.WHITE, " s [#] [#]      Swap the last two elements in the stack or the lines provided");
       Output.printColorln(Ansi.Color.WHITE, " sd [keep]      Standard deviation of stack items. 'keep' will retain stack");
       Output.printColorln(Ansi.Color.WHITE, " u [STACK #]    Undo last action or back to the undo stack defined in 'list undo'");
+      Output.printColorln(Ansi.Color.WHITE, " up             Shift the stack up. Line1 becomes Line2, last stack items becomes Line1");
 
       Output.printColorln(Ansi.Color.YELLOW, "\nConversions:");
       Output.printColorln(Ansi.Color.WHITE, " to%            Convert line1 from a number to a percent (0.715 -> 71.5%)");

snap/snapcraft.yaml

@@ -355,6 +355,25 @@ public static void cmdDice(StackObj calcStack, String param) {
       }
    }
 
+   /**
+    * cmdDown(): Shift the stack up so Line2 becomes Line1 and the original Line1 goes to the bottom
+    *
+    * @param calcStack Primary Stack
+    */
+   public static void cmdDown(StackObj calcStack) {
+      // Save current calcStack to the undoStack
+      calcStack.saveUndo();
+
+      // Ensure we have at least 2 values on the stack
+      if (calcStack.size() < 2) {
+         Output.printColorln(Ansi.Color.RED, "Error: There must be at least two items on the stack");
+         return;
+      }
+
+      // Pop the top item and place it at the bottom
+      calcStack.push(calcStack.pop().toString(), 0);
+   }
+
    /**
     * cmdFactorial(): Take the factorial of the top of stack item dropping decimals if present
     *
@@ -1027,4 +1046,26 @@ public static void cmdUndo(StackObj calcStack, String arg) {
       }
    }
 
+   /**
+    * cmdUp(): Shifts the stack up. The top of the stack item (`line1`) will be pushed back and the last item
+    * will move to the top (`line1`). This is the reverse of `down`
+    *
+    * @param calcStack Primary Stack
+    */
+   public static void cmdUp(StackObj calcStack) {
+      // Save current calcStack to the undoStack
+      calcStack.saveUndo();
+
+      // Ensure we have at least 2 values on the stack
+      if (calcStack.size() < 2) {
+         Output.printColorln(Ansi.Color.RED, "Error: There must be at least two items on the stack");
+         return;
+      }
+
+      // Move the bottom item to the top
+      BigDecimal bottomItem = calcStack.get(0);
+      calcStack.remove(0);
+      calcStack.push(bottomItem);
+   }
+
 }

src/main/java/org/fross/rpncalc/CommandParser.java

@@ -154,6 +154,34 @@ public void push(String item) {
       }
    }
 
+   /**
+    * push(): Add a value to the stack at a specific position
+    *
+    * @param item
+    * @param location
+    */
+   public void push(String item, int location) {
+      BigDecimal[] array = new BigDecimal[calcStack.size()];
+
+      // Loop through stack and build an array of the current stack
+      for (int i = 0; i < calcStack.size(); i++) {
+         array[i] = calcStack.get(i);
+      }
+
+      // Clear the stack and get ready to reload it
+      calcStack.clear();
+
+      // Reload the stack pushing the new value at the right spot
+      for (int i = 0; i < array.length; i++) {
+         if (i == location) {
+            calcStack.push(new BigDecimal(item, this.mc));
+            calcStack.push(array[i]);
+         } else {
+            calcStack.push(array[i]);
+         }
+      }
+   }
+
    /**
     * push(): Add an item onto the top of the stack
     *

src/main/java/org/fross/rpncalc/Help.java

@@ -426,6 +426,68 @@ void testCmdDeleteParmError() {
       assertEquals(5, stk.size());
    }
 
+   /**
+    * Test the `Down` command where we shift the stack down so Line2 becomes Line1 and the original Line1 goes to the end
+    */
+   @Test
+   void testDown() {
+      StackObj stk = new StackObj();
+      stk.push(5.0);
+      stk.push(4.0);
+      stk.push(3.0);
+      stk.push(2.0);
+      stk.push(1.0);
+
+      StackCommands.cmdDown(stk);
+      assertEquals(5, stk.size());
+      assertEquals("1.0", stk.get(0).toString());
+      assertEquals("5.0", stk.get(1).toString());
+      assertEquals("4.0", stk.get(2).toString());
+      assertEquals("3.0", stk.get(3).toString());
+      assertEquals("2.0", stk.get(4).toString());
+      assertEquals(5, stk.size());
+
+      StackCommands.cmdDown(stk);
+      assertEquals(5, stk.size());
+      assertEquals("2.0", stk.get(0).toString());
+      assertEquals("1.0", stk.get(1).toString());
+      assertEquals("5.0", stk.get(2).toString());
+      assertEquals("4.0", stk.get(3).toString());
+      assertEquals("3.0", stk.get(4).toString());
+      assertEquals(5, stk.size());
+   }
+
+   /**
+    * Test the `Up` command where we shift the stack up so Line1 becomes Line2 and the last item becomes Line1
+    */
+   @Test
+   void testUp() {
+      StackObj stk = new StackObj();
+      stk.push(5.0);
+      stk.push(4.0);
+      stk.push(3.0);
+      stk.push(2.0);
+      stk.push(1.0);
+
+      StackCommands.cmdUp(stk);
+      assertEquals(5, stk.size());
+      assertEquals("4.0", stk.get(0).toString());
+      assertEquals("3.0", stk.get(1).toString());
+      assertEquals("2.0", stk.get(2).toString());
+      assertEquals("1.0", stk.get(3).toString());
+      assertEquals("5.0", stk.get(4).toString());
+      assertEquals(5, stk.size());
+
+      StackCommands.cmdUp(stk);
+      assertEquals(5, stk.size());
+      assertEquals("3.0", stk.get(0).toString());
+      assertEquals("2.0", stk.get(1).toString());
+      assertEquals("1.0", stk.get(2).toString());
+      assertEquals("5.0", stk.get(3).toString());
+      assertEquals("4.0", stk.get(4).toString());
+      assertEquals(5, stk.size());
+   }
+
    /**
     * Test those bones! This is hard to get an exact test since the results are random, but we can check the ranges and
     * quantities