improv: switch from constants to enum for app status

Author: edfloreshz

src/application.rs

@@ -1,12 +1,11 @@
 use std::fmt::{Display, Formatter};
 use std::process::Command;
 
-use crate::Error;
+use crate::{DevmodeStatus, Error};
 use cmd_lib::run_cmd;
 use serde::{Deserialize, Serialize};
 
 use crate::constants::commands::*;
-use crate::constants::messages::NO_EDITOR_SET;
 use crate::constants::names::*;
 
 #[derive(Serialize, Deserialize, Debug, Clone, Eq, PartialEq)]
@@ -70,7 +69,7 @@ impl Display for Application {
             Application::VSCode => write!(f, "{}", VSCODE_NAME),
             Application::Vim => write!(f, "{}", VIM_NAME),
             Application::Custom => write!(f, "{}", CUSTOM_NAME),
-            _ => write!(f, "{}", NO_EDITOR_SET),
+            _ => write!(f, "{}", DevmodeStatus::NoEditorSet.to_string()),
         }
     }
 }

src/cli/src/cli.rs

@@ -1,6 +1,6 @@
 use clap::{Parser, Subcommand};
 use devmode::action::Action;
-use devmode::Error;
+use devmode::{DevmodeStatus, Error};
 use fs_extra::{dir, move_items};
 use libset::routes::home;
 use regex::bytes::Regex;
@@ -9,8 +9,6 @@ use std::fs;
 use std::path::PathBuf;
 use url_builder::URLBuilder;
 
-use devmode::constants::messages::*;
-
 use crate::input::{
     clone_setup, config_all, config_editor, config_host, config_owner, fork_setup, overwrite,
     select_repo,
@@ -247,7 +245,7 @@ impl Cli {
         let reader = create_paths_reader()?;
         let paths = find_paths(reader, project)?;
         if paths.is_empty() {
-            return devmode::error(NO_PROJECT_FOUND);
+            return Err(Error::String(DevmodeStatus::NoProjectFound.to_string()));
         } else if paths.len() > 1 {
             let paths: Vec<&str> = paths.iter().map(|s| s as &str).collect();
             let path = select_repo(paths)?.to_string();
@@ -260,9 +258,8 @@ impl Cli {
         let reader = create_paths_reader()?;
         let paths = find_paths(reader, project)?;
         if paths.is_empty() {
-            return devmode::error(NO_PROJECT_FOUND);
+            return Err(Error::String(DevmodeStatus::NoProjectFound.to_string()));
         } else if paths.len() > 1 {
-            eprintln!("{}", MORE_PROJECTS_FOUND); // TODO: Let user decide which
             let paths: Vec<&str> = paths.iter().map(|s| s as &str).collect();
             let path = select_repo(paths)?;
             OpenAction::new(project).update(vec![path])
@@ -277,7 +274,9 @@ impl Cli {
         } else if rx.is_match(args.get(0).unwrap().as_bytes()) {
             ForkAction::parse_url(args.get(0).unwrap(), rx, upstream.to_string())?
         } else if args.len() == 1 {
-            let options = Settings::current().ok_or(Error::Generic(APP_OPTIONS_NOT_FOUND))?;
+            let options = Settings::current().ok_or(Error::String(
+                DevmodeStatus::AppSettingsNotFound.to_string(),
+            ))?;
             let host = Host::from(&options.host);
             let repo = args
                 .get(0)
@@ -417,7 +416,6 @@ impl Cli {
                     let path = if paths.is_empty() {
                         return devmode::error("Could not locate the {add} repository.");
                     } else if paths.len() > 1 {
-                        eprintln!("{}", MORE_PROJECTS_FOUND);
                         let paths: Vec<&str> = paths.iter().map(|s| s as &str).collect();
                         select_repo(paths)?
                     } else {
@@ -451,7 +449,6 @@ impl Cli {
                             "Could not locate the {remove} repository inside {name}",
                         );
                     } else if paths.len() > 1 {
-                        eprintln!("{}", MORE_PROJECTS_FOUND);
                         let paths: Vec<&str> = paths.iter().map(|s| s as &str).collect();
                         select_repo(paths)?
                     } else {
@@ -493,5 +490,7 @@ impl Cli {
 }
 
 fn get_settings() -> Result<Settings, Error> {
-    Settings::current().ok_or(Error::Generic(APP_OPTIONS_NOT_FOUND))
+    Settings::current().ok_or(Error::String(
+        DevmodeStatus::AppSettingsNotFound.to_string(),
+    ))
 }

src/cli/src/main.rs

@@ -10,7 +10,7 @@ fn main() -> Result<(), Error> {
     start_logger();
     let cli = Cli::parse();
     if let Err(e) = cli.run() {
-        log::error!("{}", e);
+        log::error!("{}", e)
     }
     Ok(())
 }

src/constants.rs

@@ -22,26 +22,3 @@ pub mod commands {
     pub const VSCODE_CMD: &str = "code";
     pub const VIM_CMD: &str = "vim";
 }
-
-pub mod messages {
-    pub const NO_PROJECT_FOUND: &str = "No project was found. \n\
-        If you know this project exists, run `dm config -m` to refresh the paths file.";
-    pub const MORE_PROJECTS_FOUND: &str = "Two or more projects found.";
-    pub const NO_SETTINGS_CHANGED: &str = "No settings were changed.";
-    pub const SETTINGS_UPDATED: &str = "Settings updated.";
-    pub const FAILED_TO_WRITE_CONFIG: &str = "Failed to write changes to `settings.toml`.";
-    pub const FAILED_TO_PARSE: &str = "Failed to parse app options.";
-    pub const UNABLE_TO_MAP_URL: &str = "Could not map url.";
-    pub const FAILED_TO_CLONE_REPO: &str = "Failed to clone repository.";
-    pub const FAILED_TO_SET_REMOTE: &str = "Failed to set remote.";
-    pub const FAILED_TO_GET_BRANCH: &str = "Failed to get branch.";
-    pub const OPENING_WARNING: &str =
-        "If the editor does not support openning from a path, you'll have to open it yourself.";
-    pub const NO_EDITOR_SET: &str = "No editor set, run `dm config -e` to configure it.";
-    pub const APP_OPTIONS_NOT_FOUND: &str =
-        "The current app options could not be found.\nRun `dm cf --all` to reconfigure them.";
-
-    pub fn _failed_to(action: &str, obj: &str) -> String {
-        format!("Failed to {} `{}`.", action, obj)
-    }
-}

src/fork.rs

@@ -4,7 +4,6 @@ use git2::Repository;
 use libset::routes::home;
 use regex::bytes::Regex;
 
-use crate::constants::messages::*;
 use crate::host::Host;
 use crate::project::OpenAction;
 use crate::{error, Error};
@@ -112,7 +111,7 @@ impl ForkAction {
         if path.is_empty() {
             println!("Seems that you haven't cloned the repository locally.");
         }
-        let project = Repository::open(Path::new(&path)).expect(NO_PROJECT_FOUND);
+        let project = Repository::open(Path::new(&path))?;
         project.remote("upstream", &self.upstream)?;
         Ok(())
     }

src/git_pull.rs

@@ -6,9 +6,8 @@ use std::io;
 use std::io::Write;
 use std::path::Path;
 
-use crate::constants::messages::FAILED_TO_GET_BRANCH;
-use crate::error;
 use crate::error::Error;
+use crate::DevmodeStatus;
 
 pub fn pull(repo_path: &Path) -> Result<(), Error> {
     let remote_name = "origin";
@@ -124,7 +123,7 @@ fn get_branch(repo: &Repository) -> Result<String, Error> {
     let head = head.as_ref().and_then(|h| h.shorthand());
     match head {
         Some(branch) => Ok(String::from(branch)),
-        None => error::error(FAILED_TO_GET_BRANCH),
+        None => Err(Error::String(DevmodeStatus::FailedToGetBranch.to_string())),
     }
 }
 

src/lib.rs

@@ -3,8 +3,13 @@ pub mod application;
 pub mod clone;
 pub mod constants;
 pub mod editor;
+
 mod error;
-pub use error::{error, Error};
+pub use error::*;
+
+mod status;
+pub use status::*;
+
 pub mod fork;
 pub mod git_pull;
 pub mod host;

src/project.rs

@@ -9,10 +9,9 @@ use libset::routes::{data, home};
 use walkdir::WalkDir;
 
 use crate::application::Application;
-use crate::constants::messages::*;
 use crate::error::Error;
-use crate::git_pull;
 use crate::settings::Settings;
+use crate::{git_pull, DevmodeStatus};
 
 pub struct OpenAction {
     pub name: String,
@@ -90,10 +89,12 @@ pub fn open_project(name: &str, paths: Vec<String>) -> Result<(), Error> {
         "Opening {} in {}... \n\n{}",
         name,
         path.clone(),
-        OPENING_WARNING
+        DevmodeStatus::OpenedProjectWithWarning.to_string()
     );
     git_pull::status_short(path.clone())?;
-    let options = Settings::current().ok_or(Error::Generic(APP_OPTIONS_NOT_FOUND))?;
+    let options = Settings::current().ok_or(Error::String(
+        DevmodeStatus::AppSettingsNotFound.to_string(),
+    ))?;
     if let Application::Custom = options.editor.app {
         let command_editor = options.editor.command;
         let route = path.replace('\\', "/");

src/settings.rs

@@ -3,9 +3,8 @@ use libset::element::Content;
 use libset::{config::Config, format::FileFormat, new_file};
 use serde::{Deserialize, Serialize};
 
-use crate::constants::messages::*;
 use crate::editor::Editor;
-use crate::Error;
+use crate::{DevmodeStatus, Error};
 
 #[derive(Serialize, Deserialize, Debug, Clone, Default, Eq, PartialEq)]
 pub struct Settings {
@@ -51,15 +50,19 @@ impl Settings {
         if current_settings.is_none() {
             Config::set::<Settings>("devmode/settings.toml", self.clone(), FileFormat::TOML)
                 .map_err(|e| Error::String(e.to_string()))?;
-            log::info!("Settings set correctly.");
-        } else if self != &current_settings.ok_or(Error::Generic(FAILED_TO_PARSE))? {
+            crate::info(DevmodeStatus::SettingsUpdated);
+        } else if self
+            != &current_settings.ok_or(Error::String(
+                DevmodeStatus::FailedToParseSettings.to_string(),
+            ))?
+        {
             Config::set::<Settings>("devmode/settings.toml", self.clone(), FileFormat::TOML)
                 .map_err(|e| Error::String(e.to_string()))?;
             if !hide_output {
-                log::info!("{}", SETTINGS_UPDATED);
+                crate::info(DevmodeStatus::SettingsUpdated);
             }
         } else if !hide_output {
-            log::info!("{}", NO_SETTINGS_CHANGED);
+            crate::info(DevmodeStatus::NoSettingsChanged);
         }
         Ok(())
     }

src/status.rs

@@ -0,0 +1,49 @@
+use std::fmt::Display;
+
+#[derive(Debug)]
+pub enum DevmodeStatus {
+    NoProjectFound,
+    NoSettingsChanged,
+    SettingsUpdated,
+    FailedToWriteSettings,
+    FailedToParseSettings,
+    UnableToMapUrl,
+    FailedToCloneRepository,
+    FailedToSetRemote,
+    FailedToGetBranch,
+    OpenedProjectWithWarning,
+    NoEditorSet,
+    AppSettingsNotFound,
+}
+
+impl Display for DevmodeStatus {
+    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
+        match self {
+            DevmodeStatus::NoProjectFound => write!(f, "No project was found"),
+            DevmodeStatus::NoSettingsChanged => write!(f, "No settings were changed"),
+            DevmodeStatus::SettingsUpdated => write!(f, "Settings updated"),
+            DevmodeStatus::FailedToWriteSettings => write!(f, "Failed to write settings"),
+            DevmodeStatus::FailedToParseSettings => write!(f, "Failed to parse settings"),
+            DevmodeStatus::UnableToMapUrl => write!(f, "Failed to map url"),
+            DevmodeStatus::FailedToCloneRepository => write!(f, "Failed to clone repository"),
+            DevmodeStatus::FailedToSetRemote => write!(f, "Failed to set remote repository"),
+            DevmodeStatus::FailedToGetBranch => write!(f, "Failed to get branch"),
+            DevmodeStatus::OpenedProjectWithWarning => {
+                write!(
+                    f,
+                    "If the editor does not support openning from a path, open it yourself"
+                )
+            }
+            DevmodeStatus::NoEditorSet => {
+                write!(f, "No editor set, run `dm config -e` to configure it")
+            }
+            DevmodeStatus::AppSettingsNotFound => {
+                write!(f, "The current app options could not be found.\nRun `dm cf --all` to reconfigure them")
+            }
+        }
+    }
+}
+
+pub fn info(status: DevmodeStatus) {
+    println!("{}", status.to_string());
+}