Add clean command (#8)

* Add clean command

Author: saraiva132

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "protofetch"
-version = "0.0.7"
+version = "0.0.8"
 edition = "2018"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

Cargo.toml

@@ -27,6 +27,7 @@ OPTIONS:
             Print version information
 
 SUBCOMMANDS:
+    clean      Cleans generated proto sources and lock file
     fetch      Fetches protodep dependencies defined in the toml configuration file
     help       Print this message or the help of the given subcommand(s)
     init       Creates an init protofetch setup in provided directory and name
@@ -40,6 +41,7 @@ SUBCOMMANDS:
 ```toml
 name = "repository name"
 description = "this is a repository"
+proto_out_dir = "proto/src/dir/output"
 
 [repo1]
   protocol = "https"
@@ -50,4 +52,9 @@ description = "this is a repository"
   protocol = "ssh"
   url = "github.com/org/repo2"
   revision = "5.2.0"
+
+[another-name]
+protocol = "ssh"
+url = "github.com/org/repo3"
+revision = "a16f097eab6e64f2b711fd4b977e610791376223"
 ```

README.md

@@ -7,44 +7,47 @@ pub struct CliArgs {
     #[clap(subcommand)]
     pub cmd: Command,
     #[clap(short, long, default_value = "protofetch.toml")]
-    ///location of the protofetch configuration toml
+    /// location of the protofetch configuration toml
     pub module_location: String,
     #[clap(short, long, default_value = "protofetch.lock")]
-    ///location of the protofetch lock file
+    /// location of the protofetch lock file
     pub lockfile_location: String,
     #[clap(short, long, default_value = ".protofetch_cache")]
-    ///location of the protofetch cache directory
+    /// location of the protofetch cache directory
     pub cache_directory: String,
+    /// name of the proto source files directory output,
+    /// this will be used if config is not present in the toml config
+    #[clap(short, long, default_value = "proto_src")]
+    pub proto_output_directory: String,
 }
 
 #[derive(Debug, Parser)]
 pub enum Command {
-    ///Fetches protodep dependencies defined in the toml configuration file
+    /// Fetches protodep dependencies defined in the toml configuration file
     Fetch {
         #[clap(short, long)]
         ///forces re-creation of lock file
         force_lock: bool,
         ///Name of the dependencies source files directory
         #[clap(short, long, default_value = "dependencies")]
         source_output_directory: String,
-        ///Name of the proto files directory
-        #[clap(short, long, default_value = "proto_src")]
-        proto_output_directory: String,
     },
-    ///Creates a lock file based on toml configuration file
+    /// Creates a lock file based on toml configuration file
     Lock,
-    ///Creates an init protofetch setup in provided directory and name
+    /// Creates an init protofetch setup in provided directory and name
     Init {
         #[clap(default_value = ".")]
         directory: String,
         #[clap(short, long)]
         name: Option<String>,
     },
-    ///Migrates a protodep toml file to a protofetch format
+    /// Migrates a protodep toml file to a protofetch format
     Migrate {
         #[clap(default_value = ".")]
         directory: String,
         #[clap(short, long)]
         name: Option<String>,
     },
+    /// Cleans generated proto sources and lock file
+    Clean,
 }

src/cli/args.rs

@@ -9,6 +9,7 @@ use crate::{
 use std::{
     env,
     error::Error,
+    fs,
     path::{Path, PathBuf},
 };
 
@@ -28,12 +29,12 @@ pub fn do_fetch(
         LockFile::from_file(lockfile_path)?
     };
     let dependencies_out_dir = cache.location.join(dependencies_out_dir);
-    fetch::fetch(
-        cache,
-        &lockfile,
-        &dependencies_out_dir,
-        proto_output_directory,
-    )?;
+    let proto_out_dir = lockfile
+        .proto_out_dir
+        .as_ref()
+        .map(Path::new)
+        .unwrap_or(proto_output_directory);
+    fetch::fetch(cache, &lockfile, &dependencies_out_dir, proto_out_dir)?;
 
     Ok(())
 }
@@ -108,6 +109,26 @@ pub fn do_migrate(
     Ok(())
 }
 
+pub fn do_clean(lockfile_path: &Path, proto_output_directory: &Path) -> Result<(), Box<dyn Error>> {
+    if lockfile_path.exists() {
+        let lockfile = LockFile::from_file(lockfile_path).expect("Lockfile was not found");
+        let proto_out_dir = lockfile
+            .proto_out_dir
+            .as_ref()
+            .map(Path::new)
+            .unwrap_or(proto_output_directory);
+        info!(
+            "Cleaning protofetch proto source files folder {}.",
+            &proto_out_dir.to_string_lossy()
+        );
+        fs::remove_dir_all(proto_out_dir)?;
+        fs::remove_file(lockfile_path).expect("Lockfile could not be removed");
+        Ok(())
+    } else {
+        Ok(())
+    }
+}
+
 /// Name if present otherwise attempt to extract from directory
 fn build_module_name(name: Option<&str>, path: &Path) -> Result<String, Box<dyn Error>> {
     match name {

src/cli/command_handlers.rs

@@ -93,14 +93,9 @@ pub fn fetch<Cache: RepositoryCache>(
     cache: &Cache,
     lockfile: &LockFile,
     dependencies_out_dir: &Path,
-    proto_output_directory: &Path,
+    proto_out_dir: &Path,
 ) -> Result<(), FetchError> {
     info!("Fetching dependencies source files...");
-    let proto_out_dir = lockfile
-        .proto_out_dir
-        .as_ref()
-        .map(Path::new)
-        .unwrap_or(proto_output_directory);
 
     if !dependencies_out_dir.exists() {
         std::fs::create_dir_all(dependencies_out_dir)?;
@@ -160,12 +155,12 @@ pub fn copy_proto_files(
                     ))
                 })?;
                 let proto_out_dist = proto_out_dir.join(&proto_src);
-                let prefix = proto_out_dist
-                    .parent()
-                    .ok_or_else(|| FetchError::BadFilePath(format!(
+                let prefix = proto_out_dist.parent().ok_or_else(|| {
+                    FetchError::BadFilePath(format!(
                         "Bad parent dest file for {}",
                         &proto_out_dist.to_string_lossy()
-                    )))?;
+                    ))
+                })?;
                 std::fs::create_dir_all(prefix)?;
                 fs::copy(proto_file_source.as_path(), proto_out_dist.as_path())?;
             }
@@ -184,12 +179,12 @@ fn find_proto_files(dir: &Path) -> Result<Vec<PathBuf>, FetchError> {
                 let rec_call = find_proto_files(&path)?;
                 files.append(&mut rec_call.clone());
             } else if let Some(extension) = path.extension() {
-                    if extension == "proto" {
-                        files.push(path);
-                    }
+                if extension == "proto" {
+                    files.push(path);
                 }
             }
         }
+    }
     Ok(files)
 }
 

src/fetch.rs

@@ -25,12 +25,12 @@ fn run() -> Result<(), Box<dyn Error>> {
     let cache = ProtofetchCache::new(PathBuf::from(&cli_args.cache_directory))?;
     let module_path = Path::new(&cli_args.module_location);
     let lockfile_path = Path::new(&cli_args.lockfile_location);
+    let proto_output_directory = Path::new(&cli_args.proto_output_directory);
 
     match cli_args.cmd {
         cli::args::Command::Fetch {
             force_lock,
             source_output_directory,
-            proto_output_directory,
         } => {
             let dependencies_out_dir = Path::new(&source_output_directory);
             let proto_output_directory = Path::new(&proto_output_directory);
@@ -54,5 +54,8 @@ fn run() -> Result<(), Box<dyn Error>> {
         cli::args::Command::Migrate { directory, name } => {
             command_handlers::do_migrate(&directory, name.as_deref(), &cli_args.module_location)
         }
+        cli::args::Command::Clean => {
+            command_handlers::do_clean(lockfile_path, proto_output_directory)
+        }
     }
 }

src/main.rs

@@ -48,11 +48,11 @@ impl ProtoRepository {
         let rendered_revision = revision.to_string();
         let result = self
             .git_repo
-            .revparse_single(&format!("{}:module.toml", rendered_revision));
+            .revparse_single(&format!("{}:protofetch.toml", rendered_revision));
 
         match result {
             Err(e) if e.code() == git2::ErrorCode::NotFound => {
-                log::warn!("Couldn't find module.toml, assuming module has no dependencies");
+                log::debug!("Couldn't find protofetch.toml, assuming module has no dependencies");
                 Ok(Descriptor {
                     name: dep_name.to_string(),
                     description: None,