refactor: Go from Rust workspaces to a package with nested packages (#480)

1 files changed, 294 insertions, 0 deletions

diff --git a/src/context.rs b/src/context.rs
new file mode 100644
index 000000000..d440abf02
--- /dev/null
+++ b/src/context.rs
@@ -0,0 +1,294 @@
+use crate::config::StarshipConfig;
+use crate::module::Module;
+
+use clap::ArgMatches;
+use git2::{Repository, RepositoryState};
+use once_cell::sync::OnceCell;
+use std::env;
+use std::ffi::OsStr;
+use std::fs;
+use std::path::{Path, PathBuf};
+
+/// Context contains data or common methods that may be used by multiple modules.
+/// The data contained within Context will be relevant to this particular rendering
+/// of the prompt.
+pub struct Context<'a> {
+    /// The deserialized configuration map from the user's `starship.toml` file.
+    pub config: StarshipConfig,
+
+    /// The current working directory that starship is being called in.
+    pub current_dir: PathBuf,
+
+    /// A vector containing the full paths of all the files in `current_dir`.
+    dir_files: OnceCell<Vec<PathBuf>>,
+
+    /// The map of arguments that were passed when starship was called.
+    pub arguments: ArgMatches<'a>,
+
+    /// Private field to store Git information for modules who need it
+    repo: OnceCell<Repo>,
+}
+
+impl<'a> Context<'a> {
+    /// Identify the current working directory and create an instance of Context
+    /// for it.
+    pub fn new(arguments: ArgMatches) -> Context {
+        // Retrieve the "path" flag. If unavailable, use the current directory instead.
+        let path = arguments
+            .value_of("path")
+            .map(From::from)
+            .unwrap_or_else(|| env::current_dir().expect("Unable to identify current directory."));
+
+        Context::new_with_dir(arguments, path)
+    }
+
+    /// Create a new instance of Context for the provided directory
+    pub fn new_with_dir<T>(arguments: ArgMatches, dir: T) -> Context
+    where
+        T: Into<PathBuf>,
+    {
+        let config = StarshipConfig::initialize();
+
+        // TODO: Currently gets the physical directory. Get the logical directory.
+        let current_dir = Context::expand_tilde(dir.into());
+
+        Context {
+            config,
+            arguments,
+            current_dir,
+            dir_files: OnceCell::new(),
+            repo: OnceCell::new(),
+        }
+    }
+
+    /// Convert a `~` in a path to the home directory
+    fn expand_tilde(dir: PathBuf) -> PathBuf {
+        if dir.starts_with("~") {
+            let without_home = dir.strip_prefix("~").unwrap();
+            return dirs::home_dir().unwrap().join(without_home);
+        }
+        dir
+    }
+
+    /// Create a new module
+    pub fn new_module(&self, name: &str) -> Module {
+        let config = self.config.get_module_config(name);
+
+        Module::new(name, config)
+    }
+
+    /// Check the `disabled` configuration of the module
+    pub fn is_module_enabled(&self, name: &str) -> bool {
+        let config = self.config.get_module_config(name);
+
+        // If the segment has "disabled" set to "true", don't show it
+        let disabled = config.and_then(|table| table.as_table()?.get("disabled")?.as_bool());
+
+        disabled != Some(true)
+    }
+
+    // returns a new ScanDir struct with reference to current dir_files of context
+    // see ScanDir for methods
+    pub fn try_begin_scan(&'a self) -> Option<ScanDir<'a>> {
+        Some(ScanDir {
+            dir_files: self.get_dir_files().ok()?,
+            files: &[],
+            folders: &[],
+            extensions: &[],
+        })
+    }
+
+    /// Will lazily get repo root and branch when a module requests it.
+    pub fn get_repo(&self) -> Result<&Repo, std::io::Error> {
+        self.repo
+            .get_or_try_init(|| -> Result<Repo, std::io::Error> {
+                let repository = Repository::discover(&self.current_dir).ok();
+                let branch = repository
+                    .as_ref()
+                    .and_then(|repo| get_current_branch(repo));
+                let root = repository
+                    .as_ref()
+                    .and_then(|repo| repo.workdir().map(Path::to_path_buf));
+                let state = repository.as_ref().map(|repo| repo.state());
+
+                Ok(Repo {
+                    branch,
+                    root,
+                    state,
+                })
+            })
+    }
+
+    pub fn get_dir_files(&self) -> Result<&Vec<PathBuf>, std::io::Error> {
+        self.dir_files
+            .get_or_try_init(|| -> Result<Vec<PathBuf>, std::io::Error> {
+                let dir_files = fs::read_dir(&self.current_dir)?
+                    .filter_map(Result::ok)
+                    .map(|entry| entry.path())
+                    .collect::<Vec<PathBuf>>();
+
+                Ok(dir_files)
+            })
+    }
+}
+
+pub struct Repo {
+    /// If `current_dir` is a git repository or is contained within one,
+    /// this is the current branch name of that repo.
+    pub branch: Option<String>,
+
+    /// If `current_dir` is a git repository or is contained within one,
+    /// this is the path to the root of that repo.
+    pub root: Option<PathBuf>,
+
+    /// State
+    pub state: Option<RepositoryState>,
+}
+
+// A struct of Criteria which will be used to verify current PathBuf is
+// of X language, criteria can be set via the builder pattern
+pub struct ScanDir<'a> {
+    dir_files: &'a Vec<PathBuf>,
+    files: &'a [&'a str],
+    folders: &'a [&'a str],
+    extensions: &'a [&'a str],
+}
+
+impl<'a> ScanDir<'a> {
+    pub const fn set_files(mut self, files: &'a [&'a str]) -> Self {
+        self.files = files;
+        self
+    }
+
+    pub const fn set_extensions(mut self, extensions: &'a [&'a str]) -> Self {
+        self.extensions = extensions;
+        self
+    }
+
+    pub const fn set_folders(mut self, folders: &'a [&'a str]) -> Self {
+        self.folders = folders;
+        self
+    }
+
+    /// based on the current Pathbuf check to see
+    /// if any of this criteria match or exist and returning a boolean
+    pub fn is_match(&self) -> bool {
+        self.dir_files.iter().any(|path| {
+            if path.is_dir() {
+                path_has_name(path, self.folders)
+            } else {
+                path_has_name(path, self.files) || has_extension(path, self.extensions)
+            }
+        })
+    }
+}
+
+/// checks to see if the pathbuf matches a file or folder name
+pub fn path_has_name<'a>(dir_entry: &PathBuf, names: &'a [&'a str]) -> bool {
+    let found_file_or_folder_name = names.iter().find(|file_or_folder_name| {
+        dir_entry
+            .file_name()
+            .and_then(OsStr::to_str)
+            .unwrap_or_default()
+            == **file_or_folder_name
+    });
+
+    match found_file_or_folder_name {
+        Some(name) => !name.is_empty(),
+        None => false,
+    }
+}
+
+/// checks if pathbuf doesn't start with a dot and matches any provided extension
+pub fn has_extension<'a>(dir_entry: &PathBuf, extensions: &'a [&'a str]) -> bool {
+    if let Some(file_name) = dir_entry.file_name() {
+        if file_name.to_string_lossy().starts_with('.') {
+            return false;
+        }
+        return extensions.iter().any(|ext| {
+            dir_entry
+                .extension()
+                .and_then(OsStr::to_str)
+                .map_or(false, |e| e == *ext)
+        });
+    }
+    false
+}
+
+fn get_current_branch(repository: &Repository) -> Option<String> {
+    let head = repository.head().ok()?;
+    let shorthand = head.shorthand();
+
+    shorthand.map(std::string::ToString::to_string)
+}
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+
+    #[test]
+    fn test_path_has_name() {
+        let mut buf = PathBuf::from("/");
+        let files = vec!["package.json"];
+
+        assert_eq!(path_has_name(&buf, &files), false);
+
+        buf.set_file_name("some-file.js");
+        assert_eq!(path_has_name(&buf, &files), false);
+
+        buf.set_file_name("package.json");
+        assert_eq!(path_has_name(&buf, &files), true);
+    }
+
+    #[test]
+    fn test_has_extension() {
+        let mut buf = PathBuf::from("/");
+        let extensions = vec!["js"];
+
+        assert_eq!(has_extension(&buf, &extensions), false);
+
+        buf.set_file_name("some-file.rs");
+        assert_eq!(has_extension(&buf, &extensions), false);
+
+        buf.set_file_name(".some-file.js");
+        assert_eq!(has_extension(&buf, &extensions), false);
+
+        buf.set_file_name("some-file.js");
+        assert_eq!(has_extension(&buf, &extensions), true)
+    }
+
+    #[test]
+    fn test_criteria_scan_fails() {
+        let failing_criteria = ScanDir {
+            dir_files: &vec![PathBuf::new()],
+            files: &["package.json"],
+            extensions: &["js"],
+            folders: &["node_modules"],
+        };
+
+        // fails if buffer does not match any criteria
+        assert_eq!(failing_criteria.is_match(), false);
+
+        let failing_dir_criteria = ScanDir {
+            dir_files: &vec![PathBuf::from("/package.js/dog.go")],
+            files: &["package.json"],
+            extensions: &["js"],
+            folders: &["node_modules"],
+        };
+
+        // fails when passed a pathbuf dir matches extension path
+        assert_eq!(failing_dir_criteria.is_match(), false);
+    }
+
+    #[test]
+    fn test_criteria_scan_passes() {
+        let passing_criteria = ScanDir {
+            dir_files: &vec![PathBuf::from("package.json")],
+            files: &["package.json"],
+            extensions: &["js"],
+            folders: &["node_modules"],
+        };
+
+        assert_eq!(passing_criteria.is_match(), true);
+    }
+}