#22 Add absolute plot functionality for artists

Author: fsktom

Cargo.lock

@@ -17,10 +17,15 @@ chrono = "0.4"
 chrono-tz = "0.8"
 rustyline = { version = "11.*", features = ["derive"] }
 unicode-width = "0.1.10"
+plotly = "0.8"
 
 [dev-dependencies]
 criterion = "0.4"
 
+[profile.release]
+# for profiling with cargo-instruments/flamegraph-rs
+debug = true
+
 [[bench]]
 name = "printing_top"
 harness = false

Cargo.toml

@@ -12,7 +12,7 @@ use std::collections::HashMap;
 
 /// Module containing [`display`](self) functions with
 /// date functionality
-mod date;
+pub mod date;
 
 /// If set to true, it will sum up the plays of one song across multiple
 /// albums it may be in

src/display.rs

@@ -28,7 +28,7 @@ pub fn print_aspect(
                 art,
                 start.date_naive(),
                 end.date_naive(),
-                gather_artist_date(entries, art, start, end)
+                gather_artist(entries, art, start, end)
             );
             print_artist(
                 entries,
@@ -43,7 +43,7 @@ pub fn print_aspect(
                 alb,
                 start.date_naive(),
                 end.date_naive(),
-                gather_album_date(entries, alb, start, end)
+                gather_album(entries, alb, start, end)
             );
             print_album(&gather_songs_with_album_date(entries, alb, start, end));
         }
@@ -53,7 +53,7 @@ pub fn print_aspect(
                 son,
                 start.date_naive(),
                 end.date_naive(),
-                gather_song_date(entries, son, start, end)
+                gather_song(entries, son, start, end)
             );
         }
     }
@@ -77,7 +77,7 @@ fn print_artist(
         println!(
             "--- {} | {} plays ---",
             alb,
-            gather_album_date(entries, alb, start, end)
+            gather_album(entries, alb, start, end)
         );
         print_album(&mus);
     }
@@ -86,7 +86,7 @@ fn print_artist(
 /// Counts up the plays of a single artist within a date frame
 ///
 /// Basically [`super::gather_artist()`] but with date functionality
-fn gather_artist_date(
+pub fn gather_artist(
     entries: &Vec<SongEntry>,
     art: &Artist,
     start: &DateTime<Tz>,
@@ -95,7 +95,7 @@ fn gather_artist_date(
     let mut plays = 0;
 
     for entry in entries {
-        if entry.timestamp.ge(start) && entry.timestamp.le(end) && entry.artist.eq(&art.name) {
+        if entry.artist.eq(&art.name) && entry.timestamp.ge(start) && entry.timestamp.le(end) {
             plays += 1;
         }
     }
@@ -106,7 +106,7 @@ fn gather_artist_date(
 /// Counts up the plays of a single album within a date frame
 ///
 /// Basically [`super::gather_album()`] but with date functionality
-fn gather_album_date(
+pub fn gather_album(
     entries: &[SongEntry],
     alb: &Album,
     start: &DateTime<Tz>,
@@ -115,10 +115,10 @@ fn gather_album_date(
     let mut plays = 0;
 
     for entry in entries {
-        if entry.timestamp.ge(start)
-            && entry.timestamp.le(end)
-            && entry.artist.eq(&alb.artist.name)
+        if entry.artist.eq(&alb.artist.name)
             && entry.album.eq(&alb.name)
+            && entry.timestamp.ge(start)
+            && entry.timestamp.le(end)
         {
             plays += 1;
         }
@@ -130,7 +130,7 @@ fn gather_album_date(
 /// Counts up the plays of a single song within a date frame
 ///
 /// Basically [`super::gather_song()`] but with date functionality
-fn gather_song_date(
+pub fn gather_song(
     entries: &[SongEntry],
     son: &Song,
     start: &DateTime<Tz>,
@@ -139,11 +139,11 @@ fn gather_song_date(
     let mut plays = 0;
 
     for entry in entries {
-        if entry.timestamp.ge(start)
-            && entry.timestamp.le(end)
-            && entry.artist.eq(&son.album.artist.name)
+        if entry.artist.eq(&son.album.artist.name)
             && entry.album.eq(&son.album.name)
             && entry.track.eq(&son.name)
+            && entry.timestamp.ge(start)
+            && entry.timestamp.le(end)
         {
             plays += 1;
         }

src/display/date.rs

@@ -19,6 +19,7 @@
 
 mod display;
 mod parse;
+mod plot;
 mod types;
 mod ui;
 
@@ -54,6 +55,7 @@ fn main() {
     let entries = SongEntries::new(paths).unwrap();
 
     // test(&entries);
+    // test_plot(&entries);
 
     ui::start(&entries);
 }
@@ -113,3 +115,9 @@ fn test(entries: &SongEntries) {
     entries.print_aspect_date(&AspectFull::Album(&coat), &start_date, &end_date);
     entries.print_aspect_date(&AspectFull::Song(&final_solution), &start_date, &end_date);
 }
+
+/// tests various [`plot`] functions
+#[allow(dead_code)]
+fn test_plot(entries: &SongEntries) {
+    plot::absolute::artist(entries, &types::Artist::from_str("Sabaton"));
+}

src/main.rs

@@ -0,0 +1,4 @@
+//! Module responsible for plotting/charts
+
+/// Responsible for plotting absolute plots
+pub mod absolute;

src/plot.rs

@@ -0,0 +1,53 @@
+use crate::display::date;
+use crate::types::{Artist, SongEntries, SongEntry};
+use crate::ui::user_input_date_parser;
+
+use chrono::DateTime;
+use chrono_tz::Tz;
+use plotly::{Layout, Plot, Scatter};
+
+/// Creates a plot of the absolute amount of plays of an [`Artist`]
+///
+/// Opens the plot in the browser
+pub fn artist(entries: &SongEntries, art: &Artist) {
+    let mut times = Vec::<i64>::new();
+    let mut plays = Vec::<usize>::new();
+
+    let mut dates = find_artist_dates(entries, art);
+    dates.sort();
+
+    let start = dates.first().unwrap();
+
+    for date in &dates {
+        times.push(date.timestamp());
+        plays.push(date::gather_artist(entries, art, start, date));
+    }
+
+    let mut plot = Plot::new();
+    // TODO: make it display actual dates instead of UNIX timestamps xd
+    plot.add_trace(Scatter::new(times, plays).name(art.name.as_str()));
+
+    // sets the title of the plot the artist name
+    let layout = Layout::new().title(format!("<b>{art}</b>").as_str().into());
+    plot.set_layout(layout);
+
+    // opens the plot in the browser
+    plot.show();
+}
+
+/// Used by [`artist()`] to get the dates of all of its occurrence
+fn find_artist_dates(entries: &Vec<SongEntry>, art: &Artist) -> Vec<DateTime<Tz>> {
+    let mut dates = Vec::<DateTime<Tz>>::new();
+
+    for entry in entries {
+        let artist = Artist::new(entry.artist.clone());
+
+        if artist == *art {
+            dates.push(entry.timestamp);
+        }
+    }
+
+    dates.push(user_input_date_parser("now").unwrap());
+
+    dates
+}

src/plot/absolute.rs

@@ -8,6 +8,7 @@ use chrono_tz::Tz;
 
 use crate::display;
 use crate::parse;
+use crate::plot;
 
 /// Algebraic data type similar to [Aspect]
 /// but used by functions such as [`display::print_aspect()`]
@@ -266,6 +267,11 @@ impl SongEntries {
         display::print_aspect_date(self, asp, start, end);
     }
 
+    /// Creates a plot of the artist
+    pub fn plot_artist(&self, art: &Artist) {
+        plot::absolute::artist(self, art);
+    }
+
     /// Adds search capability
     ///
     /// Use with methods from [`Find`]: [`.artist()`](Find::artist()), [`.album()`](Find::album()),

src/types.rs

@@ -173,6 +173,7 @@ fn match_input(
         "print top artists" | "ptarts" => match_print_top(entries, rl, &Aspect::Artists)?,
         "print top albums" | "ptalbs" => match_print_top(entries, rl, &Aspect::Albums)?,
         "print top songs" | "ptsons" => match_print_top(entries, rl, &Aspect::Songs)?,
+        "plot artist" | "gart" => match_plot_artist(entries, rl)?,
         // when you press ENTER -> nothing happens, new prompt
         "" => (),
         _ => {
@@ -425,11 +426,25 @@ fn match_print_top(
     Ok(())
 }
 
+/// Used by [`match_input()`] for `plot artist` command
+fn match_plot_artist(
+    entries: &SongEntries,
+    rl: &mut Editor<ShellHelper, FileHistory>,
+) -> Result<(), Box<dyn Error>> {
+    // 1st prompt: artist name
+    println!("Artist name?");
+    let usr_input_art = rl.readline(PROMPT_MAIN)?;
+    let art = entries.find().artist(&usr_input_art)?;
+
+    entries.plot_artist(&art);
+    Ok(())
+}
+
 /// used by `*_date` functions in this module for when the user inputs a date
 ///
 /// # Arguments
 /// * `usr_input` - in YYYY-MM-DD format or 'now' or 'start'
-fn user_input_date_parser(usr_input: &str) -> Result<DateTime<Tz>, chrono::format::ParseError> {
+pub fn user_input_date_parser(usr_input: &str) -> Result<DateTime<Tz>, chrono::format::ParseError> {
     let date_str = match usr_input {
         "now" => {
             return Ok(LOCATION_TZ

src/ui.rs

@@ -17,7 +17,7 @@ pub fn help() {
     print("print top", &print_top_commands());
 
     // GRAPH COMMANDS
-    print("graph", &graph_commands());
+    print("graph/plot", &plot_commands());
 }
 
 /// Prints the commands
@@ -194,8 +194,13 @@ fn print_top_commands<'a>() -> Vec<[&'a str; 3]> {
 }
 
 /// Returns graph commands
-fn graph_commands<'a>() -> Vec<[&'a str; 3]> {
-    vec![["graph placeholder", "gphd", "placeholder description"]]
+fn plot_commands<'a>() -> Vec<[&'a str; 3]> {
+    vec![[
+        "plot artist",
+        "gart",
+        "creates a plot of the absolute amount of plays of the given artist
+        and opens it in the web browser",
+    ]]
 }
 
 #[cfg(test)]