Merge pull request #1007 from SierraSoftworks/refactor/inventory

refactor: Switch to dynamically discovering commands

Cargo.toml

@@ -17,6 +17,7 @@ futures = "0.3"
 gtmpl = "0.7"
 human-errors = "0.1.3"
 http = "0.2"
+inventory = "0.3.13"
 itertools = "0.12"
 keyring = { version = "2.1", optional = true }
 lazy_static = "1.4"

src/commands/apps.rs

@@ -1,8 +1,11 @@
 use super::*;
 
-pub struct AppsCommand {}
+pub struct AppsCommand;
 
-impl Command for AppsCommand {
+crate::command!(AppsCommand);
+
+#[async_trait]
+impl CommandRunnable for AppsCommand {
     fn name(&self) -> String {
         String::from("apps")
     }
@@ -12,10 +15,7 @@ impl Command for AppsCommand {
             .about("list applications which can be run through Git-Tool")
             .long_about("Gets the list of applications that you have added to your configuration file. These applications can be run through the `open` and `scratch` commands.")
     }
-}
 
-#[async_trait]
-impl CommandRunnable for AppsCommand {
     #[tracing::instrument(name = "gt apps", err, skip(self, core, _matches))]
     async fn run(
         &self,

src/commands/auth.rs

@@ -1,9 +1,12 @@
 use super::*;
 use clap::Arg;
 
-pub struct AuthCommand {}
+pub struct AuthCommand;
 
-impl Command for AuthCommand {
+crate::command!(AuthCommand);
+
+#[async_trait]
+impl CommandRunnable for AuthCommand {
     fn name(&self) -> String {
         String::from("auth")
     }
@@ -26,10 +29,7 @@ impl Command for AuthCommand {
                 .help("specifies the token to be set (don't use this unless you have to)")
                 .action(clap::ArgAction::Set))
     }
-}
 
-#[async_trait]
-impl CommandRunnable for AuthCommand {
     #[tracing::instrument(name = "gt auth", err, skip(self, core, matches))]
     async fn run(
         &self,

src/commands/clone.rs

@@ -4,9 +4,12 @@ use crate::core::Target;
 use crate::tasks::*;
 use clap::{Arg, ArgMatches};
 
-pub struct CloneCommand {}
+pub struct CloneCommand;
 
-impl Command for CloneCommand {
+crate::command!(CloneCommand);
+
+#[async_trait]
+impl CommandRunnable for CloneCommand {
     fn name(&self) -> String {
         String::from("clone")
     }
@@ -21,10 +24,7 @@ impl Command for CloneCommand {
                     .required(true)
                     .index(1))
     }
-}
 
-#[async_trait]
-impl CommandRunnable for CloneCommand {
     #[tracing::instrument(name = "gt clone", err, skip(self, core, matches))]
     async fn run(&self, core: &Core, matches: &ArgMatches) -> Result<i32, errors::Error> {
         let repo_name = matches.get_one::<String>("repo").ok_or_else(|| errors::user(

src/commands/complete.rs

@@ -1,9 +1,12 @@
 use super::*;
 use clap::Arg;
 
-pub struct CompleteCommand {}
+pub struct CompleteCommand;
 
-impl Command for CompleteCommand {
+crate::command!(CompleteCommand);
+
+#[async_trait]
+impl CommandRunnable for CompleteCommand {
     fn name(&self) -> String {
         String::from("complete")
     }
@@ -21,10 +24,7 @@ impl Command for CompleteCommand {
                 .help("The parameters being passed to Git-Tool for auto-completion.")
                 .index(1))
     }
-}
 
-#[async_trait]
-impl CommandRunnable for CompleteCommand {
     #[tracing::instrument(name = "gt complete", err, skip(self, core, matches))]
     async fn run(
         &self,
@@ -39,14 +39,12 @@ where {
             .map(|s| s.as_str())
             .unwrap_or_default();
 
-        let commands = super::commands();
         let (cmd, filter) = self
             .extract_command_and_filter(args, position)
             .unwrap_or_default();
 
         let completer = Completer::new(core, &filter);
-        self.offer_completions(core, &commands, &cmd, &completer)
-            .await;
+        self.offer_completions(core, &cmd, &completer).await;
 
         Ok(0)
     }
@@ -91,13 +89,9 @@ impl CompleteCommand {
         Some((cmd, filter))
     }
 
-    fn get_responsible_command(
-        &self,
-        commands: &[Arc<dyn CommandRunnable>],
-        args: &str,
-    ) -> Option<(Arc<dyn CommandRunnable>, ArgMatches)> {
-        if let Ok(complete_matches) = self.get_completion_matches(commands, args) {
-            for cmd in commands.iter() {
+    fn get_responsible_command(&self, args: &str) -> Option<(Command, ArgMatches)> {
+        if let Ok(complete_matches) = self.get_completion_matches(args) {
+            for cmd in inventory::iter::<Command> {
                 if let Some(cmd_matches) = complete_matches.subcommand_matches(&cmd.name()) {
                     return Some((cmd.clone(), cmd_matches.clone()));
                 }
@@ -107,38 +101,28 @@ impl CompleteCommand {
         None
     }
 
-    async fn offer_completions(
-        &self,
-        core: &Core,
-        commands: &[Arc<dyn CommandRunnable>],
-        args: &str,
-        completer: &Completer,
-    ) {
-        match self.get_responsible_command(commands, args) {
+    async fn offer_completions(&self, core: &Core, args: &str, completer: &Completer) {
+        match self.get_responsible_command(args) {
             Some((cmd, matches)) => {
                 cmd.complete(core, completer, &matches).await;
             }
             None => {
-                for cmd in commands.iter() {
+                for cmd in inventory::iter::<Command> {
                     completer.offer(&cmd.name());
                 }
             }
         }
     }
 
-    fn get_completion_matches(
-        &self,
-        commands: &[Arc<dyn CommandRunnable>],
-        args: &str,
-    ) -> Result<ArgMatches, errors::Error> {
+    fn get_completion_matches(&self, args: &str) -> Result<ArgMatches, errors::Error> {
         let true_args = shell_words::split(args)
             .map_err(|e| errors::user_with_internal(
                 "Could not parse the arguments you provided.",
                 "Please make sure that you are using auto-complete with a valid set of command line arguments.",
                 e))?;
 
-        let complete_app =
-            clap::Command::new("Git-Tool").subcommands(commands.iter().map(|x| x.app()));
+        let complete_app = clap::Command::new("Git-Tool")
+            .subcommands(inventory::iter::<Command>().map(|x| x.app()));
 
         complete_app.try_get_matches_from(true_args).map_err(|err| {
             errors::user_with_internal(
@@ -158,11 +142,8 @@ pub mod helpers {
 
     pub fn test_responsible_command(args: &str, expected: Option<&str>) {
         let cmd = CompleteCommand {};
-        let cmds = default_commands();
 
-        let responsible = cmd
-            .get_responsible_command(&cmds, args)
-            .map(|(c, _)| c.name());
+        let responsible = cmd.get_responsible_command(args).map(|(c, _)| c.name());
 
         assert_eq!(
             responsible.clone(),
@@ -180,11 +161,10 @@ pub mod helpers {
         contains: Vec<&str>,
     ) {
         let cmd = CompleteCommand {};
-        let cmds = default_commands();
 
         let console = crate::console::mock();
         let completer = Completer::new_for(filter, console.clone());
-        cmd.offer_completions(core, &cmds, args, &completer).await;
+        cmd.offer_completions(core, args, &completer).await;
 
         let output = console.to_string();
 
@@ -303,10 +283,8 @@ mod tests {
     fn get_completion_matches() {
         let cmd = CompleteCommand {};
 
-        let cmds = default_commands();
-
         assert_eq!(
-            cmd.get_completion_matches(&cmds, "git-tool new")
+            cmd.get_completion_matches("git-tool new")
                 .unwrap()
                 .subcommand_name(),
             Some("new")

src/commands/config.rs

@@ -1,14 +1,17 @@
 use crate::core::features;
 
 use super::async_trait;
-use super::Command;
+use super::CommandRunnable;
 use super::*;
 use clap::{Arg, ArgMatches};
 use online::registry::Registry;
 
-pub struct ConfigCommand {}
+pub struct ConfigCommand;
 
-impl Command for ConfigCommand {
+crate::command!(ConfigCommand);
+
+#[async_trait]
+impl CommandRunnable for ConfigCommand {
     fn name(&self) -> String {
         String::from("config")
     }
@@ -84,10 +87,7 @@ impl Command for ConfigCommand {
                     .help("configure the scratchpads path instead of the repositories path")
                     .action(clap::ArgAction::SetTrue)))
     }
-}
 
-#[async_trait]
-impl CommandRunnable for ConfigCommand {
     #[tracing::instrument(name = "gt config", err, skip(self, core, matches))]
     async fn run(&self, core: &Core, matches: &ArgMatches) -> Result<i32, errors::Error> {
         match matches.subcommand() {

src/commands/doctor.rs

@@ -1,8 +1,10 @@
 use super::*;
 
-pub struct DoctorCommand {}
+pub struct DoctorCommand;
+crate::command!(DoctorCommand);
 
-impl Command for DoctorCommand {
+#[async_trait]
+impl CommandRunnable for DoctorCommand {
     fn name(&self) -> String {
         String::from("doctor")
     }
@@ -13,10 +15,7 @@ impl Command for DoctorCommand {
             .about("checks that your environment is configured correctly for Git-Tool")
             .long_about("Runs a series of checks to ensure that the environment is ready to run the application")
     }
-}
 
-#[async_trait]
-impl CommandRunnable for DoctorCommand {
     #[tracing::instrument(name = "gt doctor", err, skip(self, core, _matches))]
     async fn run(
         &self,

src/commands/fix.rs

@@ -3,9 +3,11 @@ use super::*;
 use crate::{search, tasks::*};
 use clap::{Arg, ArgMatches};
 
-pub struct FixCommand {}
+pub struct FixCommand;
+crate::command!(FixCommand);
 
-impl Command for FixCommand {
+#[async_trait]
+impl CommandRunnable for FixCommand {
     fn name(&self) -> String {
         String::from("fix")
     }
@@ -29,10 +31,7 @@ impl Command for FixCommand {
                 .help("prevent the creation of a remote repository (on supported services)")
                 .action(clap::ArgAction::SetTrue))
     }
-}
 
-#[async_trait]
-impl CommandRunnable for FixCommand {
     #[tracing::instrument(name = "gt fix", err, skip(self, core, matches))]
     async fn run(&self, core: &Core, matches: &ArgMatches) -> Result<i32, errors::Error> {
         let tasks = sequence![

src/commands/ignore.rs

@@ -1,12 +1,14 @@
 use super::async_trait;
 use super::online::gitignore;
-use super::Command;
+use super::CommandRunnable;
 use super::*;
 use clap::{value_parser, Arg, ArgMatches};
 
-pub struct IgnoreCommand {}
+pub struct IgnoreCommand;
+crate::command!(IgnoreCommand);
 
-impl Command for IgnoreCommand {
+#[async_trait]
+impl CommandRunnable for IgnoreCommand {
     fn name(&self) -> String {
         String::from("ignore")
     }
@@ -29,10 +31,7 @@ impl Command for IgnoreCommand {
                     .action(clap::ArgAction::Append)
                     .index(1))
     }
-}
 
-#[async_trait]
-impl CommandRunnable for IgnoreCommand {
     #[tracing::instrument(name = "gt ignore", err, skip(self, core, matches))]
     async fn run(&self, core: &Core, matches: &ArgMatches) -> Result<i32, errors::Error> {
         match matches.get_many::<String>("language") {

src/commands/info.rs

@@ -3,9 +3,11 @@ use super::core::Target;
 use super::*;
 use clap::{Arg, ArgMatches};
 
-pub struct InfoCommand {}
+pub struct InfoCommand;
+crate::command!(InfoCommand);
 
-impl Command for InfoCommand {
+#[async_trait]
+impl CommandRunnable for InfoCommand {
     fn name(&self) -> String {
         String::from("info")
     }
@@ -20,10 +22,7 @@ impl Command for InfoCommand {
                     .help("The name of the repository to get information about.")
                     .index(1))
     }
-}
 
-#[async_trait]
-impl CommandRunnable for InfoCommand {
     #[tracing::instrument(name = "gt info", err, skip(self, core, matches))]
     async fn run(&self, core: &Core, matches: &ArgMatches) -> Result<i32, errors::Error> {
         let mut output = core.output();
@@ -75,6 +74,8 @@ impl CommandRunnable for InfoCommand {
 
 #[cfg(test)]
 mod tests {
+    use std::sync::Arc;
+
     use mockall::predicate::eq;
 
     use super::*;