Merge pull request #103 from DaniD3v/compilation-performance

Improve Compilation Performance/ Code Quality

Cargo.toml

@@ -14,37 +14,52 @@ edition = "2021"
 [target.'cfg(windows)'.dependencies]
 winapi = { version = "0.3", features = ["winuser"] }
 
-[dependencies]
-# This is here because of #43
+[target.'cfg(target_os = "macos")'.dependencies]
 enquote = "1.1.0"
 
-color-eyre = { version = "0.6.2", default-features = false }
-pretty_env_logger = "0.5.0"
-paris-log = { version = "1.0.2", features = ["icons"] }
+[features]
+update-informer = ["dep:update-informer"]
+web-image = ["dep:reqwest"]
+dump-json = ["dep:serde_json"]
+
+[dependencies]
+# logging
 log = "0.4.17"
-prettytable-rs = "0.10.0"
-update-informer = "1.1.0"
-reqwest = { version = "0.11.23", default_features = false, features = [
-  "blocking",
-  "rustls-tls",
-] }
+paris-log = { version = "1.0.2", features = ["icons"] } # TODO replace with using paris directly?
+pretty_env_logger = "0.5.0"
 
+# terminal output
+prettytable-rs = { default-features = false, version = "0.10.0" } # TODO feature-gate? This should definitely be a default feature tho.
+color-eyre = { version = "0.6.2", default-features = false }
+colorsys = { default-features = false, version = "0.6.7" }
 owo-colors = "4.0.0"
-colorsys = "0.6.7"
 
-resolve-path = "0.1.0"
-directories = "5.0"
-proper_path_tools = "0.7.0"
+# templating engine
+upon = { features = ["filters", "serde"], default-features = false, version = "0.8.0" }
 
-ahash = "0.8.7"
-indexmap = "2.2.2"
+# config
+serde = { version = "1.0.160", features = ["serde_derive", "std"], default-features = false }
+toml = { features = ["parse"], default-features = false, version = "0.8.8" }
 
-image = "0.24.7"
-upon = "0.8.0"
-clap = { version = "4.2.4", features = ["derive"] }
-serde = { version = "1.0.160", features = ["derive"] }
-serde_json = "1.0.107"
-toml = "0.8.8"
+clap = { version = "4.2.4", features = ["derive", "std"], default-features = false }
 material-colors = { version = "0.4.0", features = ["image"] }
-regex = "1.10.5"
+image = { default-features = false, version = "0.25.2" }
+directories = "5.0"
+
+# should probably be removed
+indexmap = { default-features = false, version = "2.2.2" } # not sure yet
+ahash = { default-features = false, version = "0.8.7" }
+resolve-path = "0.1.0"
 execute = "0.2.13"
+
+# update-informer feature
+update-informer = { version = "1.1.0", optional = true }
+
+# dump-json feature
+serde_json = { version = "1.0.107", optional = true }
+
+# web-image feature
+reqwest = { version = "0.12.5", default-features = false, features = [
+  "blocking",
+  "rustls-tls",
+], optional = true }

default.nix

@@ -1,9 +1,9 @@
-{ pkgs ? import <nixpkgs> { } }:
-let manifest = (pkgs.lib.importTOML ./Cargo.toml).package;
+{pkgs ? import <nixpkgs> {}}: let
+  manifest = (pkgs.lib.importTOML ./Cargo.toml).package;
 in
-pkgs.rustPlatform.buildRustPackage rec {
-  pname = manifest.name;
-  version = manifest.version;
-  cargoLock.lockFile = ./Cargo.lock;
-  src = pkgs.lib.cleanSource ./.;
-}
+  pkgs.rustPlatform.buildRustPackage rec {
+    pname = manifest.name;
+    version = manifest.version;
+    cargoLock.lockFile = ./Cargo.lock;
+    src = pkgs.lib.cleanSource ./.;
+  }

flake.nix

@@ -4,20 +4,23 @@
     nixpkgs.url = "github:nixos/nixpkgs/nixos-unstable";
     systems.url = "github:nix-systems/default-linux";
   };
-  outputs = { self, nixpkgs, systems }:
-    let
-      forAllSystems = nixpkgs.lib.genAttrs (import systems);
-      pkgsFor = nixpkgs.legacyPackages;
-    in {
-      packages = forAllSystems (system: {
-        default = pkgsFor.${system}.callPackage ./. { };
-      });
-      devShells = forAllSystems (system: {
-        default = pkgsFor.${system}.callPackage ./shell.nix { };
-      });
-      nixosModules = {
-        matugen = import ./module.nix self;
-        default = self.nixosModules.matugen;
-      };
+  outputs = {
+    self,
+    nixpkgs,
+    systems,
+  }: let
+    forAllSystems = nixpkgs.lib.genAttrs (import systems);
+    pkgsFor = nixpkgs.legacyPackages;
+  in {
+    packages = forAllSystems (system: {
+      default = pkgsFor.${system}.callPackage ./. {};
+    });
+    devShells = forAllSystems (system: {
+      default = pkgsFor.${system}.callPackage ./shell.nix {};
+    });
+    nixosModules = {
+      matugen = import ./module.nix self;
+      default = self.nixosModules.matugen;
     };
+  };
 }

shell.nix

@@ -1,11 +1,11 @@
-{ pkgs ? import <nixpkgs> { } }:
+{pkgs ? import <nixpkgs> {}}:
 pkgs.mkShell {
   # Get dependencies from the main package
-  inputsFrom = [ (pkgs.callPackage ./default.nix { }) ];
+  inputsFrom = [(pkgs.callPackage ./default.nix {})];
   # Additional tooling
   buildInputs = with pkgs; [
     rust-analyzer # LSP Server
-    rustfmt       # Formatter
-    clippy        # Linter
+    rustfmt # Formatter
+    clippy # Linter
   ];
-}
+}

src/color/color.rs

@@ -1,14 +1,20 @@
 use material_colors::{
-    blend::harmonize, color::Argb, dynamic_color::{DynamicScheme, MaterialDynamicColors}, hct::Hct, image::{FilterType, ImageReader}, scheme::variant::{
+    blend::harmonize,
+    color::Argb,
+    dynamic_color::{DynamicScheme, MaterialDynamicColors},
+    hct::Hct,
+    image::{FilterType, ImageReader},
+    scheme::variant::{
         SchemeContent, SchemeExpressive, SchemeFidelity, SchemeFruitSalad, SchemeMonochrome,
         SchemeNeutral, SchemeRainbow, SchemeTonalSpot,
-    }, theme::{ColorGroup, CustomColor, CustomColorGroup}
+    },
+    theme::{ColorGroup, CustomColor, CustomColorGroup},
 };
 
 use colorsys::{Hsl, Rgb};
 use std::str::FromStr;
 
-use crate::{color::math::get_color_distance_lab, scheme::scheme::SchemeTypes};
+use crate::{color::math::get_color_distance_lab, scheme::SchemeTypes};
 
 #[derive(clap::Parser, Debug)]
 pub enum ColorFormat {
@@ -21,8 +27,11 @@ pub enum ColorFormat {
 pub enum Source {
     /// The image to use for generating a color scheme
     Image { path: String },
+
+    #[cfg(feature = "web-image")]
     /// The image to fetch from web and use for generating a color scheme
     WebImage { url: String },
+
     /// The source color to use for generating a color scheme
     #[clap(subcommand)]
     Color(crate::color::color::ColorFormat),
@@ -62,19 +71,22 @@ impl OwnCustomColor {
 }
 
 pub fn get_source_color(source: &Source) -> Result<Argb, Box<dyn std::error::Error>> {
-    let source_color: Argb = match &source {
+    use crate::color::color;
+
+    let source_color: Argb = match source {
         Source::Image { path } => {
             // test
             info!("Opening image in <d><u>{}</>", path);
-            crate::color::color::get_source_color_from_image(path).expect("Could not get source color from image")
+            color::get_source_color_from_image(path).expect("Could not get source color from image")
         }
+        #[cfg(feature = "web-image")]
         Source::WebImage { url } => {
             info!("Fetching image from <d><u>{}</>", url);
-            crate::color::color::get_source_color_from_web_image(url).expect("Could not get source color from web image")
-        }
-        Source::Color(color) => {
-            crate::color::color::get_source_color_from_color(color).expect("Could not get source color from color")
+            color::get_source_color_from_web_image(url)
+                .expect("Could not get source color from web image")
         }
+        Source::Color(color) => color::get_source_color_from_color(color)
+            .expect("Could not get source color from color"),
     };
     Ok(source_color)
 }
@@ -87,16 +99,17 @@ pub fn get_source_color_from_image(path: &str) -> Result<Argb, Box<dyn std::erro
     )))
 }
 
+#[cfg(feature = "web-image")]
 pub fn get_source_color_from_web_image(url: &str) -> Result<Argb, Box<dyn std::error::Error>> {
     let bytes = reqwest::blocking::get(url)?.bytes()?;
-    Ok(ImageReader::extract_color(ImageReader::read(&bytes)?.resize(
-        128,
-        128,
-        FilterType::Lanczos3,
-    )))
+    Ok(ImageReader::extract_color(
+        ImageReader::read(&bytes)?.resize(128, 128, FilterType::Lanczos3),
+    ))
 }
 
-pub fn get_source_color_from_color(color: &ColorFormat) -> Result<Argb, Box<dyn std::error::Error>> {
+pub fn get_source_color_from_color(
+    color: &ColorFormat,
+) -> Result<Argb, Box<dyn std::error::Error>> {
     match color {
         ColorFormat::Hex { string } => {
             Ok(Argb::from_str(string).expect("Invalid hex color string provided"))
@@ -169,8 +182,6 @@ pub fn make_custom_color(
     let light = generate_dynamic_scheme(scheme_type, value, false, contrast_level);
     let dark = generate_dynamic_scheme(scheme_type, value, true, contrast_level);
 
-
-
     // debug!("custom_color: {:#?}", &custom_color);
     CustomColorGroup {
         color,
@@ -207,4 +218,4 @@ pub fn color_to_string(colors_to_compare: &Vec<ColorDefinition>, compare_to: &st
         closest_distance, closest_color
     );
     closest_color.to_string()
-}
+}

src/color/format.rs

@@ -1,5 +1,5 @@
-use material_colors::color::Argb;
 use colorsys::{ColorAlpha, Hsl, Rgb};
+use material_colors::color::Argb;
 
 pub fn rgb_from_argb(color: Argb) -> Rgb {
     Rgb::from([
@@ -74,4 +74,4 @@ pub fn format_hsla(color: &Hsl, divide: bool) -> String {
             color.alpha()
         )
     }
-}
+}

src/color/math.rs

@@ -1,6 +1,6 @@
+use colorsys::Rgb;
 use material_colors::color::{Argb, Lab};
 use std::str::FromStr;
-use colorsys::Rgb;
 
 pub fn get_color_distance_lab(c1: &str, c2: &str) -> f64 {
     let c1 = Lab::from(Argb::from_str(c1).unwrap());
@@ -25,5 +25,9 @@ pub fn get_color_distance(c1: &Rgb, c2: &Rgb) -> f64 {
     let weight_g: f64 = 4.0;
     let weight_b: f64 = 2.0 + (255.0 - rmean) / 256.0;
 
-    return f64::sqrt(weight_r * i64::pow(r1-r2, 2) as f64 + weight_g * i64::pow(g1-g2, 2) as f64 + weight_b * i64::pow(b1-b2, 2) as f64)
-}
+    f64::sqrt(
+        weight_r * i64::pow(r1 - r2, 2) as f64
+            + weight_g * i64::pow(g1 - g2, 2) as f64
+            + weight_b * i64::pow(b1 - b2, 2) as f64,
+    )
+}

src/color/mod.rs

@@ -1,4 +1,4 @@
+pub mod color;
 pub mod format;
 pub mod math;
-pub mod color;
-pub mod parse;
+pub mod parse;

src/color/parse.rs

@@ -21,4 +21,4 @@ pub fn check_string_value(value: &Value) -> Option<&String> {
         Value::String(v) => Some(v),
         _v => None,
     }
-}
+}

src/exec/command.rs

@@ -0,0 +1 @@
+

src/exec/hook.rs

@@ -5,25 +5,23 @@ use upon::{Engine, Syntax, Template, Value};
 
 use crate::color::color::color_to_string;
 
-
 pub fn format_hook(
     engine: &Engine,
     render_data: &mut Value,
     hook: &String,
     colors_to_compare: &Option<Vec<crate::color::color::ColorDefinition>>,
     compare_to: &Option<String>,
 ) -> Result<(), Box<dyn std::error::Error>> {
-    let closest_color: Option<String> =
-        if colors_to_compare.is_some() && compare_to.is_some() {
-            let s = engine.compile(compare_to.as_ref().unwrap())?;
-            let compare_to = s.render(engine, &render_data).to_string()?;
-            Some(color_to_string(
-                colors_to_compare.as_ref().unwrap(),
-                &compare_to,
-            ))
-        } else {
-            None
-        };
+    let closest_color: Option<String> = if colors_to_compare.is_some() && compare_to.is_some() {
+        let s = engine.compile(compare_to.as_ref().unwrap())?;
+        let compare_to = s.render(engine, &*render_data).to_string()?;
+        Some(color_to_string(
+            colors_to_compare.as_ref().unwrap(),
+            &compare_to,
+        ))
+    } else {
+        None
+    };
 
     let t = engine.compile(hook)?;
     let res = if colors_to_compare.is_some() && compare_to.is_some() {
@@ -66,7 +64,7 @@ pub fn format_hook_text(
         }
     }
 
-    let data = template.render(&engine, &render_data).to_string().unwrap();
+    let data = template.render(&engine, render_data).to_string().unwrap();
 
     data
 }

src/exec/mod.rs

@@ -1,2 +1,2 @@
+pub mod command;
 pub mod hook;
-pub mod command;

src/filters/alpha.rs

@@ -4,8 +4,8 @@ use colorsys::{ColorAlpha, Hsl, Rgb};
 use std::str::FromStr;
 
 use crate::color::{
-    parse::{parse_color, check_string_value},
-    format::{format_rgba, format_hsla},
+    format::{format_hsla, format_rgba},
+    parse::{check_string_value, parse_color},
 };
 
 pub fn set_alpha(value: &Value, amount: f64) -> Result<String, String> {

src/filters/grayscale.rs

@@ -4,8 +4,8 @@ use colorsys::{ColorTransform, Hsl, Rgb};
 use std::str::FromStr;
 
 use crate::color::{
-    parse::{parse_color, check_string_value},
-    format::{format_hex, format_hex_stripped, format_rgb, format_rgba, format_hsl, format_hsla},
+    format::{format_hex, format_hex_stripped, format_hsl, format_hsla, format_rgb, format_rgba},
+    parse::{check_string_value, parse_color},
 };
 
 pub fn grayscale(value: &Value) -> Result<String, String> {
@@ -50,4 +50,4 @@ pub fn grayscale(value: &Value) -> Result<String, String> {
         }
         v => Ok(v.to_string()),
     }
-}
+}

src/filters/hue.rs

@@ -4,8 +4,8 @@ use colorsys::{ColorTransform, Hsl, Rgb};
 use std::str::FromStr;
 
 use crate::color::{
-    parse::{parse_color, check_string_value},
-    format::{format_hex, format_hex_stripped, format_rgb, format_rgba, format_hsl, format_hsla},
+    format::{format_hex, format_hex_stripped, format_hsl, format_hsla, format_rgb, format_rgba},
+    parse::{check_string_value, parse_color},
 };
 
 pub fn set_hue(value: &Value, amount: f64) -> Result<String, String> {