General CLI overhaul (#44)

* rewrite clap opts to use subcommands

* rewrite using match

* handle default destination from clap argument

* cleanup braces

* remove cmd option, force stat default

* handle cd -f together with the regular cd

* subcommand shorthands

* add short status option

* added plain status option

* improve the help

* fix ci test

* refactor location.go_to and add game.visit

* preserve destination side-effects on cd -f

* set quiet/plain as (still unused) globals

* global quiet/plain logging with once_cell

* use quiet/plain in battle

* quiet/plain should be global commands

* more output cleanup

* improve tombstone output

* another tombstone improvement

* no battles at home

* true up readme examples

* update changelog

* use cd -f for ci to prevent error exit code

* add --force to cargo install example

* remove redundant help

* clap help improvements

* format

Author: facundoolano

.travis.yml

@@ -23,7 +23,7 @@ script:
   - cargo +nightly clippy
   - cargo fmt -- --check
   - cargo run
-  - cargo run -- .
+  - cargo run -- cd -f .
 
 before_deploy:
   - if [ "$TRAVIS_OS_NAME" = "linux" ]; then export TARGET=x86_64-unknown-linux-musl  ; fi

CHANGELOG.md

@@ -2,15 +2,18 @@
 
 ## Unreleased
 ### Added
-* --battle initiates a battle (with a probability) at the hero's current location b349362
-* --mv sets the hero location without initiating battles, intended for custom shell integrations 7ab2401
-* --stat,-s prints the hero status 8da1090
-*  This Changelog
+* This Changelog
+* `rpg cd -f` sets the hero location without initiating battles, intended for custom shell integrations
+* `rpg battle` initiates a battle (with a probability) at the hero's current location.
+* --quiet,-q option to reduce output while changing directories and printing the hero status.
+* --plain to facilitate scripting around the hero stats.
+* Documentation for shell integrations.
 
 ### Changed
-* `rpg` without args moves the hero to home and `rpg -` moves it to `$OLDPWD` (when present) to match the `cd` behavior 4ba4c59
-* --shop,-s renamed to --buy,-b and --inventory,-i renamed to --use,-u f737a81
-* always print hero location on cd command 05b661e
+* General command overhaul, now all actions are done via a subcommand: `rpg cd`, `rpg stat`, etc., with status printing being the default.
+* `rpg cd` without args moves the hero to home and `rpg cd -` moves it to `$OLDPWD` (when present) to match the `cd` behavior 4ba4c59
+* --shop,-s renamed to buy,b and --inventory,-i renamed to use,u f737a81
+* Removed most empty lines from output.
 
 ## [0.3.0](https://github.com/facundoolano/rpg-cli/releases/tag/0.2.0) - 2021-05-28
 ### Added

Cargo.lock

@@ -15,3 +15,4 @@ colored = "2"
 clap = "3.0.0-beta.2"
 typetag = "0.1"
 dunce = "1.0.1"
+once_cell = "1.7.2"

Cargo.toml

@@ -22,7 +22,7 @@ Just download the binary for your platform (linux/macOS/windows) from the [GitHu
 ### Installing with Cargo
 Assuming you have [Rust and Cargo installed](https://doc.rust-lang.org/cargo/getting-started/installation.html#install-rust-and-cargo):
 
-    $ cargo install --git https://github.com/facundoolano/rpg-cli --branch main
+    $ cargo install --git https://github.com/facundoolano/rpg-cli --force --branch main
 
 The binary should be available as `rpg-cli` (assuming you have `~/.cargo/bin` in your `$PATH`).
 
@@ -39,16 +39,16 @@ The most basic type of integration consists in wrapping rpg-cli in a shell funct
 ```sh
 rpg () {
     rpg-cli "$@"
-    cd "$(rpg-cli --pwd)"
+    cd "$(rpg-cli pwd)"
 }
 ```
 
 Or, if you want to go all the way and *really* use it in place of `cd`:
 
 ```sh
 cd () {
-    rpg-cli "$@"
-    builtin cd "$(rpg-cli --pwd)"
+    rpg-cli cd "$@"
+    builtin cd "$(rpg-cli pwd)"
 }
 ```
 
@@ -65,7 +65,6 @@ This example session assumes a basic `rpg` function as described in the previous
 The first time you run the program, a new hero is created at the user's home directory.
 
     ~ $ rpg
-
         hero[1]@home
         hp:[xxxxxxxxxx] 25/25
         xp:[----------] 0/30
@@ -76,9 +75,8 @@ The first time you run the program, a new hero is created at the user's home dir
 
 When running without parameters, as above, the hero status is printed (health points, accumulated experience, etc.). If you pass in a path as parameter, that will instruct the hero to move:
 
-    ~ $ rpg dev/
+    ~ $ rpg cd dev/
     ~/dev $ rpg
-
         hero[1]@~/dev
         hp:[xxxxxxxxxx] 25/25
         xp:[----------] 0/30
@@ -90,38 +88,34 @@ When running without parameters, as above, the hero status is printed (health po
 In this case, the hero moved to `~/dev/facundoolano`. Sometimes enemies will appear as you move through the directories,
 and both characters will engage in battle:
 
-    ~/dev $ rpg facundoolano/
-
+    ~/dev $ rpg cd facundoolano/
        snake[1][xxxx]@~/dev/facundoolano
-
        snake[1][x---] -12hp
         hero[1][xxxx]  dodged!
        snake[1][----] -12hp
-
-        hero[1][xxxx][xxxx]@~/dev/facundoolano +24xp +75g
+        hero[1][xxxx] +24xp +75g
+        hero[1][xxxx][xxxx]@~/dev/facundoolano
 
 Each character attacks in turn (the frequency being determined by their `speed` stat).
 Whenever you win a fight, your hero gains experience points and eventually raises its level, along with their other stats.
 
 When you return to the home directory, the hero's health points are restored:
 
-    ~/dev/facundoolano/rpg-cli $ rpg ~
+    ~/dev/facundoolano/rpg-cli $ rpg cd ~
         hero[1][xxxx][xxxx]@home +20hp
 
 Also at the home directory, you can buy items and equipment:
 
-    ~ $ rpg --shop
-
+    ~ $ rpg buy
         sword[1]    500g
         shield[1]   500g
         potion[1]   200g
         escape      1000g
 
         funds: 275g
 
-    ~ $ rpg --shop potion
+    ~ $ rpg buy potion
     ~ $ rpg
-
         hero[3]@home
         hp:[xxxxxxxxxx] 37/37
         xp:[xx--------] 19/155
@@ -130,29 +124,22 @@ Also at the home directory, you can buy items and equipment:
         item:{potion[1]x1}
         75g
 
-The shortcut `rpg -s p` would also work above.
+The shortcut `rpg b p` would also work above.
 
 The further from home you move the hero, the tougher the enemies will get. If you go to far or too long without restoring your health your hero is likely to die in battle, causing the game to restart.
 
-    ~ $ rpg ~/dev/facundoolano/rpg-cli/target/debug/examples/
-
+    ~ $ rpg cd ~/dev/facundoolano/rpg-cli/target/debug/examples/
          orc[1][xxxx]@~/dev/facundoolano/rpg-cli
-
         hero[1][x---] -20hp critical!
          orc[1][xxx-] -9hp
         hero[1][----] -16hp
-
-        hero[1][----][----]@~/dev/facundoolano/rpg-cli 💀
+        hero[1][----] 💀
 
 Death is permanent: you can't save your progress and reload after dying, but if you take your new hero to the location of the previous one's death,
 you can recover gold, items and equipment:
 
     ~ $ rpg ~/dev/facundoolano/rpg-cli/
-
-        🪦 @~/dev/facundoolano/rpg-cli/
-
-        +potionx1
-        +75g
+       hero[🪦]@~/dev/facundoolano/rpg-cli/ +potionx1 +75g
 
 
 Try `rpg --help` for more options.

README.md

@@ -13,7 +13,7 @@ you need to write a function so the working directory is changed to match that o
 ```sh
 rpg () {
     rpg-cli "$@"
-    cd "$(rpg-cli --pwd)"
+    cd "$(rpg-cli pwd)"
 }
 ```
 
@@ -24,7 +24,7 @@ If you use fish shell, update `~/.config/fish/config.fish` instead:
 ```fish
 function rpg
     rpg-cli $argv
-    cd (rpg-cli --pwd)
+    cd (rpg-cli pwd)
 end
 ```
 
@@ -34,18 +34,20 @@ If you like having enemies popping up while using `cd`, you can override that in
 
 ```sh
 cd () {
-    rpg-cli "$@"
-    builtin cd "$(rpg-cli --pwd)"
+    rpg-cli cd "$@"
+    builtin cd "$(rpg-cli pwd)"
 }
 ```
 
 ## Custom integration commands
 
 To better adapt for different usage patterns, finer-grained commands are provided:
 
-* `rpg-cli --mv <path>` will set the hero's location to `<path>` without initiating battles.
-* `rpg-cli --pwd` will print the hero's current location.
-* `rpg-cli --battle` will initiate a battle with a probability that changes based on the distance from home. If the battle is lost the exit code of the program will be non-negative.
+* `rpg-cli cd --force <path>` will set the hero's location to `<path>` without initiating battles.
+* `rpg-cli pwd` will print the hero's current location.
+* `rpg-cli battle` will initiate a battle with a probability that changes based on the distance from home. If the battle is lost the exit code of the program will be non-negative.
+* `rpg-cli stat --quiet` will return hero stats in a succinct format.
+* `rpg-cli stat --plain` will return hero stats as tab separated fields, to facilitate parsing (e.g. to integrate to the prompt).
 
 ## Prevent intermediate battles
 
@@ -60,8 +62,8 @@ A better alternative for this usage pattern is enabled by the other integration
 ```sh
 cd () {
     builtin cd "$@"
-    rpg-cli --mv .
-    rpg-cli --battle
+    rpg-cli cd -f .
+    rpg-cli battle
 }
 ```
 
@@ -70,7 +72,7 @@ cd () {
 Another way to use rpg-cli is to initiate battles when attempting to execute file-modifying operations. Only when the battle is won the operation is allowed:
 
 ```sh
-alias rpg-battle="rpg-cli --mv . && rpg-cli --battle"
+alias rpg-battle="rpg-cli cd -f . && rpg-cli battle"
 
 alias rm="rpg-battle && rm"
 alias rmdir="rpg-battle && rmdir"

shell/README.md

@@ -72,23 +72,30 @@ impl Game {
     /// at a time, with some chance of enemies appearing on each one.
     pub fn go_to(&mut self, dest: &Location, run: bool, bribe: bool) -> Result<(), Error> {
         while self.location != *dest {
-            self.location.go_to(&dest);
-            if self.location.is_home() {
-                self.visit_home();
-            } else if self.pick_up_tombstone() {
-                return Ok(());
-            } else if let Some(mut enemy) = self.maybe_spawn_enemy() {
-                return self.maybe_battle(&mut enemy, run, bribe);
+            self.visit(self.location.go_to(&dest));
+
+            if !self.location.is_home() {
+                if let Some(mut enemy) = self.maybe_spawn_enemy() {
+                    return self.maybe_battle(&mut enemy, run, bribe);
+                }
             }
         }
         Ok(())
     }
 
+    /// Set the hero's location to the one given, and apply related side effects.
+    pub fn visit(&mut self, location: Location) {
+        self.location = location;
+        if self.location.is_home() {
+            let recovered = self.player.heal_full();
+            log::heal(&self.player, &self.location, recovered);
+        }
+        self.pick_up_tombstone();
+    }
+
     /// Set the current location to home, and apply related side-effects
     pub fn visit_home(&mut self) {
-        self.location = Location::home();
-        let recovered = self.player.heal_full();
-        log::heal(&self.player, &self.location, recovered);
+        self.visit(Location::home());
     }
 
     pub fn add_item(&mut self, name: &str, item: Box<dyn Item>) {
@@ -128,7 +135,6 @@ impl Game {
     /// If there's a tombstone laying in the current location, pick up its items
     fn pick_up_tombstone(&mut self) -> bool {
         if let Some(mut tombstone) = self.tombstones.remove(&self.location) {
-            log::tombstone_found(&self.location);
             tombstone.pick_up(self);
             true
         } else {
@@ -194,7 +200,7 @@ impl Game {
             self.gold += gold;
             let level_up = self.player.add_experience(xp);
 
-            log::battle_won(&self.player, xp, level_up, gold);
+            log::battle_won(&self, xp, level_up, gold);
             Ok(())
         } else {
             // leave hero items in the location

src/game/mod.rs

@@ -63,7 +63,7 @@ impl Tombstone {
 
         game.gold += self.gold;
 
-        log::tombstone_items(&to_log, self.gold);
+        log::tombstone(&game.location, &to_log, self.gold);
     }
 }
 

src/game/tombstone.rs

@@ -39,20 +39,15 @@ impl Location {
         self.path == dirs::home_dir().unwrap()
     }
 
-    /// Move this location one step towards the given destination
-    pub fn go_to(&mut self, dest: &Self) {
-        if !dest.path.starts_with(&self.path) {
-            self.path = self.path.parent().unwrap().to_path_buf();
-        } else if dest != self {
-            let next = dest
-                .path
-                .strip_prefix(&self.path)
-                .unwrap()
-                .components()
-                .next()
-                .unwrap();
-            self.path = self.path.join(next);
-        }
+    /// Return a new location that it's one dir closer to the given destination.
+    pub fn go_to(&self, dest: &Self) -> Self {
+        let next = if !dest.path.starts_with(&self.path) {
+            self.path.parent().unwrap().to_path_buf()
+        } else {
+            let self_len = self.path.components().count();
+            dest.path.components().take(self_len + 1).collect()
+        };
+        Self { path: next }
     }
 
     fn distance_from(&self, other: &Self) -> Distance {
@@ -159,28 +154,28 @@ mod tests {
 
     #[test]
     fn test_walk_towards() {
-        let mut source = location_from("/Users/facundo/dev/");
+        let source = location_from("/Users/facundo/dev/");
         let dest = location_from("/");
 
-        source.go_to(&dest);
+        let source = source.go_to(&dest);
         assert_eq!(location_from("/Users/facundo/"), source);
-        source.go_to(&dest);
+        let source = source.go_to(&dest);
         assert_eq!(location_from("/Users/"), source);
-        source.go_to(&dest);
+        let source = source.go_to(&dest);
         assert_eq!(location_from("/"), source);
-        source.go_to(&dest);
+        let source = source.go_to(&dest);
         assert_eq!(location_from("/"), source);
 
-        let mut source = location_from("/Users/facundo/rust/rpg");
+        let source = location_from("/Users/facundo/rust/rpg");
         let dest = location_from("/Users/facundo/erlang/app");
 
-        source.go_to(&dest);
+        let source = source.go_to(&dest);
         assert_eq!(location_from("/Users/facundo/rust/"), source);
-        source.go_to(&dest);
+        let source = source.go_to(&dest);
         assert_eq!(location_from("/Users/facundo/"), source);
-        source.go_to(&dest);
+        let source = source.go_to(&dest);
         assert_eq!(location_from("/Users/facundo/erlang"), source);
-        source.go_to(&dest);
+        let source = source.go_to(&dest);
         assert_eq!(location_from("/Users/facundo/erlang/app"), source);
     }