guided_digraph 0.1.1

/*
    System utility functions

    (File I/O, JSON serialization, system time, etc.)
*/

use serde::de::DeserializeOwned;
use serde::ser::Serialize;
use std::fmt::Debug;
use std::fs::{self, File};
use std::io::{self, BufReader, BufWriter, Write};
use std::path::{Path, PathBuf};
use std::time::{Duration, SystemTime};
use time::macros::format_description;
use time::OffsetDateTime;

/*
    File I/O
*/

fn path_reader<P>(path: P) -> BufReader<File>
where
    P: AsRef<Path> + Debug,
{
    BufReader::new(File::open(&path).unwrap_or_else(|err| {
        panic!("Could not open file for reading: {:?} -- {}", path, err)
    }))
}

fn path_writer<P>(path: P) -> BufWriter<File>
where
    P: AsRef<Path> + Debug,
{
    BufWriter::new(File::create(&path).unwrap_or_else(|err| {
        panic!("Could not open file for writing: {:?} -- {}", path, err)
    }))
}

pub fn file_exists<P>(path: P) -> bool
where
    P: AsRef<Path> + Debug,
{
    path.as_ref().exists()
}

pub fn from_json_file<P, T>(path: P) -> T
where
    P: AsRef<Path> + Debug,
    T: DeserializeOwned,
{
    serde_json::from_reader(path_reader(&path)).unwrap_or_else(|err| {
        panic!("Could not read JSON from {:?} -- {}", path, err)
    })
}

pub fn to_json_file<P, T>(path: P, data: T)
where
    P: AsRef<Path> + Debug,
    T: Serialize,
{
    let mut writer = path_writer(&path);
    serde_json::to_writer_pretty(&mut writer, &data).unwrap_or_else(|err| {
        panic!("Could not write JSON to {:?} -- {}", path, err)
    });
    writeln!(&mut writer).unwrap_or_else(|err| {
        format!("Could not append newline to file: {:?} -- {}", &path, err);
    });
}

pub fn lines_to_file<P>(path: P, lines: Vec<String>)
where
    P: AsRef<Path> + Debug,
{
    let mut writer = path_writer(&path);
    for line in &lines {
        writeln!(writer, "{}", line).unwrap();
    }
}

/*
    Path walking functions
*/

// Walk files in a directory
// Could also just use the walkdir crate for this.
// It is truly hilarious how many layers of indirection it takes
// to go through Rust's various String and OS abstractions
pub fn paths_in(dir: &str) -> impl Iterator<Item = String> + '_ {
    fs::read_dir(PathBuf::from(dir))
        .unwrap_or_else(|err| {
            panic!("couldn't view files in directory: {} ({})", dir, err)
        })
        .map(move |file| {
            file.unwrap_or_else(|err| {
                panic!("error viewing file in directory: {} ({})", dir, err)
            })
        })
        .map(|file| file.path().into_os_string())
        .map(|osstr| {
            osstr.into_string().unwrap_or_else(|err| {
                panic!("found file path with invalid unicode ({:?})", err)
            })
        })
}

// Recursively visit all directories in a directory,
// calling the closure cb
// https://doc.rust-lang.org/std/fs/fn.read_dir.html#examples
pub fn walk_dirs_rec<F: FnMut(&Path)>(
    dir: &Path,
    cb: &mut F,
) -> io::Result<()> {
    if dir.is_dir() {
        cb(dir);
        for entry in fs::read_dir(dir)? {
            let path = entry?.path();
            walk_dirs_rec(&path, cb)?;
        }
    }
    Ok(())
}

/*
    Time-related functions
*/

// Time elapsed with error message
pub fn time_since(t: &SystemTime) -> Duration {
    t.elapsed().unwrap_or_else(|err| {
        eprintln!(
            "Warning: SystemTime elapsed failed (was system clock reset?): {}",
            err
        );
        Duration::ZERO
    })
}

// Current datetime for use in file names
// Note: removed dependence on chrono on 2022-07-19; as a result,
// now this uses time::OffsetDateTime, which is UTC rather than local time.
pub fn current_datetime_str() -> String {
    let dt: OffsetDateTime = SystemTime::now().into();
    let dt_fmt =
        format_description!("[year]-[month]-[day]-[hour][minute][second]");
    dt.format(&dt_fmt).unwrap()
    // Old implementation using Chrono
    // Local::now().format("%Y-%m-%d-%H%M%S").to_string()
}

#[test]
fn test_current_datetime_str() {
    let cur = current_datetime_str();
    println!("Current datetime string: {}", cur);
    let chars: Vec<char> = cur.chars().collect();
    assert_eq!(chars.len(), 17);
    assert_eq!(chars[0], '2');
    assert_eq!(chars[1], '0');
    for i in [2, 3, 5, 6, 8, 9, 11, 12, 13, 14, 15, 16] {
        assert!(chars[i].is_ascii_digit());
    }
    for i in [4, 7, 10] {
        assert_eq!(chars[i], '-');
    }
}

/*
    Fresh Clone -- a useful method for iterators

    Consumes the input iterator, collecting its items and producing
    a fresh iterator which owns all of its inputs.

    This allows, for example, removing all elements from a vector
    from an iterator over that vector (see test_fresh_clone_2).

    Note that .fresh_clone() doesn't work as expected on an
    iterator over references, since it just produces a new collected
    iterator over the same references. It would be nice to disallow
    this in the impl FreshClone block but I don't know how to ensure
    that I::Item is an owned and not a reference type.
*/
pub trait FreshClone {
    type Result: Iterator;
    fn fresh_clone(self) -> Self::Result;
}

impl<I: Iterator> FreshClone for I {
    type Result = std::vec::IntoIter<I::Item>;
    fn fresh_clone(self) -> Self::Result {
        self.collect::<Vec<I::Item>>().into_iter()
    }
}

#[test]
fn test_fresh_clone_1() {
    let v1: Vec<usize> = vec![1, 2, 3];
    let r1: Vec<usize> = v1.iter().fresh_clone().copied().collect();
    assert_eq!(v1, r1);
    assert_eq!(r1.len(), 3);
    let r2: Vec<usize> = Vec::new().iter().fresh_clone().copied().collect();
    assert!(r2.is_empty());
    let r3: Vec<usize> =
        v1.iter().chain(v1.iter()).fresh_clone().copied().collect();
    assert_eq!(r3, vec![1, 2, 3, 1, 2, 3]);
}

#[test]
fn test_fresh_clone_2() {
    let mut v: Vec<usize> = vec![1, 2, 3];
    // Notes:
    // - doesn't work if .fresh_clone() is removed
    // - doesn't work without .copied() -- we have to create a fresh clone
    //   for the usize values, not the &usize values
    for i in v.iter().copied().fresh_clone() {
        v.retain(|&x| x != i);
    }
    assert!(v.is_empty());
}