Fixed clippy, refactored names and added doc comments

Author: ShootingStar91

src/commands/command_util.rs

@@ -507,8 +507,10 @@ static CONFIG_FILE_NAME: &str = "course_config.toml";
 
 /// Checks if current directory or given path
 /// contains valid exercise (i.e config file)
-/// Returns Err(msg) if given invalid path (including root )
-pub fn find_submit_or_paste_config(
+/// Returns Err(msg) if given invalid path (including root)
+/// Returns Ok(()) if no path given, but if current dir is not
+/// an exercise, leaves course_config as None
+pub fn find_course_config_for_exercise(
     exercise_slug: &mut String,
     course_config: &mut Option<CourseConfig>,
     exercise_dir: &mut PathBuf,
@@ -581,7 +583,7 @@ pub fn read_new_course_config(course_config_path: &Path) -> Result<Option<Course
     }
 }
 
-// retrieves exercise id for exercise from CourseConfig
+/// Retrieves exercise id for exercise from CourseConfig
 pub fn get_exercise_id_from_config(
     course_config: &CourseConfig,
     exercise_slug: &str,
@@ -593,7 +595,7 @@ pub fn get_exercise_id_from_config(
     }
 }
 
-// generates return_url for submissions and pastes
+/// Generates return_url for submissions and pastes
 pub fn generate_return_url(exercise_id: usize) -> String {
     format!(
         "{}/api/v8/core/exercises/{}/submissions",
@@ -609,7 +611,8 @@ pub fn get_projects_dir() -> PathBuf {
     tmc_langs::get_projects_dir(PLUGIN).unwrap()
 }
 
-/// Gives a list of all courses in projects-folder
+/// Choose course and then exercise interactively, return exercise path
+/// or Err(String) if either menu is interrupted or no items found
 pub fn choose_exercise() -> Result<PathBuf, String> {
     let mut courses: Vec<String> = Vec::new();
 

src/commands/download_command.rs

@@ -2,7 +2,7 @@ use std::path::PathBuf;
 use std::process::Command;
 
 use super::command_util;
-use super::command_util::*;
+use super::command_util::{get_projects_dir, Client};
 use crate::interactive;
 use crate::io_module::{Io, PrintColor};
 use crate::progress_reporting;

src/commands/exercises_command.rs

@@ -1,4 +1,4 @@
-use super::command_util::*;
+use super::command_util::{get_course_id_by_name, Client};
 use crate::io_module::{Io, PrintColor};
 
 use tmc_client::CourseExercise;

src/commands/paste_command.rs

@@ -1,5 +1,5 @@
 use super::command_util;
-use super::command_util::{ask_exercise_interactive, find_submit_or_paste_config, Client};
+use super::command_util::{ask_exercise_interactive, find_course_config_for_exercise, Client};
 use crate::io_module::{Io, PrintColor};
 use crate::progress_reporting;
 use crate::progress_reporting::ProgressBarManager;
@@ -24,7 +24,7 @@ pub fn paste(io: &mut dyn Io, client: &mut dyn Client, path: &str) {
     let mut course_config = None;
     let mut exercise_dir = std::path::PathBuf::new();
 
-    if let Err(error) = find_submit_or_paste_config(
+    if let Err(error) = find_course_config_for_exercise(
         &mut exercise_name,
         &mut course_config,
         &mut exercise_dir,

src/commands/submit_command.rs

@@ -1,5 +1,5 @@
 use super::command_util;
-use super::command_util::*;
+use super::command_util::{ask_exercise_interactive, find_course_config_for_exercise, Client};
 use crate::io_module::{Io, PrintColor};
 use crate::progress_reporting;
 use crate::progress_reporting::ProgressBarManager;
@@ -33,7 +33,7 @@ fn submit_logic(io: &mut dyn Io, client: &mut dyn Client, path: &str) {
     let mut course_config = None;
     let mut exercise_dir = std::path::PathBuf::new();
 
-    if let Err(error) = find_submit_or_paste_config(
+    if let Err(error) = find_course_config_for_exercise(
         &mut exercise_name,
         &mut course_config,
         &mut exercise_dir,
@@ -205,8 +205,8 @@ fn into_locale(arg: &str) -> Result<Language> {
 #[cfg(test)]
 mod tests {
     use super::*;
+    use command_util::MockClient;
     use std::slice::Iter;
-
     pub struct IoTest<'a> {
         list: &'a mut Vec<String>,
         input: &'a mut Iter<'a, &'a str>,

src/commands/test_command.rs

@@ -1,5 +1,5 @@
 use crate::commands::command_util;
-use crate::commands::command_util::{ask_exercise_interactive, find_submit_or_paste_config};
+use crate::commands::command_util::{ask_exercise_interactive, find_course_config_for_exercise};
 use crate::io_module::{Io, PrintColor};
 use std::path::Path;
 use tmc_langs::RunResult;
@@ -17,13 +17,13 @@ pub fn test(io: &mut dyn Io, exercise_folder: Option<&str>) {
         path = folder;
     }
 
-    if let Err(error) = find_submit_or_paste_config(
+    if let Err(error) = find_course_config_for_exercise(
         &mut exercise_name,
         &mut course_config,
         &mut exercise_dir,
         path,
     ) {
-        if !exercise_folder.is_none() {
+        if exercise_folder.is_some() {
             io.println(&error, PrintColor::Failed);
             return;
         }