[tui][core] Migrate color_wheel from tui to core/tui_core

CHANGELOG.md

@@ -342,10 +342,25 @@ in a text editor.
 
 ### next release
 
+This is a major release that does not include any new functionality, but is a radical
+reorganization of the crates. The reason for paying down this technical debt now is to
+ensure that the codebase is easier to maintain and understand, and easier to add new
+features to in the future. The separation of concerns is now much clearer, and they
+reflect how the functionality is used in the real world.
+
 - Changed:
   - Refactor lots of styling related code in preparation for the move to `core`. This will
     make it easier to maintain and test the codebase, and clean up the dependencies.
 
+- Removed:
+  - Move the `color_wheel` module into `r3bl_rs_utils_core` crate. This is to ensure that
+    it is possible to import just color wheel and lolcat related functionality without
+    having to import the entire `r3bl_tui` crate. And de-tangles the dependency tree,
+    making it easier to maintain. The reason they ended up in `r3bl_tui` in the first
+    place is because it was easier to develop them there, but since then, lots of other
+    consumers of this functionality have emerged, including crates that are created by
+    "3rd party developers" (people not R3BL and not part of `r3bl-open-core` repo).
+
 ### v0.5.9 (2024-09-12)
 
 - Updated:
@@ -643,6 +658,12 @@ exhaustively tested and is able to handle many more corner cases.
 
 ### next release
 
+This is a major release that does not include any new functionality, but is a radical
+reorganization of the crates. The reason for paying down this technical debt now is to
+ensure that the codebase is easier to maintain and understand, and easier to add new
+features to in the future. The separation of concerns is now much clearer, and they
+reflect how the functionality is used in the real world.
+
 - Changed:
   - Renamed the `debug!` macro, which is confusing, since it clashes with logging, to
     `console_log!`. This macro is used in many places in the codebase for quick formatted
@@ -651,6 +672,15 @@ exhaustively tested and is able to handle many more corner cases.
   - Reorganize the `src` folder to make sure that there aren't any top level files, and that
     everything is in a module. This is to make it easier to add new modules in the future.
 
+- Added:
+  - Move the `color_wheel` module into `r3bl_rs_utils_core` crate. This is to ensure that
+    it is possible to import just color wheel and lolcat related functionality without
+    having to import the entire `r3bl_tui` crate. And de-tangles the dependency tree,
+    making it easier to maintain. The reason they ended up in `r3bl_tui` in the first
+    place is because it was easier to develop them there, but since then, lots of other
+    consumers of this functionality have emerged, including crates that are created by
+    "3rd party developers" (people not R3BL and not part of `r3bl-open-core` repo).
+
 ### v0.9.16 (2024-09-12)
 
 - Updated:

ansi_color/src/ansi256_color.rs

@@ -15,11 +15,11 @@
  *   limitations under the License.
  */
 
- use crate::{color_utils,
-    constants::ANSI_COLOR_PALETTE,
-    Color,
-    RgbColor,
-    TransformColor};
+use crate::{color_utils,
+            constants::ANSI_COLOR_PALETTE,
+            Color,
+            RgbColor,
+            TransformColor};
 
 #[derive(Debug, Clone, Copy, PartialEq, Eq)]
 pub struct Ansi256Color {

ansi_color/src/lib.rs

@@ -236,20 +236,20 @@
 #![warn(rust_2018_idioms)]
 
 // Attach.
+pub mod ansi256_color;
 pub mod ansi_escape_codes;
 pub mod ansi_styled_text;
 pub mod color;
-pub mod rgb_color;
-pub mod ansi256_color;
 pub mod convert;
 pub mod detect_color_support;
+pub mod rgb_color;
 pub mod transform_color;
 
+pub use ansi256_color::*;
 pub use ansi_escape_codes::*;
 pub use ansi_styled_text::*;
 pub use color::*;
-pub use rgb_color::*;
-pub use ansi256_color::*;
 pub use convert::*;
 pub use detect_color_support::*;
-pub use transform_color::*;
+pub use rgb_color::*;
+pub use transform_color::*;

ansi_color/src/rgb_color.rs

@@ -14,7 +14,7 @@
  *   See the License for the specific language governing permissions and
  *   limitations under the License.
  */
-use crate::{convert_rgb_into_ansi256, Ansi256Color,  TransformColor};
+use crate::{convert_rgb_into_ansi256, Ansi256Color, TransformColor};
 
 #[derive(Debug, Clone, Copy, PartialEq, Eq)]
 pub struct RgbColor {

cmdr/src/bin/edi.rs

@@ -23,11 +23,11 @@ use r3bl_rs_utils_core::{call_if_true,
                          log_debug,
                          throws,
                          try_to_set_log_level,
+                         ColorWheel,
                          CommonResult,
                          GradientGenerationPolicy,
                          TextColorizationPolicy,
                          UnicodeString};
-use r3bl_tui::ColorWheel;
 
 use crate::clap_config::CLIArg;
 

cmdr/src/edi/app_main.rs

@@ -33,6 +33,9 @@ use r3bl_rs_utils_core::{call_if_true,
                          ANSIBasicColor,
                          Ansi256GradientIndex,
                          ChUnit,
+                         ColorWheel,
+                         ColorWheelConfig,
+                         ColorWheelSpeed,
                          CommonError,
                          CommonResult,
                          GradientGenerationPolicy,
@@ -55,9 +58,6 @@ use r3bl_tui::{box_end,
                surface,
                App,
                BoxedSafeApp,
-               ColorWheel,
-               ColorWheelConfig,
-               ColorWheelSpeed,
                ComponentRegistry,
                ComponentRegistryMap,
                DialogBuffer,

cmdr/src/giti/branch/giti_ui_templates.rs

@@ -19,13 +19,13 @@ use std::{env::var, process::Command};
 
 use r3bl_ansi_color::{AnsiStyledText, Color, Style};
 use r3bl_rs_utils_core::{log_error,
+                         ColorWheel,
                          CommonError,
                          CommonErrorType,
                          CommonResult,
                          GradientGenerationPolicy,
                          TextColorizationPolicy,
                          UnicodeString};
-use r3bl_tui::ColorWheel;
 use r3bl_tuify::SLATE_GRAY;
 
 use crate::{giti::ui_strings::UIStrings::{ErrorExecutingCommand,

core/Cargo.toml

@@ -73,3 +73,4 @@ colorgrad = "0.7.0"
 [dev-dependencies]
 # for assert_eq! macro
 pretty_assertions = "1.4.0"
+serial_test = "3.1.1"

core/src/logging/proper_logging_impl.rs

@@ -40,7 +40,12 @@
 use std::{fs::File, sync::Once};
 
 use chrono::Local;
-use r3bl_simple_logger::{format_description, Config, ConfigBuilder, CombinedLogger, LevelFilter, WriteLogger};
+use r3bl_simple_logger::{format_description,
+                         CombinedLogger,
+                         Config,
+                         ConfigBuilder,
+                         LevelFilter,
+                         WriteLogger};
 use time::UtcOffset;
 
 use crate::{CommonError, CommonErrorType, CommonResult};

tui/src/tui/color_wheel/color_wheel_impl.rs → core/src/tui_core/color_wheel/color_wheel_impl.rs

@@ -16,35 +16,35 @@
  */
 
 use r3bl_ansi_color::AnsiStyledText;
-use r3bl_rs_utils_core::{ch,
-                         convert_tui_color_into_r3bl_ansi_color,
-                         generate_random_truecolor_gradient,
-                         generate_truecolor_gradient,
-                         get_gradient_array_for,
-                         tui_styled_text,
-                         Ansi256GradientIndex,
-                         AnsiValue,
-                         ChUnit,
-                         ColorUtils,
-                         Defaults,
-                         GradientGenerationPolicy,
-                         GraphemeClusterSegment,
-                         RgbValue,
-                         TextColorizationPolicy,
-                         TuiColor,
-                         TuiStyle,
-                         TuiStyledText,
-                         TuiStyledTexts,
-                         UnicodeString,
-                         DEFAULT_GRADIENT_STOPS,
-                         SPACER};
 use serde::{Deserialize, Serialize};
 
 use super::{ColorWheelConfig,
             ColorWheelDirection,
             ColorWheelSpeed,
             GradientKind,
             GradientLengthKind};
+use crate::{ch,
+            convert_tui_color_into_r3bl_ansi_color,
+            generate_random_truecolor_gradient,
+            generate_truecolor_gradient,
+            get_gradient_array_for,
+            tui_styled_text,
+            Ansi256GradientIndex,
+            AnsiValue,
+            ChUnit,
+            ColorUtils,
+            Defaults,
+            GradientGenerationPolicy,
+            GraphemeClusterSegment,
+            RgbValue,
+            TextColorizationPolicy,
+            TuiColor,
+            TuiStyle,
+            TuiStyledText,
+            TuiStyledTexts,
+            UnicodeString,
+            DEFAULT_GRADIENT_STOPS,
+            SPACER};
 
 #[derive(Serialize, Deserialize, Clone, PartialEq, Debug)]
 pub struct ColorWheel {
@@ -422,7 +422,7 @@ impl ColorWheel {
         text: &UnicodeString,
     ) -> TuiStyledTexts {
         mod inner {
-            use r3bl_rs_utils_core::{TuiColor, TuiStyle};
+            use super::*;
 
             // Inner function.
             pub fn gen_style_fg_color_for(
@@ -603,10 +603,10 @@ impl ColorWheel {
 #[cfg(test)]
 mod tests_color_wheel_rgb {
     use r3bl_ansi_color::{global_color_support, ColorSupport};
-    use r3bl_rs_utils_core::assert_eq2;
     use serial_test::serial;
 
     use super::*;
+    use crate::assert_eq2;
 
     mod test_helpers {
         use super::*;

tui/src/tui/color_wheel/config.rs → core/src/tui_core/color_wheel/config.rs

@@ -16,10 +16,10 @@
  */
 
 use r3bl_ansi_color::{global_color_support, ColorSupport};
-use r3bl_rs_utils_core::{Ansi256GradientIndex, TuiColor};
 use serde::{Deserialize, Serialize};
 
 use super::{Lolcat, LolcatBuilder};
+use crate::{Ansi256GradientIndex, TuiColor};
 
 /// For RGB colors:
 /// 1. The stops are the colors that will be used to create the gradient.

tui/src/tui/color_wheel/lolcat_api.rs → core/src/tui_core/color_wheel/lolcat_api.rs

@@ -17,10 +17,10 @@
 
 use std::borrow::Cow;
 
-use r3bl_rs_utils_core::{ColorChangeSpeed, TuiStyledTexts, UnicodeString};
 use serde::{Deserialize, Serialize};
 
 use super::Lolcat;
+use crate::{ColorChangeSpeed, TuiStyledTexts, UnicodeString};
 
 pub fn colorize_to_styled_texts(
     lolcat: &mut Lolcat,
@@ -63,7 +63,6 @@ pub fn lolcat_each_char_in_unicode_string(
 ///
 /// ```rust
 /// use r3bl_rs_utils_core::*;
-/// use r3bl_tui::*;
 ///
 /// let mut lolcat = LolcatBuilder::new()
 ///   .set_color_change_speed(ColorChangeSpeed::Rapid)

tui/src/tui/color_wheel/lolcat_impl.rs → core/src/tui_core/color_wheel/lolcat_impl.rs

@@ -17,18 +17,18 @@
 
 use std::fmt::{Debug, Formatter, Result};
 
-use r3bl_rs_utils_core::{tui_styled_text,
-                         ColorUtils,
-                         ColorWheelControl,
-                         RgbValue,
-                         TuiColor,
-                         TuiStyle,
-                         TuiStyledText,
-                         TuiStyledTexts,
-                         UnicodeString};
 use serde::{Deserialize, Serialize};
 
 use super::LolcatBuilder;
+use crate::{tui_styled_text,
+            ColorUtils,
+            ColorWheelControl,
+            RgbValue,
+            TuiColor,
+            TuiStyle,
+            TuiStyledText,
+            TuiStyledTexts,
+            UnicodeString};
 
 /// Please use the [LolcatBuilder] to create this struct (lots of documentation is provided here).
 /// Please do not use this struct directly.

core/src/tui_core/color_wheel_core/color_wheel_control.rs

@@ -69,10 +69,9 @@ impl Display for ColorChangeSpeed {
 }
 
 impl From<ColorChangeSpeed> for f64 {
-    /// The float is added to seed in [Lolcat] after every iteration. If
-    /// the number is `Rapid` then the changes in color between new lines is
-    /// quite abrupt. If it is `Slow` then the changes are much much smoother.
-    /// And so this is the default.
+    /// The float is added to seed in [crate::Lolcat] after every iteration. If the number
+    /// is `Rapid` then the changes in color between new lines is quite abrupt. If it is
+    /// `Slow` then the changes are much much smoother. And so this is the default.
     fn from(value: ColorChangeSpeed) -> Self {
         match value {
             ColorChangeSpeed::Rapid => 1.0,

core/src/tui_core/color_wheel_core/converter.rs

@@ -47,9 +47,8 @@ pub fn convert_tui_color_into_r3bl_ansi_color(color: TuiColor) -> r3bl_ansi_colo
 
 #[cfg(test)]
 mod tests_color_converter {
-    use crate::{ANSIBasicColor, AnsiValue, RgbValue, TuiColor};
-
     use super::*;
+    use crate::{ANSIBasicColor, AnsiValue, RgbValue, TuiColor};
 
     #[test]
     fn test_convert_tui_color_into_r3bl_ansi_color_rgb() {

core/src/tui_core/color_wheel_core/mod.rs

@@ -17,18 +17,18 @@
 
 // Attach sources.
 pub mod ansi_256_color_gradients;
-pub mod color_wheel_control;
 pub mod color_utils;
-pub mod truecolor_gradient;
+pub mod color_wheel_control;
 pub mod converter;
-pub mod policies;
 pub mod defaults;
+pub mod policies;
+pub mod truecolor_gradient;
 
 // Re-export.
 pub use ansi_256_color_gradients::*;
-pub use color_wheel_control::*;
 pub use color_utils::*;
-pub use truecolor_gradient::*;
+pub use color_wheel_control::*;
 pub use converter::*;
+pub use defaults::*;
 pub use policies::*;
-pub use defaults::*;
+pub use truecolor_gradient::*;

core/src/tui_core/dimens/ch_unit.rs

@@ -31,7 +31,7 @@ pub type ChUnitPrimitiveType = u16;
 ///   character in a monospace font.
 /// - The terminal displaying the Rust binary build using the tui library will ultimately
 ///   determine the actual width and height of a character.
-/// - In order to create amounts of ch units, use the [ch!] macro.
+/// - In order to create amounts of ch units, use the [crate::ch!] macro.
 #[derive(
     Copy,
     Clone,