reorganize project file structure

Author: o2sh

CONTRIBUTING.md

@@ -11,7 +11,7 @@
 
 ### Adding support for a new language
 
-Adding support for a new Language consists in adding a new entry to the `define_language!` macro in [language.rs](https://raw.githubusercontent.com/o2sh/onefetch/main/src/language.rs) and filling it in with the right data.
+Adding support for a new Language consists in adding a new entry to the `define_language!` macro in [language.rs](src/repo/language.rs) and filling it in with the right data.
 
 **Example**:
 
@@ -59,15 +59,15 @@ Remarks:
 
 To add a new package manager, make sure to follow these steps:
 
-1. Add a new entry in the `define_package_managers!` macro in [package_manager.rs](src/onefetch/package_managers/package_manager.rs).
+1. Add a new entry in the `define_package_managers!` macro in [package_manager.rs](src/repo/deps/package_manager.rs).
 
 **Example**:
 
 `{ Cargo, "cargo", [ ("Cargo.toml", cargo) ] },`
 
 The first item `Cargo` corresponds to the name of the package manager. The second item `cargo` is the display name. Then we have the name of the package manager file that will be parsed: `Cargo.toml` along with its parser `cargo` (cf. step 2), notice that the third item is an array of tuple in case the package manager has multiple parsers (e.g. pip).
 
-2. in `src/onefetch/deps/package_parser.rs`: create a function that takes an input of type `&str` representing the content of the package manager's file, and returns a `usize` as its number of dependencies.
+2. in `src/repo/deps/package_parser.rs`: create a function that takes an input of type `&str` representing the content of the package manager's file, and returns a `usize` as its number of dependencies.
 
 ```rust
 pub fn cargo(contents: &str) -> Result<usize> {

src/onefetch/cli.rs renamed to src/cli.rs

@@ -1,31 +1,29 @@
-use {
-    crate::onefetch::{
-        cli_utils,
-        error::*,
-        image_backends,
-        info_field::{InfoField, InfoFieldOff},
-        language::Language,
-        printer::SerializationFormat,
-    },
-    clap::{crate_description, crate_name, crate_version, App, AppSettings, Arg},
-    image::DynamicImage,
-    regex::Regex,
-    std::{convert::From, env, str::FromStr},
-    strum::IntoEnumIterator,
-    term_size,
-};
+use crate::error::*;
+use crate::repo::deps::package_manager::PackageManager;
+use crate::repo::language::Language;
+use crate::ui::image_backends;
+use crate::ui::image_backends::ImageBackend;
+use crate::ui::info::info_field::{InfoField, InfoFieldOff};
+use crate::ui::printer::SerializationFormat;
+use clap::{crate_description, crate_name, crate_version, App, AppSettings, Arg};
+use image::DynamicImage;
+use regex::Regex;
+use std::process::Command;
+use std::{convert::From, env, str::FromStr};
+use strum::IntoEnumIterator;
+use term_size;
 
 const MAX_TERM_WIDTH: usize = 95;
 
-pub struct Cli {
+pub struct Config {
     pub repo_path: String,
     pub ascii_input: Option<String>,
     pub ascii_language: Option<Language>,
     pub ascii_colors: Vec<String>,
     pub disabled_fields: InfoFieldOff,
     pub no_bold: bool,
     pub image: Option<DynamicImage>,
-    pub image_backend: Option<Box<dyn image_backends::ImageBackend>>,
+    pub image_backend: Option<Box<dyn ImageBackend>>,
     pub image_color_resolution: usize,
     pub no_merges: bool,
     pub no_color_palette: bool,
@@ -42,7 +40,7 @@ pub struct Cli {
     pub show_email: bool,
 }
 
-impl Cli {
+impl Config {
     pub fn new() -> Result<Self> {
         #[cfg(not(windows))]
         let possible_backends = ["kitty", "iterm", "sixel"];
@@ -280,7 +278,7 @@ impl Cli {
         let true_color = match matches.value_of("true-color") {
             Some("always") => true,
             Some("never") => false,
-            Some("auto") => cli_utils::is_truecolor_terminal(),
+            Some("auto") => is_truecolor_terminal(),
             _ => unreachable!(),
         };
         let no_bold = matches.is_present("no-bold");
@@ -375,7 +373,7 @@ impl Cli {
                 .value_of("no-bots")
                 .map_or(Regex::from_str(r"\[bot\]").unwrap(), |s| Regex::from_str(s).unwrap())
         });
-        Ok(Cli {
+        Ok(Config {
             repo_path,
             ascii_input,
             ascii_language,
@@ -401,3 +399,34 @@ impl Cli {
         })
     }
 }
+
+pub fn print_supported_languages() -> Result<()> {
+    for l in Language::iter() {
+        println!("{}", l);
+    }
+
+    Ok(())
+}
+
+pub fn print_supported_package_managers() -> Result<()> {
+    for p in PackageManager::iter() {
+        println!("{}", p);
+    }
+
+    Ok(())
+}
+
+pub fn is_truecolor_terminal() -> bool {
+    env::var("COLORTERM")
+        .map(|colorterm| colorterm == "truecolor" || colorterm == "24bit")
+        .unwrap_or(false)
+}
+
+pub fn get_git_version() -> String {
+    let version = Command::new("git").arg("--version").output();
+
+    match version {
+        Ok(v) => String::from_utf8_lossy(&v.stdout).replace('\n', ""),
+        Err(_) => String::new(),
+    }
+}

src/onefetch/error.rs renamed to src/error.rs

@@ -2,30 +2,35 @@
 #![recursion_limit = "1024"]
 #![cfg_attr(feature = "fail-on-deprecated", deny(deprecated))]
 
-use onefetch::{cli::Cli, cli_utils, error::*, info, printer::Printer, repo};
-
+use cli::Config;
+use error::*;
 use std::{io, process};
+use ui::info::Info;
+use ui::printer::Printer;
 
-mod onefetch;
+mod cli;
+mod error;
+mod repo;
+mod ui;
 
 fn run() -> Result<()> {
     #[cfg(windows)]
     let _ = ansi_term::enable_ansi_support();
 
-    let config = Cli::new()?;
+    let config = Config::new()?;
 
     if config.print_languages {
-        return cli_utils::print_supported_languages();
+        return cli::print_supported_languages();
     }
 
     if config.print_package_managers {
-        return cli_utils::print_supported_package_managers();
+        return cli::print_supported_package_managers();
     }
 
     if !repo::is_valid(&config.repo_path)? {
         return Err("please run onefetch inside of a non-bare git repository".into());
     }
-    let info = info::Info::new(config)?;
+    let info = Info::new(config)?;
 
     let mut printer = Printer::new(io::BufWriter::new(io::stdout()), info);
 

src/main.rs

@@ -1,5 +1,5 @@
 use {
-    crate::onefetch::error::*,
+    crate::error::*,
     std::collections::HashMap,
     std::{ffi::OsStr, fs},
 };

src/onefetch/cli_utils.rs

@@ -1,4 +1,4 @@
-use crate::onefetch::error::*;
+use crate::error::*;
 use std::collections::HashMap;
 use {regex::Regex, strum::EnumIter, toml::Value, yaml_rust::YamlLoader};
 

src/onefetch/mod.rs

@@ -2,18 +2,18 @@ use git2::Oid;
 use serde::ser::SerializeStruct;
 use serde::Serialize;
 
-pub struct CommitInfo {
+pub struct HeadRefs {
     commit: Oid,
     refs: Vec<String>,
 }
 
-impl CommitInfo {
-    pub fn new(commit: Oid, refs: Vec<String>) -> CommitInfo {
-        CommitInfo { commit, refs }
+impl HeadRefs {
+    pub fn new(commit: Oid, refs: Vec<String>) -> HeadRefs {
+        HeadRefs { commit, refs }
     }
 }
 
-impl std::fmt::Display for CommitInfo {
+impl std::fmt::Display for HeadRefs {
     fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
         let short_commit = self.commit.to_string().chars().take(7).collect::<String>();
         if !self.refs.is_empty() {
@@ -30,12 +30,12 @@ impl std::fmt::Display for CommitInfo {
     }
 }
 
-impl Serialize for CommitInfo {
+impl Serialize for HeadRefs {
     fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
     where
         S: serde::Serializer,
     {
-        let mut state = serializer.serialize_struct("CommitInfo", 2)?;
+        let mut state = serializer.serialize_struct("HeadRefs", 2)?;
         state.serialize_field("refs", &self.refs)?;
         state
             .serialize_field("oid", &self.commit.to_string().chars().take(7).collect::<String>())?;